@aiao/rxdb-adapter-sqliteai 0.0.20

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aiao Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/RxDBAdapterSqliteai.d.ts

@@ -0,0 +1,23 @@
+import { RxDB } from '../packages/rxdb/src/index.ts';
+import { RxDBAdapterSqliteBase, SqliteClientLike } from '../packages/rxdb-adapter-sqlite-core/src/index.ts';
+import { ADAPTER_NAME, SqliteaiOptions } from './sqliteai.interface.js';
+/**
+ * 基于 `@sqliteai/sqlite-wasm` 的 RxDB 本地存储适配器。
+ *
+ * 与 `rxdb-adapter-sqlite`（官方 sqlite-wasm 绑定）API 对齐，差异：
+ * - WASM 二进制来自 SqliteAI 的发行版（OPFS / Worker 配置一致）
+ * - 客户端实现继承 `Oo1ClientBase`，复用 sqlite-core 的队列与事件批处理
+ */
+export declare class RxDBAdapterSqliteai extends RxDBAdapterSqliteBase {
+    #private;
+    readonly options: SqliteaiOptions;
+    readonly name: string;
+    constructor(rxdb: RxDB, options: SqliteaiOptions);
+    protected createClient(): Promise<SqliteClientLike>;
+}
+declare module '../packages/rxdb/src/index.ts' {
+    interface RxDBAdapters {
+        [ADAPTER_NAME]: RxDBAdapterSqliteai;
+    }
+}
+//# sourceMappingURL=RxDBAdapterSqliteai.d.ts.map

package/dist/RxDBAdapterSqliteai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RxDBAdapterSqliteai.d.ts","sourceRoot":"","sources":["../src/RxDBAdapterSqliteai.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,KAAK,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAE9F,OAAO,EAAE,YAAY,EAAE,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE7E;;;;;;GAMG;AACH,qBAAa,mBAAoB,SAAQ,qBAAqB;;IAM1D,QAAQ,CAAC,OAAO,EAAE,eAAe;IAJnC,SAAkB,IAAI,EAAE,MAAM,CAAgB;gBAG5C,IAAI,EAAE,IAAI,EACD,OAAO,EAAE,eAAe;cAMV,YAAY,IAAI,OAAO,CAAC,gBAAgB,CAAC;CAGnE;AAED,OAAO,QAAQ,YAAY,CAAC;IAC1B,UAAU,YAAY;QACpB,CAAC,YAAY,CAAC,EAAE,mBAAmB,CAAC;KACrC;CACF"}

package/dist/SqliteaiClient.d.ts

@@ -0,0 +1,14 @@
+import { BATCH_TIMEOUT, Oo1ClientBase, Oo1Static } from '../packages/rxdb-adapter-sqlite-core/src/index.ts';
+import { SqliteaiLoadOptions } from './sqliteai.interface.js';
+export { BATCH_TIMEOUT };
+/**
+ * SqliteAI 的 oo1 客户端实现。
+ *
+ * 仅声明 `clientName` 与 `loadModule`，其余生命周期（init / disconnect / 事件批处理 /
+ * 队列 / 自定义函数注册 / OPFS fallback）全部由 `Oo1ClientBase` 提供。
+ */
+export declare class SqliteaiClient extends Oo1ClientBase<SqliteaiLoadOptions> {
+    protected get clientName(): string;
+    protected loadModule(options?: SqliteaiLoadOptions): Promise<Oo1Static>;
+}
+//# sourceMappingURL=SqliteaiClient.d.ts.map

package/dist/SqliteaiClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqliteaiClient.d.ts","sourceRoot":"","sources":["../src/SqliteaiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAE9F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,EAAE,aAAa,EAAE,CAAC;AAEzB;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,aAAa,CAAC,mBAAmB,CAAC;IACpE,SAAS,KAAK,UAAU,IAAI,MAAM,CAEjC;IAED,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;CAGxE"}

package/dist/create_sqlite_client.d.ts

@@ -0,0 +1,14 @@
+import { SqliteaiOptions } from './sqliteai.interface.js';
+import { SqliteaiClient } from './SqliteaiClient.js';
+/**
+ * 创建 SqliteAI 客户端实例并完成初始化。
+ *
+ * 如果 `options` 中指定了 worker / sharedWorker，会通过 `wrapWithComlink` 把客户端代理到 worker；
+ * 否则在主线程直接 new。
+ *
+ * @param dbName - 数据库名（用于持久化文件名归一化）
+ * @param options - SqliteAI 适配器选项（含 OPFS / worker / 缓存大小等）
+ * @returns 已 `init` 完成、可直接执行 SQL 的客户端
+ */
+export declare function createSqliteClient(dbName: string, options: SqliteaiOptions): Promise<SqliteaiClient>;
+//# sourceMappingURL=create_sqlite_client.d.ts.map

