@haverstack/record-adapter-sqlite 0.34.0 → 0.36.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { StackCapabilities, StackRecord, RecordChangeSet, TypeId, StackQuery, QueryResult, FileId, VersionsQuery, RecordVersion, JournalQuery, RecordJournalEntry, StackType, AssociationEdit, Actor } from '@haverstack/core';
-import { StackRecordAdapter, JournalOptions, MutateOptions, BumpVersionOptions } from '@haverstack/core/adapter';
+import { StackCapabilities, ConfigContent, StackRecord, TypeId, QueryResult, FileId, BaseId, VersionsQuery, RecordVersion, JournalQuery, RecordJournalEntry, StackType, AssociationEdit, DataAssociation, AuthorityAssociation, Actor } from '@haverstack/core';
+import { StackRecordAdapter, JournalOptions, RecordHistory, MutateOptions, AspectWriteOptions, AdapterQuery, Reach, ElementWriteOptions, StoreSeed } from '@haverstack/core/adapter';
 import { StackTokenStore, TokenSession, TokenInfo } from '@haverstack/core/wire';
 
 /**
@@ -32,15 +32,14 @@ interface SqlExecutor {
     transaction<T>(fn: () => T): T;
 }
 
-/** timezone is optional passthrough app metadata — no default. */
-type StackConfig = {
-    entityId: string;
-    timezone: string | undefined;
-};
+/** What open() does when the store is missing or present, like O_CREAT / O_EXCL. */
+type StoreCreateMode = 'never' | 'ifMissing' | 'exclusive';
+/** A plain DID, or a lazy provider called only when a store is actually created. */
+type OwnerEntityIdInput = string | (() => string | Promise<string>);
 
 /**
  * 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.
@@ -58,28 +57,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>;
 }
@@ -153,15 +157,9 @@ declare class NativeTokenStore implements StackTokenStore {
  * spread-args run/get/all calls to it).
  */
 
-/** What open() does when the store is missing or present, like O_CREAT / O_EXCL. */
-type StoreCreateMode = 'never' | 'ifMissing' | 'exclusive';
-/** A plain DID, or a lazy provider called only when a store is actually created. */
-type OwnerEntityIdInput = string | (() => string | Promise<string>);
 type NativeSQLiteRecordAdapterOpenOptions = {
     /** Absolute path to the .db file. */
     path: string;
-    /** IANA timezone string e.g. "America/New_York". Consulted only when a store is created. No default. */
-    timezone?: string;
     /**
      * Open even if a lock file from another live process is present.
      * Only needed if that process is gone but its PID was reused by
@@ -174,6 +172,7 @@ type NativeSQLiteRecordAdapterOpenOptions = {
     create?: 'never';
     /** Checked against the existing store's owner; a mismatch throws OwnerMismatchError. */
     ownerEntityId?: string;
+    seed?: never;
 } | {
     /** `'ifMissing'` opens the store if present and creates it if not; `'exclusive'` creates it and fails if present. */
     create: 'ifMissing' | 'exclusive';
@@ -182,6 +181,13 @@ type NativeSQLiteRecordAdapterOpenOptions = {
      * existing store's owner; a lazy provider is never called just to compare.
      */
     ownerEntityId: OwnerEntityIdInput;
+    seed?: never;
+} | {
+    /** A seed only creates, as `'exclusive'` does: an existing store refuses it. */
+    create?: never;
+    /** The `_config` record and history the store is created holding: a copy's source's. */
+    seed: StoreSeed;
+    ownerEntityId?: never;
 });
 declare class NativeSQLiteRecordAdapter extends SharedSqlRecordAdapter {
     private readonly path;