@travetto/model-sqlite 8.0.0-alpha.24 → 8.0.0-alpha.25

package/README.md

@@ -13,18 +13,18 @@ npm install @travetto/model-sqlite
 yarn add @travetto/model-sqlite
 ```
 
-This module provides a [SQLite](https://www.sqlite.org/)-based implementation for the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module.  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [SQL](https://en.wikipedia.org/wiki/SQL) databases. In development mode, the [SQLModelService](https://github.com/travetto/travetto/tree/main/module/model-sql/src/service.ts#L36) will also modify the database schema in real time to minimize impact to development. 
+This module provides a [SQLite](https://www.sqlite.org/)-based implementation for the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module. This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [SQL](https://en.wikipedia.org/wiki/SQL) databases. In development mode, the [SQLModelService](https://github.com/travetto/travetto/tree/main/module/model-sql/src/service.ts#L69) will also modify the database schema in real time to minimize impact to development. 
 
-The schema generated will not generally map to existing tables as it is attempting to produce a document store like experience on top of a [SQL](https://en.wikipedia.org/wiki/SQL) database.  Every table generated will have a `path_id` which determines it's location in the document hierarchy as well as sub tables will have a `parent_path_id` to associate records with the parent values. 
+The schema generated will not generally map to existing tables as it is attempting to produce a document store like experience on top of a [SQL](https://en.wikipedia.org/wiki/SQL) database. Every table generated will have a `path_id` which determines it's location in the document hierarchy as well as sub tables will have a `parent_path_id` to associate records with the parent values. 
 
 Supported features:
-   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11)
-   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/types/bulk.ts#L64)
-   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L16)
+   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/types/bulk.ts#L60)
+   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L10)
+   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model-indexed/src/types/service.ts#L21)
    *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/crud.ts#L11)
    *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/facet.ts#L14)
-   *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/query.ts#L10)
    *  [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/suggest.ts#L12)
+   *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/query.ts#L10)
 
 Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
 
@@ -32,8 +32,7 @@ Out of the box, by installing the module, everything should be wired up by defau
 ```typescript
 import type { AsyncContext } from '@travetto/context';
 import { InjectableFactory } from '@travetto/di';
