@haverstack/record-adapter-do-sqlite 0.27.0 → 0.29.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { StackCapabilities, StackRecord, RecordChangeSet, TypeId, StackQuery, QueryResult, FileId, VersionsQuery, RecordVersion, JournalQuery, RecordJournalEntry, StackType, AssociationEdit } from '@haverstack/core';
-import { StackRecordAdapter, JournalOptions, MutateOptions, BumpVersionOptions } from '@haverstack/core/adapter';
+import { StackRecordAdapter, JournalOptions, RecordHistory, MutateOptions, AspectWriteOptions, AdapterQuery, Reach, ElementWriteOptions, StoreSeed } from '@haverstack/core/adapter';
+import { StackCapabilities, ConfigContent, StackRecord, TypeId, QueryResult, FileId, BaseId, VersionsQuery, RecordVersion, JournalQuery, RecordJournalEntry, StackType, AssociationEdit, DataAssociation, AuthorityAssociation } from '@haverstack/core';
 
 /**
  * Normalizes a SQLite binding's call convention (array-bind-then-step,
@@ -31,15 +31,9 @@ interface SqlExecutor {
     transaction<T>(fn: () => T): T;
 }
 
-/** timezone is optional passthrough app metadata — no default. */
-type StackConfig = {
-    entityId: string;
-    timezone: string | undefined;
-};
-
 /**
  * The engine-independent half of a SQLite-backed StackRecordAdapter: the
- * capability declaration and the delegation of all seventeen
+ * capability declaration and the delegation of all twenty-three
  * StackRecordAdapter methods onto SharedSqlRecordLogic. Every method here
  * is a forward with no engine-specific content, so an adapter that owns a
  * SqlExecutor already knows how to answer all of them.
@@ -57,28 +51,33 @@ type StackConfig = {
 declare abstract class SharedSqlRecordAdapter implements StackRecordAdapter {
     readonly capabilities: StackCapabilities;
     readonly ownerEntityId: string;
-    readonly timezone: string | undefined;
     private readonly record;
-    protected constructor(exec: SqlExecutor, config: StackConfig);
+    protected constructor(exec: SqlExecutor, config: ConfigContent);
     createRecord(record: StackRecord, opts?: JournalOptions): Promise<StackRecord>;
+    importRecord(record: StackRecord, history: RecordHistory): Promise<StackRecord>;
     getRecord(id: string): Promise<StackRecord | null>;
-    mutateRecord(id: string, changes: RecordChangeSet, opts?: MutateOptions & BumpVersionOptions): Promise<StackRecord>;
+    patchContent(id: string, patch: Record<string, unknown | null>, opts?: MutateOptions): Promise<StackRecord>;
+    setParent(id: string, parentId: string | null, opts?: AspectWriteOptions): Promise<StackRecord>;
+    setUnlisted(id: string, unlisted: boolean, opts?: AspectWriteOptions): Promise<StackRecord>;
     deleteRecord(id: string, opts?: {
         purge?: boolean;
     } & MutateOptions): Promise<StackRecord | null>;
     undeleteRecord(id: string, opts?: MutateOptions): Promise<StackRecord>;
     restoreVersion(id: string, version: number, opts?: MutateOptions): Promise<StackRecord>;
     commitMigration(id: string, toTypeId: TypeId, content: Record<string, unknown>, opts?: MutateOptions): Promise<StackRecord>;
-    queryRecords(query: StackQuery): Promise<QueryResult>;
-    deleteUnreferencedAttachmentRecords(fileId: FileId, metadataTypeIds: TypeId[]): Promise<StackRecord[]>;
+    queryRecords(query: AdapterQuery): Promise<QueryResult>;
+    queryReadable(query: AdapterQuery, reach: Reach): Promise<QueryResult>;
+    deleteUnreferencedAttachmentRecords(fileId: FileId, metadataBaseId: BaseId): Promise<StackRecord[]>;
     getVersions(id: string, query?: VersionsQuery): Promise<RecordVersion[]>;
     getVersion(id: string, version: number): Promise<RecordVersion | null>;
-    saveVersion(id: string, version: RecordVersion): Promise<void>;
     getJournal(id: string, query?: JournalQuery): Promise<RecordJournalEntry[]>;
     saveType(type: StackType): Promise<void>;
     getType(id: TypeId): Promise<StackType | null>;
     listTypes(): Promise<StackType[]>;
-    amendAssociations(recordId: string, changes: AssociationEdit[], opts?: JournalOptions): Promise<StackRecord>;
+    editAssociations(id: string, edits: AssociationEdit[], opts?: ElementWriteOptions<DataAssociation>): Promise<StackRecord>;
+    setAssociations(id: string, associations: DataAssociation[], opts?: ElementWriteOptions<DataAssociation>): Promise<StackRecord>;
+    editAccess(id: string, edits: AssociationEdit[], opts?: ElementWriteOptions<AuthorityAssociation>): Promise<StackRecord>;
+    setAccess(id: string, permissions: AuthorityAssociation[], opts?: ElementWriteOptions<AuthorityAssociation>): Promise<StackRecord>;
     abstract flush(): Promise<void>;
     abstract close(): Promise<void>;
 }
@@ -143,17 +142,23 @@ type DoSQLiteRecordAdapterOpenOptions = {
      * provider is called only when the DO's storage has none yet.
      */
     ownerEntityId: string | (() => string | Promise<string>);
-    /** IANA timezone string e.g. "America/New_York". Optional passthrough app metadata — no default. */
-    timezone?: string;
+    seed?: never;
+} | {
+    /**
+     * The `_config` record and history new storage is created holding: a
+     * copy's source's. Storage that already holds a store refuses it.
+     */
+    seed: StoreSeed;
+    ownerEntityId?: never;
 };
 declare class DoSQLiteRecordAdapter extends SharedSqlRecordAdapter {
     private constructor();
     /**
      * Open the adapter for a DO instance, creating its storage on first use.
      * A DO id either already has a config record (reattach) or it doesn't
-     * (first call — opts.ownerEntityId/timezone become the config), so there
-     * is no `create` option. Schema DDL is `CREATE TABLE IF NOT EXISTS`, so
-     * running it every call is idempotent and cheap.
+     * (first call — opts.ownerEntityId becomes the config), so there
+     * is no `create` option. A new store's tables are written in the same
+     * transaction as its config record, so storage holds a whole store or none.
      *
      * DO SQLite manages its own durability and rejects PRAGMA journal_mode
      * outright ("not authorized") — verified against the real runtime, not