@delali/sirannon-db 0.3.6-next.77 → 0.3.6-next.78

package/dist/core/index.d.ts

@@ -1,16 +1,17 @@
-export { B as BackupCapabilities, a as BackupChainLocation, b as BackupRestorePlan, c as BackupSafeToDeleteOptions, d as backupPiecesSafeToDelete, p as planBackupRestore } from '../database-backup-BwTNiBm2.js';
-import { J as SQLiteConnection, V as SynchronousLevel, S as SQLiteDriver, D as DatabaseOptions, W as LifecycleConfig, M as Migration, X as MigrationResult, Y as RollbackResult } from '../types-DTmi7pXp.js';
-export { A as AfterQueryHook, Z as AfterQueryHookContext, _ as AppliedMigrationEntry, h as BackupChain, i as BackupChainBase, j as BackupChainChange, k as BackupChainPosition, l as BackupChainRecord, n as BackupCycleError, o as BackupCycleOptions, p as BackupCycleStatus, B as BackupDestination, q as BackupFileReport, r as BackupGroupMembership, s as BackupGroupSource, t as BackupLogPosition, u as BackupNodePreference, v as BackupPiece, w as BackupProgress, g as BackupRunReport, P as BackupScheduleOptions, x as BackupSkip, y as BackupSkipReason, z as BackupToDestinationOptions, C as BackupVerifyResult, $ as BatchSummary, d as BeforeConnectHook, a0 as BeforePushHook, c as BeforeQueryHook, a1 as BeforeSnapshotHook, a2 as BeforeSubscribeHook, a3 as CDCMetrics, a4 as ClusterReadEndpointInfo, I as ClusterStatusInfo, a5 as ConnectionHookContext, a6 as ConnectionMetrics, a7 as Counted, E as DEFAULT_CHAIN_NAME, f as DatabaseCloseHook, a8 as DatabaseCopyRequest, a9 as DatabaseCopyStep, e as DatabaseOpenHook, Q as DriverCapabilities, aa as DriverWorkerEntry, ab as HookConfig, ac as MIGRATION_NAME_RE, b as MetricsCollector, ad as MetricsConfig, ae as MigrationBaseline, af as MigrationSource, ag as NODE_HEALTH_REASONS, ah as NODE_HEALTH_STATES, N as NodeHealth, ai as NodeHealthReason, aj as NodeHealthState, ak as OpenOptions, al as QueryHookContext, am as QueryMetrics, an as RunResult, ao as SQLiteStatement, a as SirannonOptions, T as Transaction, ap as WriterWorkerOptions, G as readBackupChains } from '../types-DTmi7pXp.js';
-import { B as BulkLoadDurability, a as BulkLoadResult, R as RequestContext } from '../server-options-B9CsAZp5.js';
-export { A as AppliedMigrationRow, b as AuthenticateHook, c as BulkLoadOptions, C as ClientOptions, d as ClusterStatusAuthorizer, e as CorsOptions, f as ReplicationStatusInfo, g as ServerExecutionTarget, h as ServerExecutionTargetResolver, S as ServerOptions, W as WSHandlerOptions } from '../server-options-B9CsAZp5.js';
-export { C as ChangeTracker, a as ChangeTrackerOptions } from '../change-tracker-Dpo99EI-.js';
-import { D as Database } from '../database-fz-8CJBP.js';
-export { B as BackupError, C as CDCError, b as ConnectionPool, c as ConnectionPoolError, d as ConnectionPoolOptions, e as DatabaseAlreadyExistsError, f as DatabaseBackups, g as DatabaseLifecycle, h as DatabaseNotFoundError, E as ExtensionError, F as ForbiddenSqlError, i as HookDeniedError, a as HookDispose, j as HookEvent, k as HookEventContextMap, l as HookHandler, H as HookRegistry, M as MaxDatabasesError, m as MigrationError, P as PushHookContext, Q as QueryError, R as ReadOnlyError, n as RequestDeniedError, S as SirannonError, o as SnapshotHookContext, p as SubscribeHookContext, T as TransactionError, W as WriteOverloadError } from '../database-fz-8CJBP.js';
+export { B as BackupCapabilities, a as BackupChainLocation, b as BackupRestorePlan, c as BackupSafeToDeleteOptions, d as backupPiecesSafeToDelete, p as planBackupRestore } from '../database-backup-BhM8yJ1A.js';
+import { L as SQLiteConnection, X as SynchronousLevel, S as SQLiteDriver, D as DatabaseOptions, Y as LifecycleConfig, M as Migration, Z as MigrationResult, _ as RollbackResult } from '../types-BWyv_N18.js';
+export { A as AfterQueryHook, $ as AfterQueryHookContext, a0 as AppliedMigrationEntry, h as BackupChain, i as BackupChainBase, j as BackupChainChange, k as BackupChainPosition, l as BackupChainRecord, n as BackupCycleError, o as BackupCycleOptions, p as BackupCycleStatus, B as BackupDestination, q as BackupFileReport, r as BackupGroupMembership, s as BackupGroupSource, t as BackupLogPosition, u as BackupNodePreference, v as BackupPiece, w as BackupProgress, g as BackupRunReport, R as BackupScheduleOptions, x as BackupSkip, y as BackupSkipReason, z as BackupToDestinationOptions, C as BackupVerifyResult, a1 as BatchSummary, d as BeforeConnectHook, a2 as BeforePushHook, c as BeforeQueryHook, a3 as BeforeSnapshotHook, a4 as BeforeSubscribeHook, a5 as CDCMetrics, a6 as ClusterReadEndpointInfo, K as ClusterStatusInfo, a7 as ConnectionHookContext, a8 as ConnectionMetrics, a9 as Counted, F as DEFAULT_CHAIN_NAME, f as DatabaseCloseHook, aa as DatabaseCopyRequest, ab as DatabaseCopyStep, ac as DatabaseFileSystem, e as DatabaseOpenHook, V as DriverCapabilities, ad as DriverWorkerEntry, ae as EncryptionChange, af as EncryptionChangeStatus, J as EncryptionKey, E as EncryptionOptions, ag as EncryptionStatus, ah as HookConfig, ai as MIGRATION_NAME_RE, b as MetricsCollector, aj as MetricsConfig, ak as MigrationBaseline, al as MigrationSource, am as NODE_HEALTH_REASONS, an as NODE_HEALTH_STATES, N as NodeHealth, ao as NodeHealthReason, ap as NodeHealthState, aq as OpenOptions, ar as QueryHookContext, as as QueryMetrics, at as RunResult, au as SQLiteStatement, a as SirannonOptions, T as Transaction, av as WriterWorkerOptions, H as readBackupChains } from '../types-BWyv_N18.js';
+import { B as BulkLoadDurability, a as BulkLoadResult, R as RequestContext } from '../server-options-Bhdlvehe.js';
+export { A as AppliedMigrationRow, b as AuthenticateHook, c as BulkLoadOptions, C as ClientOptions, d as ClusterStatusAuthorizer, e as CorsOptions, f as ReplicationStatusInfo, g as ServerExecutionTarget, h as ServerExecutionTargetResolver, S as ServerOptions, W as WSHandlerOptions } from '../server-options-Bhdlvehe.js';
+import { S as SirannonError } from '../errors-DLMAGQFb.js';
+export { B as BackupError, a as CDCError, C as ChangeTracker, b as ChangeTrackerOptions, c as ConnectionPoolError, D as DatabaseAlreadyExistsError, d as DatabaseNotFoundError, E as ExtensionError, F as ForbiddenSqlError, H as HookDeniedError, M as MaxDatabasesError, e as MigrationError, Q as QueryError, R as ReadOnlyError, f as RequestDeniedError, T as TransactionError, W as WriteOverloadError } from '../errors-DLMAGQFb.js';
+import { D as Database, C as ConnectionPool } from '../database-BZ96ZzAx.js';
+export { c as ConnectionPoolOptions, d as DatabaseBackups, e as DatabaseEncryption, f as DatabaseLifecycle, a as HookDispose, g as HookEvent, h as HookEventContextMap, i as HookHandler, H as HookRegistry, P as PushHookContext, S as SnapshotHookContext, j as SubscribeHookContext } from '../database-BZ96ZzAx.js';
 export { a as LiveQuery, L as LiveQueryOptions, b as LiveQueryState, c as LiveUpdate, R as ResultOp } from '../types-CEJG0eFS.js';
 import { B as BaselineFileOption } from '../baseline-Co3iIsN_.js';
 import { P as Params, E as ExecuteResult } from '../query-types-5B02ixH0.js';
 export { C as ChangeEvent, b as ChangeOperation, Q as QueryOptions, R as ReadConcern, a as ReadConcernLevel, S as Subscription, c as SubscriptionBuilder, d as SubscriptionOptions, W as WriteConcern, e as WriteConcernLevel } from '../query-types-5B02ixH0.js';
