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

package/README.md

@@ -13,18 +13,18 @@ npm install @travetto/model-mysql
 yarn add @travetto/model-mysql
 ```
 
-This module provides a [MySQL](https://www.mysql.com/)-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 [MySQL](https://www.mysql.com/)-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,9 +32,8 @@ 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 { MySQLDialect } from '@travetto/model-mysql';
+import { type SQLModelConfig, SQLModelService } from '@travetto/model-sql';
 
 export class Init {
   @InjectableFactory({ primary: true })

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-mysql",
-  "version": "8.0.0-alpha.24",
+  "version": "8.0.0-alpha.25",
   "type": "module",
   "description": "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
@@ -28,15 +28,15 @@
     "directory": "module/model-mysql"
   },
   "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",
     "mysql2": "^3.22.6"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.27"
+    "@travetto/cli": "^8.0.0-alpha.28"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/connection.ts

@@ -1,14 +1,18 @@
 import { createPool } from 'mysql2';
-import type { PoolConnection, Pool, OkPacket, ResultSetHeader, TypeCastField } from 'mysql2/promise';
+import type { OkPacket, Pool, PoolConnection, PreparedStatementInfo, ResultSetHeader, TypeCastField } from 'mysql2/promise';
 
-import { castTo, JSONUtil, ShutdownManager } from '@travetto/runtime';
 import type { AsyncContext } from '@travetto/context';
 import { ExistsError } from '@travetto/model';
 import { Connection, type SQLModelConfig } from '@travetto/model-sql';
+import { castTo, JSONUtil, ShutdownManager } from '@travetto/runtime';
 
 function isSimplePacket(value: unknown): value is OkPacket | ResultSetHeader {
-  return value !== null && value !== undefined && typeof value === 'object' && 'constructor' in value && (
-    value.constructor.name === 'OkPacket' || value.constructor.name === 'ResultSetHeader'
+  return (
+    value !== null &&
+    value !== undefined &&
+    typeof value === 'object' &&
+    'constructor' in value &&
+    (value.constructor.name === 'OkPacket' || value.constructor.name === 'ResultSetHeader')
   );
 }
 
@@ -16,14 +20,10 @@ function isSimplePacket(value: unknown): value is OkPacket | ResultSetHeader {
  * Connection support for mysql
  */
 export class MySQLConnection extends Connection<PoolConnection> {
-
   #pool: Pool;
   #config: SQLModelConfig;
 
-  constructor(
-    context: AsyncContext,
-    config: SQLModelConfig
-  ) {
+  constructor(context: AsyncContext, config: SQLModelConfig) {
     super(context);
     this.#config = config;
   }
@@ -56,7 +56,7 @@ export class MySQLConnection extends Connection<PoolConnection> {
         if (typeof result === 'string' && result.charAt(0) === '{' && result.charAt(result.length - 1) === '}') {
           try {
             return JSONUtil.fromUTF8(result);
-          } catch { }
+          } catch {}
         }
         break;
       }
@@ -64,12 +64,12 @@ export class MySQLConnection extends Connection<PoolConnection> {
     return result;
   }
 
-  async execute<T = unknown>(pool: PoolConnection, query: string, values?: unknown[]): Promise<{ count: number, records: T[] }> {
+  async execute<T = unknown>(pool: PoolConnection, query: string, values?: unknown[]): Promise<{ count: number; records: T[] }> {
     console.debug('Executing query', { query });
-    let prepared;
+    let prepared: PreparedStatementInfo | undefined;
     try {
       prepared = (values?.length ?? 0) > 0 ? await pool.prepare(query) : undefined;
-      const [results,] = await (prepared ? prepared.execute(values) : pool.query(query));
+      const [results] = await (prepared ? prepared.execute(values) : pool.query(query));
       if (isSimplePacket(results)) {
         return { records: [], count: results.affectedRows };
       } else {
@@ -83,14 +83,17 @@ export class MySQLConnection extends Connection<PoolConnection> {
       console.debug('Failed query', { error, query });
       const code = error && typeof error === 'object' && 'code' in error ? error.code : undefined;
       switch (code) {
-        case 'ER_DUP_ENTRY': throw new ExistsError('query', query);
-        case 'ER_DUP_KEYNAME': throw new ExistsError('index', query);
-        default: throw error;
+        case 'ER_DUP_ENTRY':
+          throw new ExistsError('query', query);
+        case 'ER_DUP_KEYNAME':
+          throw new ExistsError('index', query);
+        default:
+          throw error;
       }
     } finally {
       try {
         await prepared?.close();
-      } catch { }
+      } catch {}
     }
   }
 
@@ -101,4 +104,4 @@ export class MySQLConnection extends Connection<PoolConnection> {
   release(pool: PoolConnection): void {
     pool.release();
   }
-}
+}

package/src/dialect.ts

@@ -1,10 +1,10 @@
-import type { SchemaFieldConfig } from '@travetto/schema';
-import { Injectable } from '@travetto/di';
 import type { AsyncContext } from '@travetto/context';
+import { Injectable } from '@travetto/di';
+import type { IndexConfig, ModelType } from '@travetto/model';
 import type { WhereClause } from '@travetto/model-query';
-import { castTo, type Class } from '@travetto/runtime';
-import type { ModelType, IndexConfig } from '@travetto/model';
-import { type SQLModelConfig, SQLDialect, type VisitStack, type SQLTableDescription, SQLModelUtil } from '@travetto/model-sql';
+import { SQLDialect, type SQLModelConfig, SQLModelUtil, type SQLTableDescription, type VisitStack } from '@travetto/model-sql';
+import { type Class, castTo } from '@travetto/runtime';
+import type { SchemaFieldConfig } from '@travetto/schema';
 
 import { MySQLConnection } from './connection.ts';
 
@@ -13,7 +13,6 @@ import { MySQLConnection } from './connection.ts';
  */
 @Injectable()
 export class MySQLDialect extends SQLDialect {
-
   connection: MySQLConnection;
   tablePostfix = 'COLLATE=utf8mb4_bin ENGINE=InnoDB';
 
@@ -47,7 +46,7 @@ export class MySQLDialect extends SQLDialect {
     } else {
       // Customer operators
       Object.assign(this.SQL_OPS, {
-        $regex: 'REGEXP',
+        $regex: 'REGEXP'
       });
       // Double escape
       this.regexWordBoundary = '\\\\b';
@@ -73,7 +72,7 @@ export class MySQLDialect extends SQLDialect {
     const IGNORE_FIELDS = [this.pathField.name, this.parentPathField.name, this.idxField.name].map(field => `'${field}'`);
     const [columns, foreignKeys, indices] = await Promise.all([
       // 1. Columns
-      this.executeSQL<{ name: string, type: string, is_not_null: boolean }>(`
+      this.executeSQL<{ name: string; type: string; is_not_null: boolean }>(`
       SELECT 
         COLUMN_NAME AS name, 
         COLUMN_TYPE AS type, 
@@ -86,7 +85,7 @@ export class MySQLDialect extends SQLDialect {
     `),
 
       // 2. Foreign Keys
