@kubun/db-expo 0.2.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/README.md

@@ -0,0 +1,11 @@
+# Kubun Expo DB adapter
+
+## Installation
+
+```sh
+npm install @kubun/db-expo
+```
+
+## License
+
+[Prosperity Public License 3.0.0](LICENSE.md)

package/lib/driver.d.ts

@@ -0,0 +1,54 @@
+import * as SQLite from 'expo-sqlite';
+import { type CompiledQuery, type DatabaseConnection, type DatabaseIntrospector, type Dialect, type DialectAdapter, type Driver, type Kysely, type QueryCompiler, type QueryResult } from 'kysely';
+export type ExpoDialectParams = {
+    database: string;
+    disableForeignKeys?: boolean;
+    disableStrictModeCreateTable?: boolean;
+    debug?: boolean;
+    onError?: (message: string, exception: unknown) => void;
+};
+export type ExpoDialectConfig = ExpoDialectParams & {
+    disableForeignKeys?: boolean;
+    disableStrictModeCreateTable?: boolean;
+};
+/**
+ * Expo dialect for Kysely.
+ */
+export declare class ExpoDialect implements Dialect {
+    config: ExpoDialectConfig;
+    constructor(config: ExpoDialectParams);
+    createDriver(): ExpoDriver;
+    createQueryCompiler(): QueryCompiler;
+    createAdapter(): DialectAdapter;
+    createIntrospector(db: Kysely<unknown>): DatabaseIntrospector;
+}
+/**
+ * Expo driver for Kysely.
+ */
+export declare class ExpoDriver implements Driver {
+    #private;
+    constructor(config: ExpoDialectConfig);
+    releaseConnection(): Promise<void>;
+    init(): Promise<void>;
+    acquireConnection(): Promise<ExpoConnection>;
+    beginTransaction(connection: ExpoConnection): Promise<void>;
+    commitTransaction(connection: ExpoConnection): Promise<void>;
+    rollbackTransaction(connection: ExpoConnection): Promise<void>;
+    destroy(): Promise<void>;
+    getDatabaseRuntimeVersion(): Promise<any>;
+}
+/**
+ * Expo connection for Kysely.
+ */
+declare class ExpoConnection implements DatabaseConnection {
+    sqlite: SQLite.SQLiteDatabase;
+    debug: boolean;
+    config: ExpoDialectConfig;
+    constructor(config: ExpoDialectConfig);
+    closeConnection(): Promise<void>;
+    executeQuery<R>(compiledQuery: CompiledQuery): Promise<QueryResult<R>>;
+    directQuery<T>(query: string): Promise<Array<T>>;
+    streamQuery<R>(compiledQuery: CompiledQuery, chunkSize?: number): AsyncIterableIterator<QueryResult<R>>;
+}
+export {};
+//# sourceMappingURL=driver.d.ts.map

package/lib/driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../src/driver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,WAAW,EAIjB,MAAM,QAAQ,CAAA;AAIf,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;CACxD,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,4BAA4B,CAAC,EAAE,OAAO,CAAA;CACvC,CAAA;AAED;;GAEG;AACH,qBAAa,WAAY,YAAW,OAAO;IACzC,MAAM,EAAE,iBAAiB,CAAA;gBAEb,MAAM,EAAE,iBAAiB;IAIrC,YAAY,IAAI,UAAU;IAI1B,mBAAmB,IAAI,aAAa;IAIpC,aAAa,IAAI,cAAc;IAI/B,kBAAkB,CAAC,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,oBAAoB;CAG9D;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;;gBAI3B,MAAM,EAAE,iBAAiB;IAI/B,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAErB,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAK5C,gBAAgB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5D,mBAAmB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,yBAAyB;CAUhC;AAED;;GAEG;AACH,cAAM,cAAe,YAAW,kBAAkB;IAChD,MAAM,EAAE,MAAM,CAAC,cAAc,CAAA;IAC7B,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,iBAAiB,CAAA;gBAEb,MAAM,EAAE,iBAAiB;IAa/B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAIhC,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IA2CtE,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAItD,WAAW,CAAC,CAAC,EACX,aAAa,EAAE,aAAa,EAC5B,SAAS,CAAC,EAAE,MAAM,GACjB,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAGzC"}

