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

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

@@ -0,0 +1,780 @@
+import { Dream, OpenapiDescription, OpenapiSchemaBodyShorthand, OpenapiShorthandPrimitiveTypes } from '@rvoh/dream';
+type DreamClassColumnNames<DreamClass extends typeof Dream, DreamInstance extends InstanceType<DreamClass> = InstanceType<DreamClass>, DB = DreamInstance['DB'], TableName extends keyof DB = DreamInstance['table'] & keyof DB, Table extends DB[keyof DB] = DB[TableName]> = keyof Table & string;
+export declare function dreamColumnOpenapiShape<DreamClass extends typeof Dream>(dreamClass: DreamClass, column: DreamClassColumnNames<DreamClass>, openapi?: OpenapiDescription | OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes | undefined, { suppressResponseEnums }?: {
+    suppressResponseEnums?: boolean;
+}): import("@rvoh/dream").OpenapiSchemaNull | import("@rvoh/dream").OpenapiSchemaExpressionRef | import("@rvoh/dream").OpenapiSchemaPrimitiveGeneric | import("@rvoh/dream").OpenapiSchemaExpressionAnyOf | import("@rvoh/dream").OpenapiSchemaExpressionOneOf | import("@rvoh/dream").OpenapiSchemaExpressionAllOf | import("@rvoh/dream").OpenapiSchemaObjectBase | import("@rvoh/dream").OpenapiSchemaObjectOneOf | import("@rvoh/dream").OpenapiSchemaObjectAnyOf | import("@rvoh/dream").OpenapiSchemaObjectAllOf | import("@rvoh/dream").OpenapiSchemaArray | {
+    type: "string" | ["string", "null"] | ["null", "string"];
+    enum?: (string | null)[] | Readonly<(string | null)[]>;
+    format?: string;
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    type: "integer" | ["integer", "null"] | ["null", "integer"];
+    minimum?: number;
+    maximum?: number;
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    type: "number" | ["number", "null"] | ["null", "number"];
+    format?: import("@rvoh/dream").OpenapiNumberFormats;
+    multipleOf?: number;
+    minimum?: number;
+    maximum?: number;
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    $ref: string;
+    type: string | string[];
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    type: import("@rvoh/dream").OpenapiPrimitiveTypes;
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: string | string[];
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: string | string[];
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: string | string[];
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    minProperties?: number;
+    maxProperties?: number;
+    properties?: import("@rvoh/dream").OpenapiSchemaProperties | import("@rvoh/dream").OpenapiSchemaExpressionOneOf | import("@rvoh/dream").OpenapiSchemaExpressionAnyOf | import("@rvoh/dream").OpenapiSchemaExpressionAllOf;
+    additionalProperties?: import("@rvoh/dream").OpenapiSchemaObject | import("@rvoh/dream").OpenapiSchemaExpressionOneOf | import("@rvoh/dream").OpenapiSchemaExpressionAnyOf | import("@rvoh/dream").OpenapiSchemaExpressionAllOf;
+    type: "object" | ["object", "null"] | ["null", "object"];
+    required?: string[];
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    oneOf?: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "object" | ["object", "null"] | ["null", "object"];
+    required?: string[];
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    anyOf?: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "object" | ["object", "null"] | ["null", "object"];
+    required?: string[];
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    allOf?: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "object" | ["object", "null"] | ["null", "object"];
+    required?: string[];
+    description?: string;
+    summary?: string;
+    items: {
+        readonly type: "string";
+        readonly description: `The following values will be allowed:\n  ${string}`;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly enum: string[];
+        readonly description?: never;
+        format?: never;
+    } | {
+        readonly type: "boolean";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "integer";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "number";
+        readonly format: "decimal";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "number";
+        readonly description?: never;
+        readonly enum?: never;
+        format?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date-time";
+        readonly description?: never;
+        readonly enum?: never;
+    } | {
+        readonly type: "string";
+        readonly format: "date";
+        readonly description?: never;
+        readonly enum?: never;
+    };
+} | {
+    $ref: string;
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description: `The following values will be allowed:\n  ${string}`;
+    enum?: never;
+    format?: never;
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description: `The following values will be allowed:\n  ${string}`;
+    enum?: never;
+    format?: never;
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description: `The following values will be allowed:\n  ${string}`;
+    enum?: never;
+    format?: never;
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description: `The following values will be allowed:\n  ${string}`;
+    enum?: never;
+    format?: never;
+} | {
+    $ref: string;
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    enum: string[];
+    description?: never;
+    format?: never;
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    enum: string[];
+    description?: never;
+    format?: never;
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    enum: string[];
+    description?: never;
+    format?: never;
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    enum: string[];
+    description?: never;
+    format?: never;
+} | {
+    $ref: string;
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description?: never;
+    enum?: never;
+    format?: never;
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description?: never;
+    enum?: never;
+    format?: never;
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description?: never;
+    enum?: never;
+    format?: never;
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    description?: never;
+    enum?: never;
+    format?: never;
+} | {
+    $ref: string;
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "decimal";
+    description?: never;
+    enum?: never;
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "decimal";
+    description?: never;
+    enum?: never;
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "decimal";
+    description?: never;
+    enum?: never;
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "decimal";
+    description?: never;
+    enum?: never;
+} | {
+    $ref: string;
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date-time";
+    description?: never;
+    enum?: never;
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date-time";
+    description?: never;
+    enum?: never;
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date-time";
+    description?: never;
+    enum?: never;
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date-time";
+    description?: never;
+    enum?: never;
+} | {
+    $ref: string;
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date";
+    description?: never;
+    enum?: never;
+} | {
+    anyOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date";
+    description?: never;
+    enum?: never;
+} | {
+    oneOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date";
+    description?: never;
+    enum?: never;
+} | {
+    allOf: import("@rvoh/dream").OpenapiSchemaBody[];
+    type: "string" | "number" | "boolean" | "integer" | string[];
+    format: "date";
+    description?: never;
+    enum?: never;
+};
+export declare class UseCustomOpenapiForVirtualAttributes extends Error {
+    private dreamClass;
+    private field;
+    constructor(dreamClass: typeof Dream, field: string);
+    get message(): string;
+}
+export declare class UseCustomOpenapiForJson extends Error {
+    private dreamClass;
+    private field;
+    constructor(dreamClass: typeof Dream, field: string);
+    get message(): string;
+}
+export {};