@nymphjs/driver-sqlite3 1.0.0-beta.13 → 1.0.0-beta.131

package/src/conf/defaults.ts

@@ -1,4 +1,4 @@
-import { SQLite3DriverConfig } from './d';
+import type { SQLite3DriverConfig } from './index.js';
 
 export default {
   filename: ':memory:',
@@ -7,5 +7,5 @@ export default {
   timeout: 10000,
   explicitWrite: false,
   wal: false,
-  verbose: undefined,
+  pragmas: [],
 } as SQLite3DriverConfig;

package/src/conf/index.ts

@@ -1,4 +1,65 @@
-export { SQLite3DriverConfig } from './d';
+/**
+ * SQLite3 Driver Config
+ */
+export interface SQLite3DriverConfig {
+  /**
+   * The filename of the SQLite3 DB. Use ':memory:' for an in-memory DB.
+   */
+  filename: string;
+  /**
+   * If the file does not exist, an Error will be thrown instead of creating a
+   * new file.
+   *
+   * This option is ignored for in-memory, temporary, or readonly database
+   * connections.
+   */
+  fileMustExist: boolean;
+  /**
+   * The SQLite3 table name prefix.
+   */
+  prefix: string;
+  /**
+   * The timeout to use for waiting for the DB to become available.
+   */
+  timeout: number;
+  /**
+   * Open explicitly for writing.
+   *
+   * By default, the driver will always open the DB as readonly, and attempt to
+   * open another link to perform write operations. If you know that only one
+   * instance will be writing, you can force the driver to open for writing by
+   * default, which will block any other instance from opening it for writing.
+   *
+   * One thing to note is that starting a transaction is a write operation, so
+   * as long as an instance is in a transaction, no other instances can write.
+   *
+   * PubSub also needs to open the DB, and it only needs read access.
+   */
+  explicitWrite: boolean;
+  /**
+   * Turn on WAL mode.
+   *
+   * This will generally increase performance, but does mean that the DB must be
+   * on a local disk.
+   *
+   * See: https://www.sqlite.org/wal.html
+   */
+  wal: boolean;
+  /**
+   * Additional pragma statements to run upon connection.
+   *
+   * The default pragmas:
+   *
+   * - journal_mode = WAL;
+   *   (if wal is set to true)
+   * - encoding = "UTF-8";
+   * - foreign_keys = 1;
+   * - case_sensitive_like = 1;
+   *
+   * (Don't include the PRAGMA keyword, but do include the semicolon.)
+   */
+  pragmas: string[];
+}
 
-import defaults from './defaults';
+import defaults from './defaults.js';
 export { defaults as SQLite3DriverConfigDefaults };

package/src/index.ts

@@ -1,5 +1,5 @@
-export * from './conf';
+export * from './conf/index.js';
 
-import SQLite3Driver from './SQLite3Driver';
+import SQLite3Driver from './SQLite3Driver.js';
 export { SQLite3Driver };
 export default SQLite3Driver;

package/tsconfig.json

@@ -2,10 +2,13 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["ES2021"],
-    "target": "ES2021",
+    "types": ["node", "jest"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "lib": ["es2024"],
+    "target": "es2024",
     "noImplicitAny": true,
-    "removeComments": true,
+    "removeComments": false,
     "sourceMap": true,
     "outDir": "dist",
     "resolveJsonModule": true,

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}

package/dist/conf/d.d.ts

@@ -1,9 +0,0 @@
-export interface SQLite3DriverConfig {
-    filename: string;
-    fileMustExist: boolean;
-    prefix: string;
-    timeout: number;
-    explicitWrite: boolean;
-    wal: boolean;
-    verbose: ((message?: any, ...additionalArgs: any[]) => void) | undefined;
-}

package/dist/conf/d.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=d.js.map

package/dist/conf/d.js.map

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

package/src/conf/d.ts

@@ -1,52 +0,0 @@
-/**
- * SQLite3 Driver Config
- */
-export interface SQLite3DriverConfig {
-  /**
-   * The filename of the SQLite3 DB. Use ':memory:' for an in-memory DB.
-   */
-  filename: string;
-  /**
-   * If the file does not exist, an Error will be thrown instead of creating a
-   * new file.
-   *
-   * This option is ignored for in-memory, temporary, or readonly database
-   * connections.
-   */
-  fileMustExist: boolean;
-  /**
-   * The SQLite3 table name prefix.
-   */
-  prefix: string;
-  /**
-   * The timeout to use for waiting for the DB to become available.
-   */
-  timeout: number;
-  /**
-   * Open explicitly for writing.
-   *
-   * By default, the driver will always open the DB as readonly, and attempt to
-   * open another link to perform write operations. If you know that only one
-   * instance will be writing, you can force the driver to open for writing by
-   * default, which will block any other instance from opening it for writing.
-   *
-   * One thing to note is that starting a transaction is a write operation, so
-   * as long as an instance is in a transaction, no other instances can write.
-   *
-   * PubSub also needs to open the DB, and it only needs read access.
-   */
-  explicitWrite: boolean;
-  /**
-   * Turn on WAL mode.
-   *
-   * This will generally increase performance, but does mean that the DB must be
-   * on a local disk.
-   *
-   * See: https://www.sqlite.org/wal.html
-   */
-  wal: boolean;
-  /**
-   * Function that gets called with every SQL string executed.
-   */
-  verbose: ((message?: any, ...additionalArgs: any[]) => void) | undefined;
-}