@rvoh/psychic 3.8.6 → 3.9.0

package/dist/cjs/src/bin/helpers/OpenApiSpecDiff.js

@@ -189,6 +189,10 @@ export class OpenApiSpecDiff {
     }
     /**
      * Retrieves head branch content for a file
+     *
+     * Marked `protected` so tests can supply a deterministic baseline instead of
+     * the live head branch. Production code never overrides this.
+     *
      * @param absoluteFilePath - Absolute path to the file
      */
     getHeadBranchContent(absoluteFilePath) {

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

@@ -7,6 +7,7 @@ import PsychicApp from '../psychic-app/index.js';
 import { HttpMethods } from '../router/types.js';
 import { DEFAULT_OPENAPI_COMPONENT_RESPONSES, DEFAULT_OPENAPI_COMPONENT_SCHEMAS } from './defaults.js';
 import { MissingControllerActionPairingInRoutes, } from './endpoint.js';
+import legacyImplicitRequestBodyParamsConfig from './helpers/legacyImplicitRequestBodyParamsConfig.js';
 import suppressResponseEnumsConfig from './helpers/suppressResponseEnumsConfig.js';
 const debugEnabled = debuglog('psychic').enabled;
 export default class OpenapiAppRenderer {
@@ -47,6 +48,7 @@ export default class OpenapiAppRenderer {
         const renderOpts = {
             casing: 'camel',
             suppressResponseEnums: suppressResponseEnumsConfig(openapiName),
+            legacyImplicitRequestBodyParams: legacyImplicitRequestBodyParamsConfig(openapiName),
         };
         const alreadyExtractedDescendantSerializers = {};
         const renderedSchemasOpenapi = {};

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

@@ -54,6 +54,7 @@ export default class OpenapiSegmentExpander {
     bodySegment;
     casing;
     suppressResponseEnums;
+    legacyImplicitRequestBodyParams;
     target;
     source;
     /**
@@ -66,6 +67,7 @@ export default class OpenapiSegmentExpander {
         this.bodySegment = bodySegment;
         this.casing = renderOpts.casing;
         this.suppressResponseEnums = renderOpts.suppressResponseEnums;
+        this.legacyImplicitRequestBodyParams = renderOpts.legacyImplicitRequestBodyParams;
         this.target = target;
         this.source = source ?? 'unknown';
     }
@@ -489,6 +491,7 @@ The following values will be allowed:
             including: ref.including,
             required: ref.required,
             combining: ref.combining,
+            legacyImplicitRequestBodyParams: this.legacyImplicitRequestBodyParams,
         }, this.source);
         return this.recursivelyParseBody(paramsShape);
     }

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

@@ -529,7 +529,17 @@ export default class OpenapiEndpointRenderer {
             including: including,
             required: required,
             combining: combining,
+            legacyImplicitRequestBodyParams: renderOpts.legacyImplicitRequestBodyParams,
         }, source);
+        // When the model-derived shape contributes no properties and no `required`
+        // (e.g. the new none-default with no `params`/`only`/`combining`), there is
+        // nothing meaningful to advertise. Fall back to `defaultRequestBody()`, which
+        // omits the body entirely unless body-level pagination params are present.
+        const shapeProperties = paramsShape.properties;
+        const shapeRequired = paramsShape.required;
+        if (Object.keys(shapeProperties ?? {}).length === 0 && !shapeRequired) {
+            return this.defaultRequestBody();
+        }
         let processedSchema = new OpenapiSegmentExpander(paramsShape, {
             renderOpts,
             target: 'request',

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

@@ -2,6 +2,7 @@ import OpenapiRequestValidationFailure from '../../error/openapi/OpenapiRequestV
 import OpenapiResponseValidationFailure from '../../error/openapi/OpenapResponseValidationFailure.js';
 import { createValidator, formatAjvErrors, } from '../../helpers/validateOpenApiSchema.js';
 import PsychicApp from '../../psychic-app/index.js';
+import legacyImplicitRequestBodyParamsConfig from './legacyImplicitRequestBodyParamsConfig.js';
 import suppressResponseEnumsConfig from './suppressResponseEnumsConfig.js';
 import { cacheValidator, getCachedValidator } from './validator-cache.js';
 /**
@@ -207,6 +208,7 @@ export default class OpenapiPayloadValidator {
         return {
             casing: 'camel',
             suppressResponseEnums: suppressResponseEnumsConfig(this.openapiName),
+            legacyImplicitRequestBodyParams: legacyImplicitRequestBodyParamsConfig(this.openapiName),
         };
     }
     /**

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

@@ -11,9 +11,15 @@ import { dreamColumnOpenapiShape } from './dreamColumnOpenapiShape.js';
  * truth keeps top-level and nested semantics identical.
  */
 export default function buildDreamRequestBodyShape(dreamClass, opts, source) {
-    const { params, only, including, required, combining } = opts;
+    const { params, only, including, required, combining, legacyImplicitRequestBodyParams } = opts;
+    // When neither `params` nor `only` is provided, the default is to resolve to
+    // NO model columns (an empty allowlist), rather than implicitly exposing every
+    // param-safe column. The legacy implicit-all behavior can be re-activated via
+    // the `legacyImplicitRequestBodyParams` opt-in.
+    const resolvedOnly = params ?? only;
+    const onlyForResolution = resolvedOnly === undefined && !legacyImplicitRequestBodyParams ? [] : resolvedOnly;
     const paramSafeColumns = openapiParamNamesForDreamClass(dreamClass, {
-        only: params ?? only,
+        only: onlyForResolution,
         including,
     });
     const paramsShape = {

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

@@ -18,6 +18,7 @@ source, dreamClass, column, openapi = undefined, { suppressResponseEnums = false
                     renderOpts: {
                         casing: 'camel',
                         suppressResponseEnums: false,
+                        legacyImplicitRequestBodyParams: false,
                     },
                     target: 'request',
                 }).render().openapi,

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

@@ -0,0 +1,9 @@
+import openapiOpts from './openapiOpts.js';
+/**
+ * returns whether the named openapi config opts in to the legacy behavior of
+ * implicitly exposing all param-safe columns when a model-derived request body
+ * is given no `params`/`only`.
+ */
+export default function legacyImplicitRequestBodyParamsConfig(openapiName) {
+    return !!openapiOpts(openapiName)?.legacyImplicitRequestBodyParams;
+}

package/dist/esm/src/bin/helpers/OpenApiSpecDiff.js

@@ -189,6 +189,10 @@ export class OpenApiSpecDiff {
     }
     /**
      * Retrieves head branch content for a file
+     *
+     * Marked `protected` so tests can supply a deterministic baseline instead of
+     * the live head branch. Production code never overrides this.
+     *
      * @param absoluteFilePath - Absolute path to the file
      */
     getHeadBranchContent(absoluteFilePath) {

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

@@ -7,6 +7,7 @@ import PsychicApp from '../psychic-app/index.js';
 import { HttpMethods } from '../router/types.js';
 import { DEFAULT_OPENAPI_COMPONENT_RESPONSES, DEFAULT_OPENAPI_COMPONENT_SCHEMAS } from './defaults.js';
 import { MissingControllerActionPairingInRoutes, } from './endpoint.js';
+import legacyImplicitRequestBodyParamsConfig from './helpers/legacyImplicitRequestBodyParamsConfig.js';
 import suppressResponseEnumsConfig from './helpers/suppressResponseEnumsConfig.js';
 const debugEnabled = debuglog('psychic').enabled;
 export default class OpenapiAppRenderer {
@@ -47,6 +48,7 @@ export default class OpenapiAppRenderer {
         const renderOpts = {
             casing: 'camel',
             suppressResponseEnums: suppressResponseEnumsConfig(openapiName),
+            legacyImplicitRequestBodyParams: legacyImplicitRequestBodyParamsConfig(openapiName),
         };
         const alreadyExtractedDescendantSerializers = {};
         const renderedSchemasOpenapi = {};

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

@@ -54,6 +54,7 @@ export default class OpenapiSegmentExpander {
     bodySegment;
     casing;
     suppressResponseEnums;
+    legacyImplicitRequestBodyParams;
     target;
     source;
     /**
@@ -66,6 +67,7 @@ export default class OpenapiSegmentExpander {
         this.bodySegment = bodySegment;
         this.casing = renderOpts.casing;
         this.suppressResponseEnums = renderOpts.suppressResponseEnums;
+        this.legacyImplicitRequestBodyParams = renderOpts.legacyImplicitRequestBodyParams;
         this.target = target;
         this.source = source ?? 'unknown';
     }
@@ -489,6 +491,7 @@ The following values will be allowed:
             including: ref.including,
             required: ref.required,
             combining: ref.combining,
+            legacyImplicitRequestBodyParams: this.legacyImplicitRequestBodyParams,
         }, this.source);
         return this.recursivelyParseBody(paramsShape);
     }

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

@@ -529,7 +529,17 @@ export default class OpenapiEndpointRenderer {
             including: including,
             required: required,
             combining: combining,
+            legacyImplicitRequestBodyParams: renderOpts.legacyImplicitRequestBodyParams,
         }, source);
+        // When the model-derived shape contributes no properties and no `required`
+        // (e.g. the new none-default with no `params`/`only`/`combining`), there is
+        // nothing meaningful to advertise. Fall back to `defaultRequestBody()`, which
+        // omits the body entirely unless body-level pagination params are present.
+        const shapeProperties = paramsShape.properties;
+        const shapeRequired = paramsShape.required;
+        if (Object.keys(shapeProperties ?? {}).length === 0 && !shapeRequired) {
+            return this.defaultRequestBody();
+        }
         let processedSchema = new OpenapiSegmentExpander(paramsShape, {
             renderOpts,
             target: 'request',

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

@@ -2,6 +2,7 @@ import OpenapiRequestValidationFailure from '../../error/openapi/OpenapiRequestV
 import OpenapiResponseValidationFailure from '../../error/openapi/OpenapResponseValidationFailure.js';
 import { createValidator, formatAjvErrors, } from '../../helpers/validateOpenApiSchema.js';
 import PsychicApp from '../../psychic-app/index.js';
+import legacyImplicitRequestBodyParamsConfig from './legacyImplicitRequestBodyParamsConfig.js';
 import suppressResponseEnumsConfig from './suppressResponseEnumsConfig.js';
 import { cacheValidator, getCachedValidator } from './validator-cache.js';
 /**
@@ -207,6 +208,7 @@ export default class OpenapiPayloadValidator {
         return {
             casing: 'camel',
             suppressResponseEnums: suppressResponseEnumsConfig(this.openapiName),
+            legacyImplicitRequestBodyParams: legacyImplicitRequestBodyParamsConfig(this.openapiName),
         };
     }
     /**

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

@@ -11,9 +11,15 @@ import { dreamColumnOpenapiShape } from './dreamColumnOpenapiShape.js';
  * truth keeps top-level and nested semantics identical.
  */
 export default function buildDreamRequestBodyShape(dreamClass, opts, source) {
-    const { params, only, including, required, combining } = opts;
+    const { params, only, including, required, combining, legacyImplicitRequestBodyParams } = opts;
+    // When neither `params` nor `only` is provided, the default is to resolve to
+    // NO model columns (an empty allowlist), rather than implicitly exposing every
+    // param-safe column. The legacy implicit-all behavior can be re-activated via
+    // the `legacyImplicitRequestBodyParams` opt-in.
+    const resolvedOnly = params ?? only;
+    const onlyForResolution = resolvedOnly === undefined && !legacyImplicitRequestBodyParams ? [] : resolvedOnly;
     const paramSafeColumns = openapiParamNamesForDreamClass(dreamClass, {
-        only: params ?? only,
+        only: onlyForResolution,
         including,
     });
     const paramsShape = {

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

@@ -18,6 +18,7 @@ source, dreamClass, column, openapi = undefined, { suppressResponseEnums = false
                     renderOpts: {
                         casing: 'camel',
                         suppressResponseEnums: false,
+                        legacyImplicitRequestBodyParams: false,
                     },
                     target: 'request',
                 }).render().openapi,

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

@@ -0,0 +1,9 @@
+import openapiOpts from './openapiOpts.js';
+/**
+ * returns whether the named openapi config opts in to the legacy behavior of
+ * implicitly exposing all param-safe columns when a model-derived request body
+ * is given no `params`/`only`.
+ */
+export default function legacyImplicitRequestBodyParamsConfig(openapiName) {
+    return !!openapiOpts(openapiName)?.legacyImplicitRequestBodyParams;
+}

package/dist/types/src/bin/helpers/OpenApiSpecDiff.d.ts

@@ -96,9 +96,13 @@ export declare class OpenApiSpecDiff {
     private createTempFilePath;
     /**
      * Retrieves head branch content for a file
+     *
+     * Marked `protected` so tests can supply a deterministic baseline instead of
+     * the live head branch. Production code never overrides this.
+     *
      * @param absoluteFilePath - Absolute path to the file
      */
-    private getHeadBranchContent;
+    protected getHeadBranchContent(absoluteFilePath: string): string;
     /**
      * Compares a single OpenAPI file against head branch
      */

package/dist/types/src/openapi-renderer/body-segment.d.ts

@@ -56,6 +56,7 @@ export default class OpenapiSegmentExpander {
     private bodySegment;
     private casing;
     private suppressResponseEnums;
+    private legacyImplicitRequestBodyParams;
     private target;
     private source;
     /**

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

@@ -11,6 +11,7 @@ import { OpenapiBodySegment, ReferencedSerializersAndOpenapiEndpointResponse, Se
 export interface OpenapiRenderOpts {
     casing: SerializerCasing;
     suppressResponseEnums: boolean;
+    legacyImplicitRequestBodyParams: boolean;
 }
 export interface ToPathObjectOpts {
     openapiName: string;

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

@@ -6,6 +6,13 @@ export interface BuildDreamRequestBodyShapeOpts {
     including?: readonly string[] | undefined;
     required?: readonly string[] | undefined;
     combining?: Record<string, unknown> | undefined;
+    /**
+     * When true, restores the legacy behavior of resolving to ALL param-safe
+     * columns when no `params`/`only` are provided. When false/undefined (the
+     * default), an absent `params`/`only` resolves to NO model columns, so that
+     * database-level structure is not implicitly leaked into the OpenAPI shape.
+     */
+    legacyImplicitRequestBodyParams?: boolean | undefined;
 }
 /**
  * @internal

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

@@ -0,0 +1,6 @@
+/**
+ * returns whether the named openapi config opts in to the legacy behavior of
+ * implicitly exposing all param-safe columns when a model-derived request body
+ * is given no `params`/`only`.
+ */
+export default function legacyImplicitRequestBodyParamsConfig(openapiName: string): boolean;

package/dist/types/src/psychic-app/index.d.ts

@@ -356,6 +356,29 @@ interface PsychicOpenapiBaseOptions {
      * ```
      */
     suppressResponseEnums?: boolean;
+    /**
+     * @deprecated escape hatch — prefer explicit `params`/`only` on each request body.
+     *
+     * When true, restores the legacy behavior where a model-derived `requestBody`
+     * (or nested `$dream`/`for:` segment) given no `params`/`only` implicitly
+     * exposes ALL param-safe columns of the model.
+     *
+     * As of 3.9.0 the default flipped: an absent `params`/`only` now resolves to
+     * NO model columns, so that database-level structure is not implicitly leaked
+     * into the OpenAPI shape (an attacker could otherwise infer the column set).
+     * A top-level model-derived `requestBody` with nothing to contribute is
+     * omitted entirely; a nested `$dream`/`for:` segment renders an empty object.
+     *
+     * Set this to true to keep the pre-3.9.0 implicit-all behavior while you
+     * migrate to explicit allowlists.
+     *
+     * ```ts
+     * psy.set('openapi', {
+     *   legacyImplicitRequestBodyParams: true,
+     * })
+     * ```
+     */
+    legacyImplicitRequestBodyParams?: boolean;
     /**
      * When true, psychic will use the `openapi-typescript` package
      * to read this openapi.json file and create typescript interfaces

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "3.8.6",
+  "version": "3.9.0",
   "author": "RVOHealth",
   "publishConfig": {
     "access": "public"