Skip to content

Graphorin API reference v0.4.0


Graphorin API reference / @graphorin/store-sqlite / / OpenAuditDatabaseOptions

Interface: OpenAuditDatabaseOptions

Defined in: packages/store-sqlite/src/audit-db.ts:14

Options for openAuditDatabase. The audit database is always encrypted (DEC-124); if the cipher peer is missing the call fails fast with CipherPeerMissingError.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
cipherLoader?readonly() => Promise<BetterSqlite3Constructor>Internal Optional cipher-driver loader override. When unset the function defers to the canonical loadCipherDriver. Used by the test suite to simulate a missing cipher peer without uninstalling the package from the workspace.packages/store-sqlite/src/audit-db.ts:28
driver?readonlyBetterSqlite3ConstructorOptional driver override for tests.packages/store-sqlite/src/audit-db.ts:19
encryptionreadonly{ cipher?: EncryptionCipher; enabled: true; passphraseResolver: PassphraseResolver; }Cipher / passphrase resolver — required because audit.db is encrypted.packages/store-sqlite/src/audit-db.ts:17
encryption.cipher?readonlyEncryptionCipher-packages/store-sqlite/src/encryption/index.ts:37
encryption.enabledreadonlytrue-packages/store-sqlite/src/encryption/index.ts:36
encryption.passphraseResolverreadonlyPassphraseResolverResolves the passphrase at startup. Returns the raw passphrase string (the caller is responsible for clearing it from memory after the connection is open). Inputs typically come from a SecretValue resolver in @graphorin/security or from an operator-supplied env var.packages/store-sqlite/src/encryption/index.ts:45
pathreadonlystring-packages/store-sqlite/src/audit-db.ts:15