@haverstack/record-adapter-do-sqlite 0.26.0 → 0.28.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { StackCapabilities, StackRecord, RecordChangeSet, RecordVersion, ActorOptions, TypeId, StackQuery, QueryResult, FileId, VersionsQuery, JournalQuery, RecordJournalEntry, StackType, AssociationEdit } from '@haverstack/core';
-import { StackRecordAdapter, JournalOptions } from '@haverstack/core/adapter';
+import { StackCapabilities, StackRecord, TypeId, QueryResult, FileId, BaseId, VersionsQuery, RecordVersion, JournalQuery, RecordJournalEntry, StackType, AssociationEdit, DataAssociation, AuthorityAssociation } from '@haverstack/core';
+import { StackRecordAdapter, JournalOptions, MutateOptions, AspectWriteOptions, AdapterQuery, Reach, ElementWriteOptions } from '@haverstack/core/adapter';
 
 /**
  * Normalizes a SQLite binding's call convention (array-bind-then-step,
@@ -23,14 +23,10 @@ interface SqlExecutor {
     /** Run a parameterized statement and return all result rows. */
     all<T = Record<string, unknown>>(sql: string, params?: readonly unknown[]): T[];
     /**
-     * Run `fn` atomically: every statement it issues commits together, or
-     * none do if it throws. `fn` must be synchronous and call back into
-     * this executor only — not every engine's transaction primitive can
-     * straddle a suspended call. A binding with a real multi-statement
-     * transaction (BEGIN/COMMIT/ROLLBACK) implements this with one; a
-     * binding whose transaction primitive is itself a callback wrapper
-     * (e.g. a Durable Object's storage.transactionSync) can pass `fn`
-     * straight through to it.
+     * Run `fn` atomically: every statement it issues commits, or none do if it
+     * throws. A callback rather than BEGIN/COMMIT text because some engines
+     * only offer one (a Durable Object's storage.transactionSync); for the
+     * same reason `fn` must be synchronous and use only this executor.
      */
     transaction<T>(fn: () => T): T;
 }
@@ -43,7 +39,7 @@ type StackConfig = {
 
 /**
  * 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.
@@ -66,30 +62,18 @@ declare abstract class SharedSqlRecordAdapter implements StackRecordAdapter {
     protected constructor(exec: SqlExecutor, config: StackConfig);
     createRecord(record: StackRecord, opts?: JournalOptions): Promise<StackRecord>;
     getRecord(id: string): Promise<StackRecord | null>;
-    mutateRecord(id: string, changes: RecordChangeSet, opts?: {
-        ifVersion?: number;
-        snapshot?: RecordVersion;
-        bumpsVersion?: boolean;
-    } & ActorOptions & JournalOptions): 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;
-        ifVersion?: number;
-        snapshot?: RecordVersion;
-    } & ActorOptions & JournalOptions): Promise<StackRecord | null>;
-    undeleteRecord(id: string, opts?: {
-        ifVersion?: number;
-        snapshot?: RecordVersion;
-    } & ActorOptions & JournalOptions): Promise<StackRecord>;
-    restoreVersion(id: string, version: number, opts?: {
-        ifVersion?: number;
-        snapshot?: RecordVersion;
-    } & ActorOptions & JournalOptions): Promise<StackRecord>;
-    commitMigration(id: string, toTypeId: TypeId, content: Record<string, unknown>, opts?: {
-        ifVersion?: number;
-        snapshot?: RecordVersion;
-    } & ActorOptions & JournalOptions): Promise<StackRecord>;
-    queryRecords(query: StackQuery): Promise<QueryResult>;
-    deleteUnreferencedAttachmentRecords(fileId: FileId, metadataTypeIds: TypeId[]): Promise<StackRecord[]>;
+    } & 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: 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>;
@@ -97,7 +81,10 @@ declare abstract class SharedSqlRecordAdapter implements StackRecordAdapter {
     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>;
 }