@rvoh/psychic 0.37.0-beta.3 → 0.37.0-beta.5

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

@@ -0,0 +1,102 @@
+import isObject from '../../helpers/isObject.js';
+import isOpenapiShorthand from './isOpenapiShorthand.js';
+import maybeNullOpenapiShorthandToOpenapiShorthand from './maybeNullOpenapiShorthandToOpenapiShorthand.js';
+export default function openapiShorthandToOpenapi(openapi, options = {}) {
+    if (isOpenapiShorthand(openapi)) {
+        return _openapiShorthandToOpenapi(openapi, options);
+    }
+    else if (isObject(openapi)) {
+        return openapi;
+    }
+    else {
+        throw new UnrecognizedOpenapiShape(openapi);
+    }
+}
+function _openapiShorthandToOpenapi(shorthand, options) {
+    const shorthandString = maybeNullOpenapiShorthandToOpenapiShorthand(shorthand);
+    if (!shorthandString)
+        return { type: 'null' };
+    const openapi = simpleOpenapiShorthandToOpenapi(shorthandString);
+    if (options.maybeNull || openapiShorthandIncludesNull(shorthand))
+        return { ...openapi, type: [openapi.type, 'null'] };
+    return openapi;
+}
+function simpleOpenapiShorthandToOpenapi(shorthand) {
+    switch (shorthand) {
+        case 'string':
+            return { type: 'string' };
+        case 'boolean':
+            return { type: 'boolean' };
+        case 'number':
+            return { type: 'number' };
+        case 'date':
+            return { type: 'string', format: 'date' };
+        case 'date-time':
+            return { type: 'string', format: 'date-time' };
+        case 'decimal':
+            return { type: 'number', format: 'decimal' };
+        case 'integer':
+            return { type: 'integer' };
+        case 'null':
+            return { type: 'null' };
+        case 'string[]':
+            return { type: 'array', items: { type: 'string' } };
+        case 'boolean[]':
+            return { type: 'array', items: { type: 'boolean' } };
+        case 'number[]':
+            return { type: 'array', items: { type: 'number' } };
+        case 'date[]':
+            return { type: 'array', items: { type: 'string', format: 'date' } };
+        case 'date-time[]':
+            return { type: 'array', items: { type: 'string', format: 'date-time' } };
+        case 'decimal[]':
+            return { type: 'array', items: { type: 'number', format: 'decimal' } };
+        case 'integer[]':
+            return { type: 'array', items: { type: 'integer' } };
+        case 'json':
+            return { type: 'json' };
+        default: {
+            // protection so that if a new OpenapiShorthandPrimitiveBaseTypes is ever added, this will throw a type error at build time
+            const _never = shorthand;
+            throw new UnrecognizedOpenapiShorthand(_never);
+        }
+    }
+}
+function openapiShorthandIncludesNull(openapi) {
+    if (openapi === undefined)
+        return false;
+    if (typeof openapi === 'string')
+        return false;
+    if (!Array.isArray(openapi))
+        return false;
+    if (openapi.length !== 2)
+        return false;
+    if (openapi[1] === 'null')
+        return true;
+    if (openapi[0] === 'null')
+        return true;
+    return false;
+}
+export class UnrecognizedOpenapiShorthand extends Error {
+    shorthand;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    constructor(shorthand) {
+        super();
+        this.shorthand = shorthand;
+    }
+    get message() {
+        return `Unrecognized OpenAPI shorthand: ${JSON.stringify(this.shorthand)}`;
+    }
+}
+export class UnrecognizedOpenapiShape extends Error {
+    openapi;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    constructor(openapi) {
+        super();
+        this.openapi = openapi;
+    }
+    get message() {
+        return `Unrecognized OpenAPI shape:
+${JSON.stringify(this.openapi)}`;
+    }
+}

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

