@chipmobilesdk/rn-local-db 0.3.0 → 0.5.0

package/lib/typescript/module/artifacts/store.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Artifacts: the file on disk and the reference to it.
+ *
+ * The reference lives in the scope's own database, so a reference created
+ * inside a transaction rolls back with it (FR-072) — no bookkeeping required,
+ * because the connection routes through the transaction in flight.
+ *
+ * The file does not roll back. A filesystem write is not part of a SQL
+ * transaction and cannot be made part of one, so a rolled-back transaction
+ * leaves an artifact on disk with nothing pointing at it. That is not a bug
+ * to be engineered away; it is why reconciliation exists (FR-073d), and why
+ * the write order is deliberate: **the file completes first, then the
+ * reference**. The reverse order would produce a reference to a file that
+ * does not exist, which is the failure a consumer cannot recover from — it
+ * looks like data the app has and does not.
+ */
+import type { AttachmentInput, AttachmentOwner, AttachmentReference, ByteRange, DeletionOutcome } from '../contract/attachment.js';
+import type { StorageLayout } from '../platform/location.js';
+import type { Executor } from '../sqlite/connection.js';
+export type ArtifactContext = {
+    executor(): Executor;
+    layout: StorageLayout;
+    scopeKey: string;
+    /** Null when the database is unencrypted. */
+    artifactKey(attachmentId: string): Uint8Array | null;
+    now(): number;
+};
+export declare function ensureAttachmentTable(executor: Executor): Promise<void>;
+export declare function readReference(executor: Executor, id: string): Promise<AttachmentReference | null>;
+export declare function listReferences(executor: Executor): Promise<AttachmentReference[]>;
+export declare function listReferencesFor(executor: Executor, owner: AttachmentOwner): Promise<AttachmentReference[]>;
+export declare function deleteReference(executor: Executor, id: string): Promise<boolean>;
+export declare function writeArtifact(context: ArtifactContext, input: AttachmentInput): Promise<AttachmentReference>;
+export declare function readArtifact(context: ArtifactContext, id: string, range?: ByteRange): Promise<string>;
+/**
+ * Collects file removals until the transaction that deleted their references
+ * commits. A file unlinked inside the transaction is gone even if the
+ * transaction then rolls back and the reference returns — a dangling
+ * reference to data nobody can recover.
+ */
+export type DeferredUnlinks = {
+    add(path: string): void;
+};
+export declare function removeArtifact(context: ArtifactContext, id: string, deferred?: DeferredUnlinks): Promise<DeletionOutcome>;
+//# sourceMappingURL=store.d.ts.map

package/lib/typescript/module/artifacts/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/artifacts/store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EACX,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,SAAS,EACT,eAAe,EACf,MAAM,2BAAwB,CAAC;AAQhC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAsB,CAAC;AAa1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAsB,CAAC;AAkBrD,MAAM,MAAM,eAAe,GAAG;IAC7B,QAAQ,IAAI,QAAQ,CAAC;IACrB,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IACrD,GAAG,IAAI,MAAM,CAAC;CACd,CAAC;AAEF,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAG7E;AAoBD,wBAAsB,aAAa,CAClC,QAAQ,EAAE,QAAQ,EAClB,EAAE,EAAE,MAAM,GACR,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAIrC;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAGvF;AAED,wBAAsB,iBAAiB,CACtC,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,eAAe,GACpB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAMhC;AA4BD,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAGtF;AA+ED,wBAAsB,aAAa,CAClC,OAAO,EAAE,eAAe,EACxB,KAAK,EAAE,eAAe,GACpB,OAAO,CAAC,mBAAmB,CAAC,CA2C9B;AA6CD,wBAAsB,YAAY,CACjC,OAAO,EAAE,eAAe,EACxB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,GACf,OAAO,CAAC,MAAM,CAAC,CAkBjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC;AAEF,wBAAsB,cAAc,CACnC,OAAO,EAAE,eAAe,EACxB,EAAE,EAAE,MAAM,EACV,QAAQ,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,CAAC,CA2B1B"}

