@kubun/db-adapter 0.3.2 → 0.5.0

package/lib/index.d.ts

@@ -1,4 +1,3 @@
 export { AbstractPostgresAdapter, type PostgresTypes } from './postgres.js';
 export { AbstractSQLiteAdapter, type SQLiteTypes } from './sqlite.js';
-export type { AbstractAdapter, Adapter, AdapterTypes } from './types.js';
-//# sourceMappingURL=index.d.ts.map
+export type { AbstractAdapter, Adapter, AdapterTypes, SearchHit, SearchIndexConfig, SearchQuery, } from './types.js';

package/lib/index.js

@@ -1,2 +1 @@
-export { AbstractPostgresAdapter } from './postgres.js';
-export { AbstractSQLiteAdapter } from './sqlite.js';
+export{AbstractPostgresAdapter}from"./postgres.js";export{AbstractSQLiteAdapter}from"./sqlite.js";

package/lib/postgres.d.ts

@@ -1,4 +1,5 @@
-import type { AbstractAdapter, AdapterTypes, ColumnTypes, Functions } from './types.js';
+import type { Kysely } from 'kysely';
+import type { AbstractAdapter, AdapterTypes, ColumnTypes, Functions, SearchHit, SearchIndexConfig, SearchQuery } from './types.js';
 export type PostgresTypes = {
     Binary: Uint8Array;
     JSON: unknown;
@@ -11,5 +12,9 @@ export declare class AbstractPostgresAdapter<T extends AdapterTypes = PostgresTy
     encodeJSON(value: unknown): unknown;
     encodeTimestamp(value: Date): string;
     decodeTimestamp(value: string): Date;
+    createSearchIndex(db: Kysely<unknown>, config: SearchIndexConfig): Promise<void>;
+    dropSearchIndex(db: Kysely<unknown>, modelID: string): Promise<void>;
+    updateSearchEntry(db: Kysely<unknown>, modelID: string, documentID: string, fields: Record<string, string>, fieldNames: Array<string>): Promise<void>;
+    removeSearchEntry(db: Kysely<unknown>, modelID: string, documentID: string): Promise<void>;
+    searchIndex(db: Kysely<unknown>, params: SearchQuery): Promise<Array<SearchHit>>;
 }
-//# sourceMappingURL=postgres.d.ts.map

package/lib/postgres.js

@@ -1,25 +1,19 @@
-export class AbstractPostgresAdapter {
-    functions = {
-        now: 'now()'
-    };
-    types = {
-        binary: 'bytea',
-        json: 'jsonb',
-        text: 'text',
-        // Use 3 digits for timestamps to have millisecond precision, same as JS dates
-        timestamp: 'timestamptz(3)',
-        uuid: 'uuid'
-    };
-    encodeBinary(value) {
-        return value;
-    }
-    encodeJSON(value) {
-        return value;
-    }
-    encodeTimestamp(value) {
-        return value.toISOString();
-    }
-    decodeTimestamp(value) {
-        return new Date(value);
-    }
-}
+import{sql as e}from"kysely";export class AbstractPostgresAdapter{functions={now:"now()"};types={binary:"bytea",json:"jsonb",text:"text",timestamp:"timestamptz(3)",uuid:"uuid"};encodeBinary(e){return e}encodeJSON(e){return e}encodeTimestamp(e){return e.toISOString()}decodeTimestamp(e){return new Date(e)}async createSearchIndex(t,r){let a=`fts_${r.modelID}`,c=`k_${r.modelID}`;await e`
+      CREATE TABLE IF NOT EXISTS ${e.ref(a)} (
+        document_id TEXT PRIMARY KEY REFERENCES ${e.ref(c)}(id) ON DELETE CASCADE,
+        search_vector tsvector
+      )
+    `.execute(t),await e`
+      CREATE INDEX IF NOT EXISTS ${e.ref(`ftsi_${r.modelID}`)}
+      ON ${e.ref(a)} USING GIN(search_vector)
+    `.execute(t)}async dropSearchIndex(t,r){let a=`fts_${r}`;await e`DROP TABLE IF EXISTS ${e.ref(a)} CASCADE`.execute(t)}async updateSearchEntry(t,r,a,c,n){let s=`fts_${r}`,o=n.map(t=>{let r=c[t]??"";return e`to_tsvector('simple', ${r})`}).reduce((t,r)=>e`${t} || ${r}`);await e`
+      INSERT INTO ${e.ref(s)} (document_id, search_vector)
+      VALUES (${a}, ${o})
+      ON CONFLICT (document_id) DO UPDATE SET search_vector = ${o}
+    `.execute(t)}async removeSearchEntry(t,r,a){let c=`fts_${r}`;await e`DELETE FROM ${e.ref(c)} WHERE document_id = ${a}`.execute(t)}async searchIndex(t,r){let a=`fts_${r.modelID}`;return(await e`
+      SELECT document_id, ts_rank(search_vector, plainto_tsquery('simple', ${r.query})) AS rank
+      FROM ${e.ref(a)}
+      WHERE search_vector @@ plainto_tsquery('simple', ${r.query})
+      ORDER BY rank DESC
+      LIMIT ${r.limit}
+    `.execute(t)).rows.map(e=>({documentID:e.document_id,rank:e.rank}))}}

