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

package/README.md

@@ -13,18 +13,18 @@ npm install @travetto/model-postgres
 yarn add @travetto/model-postgres
 ```
 
-This module provides a [Postgres](https://postgresql.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 [Postgres](https://postgresql.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,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 { PostgreSQLDialect } from '@travetto/model-postgres';
+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-postgres",
-  "version": "8.0.0-alpha.24",
+  "version": "8.0.0-alpha.25",
   "type": "module",
   "description": "PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
@@ -28,16 +28,16 @@
     "directory": "module/model-postgres"
   },
   "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",
     "@types/pg": "^8.20.0",
     "pg": "^8.22.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.27"
+    "@travetto/cli": "^8.0.0-alpha.28"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/connection.ts

@@ -1,22 +1,18 @@
 import { type Pool, type PoolClient, default as pg } from 'pg';
 
-import { castTo, ShutdownManager } 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, ShutdownManager } from '@travetto/runtime';
 
 /**
  * Connection support for postgresql
  */
 export class PostgreSQLConnection extends Connection<PoolClient> {
-
   #pool: Pool;
   #config: SQLModelConfig;
 
-  constructor(
-    context: AsyncContext,
-    config: SQLModelConfig
-  ) {
+  constructor(context: AsyncContext, config: SQLModelConfig) {
     super(context);
     this.#config = config;
   }
@@ -33,7 +29,7 @@ export class PostgreSQLConnection extends Connection<PoolClient> {
       host: this.#config.host,
       port: this.#config.port,
       ...castTo({
-        parseInputDatesAsUTC: true,
+        parseInputDatesAsUTC: true
       }),
       ...(this.#config.options || {})
     });
@@ -52,7 +48,7 @@ export class PostgreSQLConnection extends Connection<PoolClient> {
     ShutdownManager.signal.addEventListener('abort', () => this.#pool.end());
   }
 
-  async execute<T = unknown>(pool: PoolClient, query: string, values?: unknown[]): Promise<{ count: number, records: T[] }> {
+  async execute<T = unknown>(pool: PoolClient, query: string, values?: unknown[]): Promise<{ count: number; records: T[] }> {
     console.debug('Executing query', { query });
     try {
       const out = await pool.query(query, values);
@@ -62,10 +58,13 @@ export class PostgreSQLConnection extends Connection<PoolClient> {
       const code = error && typeof error === 'object' && 'code' in error ? error.code : undefined;
       switch (code) {
         // Index already exists
-        case '42P07': throw new ExistsError('index', query);
+        case '42P07':
+          throw new ExistsError('index', query);
         // Unique violation
-        case '23505': throw new ExistsError('query', query);
-        default: throw error;
+        case '23505':
+          throw new ExistsError('query', query);
+        default:
+          throw error;
       }
     }
   }
@@ -77,4 +76,4 @@ export class PostgreSQLConnection extends Connection<PoolClient> {
   release(pool: PoolClient): void {
     pool.release();
   }
-}
+}

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 { ModelType } from '@travetto/model';
-import { castTo, type Class } from '@travetto/runtime';
-
-import { SQLDialect, type SQLModelConfig, SQLModelUtil, type VisitStack, type SQLTableDescription } 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 { PostgreSQLConnection } from './connection.ts';
 
@@ -13,7 +12,6 @@ import { PostgreSQLConnection } from './connection.ts';
  */
 @Injectable()
 export class PostgreSQLDialect extends SQLDialect {
-
   connection: PostgreSQLConnection;
 
   constructor(context: AsyncContext, config: SQLModelConfig) {
@@ -48,7 +46,7 @@ export class PostgreSQLDialect extends SQLDialect {
     const IGNORE_FIELDS = [this.pathField.name, this.parentPathField.name, this.idxField.name].map(field => `'${field}'`);
 
     // 1. Columns
-    const columns = await this.executeSQL<{ name: string, type: string, is_not_null: boolean }>(`
+    const columns = await this.executeSQL<{ name: string; type: string; is_not_null: boolean }>(`
       SELECT
         a.attname AS name,
         pg_catalog.format_type(a.atttypid, a.atttypmod) AS type,
@@ -72,7 +70,7 @@ export class PostgreSQLDialect extends SQLDialect {
     }
 
     // 2. Foreign Keys
-    const foreignKeys = await this.executeSQL<{ name: string, from_column: string, to_column: string, to_table: string }>(`
+    const foreignKeys = await this.executeSQL<{ name: string; from_column: string; to_column: string; to_table: string }>(`
       SELECT
         tc.constraint_name AS name, 
         kcu.column_name AS from_column,
@@ -88,7 +86,7 @@ export class PostgreSQLDialect extends SQLDialect {
     `);
 
     // 3. Indices
-    const indices = await this.executeSQL<{ name: string, is_unique: boolean, columns: string[] }>(`
+    const indices = await this.executeSQL<{ name: string; is_unique: boolean; columns: string[] }>(`
       SELECT
         i.relname AS name,
         ix.indisunique AS is_unique,
@@ -109,20 +107,15 @@ export class PostgreSQLDialect extends SQLDialect {
     return {
       columns: columns.records.map(col => ({
         ...col,
-        type: col.type.toUpperCase()
-          .replace('CHARACTER VARYING', 'VARCHAR')
-          .replace('INTEGER', 'INT'),
+        type: col.type.toUpperCase().replace('CHARACTER VARYING', 'VARCHAR').replace('INTEGER', 'INT'),
         is_not_null: !!col.is_not_null
       })),
       foreignKeys: foreignKeys.records,
-      indices: indices.records
-        .map(idx => ({
-          name: idx.name,
-          is_unique: idx.is_unique,
-          columns: idx.columns
-            .map(column => column.split(' '))
-            .map(([name, desc]) => ({ name, desc: desc === '1' }))
-        }))
+      indices: indices.records.map(idx => ({
+        name: idx.name,
+        is_unique: idx.is_unique,
+        columns: idx.columns.map(column => column.split(' ')).map(([name, desc]) => ({ name, desc: desc === '1' }))
+      }))
     };
   }
 
@@ -142,4 +135,4 @@ export class PostgreSQLDialect extends SQLDialect {
   override getTruncateAllTablesSQL<T extends ModelType>(cls: Class<T>): string[] {
     return [`TRUNCATE ${this.table(SQLModelUtil.classToStack(cls))} CASCADE;`];
   }
-}
+}

package/support/service.postgresql.ts

@@ -12,4 +12,4 @@ export const service: ServiceDescriptor = {
     POSTGRES_PASSWORD: 'travetto',
     POSTGRES_DB: 'app'
   }
-};
+};