@rvoh/dream 2.37.0 → 2.39.0

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

@@ -14,6 +14,7 @@ import standardizeFullyQualifiedModelName from '../helpers/standardizeFullyQuali
 import expandStiClasses from '../helpers/sti/expandStiClasses.js';
 import inferSerializerFromDreamOrViewModel, { inferSerializersFromDreamClassOrViewModelClass } from '../serializer/helpers/inferSerializerFromDreamOrViewModel.js';
 import isDreamSerializer from '../serializer/helpers/isDreamSerializer.js';
+import { flattenedOpenapiVariants, nullFlattenedOpenapiKeys, nullFlattenedOpenapiKeysOfOtherVariants, nullFlattenedSerializerKeys, nullFlattenedSerializerKeysOfOtherVariants } from '../serializer/helpers/nullFlattenedSerializerKeys.js';
 import serializerNameFromFullyQualifiedModelName from '../serializer/helpers/serializerNameFromFullyQualifiedModelName.js';
 import { DbConnectionType, LegacyCompatiblePrimaryKeyType } from '../types/db.js';
 import { DreamModelSerializerType, SimpleObjectSerializerType } from '../types/serializer.js';
@@ -67,6 +68,11 @@ export default class DreamApp {
         inferSerializerFromDreamOrViewModel: typeof inferSerializerFromDreamOrViewModel;
         inferSerializersFromDreamClassOrViewModelClass: typeof inferSerializersFromDreamClassOrViewModelClass;
         isDreamSerializer: typeof isDreamSerializer;
+        nullFlattenedSerializerKeys: typeof nullFlattenedSerializerKeys;
+        nullFlattenedSerializerKeysOfOtherVariants: typeof nullFlattenedSerializerKeysOfOtherVariants;
+        nullFlattenedOpenapiKeys: typeof nullFlattenedOpenapiKeys;
+        nullFlattenedOpenapiKeysOfOtherVariants: typeof nullFlattenedOpenapiKeysOfOtherVariants;
+        flattenedOpenapiVariants: typeof flattenedOpenapiVariants;
         serializerNameFromFullyQualifiedModelName: typeof serializerNameFromFullyQualifiedModelName;
         autogeneratedFileDisclaimer: typeof autogeneratedFileDisclaimer;
     };

package/dist/types/src/serializer/DreamSerializer.d.ts

@@ -1,3 +1,26 @@
 import Dream from '../Dream.js';
 import DreamSerializerBuilder from './builders/DreamSerializerBuilder.js';
+/**
+ * Builds a serializer for a Dream model. A serializer is a function that takes the
+ * data to render and declares the keys to render it with:
+ *
+ * ```typescript
+ * export const UserSerializer = (user: User) =>
+ *   DreamSerializer(User, user).attribute('email').rendersMany('posts')
+ * ```
+ *
+ * A serializer must not read its data while being built: what it declares may not
+ * depend on its data. Dream and Psychic build it without data to read its shape (the
+ * OpenAPI schema, and the keys a flattened association or `customAttribute` that uses
+ * it renders as `null` where its value does not supply them), so a serializer that
+ * reads its data while being built throws when a flattened association or
+ * `customAttribute` that uses it is rendered. Read the data inside a `customAttribute`
+ * callback, which runs only when the serializer renders, not while it is built.
+ *
+ * @param dreamClass - The Dream model class the serializer renders
+ * @param data - The Dream instance to render
+ * @param passthroughData - Data available to this serializer and passed down to the serializers
+ *   it renders
+ * @returns The serializer builder for method chaining
+ */
 export default function DreamSerializer<DreamClass extends typeof Dream, DataType extends Dream | null, PassthroughDataType extends object | undefined = undefined>(dreamClass: DreamClass, data: DataType, passthroughData?: PassthroughDataType): DreamSerializerBuilder<DreamClass, DataType, PassthroughDataType, Exclude<DataType, null>>;

