@nymphjs/driver-sqlite3 1.0.0-beta.11 → 1.0.0-beta.110

package/src/conf/d.ts

@@ -23,9 +23,19 @@ export interface SQLite3DriverConfig {
    */
   timeout: number;
   /**
-   * Open for readonly, which is needed for PubSub.
+   * 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.
    */
-  readonly: boolean;
+  explicitWrite: boolean;
   /**
    * Turn on WAL mode.
    *
@@ -35,6 +45,20 @@ export interface SQLite3DriverConfig {
    * 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[];
   /**
    * Function that gets called with every SQL string executed.
    */

package/src/conf/defaults.ts

@@ -1,11 +1,12 @@
-import { SQLite3DriverConfig } from './d';
+import { SQLite3DriverConfig } from './d.js';
 
 export default {
   filename: ':memory:',
   fileMustExist: false,
   prefix: 'nymph_',
   timeout: 10000,
-  readonly: false,
+  explicitWrite: false,
   wal: false,
+  pragmas: [],
   verbose: undefined,
 } as SQLite3DriverConfig;

package/src/conf/index.ts

@@ -1,4 +1,4 @@
-export { SQLite3DriverConfig } from './d';
+export { SQLite3DriverConfig } from './d.js';
 
-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,12 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["ES2021"],
-    "target": "ES2021",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "lib": ["ES2022"],
+    "target": "ES2022",
     "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"]
+}