package/lib/typescript/module/contract/adapter.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The interface every storage implementation satisfies.
+ *
+ * Two implementations exist: op-sqlite on device, and a pure-TypeScript
+ * in-memory one for tests. The second is not a convenience — op-sqlite is
+ * native and unreachable from Jest, so without it the package's own
+ * guarantees would be untestable in CI (research.md R8).
+ */
+import type { AttachmentAvailability, AttachmentInput, AttachmentReference, AttachmentOwner, ByteRange, DeletionOutcome, ReconciliationReport } from './attachment.js';
+import type { EffectivePosture } from './backup.js';
+import type { DatabaseConfig, DatabaseTargetConfig, ScopeTargetConfig } from './config.js';
+import type { FilterNode, IndexCoverageReport, Query, ResultPage } from './query.js';
+import type { RecordInput, StorableRecordData, StoredRecord, WriteOutcome } from './record.js';
+import type { BatchOperation, BatchOutcome, CollectionOps, Transaction } from './transaction.js';
+export type Attachments = {
+    write(input: AttachmentInput): Promise<AttachmentReference>;
+    read(id: string, range?: ByteRange): Promise<string>;
+    /** Never opens or decrypts the artifact (FR-073e, FR-107b). */
+    availability(id: string): Promise<AttachmentAvailability>;
+    remove(id: string): Promise<DeletionOutcome>;
+    listFor(owner: AttachmentOwner): Promise<AttachmentReference[]>;
+    /** App-triggered only; the package runs no background sweep. */
+    reconcile(options?: {
+        removeOrphans?: boolean;
+    }): Promise<ReconciliationReport>;
+};
+export type DatabaseHandle = {
+    /** The scope hash. Never the components (FR-014). */
+    readonly scopeKey: string;
+    readonly schemaVersion: number;
+    readonly backupPosture: EffectivePosture;
+    readonly isEncrypted: boolean;
+    collection<T extends StorableRecordData = StorableRecordData>(name: string): CollectionOps<T>;
+    transaction<R>(fn: (tx: Transaction) => Promise<R>): Promise<R>;
+    batch(operations: BatchOperation[]): Promise<BatchOutcome>;
+    attachments(): Attachments;
+    /** Development-mode index coverage answer (FR-037). */
+    explain(collection: string, query?: Query): Promise<IndexCoverageReport>;
+    close(): Promise<void>;
+};
+/**
+ * What an implementation must provide. Deliberately lower-level than the
+ * public surface: validation, budget checks, and error mapping happen once in
+ * `adapter/`, above this line, so both implementations share them.
+ */
+export type StorageAdapter = {
+    readonly name: 'sqlite' | 'memory';
+    open(config: DatabaseConfig): Promise<DatabaseHandle>;
+    deleteScopeData(config: ScopeTargetConfig): Promise<DeletionOutcome>;
+    deleteDatabase(config: DatabaseTargetConfig): Promise<DeletionOutcome>;
+    /** The FR-057a recovery path. Never reachable from open(). */
+    resetScope(config: ScopeTargetConfig): Promise<DeletionOutcome>;
+};
+export type { CollectionOps, FilterNode, Query, RecordInput, ResultPage, StoredRecord, Transaction, WriteOutcome, };
+//# sourceMappingURL=adapter.d.ts.map

package/lib/typescript/module/contract/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../../src/contract/adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACX,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,MAAM,iBAAc,CAAC;AACtB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAU,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,aAAU,CAAC;AACxF,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAS,CAAC;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAU,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,kBAAe,CAAC;AAE9F,MAAM,MAAM,WAAW,GAAG;IACzB,KAAK,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC5D,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,+DAA+D;IAC/D,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC1D,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7C,OAAO,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAChE,gEAAgE;IAChE,SAAS,CAAC,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAChF,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC;IACzC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B,UAAU,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAC9F,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,KAAK,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC3D,WAAW,IAAI,WAAW,CAAC;IAC3B,uDAAuD;IACvD,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACzE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAEnC,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACtD,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrE,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACvE,8DAA8D;IAC9D,UAAU,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAChE,CAAC;AAEF,YAAY,EACX,aAAa,EACb,UAAU,EACV,KAAK,EACL,WAAW,EACX,UAAU,EACV,YAAY,EACZ,WAAW,EACX,YAAY,GACZ,CAAC"}