package/lib/sqlite.d.ts

@@ -1,4 +1,5 @@
-import type { AbstractAdapter, AdapterTypes, ColumnTypes, Functions } from './types.js';
+import type { Kysely } from 'kysely';
+import type { AbstractAdapter, AdapterTypes, ColumnTypes, Functions, SearchHit, SearchIndexConfig, SearchQuery } from './types.js';
 export type SQLiteTypes = {
     Binary: Uint8Array;
     JSON: string;
@@ -11,5 +12,9 @@ export declare class AbstractSQLiteAdapter<T extends AdapterTypes = SQLiteTypes>
     encodeJSON(value: unknown): string;
     encodeTimestamp(value: Date): number;
     decodeTimestamp(value: number): Date;
+    createSearchIndex(db: Kysely<unknown>, config: SearchIndexConfig): Promise<void>;
+    dropSearchIndex(db: Kysely<unknown>, modelID: string): Promise<void>;
+    updateSearchEntry(db: Kysely<unknown>, modelID: string, documentID: string, fields: Record<string, string>, fieldNames: Array<string>): Promise<void>;
+    removeSearchEntry(db: Kysely<unknown>, modelID: string, documentID: string): Promise<void>;
+    searchIndex(db: Kysely<unknown>, params: SearchQuery): Promise<Array<SearchHit>>;
 }
-//# sourceMappingURL=sqlite.d.ts.map

package/lib/sqlite.js