package/dist/types/src/serializer/ObjectSerializer.d.ts

@@ -1,2 +1,24 @@
 import ObjectSerializerBuilder from './builders/ObjectSerializerBuilder.js';
+/**
+ * Builds a serializer for a plain object or view model. A serializer is a function
+ * that takes the data to render and declares the keys to render it with:
+ *
+ * ```typescript
+ * export const AddressSerializer = (address: Address) =>
+ *   ObjectSerializer(address).attribute('city', { openapi: 'string' })
+ * ```
+ *
+ * A serializer must not read its data while being built: what it declares may not
+ * depend on its data. Dream and Psychic build it without data to read its shape (the
+ * OpenAPI schema, and the keys a flattened association or `customAttribute` that uses
+ * it renders as `null` where its value does not supply them), so a serializer that
+ * reads its data while being built throws when a flattened association or
+ * `customAttribute` that uses it is rendered. Read the data inside a `customAttribute`
+ * callback, which runs only when the serializer renders, not while it is built.
+ *
+ * @param data - The object to render
+ * @param passthroughData - Data available to this serializer and passed down to the serializers
+ *   it renders
+ * @returns The serializer builder for method chaining
+ */
 export default function ObjectSerializer<DataType extends object | null, PassthroughDataType extends object | undefined = undefined>(data: DataType, passthroughData?: PassthroughDataType): ObjectSerializerBuilder<DataType, PassthroughDataType, Exclude<DataType, null>>;

package/dist/types/src/serializer/SerializerRenderer.d.ts

@@ -10,18 +10,6 @@ export default class SerializerRenderer {
     private renderOpts;
     constructor(serializerBuilder: DreamSerializerBuilder<any, any> | ObjectSerializerBuilder<any, any> | null | undefined, passthroughData?: object, { casing }?: SerializerRendererOpts);
     render(): Record<string, any> | null;
-    /**
-     * The keys a flattened `rendersOne` adds to the parent's payload when its associated object is
-     * null: each key any of `serializers` declares, set to `null`. There are several serializers when
-     * the association is a polymorphic BelongsTo, one for each target class, or when the associated
-     * class is an STI base, one for each child, and their keys are unioned.
-     *
-     * Each serializer is built with `undefined` data to read its declarations, as Psychic's OpenAPI
-     * generation and `preloadFor` build it, and nothing is rendered: no attribute callback runs and
-     * no association of the missing object is read. A flattened `rendersOne` it declares adds its
-     * own serializers' keys the same way. A flattened `customAttribute` adds none, since only its
-     * callback knows its keys.
-     */
-    private nullFlattenedAttributes;
+    private setCaseOfDefinedKeys;
     private setCase;
 }

package/dist/types/src/serializer/builders/DreamSerializerBuilder.d.ts

@@ -141,15 +141,29 @@ export default class DreamSerializerBuilder<DataTypeForOpenapi extends typeof Dr
      *   - `openapi` - (required) OpenAPI schema definition for the computed value
      *   - `flatten` - When `true`, spreads the returned object's properties directly into the
      *     parent serialized output instead of nesting them under `name`. The `openapi` option