package/lib/typescript/module/contract/attachment.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Attachment references and the artifacts behind them.
+ *
+ * This package owns both halves. The consequence is that a filesystem write
+ * cannot be rolled back by a database transaction, which is why
+ * reconciliation exists (FR-073d) rather than being a nicety.
+ */
+export type AttachmentOwner = {
+    collection: string;
+    id: string;
+};
+type AttachmentDescription = {
+    id: string;
+    /** Absent means the attachment belongs to the scope rather than a record. */
+    owner?: AttachmentOwner | undefined;
+    contentType: string;
+};
+/**
+ * Where the bytes come from. Exactly one of the two.
+ *
+ * `sourcePath` is the one to use for anything large — a photo, a recording.
+ * The file is copied (or, when encrypted, read and encrypted 256 KB at a
+ * time), so memory does not grow with its size. `content` holds the whole
+ * payload in JS as base64 and is decoded in one piece: fine for a thumbnail,
+ * several times the file's size in memory for a video.
+ */
+export type AttachmentInput = AttachmentDescription & ({
+    /** The complete content, base64. Held and decoded whole. */
+    content: string;
+    sourcePath?: undefined;
+} | {
+    /** Absolute path of a file the app can read. A `file://` prefix is accepted. */
+    sourcePath: string;
+    content?: undefined;
+});
+export type AttachmentReference = {
+    id: string;
+    owner?: AttachmentOwner | undefined;
+    contentType: string;
+    /** Plaintext byte length, <= 100 MB (FR-088). */
+    size: number;
+    createdAt: number;
+    /** Present only for encrypted artifacts (research.md R4). */
+    chunkSize?: number;
+    chunkCount?: number;
+};
+/**
+ * `undecryptable` is deliberately distinct from `missing`: one is data loss
+ * for that artifact, the other is a wrong key or a tampered file (FR-107c).
+ */
+export type AttachmentAvailabilityState = 'available' | 'missing' | 'inaccessible' | 'undecryptable';
+export type AttachmentAvailability = {
+    id: string;
+    state: AttachmentAvailabilityState;
+    size?: number;
+};
+export type ByteRange = {
+    offset: number;
+    length: number;
+};
+/**
+ * Both directions of divergence between the database and the disk (FR-073d).
+ */
+export type ReconciliationReport = {
+    orphanedArtifacts: string[];
+    danglingReferences: string[];
+    removedArtifacts: string[];
+};
+/** Never a bare success (FR-065, FR-071). */
+export type DeletionOutcome = {
+    scopeKey?: string;
+    removedRecords: number;
+    /**
+     * True when the scope was deleted but its records could not be counted — an
+     * encrypted scope whose key was unavailable, or a file that would not open.
+     * `removedRecords` is then 0 and means "unknown". Added in 0.2.0.
+     */
+    recordCountUnavailable?: boolean;
+    removedArtifacts: string[];
+    orphanedReferences: string[];
+    failedRemovals: string[];
+};
+export {};
+//# sourceMappingURL=attachment.d.ts.map

package/lib/typescript/module/contract/attachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachment.d.ts","sourceRoot":"","sources":["../../../../src/contract/attachment.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACX,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,6EAA6E;IAC7E,KAAK,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACpC,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAClD,CACG;IACA,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,SAAS,CAAC;CACtB,GACD;IACA,gFAAgF;IAChF,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,SAAS,CAAC;CACnB,CACH,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GACtC,WAAW,GAAG,SAAS,GAAG,cAAc,GAAG,eAAe,CAAC;AAE5D,MAAM,MAAM,sBAAsB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,2BAA2B,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF,6CAA6C;AAC7C,MAAM,MAAM,eAAe,GAAG;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC"}

