@weapp-sqlite/wasm 0.1.0

package/README.md

@@ -0,0 +1,23 @@
+# @weapp-sqlite/wasm
+
+可注入 SQLite WASM 引擎和持久化回调的宿主无关 adapter。
+
+```bash
+pnpm add @weapp-sqlite/wasm @weapp-sqlite/core
+```
+
+```ts
+import { openSqliteWasmDatabase } from '@weapp-sqlite/wasm'
+
+const database = await openSqliteWasmDatabase(
+  initializer,
+  'app.sqlite',
+  {
+    storage,
+  },
+)
+```
+
+本包不直接访问 IndexedDB、小程序文件系统或平台 runtime。Web 使用 `@weapp-sqlite/web`，小程序使用 `@weapp-sqlite/miniprogram`，weapp-vite 项目优先使用 `@weapp-sqlite/weapp-vite`。
+
+完整文档与支持矩阵见 [weapp-sqlite 仓库](https://github.com/weapp-sqlite/weapp-sqlite)。

package/dist/index.cjs

@@ -0,0 +1,74 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _weapp_sqlite_core = require("@weapp-sqlite/core");
+//#region src/driver.ts
+function normalizeScalar(value) {
+	if (typeof value === "bigint") return Number(value);
+	if (typeof value === "boolean") return value ? 1 : 0;
+	if (value instanceof ArrayBuffer) return new Uint8Array(value);
+	return value;
+}
+function normalizeParameters(parameters) {
+	if (parameters === void 0) return;
+	if (Array.isArray(parameters)) return parameters.map(normalizeScalar);
+	return Object.fromEntries(Object.entries(parameters).map(([key, value]) => [key, normalizeScalar(value)]));
+}
+function rowsFromResult(result) {
+	return {
+		columns: result.columns,
+		rows: result.values.map((values) => {
+			const row = {};
+			result.columns.forEach((column, index) => {
+				row[column] = values[index];
+			});
+			return row;
+		})
+	};
+}
+function createConnection(database, name, storage) {
+	let dirty = false;
+	return {
+		async exec(sql, parameters) {
+			database.run(sql, normalizeParameters(parameters));
+			dirty = true;
+			const row = database.exec("SELECT changes() AS changes, last_insert_rowid() AS lastInsertRowid")[0]?.values[0];
+			return {
+				changes: Number(row?.[0] ?? 0),
+				lastInsertRowid: Number(row?.[1] ?? 0)
+			};
+		},
+		async query(sql, parameters) {
+			const result = database.exec(sql, normalizeParameters(parameters))[0];
+			return result ? rowsFromResult(result) : {
+				columns: [],
+				rows: []
+			};
+		},
+		async flush() {
+			if (!dirty) return;
+			await storage.save(name, database.export());
+			dirty = false;
+		},
+		async close() {
+			database.close();
+		}
+	};
+}
+function createSqliteWasmDriver(initializer, options) {
+	let modulePromise;
+	return {
+		kind: "wasm",
+		async open(name) {
+			modulePromise ??= initializer(options.locateFile ? { locateFile: options.locateFile } : void 0);
+			const module = await modulePromise;
+			const data = await options.storage.load(name);
+			return createConnection(new module.Database(data), name, options.storage);
+		}
+	};
+}
+async function openSqliteWasmDatabase(initializer, name, options) {
+	const connection = await createSqliteWasmDriver(initializer, options).open(name);
+	return (0, _weapp_sqlite_core.createSqliteDatabase)(name, connection);
+}
+//#endregion
+exports.createSqliteWasmDriver = createSqliteWasmDriver;
+exports.openSqliteWasmDatabase = openSqliteWasmDatabase;

package/dist/index.d.cts

@@ -0,0 +1,35 @@
+import { SqliteDatabase, SqliteDriver, SqliteParameters, SqliteScalar } from "@weapp-sqlite/core";
+//#region src/types.d.ts
+type SqlJsScalar = Exclude<SqliteScalar, bigint | boolean | ArrayBuffer>;
+type SqlJsParameters = SqlJsScalar[] | Record<string, SqlJsScalar> | null;
+interface SqlJsResult {
+  readonly columns: readonly string[];
+  readonly values: readonly (readonly unknown[])[];
+}
+interface SqlJsDatabase {
+  run: (sql: string, parameters?: SqlJsParameters) => SqlJsDatabase;
+  exec: (sql: string, parameters?: SqlJsParameters) => readonly SqlJsResult[];
+  export: () => Uint8Array;
+  close: () => void;
+}
+interface SqlJsModule {
+  readonly Database: new (data?: ArrayLike<number> | null) => SqlJsDatabase;
+}
+type SqlJsInitializer = (options?: {
+  locateFile?: (file: string) => string;
+}) => Promise<SqlJsModule>;
+interface SqliteWasmStorage {
+  load: (name: string) => Promise<Uint8Array | undefined>;
+  save: (name: string, data: Uint8Array) => Promise<void>;
+}
+interface SqliteWasmDriverOptions {
+  readonly storage: SqliteWasmStorage;
+  readonly locateFile?: (file: string) => string;
+}
+type SqliteWasmParameters = SqliteParameters;
+//#endregion
+//#region src/driver.d.ts
+declare function createSqliteWasmDriver(initializer: SqlJsInitializer, options: SqliteWasmDriverOptions): SqliteDriver;
+declare function openSqliteWasmDatabase(initializer: SqlJsInitializer, name: string, options: SqliteWasmDriverOptions): Promise<SqliteDatabase>;
+//#endregion
+export { type SqlJsDatabase, type SqlJsInitializer, type SqlJsModule, type SqlJsParameters, type SqlJsResult, type SqlJsScalar, type SqliteWasmDriverOptions, type SqliteWasmParameters, type SqliteWasmStorage, createSqliteWasmDriver, openSqliteWasmDatabase };

package/dist/index.d.mts

@@ -0,0 +1,35 @@
+import { SqliteDatabase, SqliteDriver, SqliteParameters, SqliteScalar } from "@weapp-sqlite/core";
+//#region src/types.d.ts
+type SqlJsScalar = Exclude<SqliteScalar, bigint | boolean | ArrayBuffer>;
+type SqlJsParameters = SqlJsScalar[] | Record<string, SqlJsScalar> | null;
+interface SqlJsResult {
+  readonly columns: readonly string[];
+  readonly values: readonly (readonly unknown[])[];
+}
+interface SqlJsDatabase {
+  run: (sql: string, parameters?: SqlJsParameters) => SqlJsDatabase;
+  exec: (sql: string, parameters?: SqlJsParameters) => readonly SqlJsResult[];
+  export: () => Uint8Array;
+  close: () => void;
+}
+interface SqlJsModule {
+  readonly Database: new (data?: ArrayLike<number> | null) => SqlJsDatabase;
+}
+type SqlJsInitializer = (options?: {
+  locateFile?: (file: string) => string;
+}) => Promise<SqlJsModule>;
+interface SqliteWasmStorage {
+  load: (name: string) => Promise<Uint8Array | undefined>;
+  save: (name: string, data: Uint8Array) => Promise<void>;
+}
+interface SqliteWasmDriverOptions {
+  readonly storage: SqliteWasmStorage;
+  readonly locateFile?: (file: string) => string;
+}
+type SqliteWasmParameters = SqliteParameters;
+//#endregion
+//#region src/driver.d.ts
+declare function createSqliteWasmDriver(initializer: SqlJsInitializer, options: SqliteWasmDriverOptions): SqliteDriver;
+declare function openSqliteWasmDatabase(initializer: SqlJsInitializer, name: string, options: SqliteWasmDriverOptions): Promise<SqliteDatabase>;
+//#endregion
+export { type SqlJsDatabase, type SqlJsInitializer, type SqlJsModule, type SqlJsParameters, type SqlJsResult, type SqlJsScalar, type SqliteWasmDriverOptions, type SqliteWasmParameters, type SqliteWasmStorage, createSqliteWasmDriver, openSqliteWasmDatabase };

package/dist/index.mjs

@@ -0,0 +1,72 @@
+import { createSqliteDatabase } from "@weapp-sqlite/core";
+//#region src/driver.ts
+function normalizeScalar(value) {
+	if (typeof value === "bigint") return Number(value);
+	if (typeof value === "boolean") return value ? 1 : 0;
+	if (value instanceof ArrayBuffer) return new Uint8Array(value);
+	return value;
+}
+function normalizeParameters(parameters) {
+	if (parameters === void 0) return;
+	if (Array.isArray(parameters)) return parameters.map(normalizeScalar);
+	return Object.fromEntries(Object.entries(parameters).map(([key, value]) => [key, normalizeScalar(value)]));
+}
+function rowsFromResult(result) {
+	return {
+		columns: result.columns,
+		rows: result.values.map((values) => {
+			const row = {};
+			result.columns.forEach((column, index) => {
+				row[column] = values[index];
+			});
+			return row;
+		})
+	};
+}
+function createConnection(database, name, storage) {
+	let dirty = false;
+	return {
+		async exec(sql, parameters) {
+			database.run(sql, normalizeParameters(parameters));
+			dirty = true;
+			const row = database.exec("SELECT changes() AS changes, last_insert_rowid() AS lastInsertRowid")[0]?.values[0];
+			return {
+				changes: Number(row?.[0] ?? 0),
+				lastInsertRowid: Number(row?.[1] ?? 0)
+			};
+		},
+		async query(sql, parameters) {
+			const result = database.exec(sql, normalizeParameters(parameters))[0];
+			return result ? rowsFromResult(result) : {
+				columns: [],
+				rows: []
+			};
+		},
+		async flush() {
+			if (!dirty) return;
+			await storage.save(name, database.export());
+			dirty = false;
+		},
+		async close() {
+			database.close();
+		}
+	};
+}
+function createSqliteWasmDriver(initializer, options) {
+	let modulePromise;
+	return {
+		kind: "wasm",
+		async open(name) {
+			modulePromise ??= initializer(options.locateFile ? { locateFile: options.locateFile } : void 0);
+			const module = await modulePromise;
+			const data = await options.storage.load(name);
+			return createConnection(new module.Database(data), name, options.storage);
+		}
+	};
+}
+async function openSqliteWasmDatabase(initializer, name, options) {
+	const connection = await createSqliteWasmDriver(initializer, options).open(name);
+	return createSqliteDatabase(name, connection);
+}
+//#endregion
+export { createSqliteWasmDriver, openSqliteWasmDatabase };

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@weapp-sqlite/wasm",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "基于可注入 WASM SQLite 引擎的跨宿主 adapter",
+  "author": "weapp-sqlite contributors",
+  "license": "MIT",
+  "homepage": "https://github.com/weapp-sqlite/weapp-sqlite#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weapp-sqlite/weapp-sqlite.git",
+    "directory": "packages/wasm"
+  },
+  "bugs": {
+    "url": "https://github.com/weapp-sqlite/weapp-sqlite/issues"
+  },
+  "keywords": [
+    "sqlite",
+    "wasm",
+    "weapp",
+    "weapp-sqlite",
+    "miniprogram"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "dev": "tsdown -w",
+    "build": "tsdown",
+    "test": "vitest run",
+    "test:dev": "vitest",
+    "release": "pnpm publish",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "typecheck": "tsc -p tsconfig.json",
+    "tsd": "pnpm build && tsd --files test-d/**/*.test-d.ts"
+  },
+  "dependencies": {
+    "@weapp-sqlite/core": "workspace:*"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/sql.js": "^1.4.11",
+    "sql.js": "^1.14.2"
+  }
+}