-     *     then describes the whole returned object, not each property, because Psychic adds it
-     *     to the parent's schema as an `allOf` branch: either an object schema with full
-     *     property bodies (`type: 'object'`, `properties`, and `required` listing the keys that
-     *     are always present), or `{ $serializer: SomeSerializer }` when the callback returns
-     *     what that serializer renders. A serializer ref with `many: true` does not type-check
-     *     here, since a list has no properties to spread. A `null` or `undefined` return adds no
-     *     keys. Attributes render in declaration order, so a key the returned object shares with
-     *     another attribute takes the value of whichever is declared later; under the `allOf`,
-     *     that value must match both schemas
+     *     then describes the whole returned object, not each property: either an object schema
+     *     with full property bodies (`type: 'object'`, `properties`, and `required` listing the
+     *     keys that are always present), or `{ $serializer: SomeSerializer }` when the callback
+     *     returns what that serializer renders. A serializer ref with `many: true` does not
+     *     type-check here, since a list has no properties to spread. Whatever the callback
+     *     returns, each key any shape of the `openapi` requires renders, as `null` wherever the
+     *     value does not supply it (a returned plain object's key set to `undefined` does not
+     *     supply it): a key an object shape lists in its `required` array, a key a `$serializer` or
+     *     `$serializable` ref's serializer declares without `required: false` (for an STI base,
+     *     any child's serializer), and each such key of any `allOf`, `anyOf` or `oneOf` member. So
+     *     a `null` return, a serializer built over `null` or `undefined` data, or an `undefined`
+     *     return without `required: false` renders each of them as `null`, and a present value
+     *     renders its own keys over them, so a key another shape requires renders as `null` even
+     *     when the value's own shape leaves it optional; the payload always includes the same
+     *     keys whichever shape the value takes and whether it is null. An optional key no shape
+     *     requires stays absent unless the value supplies it, and an `undefined` return with
+     *     `required: false` adds no keys.
+     *     Every key it adds follows the render's casing like the parent's own keys: a returned
+     *     plain object's top-level keys and the `openapi`'s `properties` keys are cased (so
+     *     `casing: 'snake'` renders `phoneNumber` as `phone_number`, present or `null`), while
+     *     nested values render as returned. Attributes render in declaration order, so a key the
+     *     returned object shares with another attribute takes the value of whichever is declared
+     *     later, and that value must match both the attribute's declaration and the `openapi`'s
      *   - `required` - Set to `false` to mark the attribute as optional in the OpenAPI schema;
      *     when omitted, attributes are required by default
      * @returns The serializer builder for method chaining
@@ -191,14 +205,29 @@ export default class DreamSerializerBuilder<DataTypeForOpenapi extends typeof Dr
      *     declaration order, so when the parent and the association share a key (e.g., `id`),
      *     whichever is declared later wins: the association's value replaces an attribute declared
      *     before the `rendersOne`, and an attribute declared after it replaces the association's.