package/lib/typescript/module/contract/backup.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Platform backup posture.
+ *
+ * The platforms are not symmetric, and this contract is where that becomes
+ * visible to the consumer rather than hidden. On iOS the package sets the
+ * exclusion attribute itself. On Android backup participation is declared in
+ * the app's manifest — build-time, app-owned, and unreachable from a library
+ * that authors no native code — so the package verifies and reports instead.
+ * See research.md R5.
+ */
+export type BackupConfig = {
+    /** Default false: excluded unless the app asks otherwise (FR-109). */
+    includeInPlatformBackup: boolean;
+};
+export type BackupPostureValue = 'excluded' | 'included' | 'unknown';
+export type EffectivePosture = {
+    /** What the app asked for. */
+    requested: Exclude<BackupPostureValue, 'unknown'>;
+    /** What the package can actually confirm on this platform. */
+    observed: BackupPostureValue;
+    /** iOS: the package. Android: the app's manifest. */
+    enforcedBy: 'package' | 'app-manifest';
+    /** Present when requested and observed disagree — the case that matters. */
+    warning?: string;
+};
+//# sourceMappingURL=backup.d.ts.map

package/lib/typescript/module/contract/backup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../../../../src/contract/backup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,MAAM,YAAY,GAAG;IAC1B,sEAAsE;IACtE,uBAAuB,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAErE,MAAM,MAAM,gBAAgB,GAAG;IAC9B,8BAA8B;IAC9B,SAAS,EAAE,OAAO,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC;IAClD,8DAA8D;IAC9D,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,qDAAqD;IACrD,UAAU,EAAE,SAAS,GAAG,cAAc,CAAC;IACvC,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/lib/typescript/module/contract/config.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Database configuration: everything an app supplies at open time.
+ *
+ * Immutable for the handle's lifetime. Scope in particular is bound here and
+ * never changes (FR-008a) — there is no switchScope, and no operation takes a
+ * scope argument, which is what makes cross-scope leakage inexpressible
+ * rather than merely prevented.
+ */
+import type { BackupConfig } from './backup.js';
+import type { EncryptionConfig } from './encryption.js';
+import type { Migration } from './migration.js';
+import type { CollectionSchema } from './schema.js';
+import type { ScopeDescriptor } from './scope.js';
+/** Phase-one budgets (FR-088). Confirmed against the harness during validation. */
+export declare const Budgets: {
+    readonly MAX_RECORDS_PER_COLLECTION: 100000;
+    readonly MAX_RECORD_BYTES: number;
+    readonly MAX_BATCH_OPERATIONS: 1000;
+    readonly MAX_PAGE_SIZE: 500;
+    readonly MAX_COLLECTIONS_PER_DATABASE: 50;
+    readonly MAX_ATTACHMENT_REFERENCES_PER_SCOPE: 50000;
+    readonly MAX_ARTIFACT_BYTES: number;
+    readonly MAX_OPEN_HANDLES: 8;
+    /** Plaintext chunk size for encrypted artifacts (research.md R4). */
+    readonly ARTIFACT_CHUNK_BYTES: number;
+};
+export type DatabaseConfig = {
+    name: string;
+    scope: ScopeDescriptor;
+    /** Must equal the highest version in `migrations` (FR-053). */
+    schemaVersion: number;
+    collections: CollectionSchema[];
+    migrations?: Migration[];
+    /** Absent means unencrypted (FR-097). */
+    encryption?: EncryptionConfig | undefined;
+    /** Absent means excluded from platform backup (FR-109). */
+    backup?: BackupConfig;
+    /** Governs whether deleting a record removes its artifacts (FR-070). */
+    cascadeAttachments?: boolean;
+};
+/** Names a scope for the operations that legitimately need to (FR-059). */
+export type ScopeTargetConfig = {
+    name: string;
+    scope: ScopeDescriptor;
+    encryption?: EncryptionConfig | undefined;
+};
+export type DatabaseTargetConfig = {
+    name: string;
+};
+//# sourceMappingURL=config.d.ts.map

