@kubun/db 0.7.0 → 0.8.1

package/lib/db.d.ts

@@ -1,122 +1,40 @@
-import { EventEmitter } from '@enkaku/event';
-import type { Adapter, AdapterTypes } from '@kubun/db-adapter';
-import { DocumentID, DocumentModelID } from '@kubun/id';
+import type { Adapter, ColumnTypes, Functions } from '@kubun/db-adapter';
 import { type Logger } from '@kubun/logger';
-import type { DocumentModel, DocumentModelsRecord, DocumentNode } from '@kubun/protocol';
 import { Kysely, type Migration } from 'kysely';
-import type { CountDocumentsParams, Database, DocumentData, GraphModel, InsertDocumentAttachment, InsertMutationLogEntry, ListDocumentsParams, MutationLogEntry, QueryDocumentsParams, QueryDocumentsResult, SearchConfig, SearchDocumentResult, SearchDocumentsParams } from './types.js';
-export type Migrations = Record<string, Migration>;
-export type DocumentCreatedEvent = {
-    type: 'create';
-    document: DocumentNode;
-    getCursor: () => string;
-};
-export type DocumentUpdatedEvent = {
-    type: 'update';
-    document: DocumentNode;
-    previous: DocumentNode;
-    getCursor: () => string;
-};
-export type DocumentSavedEvent = DocumentCreatedEvent | DocumentUpdatedEvent;
-export type DBEvents = {
-    'document:saved': DocumentSavedEvent;
-};
-export type DBParams<T extends AdapterTypes = AdapterTypes> = {
-    adapter: Adapter<T>;
+export type MigrationContext = {
+    types: ColumnTypes;
+    functions: Functions;
+};
+export type StoreDefinition<Tables, API> = {
+    name: string;
+    migrations: Record<string, Migration> | ((ctx: MigrationContext) => Record<string, Migration>);
+    dependsOn?: Array<string>;
+    createAPI: (db: Kysely<Tables>, adapter: Adapter) => API;
+};
+export type StoreProvider<Stores extends Record<string, unknown> = Record<string, unknown>> = {
+    getStore<S extends keyof Stores & string>(name: S): Promise<Stores[S]>;
+    onCommit(fn: () => void): void;
+};
+export type KubunDBParams = {
+    adapter: Adapter;
     logger?: Logger;
 };
-export type GraphModelWithRecord = GraphModel & {
-    record: DocumentModelsRecord;
-};
-export type DocumentParams = {
-    id: DocumentID;
-    data: DocumentData | null;
-};
-export type CreateDocumentParams = DocumentParams & {
-    owner: string;
-    unique: Uint8Array;
-};
-export type SaveDocumentParams = DocumentParams & {
-    existing: DocumentNode;
-};
-export type CreateGraphParams = {
-    aliases?: Record<string, string>;
-    id?: string;
-    name?: string;
-    record: DocumentModelsRecord;
-    search?: SearchConfig;
-};
-export type AddDocumentModelParams = {
-    id: string;
-    graphModelID: string;
-    model: DocumentModel;
-};
-export type WritableDB = {
-    readonly events: EventEmitter<DBEvents>;
-    getDocument(id: DocumentID): Promise<DocumentNode | null>;
-    getDocumentModel(id: DocumentModelID | string): Promise<DocumentModel>;
-    createDocument(params: CreateDocumentParams): Promise<DocumentNode>;
-    saveDocument(params: SaveDocumentParams): Promise<DocumentNode>;
-    insertMutationLogEntry(entry: InsertMutationLogEntry): Promise<void>;
-    hasMutationHash(hash: string): Promise<boolean>;
-    updateMutationStatus(mutationHash: string, status: string): Promise<void>;
-    getFieldHLCs(documentID: string): Promise<Record<string, string> | null>;
-    updateFieldHLCs(docID: DocumentID, fieldHLCs: Record<string, string>): Promise<void>;
-};
-export declare class KubunDB<T extends AdapterTypes = AdapterTypes> {
+export declare class KubunDB implements StoreProvider {
     #private;
-    constructor(params: DBParams<T>);
-    /** @internal */
+    constructor(params: KubunDBParams);
     get adapter(): Adapter;
-    get events(): EventEmitter<DBEvents>;
-    getDB<T extends Database>(): Promise<Kysely<T>>;
-    withTransaction<R>(fn: (db: WritableDB) => Promise<R>): Promise<R>;
-    getMigrations(): Migrations;
+    register<Tables, API>(store: StoreDefinition<Tables, API>): void;
+    getStore<T>(name: string): Promise<T>;
+    onCommit(fn: () => void): void;
+    /**
+     * Runs `fn` inside a DB transaction and provides a scoped `StoreProvider`.
+     * Concurrent calls on the same `KubunDB` instance are supported — the
+     * underlying driver serializes them.
+     *
+     * Callers MUST use the provided `tx` inside the callback. Calling
+     * `db.withTransaction` on the same instance inside the callback opens a
+     * new independent transaction (no atomic nesting) and is a bug.
+     */
+    withTransaction<Stores extends Record<string, unknown>, R>(fn: (tx: StoreProvider<Stores>) => Promise<R>): Promise<R>;
     close(): Promise<void>;
-    listGraphs(): Promise<Array<GraphModel>>;
-    createGraph(params: CreateGraphParams): Promise<string>;
-    getGraph(id: string): Promise<GraphModelWithRecord | null>;
-    getDocumentModel(id: DocumentModelID | string): Promise<DocumentModel>;
-    getDocument(id: DocumentID): Promise<DocumentNode | null>;
-    listDocuments(params: ListDocumentsParams): Promise<Array<DocumentNode>>;
-    countDocuments(params: CountDocumentsParams): Promise<number>;
-    queryDocuments(params: QueryDocumentsParams): Promise<QueryDocumentsResult>;
-    createDocument(params: CreateDocumentParams): Promise<DocumentNode>;
-    saveDocument(params: SaveDocumentParams): Promise<DocumentNode>;
-    insertMutationLogEntry(entry: InsertMutationLogEntry): Promise<void>;
-    hasMutationHash(hash: string): Promise<boolean>;
-    getMutationLogForDocuments(documentIDs: Array<string>): Promise<Array<MutationLogEntry>>;
-    getPendingMutations(documentID: string): Promise<Array<MutationLogEntry>>;
-    updateMutationStatus(mutationHash: string, status: string): Promise<void>;
-    getFieldHLCs(documentID: string): Promise<Record<string, string> | null>;
-    updateFieldHLCs(docID: DocumentID, fieldHLCs: Record<string, string>): Promise<void>;
-    getDocumentIDsForScope(scopes: Array<{
-        modelID: string;
-        ownerDID: string;
-    }>, excludedDocumentIDs?: Array<string>): Promise<Array<string>>;
-    getDocumentMetadataForSync(modelID: string, documentIDs: Array<string>): Promise<Array<{
-        id: string;
-        model: string;
-        owner: string;
-    }>>;
-    addAttachments(attachments: Array<InsertDocumentAttachment>): Promise<void>;
-    getUserModelAccessDefault(ownerDID: string, modelID: string, permissionType: 'read' | 'write'): Promise<{
-        level: string;
-        allowedDIDs: Array<string> | null;
-    } | null>;
-    setUserModelAccessDefault(params: {
-        ownerDID: string;
-        modelID: string;
-        permissionType: 'read' | 'write';
-        accessLevel: string;
-        allowedDIDs: Array<string> | null;
-    }): Promise<void>;
-    removeUserModelAccessDefaults(ownerDID: string, modelID: string, permissionTypes: Array<string>): Promise<void>;
-    listDocumentModelIDs(): Promise<Array<string>>;
-    queryDocumentsByOwner(modelID: string, ownerDID: string): Promise<Array<DocumentNode>>;
-    createSearchIndex(modelID: string, fields: Array<string>): Promise<void>;
-    dropSearchIndex(modelID: string): Promise<void>;
-    updateSearchEntry(modelID: string, documentID: string, data: Record<string, unknown>, fields: Array<string>): Promise<void>;
-    removeSearchEntry(modelID: string, documentID: string): Promise<void>;
-    searchDocuments(params: SearchDocumentsParams): Promise<Array<SearchDocumentResult>>;
 }

package/lib/db.js

@@ -1 +1 @@
-import{EventEmitter as e}from"@enkaku/event";import{DocumentID as t,DocumentModelID as a}from"@kubun/id";import{getKubunLogger as i}from"@kubun/logger";import{Kysely as r,Migrator as s,ParseJSONResultsPlugin as n}from"kysely";import{serializeCursor as d}from"./cursor.js";import{getMigrations as o}from"./migrations/migrations.js";import{applyDocumentFilter as l,applyDocumentOrderBy as u,applyPagination as c}from"./query-builder.js";function h(e){let t={version:e.version,name:e.name,behavior:e.behavior,interfaces:e.interfaces,schema:e.schema,fieldsMeta:e.fields_meta};return"unique"===t.behavior&&(t.uniqueFields=e.unique_fields),t}function m(e,t){return{id:t.id,model:t.model,owner:t.owner,data:t.data,createdAt:e.decodeTimestamp(t.created_at),updatedAt:t.updated_at?e.decodeTimestamp(t.updated_at):null}}function w(e,t){let i=a.fromString(t);return i.isLocal?i.toGlobal(a.fromString(e)).toString():t}export class KubunDB{#e;#t;#a;#i;#r;constructor(t){this.#e=t.adapter,this.#t=new r({dialect:this.#e.dialect,plugins:[new n]}),this.#a=new e,this.#i=t.logger??i("db"),this.#r=this.#s()}get adapter(){return this.#e}get events(){return this.#a}getDB(){return this.#r.then(()=>this.#t)}async withTransaction(e){await this.#r;let a=this.#e,i=this.#a,r=[],s=await this.#t.transaction().setIsolationLevel("read committed").execute(async s=>await e({events:i,getDocumentModel:async e=>h(await s.selectFrom("kubun_document_models").selectAll().where("id","=",e.toString()).executeTakeFirstOrThrow()),async getDocument(e){let t=await s.selectFrom(`k_${e.model.toString()}`).selectAll().where("id","=",e.toString()).executeTakeFirst();return t?m(a,t):null},async createDocument(e){let t=e.id.toString(),i=e.id.model.toString(),n=await s.insertInto(`k_${i}`).values({id:t,owner:e.owner,model:i,data:a.encodeJSON(e.data),unique:a.encodeBinary(e.unique)}).returningAll().executeTakeFirst(),o=m(a,n);return r.push({type:"create",document:o,getCursor:()=>d({id:n.id,ts:+n.created_at})}),o},async saveDocument(e){let t=e.id.toString(),i=await s.updateTable(`k_${e.id.model.toString()}`).set({data:e.data?a.encodeJSON(e.data):null,updated_at:a.encodeTimestamp(new Date)}).where("id","=",t).returningAll().executeTakeFirst(),n=m(a,i);return r.push({type:"update",document:n,previous:e.existing,getCursor:()=>d({id:i.id,ts:+i.created_at})}),n},async insertMutationLogEntry(e){await s.insertInto("kubun_mutation_log").values(e).onConflict(e=>e.doNothing()).execute()},hasMutationHash:async e=>null!=await s.selectFrom("kubun_mutation_log").select("mutation_hash").where("mutation_hash","=",e).executeTakeFirst(),async updateMutationStatus(e,t){await s.updateTable("kubun_mutation_log").set({status:t}).where("mutation_hash","=",e).execute()},async getFieldHLCs(e){let a=t.fromString(e).model.toString(),i=await s.selectFrom(`k_${a}`).select("field_hlcs").where("id","=",e).executeTakeFirst();if(i?.field_hlcs==null)return null;let r=i.field_hlcs;return"string"==typeof r?JSON.parse(r):r},async updateFieldHLCs(e,t){let i=e.model.toString();await s.updateTable(`k_${i}`).set({field_hlcs:a.encodeJSON(t)}).where("id","=",e.toString()).execute()}}));for(let e of r)i.emit("document:saved",e);return s}async #s(){let e=new s({db:this.#t,provider:{getMigrations:()=>Promise.resolve(this.getMigrations())}}),t=await e.migrateToLatest();if(null!=t.error)throw t.error;this.#i.info("ready")}getMigrations(){return o(this.#e)}async close(){await this.#r,await this.#t.destroy(),this.#i.info("closed")}async listGraphs(){return await this.#r,await this.#t.selectFrom("kubun_graph_models").selectAll().execute()}async createGraph(e){await this.#r;let t=e.id??globalThis.crypto.randomUUID(),a=e.name??t;return await this.#t.transaction().setIsolationLevel("read committed").execute(async i=>{await i.insertInto("kubun_graph_models").values({aliases:JSON.stringify(e.aliases??{}),id:t,name:a,search:e.search?JSON.stringify(e.search):null}).onConflict(e=>e.doNothing()).execute();let r=Object.entries(e.record),s=new Set;for(;s.size<r.length;){let e=r.filter(([e,t])=>!s.has(e)&&t.interfaces.every(t=>s.has(w(e,t))));if(0===e.length)throw Error("Could not create graph: no valid model to add");await Promise.all(e.map(async([e,a])=>{await this.#n(i,{id:e,graphModelID:t,model:a}),s.add(e)}))}}),this.#i.debug("created graph {id}",{id:t}),t}async #n(e,t){let{id:a,graphModelID:i,model:r}=t,s=this.#e.types;for(let t of(await this.#r,await e.schema.createTable(`k_${a}`).ifNotExists().addColumn("id",s.text,e=>e.notNull().primaryKey()).addColumn("owner",s.text,e=>e.notNull()).addColumn("model",s.text,e=>e.notNull()).addColumn("data",s.json).addColumn("field_hlcs",s.json).addColumn("unique",s.binary,e=>e.notNull()).addColumn("created_at",s.timestamp,e=>e.defaultTo(this.#e.functions.now).notNull()).addColumn("updated_at",s.timestamp).execute(),await e.insertInto("kubun_document_models").values({id:a,version:r.version,name:r.name,behavior:r.behavior,unique_fields:"unique"===r.behavior?JSON.stringify(r.uniqueFields):null,interfaces:JSON.stringify(r.interfaces),schema:JSON.stringify(r.schema),fields_meta:JSON.stringify(r.fieldsMeta)}).onConflict(e=>e.doNothing()).execute(),r.interfaces))await e.insertInto("kubun_document_model_interfaces").values({interface_id:w(a,t),implementation_id:a}).onConflict(e=>e.doNothing()).execute();await e.insertInto("kubun_graph_document_models").values({graph_model_id:i,document_model_id:a}).onConflict(e=>e.doNothing()).execute()}async getGraph(e){await this.#r;let t=await this.#t.selectFrom("kubun_graph_models").selectAll().where("id","=",e).executeTakeFirst();if(null==t)return null;let a={};for(let t of(await this.#t.selectFrom("kubun_graph_document_models").innerJoin("kubun_document_models","kubun_graph_document_models.document_model_id","kubun_document_models.id").selectAll("kubun_document_models").where("kubun_graph_document_models.graph_model_id","=",e).execute()))a[t.id]=h(t);return{...t,record:a}}async getDocumentModel(e){return await this.#r,h(await this.#t.selectFrom("kubun_document_models").selectAll().where("id","=",e.toString()).executeTakeFirstOrThrow())}async getDocument(e){await this.#r;let t=await this.#t.selectFrom(`k_${e.model.toString()}`).selectAll().where("id","=",e.toString()).executeTakeFirst();return t?m(this.#e,t):null}async listDocuments(e){await this.#r;let[t,...a]=e.modelIDs,i=this.#t.selectFrom(`k_${t}`).selectAll().where("id","in",e.docIDs);for(let t of a)i=i.unionAll(a=>a.selectFrom(`k_${t}`).selectAll().where("id","in",e.docIDs));return(await i.execute()).map(e=>m(this.#e,e))}async countDocuments(e){let{filter:t,modelIDs:a,owner:i}=e;await this.#r;let r=this.#e.coerceFilterValue.bind(this.#e);return(await Promise.all(a.map(async e=>{let a=this.#t.selectFrom(`k_${e}`).select(e=>e.fn.countAll().as("count"));return null!=i&&(a=a.where("owner","=",i)),null!=t&&(a=a.where(e=>l(e,t,[],r))),Number((await a.executeTakeFirstOrThrow()).count)}))).reduce((e,t)=>e+t,0)}async queryDocuments(e){let{filter:t,modelIDs:a,orderBy:i,owner:r,...s}=e,n=null!=e.last;await this.#r;let o=this.#e.coerceFilterValue.bind(this.#e),[h,...w]=a,_=this.#t.selectFrom(`k_${h}`).selectAll();for(let e of(null!=r&&(_=_.where("owner","=",r)),null!=t&&(_=_.where(e=>l(e,t,[],o))),w))_=_.unionAll(a=>{let i=a.selectFrom(`k_${e}`).selectAll();return null!=r&&(i=i.where("owner","=",r)),null!=t&&(i=i.where(e=>l(e,t,[],o))),i});let[p,y]=u(_,i,n),[g,f]=c(p,s,i),b=await g.execute(),k=n?b.slice(0,f).reverse():b.slice(0,f);return{entries:y?k.map(e=>{let t={};for(let a of y){let i=e.data;for(let e of a)null!=i&&(i=i[e]);null!=i&&(t[a.join(".")]=i)}return{cursor:d({id:e.id,values:t}),document:m(this.#e,e)}}):k.map(e=>({cursor:d({id:e.id,ts:+e.created_at}),document:m(this.#e,e)})),hasMore:k.length>f}}async createDocument(e){await this.#r;let t=e.id.toString(),a=e.id.model.toString(),i={id:t,owner:e.owner,model:a,data:this.#e.encodeJSON(e.data),unique:this.#e.encodeBinary(e.unique)},r=await this.#t.transaction().setIsolationLevel("read committed").execute(async e=>await e.insertInto(`k_${a}`).values(i).returningAll().executeTakeFirst()),s=m(this.#e,r);return this.#a.emit("document:saved",{type:"create",document:s,getCursor:()=>d({id:r.id,ts:+r.created_at})}),this.#i.debug("created document {id} with model {model}",{id:t,model:a}),s}async saveDocument(e){await this.#r;let t=e.id.toString(),a={data:e.data?this.#e.encodeJSON(e.data):null,updated_at:this.#e.encodeTimestamp(new Date)},i=await this.#t.transaction().setIsolationLevel("read committed").execute(async i=>await i.updateTable(`k_${e.id.model.toString()}`).set(a).where("id","=",t).returningAll().executeTakeFirst()),r=m(this.#e,i);return this.#a.emit("document:saved",{type:"update",document:r,previous:e.existing,getCursor:()=>d({id:i.id,ts:+i.created_at})}),this.#i.debug("updated document {id}",{id:t}),r}async insertMutationLogEntry(e){await this.#r,await this.#t.insertInto("kubun_mutation_log").values(e).onConflict(e=>e.doNothing()).execute()}async hasMutationHash(e){return await this.#r,null!=await this.#t.selectFrom("kubun_mutation_log").select("mutation_hash").where("mutation_hash","=",e).executeTakeFirst()}async getMutationLogForDocuments(e){return 0===e.length?[]:(await this.#r,await this.#t.selectFrom("kubun_mutation_log").selectAll().where("document_id","in",e).orderBy("hlc","asc").execute())}async getPendingMutations(e){return await this.#r,await this.#t.selectFrom("kubun_mutation_log").selectAll().where("document_id","=",e).where("status","=","pending").orderBy("hlc","asc").execute()}async updateMutationStatus(e,t){await this.#r,await this.#t.updateTable("kubun_mutation_log").set({status:t}).where("mutation_hash","=",e).execute()}async getFieldHLCs(e){await this.#r;let a=t.fromString(e).model.toString(),i=await this.#t.selectFrom(`k_${a}`).select("field_hlcs").where("id","=",e).executeTakeFirst();if(i?.field_hlcs==null)return null;let r=i.field_hlcs;return"string"==typeof r?JSON.parse(r):r}async updateFieldHLCs(e,t){await this.#r;let a=e.model.toString();await this.#t.updateTable(`k_${a}`).set({field_hlcs:this.#e.encodeJSON(t)}).where("id","=",e.toString()).execute()}async getDocumentIDsForScope(e,t=[]){await this.#r;let a=[];for(let t of e)try{let e=await this.#t.selectFrom(`k_${t.modelID}`).select("id").where("owner","=",t.ownerDID).execute();a.push(...e.map(e=>e.id))}catch{}if(t.length>0){let e=new Set(t);return a.filter(t=>!e.has(t))}return a}async getDocumentMetadataForSync(e,t){return 0===t.length?[]:(await this.#r,(await this.#t.selectFrom(`k_${e}`).select(["id","model","owner"]).where("id","in",t).execute()).map(e=>({id:e.id,model:e.model,owner:e.owner})))}async addAttachments(e){await this.#r,await this.#t.insertInto("kubun_document_attachments").values(e).onConflict(e=>e.doNothing()).execute()}async getUserModelAccessDefault(e,t,a){await this.#r;let i=await this.#t.selectFrom("kubun_user_model_access_defaults").select(["access_level","allowed_dids"]).where("owner_did","=",e).where("model_id","=",t).where("permission_type","=",a).executeTakeFirst();return i?{level:i.access_level,allowedDIDs:i.allowed_dids}:null}async setUserModelAccessDefault(e){await this.#r,await this.#t.insertInto("kubun_user_model_access_defaults").values({owner_did:e.ownerDID,model_id:e.modelID,permission_type:e.permissionType,access_level:e.accessLevel,allowed_dids:e.allowedDIDs?this.#e.encodeJSON(e.allowedDIDs):null}).onConflict(t=>t.columns(["owner_did","model_id","permission_type"]).doUpdateSet({access_level:e.accessLevel,allowed_dids:e.allowedDIDs?this.#e.encodeJSON(e.allowedDIDs):null,updated_at:this.#e.encodeTimestamp(new Date)})).execute()}async removeUserModelAccessDefaults(e,t,a){await this.#r,await this.#t.deleteFrom("kubun_user_model_access_defaults").where("owner_did","=",e).where("model_id","=",t).where("permission_type","in",a).execute()}async listDocumentModelIDs(){return await this.#r,(await this.#t.selectFrom("kubun_document_models").select("id").execute()).map(e=>e.id)}async queryDocumentsByOwner(e,t){return await this.#r,(await this.#t.selectFrom(`k_${e}`).selectAll().where("owner","=",t).execute()).map(e=>m(this.#e,e))}async createSearchIndex(e,t){await this.#r,await this.#e.createSearchIndex(this.#t,{modelID:e,fields:t})}async dropSearchIndex(e){await this.#r,await this.#e.dropSearchIndex(this.#t,e)}async updateSearchEntry(e,t,a,i){await this.#r;let r={};for(let e of i){let t=this.#d(a,e);null!=t&&(r[e]=String(t))}await this.#e.updateSearchEntry(this.#t,e,t,r,i)}async removeSearchEntry(e,t){await this.#r,await this.#e.removeSearchEntry(this.#t,e,t)}async searchDocuments(e){await this.#r;let t=[];for(let a of e.modelIDs)for(let i of(await this.#e.searchIndex(this.#t,{query:e.query,modelID:a,limit:e.first??50})))t.push({documentID:i.documentID,modelID:a,rank:i.rank});return(t.sort((e,t)=>Math.abs(t.rank)-Math.abs(e.rank)),e.first)?t.slice(0,e.first):t}#d(e,t){let a=t.split("."),i=e;for(let e of a){if(null==i||"object"!=typeof i)return null;i=i[e]}return i}}
+import{getKubunLogger as t}from"@kubun/logger";import{Kysely as e,Migrator as r,ParseJSONResultsPlugin as i}from"kysely";export class KubunDB{#t;#e;#r;#i=new Map;#s=new Map;#a=new Map;constructor(r){this.#t=r.adapter,this.#e=new e({dialect:this.#t.dialect,plugins:[new i]}),this.#r=r.logger??t("db")}get adapter(){return this.#t}register(t){let e=this.#a.get(t.name);if(null!=e){e!==t&&this.#r.warn('store "{name}" registered with different definition, ignoring',{name:t.name});return}this.#a.set(t.name,t)}async getStore(t){if(await this.#o(t),!this.#s.has(t)){let e=this.#a.get(t);if(null==e)throw Error(`Store "${t}" is not registered`);this.#s.set(t,e.createAPI(this.#e,this.#t))}return this.#s.get(t)}onCommit(t){t()}async withTransaction(t){await Promise.all(Array.from(this.#a.keys()).map(t=>this.#o(t)));let e=[],r=await this.#e.transaction().execute(async r=>{let i=new Map;return await t({getStore:async t=>{if(!i.has(t)){let e=this.#a.get(t);if(null==e)throw Error(`Store "${t}" is not registered`);i.set(t,e.createAPI(r,this.#t))}return i.get(t)},onCommit:t=>{e.push(t)}})});for(let t of e)t();return r}async close(){await this.#e.destroy(),this.#r.info("closed")}async #o(t){let e=this.#i.get(t);return null==e&&(e=this.#n(t).catch(e=>{throw this.#i.delete(t),e}),this.#i.set(t,e)),e}async #n(t){let e=this.#a.get(t);if(null==e)throw Error(`Store "${t}" is not registered`);for(let t of e.dependsOn??[])await this.#o(t);let i="function"==typeof e.migrations?e.migrations({types:this.#t.types,functions:this.#t.functions}):e.migrations;if(0===Object.keys(i).length)return;let s=new r({db:this.#e,provider:{getMigrations:()=>Promise.resolve(i)},migrationTableName:`kubun_${t}_migration`,migrationLockTableName:`kubun_${t}_migration_lock`}),a=await s.migrateToLatest();if(null!=a.error)throw a.error;this.#r.info("store {name} migrations complete",{name:t})}}

package/lib/index.d.ts

@@ -1,3 +1 @@
-export type { CreateGraphParams, DBEvents, DBParams, DocumentCreatedEvent, DocumentSavedEvent, GraphModelWithRecord, Migrations, WritableDB, } from './db.js';
-export { KubunDB } from './db.js';
-export type * from './types.js';
+export { KubunDB, type KubunDBParams, type MigrationContext, type StoreDefinition, type StoreProvider, } from './db.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/db",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -15,18 +15,12 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@enkaku/codec": "^0.14.0",
-    "@enkaku/event": "^0.14.1",
-    "kysely": "^0.28.11",
-    "@kubun/logger": "^0.7.0"
+    "kysely": "^0.28.16",
+    "@kubun/db-adapter": "^0.8.1",
+    "@kubun/logger": "^0.8.0"
   },
   "devDependencies": {
-    "@testcontainers/postgresql": "^11.12.0",
-    "@kubun/db-better-sqlite": "^0.7.0",
-    "@kubun/db-postgres": "^0.7.0",
-    "@kubun/db-adapter": "^0.7.0",
-    "@kubun/protocol": "^0.7.0",
-    "@kubun/id": "^0.7.0"
+    "@kubun/db-better-sqlite": "^0.8.1"
   },
   "scripts": {
     "build:clean": "del lib",
@@ -34,9 +28,8 @@
     "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
     "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
     "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
-    "test:types": "tsc --noEmit --skipLibCheck",
-    "test:vitest": "vitest run",
-    "test:unit": "pnpm rebuild && pnpm run test:vitest",
+    "test:types": "tsc --noEmit -p tsconfig.test.json",
+    "test:unit": "vitest run",
     "test": "pnpm run test:types && pnpm run test:unit"
   }
 }

package/lib/cursor.d.ts

@@ -1,7 +0,0 @@
-export type CursorData = {
-    id: string;
-    ts?: number;
-    values?: Record<string, unknown>;
-};
-export declare function parseCursor(cursor: string): CursorData;
-export declare function serializeCursor(data: CursorData): string;

package/lib/cursor.js

@@ -1 +0,0 @@
-import{b64uFromJSON as r,b64uToJSON as e}from"@enkaku/codec";export function parseCursor(r){return e(r)}export function serializeCursor(e){return r(e)}

package/lib/migrations/0-init.d.ts

@@ -1,3 +0,0 @@
-import type { Adapter } from '@kubun/db-adapter';
-import type { Migration } from 'kysely';
-export declare function getMigration(adapter: Adapter): Migration;

package/lib/migrations/0-init.js

@@ -1 +0,0 @@
-export function getMigration(e){let t=e.types;return{up:async function(a){await a.schema.createTable("kubun_document_attachments").ifNotExists().addColumn("id",t.text,e=>e.notNull().primaryKey()).addColumn("data",t.binary,e=>e.notNull()).addColumn("created_at",t.timestamp,t=>t.defaultTo(e.functions.now).notNull()).execute(),await a.schema.createTable("kubun_document_models").ifNotExists().addColumn("id",t.text,e=>e.notNull().primaryKey()).addColumn("version",t.text,e=>e.notNull()).addColumn("name",t.text,e=>e.notNull()).addColumn("behavior",t.text,e=>e.notNull()).addColumn("unique_fields",t.json).addColumn("interfaces",t.json,e=>e.notNull()).addColumn("schema",t.json,e=>e.notNull()).addColumn("fields_meta",t.json,e=>e.notNull()).addColumn("created_at",t.timestamp,t=>t.defaultTo(e.functions.now).notNull()).execute(),await a.schema.createTable("kubun_document_model_interfaces").ifNotExists().addColumn("interface_id",t.text,e=>e.notNull().references("kubun_document_models.id")).addColumn("implementation_id",t.text,e=>e.notNull().references("kubun_document_models.id")).addUniqueConstraint("kubun_document_model_interfaces_pkey",["interface_id","implementation_id"]).execute(),await a.schema.createTable("kubun_graph_models").ifNotExists().addColumn("id",t.text,e=>e.notNull().primaryKey()).addColumn("name",t.text,e=>e.notNull()).addColumn("aliases",t.json,e=>e.defaultTo("{}").notNull()).addColumn("search",t.json).addColumn("created_at",t.timestamp,t=>t.defaultTo(e.functions.now).notNull()).addColumn("updated_at",t.timestamp).execute(),await a.schema.createTable("kubun_graph_document_models").ifNotExists().addColumn("graph_model_id",t.text,e=>e.notNull().references("kubun_graph_models.id")).addColumn("document_model_id",t.text,e=>e.notNull().references("kubun_document_models.id")).addUniqueConstraint("kubun_graph_document_models_pkey",["graph_model_id","document_model_id"]).execute(),await a.schema.createTable("kubun_user_model_access_defaults").ifNotExists().addColumn("owner_did",t.text,e=>e.notNull()).addColumn("model_id",t.text,e=>e.notNull()).addColumn("permission_type",t.text,e=>e.notNull()).addColumn("access_level",t.text,e=>e.notNull()).addColumn("allowed_dids",t.json).addColumn("created_at",t.timestamp,t=>t.defaultTo(e.functions.now).notNull()).addColumn("updated_at",t.timestamp).addPrimaryKeyConstraint("kubun_user_model_access_defaults_pkey",["owner_did","model_id","permission_type"]).execute(),await a.schema.createIndex("idx_user_model_access_owner_model").on("kubun_user_model_access_defaults").columns(["owner_did","model_id"]).execute(),await a.schema.createTable("kubun_sync_checkpoints").ifNotExists().addColumn("id",t.text,e=>e.notNull().primaryKey()).addColumn("peer_server_id",t.text,e=>e.notNull()).addColumn("user_id",t.text,e=>e.notNull()).addColumn("last_sync_timestamp",t.timestamp,e=>e.notNull()).addColumn("document_checkpoints",t.json,e=>e.notNull()).addColumn("vector_clock",t.json,e=>e.notNull()).execute(),await a.schema.createIndex("idx_sync_checkpoints_peer_user").on("kubun_sync_checkpoints").columns(["peer_server_id","user_id"]).execute(),await a.schema.createTable("kubun_sync_peers").ifNotExists().addColumn("id",t.text,e=>e.notNull().primaryKey()).addColumn("peer_did",t.text,e=>e.notNull().unique()).addColumn("endpoint",t.text,e=>e.notNull()).addColumn("mode",t.text,e=>e.notNull()).addColumn("allowed_users",t.json,e=>e.notNull()).addColumn("priority",t.text,e=>e.notNull().defaultTo("0")).addColumn("trust_level",t.text,e=>e.notNull()).addColumn("config",t.json,e=>e.notNull()).addColumn("created_at",t.timestamp,t=>t.defaultTo(e.functions.now).notNull()).addColumn("updated_at",t.timestamp,t=>t.defaultTo(e.functions.now).notNull()).execute(),await a.schema.createTable("kubun_mutation_log").ifNotExists().addColumn("mutation_hash",t.text,e=>e.primaryKey()).addColumn("model_id",t.text,e=>e.notNull()).addColumn("document_id",t.text,e=>e.notNull()).addColumn("author_did",t.text,e=>e.notNull()).addColumn("hlc",t.text,e=>e.notNull()).addColumn("mutation_jwt",t.text,e=>e.notNull()).addColumn("status",t.text,e=>e.notNull().defaultTo("applied")).execute(),await a.schema.createIndex("idx_mutation_log_hlc").on("kubun_mutation_log").column("hlc").execute(),await a.schema.createIndex("idx_mutation_log_document").on("kubun_mutation_log").column("document_id").execute(),await a.schema.createIndex("idx_mutation_log_status").on("kubun_mutation_log").column("status").execute()},down:async function(e){await e.schema.dropTable("kubun_mutation_log").ifExists().execute(),await e.schema.dropTable("kubun_sync_peers").ifExists().execute(),await e.schema.dropTable("kubun_sync_checkpoints").ifExists().execute(),await e.schema.dropTable("kubun_user_model_access_defaults").ifExists().execute(),await e.schema.dropTable("kubun_graph_document_models").ifExists().execute(),await e.schema.dropTable("kubun_graph_models").ifExists().execute(),await e.schema.dropTable("kubun_document_model_interfaces").ifExists().execute(),await e.schema.dropTable("kubun_document_models").ifExists().execute(),await e.schema.dropTable("kubun_document_attachments").ifExists().execute()}}}

package/lib/migrations/migrations.d.ts

@@ -1,3 +0,0 @@
-import type { Adapter } from '@kubun/db-adapter';
-import type { Migration } from 'kysely';
-export declare function getMigrations(adapter: Adapter): Record<string, Migration>;

package/lib/migrations/migrations.js

@@ -1 +0,0 @@
-import{getMigration as i}from"./0-init.js";export function getMigrations(t){return{kubunMigration0:i(t)}}

package/lib/query-builder.d.ts

@@ -1,12 +0,0 @@
-import type { AnyValueFilter, DocumentFilter, DocumentOrderBy } from '@kubun/protocol';
-import type { ExpressionBuilder, ExpressionWrapper, SelectQueryBuilder } from 'kysely';
-import type { ConnectionArguments, Database, Document } from './types.js';
-export type CoerceFilterValue = (value: unknown) => unknown;
-type DocumentExpressionBuilder = ExpressionBuilder<Database, 'k_document'>;
-type DocumentExpressionWrapper = ExpressionWrapper<Database, 'k_document', any>;
-export type DocumentQueryBuilder = SelectQueryBuilder<Database, 'k_document', Document>;
-export declare function applyPagination(query: DocumentQueryBuilder, args: ConnectionArguments, orderBy?: DocumentOrderBy): [DocumentQueryBuilder, number];
-export declare function applyDocumentFilter(eb: DocumentExpressionBuilder, filter: DocumentFilter, path?: Array<string>, coerce?: CoerceFilterValue): DocumentExpressionWrapper;
-export declare function applyValueFilter(eb: DocumentExpressionBuilder, keys: Array<string>, filter: AnyValueFilter, coerce?: CoerceFilterValue): DocumentExpressionWrapper;
-export declare function applyDocumentOrderBy(queryBuilder: DocumentQueryBuilder, orderBy?: DocumentOrderBy, isReverse?: boolean): [DocumentQueryBuilder, Array<Array<string>> | null];
-export {};

package/lib/query-builder.js

@@ -1 +0,0 @@
-import{parseCursor as e}from"./cursor.js";function t(e=50){return Math.min(e,100)}function r(e,t){let r=e.ref("data","->>");for(let e of t)r=r.key(e);return r}function n(e){let t=[],r=e;do{let[e,n]=Object.entries(r)[0];if(t.push(e),"string"==typeof n)return{keys:t,direction:n};r=n}while(null!=r)throw Error("Could not extract field entry")}function l(e,t=!1){return t?"asc"===e?"desc":"asc":e}export function applyPagination(l,a,o=[]){let{first:i,last:u,before:c,after:d}=a;if(null!=i){let a=t(i);return[function(t,l,a,o){let i=t;if(null!=a){let{id:t,ts:l,values:u}=e(a);null!=l?i=i.where(e=>e.or([e("created_at",">",l),e("created_at","=",l).and("id",">",t)])):null!=u&&(i=i.where(e=>{let l=[];for(let a of o){let o=n(a),i=u[o.keys.join(".")];if(null==i)continue;let c=r(e,o.keys);l.push(e.or([e(c,"asc"===o.direction?">":"<",i),e(c,"=",i).and("id",">",t)]))}return e.and(l)}))}return i.orderBy("created_at","asc").limit(l)}(l,a+1,d,o),a]}if(null!=u){let a=t(u);return[function(t,l,a,o){let i=t;if(null!=a){let{id:t,ts:l,values:u}=e(a);null!=l?i=i.where(e=>e.or([e("created_at","<",l),e("created_at","=",l).and("id","<",t)])):null!=u&&(i=i.where(e=>{let l=[];for(let a of o){let o=n(a),i=u[o.keys.join(".")];if(null==i)continue;let c=r(e,o.keys);l.push(e.or([e(c,"asc"===o.direction?"<":">",i),e(c,"=",i).and("id",">",t)]))}return e.and(l)}))}return i.orderBy("created_at","desc").limit(l)}(l,a+1,c,o),a]}let s=t();return[l.orderBy("created_at","asc").limit(s+1),s]}export function applyDocumentFilter(e,t,r=[],n){let l=Object.entries(t);if(1!==l.length)throw Error("Invalid document filter");let[a,o]=l[0];switch(a){case"where":var i,u,c,d;let s;return i=e,u=o,c=r,d=n,s=Object.entries(u).map(([e,t])=>applyValueFilter(i,[...c,e],t,d)),i.and(s);case"and":return e.and(o.map(t=>applyDocumentFilter(e,t,r,n)));case"or":return e.or(o.map(t=>applyDocumentFilter(e,t,r,n)));case"not":return e.not(applyDocumentFilter(e,o,r,n));default:throw Error(`Invalid document filter type: ${a}`)}}export function applyValueFilter(e,t,n,l){let a=Object.entries(n);if(1!==a.length)throw Error("Invalid value filter");let o=r(e,t),[i,u]=a[0],c=l??(e=>e);switch(i){case"isNull":return e(o,!0===u?"is":"is not",null);case"equalTo":return e(o,"=",c(u));case"notEqualTo":return e(o,"!=",c(u));case"in":return e(o,"in",u.map(c));case"notIn":return e(o,"not in",u.map(c));case"lessThan":return e(o,"<",c(u));case"lessThanOrEqualTo":return e(o,"<=",c(u));case"greaterThan":return e(o,">",c(u));case"greaterThanOrEqualTo":return e(o,">=",c(u));default:throw Error(`Invalid value filter type: ${i}`)}}export function applyDocumentOrderBy(e,t=[],n=!1){if(0===t.length)return[e.orderBy("created_at",l("asc",n)),null];let o=e,i=[];for(let e of t){let[t,u]=function e(t,n,o,i=[]){let u=Object.entries(n);if(1!==u.length)throw Error("Invalid order by field");let[c,d]=u[0],s=[...i,c],f=a[c];return null!=f?[t.orderBy(f,l(d,o)),s]:"string"==typeof d?[t.orderBy(e=>r(e,s),l(d,o)),s]:e(t,d,o,s)}(o,e,n);o=t,i.push(u)}return[o,i]}let a={_createdAt:"created_at",_owner:"owner"};

package/lib/types.d.ts

@@ -1,184 +0,0 @@
-import type { DocumentFieldsMeta, DocumentFilter, DocumentModelSchema, DocumentNode, DocumentOrderBy } from '@kubun/protocol';
-import type { ColumnType, Insertable, JSONColumnType, Selectable, Updateable } from 'kysely';
-type CreatedAtColumn = ColumnType<number, number | undefined, never>;
-type UpdatedAtColumn = ColumnType<number, number | undefined, number | undefined>;
-export type ConnectionArguments = {
-    before?: string | null;
-    after?: string | null;
-    first?: number | null;
-    last?: number | null;
-};
-export type DocumentData = Record<string, unknown>;
-export type DocumentTable<Data extends DocumentData = DocumentData> = {
-    id: string;
-    owner: string;
-    model: string;
-    data: JSONColumnType<Data> | null;
-    field_hlcs: JSONColumnType<Record<string, string>> | null;
-    unique: Uint8Array;
-    created_at: CreatedAtColumn;
-    updated_at: UpdatedAtColumn;
-};
-export type Document<Data extends DocumentData = DocumentData> = Selectable<DocumentTable<Data>>;
-export type InsertDocument<Data extends DocumentData = DocumentData> = Insertable<DocumentTable<Data>>;
-export type UpdateDocument<Data extends DocumentData = DocumentData> = Updateable<DocumentTable<Data>>;
-export type DocumentAttachmentTable = {
-    id: string;
-    data: Uint8Array;
-    created_at: CreatedAtColumn;
-};
-export type DocumentAttachment = Selectable<DocumentAttachmentTable>;
-export type InsertDocumentAttachment = Insertable<DocumentAttachmentTable>;
-export type DocumentModelTable = {
-    id: string;
-    version: string;
-    name: string;
-    behavior: string;
-    unique_fields: JSONColumnType<Array<string>> | null;
-    interfaces: JSONColumnType<Array<string>>;
-    schema: JSONColumnType<DocumentModelSchema>;
-    fields_meta: JSONColumnType<DocumentFieldsMeta>;
-    created_at: CreatedAtColumn;
-    updated_at: UpdatedAtColumn;
-};
-export type DocumentModel = Selectable<DocumentModelTable>;
-export type InsertDocumentModel = Insertable<DocumentModelTable>;
-export type UpdateDocumentModel = Updateable<DocumentModelTable>;
-export type DocumentModelInterfaceTable = {
-    interface_id: string;
-    implementation_id: string;
-};
-export type DocumentModelInterface = Selectable<DocumentModelInterfaceTable>;
-export type InsertDocumentModelInterface = Insertable<DocumentModelInterfaceTable>;
-export type MutationLogTable = {
-    mutation_hash: string;
-    model_id: string;
-    document_id: string;
-    author_did: string;
-    hlc: string;
-    mutation_jwt: string;
-    status: string;
-};
-export type MutationLogEntry = Selectable<MutationLogTable>;
-export type InsertMutationLogEntry = Insertable<MutationLogTable>;
-export type SearchConfig = Record<string, {
-    fields?: Array<string>;
-}>;
-export type SearchDocumentsParams = {
-    query: string;
-    modelIDs: Array<string>;
-    first?: number;
-    after?: string;
-};
-export type SearchDocumentResult = {
-    documentID: string;
-    modelID: string;
-    rank: number;
-};
-export type GraphModelTable = {
-    id: string;
-    name: string;
-    aliases: JSONColumnType<Record<string, string>>;
-    search: JSONColumnType<SearchConfig> | null;
-    created_at: CreatedAtColumn;
-    updated_at: UpdatedAtColumn;
-};
-export type GraphModel = Selectable<GraphModelTable>;
-export type InsertGraphModel = Insertable<GraphModelTable>;
-export type UpdateGraphModel = Updateable<GraphModelTable>;
-export type GraphDocumentModelTable = {
-    graph_model_id: string;
-    document_model_id: string;
-};
-export type GraphDocumentModel = Selectable<GraphDocumentModelTable>;
-export type InsertGraphDocumentModel = Insertable<GraphDocumentModelTable>;
-export type UserModelAccessDefaultTable = {
-    owner_did: string;
-    model_id: string;
-    permission_type: string;
-    access_level: string;
-    allowed_dids: JSONColumnType<Array<string>> | null;
-    created_at: CreatedAtColumn;
-    updated_at: UpdatedAtColumn;
-};
-export type UserModelAccessDefault = Selectable<UserModelAccessDefaultTable>;
-export type InsertUserModelAccessDefault = Insertable<UserModelAccessDefaultTable>;
-export type UpdateUserModelAccessDefault = Updateable<UserModelAccessDefaultTable>;
-export type SyncCheckpointTable = {
-    id: string;
-    peer_server_id: string;
-    user_id: string;
-    last_sync_timestamp: ColumnType<number, number, number>;
-    document_checkpoints: JSONColumnType<Record<string, {
-        lastKnownHash: string;
-        lastSyncedSequence: number;
-    }>>;
-    vector_clock: JSONColumnType<Record<string, number>>;
-};
-export type SyncCheckpoint = Selectable<SyncCheckpointTable>;
-export type InsertSyncCheckpoint = Insertable<SyncCheckpointTable>;
-export type SyncPeerTable = {
-    id: string;
-    peer_did: string;
-    endpoint: string;
-    mode: string;
-    allowed_users: JSONColumnType<Array<string> | {
-        all: boolean;
-    }>;
-    priority: string;
-    trust_level: string;
-    config: JSONColumnType<Record<string, unknown>>;
-    created_at: CreatedAtColumn;
-    updated_at: UpdatedAtColumn;
-};
-export type SyncPeer = Selectable<SyncPeerTable>;
-export type InsertSyncPeer = Insertable<SyncPeerTable>;
-export type AccessPermissions = {
-    read?: {
-        level: 'only_owner' | 'anyone' | 'allowed_dids';
-        allowedDIDs?: Array<string>;
-    };
-    write?: {
-        level: 'only_owner' | 'allowed_dids';
-        allowedDIDs?: Array<string>;
-    };
-};
-export type DocumentTables<Models extends Record<string, DocumentData> = Record<string, DocumentData>, Keys = keyof Models> = {
-    [K in string & Keys]: DocumentTable<Models[K]>;
-};
-export type Database = {
-    kubun_document_attachments: DocumentAttachmentTable;
-    kubun_document_models: DocumentModelTable;
-    kubun_document_model_interfaces: DocumentModelInterfaceTable;
-    kubun_mutation_log: MutationLogTable;
-    kubun_graph_document_models: GraphDocumentModelTable;
-    kubun_graph_models: GraphModelTable;
-    kubun_user_model_access_defaults: UserModelAccessDefaultTable;
-    kubun_sync_checkpoints: SyncCheckpointTable;
-    kubun_sync_peers: SyncPeerTable;
-    [key: `k_${string}`]: DocumentTable;
-};
-export type CursorDocument = {
-    cursor: string;
-    document: DocumentNode;
-};
-export type ListDocumentsParams = {
-    modelIDs: Array<string>;
-    docIDs: Array<string>;
-};
-export type QueryDocumentsParams = ConnectionArguments & {
-    modelIDs: Array<string>;
-    filter?: DocumentFilter;
-    orderBy?: DocumentOrderBy;
-    owner?: string;
-};
-export type CountDocumentsParams = {
-    modelIDs: Array<string>;
-    filter?: DocumentFilter;
-    owner?: string;
-};
-export type QueryDocumentsResult = {
-    entries: Array<CursorDocument>;
-    hasMore: boolean;
-};
-export {};

package/lib/types.js

@@ -1 +0,0 @@
-export{};