@rvoh/psychic 0.28.6 → 0.29.1

package/dist/cjs/src/openapi-renderer/body-segment.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -6,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const dream_1 = require("@rvoh/dream");
 const cache_js_1 = require("../psychic-application/cache.js");
 const isBlankDescription_js_1 = __importDefault(require("./helpers/isBlankDescription.js"));
+const primitiveOpenapiStatementToOpenapi_js_1 = __importStar(require("./helpers/primitiveOpenapiStatementToOpenapi.js"));
 const serializer_js_1 = __importDefault(require("./serializer.js"));
 class OpenapiBodySegmentRenderer {
     controllerClass;
@@ -113,23 +137,40 @@ class OpenapiBodySegmentRenderer {
             return 'anyOf';
         if (allOfBodySegment.allOf)
             return 'allOf';
-        if (objectBodySegment.type === 'object')
+        if (this.maybeNullTypeToType(objectBodySegment) === 'object')
             return 'object';
-        else if (arrayBodySegment.type === 'array')
+        else if (this.maybeNullTypeToType(arrayBodySegment) === 'array')
             return 'array';
         else {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
             if (dream_1.openapiShorthandPrimitiveTypes.includes(bodySegment))
                 return 'openapi_primitive_literal';
             if (typeof bodySegment === 'object') {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
-                if (dream_1.openapiShorthandPrimitiveTypes.includes(bodySegment.type))
+                if (dream_1.openapiShorthandPrimitiveTypes.includes(this.maybeNullTypeToType(bodySegment)))
                     return 'openapi_primitive_object';
             }
             if (typeof bodySegment === 'object')
                 return 'unknown_object';
         }
     }
+    maybeNullTypeToType(bodySegment) {
+        if (bodySegment === undefined)
+            return undefined;
+        if (typeof bodySegment === 'string')
+            return bodySegment;
+        const safeBodySegment = bodySegment;
+        const openapiType = safeBodySegment.type;
+        if (Array.isArray(openapiType)) {
+            if (openapiType[1] === 'null')
+                return openapiType[0];
+            if (openapiType[0] === 'null')
+                return openapiType[1];
+            return undefined;
+        }
+        else {
+            return openapiType;
+        }
+    }
     /**
      * @internal
      *
@@ -170,13 +211,9 @@ class OpenapiBodySegmentRenderer {
      */
     arrayStatement(bodySegment) {
         const data = this.applyCommonFieldsToPayload({
-            type: 'array',
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
+            type: bodySegment.type,
             items: this.recursivelyParseBody(bodySegment.items),
         });
-        if (bodySegment.nullable) {
-            data.nullable = true;
-        }
         const description = bodySegment.description;
         if (description) {
             data.description = description;
@@ -191,14 +228,11 @@ class OpenapiBodySegmentRenderer {
     objectStatement(bodySegment) {
         const objectBodySegment = bodySegment;
         const data = {
-            type: 'object',
+            type: bodySegment.type,
         };
         if (objectBodySegment.description) {
             data.description = objectBodySegment.description;
         }
-        if (objectBodySegment.nullable) {
-            data.nullable = true;
-        }
         if (objectBodySegment.summary) {
             data.summary = objectBodySegment.summary;
         }
@@ -246,7 +280,7 @@ class OpenapiBodySegmentRenderer {
      * recursively parses a primitive literal type (i.e. string or boolean[])
      */
     primitiveLiteralStatement(bodySegment) {
-        return this.parseAttributeValue(bodySegment);
+        return (0, primitiveOpenapiStatementToOpenapi_js_1.default)(bodySegment);
     }
     /**
      * @internal
@@ -254,53 +288,22 @@ class OpenapiBodySegmentRenderer {
      * recursively parses a primitive object type (i.e. { type: 'string[]' })
      */
     primitiveObjectStatement(bodySegment) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
-        if (/\[\]$/.test(bodySegment.type)) {
-            return this.applyConfigurationOptions(this.applyCommonFieldsToPayload(
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
-            this.expandShorthandArray(bodySegment)));
+        const safeBodySegment = bodySegment;
+        if (this.typeIsOpenapiArrayPrimitive(safeBodySegment.type)) {
+            return this.applyConfigurationOptions(this.applyCommonFieldsToPayload({
+                ...safeBodySegment,
+                ...(0, primitiveOpenapiStatementToOpenapi_js_1.default)(safeBodySegment.type),
+            }));
         }
         else {
-            return this.applyConfigurationOptions(this.applyCommonFieldsToPayload(
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
-            this.expandType(bodySegment)));
+            return this.applyConfigurationOptions(this.applyCommonFieldsToPayload({
+                ...safeBodySegment,
+                ...(0, primitiveOpenapiStatementToOpenapi_js_1.default)(safeBodySegment.type),
+            }));
         }
     }
-    expandShorthandArray(bodySegment) {
-        const retObj = {
-            ...bodySegment,
-            type: 'array',
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            items: this.expandType({
-                // ...bodySegment,
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-explicit-any
-                type: bodySegment.type.replace(/\[\]$/, ''),
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            }),
-        };
-        if (bodySegment.nullable) {
-            retObj.nullable = true;
-        }
-        return retObj;
-    }
-    expandType(bodySegment) {
-        switch (bodySegment.type) {
-            case 'decimal':
-            case 'double':
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access
-                ;
-                bodySegment.format = bodySegment.type;
-                bodySegment.type = 'number';
-                break;
-            case 'date':
-            case 'date-time':
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access
-                ;
-                bodySegment.format = bodySegment.type;
-                bodySegment.type = 'string';
-                break;
-        }
-        return bodySegment;
+    typeIsOpenapiArrayPrimitive(openapiType) {
+        return /\[\]$/.test((0, primitiveOpenapiStatementToOpenapi_js_1.maybeNullPrimitiveToPrimitive)(openapiType));
     }
     applyConfigurationOptions(obj) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-assignment
@@ -359,19 +362,17 @@ The following values will be allowed:
         };
         if (serializerRefBodySegment.many) {
             const returnVal = {
-                type: 'array',
+                type: serializerRefBodySegment.maybeNull ? ['array', 'null'] : 'array',
                 items: {
                     $ref: `#/components/schemas/${serializerKey}`,
                 },
             };
-            if (serializerRefBodySegment.nullable)
-                returnVal.nullable = true;
             return returnVal;
         }
         else {
-            if (serializerRefBodySegment.nullable) {
+            if (serializerRefBodySegment.maybeNull) {
                 return {
-                    allOf: [{ $ref: `#/components/schemas/${serializerKey}` }, { nullable: true }],
+                    allOf: [{ $ref: `#/components/schemas/${serializerKey}` }, { type: 'null' }],
                 };
             }
             else {
@@ -412,81 +413,6 @@ The following values will be allowed:
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         return this.applyCommonFieldsToPayload(bodySegment);
     }
-    /**
-     * @internal
-     *
-     * parses a primitive stored type
-     */
-    parseAttributeValue(data) {
-        if (!data)
-            return {
-                type: 'object',
-                nullable: true,
-            };
-        switch (data) {
-            case 'string[]':
-            case 'number[]':
-            case 'boolean[]':
-            case 'integer[]':
-                return (0, dream_1.compact)({
-                    type: 'array',
-                    items: {
-                        type: this.serializerTypeToOpenapiType(data),
-                    },
-                });
-            case 'decimal[]':
-            case 'double[]':
-                return (0, dream_1.compact)({
-                    type: 'array',
-                    items: {
-                        type: 'number',
-                        format: data.replace(/\[\]$/, ''),
-                    },
-                });
-            case 'date[]':
-            case 'date-time[]':
-                return (0, dream_1.compact)({
-                    type: 'array',
-                    items: {
-                        type: 'string',
-                        format: data.replace(/\[\]$/, ''),
-                    },
-                });
-            case 'decimal':
-            case 'double':
-                return (0, dream_1.compact)({
-                    type: 'number',
-                    format: data,
-                });
-            case 'date':
-            case 'date-time':
-                return (0, dream_1.compact)({
-                    type: 'string',
-                    format: data,
-                });
-            default:
-                return (0, dream_1.compact)({
-                    type: this.serializerTypeToOpenapiType(data),
-                });
-        }
-    }
-    /**
-     * @internal
-     *
-     * sanitizes primitive openapi type before putting in
-     * openapi type fields
-     */
-    serializerTypeToOpenapiType(type) {
-        switch (type) {
-            case 'date':
-            case 'date-time':
-            case 'date[]':
-            case 'date-time[]':
-                return 'string';
-            default:
-                return type.replace(/\[\]$/, '');
-        }
-    }
     /**
      * @internal
      *
@@ -497,11 +423,6 @@ The following values will be allowed:
         const returnObj = {
             ...obj,
         };
-        if (objectCast.nullable) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
-            ;
-            returnObj.nullable = true;
-        }
         if (objectCast.description) {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
             ;

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

@@ -10,6 +10,7 @@ const index_js_1 = __importDefault(require("../psychic-application/index.js"));
 const body_segment_js_1 = __importDefault(require("./body-segment.js"));
 const defaults_js_1 = require("./defaults.js");
 const openapiRoute_js_1 = __importDefault(require("./helpers/openapiRoute.js"));
+const primitiveOpenapiStatementToOpenapi_js_1 = __importDefault(require("./helpers/primitiveOpenapiStatementToOpenapi.js"));
 const serializer_js_1 = __importDefault(require("./serializer.js"));
 class OpenapiEndpointRenderer {
     dreamsOrSerializers;
@@ -27,7 +28,6 @@ class OpenapiEndpointRenderer {
     security;
     summary;
     description;
-    nullable;
     omitDefaultHeaders;
     omitDefaultResponses;
     defaultResponse;
@@ -47,7 +47,7 @@ class OpenapiEndpointRenderer {
      * const json = JSON.encode(openapiJsonContents, null, 2)
      * ```
      */
-    constructor(dreamsOrSerializers, controllerClass, action, { requestBody, headers, many, query, responses, serializerKey, status, tags, security, pathParams, description, nullable, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, } = {}) {
+    constructor(dreamsOrSerializers, controllerClass, action, { requestBody, headers, many, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, } = {}) {
         this.dreamsOrSerializers = dreamsOrSerializers;
         this.controllerClass = controllerClass;
         this.action = action;
@@ -62,7 +62,6 @@ class OpenapiEndpointRenderer {
         this.pathParams = pathParams;
         this.summary = summary;
         this.description = description;
-        this.nullable = nullable;
         this.tags = tags === undefined ? controllerClass.openapiConfig?.tags || [] : tags;
         this.omitDefaultHeaders =
             omitDefaultHeaders === undefined
@@ -406,6 +405,7 @@ class OpenapiEndpointRenderer {
         }
         for (const columnName of paramSafeColumns) {
             const columnMetadata = columns[columnName];
+            const nullableColumn = columnMetadata?.allowNull;
             switch (columnMetadata?.dbType) {
                 case 'boolean':
                 case 'boolean[]':
@@ -415,9 +415,7 @@ class OpenapiEndpointRenderer {
                 case 'integer[]':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: columnMetadata.dbType,
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)(columnMetadata.dbType, nullableColumn),
                     };
                     break;
                 case 'character varying':
@@ -427,9 +425,7 @@ class OpenapiEndpointRenderer {
                 case 'bigint':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: 'string',
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string', nullableColumn),
                     };
                     break;
                 case 'character varying[]':
@@ -439,12 +435,7 @@ class OpenapiEndpointRenderer {
                 case 'bigint[]':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: 'array',
-                            items: {
-                                type: 'string',
-                            },
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('string[]', nullableColumn),
                     };
                     break;
                 case 'timestamp':
@@ -452,9 +443,7 @@ class OpenapiEndpointRenderer {
                 case 'timestamp without time zone':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: 'date-time',
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('date-time', nullableColumn),
                     };
                     break;
                 case 'timestamp[]':
@@ -462,12 +451,7 @@ class OpenapiEndpointRenderer {
                 case 'timestamp without time zone[]':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: 'array',
-                            items: {
-                                type: 'date-time',
-                            },
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('date-time[]', nullableColumn),
                     };
                     break;
                 case 'json':
@@ -475,7 +459,7 @@ class OpenapiEndpointRenderer {
                     paramsShape.properties = {
                         ...paramsShape.properties,
                         [columnName]: {
-                            type: 'object',
+                            type: nullableColumn ? ['object', 'null'] : 'object',
                         },
                     };
                     break;
@@ -484,7 +468,7 @@ class OpenapiEndpointRenderer {
                     paramsShape.properties = {
                         ...paramsShape.properties,
                         [columnName]: {
-                            type: 'array',
+                            type: nullableColumn ? ['array', 'null'] : 'array',
                             items: {
                                 type: 'object',
                             },
@@ -494,20 +478,13 @@ class OpenapiEndpointRenderer {
                 case 'numeric':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: 'number',
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('number', nullableColumn),
                     };
                     break;
                 case 'numeric[]':
                     paramsShape.properties = {
                         ...paramsShape.properties,
-                        [columnName]: {
-                            type: 'array',
-                            items: {
-                                type: 'number',
-                            },
-                        },
+                        [columnName]: (0, primitiveOpenapiStatementToOpenapi_js_1.default)('number[]', nullableColumn),
                     };
                     break;
                 default:
@@ -526,9 +503,9 @@ class OpenapiEndpointRenderer {
                                 ...paramsShape.properties,
                                 [columnName]: {
                                     anyOf: [
-                                        { type: 'string', nullable: true },
-                                        { type: 'number', nullable: true },
-                                        { type: 'object', nullable: true },
+                                        { type: ['string', 'null'] },
+                                        { type: ['number', 'null'] },
+                                        { type: ['object', 'null'] },
                                     ],
                                 },
                             };
@@ -539,10 +516,10 @@ class OpenapiEndpointRenderer {
                             paramsShape.properties = {
                                 ...paramsShape.properties,
                                 [columnName]: {
-                                    type: 'array',
+                                    type: nullableColumn ? ['array', 'null'] : 'array',
                                     items: {
                                         type: 'string',
-                                        enum: [...columnMetadata.enumValues, ...(columnMetadata.allowNull ? ['null'] : [])],
+                                        enum: [...columnMetadata.enumValues],
                                     },
                                 },
                             };
@@ -551,17 +528,13 @@ class OpenapiEndpointRenderer {
                             paramsShape.properties = {
                                 ...paramsShape.properties,
                                 [columnName]: {
-                                    type: 'string',
-                                    enum: [...columnMetadata.enumValues, ...(columnMetadata.allowNull ? ['null'] : [])],
+                                    type: nullableColumn ? ['string', 'null'] : 'string',
+                                    enum: [...columnMetadata.enumValues],
                                 },
                             };
                         }
                     }
             }
-            if (columnMetadata?.allowNull && paramsShape.properties[columnName]) {
-                ;
-                paramsShape.properties[columnName].nullable = true;
-            }
         }
         return {
             content: {
@@ -668,16 +641,6 @@ class OpenapiEndpointRenderer {
         }
         return this.parseSingleEntitySerializerResponseShape();
     }
-    accountForNullableOption(bodySegment, nullable) {
-        if (nullable) {
-            return {
-                allOf: [bodySegment, { nullable: true }],
-            };
-        }
-        else {
-            return bodySegment;
-        }
-    }
     /**
      * @internal
      *
@@ -694,16 +657,15 @@ class OpenapiEndpointRenderer {
         if (serializerClass === undefined)
             throw new Error('getSerializerClasses returned no serializer classes');
         const serializerKey = serializerClass.openapiName;
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        const serializerObject = this.accountForNullableOption({
-            $ref: `#/components/schemas/${serializerKey}`,
-        }, this.nullable || false);
+        const serializerObject = { $ref: `#/components/schemas/${serializerKey}` };
         const baseSchema = this.many
             ? {
                 type: 'array',
                 items: serializerObject,
             }
-            : serializerObject;
+            : this.defaultResponse?.maybeNull
+                ? { anyOf: [serializerObject, { type: 'null' }] }
+                : serializerObject;
         const finalOutput = {
             content: {
                 'application/json': {

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

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = primitiveOpenapiStatementToOpenapi;
+exports.maybeNullPrimitiveToPrimitive = maybeNullPrimitiveToPrimitive;
+exports.booleanNullFromMaybeNullPrimitive = booleanNullFromMaybeNullPrimitive;
+/**
+ * @internal
+ *
+ * parses a primitive stored type
+ */
+function primitiveOpenapiStatementToOpenapi(data, maybeNull = false) {
+    if (!data)
+        return { type: ['object', 'null'] };
+    const primitiveString = maybeNullPrimitiveToPrimitive(data);
+    maybeNull = maybeNull || booleanNullFromMaybeNullPrimitive(data);
+    switch (primitiveString) {
+        case 'string':
+        case 'number':
+        case 'boolean':
+        case 'integer':
+            return {
+                type: maybeNull ? [primitiveString, 'null'] : primitiveString,
+            };
+        case 'decimal':
+        case 'double':
+            return {
+                type: maybeNull ? ['number', 'null'] : 'number',
+                format: primitiveString,
+            };
+        case 'date':
+        case 'date-time':
+            return {
+                type: maybeNull ? ['string', 'null'] : 'string',
+                format: primitiveString,
+            };
+        case 'string[]':
+        case 'number[]':
+        case 'boolean[]':
+        case 'integer[]':
+            return {
+                type: maybeNull ? ['array', 'null'] : 'array',
+                items: {
+                    type: primitiveTypeToOpenapiType(primitiveString),
+                },
+            };
+        case 'decimal[]':
+        case 'double[]':
+            return {
+                type: maybeNull ? ['array', 'null'] : 'array',
+                items: {
+                    type: 'number',
+                    format: stripBracketsFromPrimitiveString(primitiveString),
+                },
+            };
+        case 'date[]':
+        case 'date-time[]':
+            return {
+                type: maybeNull ? ['array', 'null'] : 'array',
+                items: {
+                    type: 'string',
+                    format: stripBracketsFromPrimitiveString(primitiveString),
+                },
+            };
+        case 'null':
+            return {
+                type: 'null',
+            };
+        default:
+            throw new Error(`Unrecognized primitive type ${primitiveString}`);
+    }
+}
+function maybeNullPrimitiveToPrimitive(openapiType) {
+    if (Array.isArray(openapiType)) {
+        if (openapiType[1] === 'null')
+            return openapiType[0];
+        if (openapiType[0] === 'null')
+            return openapiType[1];
+        throw new Error(`Expected array with 'null' and an OpenAPI primitive string: ${JSON.stringify(openapiType)}`);
+    }
+    else {
+        return openapiType;
+    }
+}
+function booleanNullFromMaybeNullPrimitive(openapiType) {
+    if (Array.isArray(openapiType)) {
+        if (openapiType[1] === 'null')
+            return true;
+        if (openapiType[0] === 'null')
+            return true;
+        throw new Error(`Expected array with 'null' and an OpenAPI primitive string: ${JSON.stringify(openapiType)}`);
+    }
+    else {
+        return false;
+    }
+}
+/**
+ * @internal
+ *
+ * removes array brackets from primitive openapi type before putting in
+ * openapi type fields
+ */
+function primitiveTypeToOpenapiType(type) {
+    switch (type) {
+        case 'date':
+        case 'date-time':
+        case 'date[]':
+        case 'date-time[]':
+            return 'string';
+        default:
+            return stripBracketsFromPrimitiveString(type);
+    }
+}
+/**
+ * @internal
+ *
+ * removes array brackets from primitive openapi format types before putting in
+ * openapi type fields
+ */
+function stripBracketsFromPrimitiveString(type) {
+    return type.replace(/\[\]$/, '');
+}