-     *     When the association is `null`, every key its serializer declares renders as `null`
-     *     (for a polymorphic `BelongsTo`, every key the serializer of any of its target classes
-     *     declares, and for an association to an STI base, every key the serializer of any of its
-     *     STI children declares), in the same order (so an `id` declared before the `rendersOne` becomes
-     *     `null`); nothing in that serializer is rendered, so its custom attribute callbacks do
-     *     not run, and a flattened `customAttribute` in it adds no keys. Psychic adds the association's OpenAPI
-     *     schema to the parent's as an `allOf` branch, so a shared key's value must match both
-     *     schemas, whichever declaration wins
+     *     Each key its serializer requires always renders, as `null` wherever the association
+     *     does not supply it: an attribute, delegatedAttribute or customAttribute declared without
+     *     `required: false`, and every non-flattened `rendersOne` and `rendersMany` (for a
+     *     polymorphic `BelongsTo`, each key the serializer of any of its target classes requires,
+     *     and for an association to an STI base, each key the serializer of any of its STI children
+     *     requires), in the same order (so an `id` declared before the `rendersOne` becomes `null`
+     *     when the association is `null`). A flattened `customAttribute` in that serializer adds the
+     *     keys its `openapi` requires: a key an object shape lists in its `required` array, a key a
+     *     `$serializer` or `$serializable` ref's serializer declares without `required: false`, and
+     *     each such key of an `allOf`, `anyOf` or `oneOf` member; a ref with `many: true` adds none,
+     *     and a flattened `customAttribute` declared with `required: false` adds none. When the
+     *     association is `null`, each of these keys renders as `null` and nothing in its serializer
+     *     is rendered, so its custom attribute callbacks do not run. When it is present, the held
+     *     object's serializer renders its own keys over them, so a key another STI child's or
+     *     target's serializer requires renders as `null` where the held one's serializer does not
+     *     render it, including a key that serializer declares with `required: false`; the payload
+     *     always includes the same keys whichever is held and, for an association or a property
+     *     given a `serializer` or `viewModelClass` option, whether it is `null` (a `null` property
+     *     that is not an association and has neither option renders none of these keys, since no
+     *     serializer is known for it). A key declared with `required: false` that no serializer
+     *     requires stays absent unless it renders. The association's OpenAPI schema describes the
+     *     parent's payload too, so a shared key's value must match both the parent's declaration
+     *     and the association's, whichever declaration wins
      *   - `optional` - When `true`, allows the association to be null/missing without causing
      *     an `OpenapiResponseValidationFailure` during Psychic controller unit specs. By default,
      *     `rendersOne` expects the association to be present (mirroring the `optional` option on
@@ -254,8 +283,9 @@ export default class DreamSerializerBuilder<DataTypeForOpenapi extends typeof Dr
          * If `true`, the rendered association's attributes are merged directly into
          * the parent object instead of being nested under the association key. A key
          * the parent shares with the association takes the value of whichever is
-         * declared later, and when the association is `null`, every key its serializer
-         * declares renders as `null`. See the `flatten` option of `rendersOne`.
+         * declared later, and each key its serializer requires renders, as `null`
+         * wherever the association does not supply it. See the `flatten` option of
+         * `rendersOne`.
          */
         flatten?: boolean;
         /**

package/dist/types/src/serializer/builders/ObjectSerializerBuilder.d.ts

@@ -134,15 +134,29 @@ export default class ObjectSerializerBuilder<MaybeNullDataType extends object |
      *   - `openapi` - (required) OpenAPI schema definition for the computed value
      *   - `flatten` - When `true`, spreads the returned object's properties directly into the
      *     parent serialized output instead of nesting them under `name`. The `openapi` option
-     *     then describes the whole returned object, not each property, because Psychic adds it
-     *     to the parent's schema as an `allOf` branch: either an object schema with full
-     *     property bodies (`type: 'object'`, `properties`, and `required` listing the keys that
-     *     are always present), or `{ $serializer: SomeSerializer }` when the callback returns
-     *     what that serializer renders. A serializer ref with `many: true` does not type-check
-     *     here, since a list has no properties to spread. A `null` or `undefined` return adds no
-     *     keys. Attributes render in declaration order, so a key the returned object shares with
-     *     another attribute takes the value of whichever is declared later; under the `allOf`,
-     *     that value must match both schemas
+     *     then describes the whole returned object, not each property: either an object schema
+     *     with full property bodies (`type: 'object'`, `properties`, and `required` listing the
+     *     keys that are always present), or `{ $serializer: SomeSerializer }` when the callback
+     *     returns what that serializer renders. A serializer ref with `many: true` does not
+     *     type-check here, since a list has no properties to spread. Whatever the callback
+     *     returns, each key any shape of the `openapi` requires renders, as `null` wherever the
+     *     value does not supply it (a returned plain object's key set to `undefined` does not
+     *     supply it): a key an object shape lists in its `required` array, a key a `$serializer` or
+     *     `$serializable` ref's serializer declares without `required: false` (for an STI base,
+     *     any child's serializer), and each such key of any `allOf`, `anyOf` or `oneOf` member. So
+     *     a `null` return, a serializer built over `null` or `undefined` data, or an `undefined`
+     *     return without `required: false` renders each of them as `null`, and a present value
+     *     renders its own keys over them, so a key another shape requires renders as `null` even
+     *     when the value's own shape leaves it optional; the payload always includes the same
+     *     keys whichever shape the value takes and whether it is null. An optional key no shape
+     *     requires stays absent unless the value supplies it, and an `undefined` return with
+     *     `required: false` adds no keys.
+     *     Every key it adds follows the render's casing like the parent's own keys: a returned
+     *     plain object's top-level keys and the `openapi`'s `properties` keys are cased (so
+     *     `casing: 'snake'` renders `phoneNumber` as `phone_number`, present or `null`), while
+     *     nested values render as returned. Attributes render in declaration order, so a key the
+     *     returned object shares with another attribute takes the value of whichever is declared
+     *     later, and that value must match both the attribute's declaration and the `openapi`'s
      *   - `required` - Set to `false` to mark the attribute as optional in the OpenAPI schema;
      *     when omitted, attributes are required by default
      * @returns The serializer builder for method chaining
@@ -184,14 +198,27 @@ export default class ObjectSerializerBuilder<MaybeNullDataType extends object |
      *     declaration order, so when the parent and the association share a key (e.g., `id`),
      *     whichever is declared later wins: the association's value replaces an attribute declared
      *     before the `rendersOne`, and an attribute declared after it replaces the association's.
-     *     When the association is `null`, every key its serializer declares renders as `null`
-     *     (for a polymorphic `BelongsTo`, every key the serializer of any of its target classes
-     *     declares, and for an association to an STI base, every key the serializer of any of its
-     *     STI children declares), in the same order (so an `id` declared before the `rendersOne` becomes
-     *     `null`); nothing in that serializer is rendered, so its custom attribute callbacks do
-     *     not run, and a flattened `customAttribute` in it adds no keys. Psychic adds the association's OpenAPI
-     *     schema to the parent's as an `allOf` branch, so a shared key's value must match both
-     *     schemas, whichever declaration wins
+     *     Each key its serializer requires always renders, as `null` wherever the association
+     *     does not supply it: an attribute, delegatedAttribute or customAttribute declared without
+     *     `required: false`, and every non-flattened `rendersOne` and `rendersMany` (for a
+     *     polymorphic `BelongsTo`, each key the serializer of any of its target classes requires,
+     *     and for an association to an STI base, each key the serializer of any of its STI children
+     *     requires), in the same order (so an `id` declared before the `rendersOne` becomes `null`
+     *     when the association is `null`). A flattened `customAttribute` in that serializer adds the
+     *     keys its `openapi` requires: a key an object shape lists in its `required` array, a key a
+     *     `$serializer` or `$serializable` ref's serializer declares without `required: false`, and
+     *     each such key of an `allOf`, `anyOf` or `oneOf` member; a ref with `many: true` adds none,
+     *     and a flattened `customAttribute` declared with `required: false` adds none. When the
+     *     association is `null`, each of these keys renders as `null` and nothing in its serializer
+     *     is rendered, so its custom attribute callbacks do not run. When it is present, the held
+     *     object's serializer renders its own keys over them, so a key another STI child's or
+     *     target's serializer requires renders as `null` where the held one's serializer does not
+     *     render it, including a key that serializer declares with `required: false`; the payload
+     *     always includes the same keys whichever is held and whether the association is `null`. A
+     *     key declared with `required: false` that no serializer requires stays absent unless it
+     *     renders. The association's OpenAPI schema describes the parent's payload too, so a shared
+     *     key's value must match both the parent's declaration and the association's, whichever
+     *     declaration wins
      *   - `optional` - When `true`, allows the association to be null/missing without causing
      *     an `OpenapiResponseValidationFailure` during Psychic controller unit specs. By default,
      *     `rendersOne` expects the association to be present (mirroring the `optional` option on
@@ -249,8 +276,9 @@ export default class ObjectSerializerBuilder<MaybeNullDataType extends object |
          * If `true`, the rendered association's attributes are merged directly into
          * the parent object instead of being nested under the association key. A key
          * the parent shares with the association takes the value of whichever is
-         * declared later, and when the association is `null`, every key its serializer
-         * declares renders as `null`. See the `flatten` option of `rendersOne`.
+         * declared later, and each key its serializer requires renders, as `null`
+         * wherever the association does not supply it. See the `flatten` option of
+         * `rendersOne`.
          */
         flatten?: boolean;
         /**

package/dist/types/src/serializer/helpers/nullFlattenedSerializerKeys.d.ts

@@ -0,0 +1,85 @@
+import { OpenapiSchemaBodyShorthand, OpenapiShorthandPrimitiveTypes } from '../../types/openapi.js';
+import { DreamModelSerializerType, SerializerCasing, SimpleObjectSerializerType } from '../../types/serializer.js';
+export interface NullFlattenedSerializerKeysOptions {
+    casing?: SerializerCasing;
+    passthroughData?: object;
+}
+/**
+ * The keys a flattened `rendersOne` always adds to the parent's payload, returned as an object
+ * with each key set to `null`, ready to spread into the parent's payload (`Object.keys` of it for
+ * the key names alone): each key one of `serializers` requires. When the associated object is
+ * null, these are the keys it renders; when it is present, the rendered serializer's own keys
+ * render over them, so each of these it leaves out stays `null` and the payload always includes
+ * these keys, whichever serializer renders and whether the object is null. As a property read on
+ * an empty object is `undefined`, a null value carries no key it may omit: an attribute,
+ * delegatedAttribute or customAttribute declared with `required: false` adds no key unless another
+ * of `serializers` requires it. Every key is cased per `casing`, as the renderer cases it. There
+ * are several serializers when the association is a polymorphic BelongsTo, one for each target
+ * class, or when the associated class is an STI base, one for each child, and their required keys
+ * are unioned.
+ *
+ * Each serializer is built with `undefined` data to read its declarations, as Psychic's OpenAPI
+ * generation and `preloadFor` build it, and nothing is rendered: no attribute callback runs and
+ * no association of the missing object is read. A non-flattened `rendersOne` or a `rendersMany`
+ * always adds its key. A flattened `rendersOne` it declares adds its own serializers' required keys
+ * the same way. A flattened `customAttribute` adds the keys its `openapi` requires: each key of
+ * its `properties` that the shape's `required` array lists, the required keys of the serializer a
+ * `$serializer` ref names or of every serializer a `$serializable` ref resolves to (one per child
+ * for an STI base), walked the same way, and the union of the keys every member of an `allOf`,
+ * `anyOf` or `oneOf` requires, with each key an object shape's own `required` array lists beside
+ * its members; one declared with `required: false` adds none. A ref with `many: true` adds none,
+ * since a list has no keys to spread. A serializer reached again within its own walk, as when one
+ * flattens itself, adds nothing, so the walk always terminates; one reached again along another
+ * path is walked again, so each path adds its keys and their requirements.
+ *
+ * `passthroughData` is handed to each serializer as it is built, as when rendering; outside a
+ * render it may be left out.
+ */
+export declare function nullFlattenedSerializerKeys(serializers: (DreamModelSerializerType | SimpleObjectSerializerType)[], options?: NullFlattenedSerializerKeysOptions): Record<string, null>;
+/**
+ * The keys a flattened `customAttribute` with this `openapi` always adds to the parent's payload,
+ * each set to `null`: each key any shape of `openapi` requires, walked as
+ * `nullFlattenedSerializerKeys` walks a flattened `customAttribute` and cased per `casing`. When
+ * its callback returns null (or `undefined` without `required: false`), or a serializer built over
+ * null data, these are the keys it renders; when it returns any other value, that value's own keys
+ * render over them, so each of these the value leaves out, or a returned plain object sets to
+ * `undefined`, stays `null`. With `required: false`, a callback that returns `undefined` adds none
+ * of them.
+ */
+export declare function nullFlattenedOpenapiKeys(openapi: OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes, options?: NullFlattenedSerializerKeysOptions): Record<string, null>;
+/**
+ * The keys only the other variants of a flattened `rendersOne` contribute to its payload, each set
+ * to `null`: each key one of `serializers` (every serializer the association may render with)
+ * requires that `renderedSerializer` does not declare at all. A key `renderedSerializer` declares
+ * is left out even when it declares it with `required: false` and another serializer requires it;
+ * the renderer fills that key with `null` too, since it renders every key
+ * `nullFlattenedSerializerKeys` returns beneath the rendered serializer's own keys.
+ */
+export declare function nullFlattenedSerializerKeysOfOtherVariants(serializers: (DreamModelSerializerType | SimpleObjectSerializerType)[], renderedSerializer: DreamModelSerializerType | SimpleObjectSerializerType, options?: NullFlattenedSerializerKeysOptions): Record<string, null>;
+/**
+ * The keys only the other variants of a flattened `customAttribute` with this `openapi` contribute
+ * to its payload, each set to `null`: each key a variant of `openapi` requires that
+ * `renderedVariant` does not declare. `renderedVariant` is any `openapi` shorthand: one member of
+ * an `anyOf` or `oneOf`, or `{ $serializer: childSerializer }` for one child of a `$serializable`
+ * ref to an STI base. A key requires its value when an object shape's `required` array lists it,
+ * whether the shape's own `properties` declare it or a member of its `allOf`, `anyOf` or `oneOf`
+ * does, or when a serializer declares it without `required: false`. A key `renderedVariant`
+ * declares is left out even when it is optional there and another variant requires it; the
+ * renderer fills that key with `null` too, since it renders every key `nullFlattenedOpenapiKeys`
+ * returns beneath the value's own keys.
+ */
+export declare function nullFlattenedOpenapiKeysOfOtherVariants(openapi: OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes, renderedVariant: OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes, options?: NullFlattenedSerializerKeysOptions): Record<string, null>;
+/**
+ * Lists the single shapes a value of a flattened `customAttribute` with this `openapi` may take,
+ * which a consumer can union into one description of the flattened payload: a `$serializer` ref to
+ * each serializer a `$serializable` ref resolves to (one per child for an STI base), or the members
+ * of an `anyOf` or `oneOf` (an `anyOf`'s members listed before a sibling `oneOf`'s, not paired with
+ * them), each member that itself has several shapes (a nested `anyOf` or `oneOf`, or a
+ * `$serializable` ref to an STI base) contributing those shapes in its place. An `allOf` beside
+ * the `anyOf` or `oneOf` describes every value, so each shape is that `allOf` with the shape added
+ * to its members. Anything else (a single shape, a ref with `many: true`, or a primitive) has no
+ * variants and returns an empty list. Each shape may be passed back as the `renderedVariant` of
+ * `nullFlattenedOpenapiKeysOfOtherVariants`. The renderer does not read a value's shape from this
+ * list: whatever shape the value takes, it renders every key `nullFlattenedOpenapiKeys` returns.
+ */
+export declare function flattenedOpenapiVariants(openapi: OpenapiSchemaBodyShorthand | OpenapiShorthandPrimitiveTypes): OpenapiSchemaBodyShorthand[];

package/dist/types/src/serializer/helpers/serializersForAssociatedClass.d.ts

@@ -1,9 +1,10 @@
 import Dream from '../../Dream.js';
 import { DreamModelSerializerType, InternalAnyRendersOneOrManyOpts, SimpleObjectSerializerType } from '../../types/serializer.js';
 /**
- * Only used when flatten: true, and the associated object is null, in which case there is no
- * object to resolve a serializer from, but the renderer still needs the serializers whose keys it
- * renders as null in the parent's payload.
+ * Used by every flattened rendersOne render, whether the associated object is present or null: it
+ * lists every serializer the association may render with, whose required keys the renderer renders
+ * as null in the parent's payload, beneath the present object's own keys or alone when the object
+ * is null, where there is no object to resolve a serializer from.
  *
  * Resolves, in order, to the `serializer` option, the serializers of the `dreamClass` or
  * `viewModelClass` option, or the serializers of each class `parentClass` declares the association