package/lib/driver.js

@@ -0,0 +1,139 @@
+import * as SQLite from 'expo-sqlite';
+// Adapted from https://github.com/mphill/kysely-expo/blob/main/src/driver.ts
+import { SqliteAdapter, SqliteIntrospector, SqliteQueryCompiler } from 'kysely';
+import { serialize } from './serialize.js';
+/**
+ * Expo dialect for Kysely.
+ */ export class ExpoDialect {
+    config;
+    constructor(config){
+        this.config = {
+            ...config,
+            disableStrictModeCreateTable: true
+        };
+    }
+    createDriver() {
+        return new ExpoDriver(this.config);
+    }
+    createQueryCompiler() {
+        return new SqliteQueryCompiler();
+    }
+    createAdapter() {
+        return new SqliteAdapter();
+    }
+    createIntrospector(db) {
+        return new SqliteIntrospector(db);
+    }
+}
+/**
+ * Expo driver for Kysely.
+ */ export class ExpoDriver {
+    #connectionMutex = new ConnectionMutex();
+    #connection;
+    constructor(config){
+        this.#connection = new ExpoConnection(config);
+    }
+    async releaseConnection() {
+        this.#connectionMutex.unlock();
+    }
+    async init() {}
+    async acquireConnection() {
+        await this.#connectionMutex.lock();
+        return this.#connection;
+    }
+    async beginTransaction(connection) {
+        await connection.directQuery('begin transaction');
+    }
+    async commitTransaction(connection) {
+        await connection.directQuery('commit');
+    }
+    async rollbackTransaction(connection) {
+        await connection.directQuery('rollback');
+    }
+    async destroy() {
+        this.#connection.closeConnection();
+    }
+    async getDatabaseRuntimeVersion() {
+        try {
+            const res = await this.#connection.directQuery('select sqlite_version() as version;');
+            //@ts-ignore
+            return res[0].version;
+        } catch (e) {
+            console.error(e);
+            return 'unknown';
+        }
+    }
+}
+/**
+ * Expo connection for Kysely.
+ */ class ExpoConnection {
+    sqlite;
+    debug;
+    config;
+    constructor(config){
+        this.sqlite = SQLite.openDatabaseSync(config.database);
+        this.debug = config.debug ?? false;
+        this.config = config;
+        if (this.config.disableForeignKeys) {
+            this.sqlite.execSync('PRAGMA foreign_keys = OFF;');
+        } else {
+            this.sqlite.execSync('PRAGMA foreign_keys = ON;');
+        }
+    }
+    async closeConnection() {
+        return this.sqlite.closeAsync();
+    }
+    async executeQuery(compiledQuery) {
+        let { sql, parameters, query } = compiledQuery;
+        // Kysely uses varchar(255) as the default string type for migrations which is not supported by STRICT mode.
+        if (query.kind === 'CreateTableNode' && !sql.includes('kysely_migration') && !sql.includes('kysely_migration_lock') && !sql.includes('STRICT') && !this.config.disableStrictModeCreateTable) {
+            sql += ' STRICT';
+        }
+        const readonly = query.kind === 'SelectQueryNode' || query.kind === 'RawNode';
+        const transformedParameters = serialize([
+            ...parameters
+        ]);
+        if (this.debug) {
+            console.debug(`${query.kind}${readonly ? ' (readonly)' : ''}: ${sql}`);
+        }
+        if (readonly) {
+            const res = await this.sqlite.getAllAsync(sql, transformedParameters);
+            return {
+                rows: res
+            };
+        }
+        const res = await this.sqlite.runAsync(sql, transformedParameters);
+        const queryResult = {
+            numUpdatedOrDeletedRows: BigInt(res.changes),
+            numAffectedRows: BigInt(res.changes),
+            insertId: BigInt(res.lastInsertRowId),
+            rows: []
+        };
+        if (this.debug) console.log('queryResult', queryResult);
+        return queryResult;
+    }
+    async directQuery(query) {
+        return await this.sqlite.getAllAsync(query, []);
+    }
+    streamQuery(compiledQuery, chunkSize) {
+        throw new Error('Expo SQLite driver does not support iterate on prepared statements');
+    }
+}
+class ConnectionMutex {
+    #promise;
+    #resolve;
+    async lock() {
+        while(this.#promise){
+            await this.#promise;
+        }
+        this.#promise = new Promise((resolve)=>{
+            this.#resolve = resolve;
+        });
+    }
+    unlock() {
+        const resolve = this.#resolve;
+        this.#promise = undefined;
+        this.#resolve = undefined;
+        resolve?.();
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,10 @@
+import { AbstractSQLiteAdapter, type Adapter } from '@kubun/db-adapter';
+import type { Dialect } from 'kysely';
+import { type ExpoDialectParams } from './driver.js';
+export type AdapterParams = ExpoDialectParams;
+export declare class ExpoAdapter extends AbstractSQLiteAdapter implements Adapter {
+    #private;
+    constructor(params: AdapterParams);
+    get dialect(): Dialect;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAA;AACvE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAErC,OAAO,EAAe,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAEjE,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAA;AAE7C,qBAAa,WAAY,SAAQ,qBAAsB,YAAW,OAAO;;gBAG3D,MAAM,EAAE,aAAa;IAKjC,IAAI,OAAO,IAAI,OAAO,CAErB;CACF"}

package/lib/index.js

@@ -0,0 +1,12 @@
+import { AbstractSQLiteAdapter } from '@kubun/db-adapter';
+import { ExpoDialect } from './driver.js';
+export class ExpoAdapter extends AbstractSQLiteAdapter {
+    #dialect;
+    constructor(params){
+        super();
+        this.#dialect = new ExpoDialect(params);
+    }
+    get dialect() {
+        return this.#dialect;
+    }
+}

package/lib/serialize.d.ts

@@ -0,0 +1,3 @@
+import type { SQLiteBindValue } from 'expo-sqlite';
+export declare function serialize(parameters: Array<unknown>): Array<SQLiteBindValue>;
+//# sourceMappingURL=serialize.d.ts.map

package/lib/serialize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize.d.ts","sourceRoot":"","sources":["../src/serialize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,wBAAgB,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,eAAe,CAAC,CAyB5E"}

package/lib/serialize.js

@@ -0,0 +1,27 @@
+export function serialize(parameters) {
+    return parameters.map((parameter)=>{
+        if (typeof parameter === 'string') {
+            return parameter.toString();
+        }
+        if (parameter instanceof Date) {
+            return parameter.toISOString();
+        }
+        if (typeof parameter === 'number') {
+            return parameter;
+        }
+        if (parameter instanceof Uint8Array) {
+            return parameter;
+        }
+        if (parameter === null || parameter === undefined) {
+            return null;
+        }
+        if (typeof parameter === 'object') {
+            return JSON.stringify(parameter);
+        }
+        if (typeof parameter === 'boolean') {
+            return parameter ? 'true' : 'false' // SQLite booleans must be stored a strings.
+            ;
+        }
+        throw new Error(`Unknown type: ${typeof parameter}`);
+    });
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@kubun/db-expo",
+  "version": "0.2.0",
+  "license": "see LICENSE.md",
+  "keywords": [],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "expo-sqlite": "~15.1.2",
+    "kysely": "^0.27.6",
+    "@kubun/db-adapter": "^0.2.0"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "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",
+    "test:unit": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}