@travetto/model-sql 3.0.0-rc.2 → 3.0.0-rc.21

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-sql/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-sql/DOC.ts and execute "npx trv doc" to rebuild -->
 # SQL Model Service
 ## SQL backing for the travetto model module, with real-time modeling support for SQL schemas.
 
@@ -29,9 +29,9 @@ npm install @travetto/model-sqlite
 
 The current SQL client support stands at:
    
-   *  [MySQL](https://www.mysql.com/) - 5.6 and 5.7
-   *  [Postgres](https://postgresql.org) - 11+
-   *  [SQLite](https://www.sqlite.org/) - (bettersqlite 7.6+)
+   *  [MySQL](https://www.mysql.com/) - 8.6+
+   *  [Postgres](https://postgresql.org) - 14+
+   *  [SQLite](https://www.sqlite.org/) - (bettersqlite 8.0+)
    *  `SQL Server` - Currently unsupported
    *  `Oracle` - Currently unsupported
 

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/model-sql",
-  "displayName": "SQL Model Service",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0-rc.21",
   "description": "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
     "sql",
@@ -18,27 +17,35 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
-    "support",
-    "test-support"
+    "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/model-sql"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.2",
-    "@travetto/context": "^3.0.0-rc.2",
-    "@travetto/model": "^3.0.0-rc.2",
-    "@travetto/model-query": "3.0.0-rc.2"
+    "@travetto/config": "^3.0.0-rc.21",
+    "@travetto/context": "^3.0.0-rc.20",
+    "@travetto/model": "^3.0.0-rc.21",
+    "@travetto/model-query": "^3.0.0-rc.21"
   },
-  "devDependencies": {
-    "@travetto/app": "^3.0.0-rc.2"
+  "peerDependencies": {
+    "@travetto/command": "^3.0.0-rc.17",
+    "@travetto/test": "^3.0.0-rc.23"
   },
-  "docDependencies": {
-    "@travetto/model-mysql": 1
+  "peerDependenciesMeta": {
+    "@travetto/command": {
+      "optional": true
+    },
+    "@travetto/test": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "SQL Model Service"
   },
   "publishConfig": {
     "access": "public"

package/src/config.ts

@@ -4,7 +4,7 @@ import { Config } from '@travetto/config';
  * SQL Model Config
  */
 @Config('model.sql')
-export class SQLModelConfig {
+export class SQLModelConfig<T extends {} = {}> {
   /**
    * Host to connect to
    */
@@ -40,5 +40,6 @@ export class SQLModelConfig {
   /**
    * Raw client options
    */
-  options = {};
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  options: T = {} as T;
 }

package/src/connection/base.ts

@@ -1,8 +1,8 @@
 import { Util } from '@travetto/base';
 import { AsyncContext } from '@travetto/context';
 
-const ContextActiveⲐ: unique symbol = Symbol.for('@trv:model/sql-active');
-const TxActiveⲐ: unique symbol = Symbol.for('@trv:model/sql-transaction');
+const ContextActiveⲐ: unique symbol = Symbol.for('@travetto/model:sql-active');
+const TxActiveⲐ: unique symbol = Symbol.for('@travetto/model:sql-transaction');
 
 export type TransactionType = 'required' | 'isolated' | 'force';
 

package/src/connection/decorator.ts

@@ -1,4 +1,4 @@
-import { MethodDescriptor } from '@travetto/base/src/internal/types';
+import type { MethodDescriptor } from '@travetto/base';
 import { Connection, TransactionType } from './base';
 
 /**

package/src/dialect/base.ts

@@ -1,10 +1,12 @@
+import { RootIndex } from '@travetto/manifest';
 import { SchemaRegistry, FieldConfig, Schema } from '@travetto/schema';
-import { Class, Util, AppError } from '@travetto/base';
+import { Class, ObjectUtil, AppError, TypedObject, DataUtil } from '@travetto/base';
 import { SelectClause, Query, SortClause, WhereClause, RetainFields } from '@travetto/model-query';
 import { BulkResponse, IndexConfig } from '@travetto/model';
 import { PointImpl } from '@travetto/model-query/src/internal/model/point';
 import { ModelType } from '@travetto/model/src/types/model';
 import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
+import { ModelUtil } from '@travetto/model/src/internal/util';
 
 import { SQLUtil, VisitStack } from '../internal/util';
 import { DeleteWrapper, InsertWrapper, DialectState } from '../internal/types';
@@ -186,7 +188,7 @@ export abstract class SQLDialect implements DialectState {
       return 'NULL';
     } else if (conf.type === String) {
       if (value instanceof RegExp) {
-        const src = Util.toRegex(value).source.replace(/\\b/g, this.regexWordBoundary);
+        const src = DataUtil.toRegex(value).source.replace(/\\b/g, this.regexWordBoundary);
         return this.quote(src);
       } else {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -309,7 +311,7 @@ export abstract class SQLDialect implements DialectState {
    * Generate a UUID
    */
   generateId(): string {
-    return Util.uuid(this.KEY_LEN);
+    return ModelUtil.uuid(this.KEY_LEN);
   }
 
   /**
@@ -424,7 +426,7 @@ export abstract class SQLDialect implements DialectState {
       }
       const sPath = this.resolveName(sStack);
 
-      if (Util.isPlainObject(top)) {
+      if (ObjectUtil.isPlainObject(top)) {
         const subKey = Object.keys(top)[0];
         if (!subKey.startsWith('$')) {
           const inner = this.getWhereFieldSQL(sStack, top);
@@ -456,7 +458,7 @@ export abstract class SQLDialect implements DialectState {
             }
             case '$regex': {
               // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-              const re = Util.toRegex(v as string);
+              const re = DataUtil.toRegex(v as string);
               const src = re.source;
               const ins = re.flags && re.flags.includes('i');
 
@@ -490,7 +492,7 @@ export abstract class SQLDialect implements DialectState {
             }
             case '$lt': case '$gt': case '$gte': case '$lte': {
               // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-              const subItems = Object.keys(top as typeof SQL_OPS)
+              const subItems = TypedObject.keys(top as typeof SQL_OPS)
                 .map(ssk => `${sPath} ${SQL_OPS[ssk]} ${resolve(top[ssk])}`);
               items.push(subItems.length > 1 ? `(${subItems.join(` ${SQL_OPS.$and} `)})` : subItems[0]);
               break;
@@ -630,7 +632,7 @@ ${this.getLimitSQL(cls, query)}`;
     const parent = stack.length > 1;
     const array = parent && config.array;
 
-    if (config.type && config.type.ᚕsynthetic) {
+    if (config.type && RootIndex.getFunctionMetadata(config.type)?.synthetic) {
       throw new AppError(`Cannot create SQL tables for synthetic types, please convert ${SQLUtil.buildPath(stack)} to a concrete class`);
     }
 
@@ -710,9 +712,9 @@ CREATE TABLE IF NOT EXISTS ${this.table(stack)} (
   getCreateIndexSQL<T extends ModelType>(cls: Class<T>, idx: IndexConfig<T>): string {
     const table = this.namespace(SQLUtil.classToStack(cls));
     const fields: [string, boolean][] = idx.fields.map(x => {
-      const key = Object.keys(x)[0];
+      const key = TypedObject.keys(x)[0];
       const val = x[key];
-      if (Util.isPlainObject(val)) {
+      if (ObjectUtil.isPlainObject(val)) {
         throw new Error('Unable to supported nested fields for indices');
       }
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions

package/src/internal/util.ts

@@ -1,4 +1,4 @@
-import { Class, Util } from '@travetto/base';
+import { Class, TypedObject, ObjectUtil } from '@travetto/base';
 import { SelectClause, SortClause } from '@travetto/model-query';
 import { ModelRegistry, ModelType } from '@travetto/model';
 import { SchemaRegistry, ClassConfig, FieldConfig } from '@travetto/schema';
@@ -6,7 +6,7 @@ import { AllViewⲐ } from '@travetto/schema/src/internal/types';
 
 import { DialectState, InsertWrapper, VisitHandler, VisitState, VisitInstanceNode, OrderBy } from './types';
 
-const TableⲐ = Symbol.for('@trv:model-sql/table');
+const TableⲐ = Symbol.for('@travetto/model-sql:table');
 
 export type VisitStack = {
   [TableⲐ]?: string;
@@ -45,8 +45,8 @@ export class SQLUtil {
   static cleanResults<T, U = T>(dct: DialectState, o: T | T[]): U | U[] {
     if (Array.isArray(o)) {
       return o.filter(x => x !== null && x !== undefined).map(x => this.cleanResults(dct, x));
-    } else if (!Util.isSimple(o)) {
-      for (const k of Object.keys(o)) {
+    } else if (!ObjectUtil.isSimple(o)) {
+      for (const k of TypedObject.keys(o)) {
         if (o[k] === null || o[k] === undefined || k === dct.parentPathField.name || k === dct.pathField.name || k === dct.idxField.name) {
           delete o[k];
         } else {
@@ -228,10 +228,10 @@ export class SQLUtil {
 
     let toGet = new Set<string>();
 
-    for (const [k, v] of Object.entries(select)) {
+    for (const [k, v] of TypedObject.entries(select)) {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       const sk = k as string;
-      if (!Util.isPlainObject(select[k]) && localMap[sk]) {
+      if (!ObjectUtil.isPlainObject(select[k]) && localMap[sk]) {
         if (!v) {
           if (toGet.size === 0) {
             toGet = new Set(SchemaRegistry.get(cls).views[AllViewⲐ].fields);
@@ -257,7 +257,7 @@ export class SQLUtil {
         const key = Object.keys(cl)[0];
         const val = cl[key];
         const field = { ...schema.views[AllViewⲐ].schema[key] };
-        if (Util.isPrimitive(val)) {
+        if (ObjectUtil.isPrimitive(val)) {
           stack.push(field);
           found = { stack, asc: val === 1 };
         } else {

package/src/service.ts

@@ -3,7 +3,7 @@ import {
   BulkOp, BulkResponse, ModelCrudSupport, ModelStorageSupport, ModelBulkSupport,
   NotFoundError, ModelRegistry, ExistsError, OptionalId
 } from '@travetto/model';
-import { Util, Class } from '@travetto/base';
+import { DataUtil, Class } from '@travetto/base';
 import { SchemaChange } from '@travetto/schema';
 import { AsyncContext } from '@travetto/context';
 import { Injectable } from '@travetto/di';
@@ -315,7 +315,7 @@ export class SQLModelService implements
 
     const results = await this.#exec<{ key: string, count: number }>(q.join('\n'));
     return results.records.map(x => {
-      x.count = Util.coerceType(x.count, Number);
+      x.count = DataUtil.coerceType(x.count, Number);
       return x;
     });
   }

package/{test-support → support/test}/query.ts

@@ -1,11 +1,11 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Schema, FieldConfig } from '@travetto/schema';
 import { Suite, Test } from '@travetto/test';
-import { BaseModelSuite } from '@travetto/model/test-support/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base';
 
-import { VisitStack } from '../src/internal/util';
-import { SQLModelService } from '../src/service';
+import { VisitStack } from '../../src/internal/util';
+import { SQLModelService } from '../../src/service';
 
 @Schema()
 class User {