-export { S as Sirannon } from '../sirannon-D0CjDULa.js';
+export { S as Sirannon } from '../sirannon-Ba1o2HUQ.js';
 export { D as DatabaseOperations, b as OperationArguments, O as OperationRef, a as OperationRegistry, c as OperationStatement, R as ReadOperation, W as WriteOperation, o as operationName, d as operationRef } from '../operation-registry-CGhNT-Sn.js';
 import '../types-BG31TtrQ.js';
 
@@ -122,6 +123,29 @@ declare function synchronousPragmaValue(level: SynchronousLevel | undefined): st
  */
 declare function isSynchronousLevel(value: unknown): value is SynchronousLevel;
 
+/**
+ * The codes of the errors that an encrypted database raises.
+ *
+ * @public
+ */
+type EncryptionErrorCode = 'ENCRYPTION_UNSUPPORTED' | 'INVALID_ENCRYPTION_KEY' | 'ENCRYPTION_KEY_UNAVAILABLE' | 'ENCRYPTION_KEY_MISSING' | 'ENCRYPTION_KEY_REJECTED' | 'DATABASE_NOT_ENCRYPTED' | 'ENCRYPTED_PAGE_CORRUPT' | 'ENCRYPTION_REQUIRED' | 'ENCRYPTION_CHANGE_IN_PROGRESS' | 'ENCRYPTION_CHANGE_ABORTED';
+/**
+ * Thrown when a database cannot be encrypted, opened under its key, or given a new key. The message never contains a
+ * key.
+ *
+ * @public
+ */
+declare class EncryptionError extends SirannonError {
+    /**
+     * Returns an error with an encryption code, and the failure that caused it when there is one.
+     *
+     * @param message - What failed, written without the key.
+     * @param code - The machine-readable code.
+     * @param cause - The failure that caused this error, such as the error that a key function threw.
+     */
+    constructor(message: string, code: EncryptionErrorCode, cause?: unknown);
+}
+
 /**
  * The registry supplies these functions so that the lifecycle manager can open, close, count, and look up its databases.
  *
@@ -300,15 +324,27 @@ declare class MigrationRunner {
 /**
  * Executes a read on one connection and returns the rows with their values decoded.
  *
+ * @param conn - The connection that executes the read.
+ * @param sql - The statement to execute.
+ * @param params - The values to bind to the statement, named or positional.
+ * @param leasedFrom - The pool that leased `conn` through {@link ConnectionPool.leaseReader}, which gets the lease
+ * back once the read settles.
+ * @returns The rows with their values decoded.
  * @internal
  */