@@ -1,4 +1,4 @@
-import { openapiShorthandToOpenapi, } from '@rvoh/dream';
+import openapiShorthandToOpenapi from './openapiShorthandToOpenapi.js';
 /**
  * @internal
  *

package/dist/esm/src/server/params.js

@@ -1,10 +1,10 @@
 import { CalendarDate, camelize, compact, DateTime, snakeify, } from '@rvoh/dream';
 import ParamValidationError from '../error/controller/ParamValidationError.js';
 import ParamValidationErrors from '../error/controller/ParamValidationErrors.js';
-import isUuid from '../helpers/isUuid.js';
-import { isObject } from '../helpers/typechecks.js';
-import isArrayParamName from '../helpers/isArrayParamName.js';
 import alternateParamName from '../helpers/alternateParamName.js';
+import isArrayParamName from '../helpers/isArrayParamName.js';
+import isObject from '../helpers/isObject.js';
+import isUuid from '../helpers/isUuid.js';
 export default class Params {
     $params;
     /**

package/dist/types/src/error/openapi/AttemptedToDeriveDescendentSerializersFromNonSerializer.d.ts

@@ -0,0 +1,5 @@
+export default class AttemptedToDeriveDescendentSerializersFromNonSerializer extends Error {
+    private serializer;
+    constructor(serializer: any);
+    get message(): string;
+}

package/dist/types/src/error/openapi/ExpectedSerializerForRendersOneOrManyOption.d.ts

@@ -0,0 +1,8 @@
+import { InternalAnyTypedSerializerRendersMany, InternalAnyTypedSerializerRendersOne } from '@rvoh/dream';
+export default class ExpectedSerializerForRendersOneOrManyOption extends Error {
+    private rendersOneOrMany;
+    private referencingSerializerName;
+    private attribute;
+    constructor(rendersOneOrMany: 'rendersOne' | 'rendersMany', referencingSerializerName: string, attribute: InternalAnyTypedSerializerRendersOne<any, string> | InternalAnyTypedSerializerRendersMany<any, string>);
+    get message(): string;
+}

package/dist/types/src/error/openapi/NoSerializerFoundForRendersOneAndMany.d.ts

@@ -0,0 +1,5 @@
+export default class NoSerializerFoundForRendersOneAndMany extends Error {
+    private associationName;
+    constructor(associationName: string);
+    get message(): string;
+}

package/dist/types/src/error/openapi/NonSerializerPassedToSerializerOpenapiRenderer.d.ts

@@ -0,0 +1,5 @@
+export default class NonSerializerPassedToSerializerOpenapiRenderer extends Error {
+    private serializer;
+    constructor(serializer: any);
+    get message(): string;
+}

package/dist/types/src/error/openapi/NonSerializerSerializerOverrideProvided.d.ts

@@ -0,0 +1,6 @@
+export default class NonSerializerSerializerOverrideProvided extends Error {
+    private rendersAssociation;
+    private serializer;
+    constructor(rendersAssociation: any, serializer: any);
+    get message(): string;
+}

package/dist/types/src/error/openapi/ObjectSerializerRendersOneAndManyRequireClassType.d.ts

@@ -0,0 +1,5 @@
+export default class ObjectSerializerRendersOneAndManyRequireClassType extends Error {
+    private associationName;
+    constructor(associationName: string);
+    get message(): string;
+}

package/dist/types/src/helpers/isObject.d.ts

@@ -0,0 +1 @@
+export default function isObject(x: any): boolean;

package/dist/types/src/helpers/typeHelpers.d.ts

@@ -1,5 +1,7 @@
+import { Dream, DreamOrViewModelClassSerializerKey, DreamSerializableArray, ViewModelClass } from '@rvoh/dream';
 export type FunctionProperties<T> = {
     [K in keyof T as T[K] extends (...args: any[]) => any ? K : never]: T[K];
 };
 export type FunctionPropertyNames<T> = keyof FunctionProperties<T> & string;
 export type StringToInt<T extends string> = T extends `${infer N extends number}` ? N : never;
+export type DreamOrViewModelClassSerializerArrayKeys<T extends DreamSerializableArray> = T['length'] extends 0 ? string : T[0] extends typeof Dream | ViewModelClass ? DreamOrViewModelClassSerializerKey<T[0]> & DreamOrViewModelClassSerializerArrayKeys<T extends [any, ...infer Rest] ? Rest : never> : DreamOrViewModelClassSerializerArrayKeys<T extends [any, ...infer Rest] ? Rest : never>;

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

@@ -0,0 +1,25 @@
+import { DreamModelSerializerType, OpenapiSchemaBodyShorthand, OpenapiSchemaExpressionRef, SerializerCasing, SimpleObjectSerializerType } from '@rvoh/dream';
+export default class SerializerOpenapiRenderer {
+    private serializer;
+    private casing;
+    private suppressResponseEnums;
+    private allOfSiblings;
+    constructor(serializer: DreamModelSerializerType | SimpleObjectSerializerType, { casing, suppressResponseEnums, }?: {
+        casing?: SerializerCasing;
+        suppressResponseEnums?: boolean;
+    });
+    get globalName(): string;
+    get openapiName(): string;
+    get serializerRef(): OpenapiSchemaExpressionRef;
+    private _serializerBuilder;
+    private get serializerBuilder();
+    renderedOpenapi(alreadyExtractedDescendantSerializers?: Record<string, boolean>): ReferencedSerializersAndOpenapiSchemaBodyShorthand;
+    private _renderedOpenapi;
+    private renderedOpenapiAttributes;
+    private setCase;
+}
+interface ReferencedSerializersAndOpenapiSchemaBodyShorthand {
+    referencedSerializers: (DreamModelSerializerType | SimpleObjectSerializerType)[];
+    openapi: OpenapiSchemaBodyShorthand;
+}
+export {};

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

@@ -1,6 +1,7 @@
-import { Dream, DreamOrViewModelClassSerializerArrayKeys, DreamOrViewModelClassSerializerKey, DreamSerializable, DreamSerializableArray, OpenapiAllTypes, OpenapiFormats, OpenapiSchemaArray, OpenapiSchemaBody, OpenapiSchemaBodyShorthand, OpenapiSchemaExpressionAllOf, OpenapiSchemaExpressionAnyOf, OpenapiSchemaExpressionOneOf, OpenapiSchemaExpressionRef, OpenapiSchemaObject, OpenapiSchemaProperties, SerializerCasing, ViewModelClass } from '@rvoh/dream';
+import { Dream, DreamOrViewModelClassSerializerKey, DreamSerializable, DreamSerializableArray, OpenapiAllTypes, OpenapiFormats, OpenapiSchemaArray, OpenapiSchemaBody, OpenapiSchemaBodyShorthand, OpenapiSchemaExpressionAllOf, OpenapiSchemaExpressionAnyOf, OpenapiSchemaExpressionOneOf, OpenapiSchemaExpressionRef, OpenapiSchemaObject, OpenapiSchemaProperties, SerializerCasing, ViewModelClass } from '@rvoh/dream';
 import PsychicController from '../controller/index.js';
 import { HttpStatusCode, HttpStatusCodeNumber } from '../error/http/status-codes.js';
+import { DreamOrViewModelClassSerializerArrayKeys } from '../helpers/typeHelpers.js';
 import { RouteConfig } from '../router/route-manager.js';
 import { HttpMethod } from '../router/types.js';
 import { OpenapiBodySegment, ReferencedSerializersAndOpenapiEndpointResponse, SerializerArray } from './body-segment.js';

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

@@ -0,0 +1,2 @@
+import { DreamModelSerializerType, OpenapiSchemaBodyShorthand, OpenapiShorthandPrimitiveTypes, SimpleObjectSerializerType } from '@rvoh/dream';
+export default function allSerializersFromHandWrittenOpenapi(openapi: OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes | undefined): (DreamModelSerializerType | SimpleObjectSerializerType)[];

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

@@ -0,0 +1,2 @@
+import { OpenapiSchemaBodyShorthand, OpenapiShorthandPrimitiveTypes } from '@rvoh/dream';
+export default function allSerializersToRefsInOpenapi(openapi: OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes | undefined): OpenapiSchemaBodyShorthand;