@rvoh/dream 2.37.0 → 2.39.0

package/dist/cjs/src/dream-app/index.js

@@ -19,6 +19,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 BaseClockTime from '../utils/datetime/BaseClockTime.js';
 import CalendarDate from '../utils/datetime/CalendarDate.js';
@@ -103,6 +104,11 @@ export default class DreamApp {
             inferSerializerFromDreamOrViewModel,
             inferSerializersFromDreamClassOrViewModelClass,
             isDreamSerializer,
+            nullFlattenedSerializerKeys,
+            nullFlattenedSerializerKeysOfOtherVariants,
+            nullFlattenedOpenapiKeys,
+            nullFlattenedOpenapiKeysOfOtherVariants,
+            flattenedOpenapiVariants,
             serializerNameFromFullyQualifiedModelName,
             autogeneratedFileDisclaimer,
         };

package/dist/cjs/src/serializer/DreamSerializer.js

@@ -1,4 +1,27 @@
 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, data, passthroughData) {
     return new DreamSerializerBuilder(dreamClass, data, passthroughData);
 }

package/dist/cjs/src/serializer/ObjectSerializer.js

@@ -1,4 +1,26 @@
 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(data, passthroughData) {
     return new ObjectSerializerBuilder(data, passthroughData);
 }

package/dist/cjs/src/serializer/SerializerRenderer.js

@@ -9,6 +9,7 @@ import { DateTime } from '../utils/datetime/DateTime.js';
 import DreamSerializerBuilder from './builders/DreamSerializerBuilder.js';
 import ObjectSerializerBuilder from './builders/ObjectSerializerBuilder.js';
 import inferSerializerFromDreamOrViewModel from './helpers/inferSerializerFromDreamOrViewModel.js';
