Class WORMStorage

Index

Constructors

Methods

enable applyHooks archive freeze getTamperLog verifyIntegrity isWORMEnabled getConfig enforceRetention getState disable getMetadataModel getTamperLogModel listWORMModels

Constructors

constructor

new WORMStorage(): WORMStorage

Returns WORMStorage

Methods

`Static`enable

enable(model: any, prorm: Prorm, options: WORMOptions): void
Enable WORM storage on a model. Creates necessary metadata tables and registers hooks.
Parameters
- model: any
  The model class to protect
- prorm: Prorm
  The Prorm instance
- options: WORMOptions
  WORM configuration options
Returns void
- Defined in compliance/worm-storage.ts:281

`Static`applyHooks

applyHooks(model: any, config?: WORMConfig): void
Apply hooks to a model for WORM protection. Called automatically by enable().
Parameters
- model: any
  The model class
- Optionalconfig: WORMConfig
  The WORM configuration
Returns void
- Defined in compliance/worm-storage.ts:329

`Static`archive

archive(record: any): Promise<void>
Archive a record (moves to archived state). Archived records are read-only but can still be queried.
Parameters
- record: any
  The record instance to archive
Returns Promise<void>
- Defined in compliance/worm-storage.ts:503

`Static`freeze

freeze(record: any): Promise<void>
Freeze a record (fully immutable). Frozen records cannot be modified or deleted.
Parameters
- record: any
  The record instance to freeze
Returns Promise<void>
- Defined in compliance/worm-storage.ts:582

`Static`getTamperLog

getTamperLog(
recordId: string | number,
tableName: string,
): Promise<WORMTamperLog[]>
Get the tamper evidence log for a record.
Parameters
- recordId: string | number
  The record ID
- tableName: string
  The table name
Returns Promise<WORMTamperLog[]>
- Defined in compliance/worm-storage.ts:650

`Static`verifyIntegrity

verifyIntegrity(recordId: string | number, tableName: string): Promise<boolean>
Verify the integrity of a record's tamper chain.
Parameters
- recordId: string | number
  The record ID
- tableName: string
  The table name
Returns Promise<boolean>
True if chain is valid, false if tampering detected
- Defined in compliance/worm-storage.ts:684

`Static`isWORMEnabled

isWORMEnabled(model: any): boolean
Check if WORM is enabled on a model.
Parameters
- model: any
  The model class
Returns boolean
- Defined in compliance/worm-storage.ts:761

`Static`getConfig

getConfig(model: any): WORMOptions | undefined
Get the WORM configuration for a model.
Parameters
- model: any
  The model class
Returns WORMOptions | undefined
- Defined in compliance/worm-storage.ts:770

`Static`enforceRetention

enforceRetention(
model: any,
prorm: any,
): Promise<{ affected: number; mode: string }>
Enforce retention policy on a model. This will delete or anonymize records that have exceeded their retention period.
Parameters
- model: any
  The model class
- prorm: any
  The Prorm instance
Returns Promise<{ affected: number; mode: string }>
- Defined in compliance/worm-storage.ts:782

`Static`getState

getState(
recordId: string | number,
tableName: string,
): Promise<ArchiveState | null>
Get the archive state of a record.
Parameters
- recordId: string | number
  The record ID
- tableName: string
  The table name
Returns Promise<ArchiveState | null>
- Defined in compliance/worm-storage.ts:802

`Static`disable

disable(model: any): void
Disable WORM storage for a model.
Parameters
- model: any
  The model class
Returns void
- Defined in compliance/worm-storage.ts:833

`Static`getMetadataModel

getMetadataModel(model: any): ModelStatic<any> | undefined
Get the WORM metadata model for a model.
Parameters
- model: any
  The model class
Returns ModelStatic<any> | undefined
- Defined in compliance/worm-storage.ts:856

`Static`getTamperLogModel

getTamperLogModel(model: any): ModelStatic<any> | undefined
Get the tamper log model for a model.
Parameters
- model: any
  The model class
Returns ModelStatic<any> | undefined
- Defined in compliance/worm-storage.ts:865

`Static`listWORMModels

listWORMModels(): { modelName: string; options: WORMOptions }[]
List all models with WORM storage enabled.

Returns { modelName: string; options: WORMOptions }[]
- Defined in compliance/worm-storage.ts:872