package/lib/typescript/module/contract/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../../src/contract/config.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAc,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAU,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAS,CAAC;AAE/C,mFAAmF;AACnF,eAAO,MAAM,OAAO;;;;;;;;;IASnB,qEAAqE;;CAE5D,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,eAAe,CAAC;IACvB,+DAA+D;IAC/D,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,yCAAyC;IACzC,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC1C,2DAA2D;IAC3D,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,wEAAwE;IACxE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,2EAA2E;AAC3E,MAAM,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,eAAe,CAAC;IACvB,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;CACb,CAAC"}

package/lib/typescript/module/contract/encryption.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Opt-in encryption at rest under an app-supplied key.
+ *
+ * The package never generates, derives from its own material, persists,
+ * caches beyond the handle's lifetime, transmits, or returns a key (FR-098).
+ * Keeping key acquisition on the app side is also what keeps a keychain
+ * dependency out of this package entirely (LIB-004).
+ */
+import type { ResolvedScope } from './scope.js';
+/**
+ * Implemented by the consuming app. Receives the scope so an app can key per
+ * identity — which is what makes destroying one identity's key meaningful
+ * (FR-104).
+ */
+export type KeyProvider = {
+    getKey(scope: ResolvedScope): Promise<string>;
+};
+export type EncryptionConfig = {
+    enabled: true;
+    keyProvider: KeyProvider;
+};
+/**
+ * What the package will say about its own at-rest posture. Reported so a
+ * consumer can make an accurate privacy disclosure rather than assume one.
+ */
+export type EncryptionPosture = {
+    enabled: boolean;
+    /** Whether SQLCipher is actually compiled into the app (research.md R1a). */
+    available: boolean;
+};
+//# sourceMappingURL=encryption.d.ts.map

package/lib/typescript/module/contract/encryption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../../../../src/contract/encryption.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAS,CAAC;AAE7C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,MAAM,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,EAAE,WAAW,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,6EAA6E;IAC7E,SAAS,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/lib/typescript/module/contract/errors.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Diagnostic codes.
+ *
+ * Stable identifiers so an app can choose a response without parsing a
+ * message (FR-074, FR-082). Disk-full, filesystem-access, and corruption stay
+ * distinct rather than collapsing into a generic write failure (FR-076) —
+ * an app frees space for one, retries after unlock for another, and offers a
+ * reset for the third.
+ *
+ * Full table with recommended recovery per code:
+ * specs/008-rn-local-db-package/contracts/errors.md
+ */
+export declare const DiagnosticCodes: {
+    readonly CONFIG_INVALID: "CONFIG_INVALID";
+    readonly INVALID_SCOPE: "INVALID_SCOPE";
+    readonly MIGRATION_CONFIG_INVALID: "MIGRATION_CONFIG_INVALID";
+    readonly OPEN_FAILED: "OPEN_FAILED";
+    readonly CLOSED_HANDLE: "CLOSED_HANDLE";
+    readonly SCOPE_DELETED: "SCOPE_DELETED";
+    readonly CORRUPTION: "CORRUPTION";
+    readonly STORAGE_ACCESS: "STORAGE_ACCESS";
+    readonly MIGRATION_FAILED: "MIGRATION_FAILED";
+    readonly SCHEMA_DOWNGRADE: "SCHEMA_DOWNGRADE";
+    readonly RECORD_NOT_FOUND: "RECORD_NOT_FOUND";
+    readonly RECORD_CONFLICT: "RECORD_CONFLICT";
+    readonly RECORD_TOO_LARGE: "RECORD_TOO_LARGE";
+    readonly BATCH_TOO_LARGE: "BATCH_TOO_LARGE";
+    readonly DISK_FULL: "DISK_FULL";
+    readonly WRITE_FAILED: "WRITE_FAILED";
+    readonly QUERY_INVALID: "QUERY_INVALID";
+    readonly PAGE_SIZE_INVALID: "PAGE_SIZE_INVALID";
+    readonly CURSOR_INVALID: "CURSOR_INVALID";
+    readonly TRANSACTION_FAILED: "TRANSACTION_FAILED";
+    readonly TRANSACTION_STATE: "TRANSACTION_STATE";
+    readonly ATTACHMENT_MISSING: "ATTACHMENT_MISSING";
+    readonly ATTACHMENT_OUT_OF_BOUNDS: "ATTACHMENT_OUT_OF_BOUNDS";
+    readonly ATTACHMENT_WRITE_FAILED: "ATTACHMENT_WRITE_FAILED";
+    readonly ATTACHMENT_UNDECRYPTABLE: "ATTACHMENT_UNDECRYPTABLE";
+    readonly KEY_INVALID: "KEY_INVALID";
+    readonly KEY_PROVIDER_FAILED: "KEY_PROVIDER_FAILED";
+    readonly ENCRYPTION_MISMATCH: "ENCRYPTION_MISMATCH";
+    readonly ENCRYPTION_UNAVAILABLE: "ENCRYPTION_UNAVAILABLE";
+};
+export type DiagnosticCode = (typeof DiagnosticCodes)[keyof typeof DiagnosticCodes];
+/**
+ * Codes worth retrying. `KEY_PROVIDER_FAILED` is here because a locked device
+ * is an expected condition, not a bug (FR-102).
+ */
+export declare const RETRYABLE_CODES: ReadonlySet<DiagnosticCode>;
+//# sourceMappingURL=errors.d.ts.map