+import { nullFlattenedOpenapiKeys, nullFlattenedSerializerKeys, } from './helpers/nullFlattenedSerializerKeys.js';
 import { serializersForAssociatedClass } from './helpers/serializersForAssociatedClass.js';
 export default class SerializerRenderer {
     serializerBuilder;
@@ -77,9 +78,28 @@ export default class SerializerRenderer {
                     if (value === undefined && attribute.options?.required === false)
                         return accumulator;
                     if (attribute.options.flatten) {
+                        const flattenOptions = { casing: this.renderOpts.casing, passthroughData };
+                        // a flattened customAttribute's keys are the parent's own keys, cased like them, and
+                        // always include each key any shape of its openapi requires: a callback that returns
+                        // null or undefined, or a serializer built over null or undefined data (which renders
+                        // null), renders each of them as null, as a null flattened rendersOne does, and a
+                        // present value renders its own keys over them, so a required key it leaves out is null
+                        const valueIsSerializerBuilder = value instanceof DreamSerializerBuilder || value instanceof ObjectSerializerBuilder;
+                        const valueRendersNull = value === null ||
+                            value === undefined ||
+                            (valueIsSerializerBuilder &&
+                                (value['data'] ?? null) === null);
+                        const nullRequiredKeys = nullFlattenedOpenapiKeys(attribute.options.openapi, flattenOptions);
+                        if (valueRendersNull)
+                            return { ...accumulator, ...nullRequiredKeys };
+                        const renderedValue = applyRenderingOptionsToAttribute(null, value, attribute.name, {}, this.passthroughData, this.renderOpts);
                         return {
                             ...accumulator,
-                            ...applyRenderingOptionsToAttribute(null, value, attribute.name, {}, this.passthroughData, this.renderOpts),
+                            ...nullRequiredKeys,
+                            // a returned serializer renders its keys in the render's casing; a returned plain
+                            // object's top-level keys are cased here, its nested values left as returned, and a
+                            // key it sets to undefined is skipped, so a required key renders null beneath it
+                            ...(valueIsSerializerBuilder ? renderedValue : this.setCaseOfDefinedKeys(renderedValue)),
                         };
                     }
                     else {
@@ -96,12 +116,6 @@ export default class SerializerRenderer {
                 case 'rendersOne': {
                     const outputAttributeName = this.setCase(attribute.options.as ?? attribute.name);
                     const associatedObject = data[attribute.name];
-                    if (!associatedObject && attribute.options.flatten) {
-                        return {
-                            ...accumulator,
-                            ...this.nullFlattenedAttributes(serializersForAssociatedClass(data instanceof Dream ? data.constructor : null, attribute.name, attribute.options), passthroughData),
-                        };
-                    }
                     const serializer = associatedObject
                         ? serializerForAssociatedObject(associatedObject, attribute.options, renderTimeResolutionContext(attribute.options, 'rendersOne', attribute.name))
                         : null;
@@ -112,6 +126,11 @@ export default class SerializerRenderer {
                     if (attribute.options.flatten) {
                         return {
                             ...accumulator,
+                            // a flattened rendersOne always renders each key any serializer the association may
+                            // render with (each STI child, each polymorphic target) requires: as null when the
+                            // associated object is null, and beneath the rendered serializer's own keys when it is
+                            // present, so a required key the rendered serializer leaves out renders as null
+                            ...nullFlattenedSerializerKeys(serializersForAssociatedClass(data instanceof Dream ? data.constructor : null, attribute.name, attribute.options), { casing: this.renderOpts.casing, passthroughData }),
                             // passthrough data must be passed both into the serializer and render
                             // because, if the serializer does accept passthrough data, then passing it in is how
                             // it gets into the serializer, but if it does not accept passthrough data, and therefore
@@ -176,58 +195,14 @@ export default class SerializerRenderer {
         }, renderedAttributes);
         return renderedAttributes;
     }
-    /**
-     * 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.
-     */
-    nullFlattenedAttributes(serializers, passthroughData, serializersBeingFlattened = new Set()) {
-        return serializers.reduce((flattenedKeys, serializer) => {
-            // a serializer reached again, e.g. one that flattens itself directly or through others, or
-            // one that two polymorphic targets or two STI children both flatten, adds no keys the first
-            // walk through it did not
-            if (serializersBeingFlattened.has(serializer))
-                return flattenedKeys;
-            serializersBeingFlattened.add(serializer);
-            const serializerBuilder = serializer(undefined, passthroughData);
-            const dreamClass = serializerBuilder instanceof DreamSerializerBuilder
-                ? serializerBuilder['$typeForOpenapi']
-                : null;
-            return serializerBuilder['attributes'].reduce((keys, attribute) => {
-                const attributeType = attribute.type;
-                switch (attributeType) {
-                    case 'attribute':
-                    case 'delegatedAttribute':
-                    case 'rendersMany':
-                        keys[this.setCase(attribute.options?.as ?? attribute.name)] = null;
-                        return keys;
-                    case 'customAttribute':
-                        if (!attribute.options.flatten)
-                            keys[this.setCase(attribute.name)] = null;
-                        return keys;
-                    case 'rendersOne':
-                        if (!attribute.options.flatten) {
-                            keys[this.setCase(attribute.options.as ?? attribute.name)] = null;
-                            return keys;
-                        }
-                        return {
-                            ...keys,
-                            ...this.nullFlattenedAttributes(serializersForAssociatedClass(dreamClass, attribute.name, attribute.options), passthroughData, serializersBeingFlattened),
-                        };
-                    default: {
-                        // protection so that if a new ValidationType is ever added, this will throw a type error at build time
-                        const _never = attributeType;
-                        throw new Error(`Unhandled serializer attribute type: ${_never}`);
-                    }
-                }
-            }, flattenedKeys);
+    setCaseOfDefinedKeys(value) {
+        if (typeof value !== 'object' || value === null || Array.isArray(value))
+            return value;
+        return Object.keys(value).reduce((casedValue, key) => {
+            const keyValue = value[key];
+            if (keyValue !== undefined)
+                casedValue[this.setCase(key)] = keyValue;
+            return casedValue;
         }, {});
     }
     setCase(attr) {

package/dist/cjs/src/serializer/builders/DreamSerializerBuilder.js

@@ -110,15 +110,29 @@ export default class DreamSerializerBuilder {
      *   - `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
@@ -168,14 +182,29 @@ export default class DreamSerializerBuilder {
      *     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

package/dist/cjs/src/serializer/builders/ObjectSerializerBuilder.js

@@ -146,15 +146,29 @@ export default class ObjectSerializerBuilder {
      *   - `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
@@ -204,14 +218,27 @@ export default class ObjectSerializerBuilder {
      *     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

package/dist/cjs/src/serializer/helpers/nullFlattenedSerializerKeys.js

@@ -0,0 +1,233 @@
+import snakeify from '../../helpers/snakeify.js';
+import DreamSerializerBuilder from '../builders/DreamSerializerBuilder.js';
+import { inferSerializersFromDreamClassOrViewModelClass } from './inferSerializerFromDreamOrViewModel.js';
+import { serializersForAssociatedClass } from './serializersForAssociatedClass.js';
+/**
+ * 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 function nullFlattenedSerializerKeys(serializers, options = {}) {
+    return nullRequiredKeys(walkSerializers(serializers, newWalk(options)));
+}
+/**
+ * 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 function nullFlattenedOpenapiKeys(openapi, options = {}) {
+    return nullRequiredKeys(walkOpenapi(openapi, newWalk(options)));
+}
+/**
+ * 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 function nullFlattenedSerializerKeysOfOtherVariants(serializers, renderedSerializer, options = {}) {
+    return nullKeysRequiredByOthers(walkSerializers(serializers, newWalk(options)), Object.keys(walkSerializers([renderedSerializer], newWalk(options))));
+}
+/**
+ * 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 function nullFlattenedOpenapiKeysOfOtherVariants(openapi, renderedVariant, options = {}) {
+    return nullKeysRequiredByOthers(walkOpenapi(openapi, newWalk(options)), Object.keys(walkOpenapi(renderedVariant, newWalk(options))));
+}
+/**
+ * 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 function flattenedOpenapiVariants(openapi) {
+    if (typeof openapi !== 'object' || Array.isArray(openapi))
+        return [];
+    if ('$serializable' in openapi)
+        return openapi.many
+            ? []
+            : inferSerializersFromDreamClassOrViewModelClass(openapi.$serializable, openapi.$serializableSerializerKey ?? openapi.key).map(serializer => ({ $serializer: serializer }));
+    const variants = [
+        ...(('anyOf' in openapi && openapi.anyOf) || []),
+        ...(('oneOf' in openapi && openapi.oneOf) || []),
+    ].flatMap(member => {
+        const memberVariants = flattenedOpenapiVariants(member);
+        return memberVariants.length > 1 ? memberVariants : [member];
+    });
+    const sharedMembers = ('allOf' in openapi && openapi.allOf) || [];
+    return sharedMembers.length ? variants.map(variant => ({ allOf: [...sharedMembers, variant] })) : variants;
+}
+function newWalk({ casing = 'camel', passthroughData = {}, }) {
+    return { casing, passthroughData, serializersBeingFlattened: new Set() };
+}
+function nullRequiredKeys(requirements) {
+    return Object.keys(requirements).reduce((keys, key) => {
+        if (requirements[key])
+            keys[key] = null;
+        return keys;
+    }, {});
+}
+function nullKeysRequiredByOthers(requirements, renderedKeys) {
+    return Object.keys(requirements).reduce((keys, key) => {
+        if (requirements[key] && !renderedKeys.includes(key))
+            keys[key] = null;
+        return keys;
+    }, {});
+}
+/**
+ * A key is required when any of its declarations requires it.
+ */
+function mergeRequirements(requirements, other) {
+    Object.keys(other).forEach(key => {
+        requirements[key] = (requirements[key] ?? false) || other[key];
+    });
+    return requirements;
+}
+function walkSerializers(serializers, walk) {
+    return serializers.reduce((flattenedKeys, serializer) => {
+        // a serializer that flattens itself, directly or through others, adds no keys its walk in
+        // progress does not; one reached again along another path is walked again, since a path that
+        // requires its keys must not lose them to an earlier path that left them optional
+        if (walk.serializersBeingFlattened.has(serializer))
+            return flattenedKeys;
+        walk.serializersBeingFlattened.add(serializer);
+        const serializerBuilder = serializer(undefined, walk.passthroughData);
+        const serializerKeys = walkSerializerBuilder(serializerBuilder, walk);
+        walk.serializersBeingFlattened.delete(serializer);
+        return mergeRequirements(flattenedKeys, serializerKeys);
+    }, {});
+}
+function walkSerializerBuilder(serializerBuilder, walk) {
+    const dreamClass = serializerBuilder instanceof DreamSerializerBuilder
+        ? serializerBuilder['$typeForOpenapi']
+        : null;
+    return serializerBuilder['attributes'].reduce((keys, attribute) => {
+        const attributeType = attribute.type;
+        switch (attributeType) {
+            case 'attribute':
+            case 'delegatedAttribute':
+                return mergeRequirements(keys, {
+                    [setCase(attribute.options?.as ?? attribute.name, walk.casing)]: attribute.options?.required !== false,
+                });
+            case 'rendersMany':
+                return mergeRequirements(keys, {
+                    [setCase(attribute.options?.as ?? attribute.name, walk.casing)]: true,
+                });
+            case 'customAttribute': {
+                if (!attribute.options.flatten)
+                    return mergeRequirements(keys, {
+                        [setCase(attribute.name, walk.casing)]: attribute.options.required !== false,
+                    });
+                const flattenedKeys = walkOpenapi(attribute.options.openapi, walk);
+                // a callback that may return undefined with `required: false` adds none of its keys
+                if (attribute.options.required === false)
+                    Object.keys(flattenedKeys).forEach(key => (flattenedKeys[key] = false));
+                return mergeRequirements(keys, flattenedKeys);
+            }
+            case 'rendersOne':
+                if (!attribute.options.flatten)
+                    return mergeRequirements(keys, {
+                        [setCase(attribute.options.as ?? attribute.name, walk.casing)]: true,
+                    });
+                return mergeRequirements(keys, walkSerializers(serializersForAssociatedClass(dreamClass, attribute.name, attribute.options), walk));
+            default: {
+                // protection so that if a new ValidationType is ever added, this will throw a type error at build time
+                const _never = attributeType;
+                throw new Error(`Unhandled serializer attribute type: ${_never}`);
+            }
+        }
+    }, {});
+}
+function walkOpenapi(openapi, walk) {
+    if (typeof openapi !== 'object' || Array.isArray(openapi))
+        return {};
+    if ('$serializer' in openapi) {
+        if (openapi.many)
+            return {};
+        return walkSerializers([openapi.$serializer], walk);
+    }
+    if ('$serializable' in openapi) {
+        if (openapi.many)
+            return {};
+        return walkSerializers(inferSerializersFromDreamClassOrViewModelClass(openapi.$serializable, openapi.$serializableSerializerKey ?? openapi.key), walk);
+    }
+    const keys = Object.keys(('properties' in openapi && openapi.properties) || {}).reduce((propertyKeys, key) => {
+        propertyKeys[setCase(key, walk.casing)] = false;
+        return propertyKeys;
+    }, {});
+    const members = [
+        ...(('allOf' in openapi && openapi.allOf) || []),
+        ...(('anyOf' in openapi && openapi.anyOf) || []),
+        ...(('oneOf' in openapi && openapi.oneOf) || []),
+    ];
+    const shapeKeys = members.reduce((keys, member) => mergeRequirements(keys, walkOpenapi(member, walk)), keys);
+    // the shape's own `required` array requires a key its `properties` declare or a member declares
+    const requiredKeys = ('required' in openapi && openapi.required) || [];
+    requiredKeys.forEach(key => {
+        const casedKey = setCase(key, walk.casing);
+        if (Object.prototype.hasOwnProperty.call(shapeKeys, casedKey))
+            shapeKeys[casedKey] = true;
+    });
+    return shapeKeys;
+}
+function setCase(attr, casing) {
+    switch (casing) {
+        case 'camel':
+            return attr;
+        case 'snake':
+            return snakeify(attr);
+        default: {
+            // protection so that if a new Casing is ever added, this will throw a type error at build time
+            const _never = casing;
+            throw new Error(`Unhandled Casing: ${_never}`);
+        }
+    }
+}

package/dist/cjs/src/serializer/helpers/serializersForAssociatedClass.js

@@ -1,9 +1,10 @@
 import uniq from '../../helpers/uniq.js';
 import { inferSerializersFromDreamClassOrViewModelClass } from './inferSerializerFromDreamOrViewModel.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