@@ -1,27 +1,6 @@
-import { sql } from 'kysely';
-export class AbstractSQLiteAdapter {
-    functions = {
-        now: sql`(unixepoch())`
-    };
-    types = {
-        binary: 'blob',
-        json: 'jsonb',
-        text: 'text',
-        timestamp: 'integer',
-        uuid: 'text'
-    };
-    encodeBinary(value) {
-        return value;
-    }
-    encodeJSON(value) {
-        return JSON.stringify(value);
-    }
-    encodeTimestamp(value) {
-        // SQLite timestamps are stored in seconds
-        return Math.floor(value.getTime() / 1000);
-    }
-    decodeTimestamp(value) {
-        // SQLite timestamps are stored in seconds
-        return new Date(value * 1000);
-    }
-}
+import{sql as e}from"kysely";export class AbstractSQLiteAdapter{functions={now:e`(unixepoch())`};types={binary:"blob",json:"jsonb",text:"text",timestamp:"integer",uuid:"text"};encodeBinary(e){return e}encodeJSON(e){return JSON.stringify(e)}encodeTimestamp(e){return Math.floor(e.getTime()/1e3)}decodeTimestamp(e){return new Date(1e3*e)}async createSearchIndex(t,r){let a=`fts_${r.modelID}`,n=["document_id UNINDEXED",...r.fields].join(", ");await e`CREATE VIRTUAL TABLE IF NOT EXISTS ${e.ref(a)} USING fts5(${e.raw(n)})`.execute(t)}async dropSearchIndex(t,r){let a=`fts_${r}`;await e`DROP TABLE IF EXISTS ${e.ref(a)}`.execute(t)}async updateSearchEntry(t,r,a,n,i){let c=`fts_${r}`;await e`DELETE FROM ${e.ref(c)} WHERE document_id = ${a}`.execute(t);let o=["document_id",...i].join(", "),d=[a,...i.map(e=>n[e]??"")].map(t=>e.lit(t));await e`INSERT INTO ${e.ref(c)} (${e.raw(o)}) VALUES (${e.join(d)})`.execute(t)}async removeSearchEntry(t,r,a){let n=`fts_${r}`;await e`DELETE FROM ${e.ref(n)} WHERE document_id = ${a}`.execute(t)}async searchIndex(t,r){let a=`fts_${r.modelID}`;return(await e`
+      SELECT document_id, rank FROM ${e.ref(a)}
+      WHERE ${e.ref(a)} MATCH ${r.query}
+      ORDER BY rank
+      LIMIT ${r.limit}
+    `.execute(t)).rows.map(e=>({documentID:e.document_id,rank:e.rank}))}}

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { ColumnDataType, Dialect, RawBuilder } from 'kysely';
+import type { ColumnDataType, Dialect, Kysely, RawBuilder } from 'kysely';
 export type ColumnTypes = {
     binary: ColumnDataType;
     json: ColumnDataType;
@@ -14,6 +14,19 @@ export type AdapterTypes = {
     JSON: unknown;
     Timestamp: unknown;
 };
+export type SearchIndexConfig = {
+    modelID: string;
+    fields: Array<string>;
+};
+export type SearchQuery = {
+    query: string;
+    modelID: string;
+    limit: number;
+};
+export type SearchHit = {
+    documentID: string;
+    rank: number;
+};
 export type AbstractAdapter<T extends AdapterTypes = AdapterTypes> = {
     functions: Functions;
     types: ColumnTypes;
@@ -21,8 +34,12 @@ export type AbstractAdapter<T extends AdapterTypes = AdapterTypes> = {
     encodeJSON(value: unknown): T['JSON'];
     encodeTimestamp(value: Date): T['Timestamp'];
     decodeTimestamp(value: T['Timestamp']): Date;
+    createSearchIndex(db: Kysely<unknown>, config: SearchIndexConfig): Promise<void>;
+    dropSearchIndex(db: Kysely<unknown>, modelID: string): Promise<void>;
+    updateSearchEntry(db: Kysely<unknown>, modelID: string, documentID: string, fields: Record<string, string>, fieldNames: Array<string>): Promise<void>;
+    removeSearchEntry(db: Kysely<unknown>, modelID: string, documentID: string): Promise<void>;
+    searchIndex(db: Kysely<unknown>, params: SearchQuery): Promise<Array<SearchHit>>;
 };
 export type Adapter<T extends AdapterTypes = AdapterTypes> = AbstractAdapter<T> & {
     dialect: Dialect;
 };
-//# sourceMappingURL=types.d.ts.map

package/lib/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/db-adapter",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -15,7 +15,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "kysely": "^0.28.2"
+    "kysely": "^0.28.11"
   },
   "scripts": {
     "build:clean": "del lib",
@@ -24,7 +24,7 @@
     "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
     "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
     "test:types": "tsc --noEmit",
-    "test:unit": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test:unit": "vitest run",
     "test": "pnpm run test:types && pnpm run test:unit"
   }
 }

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,KAAK,aAAa,EAAE,MAAM,eAAe,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAA;AACrE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA"}

package/lib/postgres.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"postgres.d.ts","sourceRoot":"","sources":["../src/postgres.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEvF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qBAAa,uBAAuB,CAAC,CAAC,SAAS,YAAY,GAAG,aAAa,CACzE,YAAW,eAAe,CAAC,CAAC,CAAC;IAE7B,SAAS,EAEJ,SAAS,CAAA;IAEd,KAAK,EAOA,WAAW,CAAA;IAEhB,YAAY,CAAC,KAAK,EAAE,UAAU;IAI9B,UAAU,CAAC,KAAK,EAAE,OAAO;IAIzB,eAAe,CAAC,KAAK,EAAE,IAAI;IAI3B,eAAe,CAAC,KAAK,EAAE,MAAM;CAG9B"}

package/lib/sqlite.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sqlite.d.ts","sourceRoot":"","sources":["../src/sqlite.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEvF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qBAAa,qBAAqB,CAAC,CAAC,SAAS,YAAY,GAAG,WAAW,CACrE,YAAW,eAAe,CAAC,CAAC,CAAC;IAE7B,SAAS,EAEJ,SAAS,CAAA;IAEd,KAAK,EAMA,WAAW,CAAA;IAEhB,YAAY,CAAC,KAAK,EAAE,UAAU;IAI9B,UAAU,CAAC,KAAK,EAAE,OAAO;IAIzB,eAAe,CAAC,KAAK,EAAE,IAAI;IAK3B,eAAe,CAAC,KAAK,EAAE,MAAM;CAI9B"}

package/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAEjE,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,cAAc,CAAA;IACtB,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,cAAc,CAAA;IACpB,SAAS,EAAE,cAAc,CAAA;IACzB,IAAI,EAAE,cAAc,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI;IACnE,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,WAAW,CAAA;IAClB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAA;IAC5C,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,CAAA;IACrC,eAAe,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,CAAA;IAC5C,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;IAChF,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA"}