@rvoh/psychic 1.5.0 → 1.5.2

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.5.1
+
+- fix issue with enum syncing related to multi-db engine support regression
+
+## 1.5.0
+
+- add support for multiple database engines in dream
+
 ## 1.2.3
 
 - add support for the connectionName argument when generating a resource

package/dist/cjs/src/bin/helpers/enumsAndTheirValues.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = enumsAndTheirValues;
 const dream_1 = require("@rvoh/dream");
 const kysely_1 = require("kysely");
-async function enumsAndTheirValues() {
+async function enumsAndTheirValues(connectionName = 'default') {
     const { rows } = await (0, kysely_1.sql) `
 SELECT pg_type.typname AS enum_type, pg_enum.enumlabel AS enum_label FROM pg_type JOIN pg_enum ON pg_enum.enumtypid = pg_type.oid;
 
-`.execute((0, dream_1.untypedDb)('primary'));
+`.execute((0, dream_1.untypedDb)(connectionName, 'primary'));
     const rowData = {};
     rows.forEach(row => {
         const enumType = row.enumType;

package/dist/cjs/src/bin/helpers/syncTypescriptOpenapiFiles.js

@@ -27,9 +27,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = syncTypescriptOpenapiFiles;
-const dream_1 = require("@rvoh/dream");
 const fs = __importStar(require("node:fs/promises"));
 const path = __importStar(require("node:path"));
+const openapi_typescript_1 = __importStar(require("openapi-typescript"));
+const typescript_1 = __importDefault(require("typescript"));
 const psychicPath_js_1 = __importDefault(require("../../helpers/path/psychicPath.js"));
 const index_js_1 = __importDefault(require("../../psychic-app/index.js"));
 async function syncTypescriptOpenapiFiles() {
@@ -37,10 +38,22 @@ async function syncTypescriptOpenapiFiles() {
     const syncableKeys = Object.keys(psychicApp.openapi).filter(key => psychicApp.openapi[key]?.syncTypes);
     const targetDir = path.join((0, psychicPath_js_1.default)('types'), 'openapi');
     await fs.mkdir(targetDir, { recursive: true });
-    await Promise.all(syncableKeys.map(key => {
+    await Promise.all(syncableKeys.map(async (key) => {
         const openapiOpts = psychicApp.openapi[key];
         const jsonPath = openapiOpts.outputFilepath;
         const outpath = path.join(targetDir, path.basename(jsonPath).replace(/\.json$/, '.d.ts'));
-        return dream_1.DreamCLI.spawn(`npx openapi-typescript ${jsonPath} -o ${outpath}`);
+        const contents = (await fs.readFile(jsonPath)).toString();
+        const data = await (0, openapi_typescript_1.default)(contents, {
+            transform(schemaObject) {
+                if (schemaObject.format === 'bigint') {
+                    const isNullable = schemaObject.nullable ||
+                        (Array.isArray(schemaObject.type) && schemaObject.type.includes('null'));
+                    return isNullable
+                        ? typescript_1.default.factory.createUnionTypeNode([openapi_typescript_1.STRING, openapi_typescript_1.NUMBER, openapi_typescript_1.NULL])
+                        : typescript_1.default.factory.createUnionTypeNode([openapi_typescript_1.STRING, openapi_typescript_1.NUMBER]);
+                }
+            },
+        });
+        await fs.writeFile(outpath, (0, openapi_typescript_1.astToString)(data));
     }));
 }

package/dist/cjs/src/openapi-renderer/helpers/dreamColumnToOpenapiType.js

@@ -21,35 +21,55 @@ function dreamColumnToOpenapiType(dreamClass, columnName) {
         case 'integer':
         case 'integer[]':
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)(columnMetadata.dbType, nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)(columnMetadata.dbType, {
+                    maybeNull: nullableColumn,
+                }),
             };
         case 'character varying':
         case 'citext':
         case 'text':
         case 'uuid':
+            return {
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string', { maybeNull: nullableColumn }),
+            };
         case 'bigint':
+            // customize formats for bigint values, since the openapi-typescript
+            // integration has been customized to treat a bigint as
+            // "string | number", rather than simply "string", which helps
+            // the request types generated by psychic-spec-helpers to accept
+            // primary/foreign key values in the requestBody payloads without
+            // raising type errors.
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string', nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string', {
+                    maybeNull: nullableColumn,
+                    format: 'bigint',
+                }),
             };
         case 'character varying[]':
         case 'citext[]':
         case 'text[]':
         case 'uuid[]':
+            return {
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string[]', { maybeNull: nullableColumn }),
+            };
         case 'bigint[]':
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string[]', nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string[]', {
+                    maybeNull: nullableColumn,
+                    format: 'bigint',
+                }),
             };
         case 'timestamp':
         case 'timestamp with time zone':
         case 'timestamp without time zone':
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('date-time', nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('date-time', { maybeNull: nullableColumn }),
             };
         case 'timestamp[]':
         case 'timestamp with time zone[]':
         case 'timestamp without time zone[]':
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('date-time[]', nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('date-time[]', { maybeNull: nullableColumn }),
             };
         case 'json':
         case 'jsonb':
@@ -70,11 +90,11 @@ function dreamColumnToOpenapiType(dreamClass, columnName) {
             };
         case 'numeric':
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('number', nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('number', { maybeNull: nullableColumn }),
             };
         case 'numeric[]':
             return {
-                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('number[]', nullableColumn),
+                [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('number[]', { maybeNull: nullableColumn }),
             };
         default:
             if (dreamClass.isVirtualColumn(columnName)) {

package/dist/cjs/src/openapi-renderer/helpers/openapiShorthandToOpenapi.js

@@ -23,15 +23,16 @@ function _openapiShorthandToOpenapi(shorthand, options) {
     const shorthandString = (0, maybeNullOpenapiShorthandToOpenapiShorthand_js_1.default)(shorthand);
     if (!shorthandString)
         return { type: 'null' };
-    const openapi = simpleOpenapiShorthandToOpenapi(shorthandString);
-    if (options.maybeNull || openapiShorthandIncludesNull(shorthand))
+    const openapi = simpleOpenapiShorthandToOpenapi(shorthandString, options);
+    if (options.maybeNull || openapiShorthandIncludesNull(shorthand)) {
         return { ...openapi, type: [openapi.type, 'null'] };
+    }
     return openapi;
 }
-function simpleOpenapiShorthandToOpenapi(shorthand) {
+function simpleOpenapiShorthandToOpenapi(shorthand, options) {
     switch (shorthand) {
         case 'string':
-            return { type: 'string' };
+            return options.format ? { type: 'string', format: options.format } : { type: 'string' };
         case 'boolean':
             return { type: 'boolean' };
         case 'number':
@@ -47,7 +48,10 @@ function simpleOpenapiShorthandToOpenapi(shorthand) {
         case 'null':
             return { type: 'null' };
         case 'string[]':
-            return { type: 'array', items: { type: 'string' } };
+            return {
+                type: 'array',
+                items: options.format ? { type: 'string', format: options.format } : { type: 'string' },
+            };
         case 'boolean[]':
             return { type: 'array', items: { type: 'boolean' } };
         case 'number[]':

package/dist/cjs/src/openapi-renderer/helpers/primitiveOpenapiStatementToOpenapi.js

@@ -10,6 +10,6 @@ const openapiShorthandToOpenapi_js_1 = __importDefault(require("./openapiShortha
  *
  * parses a primitive stored type
  */
-function primitiveOpenapiStatementToOpenapi(data, maybeNull = false) {
-    return (0, openapiShorthandToOpenapi_js_1.default)(data, { maybeNull });
+function primitiveOpenapiStatementToOpenapi(data, options = {}) {
+    return (0, openapiShorthandToOpenapi_js_1.default)(data, options);
 }

package/dist/esm/src/bin/helpers/enumsAndTheirValues.js

@@ -1,10 +1,10 @@
 import { untypedDb } from '@rvoh/dream';
 import { sql } from 'kysely';
-export default async function enumsAndTheirValues() {
+export default async function enumsAndTheirValues(connectionName = 'default') {
     const { rows } = await sql `
 SELECT pg_type.typname AS enum_type, pg_enum.enumlabel AS enum_label FROM pg_type JOIN pg_enum ON pg_enum.enumtypid = pg_type.oid;
 
-`.execute(untypedDb('primary'));
+`.execute(untypedDb(connectionName, 'primary'));
     const rowData = {};
     rows.forEach(row => {
         const enumType = row.enumType;

package/dist/esm/src/bin/helpers/syncTypescriptOpenapiFiles.js

@@ -1,6 +1,7 @@
-import { DreamCLI } from '@rvoh/dream';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
+import openapiTS, { astToString, NULL, NUMBER, STRING } from 'openapi-typescript';
+import ts from 'typescript';
 import psychicPath from '../../helpers/path/psychicPath.js';
 import PsychicApp from '../../psychic-app/index.js';
 export default async function syncTypescriptOpenapiFiles() {
@@ -8,10 +9,22 @@ export default async function syncTypescriptOpenapiFiles() {
     const syncableKeys = Object.keys(psychicApp.openapi).filter(key => psychicApp.openapi[key]?.syncTypes);
     const targetDir = path.join(psychicPath('types'), 'openapi');
     await fs.mkdir(targetDir, { recursive: true });
-    await Promise.all(syncableKeys.map(key => {
+    await Promise.all(syncableKeys.map(async (key) => {
         const openapiOpts = psychicApp.openapi[key];
         const jsonPath = openapiOpts.outputFilepath;
         const outpath = path.join(targetDir, path.basename(jsonPath).replace(/\.json$/, '.d.ts'));
-        return DreamCLI.spawn(`npx openapi-typescript ${jsonPath} -o ${outpath}`);
+        const contents = (await fs.readFile(jsonPath)).toString();
+        const data = await openapiTS(contents, {
+            transform(schemaObject) {
+                if (schemaObject.format === 'bigint') {
+                    const isNullable = schemaObject.nullable ||
+                        (Array.isArray(schemaObject.type) && schemaObject.type.includes('null'));
+                    return isNullable
+                        ? ts.factory.createUnionTypeNode([STRING, NUMBER, NULL])
+                        : ts.factory.createUnionTypeNode([STRING, NUMBER]);
+                }
+            },
+        });
+        await fs.writeFile(outpath, astToString(data));
     }));
 }

package/dist/esm/src/openapi-renderer/helpers/dreamColumnToOpenapiType.js

@@ -15,35 +15,55 @@ export default function dreamColumnToOpenapiType(dreamClass, columnName) {
         case 'integer':
         case 'integer[]':
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi(columnMetadata.dbType, nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi(columnMetadata.dbType, {
+                    maybeNull: nullableColumn,
+                }),
             };
         case 'character varying':
         case 'citext':
         case 'text':
         case 'uuid':
+            return {
+                [columnName]: primitiveOpenapiStatementToOpenapi('string', { maybeNull: nullableColumn }),
+            };
         case 'bigint':
+            // customize formats for bigint values, since the openapi-typescript
+            // integration has been customized to treat a bigint as
+            // "string | number", rather than simply "string", which helps
+            // the request types generated by psychic-spec-helpers to accept
+            // primary/foreign key values in the requestBody payloads without
+            // raising type errors.
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi('string', nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi('string', {
+                    maybeNull: nullableColumn,
+                    format: 'bigint',
+                }),
             };
         case 'character varying[]':
         case 'citext[]':
         case 'text[]':
         case 'uuid[]':
+            return {
+                [columnName]: primitiveOpenapiStatementToOpenapi('string[]', { maybeNull: nullableColumn }),
+            };
         case 'bigint[]':
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi('string[]', nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi('string[]', {
+                    maybeNull: nullableColumn,
+                    format: 'bigint',
+                }),
             };
         case 'timestamp':
         case 'timestamp with time zone':
         case 'timestamp without time zone':
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi('date-time', nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi('date-time', { maybeNull: nullableColumn }),
             };
         case 'timestamp[]':
         case 'timestamp with time zone[]':
         case 'timestamp without time zone[]':
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi('date-time[]', nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi('date-time[]', { maybeNull: nullableColumn }),
             };
         case 'json':
         case 'jsonb':
@@ -64,11 +84,11 @@ export default function dreamColumnToOpenapiType(dreamClass, columnName) {
             };
         case 'numeric':
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi('number', nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi('number', { maybeNull: nullableColumn }),
             };
         case 'numeric[]':
             return {
-                [columnName]: primitiveOpenapiStatementToOpenapi('number[]', nullableColumn),
+                [columnName]: primitiveOpenapiStatementToOpenapi('number[]', { maybeNull: nullableColumn }),
             };
         default:
             if (dreamClass.isVirtualColumn(columnName)) {

package/dist/esm/src/openapi-renderer/helpers/openapiShorthandToOpenapi.js

@@ -16,15 +16,16 @@ function _openapiShorthandToOpenapi(shorthand, options) {
     const shorthandString = maybeNullOpenapiShorthandToOpenapiShorthand(shorthand);
     if (!shorthandString)
         return { type: 'null' };
-    const openapi = simpleOpenapiShorthandToOpenapi(shorthandString);
-    if (options.maybeNull || openapiShorthandIncludesNull(shorthand))
+    const openapi = simpleOpenapiShorthandToOpenapi(shorthandString, options);
+    if (options.maybeNull || openapiShorthandIncludesNull(shorthand)) {
         return { ...openapi, type: [openapi.type, 'null'] };
+    }
     return openapi;
 }
-function simpleOpenapiShorthandToOpenapi(shorthand) {
+function simpleOpenapiShorthandToOpenapi(shorthand, options) {
     switch (shorthand) {
         case 'string':
-            return { type: 'string' };
+            return options.format ? { type: 'string', format: options.format } : { type: 'string' };
         case 'boolean':
             return { type: 'boolean' };
         case 'number':
@@ -40,7 +41,10 @@ function simpleOpenapiShorthandToOpenapi(shorthand) {
         case 'null':
             return { type: 'null' };
         case 'string[]':
-            return { type: 'array', items: { type: 'string' } };
+            return {
+                type: 'array',
+                items: options.format ? { type: 'string', format: options.format } : { type: 'string' },
+            };
         case 'boolean[]':
             return { type: 'array', items: { type: 'boolean' } };
         case 'number[]':

package/dist/esm/src/openapi-renderer/helpers/primitiveOpenapiStatementToOpenapi.js

@@ -4,6 +4,6 @@ import openapiShorthandToOpenapi from './openapiShorthandToOpenapi.js';
  *
  * parses a primitive stored type
  */
-export default function primitiveOpenapiStatementToOpenapi(data, maybeNull = false) {
-    return openapiShorthandToOpenapi(data, { maybeNull });
+export default function primitiveOpenapiStatementToOpenapi(data, options = {}) {
+    return openapiShorthandToOpenapi(data, options);
 }

package/dist/types/src/bin/helpers/enumsAndTheirValues.d.ts

@@ -1 +1 @@
-export default function enumsAndTheirValues(): Promise<Record<string, string[]>>;
+export default function enumsAndTheirValues(connectionName?: string): Promise<Record<string, string[]>>;

package/dist/types/src/openapi-renderer/helpers/openapiShorthandToOpenapi.d.ts

@@ -1,8 +1,9 @@
 import { OpenapiSchemaBody, OpenapiSchemaBodyShorthand, OpenapiShorthandPrimitiveTypes } from '@rvoh/dream';
-interface Options {
+export interface OpenapiShorthandToOpenapiOptions {
     maybeNull?: boolean;
+    format?: string | undefined;
 }
-export default function openapiShorthandToOpenapi(openapi: OpenapiShorthandPrimitiveTypes | OpenapiSchemaBodyShorthand | undefined, options?: Options): OpenapiSchemaBody;
+export default function openapiShorthandToOpenapi(openapi: OpenapiShorthandPrimitiveTypes | OpenapiSchemaBodyShorthand | undefined, options?: OpenapiShorthandToOpenapiOptions): OpenapiSchemaBody;
 export declare class UnrecognizedOpenapiShorthand extends Error {
     private shorthand;
     constructor(shorthand: any);
@@ -13,4 +14,3 @@ export declare class UnrecognizedOpenapiShape extends Error {
     constructor(openapi: any);
     get message(): string;
 }
-export {};

package/dist/types/src/openapi-renderer/helpers/primitiveOpenapiStatementToOpenapi.d.ts

@@ -1,7 +1,8 @@
 import { OpenapiSchemaBody, OpenapiSchemaBodyShorthand, OpenapiShorthandPrimitiveTypes } from '@rvoh/dream';
+import { OpenapiShorthandToOpenapiOptions } from './openapiShorthandToOpenapi.js';
 /**
  * @internal
  *
  * parses a primitive stored type
  */
-export default function primitiveOpenapiStatementToOpenapi(data: OpenapiShorthandPrimitiveTypes | OpenapiSchemaBodyShorthand | undefined, maybeNull?: boolean): OpenapiSchemaBody;
+export default function primitiveOpenapiStatementToOpenapi(data: OpenapiShorthandPrimitiveTypes | OpenapiSchemaBodyShorthand | undefined, options?: OpenapiShorthandToOpenapiOptions): OpenapiSchemaBody;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "author": "RVOHealth",
   "repository": {
     "type": "git",