-
-import { SQLModelService, type SQLModelConfig } from '@travetto/model-sql';
+import { type SQLModelConfig, SQLModelService } from '@travetto/model-sql';
 import { SqliteDialect } from '@travetto/model-sqlite';
 
 export class Init {

package/__index__.ts

@@ -1,2 +1,2 @@
+export * from './src/connection.ts';
 export * from './src/dialect.ts';
-export * from './src/connection.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-sqlite",
-  "version": "8.0.0-alpha.24",
+  "version": "8.0.0-alpha.25",
   "type": "module",
   "description": "SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
@@ -27,11 +27,11 @@
     "directory": "module/model-sqlite"
   },
   "dependencies": {
-    "@travetto/config": "^8.0.0-alpha.21",
-    "@travetto/context": "^8.0.0-alpha.19",
-    "@travetto/model": "^8.0.0-alpha.22",
-    "@travetto/model-query": "^8.0.0-alpha.23",
-    "@travetto/model-sql": "^8.0.0-alpha.24"
+    "@travetto/config": "^8.0.0-alpha.22",
+    "@travetto/context": "^8.0.0-alpha.20",
+    "@travetto/model": "^8.0.0-alpha.23",
+    "@travetto/model-query": "^8.0.0-alpha.24",
+    "@travetto/model-sql": "^8.0.0-alpha.25"
   },
   "travetto": {
     "displayName": "SQLite Model Service"

package/src/connection.ts

@@ -1,33 +1,28 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import { DatabaseSync, type DatabaseSyncOptions, type SQLInputValue, } from 'node:sqlite';
+import { DatabaseSync, type DatabaseSyncOptions, type SQLInputValue } from 'node:sqlite';
 
-import { type Pool, createPool } from 'generic-pool';
+import { createPool, type Pool } from 'generic-pool';
 
-import { ShutdownManager, Util, Runtime, RuntimeError, castTo } from '@travetto/runtime';
 import { type AsyncContext, WithAsyncContext } from '@travetto/context';
 import { ExistsError } from '@travetto/model';
-import { type SQLModelConfig, Connection } from '@travetto/model-sql';
+import { Connection, type SQLModelConfig } from '@travetto/model-sql';
+import { castTo, Runtime, RuntimeError, ShutdownManager, Util } from '@travetto/runtime';
 
 const RECOVERABLE_MESSAGE = /database( table| schema)? is (locked|busy)/;
 
-const isRecoverableError = (error: unknown): error is Error =>
-  error instanceof Error && RECOVERABLE_MESSAGE.test(error.message);
+const isRecoverableError = (error: unknown): error is Error => error instanceof Error && RECOVERABLE_MESSAGE.test(error.message);
 
 /**
  * Connection support for Sqlite
  */
 export class SqliteConnection extends Connection<DatabaseSync> {
-
   isolatedTransactions = false;
 
   #config: SQLModelConfig<DatabaseSyncOptions & { file?: string }>;
   #pool: Pool<DatabaseSync>;
 
-  constructor(
-    context: AsyncContext,
-    config: SQLModelConfig<DatabaseSyncOptions & { file?: string }>
-  ) {
+  constructor(context: AsyncContext, config: SQLModelConfig<DatabaseSyncOptions & { file?: string }>) {
     super(context);
     this.#config = config;
   }
@@ -51,14 +46,10 @@ export class SqliteConnection extends Connection<DatabaseSync> {
     const file = path.resolve(this.#config.options.file ?? Runtime.toolPath('@', 'sqlite_db'));
     await fs.mkdir(path.dirname(file), { recursive: true });
     const db = new DatabaseSync(file, this.#config.options);
-    for (const q of [
-      'PRAGMA foreign_keys = ON',
-      'PRAGMA journal_mode = WAL',
-      'PRAGMA synchronous = NORMAL',
-    ]) {
+    for (const q of ['PRAGMA foreign_keys = ON', 'PRAGMA journal_mode = WAL', 'PRAGMA synchronous = NORMAL']) {
       await this.#withRetries(async () => db.exec(q));
     }
-    db.function('regexp', (a, b) => new RegExp(`${a}`).test(`${b}`) ? 1 : 0);
+    db.function('regexp', (a, b) => (new RegExp(`${a}`).test(`${b}`) ? 1 : 0));
     return db;
   }
 
@@ -71,16 +62,21 @@ export class SqliteConnection extends Connection<DatabaseSync> {
 
     await this.#create();
 
-    this.#pool = createPool<DatabaseSync>({
-      create: () => this.#withRetries(() => this.#create()),
-      destroy: async db => { db.close(); }
-    }, { max: 1 });
+    this.#pool = createPool<DatabaseSync>(
+      {
+        create: () => this.#withRetries(() => this.#create()),
+        destroy: async db => {
+          db.close();
+        }
+      },
+      { max: 1 }
+    );
 
     // Close postgres
     ShutdownManager.signal.addEventListener('abort', () => this.#pool.clear());
   }
 
-  async execute<T = unknown>(connection: DatabaseSync, query: string, values?: unknown[]): Promise<{ count: number, records: T[] }> {
+  async execute<T = unknown>(connection: DatabaseSync, query: string, values?: unknown[]): Promise<{ count: number; records: T[] }> {
     const isSelect = query.trim().startsWith('SELECT');
     return this.#withRetries(async () => {
       console.debug('Executing query', { query });
@@ -98,7 +94,7 @@ export class SqliteConnection extends Connection<DatabaseSync> {
         }
       } catch (error) {
         const code = error && typeof error === 'object' && 'code' in error ? error.code : undefined;
-        const message = (Error.isError(error) || error instanceof Error) ? error.message : undefined;
+        const message = Error.isError(error) || error instanceof Error ? error.message : undefined;
         switch (code) {
           case 'ERR_SQLITE_ERROR': {
             if (message?.startsWith('UNIQUE')) {
@@ -108,8 +104,9 @@ export class SqliteConnection extends Connection<DatabaseSync> {
           }
           case 'SQLITE_CONSTRAINT_PRIMARYKEY':
           case 'SQLITE_CONSTRAINT_UNIQUE':
-          case 'SQLITE_CONSTRAINT_INDEX': throw new ExistsError('query', query);
-        };
+          case 'SQLITE_CONSTRAINT_INDEX':
+            throw new ExistsError('query', query);
+        }
         if (/index.*?already exists/.test(message ?? '')) {
           throw new ExistsError('index', query);
         }
@@ -135,4 +132,4 @@ export class SqliteConnection extends Connection<DatabaseSync> {
       await this.release(db);
     }
   }
-}
+}

package/src/dialect.ts

@@ -1,10 +1,9 @@
-import type { SchemaFieldConfig } from '@travetto/schema';
-import { Injectable } from '@travetto/di';
 import type { AsyncContext } from '@travetto/context';
+import { Injectable } from '@travetto/di';
 import type { WhereClause } from '@travetto/model-query';
+import { SQLDialect, type SQLModelConfig, type SQLTableDescription, type VisitStack } from '@travetto/model-sql';
 import { castTo } from '@travetto/runtime';
-
-import { type SQLModelConfig, SQLDialect, type VisitStack, type SQLTableDescription } from '@travetto/model-sql';
+import type { SchemaFieldConfig } from '@travetto/schema';
 
 import { SqliteConnection } from './connection.ts';
 
@@ -13,7 +12,6 @@ import { SqliteConnection } from './connection.ts';
  */
 @Injectable()
 export class SqliteDialect extends SQLDialect {
-
   connection: SqliteConnection;
   config: SQLModelConfig;
 
@@ -50,7 +48,7 @@ export class SqliteDialect extends SQLDialect {
     const IGNORE_FIELDS = [this.pathField.name, this.parentPathField.name, this.idxField.name].map(field => `'${field}'`);
 
     const [columns, foreignKeys, indices] = await Promise.all([
-      this.executeSQL<{ name: string, type: string, is_not_null: 1 | 0 }>(`
+      this.executeSQL<{ name: string; type: string; is_not_null: 1 | 0 }>(`
       SELECT 
         name, 
         type, 
@@ -58,7 +56,7 @@ export class SqliteDialect extends SQLDialect {
       FROM PRAGMA_TABLE_INFO('${table}')
       WHERE name NOT IN (${IGNORE_FIELDS.join(',')})
     `),
-      this.executeSQL<{ name: string, to_table: string, from_column: string, to_column: string }>(`
+      this.executeSQL<{ name: string; to_table: string; from_column: string; to_column: string }>(`
       SELECT 
         'fk_' || '${table}' || '_' || ${this.identifier('from')} AS name, 
         ${this.identifier('from')} as from_column, 
@@ -66,7 +64,7 @@ export class SqliteDialect extends SQLDialect {
         ${this.identifier('table')} as to_table
       FROM PRAGMA_FOREIGN_KEY_LIST('${table}')
     `),
-      this.executeSQL<{ name: string, is_unique: boolean, columns: string }>(`
+      this.executeSQL<{ name: string; is_unique: boolean; columns: string }>(`
       SELECT 
         il.name as name, 
         il.${this.identifier('unique')} = 1 as is_unique, 
@@ -87,7 +85,8 @@ export class SqliteDialect extends SQLDialect {
       indices: indices.records.map(idx => ({
         name: idx.name,
         is_unique: idx.is_unique,
-        columns: idx.columns.split(',')
+        columns: idx.columns
+          .split(',')
           .map(col => col.split(' '))
           .map(([order, name, desc]) => [+order, { name, desc: desc === '1' }] as const)
           .sort((a, b) => a[0] - b[0])
@@ -120,4 +119,4 @@ export class SqliteDialect extends SQLDialect {
   override getUpdateSQL(stack: VisitStack[], data: Record<string, unknown>, where?: WhereClause<unknown>): string {
     return super.getUpdateSQL(stack, data, where).replace(/_ROOT[.]?/g, '');
   }
-}
+}