package/lib/typescript/module/contract/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../src/contract/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6ClB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,WAAW,CAAC,cAAc,CAStD,CAAC"}

package/lib/typescript/module/contract/migration.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Versioned migrations.
+ *
+ * The package never writes a migration and never alters domain data except
+ * through one the domain supplied (FR-056).
+ */
+import type { Transaction } from './transaction.js';
+/** Low-level escape hatch for schema work a migration needs. */
+/** A value SQLite can bind. */
+export type SqlParameter = string | number | boolean | null;
+export type MigrationContext = Omit<Transaction, 'attachments'> & {
+    /** Execute a raw statement against the scope's database. */
+    execute(sql: string, params?: SqlParameter[]): Promise<void>;
+};
+export type Migration = {
+    /** Unique, contiguous, and reaching the declared schemaVersion (FR-053). */
+    version: number;
+    migrate(context: MigrationContext): Promise<void>;
+};
+export type MigrationOutcome = 'applied' | 'failed';
+export type MigrationLedgerEntry = {
+    version: number;
+    attemptedAt: number;
+    outcome: MigrationOutcome;
+    /** A diagnostic code only — never a message, which could carry payload. */
+    failureCode?: string;
+};
+/**
+ * Attached to a MIGRATION_FAILED error so an app can tell a transient failure
+ * from a permanent one and choose retry, reset, or asking the user (FR-057c).
+ */
+export type MigrationFailureDetail = {
+    recordedVersion: number;
+    failingVersion: number;
+    outcome: MigrationOutcome;
+};
+//# sourceMappingURL=migration.d.ts.map

package/lib/typescript/module/contract/migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../../src/contract/migration.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAe,CAAC;AAEjD,gEAAgE;AAGhE,+BAA+B;AAC/B,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE5D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG;IACjE,4DAA4D;IAC5D,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACvB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,gBAAgB,CAAC;CAC1B,CAAC"}

