@rvoh/psychic 0.37.6 → 0.37.8

package/dist/cjs/src/server/helpers/paramNamesForDreamClass.js

@@ -8,8 +8,13 @@ function paramNamesForDreamClass(dreamClass, { only, including } = {}) {
     if (Array.isArray(including)) {
         paramSafeColumns = [
             ...paramSafeColumns,
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
-            ...[...dreamClass.columns()].filter(columnName => including.includes(columnName)),
+            // TODO: add a method to dream which can extrapolate
+            // all of these fields from the model
+            ...[
+                ...dreamClass.columns(),
+                ...dreamClass['virtualAttributes'].map(statement => statement.property),
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+            ].filter(columnName => including.includes(columnName)),
         ];
     }
     return paramSafeColumns;

package/dist/esm/src/server/helpers/paramNamesForDreamClass.js

@@ -5,8 +5,13 @@ export default function paramNamesForDreamClass(dreamClass, { only, including }
     if (Array.isArray(including)) {
         paramSafeColumns = [
             ...paramSafeColumns,
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
-            ...[...dreamClass.columns()].filter(columnName => including.includes(columnName)),
+            // TODO: add a method to dream which can extrapolate
+            // all of these fields from the model
+            ...[
+                ...dreamClass.columns(),
+                ...dreamClass['virtualAttributes'].map(statement => statement.property),
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+            ].filter(columnName => including.includes(columnName)),
         ];
     }
     return paramSafeColumns;

package/dist/types/src/controller/index.d.ts

@@ -1,10 +1,10 @@
-import { Dream, DreamAttributes, DreamModelSerializerType, DreamParamSafeAttributes, SerializerRendererOpts, SimpleObjectSerializerType } from '@rvoh/dream';
+import { Dream, DreamModelSerializerType, DreamParamSafeAttributes, SerializerRendererOpts, SimpleObjectSerializerType, UpdateableProperties, DreamParamSafeColumnNames } from '@rvoh/dream';
 import { Request, Response } from 'express';
 import { ControllerHook } from '../controller/hooks.js';
 import { HttpStatusCodeInt, HttpStatusSymbol } from '../error/http/status-codes.js';
 import OpenapiEndpointRenderer from '../openapi-renderer/endpoint.js';
 import PsychicApp from '../psychic-app/index.js';
-import { ParamsCastOptions, ParamsForDreamClass, ParamsForOpts, ValidatedAllowsNull, ValidatedReturnType } from '../server/params.js';
+import { ParamsCastOptions, ParamsForOpts, ValidatedAllowsNull, ValidatedReturnType } from '../server/params.js';
 import Session, { CustomSessionCookieOptions } from '../session/index.js';
 type SerializerResult = {
     [key: string]: any;
@@ -129,11 +129,15 @@ export default class PsychicController {
     param<ReturnType = string>(key: string): ReturnType;
     castParam<const EnumType extends readonly string[], OptsType extends ParamsCastOptions<EnumType>, ExpectedType extends (typeof PsychicParamsPrimitiveLiterals)[number] | RegExp>(key: string, expectedType: ExpectedType, opts?: OptsType): ValidatedAllowsNull<ExpectedType, OptsType> extends infer T ? T extends ValidatedAllowsNull<ExpectedType, OptsType> ? T extends true ? ValidatedReturnType<ExpectedType, OptsType> | null | undefined : ValidatedReturnType<ExpectedType, OptsType> : never : never;
     private _castParam;
-    paramsFor<T extends typeof Dream, I extends InstanceType<T>, const OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], const IncludingArray extends Exclude<keyof DreamAttributes<I>, OnlyArray[number]>[], ReturnPayload = ParamsForDreamClass<T, OnlyArray, IncludingArray>, ForOpts extends ParamsForOpts<OnlyArray, IncludingArray> & {
+    paramsFor<T extends typeof Dream, I extends InstanceType<T>, const OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], const IncludingArray extends Exclude<keyof UpdateableProperties<I>, OnlyArray[number]>[], ForOpts extends ParamsForOpts<OnlyArray, IncludingArray> & {
         key?: string;
-    } = ParamsForOpts<OnlyArray, IncludingArray> & {
-        key?: string;
-    }>(this: PsychicController, dreamClass: T, opts?: ForOpts): ReturnPayload;
+    }, ParamSafeColumnsOverride extends I['paramSafeColumns' & keyof I] extends never ? undefined : I['paramSafeColumns' & keyof I] & string[], ParamSafeColumns extends ParamSafeColumnsOverride extends string[] | Readonly<string[]> ? Extract<DreamParamSafeColumnNames<I>, ParamSafeColumnsOverride[number] & DreamParamSafeColumnNames<I>>[] : DreamParamSafeColumnNames<I>[], ParamSafeAttrs extends DreamParamSafeAttributes<InstanceType<T>>, ReturnPartialType extends ForOpts['only'] extends readonly (keyof DreamParamSafeAttributes<InstanceType<T>>)[] ? Partial<{
+        [K in ForOpts['only'][number] & keyof ParamSafeAttrs]: ParamSafeAttrs[K & keyof ParamSafeAttrs];
+    }> : Partial<{
+        [K in ParamSafeColumns[number & keyof ParamSafeColumns] & string]: DreamParamSafeAttributes<InstanceType<T>>[K & keyof DreamParamSafeAttributes<InstanceType<T>>];
+    }>, ReturnPartialTypeWithIncluding extends ForOpts['including'] extends readonly (keyof UpdateableProperties<InstanceType<T>>)[] ? ReturnPartialType & Partial<{
+        [K in Extract<keyof UpdateableProperties<InstanceType<T>>, ForOpts['including'][number & keyof ForOpts['including']]>]: UpdateableProperties<InstanceType<T>>[K];
+    }> : ReturnPartialType, ReturnPayload extends ForOpts['array'] extends true ? ReturnPartialTypeWithIncluding[] : ReturnPartialTypeWithIncluding>(this: PsychicController, dreamClass: T, opts?: ForOpts): ReturnPayload;
     getCookie<RetType>(name: string): RetType | null;
     setCookie(name: string, data: string, opts?: CustomSessionCookieOptions): void;
     startSession(user: Dream): void;

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

@@ -1,4 +1,4 @@
-import { Dream, DreamAttributes, DreamOrViewModelClassSerializerKey, DreamParamSafeAttributes, DreamSerializable, DreamSerializableArray, OpenapiAllTypes, OpenapiFormats, OpenapiSchemaArray, OpenapiSchemaBody, OpenapiSchemaBodyShorthand, OpenapiSchemaExpressionAllOf, OpenapiSchemaExpressionAnyOf, OpenapiSchemaExpressionOneOf, OpenapiSchemaExpressionRef, OpenapiSchemaObject, OpenapiSchemaProperties, SerializerCasing, ViewModelClass } from '@rvoh/dream';
+import { Dream, DreamAttributes, DreamOrViewModelClassSerializerKey, DreamParamSafeAttributes, DreamSerializable, DreamSerializableArray, OpenapiAllTypes, OpenapiFormats, OpenapiSchemaArray, OpenapiSchemaBody, OpenapiSchemaBodyShorthand, OpenapiSchemaExpressionAllOf, OpenapiSchemaExpressionAnyOf, OpenapiSchemaExpressionOneOf, OpenapiSchemaExpressionRef, OpenapiSchemaObject, OpenapiSchemaProperties, SerializerCasing, UpdateableProperties, 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';
@@ -608,7 +608,7 @@ export interface OpenapiSchemaRequestBodyForDreamClass<ForOption extends typeof
      * }
      * ```
      */
-    including?: Exclude<keyof DreamAttributes<InstanceType<ForOption>>, keyof DreamParamSafeAttributes<InstanceType<ForOption>>>[];
+    including?: Exclude<keyof UpdateableProperties<InstanceType<ForOption>>, keyof DreamParamSafeAttributes<InstanceType<ForOption>>>[];
     /**
      * Specify which fields are required for your openapi
      * request body.
@@ -633,7 +633,7 @@ export interface OpenapiSchemaRequestBodyForDreamClass<ForOption extends typeof
      * }
      * ```
      */
-    required?: (keyof DreamAttributes<InstanceType<ForOption>>)[];
+    required?: (keyof UpdateableProperties<InstanceType<ForOption>>)[];
 }
 export interface OpenapiSchemaRequestBodyForBaseDreamClass<Serializable extends DreamSerializable | DreamSerializableArray | undefined, T extends Serializable extends typeof Dream ? Serializable : undefined = Serializable extends typeof Dream ? Serializable : undefined, I extends T extends typeof Dream ? InstanceType<T> : undefined = T extends typeof Dream ? InstanceType<T> : undefined, Only extends I extends Dream ? readonly (keyof DreamParamSafeAttributes<I>)[] : string[] = I extends Dream ? readonly (keyof DreamParamSafeAttributes<I>)[] : string[], Including extends I extends Dream ? Exclude<keyof DreamAttributes<I>, keyof DreamParamSafeAttributes<I>>[] : string[] = I extends Dream ? Exclude<keyof DreamAttributes<I>, keyof DreamParamSafeAttributes<I>>[] : string[], RequiredFields extends I extends Dream ? readonly (keyof DreamAttributes<I>)[] : string[] = I extends Dream ? readonly (keyof DreamAttributes<I>)[] : string[]> {
     for?: never;

package/dist/types/src/server/helpers/paramNamesForDreamClass.d.ts

@@ -1,9 +1,11 @@
-import { Dream, DreamAttributes, DreamParamSafeAttributes, DreamParamSafeColumnNames } from '@rvoh/dream';
-import { ParamExclusionOptions } from '../params.js';
-export default function paramNamesForDreamClass<T extends typeof Dream, I extends InstanceType<T>, const OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], const IncludingArray extends Exclude<keyof DreamAttributes<I>, OnlyArray[number]>[], ForOpts extends ParamExclusionOptions<OnlyArray, IncludingArray>, ParamSafeColumnsOverride extends I['paramSafeColumns' & keyof I] extends never ? undefined : I['paramSafeColumns' & keyof I] & string[], ParamSafeColumns extends ParamSafeColumnsOverride extends string[] | Readonly<string[]> ? Extract<DreamParamSafeColumnNames<I>, ParamSafeColumnsOverride[number] & DreamParamSafeColumnNames<I>>[] : DreamParamSafeColumnNames<I>[], ReturnPartialWithOnly extends ForOpts['only'] extends readonly (keyof DreamParamSafeAttributes<InstanceType<T>>)[] ? Partial<{
-    [K in Extract<ParamSafeColumns[number], ForOpts['only'][number & keyof ForOpts['only']]>]: DreamParamSafeAttributes<InstanceType<T>>[K];
+import { Dream, DreamParamSafeAttributes, DreamParamSafeColumnNames, UpdateableProperties } from '@rvoh/dream';
+import { ParamsForOpts } from '../params.js';
+export default function paramNamesForDreamClass<T extends typeof Dream, I extends InstanceType<T>, const OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], const IncludingArray extends Exclude<keyof UpdateableProperties<I>, OnlyArray[number]>[], ForOpts extends ParamsForOpts<OnlyArray, IncludingArray> & {
+    key?: string;
+}, ParamSafeColumnsOverride extends I['paramSafeColumns' & keyof I] extends never ? undefined : I['paramSafeColumns' & keyof I] & string[], ParamSafeColumns extends ParamSafeColumnsOverride extends string[] | Readonly<string[]> ? Extract<DreamParamSafeColumnNames<I>, ParamSafeColumnsOverride[number] & DreamParamSafeColumnNames<I>>[] : DreamParamSafeColumnNames<I>[], ParamSafeAttrs extends DreamParamSafeAttributes<InstanceType<T>>, ReturnPartialType extends ForOpts['only'] extends readonly (keyof DreamParamSafeAttributes<InstanceType<T>>)[] ? Partial<{
+    [K in ForOpts['only'][number] & keyof ParamSafeAttrs]: ParamSafeAttrs[K & keyof ParamSafeAttrs];
 }> : Partial<{
     [K in ParamSafeColumns[number & keyof ParamSafeColumns] & string]: DreamParamSafeAttributes<InstanceType<T>>[K & keyof DreamParamSafeAttributes<InstanceType<T>>];
-}>, ReturnPartialWithIncluding extends ForOpts['including'] extends readonly (keyof DreamAttributes<InstanceType<T>>)[] ? ReturnPartialWithOnly & Partial<{
-    [K in Extract<keyof DreamAttributes<InstanceType<T>>, ForOpts['including'][number & keyof ForOpts['including']]>]: DreamAttributes<InstanceType<T>>[K];
-}> : ReturnPartialWithOnly, RetArray = (keyof ReturnPartialWithIncluding)[]>(dreamClass: T, { only, including }?: ForOpts): RetArray;
+}>, ReturnPartialTypeWithIncluding extends ForOpts['including'] extends readonly (keyof UpdateableProperties<InstanceType<T>>)[] ? ReturnPartialType & Partial<{
+    [K in Extract<keyof UpdateableProperties<InstanceType<T>>, ForOpts['including'][number & keyof ForOpts['including']]>]: UpdateableProperties<InstanceType<T>>[K];
+}> : ReturnPartialType, RetArray = (keyof ReturnPartialTypeWithIncluding)[]>(dreamClass: T, { only, including }?: ForOpts): RetArray;