package/dist/create_sqlite_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create_sqlite_client.d.ts","sourceRoot":"","sources":["../src/create_sqlite_client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAA4B,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAe1G"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { ROWID, RxDBAdapterSqliteError, SqliteRepository, buildRuleGroup, get_table_name as sqliteGetTableName, get_table_name_by_metadata as sqliteGetTableNameByMetadata } from '../packages/rxdb-adapter-sqlite-core/src/index.ts';
+export type { GenerateSqlResult } from '../packages/rxdb-adapter-sqlite-core/src/index.ts';
+export { createSqliteClient } from './create_sqlite_client.js';
+export { RxDBAdapterSqliteai } from './RxDBAdapterSqliteai.js';
+export { sqliteaiLoad } from './sqliteai-load.utils.js';
+export type { SqliteaiOptions } from './sqliteai.interface.js';
+export { SqliteaiClient } from './SqliteaiClient.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,cAAc,IAAI,kBAAkB,EACpC,0BAA0B,IAAI,4BAA4B,EAC3D,MAAM,gCAAgC,CAAC;AACxC,YAAY,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAGxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -0,0 +1,50 @@
+import { Oo1ClientBase as e, ROWID as t, RxDBAdapterSqliteBase as n, RxDBAdapterSqliteError as r, SqliteRepository as i, buildOo1InitOptions as a, buildRuleGroup as o, defaultWarn as s, get_table_name as c, get_table_name_by_metadata as l, withPatchedOpfsProxyWorker as u, withSqliteApiConfig as d, wrapWithComlink as f } from "@aiao/rxdb-adapter-sqlite-core";
+import p from "@sqliteai/sqlite-wasm";
+//#region src/sqliteai-load.utils.ts
+var m, h = !1;
+async function g(e) {
+	let t = !!e?.opfs && !!e.opfsProxyPath;
+	if (m && (!t || h)) return m;
+	let n = a(e);
+	return m = await u(e, async () => await d({ warn: s }, async () => await p(n))), h = t, m.config && (m.config.warn = s), m;
+}
+//#endregion
+//#region src/SqliteaiClient.ts
+var _ = class extends e {
+	get clientName() {
+		return "sqliteai";
+	}
+	loadModule(e) {
+		return g(e);
+	}
+};
+//#endregion
+//#region src/create_sqlite_client.ts
+async function v(e, t) {
+	let n = {
+		opfs: t.opfs,
+		wasmPath: t.wasmPath,
+		opfsProxyPath: t.opfsProxyPath,
+		locateFile: t.locateFile,
+		print: t.print,
+		printErr: t.printErr,
+		cacheSizeKb: t.cacheSizeKb,
+		batchTimeout: t.batchTimeout
+	}, r = f(new _(), t);
+	return await r.init(e, n), r;
+}
+//#endregion
+//#region src/sqliteai.interface.ts
+var y = "sqliteai", b = class extends n {
+	options;
+	#e;
+	name = y;
+	constructor(e, t) {
+		super(e, t), this.options = t, this.#e = e.config.dbName;
+	}
+	async createClient() {
+		return v(this.#e, this.options);
+	}
+};
+//#endregion
+export { t as ROWID, r as RxDBAdapterSqliteError, b as RxDBAdapterSqliteai, i as SqliteRepository, _ as SqliteaiClient, o as buildRuleGroup, v as createSqliteClient, c as sqliteGetTableName, l as sqliteGetTableNameByMetadata, g as sqliteaiLoad };

package/dist/sqliteai-load.utils.d.ts

@@ -0,0 +1,20 @@
+import { Oo1Static } from '../packages/rxdb-adapter-sqlite-core/src/index.ts';
+import { SqliteaiLoadOptions } from './sqliteai.interface.js';
+/**
+ * 清除模块级 SqliteAI WASM 缓存。
+ *
+ * 仅供测试使用：每个测试用例需要重新加载干净模块时调用，
+ * 生产代码不应依赖这个钩子。
+ */
+export declare function resetSqliteaiLoadCache(): void;
+/**
+ * 加载 SqliteAI WASM 模块（带模块级缓存）。
+ *
+ * 第一次调用会下载并初始化 WASM；之后调用复用缓存的 `Oo1Static`。
+ * 若新调用需要 OPFS proxy patch 而缓存模块未启用过，会重新加载一次以应用 patch。
+ *
+ * @param options - 加载选项（含 OPFS / wasmPath / printErr 等）
+ * @returns 共享的 `Oo1Static` 实例
+ */
+export declare function sqliteaiLoad(options?: SqliteaiLoadOptions): Promise<Oo1Static>;
+//# sourceMappingURL=sqliteai-load.utils.d.ts.map

package/dist/sqliteai-load.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqliteai-load.utils.d.ts","sourceRoot":"","sources":["../src/sqliteai-load.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,SAAS,EAGf,MAAM,gCAAgC,CAAC;AAExC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAKnE;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAG7C;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,CAmBpF"}

package/dist/sqliteai.interface.d.ts

@@ -0,0 +1,40 @@
+import { EntityType, IRxDBAdapterOptions, RepositoryBase } from '../packages/rxdb/src/index.ts';
+import { OpfsFallback, RxDBAdapterSqliteBase } from '../packages/rxdb-adapter-sqlite-core/src/index.ts';
+/**
+ * SqliteAI 适配器的可配置项（不含自定义 repository 注册）。
+ *
+ * - `opfs` / `opfsProxyPath` / `opfsFallback`：OPFS 持久化相关
+ * - `wasmPath` / `locateFile`：WASM 资源定位
+ * - `worker` / `sharedWorker` + `*Instance`：跨线程运行
+ * - `cacheSizeKb` / `batchTimeout`：性能调优
+ */
+interface SqliteaiOptionsBase extends IRxDBAdapterOptions {
+    opfs?: boolean;
+    wasmPath?: string;
+    opfsProxyPath?: string;
+    locateFile?: (name: string) => string;
+    print?: (msg: string) => void;
+    printErr?: (msg: string) => void;
+    /** @see https://www.sqlite.org/pragma.html#pragma_cache_size @default 51200 */
+    cacheSizeKb?: number;
+    /** @default 16 (BALANCED) @see BATCH_TIMEOUT */
+    batchTimeout?: number;
+    /** Behaviour when OPFS database opening fails. @default 'memory' */
+    opfsFallback?: OpfsFallback;
+    worker?: boolean;
+    workerInstance?: Worker;
+    sharedWorker?: boolean;
+    sharedWorkerInstance?: SharedWorker;
+}
+/** 自定义 Repository 类的构造器签名（用户可覆盖默认 Repository / TreeRepository）。 */
+export type SqliteaiRepositoryConstructor<T extends RepositoryBase<any>> = new (adapter: RxDBAdapterSqliteBase, EntityType: EntityType) => T;
+/** SqliteAI 适配器完整选项（含可选的自定义 Repository 注册表）。 */
+export interface SqliteaiOptions extends SqliteaiOptionsBase {
+    repositories?: Record<string, SqliteaiRepositoryConstructor<any>>;
+}
+/** `sqliteaiLoad` 接受的运行期选项子集（剥离 worker / repository 配置）。 */
+export type SqliteaiLoadOptions = Pick<SqliteaiOptionsBase, 'opfs' | 'wasmPath' | 'opfsProxyPath' | 'locateFile' | 'print' | 'printErr' | 'cacheSizeKb' | 'batchTimeout' | 'opfsFallback'>;
+/** 在 RxDB 中注册此适配器使用的名称。 */
+export declare const ADAPTER_NAME: "sqliteai";
+export {};
+//# sourceMappingURL=sqliteai.interface.d.ts.map

package/dist/sqliteai.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqliteai.interface.d.ts","sourceRoot":"","sources":["../src/sqliteai.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAClF,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE1F;;;;;;;GAOG;AACH,UAAU,mBAAoB,SAAQ,mBAAmB;IACvD,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACtC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9B,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,oBAAoB,CAAC,EAAE,YAAY,CAAC;CACrC;AAED,mEAAmE;AACnE,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,cAAc,CAAC,GAAG,CAAC,IAAI,KACzE,OAAO,EAAE,qBAAqB,EAC9B,UAAU,EAAE,UAAU,KACnB,CAAC,CAAC;AAEP,gDAAgD;AAChD,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAC;CACnE;AAED,4DAA4D;AAC5D,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,mBAAmB,EACjB,MAAM,GACN,UAAU,GACV,eAAe,GACf,YAAY,GACZ,OAAO,GACP,UAAU,GACV,aAAa,GACb,cAAc,GACd,cAAc,CACjB,CAAC;AAEF,2BAA2B;AAC3B,eAAO,MAAM,YAAY,EAAG,UAAmB,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@aiao/rxdb-adapter-sqliteai",
+  "version": "0.0.20",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@aiao/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "nx": {
+    "name": "rxdb-adapter-sqliteai",
+    "tags": [
+      "js-lib"
+    ]
+  },
+  "dependencies": {
+    "@sqliteai/sqlite-wasm": "3.50.4-sync.1.0.16-vector.0.9.95-memory.0.9.0",
+    "comlink": "^4.4.2",
+    "rxjs": "^7.8.2",
+    "@aiao/rxdb": "0.0.20",
+    "@aiao/rxdb-adapter-sqlite-core": "0.0.20"
+  },
+  "devDependencies": {
+    "ms": "^2.1.3",
+    "@aiao/rxdb-test": "0.0.20"
+  }
+}