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

package/README.md

@@ -23,8 +23,8 @@ The current SQL client support stands at:
 **Note**: Wider client support will roll out as usage increases.
 
 ## Assumed Behavior
-The [SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.") works quite a bit different than the average [Object Relationship Mapping](https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping) in that it makes assertions about how data is stored in the database.  The primary goal of the [SQL](https://en.wikipedia.org/wiki/SQL) support is not to handle every scenario that a relational database can provide, but to integrate with the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") structure, while leverage relational datastores to the best of their abilities. 
+The [SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.") works quite a bit different than the average [Object Relationship Mapping](https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping) in that it makes assertions about how data is stored in the database. The primary goal of the [SQL](https://en.wikipedia.org/wiki/SQL) support is not to handle every scenario that a relational database can provide, but to integrate with the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") structure, while leverage relational datastores to the best of their abilities. 
 
-The primary difference is around unique identifiers, and how parent/child relationships are managed.  In a normal database primary keys could be composite values between various fields.  For example a unique identifier could be a combination of `date` + `orderNumber` + `customerNumber`.  This is perfectly normal in a relational model, but [SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.") assumes unique identifiers ([UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)) as 32-character hexadecimal values.  In addition to these unique values, the parent's identifier is required in all children values.  This allows for some fairly optimized querying, updates, and deletions on changes. 
+The primary difference is around unique identifiers, and how parent/child relationships are managed. In a normal database primary keys could be composite values between various fields. For example a unique identifier could be a combination of `date` + `orderNumber` + `customerNumber`. This is perfectly normal in a relational model, but [SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.") assumes unique identifiers ([UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)) as 32-character hexadecimal values. In addition to these unique values, the parent's identifier is required in all children values. This allows for some fairly optimized querying, updates, and deletions on changes. 
 
 What this translates to, is that the framework here dictates the final schema, and doesn't support adapting to existing relational data stores. In greenfield projects, this is not an issue, but will most likely preclude its use in adapting to existing relational data sets.

package/__index__.ts

@@ -1,7 +1,7 @@
 export * from './src/config.ts';
-export * from './src/service.ts';
 export * from './src/connection/base.ts';
 export * from './src/connection/decorator.ts';
 export * from './src/dialect/base.ts';
+export * from './src/service.ts';
+export * from './src/types.ts';
 export * from './src/util.ts';
-export * from './src/types.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-sql",
-  "version": "8.0.0-alpha.24",
+  "version": "8.0.0-alpha.25",
   "type": "module",
   "description": "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
@@ -28,15 +28,15 @@
     "directory": "module/model-sql"
   },
   "dependencies": {
-    "@travetto/config": "^8.0.0-alpha.21",
-    "@travetto/context": "^8.0.0-alpha.19",
-    "@travetto/model": "^8.0.0-alpha.22",
-    "@travetto/model-indexed": "^8.0.0-alpha.24",
-    "@travetto/model-query": "^8.0.0-alpha.23"
+    "@travetto/config": "^8.0.0-alpha.22",
+    "@travetto/context": "^8.0.0-alpha.20",
+    "@travetto/model": "^8.0.0-alpha.23",
+    "@travetto/model-indexed": "^8.0.0-alpha.25",
+    "@travetto/model-query": "^8.0.0-alpha.24"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.27",
-    "@travetto/test": "^8.0.0-alpha.20"
+    "@travetto/cli": "^8.0.0-alpha.28",
+    "@travetto/test": "^8.0.0-alpha.21"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -42,4 +42,4 @@ export class SQLModelConfig<T extends {} = {}> {
    * Raw client options
    */
   options: T = asFull({});
-}
+}

package/src/connection/base.ts

@@ -1,5 +1,5 @@
-import { castTo, Util } from '@travetto/runtime';
 import { type AsyncContext, AsyncContextValue } from '@travetto/context';
+import { castTo, Util } from '@travetto/runtime';
 
 export type TransactionType = 'required' | 'isolated' | 'force';
 
@@ -9,7 +9,6 @@ export type TransactionType = 'required' | 'isolated' | 'force';
  * vs querying.
  */
 export abstract class Connection<C = unknown> {
-
   isolatedTransactions = true;
   nestedTransactions = true;
 
@@ -56,7 +55,7 @@ export abstract class Connection<C = unknown> {
    * @param rawConnection
    * @param query
    */
-  abstract execute<T = unknown>(rawConnection: C, query: string, values?: unknown[]): Promise<{ records: T[], count: number }>;
+  abstract execute<T = unknown>(rawConnection: C, query: string, values?: unknown[]): Promise<{ records: T[]; count: number }>;
 
   /**
    * Acquire new connection
@@ -80,7 +79,7 @@ export abstract class Connection<C = unknown> {
     }
 
     return this.context.run(async () => {
-      let connection;
+      let connection: C | undefined;
       try {
         connection = await this.acquire();
         this.#active.set(connection);
@@ -99,7 +98,7 @@ export abstract class Connection<C = unknown> {
    * @param operation
    * @param args
    */
-  async * iterateWithActive<R>(operation: () => AsyncIterable<R>): AsyncIterable<R> {
+  async *iterateWithActive<R>(operation: () => AsyncIterable<R>): AsyncIterable<R> {
     if (this.active) {
       yield* operation();
     }
@@ -130,7 +129,9 @@ export abstract class Connection<C = unknown> {
           await this.commitTx(this.active!, txId);
           return result;
         } catch (error) {
-          try { await this.rollbackTx(this.active!, txId); } catch { }
+          try {
+            await this.rollbackTx(this.active!, txId);
+          } catch {}
           throw error;
         }
       } else {
@@ -185,4 +186,4 @@ export abstract class Connection<C = unknown> {
       await this.execute(connection, this.transactionDialect.rollback);
     }
   }
-}
+}

package/src/connection/decorator.ts

@@ -1,4 +1,5 @@
 import type { AsyncIterableMethodDescriptor, AsyncMethodDescriptor } from '@travetto/runtime';
+
 import type { Connection, TransactionType } from './base.ts';
 
 /**
@@ -13,9 +14,7 @@ export interface ConnectionAware<C = unknown> {
  * @kind decorator
  */
 export function Connected() {
-  return function <T extends { connection?: Connection }>(
-    target: T, property: string, descriptor: AsyncMethodDescriptor<T>
-  ): void {
+  return function <T extends { connection?: Connection }>(target: T, property: string, descriptor: AsyncMethodDescriptor<T>): void {
     const handle = descriptor.value!;
     descriptor.value = function (...args: unknown[]): ReturnType<typeof handle> {
       return this.connection!.runWithActive(() => handle.call(this, ...args));
@@ -28,9 +27,7 @@ export function Connected() {
  * @kind decorator
  */
 export function ConnectedIterator() {
-  return function <T extends { connection?: Connection }>(
-    target: T, property: string, descriptor: AsyncIterableMethodDescriptor<T>
-  ): void {
+  return function <T extends { connection?: Connection }>(target: T, property: string, descriptor: AsyncIterableMethodDescriptor<T>): void {
     const handle = descriptor.value!;
     descriptor.value = async function* (...args: unknown[]): ReturnType<typeof handle> {
       yield* this.connection!.iterateWithActive(() => handle.call(this, ...args));
@@ -43,12 +40,10 @@ export function ConnectedIterator() {
  * @kind decorator
  */
 export function Transactional(mode: TransactionType = 'required') {
-  return function <T extends { connection?: Connection }>(
-    target: unknown, property: string, descriptor: AsyncMethodDescriptor<T>
-  ): void {
+  return function <T extends { connection?: Connection }>(target: unknown, property: string, descriptor: AsyncMethodDescriptor<T>): void {
     const handle = descriptor.value!;
     descriptor.value = function (...args: unknown[]): ReturnType<typeof handle> {
       return this.connection!.runWithTransaction(mode, () => handle.call(this, ...args));
     };
   };
-}
+}