@op-engineering/op-sqlite 15.1.17 → 15.2.0-beta.0

package/node/dist/types.d.ts

@@ -0,0 +1,102 @@
+export type Scalar = string | number | boolean | null | ArrayBuffer | ArrayBufferView;
+export type QueryResult = {
+    insertId?: number;
+    rowsAffected: number;
+    res?: any[];
+    rows: Array<Record<string, Scalar>>;
+    rawRows?: Scalar[][];
+    columnNames?: string[];
+    metadata?: ColumnMetadata[];
+};
+export type ColumnMetadata = {
+    name: string;
+    type: string;
+    index: number;
+};
+export type SQLBatchTuple = [string] | [string, Scalar[]] | [string, Scalar[][]];
+export type UpdateHookOperation = 'INSERT' | 'DELETE' | 'UPDATE';
+export type BatchQueryResult = {
+    rowsAffected?: number;
+};
+export type FileLoadResult = BatchQueryResult & {
+    commands?: number;
+};
+export type Transaction = {
+    commit: () => Promise<QueryResult>;
+    execute: (query: string, params?: Scalar[]) => Promise<QueryResult>;
+    rollback: () => QueryResult;
+};
+export type PreparedStatement = {
+    bind: (params: any[]) => Promise<void>;
+    bindSync: (params: any[]) => void;
+    execute: () => Promise<QueryResult>;
+};
+export type DB = {
+    close: () => void;
+    delete: (location?: string) => void;
+    attach: (params: {
+        secondaryDbFileName: string;
+        alias: string;
+        location?: string;
+    }) => void;
+    detach: (alias: string) => void;
+    transaction: (fn: (tx: Transaction) => Promise<void>) => Promise<void>;
+    executeSync: (query: string, params?: Scalar[]) => QueryResult;
+    execute: (query: string, params?: Scalar[]) => Promise<QueryResult>;
+    executeWithHostObjects: (query: string, params?: Scalar[]) => Promise<QueryResult>;
+    executeBatch: (commands: SQLBatchTuple[]) => Promise<BatchQueryResult>;
+    loadFile: (location: string) => Promise<FileLoadResult>;
+    updateHook: (callback?: ((params: {
+        table: string;
+        operation: UpdateHookOperation;
+        row?: any;
+        rowId: number;
+    }) => void) | null) => void;
+    commitHook: (callback?: (() => void) | null) => void;
+    rollbackHook: (callback?: (() => void) | null) => void;
+    prepareStatement: (query: string) => PreparedStatement;
+    loadExtension: (path: string, entryPoint?: string) => void;
+    executeRaw: (query: string, params?: Scalar[]) => Promise<any[]>;
+    executeRawSync: (query: string, params?: Scalar[]) => any[];
+    getDbPath: (location?: string) => string;
+    reactiveExecute: (params: {
+        query: string;
+        arguments: any[];
+        fireOn: {
+            table: string;
+            ids?: number[];
+        }[];
+        callback: (response: any) => void;
+    }) => () => void;
+    sync: () => void;
+    setReservedBytes: (reservedBytes: number) => void;
+    getReservedBytes: () => number;
+    flushPendingReactiveQueries: () => Promise<void>;
+};
+export type DBParams = {
+    url?: string;
+    authToken?: string;
+    name?: string;
+    location?: string;
+    syncInterval?: number;
+};
+export type OPSQLiteProxy = {
+    open: (options: {
+        name: string;
+        location?: string;
+        encryptionKey?: string;
+    }) => DB;
+    openV2: (options: {
+        path: string;
+        encryptionKey?: string;
+    }) => DB;
+    openRemote: (options: {
+        url: string;
+        authToken: string;
+    }) => DB;
+    openSync: (options: DBParams) => DB;
+    isSQLCipher: () => boolean;
+    isLibsql: () => boolean;
+    isIOSEmbedded: () => boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/node/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,MAAM,GACd,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,WAAW,GACX,eAAe,CAAC;AAEpB,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;IACZ,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,aAAa,GACrB,CAAC,MAAM,CAAC,GACR,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAClB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;AAEzB,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC;IACnC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IACpE,QAAQ,EAAE,MAAM,WAAW,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,EAAE,GAAG;IACf,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,MAAM,EAAE,CAAC,MAAM,EAAE;QACf,mBAAmB,EAAE,MAAM,CAAC;QAC5B,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,KAAK,IAAI,CAAC;IACX,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,WAAW,CAAC;IAC/D,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IACpE,sBAAsB,EAAE,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,EAAE,KACd,OAAO,CAAC,WAAW,CAAC,CAAC;IAC1B,YAAY,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACvE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACxD,UAAU,EAAE,CACV,QAAQ,CAAC,EACL,CAAC,CAAC,MAAM,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,mBAAmB,CAAC;QAC/B,GAAG,CAAC,EAAE,GAAG,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;KACf,KAAK,IAAI,CAAC,GACX,IAAI,KACL,IAAI,CAAC;IACV,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;IACrD,YAAY,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;IACvD,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,iBAAiB,CAAC;IACvD,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3D,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACjE,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,GAAG,EAAE,CAAC;IAC5D,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IACzC,eAAe,EAAE,CAAC,MAAM,EAAE;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,GAAG,EAAE,CAAC;QACjB,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAC;YACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;SAChB,EAAE,CAAC;QACJ,QAAQ,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;KACnC,KAAK,MAAM,IAAI,CAAC;IACjB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,gBAAgB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,gBAAgB,EAAE,MAAM,MAAM,CAAC;IAC/B,2BAA2B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,CAAC,OAAO,EAAE;QACd,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,KAAK,EAAE,CAAC;IACT,MAAM,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,EAAE,CAAC;IAClE,UAAU,EAAE,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,KAAK,EAAE,CAAC;IAChE,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,EAAE,CAAC;IACpC,WAAW,EAAE,MAAM,OAAO,CAAC;IAC3B,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB,aAAa,EAAE,MAAM,OAAO,CAAC;CAC9B,CAAC"}

package/node/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/node/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/node/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "node",
+  "version": "1.0.0",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "build": "tsc",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "example": "tsc && node example.js"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0"
+  }
+}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@op-engineering/op-sqlite",
-  "version": "15.1.17",
-  "description": "Fastest SQLite for React Native",
+  "version": "15.2.0-beta.0",
+  "description": "Fastest SQLite for React Native (with node.js support)",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "react-native": "src/index",
   "exports": {
     ".": {
       "source": "./src/index.ts",
+      "node": "./node/dist/index.js",
       "types": "./lib/typescript/src/index.d.ts",
       "default": "./lib/module/index.js"
     },
@@ -19,6 +20,8 @@
     "android",
     "ios",
     "cpp",
+    "node/dist",
+    "node/package.json",
     "*.podspec",
     "*.rb",
     "react-native.config.js",
@@ -35,9 +38,11 @@
     "!**/.*"
   ],
   "scripts": {
+    "test:node": "yarn workspace node test",
     "example": "yarn workspace op_sqlite_example",
     "typecheck": "tsc",
     "prepare": "bob build",
+    "build:node": "yarn workspace node build",
     "pods": "cd example && yarn pods",
     "clang-format-check": "clang-format -i cpp/*.cpp cpp/*.h"
   },