-declare function query<T = Record<string, unknown>>(conn: SQLiteConnection, sql: string, params?: Params): Promise<T[]>;
+declare function query<T = Record<string, unknown>>(conn: SQLiteConnection, sql: string, params?: Params, leasedFrom?: ConnectionPool): Promise<T[]>;
 /**
  * Executes a read on one connection and returns the first row, or undefined when the read returns none.
  *
+ * @param conn - The connection that executes the read.
+ * @param sql - The statement to execute.
+ * @param params - The values to bind to the statement, named or positional.
+ * @param leasedFrom - The pool that leased `conn` through {@link ConnectionPool.leaseReader}, which gets the lease
+ * back once the read settles.
+ * @returns The first row, or undefined when the read returns none.
  * @internal
  */
-declare function queryOne<T = Record<string, unknown>>(conn: SQLiteConnection, sql: string, params?: Params): Promise<T | undefined>;
+declare function queryOne<T = Record<string, unknown>>(conn: SQLiteConnection, sql: string, params?: Params, leasedFrom?: ConnectionPool): Promise<T | undefined>;
 /**
  * Executes one write on a connection and returns the change count and the row id of the last inserted row.
  *
@@ -377,4 +413,4 @@ declare function readBearerToken(ctx: RequestContext): string | undefined;
  */
 declare function readSubprotocolCredential(ctx: RequestContext, prefix: string): string | undefined;
 
-export { BaselineFileOption, BulkLoadDurability, BulkLoadResult, DEFAULT_SYNCHRONOUS, Database, DatabaseOptions, ExecuteResult, type LifecycleCallbacks, LifecycleConfig, LifecycleManager, MIGRATION_FILENAME_PATTERN, Migration, MigrationResult, MigrationRunner, type MigrationsFromFilesOptions, Params, type ParsedMigrationFilename, RequestContext, RollbackResult, SQLiteConnection, SQLiteDriver, SynchronousLevel, type TenantResolverOptions, createTenantResolver, defineDriver, execute, executeBatch, isBulkLoadDurability, isSynchronousLevel, migrationsFromFiles, parseMigrationFilename, query, queryOne, readBearerToken, readHeader, readSubprotocolCredential, runBulkLoad, sanitizeTenantId, synchronousPragmaValue, tenantPath, toSubprotocolCredential };
+export { BaselineFileOption, BulkLoadDurability, BulkLoadResult, ConnectionPool, DEFAULT_SYNCHRONOUS, Database, DatabaseOptions, EncryptionError, type EncryptionErrorCode, ExecuteResult, type LifecycleCallbacks, LifecycleConfig, LifecycleManager, MIGRATION_FILENAME_PATTERN, Migration, MigrationResult, MigrationRunner, type MigrationsFromFilesOptions, Params, type ParsedMigrationFilename, RequestContext, RollbackResult, SQLiteConnection, SQLiteDriver, SirannonError, SynchronousLevel, type TenantResolverOptions, createTenantResolver, defineDriver, execute, executeBatch, isBulkLoadDurability, isSynchronousLevel, migrationsFromFiles, parseMigrationFilename, query, queryOne, readBearerToken, readHeader, readSubprotocolCredential, runBulkLoad, sanitizeTenantId, synchronousPragmaValue, tenantPath, toSubprotocolCredential };