@aiao/rxdb-adapter-sqlite 0.0.1

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@aiao/rxdb-adapter-sqlite",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "./index.js",
+  "dependencies": {
+    "@aiao/rxdb": "*",
+    "@aiao/utils": "0.0.1",
+    "rxjs": "~7.8.0",
+    "@journeyapps/wa-sqlite": "^1.2.4",
+    "comlink": "^4.4.2"
+  },
+  ".": {
+    "import": "./index.js",
+    "types": "./index.d.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/sqlite-load.utils.d.ts

@@ -0,0 +1,39 @@
+import { LoadModuleOptions } from './sqlite.interface';
+import { SQLiteAPI } from './wa-sqlite';
+interface VFSConfig {
+    /**
+     * vfs 的名称
+     */
+    name: string;
+    vfsModule: () => Promise<any>;
+    vfsOptions?: any;
+    /**
+     * 是否支持同步
+     */
+    sync: boolean;
+    /**
+     * 支持异步
+     */
+    async: boolean;
+    /**
+     * 支持在 js 环境下运行
+     */
+    jsContext: boolean;
+    /**
+     * 支持使用 web worker
+     */
+    worker: boolean;
+    /**
+     * 支持使用 shared worker
+     */
+    sharedWorker: boolean;
+    /**
+     * 支持多个连接
+     */
+    multipleConnections?: boolean;
+}
+export declare const WA_SQLITE_VFS_LIST: VFSConfig[];
+export declare const checkVFSConfig: (options: LoadModuleOptions) => VFSConfig;
+export declare const sqliteLoad: (options: LoadModuleOptions) => Promise<SQLiteAPI>;
+export declare const getSqliteEventName: (dbName: string, eventName: string) => string;
+export {};

package/sqlite.interface.d.ts

@@ -0,0 +1,57 @@
+import { IRxDBAdapterOptions, UnixMilliseconds } from '@aiao/rxdb';
+import { SQLiteCompatibleType } from './wa-sqlite';
+export type SupportVFS = 'MemoryVFS' | 'MemoryAsyncVFS' | 'IDBBatchAtomicVFS' | 'OPFSAdaptiveVFS' | 'AccessHandlePoolVFS' | 'OPFSAnyContextVFS' | 'OPFSCoopSyncVFS' | 'OPFSPermutedVFS';
+export interface SqliteData {
+    columns: string[];
+    rows: SQLiteCompatibleType[][];
+}
+export interface SqliteSuccessResult {
+    sql: string;
+    rowsAffected: number;
+    runStart: number;
+    runEnd: number;
+    results: SqliteData[];
+}
+export type SqliteResult = SqliteSuccessResult;
+export interface SqliteOptions extends IRxDBAdapterOptions {
+    /**
+     * vfs
+     */
+    vfs: SupportVFS;
+    /**
+     * 异步方式
+     */
+    async: boolean;
+    /**
+     * 是否启用 worker
+     */
+    worker: boolean;
+    /**
+     * worker
+     */
+    workerInstance?: Worker;
+    /**
+     * wasm 路径
+     */
+    wasmPath?: string;
+    /**
+     * @see https://www.sqlite.org/pragma.html#pragma_cache_size
+     * @default 51200
+     */
+    cacheSizeKb?: number;
+}
+export type LoadModuleOptions = Pick<SqliteOptions, 'vfs' | 'async' | 'wasmPath' | 'worker' | 'cacheSizeKb'>;
+export declare enum SQliteChangeType {
+    SQLITE_DELETE = 9,
+    SQLITE_INSERT = 18,
+    SQLITE_UPDATE = 23
+}
+export interface SqliteChangeEvent {
+    type: SQliteChangeType;
+    dbName: string | null;
+    tableName: string | null;
+    rowid: bigint;
+    recordAt: UnixMilliseconds;
+    timeStamp: DOMHighResTimeStamp;
+}
+export declare const ADAPTER_NAME: "sqlite";

package/sqlite.utils.d.ts

@@ -0,0 +1,107 @@
+import { EntityMetadata, EntityPropertyMetadata, EntityRelationMetadata, RuleGroup, RxDBError, RxDBScalar } from '@aiao/rxdb';
+import { SqliteResult } from './sqlite.interface';
+import { SQLiteCompatibleType } from './wa-sqlite';
+/**
+ * 检查 sqlite 表是否存在
+ * @param tableName
+ * @returns
+ */
+export declare const isTableExistedSql: (tableName: string) => string;
+/**
+ * 检查 sqlite 结果是否为空
+ * @param result
+ * @returns
+ */
+export declare const isSqlResultEmpty: (result: SqliteResult) => boolean;
+/**
+ * sqlite 行 id 列名
+ */
+export declare const ROWID: "_rowid";
+/**
+ * 类型
+ * https://www.sqlite.org/datatype3.html
+ */
+type SqliteDataType = 'NULL' | 'INTEGER' | 'REAL' | 'TEXT' | 'BLOB';
+/**
+ * rxdb 的类型 转 sqlite 类型
+ */
+export declare const rxDBColumnTypeToSqliteType: (property: EntityPropertyMetadata) => SqliteDataType;
+/**
+ * 转换 js 类型为 sqlite 类型
+ * @param value
+ * @param property
+ * @returns
+ */
+export declare const transformValueJsToSqlite: (value: RxDBScalar, property: EntityPropertyMetadata) => RxDBScalar | null | undefined;
+/**
+ * 转换 sqlite 类型为 js 类型
+ * @param value sqlite 类型的值
+ * @param property 实体属性
+ * @returns js 类型的值
+ */
+export declare const transformValueSqliteToJs: (value: RxDBScalar | any, property: EntityPropertyMetadata) => any;
+/**
+ * 获取表名
+ * @param name 表名
+ * @param namespace 命名空间
+ * @returns
+ */
+export declare const getTableName: (name: string, namespace: string) => string;
+/**
+ * 通过 metadata 获取表名
+ * @param metadata
+ * @returns
+ */
+export declare const getTableNameByMetadata: (metadata: EntityMetadata) => string;
+/**
+ * 获取表列索引名称
+ * @param metadata
+ * @param property
+ * @returns
+ */
+export declare const getTableColumnIndexName: (metadata: EntityMetadata, property: EntityPropertyMetadata | EntityRelationMetadata) => string;
+export declare class RxdbAdapterSqliteError extends RxDBError {
+}
+/**
+ * 格式化实体数据，转换为 sqlite 类型
+ * @param metadata
+ * @param entity
+ * @returns
+ */
+export declare const transformEntityValueToSql: (metadata: EntityMetadata, entity: any) => any;
+/**
+ * 格式化创建时的实体数据
+ * @param metadata
+ * @param entity
+ * @returns
+ */
+export declare const normalizeCreateEntity: (metadata: EntityMetadata, entity: any) => any;
+/**
+ * 格式化实体数据，过滤掉 readonly 字段
+ * @param metadata
+ * @param entity
+ * @returns
+ */
+export declare const normalizeEntity: (metadata: EntityMetadata, entity: any) => any;
+/**
+ * 查询去除软删除数据
+ * @param where
+ * @returns
+ */
+export declare const withoutSoftDelete: <RG extends RuleGroup<any, any, any>>(where: RG) => RG;
+/**
+ * 展示 sql 合并后的结果
+ * @param sql
+ * @param params
+ * @returns
+ */
+export declare const showSQL: (sql: string, params: any[]) => string;
+/**
+ * 获取实体对象数据
+ * @param metadata
+ * @param columns
+ * @param row
+ * @returns
+ */
+export declare const getEntityObjectFromResult: (metadata: EntityMetadata, columns: string[], row: SQLiteCompatibleType[]) => any;
+export {};

package/types.d.ts

@@ -0,0 +1,7 @@
+declare module '@journeyapps/wa-sqlite/src/examples/OPFSCoopSyncVFS.js' { }
+declare module '@journeyapps/wa-sqlite/src/examples/AccessHandlePoolVFS.js' { }
+declare module '@journeyapps/wa-sqlite/src/examples/OPFSAnyContextVFS.js' { }
+declare module '@journeyapps/wa-sqlite/src/examples/IDBBatchAtomicVFS.js' { }
+declare module '@journeyapps/wa-sqlite/src/examples/IDBMirrorVFS.js' { }
+declare module '@journeyapps/wa-sqlite/src/examples/OPFSAdaptiveVFS.js' { }
+declare module '@journeyapps/wa-sqlite/src/examples/OPFSPermutedVFS.js' { }