@@ -45,7 +50,9 @@
     "react-native",
     "ios",
     "android",
-    "sqlite"
+    "node",
+    "sqlite",
+    "database"
   ],
   "repository": "https://github.com/OP-Engineering/op-sqlite",
   "author": "Oscar Franco <ospfranco@gmail.com> (https://github.com/ospfranco)",
@@ -57,8 +64,12 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "dependencies": {
+    "better-sqlite3": "^11.0.0"
+  },
   "devDependencies": {
     "clang-format": "^1.8.0",
+    "jest": "^29.5.0",
     "react": "19.1.1",
     "react-native": "0.82.1",
     "react-native-builder-bob": "^0.40.15",
@@ -69,7 +80,8 @@
     "react-native": "*"
   },
   "workspaces": [
-    "example"
+    "example",
+    "node"
   ],
   "prettier": {
     "quoteProps": "consistent",

package/src/functions.ts

@@ -1,15 +1,15 @@
 import { NativeModules, Platform } from 'react-native';
-import {
-  type _InternalDB,
-  type _PendingTransaction,
-  type BatchQueryResult,
-  type DB,
-  type DBParams,
-  type OPSQLiteProxy,
-  type QueryResult,
-  type Scalar,
-  type SQLBatchTuple,
-  type Transaction,
+import type {
+  _InternalDB,
+  _PendingTransaction,
+  BatchQueryResult,
+  DB,
+  DBParams,
+  OPSQLiteProxy,
+  QueryResult,
+  Scalar,
+  SQLBatchTuple,
+  Transaction,
 } from './types';
 
 declare global {
@@ -419,13 +419,6 @@ export const open = (params: {
   return enhancedDb;
 };
 
-export function openV2(params: { path: string; encryptionKey?: string }) {
-  const db = OPSQLite.openV2(params);
-  const enhancedDb = enhanceDB(db, params as any);
-
-  return enhancedDb;
-}
-
 /**
  * Moves the database from the assets folder to the default path (check the docs) or to a custom path
  * It DOES NOT OVERWRITE the database if it already exists in the destination path

package/src/types.ts

@@ -317,7 +317,6 @@ export type OPSQLiteProxy = {
     location?: string;
     encryptionKey?: string;
   }) => _InternalDB;
-  openV2: (options: { path: string; encryptionKey?: string }) => _InternalDB;
   openRemote: (options: { url: string; authToken: string }) => _InternalDB;
   openSync: (options: DBParams) => _InternalDB;
   isSQLCipher: () => boolean;