package/dist/types/src/server/params.d.ts

@@ -1,4 +1,4 @@
-import { CalendarDate, DateTime, Dream, DreamAttributes, DreamParamSafeAttributes, DreamParamSafeColumnNames } from '@rvoh/dream';
+import { CalendarDate, DateTime, Dream, DreamAttributes, DreamParamSafeAttributes, DreamParamSafeColumnNames, UpdateableProperties } from '@rvoh/dream';
 import { PsychicParamsDictionary, PsychicParamsPrimitive, PsychicParamsPrimitiveLiterals } from '../controller/index.js';
 export default class Params {
     private $params;
@@ -16,7 +16,13 @@ export default class Params {
      * const params = Params.for(this.params.user, User)
      * ```
      */
-    static for<T extends typeof Dream, I extends InstanceType<T>, const OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], const IncludingArray extends Exclude<keyof DreamAttributes<I>, OnlyArray[number]>[], ForOpts extends ParamsForOpts<OnlyArray, IncludingArray>, ReturnPayload extends ParamsForDreamClass<T, OnlyArray, IncludingArray, I>>(params: object, dreamClass: T, forOpts?: ForOpts): ReturnPayload;
+    static for<T extends typeof Dream, I extends InstanceType<T>, const OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], const IncludingArray extends Exclude<keyof DreamAttributes<I>, OnlyArray[number]>[], ForOpts extends ParamsForOpts<OnlyArray, IncludingArray>, ParamSafeColumnsOverride extends I['paramSafeColumns' & keyof I] extends never ? undefined : I['paramSafeColumns' & keyof I] & string[], ParamSafeColumns extends ParamSafeColumnsOverride extends string[] | Readonly<string[]> ? Extract<DreamParamSafeColumnNames<I>, ParamSafeColumnsOverride[number] & DreamParamSafeColumnNames<I>>[] : DreamParamSafeColumnNames<I>[], ParamSafeAttrs extends DreamParamSafeAttributes<InstanceType<T>>, ReturnPartialType extends ForOpts['only'] extends readonly (keyof DreamParamSafeAttributes<InstanceType<T>>)[] ? Partial<{
+        [K in ForOpts['only'][number] & keyof ParamSafeAttrs]: ParamSafeAttrs[K & keyof ParamSafeAttrs];
+    }> : Partial<{
+        [K in ParamSafeColumns[number & keyof ParamSafeColumns] & string & keyof ParamSafeAttrs]: ParamSafeAttrs[K & keyof ParamSafeAttrs];
+    }>, ReturnPartialTypeWithIncluding extends ForOpts['including'] extends readonly (keyof UpdateableProperties<InstanceType<T>>)[] ? ReturnPartialType & Partial<{
+        [K in Extract<keyof UpdateableProperties<InstanceType<T>>, ForOpts['including'][number & keyof ForOpts['including']]>]: UpdateableProperties<InstanceType<T>>[K];
+    }> : ReturnPartialType, ReturnPayload extends ForOpts['array'] extends true ? ReturnPartialTypeWithIncluding[] : ReturnPartialTypeWithIncluding>(params: object, dreamClass: T, forOpts?: ForOpts): ReturnPayload;
     static restrict<T extends typeof Params>(this: T, params: PsychicParamsPrimitive | PsychicParamsDictionary | PsychicParamsDictionary[], allowed: string[]): PsychicParamsDictionary;
     /**
      * ### .cast
@@ -74,16 +80,3 @@ export interface ParamExclusionOptions<OnlyArray, IncludingArray> {
     only?: OnlyArray;
     including?: IncludingArray;
 }
-export type ParamsForDreamClass<T extends typeof Dream, OnlyArray extends readonly (keyof DreamParamSafeAttributes<I>)[], IncludingArray extends Exclude<keyof DreamAttributes<I>, OnlyArray[number]>[], I extends InstanceType<T> = InstanceType<T>, ForOpts extends ParamsForOpts<OnlyArray, IncludingArray> = ParamsForOpts<OnlyArray, IncludingArray>, ParamSafeColumnsOverride extends I['paramSafeColumns' & keyof I] extends never ? undefined : I['paramSafeColumns' & keyof I] & string[] = I['paramSafeColumns' & keyof I] extends never ? undefined : I['paramSafeColumns' & keyof I] & string[], ParamSafeColumns extends ParamSafeColumnsOverride extends string[] | Readonly<string[]> ? Extract<DreamParamSafeColumnNames<I>, ParamSafeColumnsOverride[number] & DreamParamSafeColumnNames<I>>[] : DreamParamSafeColumnNames<I>[] = ParamSafeColumnsOverride extends string[] | Readonly<string[]> ? Extract<DreamParamSafeColumnNames<I>, ParamSafeColumnsOverride[number] & DreamParamSafeColumnNames<I>>[] : DreamParamSafeColumnNames<I>[], ReturnPartialType extends ForOpts['only'] extends readonly (keyof DreamParamSafeAttributes<InstanceType<T>>)[] ? Partial<{
-    [K in Extract<ParamSafeColumns[number], ForOpts['only'][number & keyof ForOpts['only']]>]: DreamParamSafeAttributes<InstanceType<T>>[K];
-}> : Partial<{
-    [K in ParamSafeColumns[number & keyof ParamSafeColumns] & string]: DreamParamSafeAttributes<InstanceType<T>>[K & keyof DreamParamSafeAttributes<InstanceType<T>>];
-}> = ForOpts['only'] extends readonly (keyof DreamParamSafeAttributes<InstanceType<T>>)[] ? Partial<{
-    [K in Extract<ParamSafeColumns[number], ForOpts['only'][number & keyof ForOpts['only']]>]: DreamParamSafeAttributes<InstanceType<T>>[K];
-}> : Partial<{
-    [K in ParamSafeColumns[number & keyof ParamSafeColumns] & string]: DreamParamSafeAttributes<InstanceType<T>>[K & keyof DreamParamSafeAttributes<InstanceType<T>>];
-}>, ReturnPartialTypeWithIncluding extends ForOpts['including'] extends readonly (keyof DreamAttributes<InstanceType<T>>)[] ? ReturnPartialType & Partial<{
-    [K in Extract<keyof DreamAttributes<InstanceType<T>>, ForOpts['including'][number & keyof ForOpts['including']]>]: DreamAttributes<InstanceType<T>>[K];
-}> : ReturnPartialType = ForOpts['including'] extends readonly (keyof DreamAttributes<InstanceType<T>>)[] ? ReturnPartialType & Partial<{
-    [K in Extract<keyof DreamAttributes<InstanceType<T>>, ForOpts['including'][number & keyof ForOpts['including']]>]: DreamAttributes<InstanceType<T>>[K];
-}> : ReturnPartialType, ReturnPayload extends ForOpts['array'] extends true ? ReturnPartialTypeWithIncluding[] : ReturnPartialTypeWithIncluding = ForOpts['array'] extends true ? ReturnPartialTypeWithIncluding[] : ReturnPartialTypeWithIncluding> = ReturnPayload;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "0.37.6",
+  "version": "0.37.8",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -31,6 +31,7 @@
     "gpsy": "tsx ./global-cli/main.ts",
     "build": "echo \"building cjs...\" && rm -rf dist && npx tsc -p ./tsconfig.cjs.build.json && echo \"building esm...\" && npx tsc -p ./tsconfig.esm.build.json",
     "build:test-app": "rm -rf dist && echo \"building test app to esm...\" && npx tsc -p ./tsconfig.esm.build.test-app.json && echo \"building test app to cjs...\" && npx tsc -p ./tsconfig.cjs.build.test-app.json",
+    "types:esm:trace": "rm -rf dist && npx tsc -p ./tsconfig.esm.build.json --generateTrace ./typetrace --diagnostics && yarn analyze-trace ./typetrace --skipMillis 100 --forceMillis 300",
     "dev": "NODE_ENV=development tsx ./test-app/main.ts",
     "console": "tsx ./test-app/src/conf/repl.ts",
     "uspec": "vitest --config ./spec/unit/vite.config.ts",
@@ -58,13 +59,14 @@
   "devDependencies": {
     "@eslint/js": "^9.19.0",
     "@jest-mock/express": "^3.0.0",
-    "@rvoh/dream": "^0.43.0-beta.10",
+    "@rvoh/dream": "^0.44.5",
     "@rvoh/dream-spec-helpers": "^0.2.4",
     "@rvoh/psychic-spec-helpers": "^0.6.0",
     "@types/express": "^5.0.1",
     "@types/node": "^22.5.1",
     "@types/pg": "^8.11.8",
     "@types/supertest": "^6.0.3",
+    "@typescript/analyze-trace": "^0.10.1",
     "eslint": "^9.19.0",
     "express": "^5.1.0",
     "jsdom": "^26.0.0",
@@ -85,4 +87,4 @@
     "winston": "^3.14.2"
   },
   "packageManager": "yarn@4.7.0"
-}
+}