@rvoh/psychic 1.6.1 → 1.6.2

package/dist/cjs/src/openapi-renderer/endpoint.js

@@ -9,16 +9,16 @@ const FailedToLookupSerializerForEndpoint_js_1 = __importDefault(require("../err
 const NonSerializerDerivedInOpenapiEndpointRenderer_js_1 = __importDefault(require("../error/openapi/NonSerializerDerivedInOpenapiEndpointRenderer.js"));
 const NonSerializerDerivedInToSchemaObjects_js_1 = __importDefault(require("../error/openapi/NonSerializerDerivedInToSchemaObjects.js"));
 const SerializerForEndpointNotAFunction_js_1 = __importDefault(require("../error/openapi/SerializerForEndpointNotAFunction.js"));
+const index_js_1 = __importDefault(require("../psychic-app/index.js"));
+const paramNamesForDreamClass_js_1 = __importDefault(require("../server/helpers/paramNamesForDreamClass.js"));
 const body_segment_js_1 = __importDefault(require("./body-segment.js"));
 const defaults_js_1 = require("./defaults.js");
-const dreamColumnToOpenapiType_js_1 = __importDefault(require("./helpers/dreamColumnToOpenapiType.js"));
+const dreamAttributeOpenapiShape_js_1 = require("./helpers/dreamAttributeOpenapiShape.js");
 const openapiOpts_js_1 = __importDefault(require("./helpers/openapiOpts.js"));
 const openapiRoute_js_1 = __importDefault(require("./helpers/openapiRoute.js"));
 const pageParamOpenapiProperty_js_1 = __importDefault(require("./helpers/pageParamOpenapiProperty.js"));
 const safelyAttachPaginationParamsToBodySegment_js_1 = __importDefault(require("./helpers/safelyAttachPaginationParamsToBodySegment.js"));
 const SerializerOpenapiRenderer_js_1 = __importDefault(require("./SerializerOpenapiRenderer.js"));
-const paramNamesForDreamClass_js_1 = __importDefault(require("../server/helpers/paramNamesForDreamClass.js"));
-const index_js_1 = __importDefault(require("../psychic-app/index.js"));
 class OpenapiEndpointRenderer {
     dreamsOrSerializers;
     controllerClass;
@@ -505,12 +505,12 @@ class OpenapiEndpointRenderer {
         if (required) {
             paramsShape.required = required;
         }
-        for (const columnName of paramSafeColumns) {
-            paramsShape.properties = {
-                ...paramsShape.properties,
-                ...(0, dreamColumnToOpenapiType_js_1.default)(dreamClass, columnName),
-            };
-        }
+        paramsShape.properties = paramSafeColumns.reduce((acc, columnName) => {
+            acc[columnName] = (0, dreamAttributeOpenapiShape_js_1.dreamColumnOpenapiShape)(dreamClass, columnName, undefined, {
+                allowGenericJson: true,
+            });
+            return acc;
+        }, paramsShape.properties);
         let processedSchema = new body_segment_js_1.default(paramsShape, {
             renderOpts,
             target: 'request',

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

@@ -5,8 +5,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UseCustomOpenapiForJson = exports.UseCustomOpenapiForVirtualAttributes = void 0;
 exports.dreamColumnOpenapiShape = dreamColumnOpenapiShape;
+const body_segment_js_1 = __importDefault(require("../body-segment.js"));
 const openapiShorthandToOpenapi_js_1 = __importDefault(require("./openapiShorthandToOpenapi.js"));
-function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined, { suppressResponseEnums = false } = {}) {
+function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined, { suppressResponseEnums = false, allowGenericJson = false, } = {}) {
+    if (dreamClass.isVirtualColumn(column)) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+        const openapiObject = (0, openapiShorthandToOpenapi_js_1.default)((openapi ?? {}));
+        const metadata = dreamClass['virtualAttributes'].find(statement => statement.property === column);
+        if (metadata?.type) {
+            return {
+                ...new body_segment_js_1.default(metadata.type, {
+                    renderOpts: {
+                        casing: 'camel',
+                        suppressResponseEnums: false,
+                    },
+                    target: 'request',
+                }).render().openapi,
+                ...openapiObject,
+            };
+        }
+        else if (openapi) {
+            return openapiObject;
+        }
+        else {
+            return {
+                anyOf: [{ type: ['string', 'null'] }, { type: ['number', 'null'] }, { type: ['object', 'null'] }],
+            };
+        }
+    }
     const dream = dreamClass.prototype;
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
     const dreamColumnInfo = dream.schema[dream.table]?.columns[column];
@@ -16,13 +42,15 @@ function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined, { supp
             return (0, openapiShorthandToOpenapi_js_1.default)(openapi);
         throw new UseCustomOpenapiForVirtualAttributes(dreamClass, column);
     }
-    switch (baseDbType(dreamColumnInfo)) {
-        case 'json':
-        case 'jsonb':
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
-            if (openapi)
-                return (0, openapiShorthandToOpenapi_js_1.default)(openapi);
-            throw new UseCustomOpenapiForJson(dreamClass, column);
+    if (!allowGenericJson) {
+        switch (baseDbType(dreamColumnInfo)) {
+            case 'json':
+            case 'jsonb':
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+                if (openapi)
+                    return (0, openapiShorthandToOpenapi_js_1.default)(openapi);
+                throw new UseCustomOpenapiForJson(dreamClass, column);
+        }
     }
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
     const openapiObject = (0, openapiShorthandToOpenapi_js_1.default)((openapi ?? {}));
@@ -35,10 +63,12 @@ function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined, { supp
         };
     }
     else {
-        const existingType = singleType.type;
+        const existingType = dreamColumnInfo.allowNull
+            ? [singleType.type, 'null']
+            : singleType.type;
         return {
             ...singleType,
-            type: dreamColumnInfo.allowNull && !Array.isArray(existingType) ? [existingType, 'null'] : existingType,
+            type: existingType,
             ...openapiObject,
         };
     }
@@ -55,13 +85,18 @@ function singularAttributeOpenapiShape(dreamColumnInfo, suppressResponseEnums) {
             };
         }
         else {
-            return { type: 'string', enum: dreamColumnInfo.enumValues };
+            return {
+                type: 'string',
+                enum: [
+                    ...dreamColumnInfo.enumValues,
+                    ...(dreamColumnInfo.allowNull && !dreamColumnInfo.isArray ? [null] : []),
+                ],
+            };
         }
     }
     switch (baseDbType(dreamColumnInfo)) {
         case 'boolean':
             return { type: 'boolean' };
-        case 'bigint':
         case 'bigserial':
         case 'bytea':
         case 'char':
@@ -84,6 +119,8 @@ function singularAttributeOpenapiShape(dreamColumnInfo, suppressResponseEnums) {
         case 'smallint':
         case 'smallserial':
             return { type: 'integer' };
+        case 'bigint':
+            return { type: 'string', format: 'bigint' };
         case 'numeric':
         case 'decimal':
             return { type: 'number', format: 'decimal' };
@@ -99,6 +136,9 @@ function singularAttributeOpenapiShape(dreamColumnInfo, suppressResponseEnums) {
             return { type: 'string', format: 'date-time' };
         case 'date':
             return { type: 'string', format: 'date' };
+        case 'json':
+        case 'jsonb':
+            return { type: 'object' };
         default:
             throw new Error(`Unrecognized dbType used in serializer OpenAPI type declaration: ${dreamColumnInfo.dbType}`);
     }

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

@@ -65,7 +65,7 @@ function simpleOpenapiShorthandToOpenapi(shorthand, options) {
         case 'integer[]':
             return { type: 'array', items: { type: 'integer' } };
         case 'json':
-            return { type: 'json' };
+            return { type: 'object' };
         default: {
             // protection so that if a new OpenapiShorthandPrimitiveBaseTypes is ever added, this will throw a type error at build time
             const _never = shorthand;

package/dist/esm/src/openapi-renderer/endpoint.js

@@ -3,16 +3,16 @@ import OpenApiFailedToLookupSerializerForEndpoint from '../error/openapi/FailedT
 import NonSerializerDerivedInOpenapiEndpointRenderer from '../error/openapi/NonSerializerDerivedInOpenapiEndpointRenderer.js';
 import NonSerializerDerivedInToSchemaObjects from '../error/openapi/NonSerializerDerivedInToSchemaObjects.js';
 import OpenApiSerializerForEndpointNotAFunction from '../error/openapi/SerializerForEndpointNotAFunction.js';
+import PsychicApp from '../psychic-app/index.js';
+import paramNamesForDreamClass from '../server/helpers/paramNamesForDreamClass.js';
 import OpenapiSegmentExpander from './body-segment.js';
 import { DEFAULT_OPENAPI_RESPONSES } from './defaults.js';
-import dreamColumnToOpenapiType from './helpers/dreamColumnToOpenapiType.js';
+import { dreamColumnOpenapiShape } from './helpers/dreamAttributeOpenapiShape.js';
 import openapiOpts from './helpers/openapiOpts.js';
 import openapiRoute from './helpers/openapiRoute.js';
 import openapiPageParamProperty from './helpers/pageParamOpenapiProperty.js';
 import safelyAttachPaginationParamToRequestBodySegment from './helpers/safelyAttachPaginationParamsToBodySegment.js';
 import SerializerOpenapiRenderer from './SerializerOpenapiRenderer.js';
-import paramNamesForDreamClass from '../server/helpers/paramNamesForDreamClass.js';
-import PsychicApp from '../psychic-app/index.js';
 export default class OpenapiEndpointRenderer {
     dreamsOrSerializers;
     controllerClass;
@@ -499,12 +499,12 @@ export default class OpenapiEndpointRenderer {
         if (required) {
             paramsShape.required = required;
         }
-        for (const columnName of paramSafeColumns) {
-            paramsShape.properties = {
-                ...paramsShape.properties,
-                ...dreamColumnToOpenapiType(dreamClass, columnName),
-            };
-        }
+        paramsShape.properties = paramSafeColumns.reduce((acc, columnName) => {
+            acc[columnName] = dreamColumnOpenapiShape(dreamClass, columnName, undefined, {
+                allowGenericJson: true,
+            });
+            return acc;
+        }, paramsShape.properties);
         let processedSchema = new OpenapiSegmentExpander(paramsShape, {
             renderOpts,
             target: 'request',

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

@@ -1,5 +1,31 @@
+import OpenapiSegmentExpander from '../body-segment.js';
 import openapiShorthandToOpenapi from './openapiShorthandToOpenapi.js';
-export function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined, { suppressResponseEnums = false } = {}) {
+export function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined, { suppressResponseEnums = false, allowGenericJson = false, } = {}) {
+    if (dreamClass.isVirtualColumn(column)) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+        const openapiObject = openapiShorthandToOpenapi((openapi ?? {}));
+        const metadata = dreamClass['virtualAttributes'].find(statement => statement.property === column);
+        if (metadata?.type) {
+            return {
+                ...new OpenapiSegmentExpander(metadata.type, {
+                    renderOpts: {
+                        casing: 'camel',
+                        suppressResponseEnums: false,
+                    },
+                    target: 'request',
+                }).render().openapi,
+                ...openapiObject,
+            };
+        }
+        else if (openapi) {
+            return openapiObject;
+        }
+        else {
+            return {
+                anyOf: [{ type: ['string', 'null'] }, { type: ['number', 'null'] }, { type: ['object', 'null'] }],
+            };
+        }
+    }
     const dream = dreamClass.prototype;
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
     const dreamColumnInfo = dream.schema[dream.table]?.columns[column];
@@ -9,13 +35,15 @@ export function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined,
             return openapiShorthandToOpenapi(openapi);
         throw new UseCustomOpenapiForVirtualAttributes(dreamClass, column);
     }
-    switch (baseDbType(dreamColumnInfo)) {
-        case 'json':
-        case 'jsonb':
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
-            if (openapi)
-                return openapiShorthandToOpenapi(openapi);
-            throw new UseCustomOpenapiForJson(dreamClass, column);
+    if (!allowGenericJson) {
+        switch (baseDbType(dreamColumnInfo)) {
+            case 'json':
+            case 'jsonb':
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+                if (openapi)
+                    return openapiShorthandToOpenapi(openapi);
+                throw new UseCustomOpenapiForJson(dreamClass, column);
+        }
     }
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
     const openapiObject = openapiShorthandToOpenapi((openapi ?? {}));
@@ -28,10 +56,12 @@ export function dreamColumnOpenapiShape(dreamClass, column, openapi = undefined,
         };
     }
     else {
-        const existingType = singleType.type;
+        const existingType = dreamColumnInfo.allowNull
+            ? [singleType.type, 'null']
+            : singleType.type;
         return {
             ...singleType,
-            type: dreamColumnInfo.allowNull && !Array.isArray(existingType) ? [existingType, 'null'] : existingType,
+            type: existingType,
             ...openapiObject,
         };
     }
@@ -48,13 +78,18 @@ function singularAttributeOpenapiShape(dreamColumnInfo, suppressResponseEnums) {
             };
         }
         else {
-            return { type: 'string', enum: dreamColumnInfo.enumValues };
+            return {
+                type: 'string',
+                enum: [
+                    ...dreamColumnInfo.enumValues,
+                    ...(dreamColumnInfo.allowNull && !dreamColumnInfo.isArray ? [null] : []),
+                ],
+            };
         }
     }
     switch (baseDbType(dreamColumnInfo)) {
         case 'boolean':
             return { type: 'boolean' };
-        case 'bigint':
         case 'bigserial':
         case 'bytea':
         case 'char':
@@ -77,6 +112,8 @@ function singularAttributeOpenapiShape(dreamColumnInfo, suppressResponseEnums) {
         case 'smallint':
         case 'smallserial':
             return { type: 'integer' };
+        case 'bigint':
+            return { type: 'string', format: 'bigint' };
         case 'numeric':
         case 'decimal':
             return { type: 'number', format: 'decimal' };
@@ -92,6 +129,9 @@ function singularAttributeOpenapiShape(dreamColumnInfo, suppressResponseEnums) {
             return { type: 'string', format: 'date-time' };
         case 'date':
             return { type: 'string', format: 'date' };
+        case 'json':
+        case 'jsonb':
+            return { type: 'object' };
         default:
             throw new Error(`Unrecognized dbType used in serializer OpenAPI type declaration: ${dreamColumnInfo.dbType}`);
     }

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

@@ -58,7 +58,7 @@ function simpleOpenapiShorthandToOpenapi(shorthand, options) {
         case 'integer[]':
             return { type: 'array', items: { type: 'integer' } };
         case 'json':
-            return { type: 'json' };
+            return { type: 'object' };
         default: {
             // protection so that if a new OpenapiShorthandPrimitiveBaseTypes is ever added, this will throw a type error at build time
             const _never = shorthand;

package/dist/types/src/openapi-renderer/endpoint.d.ts

@@ -2,10 +2,10 @@ import { Dream, DreamAttributes, DreamOrViewModelClassSerializerKey, DreamParamS
 import PsychicController from '../controller/index.js';
 import { HttpStatusCode, HttpStatusCodeNumber } from '../error/http/status-codes.js';
 import { DreamOrViewModelClassSerializerArrayKeys } from '../helpers/typeHelpers.js';
+import { ValidateOpenapiSchemaOptions } from '../helpers/validateOpenApiSchema.js';
 import { RouteConfig } from '../router/route-manager.js';
 import { HttpMethod } from '../router/types.js';
 import { OpenapiBodySegment, ReferencedSerializersAndOpenapiEndpointResponse, SerializerArray } from './body-segment.js';
-import { ValidateOpenapiSchemaOptions } from '../helpers/validateOpenApiSchema.js';
 export interface OpenapiRenderOpts {
     casing: SerializerCasing;
     suppressResponseEnums: boolean;