package/lib/typescript/module/contract/query.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Query contract.
+ *
+ * A query carries no scope, because it cannot address one — scope is bound to
+ * the handle and immutable (FR-008a). That absence is the isolation
+ * guarantee, not a convention.
+ */
+import type { StorableRecordData, StoredRecord } from './record.js';
+/** Values a filter may compare against. */
+export type FilterValue = string | number | boolean | null;
+export type ComparisonOperator = 'eq' | 'ne' | 'lt' | 'lte' | 'gt' | 'gte' | 'in' | 'nin' | 'between' | 'isNull' | 'isNotNull' | 'exists';
+export type ComparisonNode = {
+    op: 'eq' | 'ne' | 'lt' | 'lte' | 'gt' | 'gte';
+    field: string;
+    value: FilterValue;
+} | {
+    op: 'in' | 'nin';
+    field: string;
+    value: FilterValue[];
+} | {
+    op: 'between';
+    field: string;
+    value: [FilterValue, FilterValue];
+} | {
+    op: 'isNull' | 'isNotNull';
+    field: string;
+}
+/** Distinguishes an absent field from one holding null (FR-019). */
+ | {
+    op: 'exists';
+    field: string;
+    value: boolean;
+};
+export type LogicalNode = {
+    op: 'and';
+    nodes: FilterNode[];
+} | {
+    op: 'or';
+    nodes: FilterNode[];
+} | {
+    op: 'not';
+    node: FilterNode;
+};
+export type FilterNode = ComparisonNode | LogicalNode;
+export type SortDirection = 'asc' | 'desc';
+export type SortKey = {
+    field: string;
+    direction?: SortDirection;
+};
+export type PageRequest = {
+    /** 1..500 (FR-036, FR-088). */
+    size: number;
+    /** Opaque keyset cursor from a previous page. */
+    cursor?: string | undefined;
+};
+export type Query = {
+    filter?: FilterNode | undefined;
+    sort?: SortKey[] | undefined;
+    page?: PageRequest | undefined;
+    /** Soft-deleted records are excluded unless this is true (FR-021). */
+    includeSoftDeleted?: boolean;
+};
+export type ResultPage<T extends StorableRecordData = StorableRecordData> = {
+    records: StoredRecord<T>[];
+    /** Absent when there is no further page. */
+    cursor?: string | undefined;
+    hasMore: boolean;
+};
+/**
+ * Development-only answer to "is this query covered by an index?" (FR-037).
+ * Backed by EXPLAIN QUERY PLAN on the SQLite adapter.
+ */
+export type IndexCoverageReport = {
+    collection: string;
+    usesIndex: boolean;
+    indexName?: string | undefined;
+    detail: string;
+};
+//# sourceMappingURL=query.d.ts.map

package/lib/typescript/module/contract/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../src/contract/query.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,aAAU,CAAC;AAEjE,2CAA2C;AAC3C,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAC3B,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,SAAS,GACT,QAAQ,GACR,WAAW,GACX,QAAQ,CAAC;AAEZ,MAAM,MAAM,cAAc,GACvB;IAAE,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,GACpF;IAAE,EAAE,EAAE,IAAI,GAAG,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,WAAW,EAAE,CAAA;CAAE,GACzD;IAAE,EAAE,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;CAAE,GACnE;IAAE,EAAE,EAAE,QAAQ,GAAG,WAAW,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;AAC/C,oEAAoE;GAClE;IAAE,EAAE,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEnD,MAAM,MAAM,WAAW,GACpB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,UAAU,EAAE,CAAA;CAAE,GAClC;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,UAAU,EAAE,CAAA;CAAE,GACjC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC;AAEnC,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC;AAEtD,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAC;AAE3C,MAAM,MAAM,OAAO,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IACnB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;IAC7B,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAAI;IAC3E,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3B,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;CACf,CAAC"}

package/lib/typescript/module/contract/record.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Records and the four value conditions.
+ *
+ * The distinction FR-019 requires — record absent, field explicitly null,
+ * field absent, record soft-deleted — is preserved because reads reconstruct
+ * from the stored payload alone and never from projected columns. See
+ * research.md R6.
+ */
+import type { DeletionOutcome } from './attachment.js';
+/** Anything the package will store and hand back unchanged. */
+export type StorableValue = string | number | boolean | null | StorableValue[] | {
+    [key: string]: StorableValue;
+};
+export type StorableRecordData = {
+    [key: string]: StorableValue;
+};
+export type RecordInput<T extends StorableRecordData = StorableRecordData> = {
+    id: string;
+    data: T;
+};
+export type StoredRecord<T extends StorableRecordData = StorableRecordData> = {
+    id: string;
+    data: T;
+    /** Present only when the collection declares timestamps (FR-020). */
+    createdAt?: number;
+    updatedAt?: number;
+    /** Present only when soft-deleted (FR-021). */
+    deletedAt?: number | null;
+};
+export type WriteOperation = 'created' | 'updated' | 'deleted' | 'restored';
+/** An upsert reports which it actually was (FR-026). */
+export type WriteOutcome = {
+    operation: WriteOperation;
+    id: string;
+    /**
+     * Present on a delete when `cascadeAttachments` is on: which attachment files
+     * went with the record and which could not be removed (FR-071). Inside a
+     * transaction the files are removed once it commits, so `removedArtifacts`
+     * lists what was scheduled. Added in 0.2.0.
+     */
+    cascade?: DeletionOutcome;
+};
+//# sourceMappingURL=record.d.ts.map