-      this.executeSQL<{ name: string, from_column: string, to_column: string, to_table: string }>(`
+      this.executeSQL<{ name: string; from_column: string; to_column: string; to_table: string }>(`
       SELECT 
         CONSTRAINT_NAME AS name, 
         COLUMN_NAME AS from_column, 
@@ -99,7 +98,7 @@ export class MySQLDialect extends SQLDialect {
     `),
 
       // 3. Indices
-      this.executeSQL<{ name: string, is_unique: number, columns: string }>(`
+      this.executeSQL<{ name: string; is_unique: number; columns: string }>(`
       SELECT 
         stat.INDEX_NAME AS name, 
         stat.NON_UNIQUE = 0 AS is_unique, 
@@ -167,10 +166,6 @@ export class MySQLDialect extends SQLDialect {
    * Suppress foreign key checks
    */
   override getTruncateAllTablesSQL<T extends ModelType>(cls: Class<T>): string[] {
-    return [
-      'SET FOREIGN_KEY_CHECKS = 0;',
-      ...super.getTruncateAllTablesSQL(cls),
-      'SET FOREIGN_KEY_CHECKS = 1;'
-    ];
+    return ['SET FOREIGN_KEY_CHECKS = 0;', ...super.getTruncateAllTablesSQL(cls), 'SET FOREIGN_KEY_CHECKS = 1;'];
   }
-}
+}

package/support/service.mysql.ts

@@ -12,5 +12,5 @@ export const service: ServiceDescriptor = {
     MYSQL_PASSWORD: 'travetto',
     MYSQL_USER: 'travetto',
     MYSQL_DATABASE: 'app'
-  },
-};
+  }
+};