package/lib/typescript/module/contract/record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../../../../src/contract/record.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAc,CAAC;AAEpD,+DAA+D;AAC/D,MAAM,MAAM,aAAa,GACxB,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,aAAa,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAAC;AAEvF,MAAM,MAAM,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAAC;AAElE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAAI;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;CACR,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAAI;IAC7E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;IACR,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAE5E,wDAAwD;AACxD,MAAM,MAAM,YAAY,GAAG;IAC1B,SAAS,EAAE,cAAc,CAAC;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;CAC1B,CAAC"}

package/lib/typescript/module/contract/schema.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Collection schema: structure only.
+ *
+ * Declaring a field makes it queryable and projectable. It does NOT restrict
+ * what a record may contain — undeclared fields are stored and returned
+ * faithfully, they are simply not filterable or sortable (FR-017, FR-034).
+ */
+export type FieldType = 'string' | 'number' | 'boolean' | 'timestamp';
+export type FieldDeclaration = {
+    name: string;
+    type: FieldType;
+    /** Whether the projected column tolerates SQL NULL. Purely a query concern. */
+    nullable?: boolean;
+};
+export type IndexDeclaration = {
+    name: string;
+    /** Must all reference declared fields (FR-006). */
+    fields: string[];
+    unique?: boolean;
+};
+export type CollectionSchema = {
+    name: string;
+    fields: FieldDeclaration[];
+    indexes?: IndexDeclaration[];
+    /**
+     * Opt-in per collection, off by default. When on, deleted rows are
+     * excluded from queries unless explicitly requested (FR-021).
+     */
+    softDelete?: boolean;
+    /** When on, the package maintains createdAt / updatedAt (FR-020). */
+    timestamps?: boolean;
+};
+//# sourceMappingURL=schema.d.ts.map

package/lib/typescript/module/contract/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/contract/schema.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtE,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,CAAC;IAChB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/lib/typescript/module/contract/scope.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Storage scope: the isolation boundary for all data.
+ *
+ * Components are opaque values the consuming app supplies. The package
+ * composes, normalizes, and validates them but never interprets them, and
+ * never invents one of its own (FR-008, FR-009).
+ */
+export type ScopeKind = 'guest' | 'identity' | 'tenant' | 'workspace' | 'custom';
+/**
+ * What an app supplies to name a scope.
+ *
+ * Every component is treated as sensitive (FR-014): none of these values
+ * reaches disk, a log, or an error. Only the SHA-256 digest of the canonical
+ * form does.
+ */
+export type ScopeDescriptor = {
+    kind: ScopeKind;
+    /** Required for every kind except `guest`. */
+    id?: string;
+    tenant?: string;
+    app?: string;
+    environment?: string;
+    namespace?: string;
+};
+/** The resolved scope: a hex digest, plus the kind it came from. */
+export type ResolvedScope = {
+    /** SHA-256 hex of the canonical descriptor. Names the scope's directory. */
+    key: string;
+    kind: ScopeKind;
+};
+/** Where a scope sits in its lifecycle. Persisted in the catalog (FR-063). */
+export type ScopeDeletionState = 'active' | 'deleting';
+//# sourceMappingURL=scope.d.ts.map

package/lib/typescript/module/contract/scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../../../../src/contract/scope.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEjF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,SAAS,CAAC;IAChB,8CAA8C;IAC9C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,aAAa,GAAG;IAC3B,4EAA4E;IAC5E,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,SAAS,CAAC;CAChB,CAAC;AAEF,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,UAAU,CAAC"}