@rvoh/dream 2.40.1 → 2.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/dist/cjs/src/Dream.js +3 -2
  2. package/dist/cjs/src/dream/internal/findOrCreateBy.js +2 -3
  3. package/dist/cjs/src/dream/internal/findOrCreateLookupStatement.js +19 -0
  4. package/dist/cjs/src/dream/internal/updateOrCreateBy.js +2 -3
  5. package/dist/cjs/src/dream-app/index.js +17 -10
  6. package/dist/cjs/src/helpers/db/normalizeDataForDb.js +16 -2
  7. package/dist/cjs/src/ops/index.js +7 -3
  8. package/dist/cjs/src/serializer/DreamSerializer.js +15 -9
  9. package/dist/cjs/src/serializer/ObjectSerializer.js +15 -9
  10. package/dist/cjs/src/serializer/SerializerRenderer.js +2 -2
  11. package/dist/cjs/src/serializer/helpers/nullFlattenedSerializerKeys.js +6 -5
  12. package/dist/esm/src/Dream.js +3 -2
  13. package/dist/esm/src/dream/internal/findOrCreateBy.js +2 -3
  14. package/dist/esm/src/dream/internal/findOrCreateLookupStatement.js +19 -0
  15. package/dist/esm/src/dream/internal/updateOrCreateBy.js +2 -3
  16. package/dist/esm/src/dream-app/index.js +17 -10
  17. package/dist/esm/src/helpers/db/normalizeDataForDb.js +16 -2
  18. package/dist/esm/src/ops/index.js +7 -3
  19. package/dist/esm/src/serializer/DreamSerializer.js +15 -9
  20. package/dist/esm/src/serializer/ObjectSerializer.js +15 -9
  21. package/dist/esm/src/serializer/SerializerRenderer.js +2 -2
  22. package/dist/esm/src/serializer/helpers/nullFlattenedSerializerKeys.js +6 -5
  23. package/dist/types/src/dream/internal/findOrCreateLookupStatement.d.ts +14 -0
  24. package/dist/types/src/dream-app/index.d.ts +17 -10
  25. package/dist/types/src/ops/index.d.ts +7 -3
  26. package/dist/types/src/serializer/DreamSerializer.d.ts +15 -9
  27. package/dist/types/src/serializer/ObjectSerializer.d.ts +15 -9
  28. package/dist/types/src/serializer/helpers/nullFlattenedSerializerKeys.d.ts +3 -3
  29. package/dist/types/src/types/associations/shared.d.ts +7 -5
  30. package/dist/types/src/types/types/associations/shared.ts +27 -5
  31. package/docs/classes/db.DreamMigrationHelpers.html +11 -11
  32. package/docs/classes/db.KyselyQueryDriver.html +49 -49
  33. package/docs/classes/db.PostgresQueryDriver.html +49 -49
  34. package/docs/classes/db.QueryDriverBase.html +49 -49
  35. package/docs/classes/errors.CannotSaveMissingDream.html +2 -2
  36. package/docs/classes/errors.CheckConstraintViolation.html +3 -3
  37. package/docs/classes/errors.ColumnOverflow.html +3 -3
  38. package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +3 -3
  39. package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +3 -3
  40. package/docs/classes/errors.DataTypeColumnTypeMismatch.html +3 -3
  41. package/docs/classes/errors.DecryptionError.html +2 -2
  42. package/docs/classes/errors.DecryptionParseError.html +2 -2
  43. package/docs/classes/errors.DecryptionRotationError.html +3 -3
  44. package/docs/classes/errors.GlobalNameNotSet.html +3 -3
  45. package/docs/classes/errors.InvalidCalendarDate.html +2 -2
  46. package/docs/classes/errors.InvalidClockTime.html +2 -2
  47. package/docs/classes/errors.InvalidClockTimeTz.html +2 -2
  48. package/docs/classes/errors.InvalidDateTime.html +2 -2
  49. package/docs/classes/errors.MissingSerializersDefinition.html +3 -3
  50. package/docs/classes/errors.NonLoadedAssociation.html +3 -3
  51. package/docs/classes/errors.NotNullViolation.html +3 -3
  52. package/docs/classes/errors.RecordNotFound.html +3 -3
  53. package/docs/classes/errors.SortableScopeDidNotStabilize.html +3 -3
  54. package/docs/classes/errors.SortableScopeLockWaitTimedOut.html +3 -3
  55. package/docs/classes/errors.ValidationError.html +3 -3
  56. package/docs/classes/index.CalendarDate.html +33 -33
  57. package/docs/classes/index.ClockTime.html +32 -32
  58. package/docs/classes/index.ClockTimeTz.html +35 -35
  59. package/docs/classes/index.DateTime.html +86 -86
  60. package/docs/classes/index.Decorators.html +19 -19
  61. package/docs/classes/index.Dream.html +126 -126
  62. package/docs/classes/index.DreamApp.html +24 -21
  63. package/docs/classes/index.DreamTransaction.html +3 -3
  64. package/docs/classes/index.Env.html +5 -5
  65. package/docs/classes/index.Query.html +65 -65
  66. package/docs/classes/system.CliFileWriter.html +4 -4
  67. package/docs/classes/system.DreamBin.html +3 -3
  68. package/docs/classes/system.DreamCLI.html +7 -7
  69. package/docs/classes/system.DreamImporter.html +2 -2
  70. package/docs/classes/system.DreamLogos.html +2 -2
  71. package/docs/classes/system.DreamSerializerBuilder.html +11 -11
  72. package/docs/classes/system.ObjectSerializerBuilder.html +8 -8
  73. package/docs/classes/system.PathHelpers.html +3 -3
  74. package/docs/classes/utils.Encrypt.html +4 -4
  75. package/docs/classes/utils.Range.html +2 -2
  76. package/docs/functions/db.closeAllDbConnections.html +1 -1
  77. package/docs/functions/db.dreamDbConnections.html +1 -1
  78. package/docs/functions/db.untypedDb.html +1 -1
  79. package/docs/functions/db.validateColumn.html +1 -1
  80. package/docs/functions/db.validateTable.html +1 -1
  81. package/docs/functions/errors.pgErrorType.html +1 -1
  82. package/docs/functions/index.DreamSerializer.html +16 -10
  83. package/docs/functions/index.ObjectSerializer.html +16 -10
  84. package/docs/functions/index.ReplicaSafe.html +1 -1
  85. package/docs/functions/index.STI.html +1 -1
  86. package/docs/functions/index.SoftDelete.html +1 -1
  87. package/docs/functions/utils.camelize.html +1 -1
  88. package/docs/functions/utils.capitalize.html +1 -1
  89. package/docs/functions/utils.cloneDeepSafe.html +1 -1
  90. package/docs/functions/utils.compact.html +1 -1
  91. package/docs/functions/utils.groupBy.html +1 -1
  92. package/docs/functions/utils.hyphenize.html +1 -1
  93. package/docs/functions/utils.intersection.html +1 -1
  94. package/docs/functions/utils.isEmpty.html +1 -1
  95. package/docs/functions/utils.normalizeUnicode.html +1 -1
  96. package/docs/functions/utils.pascalize.html +1 -1
  97. package/docs/functions/utils.percent.html +1 -1
  98. package/docs/functions/utils.range.html +1 -1
  99. package/docs/functions/utils.round.html +1 -1
  100. package/docs/functions/utils.sanitizeString.html +1 -1
  101. package/docs/functions/utils.snakeify.html +1 -1
  102. package/docs/functions/utils.sort.html +1 -1
  103. package/docs/functions/utils.sortBy.html +1 -1
  104. package/docs/functions/utils.sortObjectByKey.html +1 -1
  105. package/docs/functions/utils.sortObjectByValue.html +1 -1
  106. package/docs/functions/utils.uncapitalize.html +1 -1
  107. package/docs/functions/utils.uniq.html +1 -1
  108. package/docs/interfaces/openapi.OpenapiDescription.html +2 -2
  109. package/docs/interfaces/openapi.OpenapiSchemaProperties.html +1 -1
  110. package/docs/interfaces/openapi.OpenapiSchemaPropertiesShorthand.html +1 -1
  111. package/docs/interfaces/openapi.OpenapiTypeFieldObject.html +1 -1
  112. package/docs/interfaces/types.BelongsToStatement.html +2 -2
  113. package/docs/interfaces/types.DecoratorContext.html +2 -2
  114. package/docs/interfaces/types.DecryptCallbacks.html +2 -2
  115. package/docs/interfaces/types.DreamAppInitOptions.html +2 -2
  116. package/docs/interfaces/types.DreamAppOpts.html +2 -2
  117. package/docs/interfaces/types.DreamDbConfig.html +6 -6
  118. package/docs/interfaces/types.DurationObject.html +2 -2
  119. package/docs/interfaces/types.EncryptOptions.html +2 -2
  120. package/docs/interfaces/types.EncryptionLegacyKeyUsedEvent.html +4 -4
  121. package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +2 -2
  122. package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +2 -2
  123. package/docs/interfaces/types.IntrospectedColumn.html +7 -7
  124. package/docs/interfaces/types.IntrospectedDatabase.html +2 -2
  125. package/docs/interfaces/types.IntrospectedEnum.html +2 -2
  126. package/docs/interfaces/types.IntrospectedTable.html +5 -5
  127. package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
  128. package/docs/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
  129. package/docs/types/openapi.OpenapiAllTypes.html +1 -1
  130. package/docs/types/openapi.OpenapiFormats.html +1 -1
  131. package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
  132. package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
  133. package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
  134. package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
  135. package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
  136. package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
  137. package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
  138. package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
  139. package/docs/types/openapi.OpenapiSchemaCombinatorFields.html +1 -1
  140. package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
  141. package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +1 -1
  142. package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +1 -1
  143. package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +1 -1
  144. package/docs/types/openapi.OpenapiSchemaExpressionRef.html +2 -2
  145. package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +2 -2
  146. package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
  147. package/docs/types/openapi.OpenapiSchemaNull.html +2 -2
  148. package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
  149. package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
  150. package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
  151. package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
  152. package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
  153. package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
  154. package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
  155. package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
  156. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +1 -1
  157. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
  158. package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +1 -1
  159. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +2 -2
  160. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +2 -2
  161. package/docs/types/openapi.OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
  162. package/docs/types/openapi.OpenapiSchemaString.html +1 -1
  163. package/docs/types/openapi.OpenapiShorthandAllTypes.html +1 -1
  164. package/docs/types/openapi.OpenapiShorthandPrimitiveBaseTypes.html +1 -1
  165. package/docs/types/openapi.OpenapiShorthandPrimitiveTypes.html +1 -1
  166. package/docs/types/openapi.OpenapiTypeField.html +1 -1
  167. package/docs/types/system.DreamAppAllowedPackageManagersEnum.html +1 -1
  168. package/docs/types/types.CalendarDateDurationUnit.html +1 -1
  169. package/docs/types/types.CalendarDateObject.html +1 -1
  170. package/docs/types/types.Camelized.html +1 -1
  171. package/docs/types/types.ClockTimeObject.html +1 -1
  172. package/docs/types/types.DbConnectionType.html +1 -1
  173. package/docs/types/types.DbTypes.html +1 -1
  174. package/docs/types/types.DreamAssociationMetadata.html +1 -1
  175. package/docs/types/types.DreamAttributes.html +1 -1
  176. package/docs/types/types.DreamClassAssociationAndStatement.html +1 -1
  177. package/docs/types/types.DreamClassColumn.html +1 -1
  178. package/docs/types/types.DreamColumn.html +1 -1
  179. package/docs/types/types.DreamColumnNames.html +1 -1
  180. package/docs/types/types.DreamLogLevel.html +1 -1
  181. package/docs/types/types.DreamLogger.html +2 -2
  182. package/docs/types/types.DreamModelSerializerType.html +1 -1
  183. package/docs/types/types.DreamOrViewModelClassSerializerKey.html +1 -1
  184. package/docs/types/types.DreamOrViewModelSerializerKey.html +1 -1
  185. package/docs/types/types.DreamParamSafeAttributes.html +1 -1
  186. package/docs/types/types.DreamParamSafeColumnNames.html +1 -1
  187. package/docs/types/types.DreamSerializable.html +1 -1
  188. package/docs/types/types.DreamSerializableArray.html +1 -1
  189. package/docs/types/types.DreamSerializerKey.html +1 -1
  190. package/docs/types/types.DreamSerializers.html +1 -1
  191. package/docs/types/types.DreamVirtualColumns.html +1 -1
  192. package/docs/types/types.DurationUnit.html +1 -1
  193. package/docs/types/types.EncryptAlgorithm.html +1 -1
  194. package/docs/types/types.HasManyStatement.html +1 -1
  195. package/docs/types/types.HasOneStatement.html +1 -1
  196. package/docs/types/types.Hyphenized.html +1 -1
  197. package/docs/types/types.IntrospectedValueType.html +1 -1
  198. package/docs/types/types.Pascalized.html +1 -1
  199. package/docs/types/types.PrimaryKeyType.html +1 -1
  200. package/docs/types/types.RoundingPrecision.html +1 -1
  201. package/docs/types/types.SerializerCasing.html +1 -1
  202. package/docs/types/types.SimpleObjectSerializerType.html +1 -1
  203. package/docs/types/types.Snakeified.html +1 -1
  204. package/docs/types/types.StrictInterface.html +1 -1
  205. package/docs/types/types.UpdateableAssociationProperties.html +1 -1
  206. package/docs/types/types.UpdateableProperties.html +1 -1
  207. package/docs/types/types.ValidationType.html +1 -1
  208. package/docs/types/types.ViewModel.html +2 -2
  209. package/docs/types/types.ViewModelClass.html +1 -1
  210. package/docs/types/types.WeekdayName.html +1 -1
  211. package/docs/types/types.WhereStatementForDream.html +1 -1
  212. package/docs/types/types.WhereStatementForDreamClass.html +1 -1
  213. package/docs/variables/index.DreamConst.html +1 -1
  214. package/docs/variables/index.ops.html +8 -4
  215. package/docs/variables/openapi.openapiPrimitiveTypes.html +1 -1
  216. package/docs/variables/openapi.openapiShorthandPrimitiveTypes.html +1 -1
  217. package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
  218. package/docs/variables/system.primaryKeyTypes.html +1 -1
  219. package/package.json +1 -1
@@ -20,6 +20,7 @@ import destroyDream from './dream/internal/destroyDream.js';
20
20
  import { destroyOptions, reallyDestroyOptions, undestroyOptions } from './dream/internal/destroyOptions.js';
21
21
  import ensureSTITypeFieldIsSet from './dream/internal/ensureSTITypeFieldIsSet.js';
22
22
  import findOrCreateBy from './dream/internal/findOrCreateBy.js';
23
+ import findOrCreateLookupStatement from './dream/internal/findOrCreateLookupStatement.js';
23
24
  import mergeSerializerAssociationEdges from './dream/internal/mergeSerializerAssociationEdges.js';
24
25
  import printSerializerHierarchyLevel from './dream/internal/printSerializerHierarchyLevel.js';
25
26
  import reload from './dream/internal/reload.js';
@@ -1288,7 +1289,7 @@ export default class Dream {
1288
1289
  }
1289
1290
  catch (err) {
1290
1291
  if (pgErrorType(err) === UNIQUE_VIOLATION) {
1291
- const dreamModel = await this.findBy(this.extractAttributesFromUpdateableProperties(attributes));
1292
+ const dreamModel = await this.findBy(findOrCreateLookupStatement(this, attributes));
1292
1293
  if (!dreamModel)
1293
1294
  throw new CreateOrFindByFailedToCreateAndFind(this);
1294
1295
  return dreamModel;
@@ -1342,7 +1343,7 @@ export default class Dream {
1342
1343
  }
1343
1344
  catch (err) {
1344
1345
  if (pgErrorType(err) === UNIQUE_VIOLATION) {
1345
- const existingRecord = await this.findBy(this.extractAttributesFromUpdateableProperties(attributes));
1346
+ const existingRecord = await this.findBy(findOrCreateLookupStatement(this, attributes));
1346
1347
  if (!existingRecord)
1347
1348
  throw new CreateOrUpdateByFailedToCreateAndUpdate(this);
1348
1349
  const { with: attrs } = extraOpts;
@@ -1,7 +1,6 @@
1
+ import findOrCreateLookupStatement from './findOrCreateLookupStatement.js';
1
2
  export default async function findOrCreateBy(dreamClass, txn = null, attributes, extraOpts = {}) {
2
- const existingRecord = await dreamClass
3
- .txn(txn)
4
- .findBy(dreamClass['extractAttributesFromUpdateableProperties'](attributes));
3
+ const existingRecord = await dreamClass.txn(txn).findBy(findOrCreateLookupStatement(dreamClass, attributes));
5
4
  if (existingRecord)
6
5
  return existingRecord;
7
6
  const { createWith, skipHooks } = extraOpts;
@@ -0,0 +1,19 @@
1
+ import isDatabaseArrayColumn from '../../helpers/db/types/isDatabaseArrayColumn.js';
2
+ import ops from '../../ops/index.js';
3
+ /**
4
+ * Builds the `findBy` statement that findOrCreateBy, createOrFindBy,
5
+ * updateOrCreateBy and createOrUpdateBy use to look up an existing record.
6
+ * Their attributes are both the lookup and the values to persist, so an array
7
+ * given for an array column is the whole array to store: the lookup compares
8
+ * it with `ops.equal`, matching only a record whose array equals it
9
+ * element-for-element, in order, instead of the `IN` a plain list means in a
10
+ * where clause. PostgreSQL defines no equality operator for `json`, so on a
11
+ * `json[]` column this lookup raises at the database, as `ops.equal` does.
12
+ */
13
+ export default function findOrCreateLookupStatement(dreamClass, attributes) {
14
+ const lookup = dreamClass['extractAttributesFromUpdateableProperties'](attributes);
15
+ return Object.fromEntries(Object.entries(lookup).map(([column, value]) => [
16
+ column,
17
+ Array.isArray(value) && isDatabaseArrayColumn(dreamClass, column) ? ops.equal(value) : value,
18
+ ]));
19
+ }
@@ -1,8 +1,7 @@
1
+ import findOrCreateLookupStatement from './findOrCreateLookupStatement.js';
1
2
  import saveDream from './saveDream.js';
2
3
  export default async function updateOrCreateBy(dreamClass, txn = null, attributes, extraOpts = {}) {
3
- const existingRecord = await dreamClass
4
- .txn(txn)
5
- .findBy(dreamClass['extractAttributesFromUpdateableProperties'](attributes));
4
+ const existingRecord = await dreamClass.txn(txn).findBy(findOrCreateLookupStatement(dreamClass, attributes));
6
5
  const { with: attrs, skipHooks } = extraOpts;
7
6
  if (existingRecord) {
8
7
  existingRecord.assignAttributes(attrs ?? {});
@@ -270,6 +270,16 @@ export default class DreamApp {
270
270
  return this._packageManager;
271
271
  }
272
272
  _importExtension = '.js';
273
+ /**
274
+ * The import suffix the CLI generators write: `.js`, `.ts` or `none`.
275
+ *
276
+ * In a Psychic app, set it in conf/app.ts with
277
+ * `psy.set('importExtension', …)`. Psychic forwards it here, and a different
278
+ * value set in conf/dream.ts throws at boot. In a Dream-only app, set it in
279
+ * conf/dream.ts with `dreamApp.set('importExtension', …)`.
280
+ *
281
+ * Defaults to `.js`.
282
+ */
273
283
  get importExtension() {
274
284
  return this._importExtension;
275
285
  }
@@ -277,20 +287,17 @@ export default class DreamApp {
277
287
  /**
278
288
  * The prefix of the import aliases the CLI generators write: the `@` in
279
289
  * `@models/User.js`, `@serializers/UserSerializer.js` and
280
- * `@spec/factories/UserFactory.js`. Set with
281
- * `dreamApp.set('importAliasPrefix', '#')` to have them write
290
+ * `@spec/factories/UserFactory.js`. Set it to `#` to have them write
282
291
  * `#models/User.js` and so on, which Node resolves as subpath imports
283
292
  * declared under `imports` in the app's package.json.
284
293
  *
285
- * Defaults to `@`. The default becomes `#` in Dream 3; an app that wants
286
- * to keep `@` should set it explicitly with
287
- * `dreamApp.set('importAliasPrefix', '@')`.
294
+ * In a Psychic app, set it in conf/app.ts with
295
+ * `psy.set('importAliasPrefix', '#')`. Psychic forwards it here, and a
296
+ * different value set in conf/dream.ts throws at boot. In a Dream-only app,
297
+ * set it in conf/dream.ts with `dreamApp.set('importAliasPrefix', '#')`.
288
298
  *
289
- * Psychic's resource controller-spec generator still writes its
290
- * `@spec/unit/helpers/authentication.js` import with a literal `@` until
291
- * Psychic reads this setting (planned for 3.17.0), so a Psychic app should
292
- * keep its `@spec` alias, or wait for that release, before switching to
293
- * `#` only.
299
+ * Defaults to `@`. The default becomes `#` in Dream 3; an app that wants
300
+ * to keep `@` should set it to `@` explicitly.
294
301
  */
295
302
  get importAliasPrefix() {
296
303
  return this._importAliasPrefix;
@@ -38,11 +38,18 @@ function normalizedString(_val) {
38
38
  const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map(val => typeof val === 'string' ? normalizeUnicode(val) : val);
39
39
  return alreadyAnArray ? normalizedValueArray : normalizedValueArray[0];
40
40
  }
41
+ /**
42
+ * A value for a date or timestamp column (or an array of them) may be a single
43
+ * value, an array, or, as the `IN` operand against an array column, a list of
44
+ * whole arrays; every nested array is converted element by element.
45
+ */
41
46
  function dateTimeOrDateToSql(dateClass, _val) {
42
47
  const alreadyAnArray = Array.isArray(_val);
43
- const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map(val => {
48
+ const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map((val) => {
44
49
  if (val === null || val === undefined)
45
50
  return val;
51
+ if (Array.isArray(val))
52
+ return dateTimeOrDateToSql(dateClass, val);
46
53
  if (val instanceof DateTime || val instanceof CalendarDate)
47
54
  return val.toSQL();
48
55
  try {
@@ -59,11 +66,18 @@ function dateTimeOrDateToSql(dateClass, _val) {
59
66
  });
60
67
  return alreadyAnArray ? normalizedValueArray : normalizedValueArray[0];
61
68
  }
69
+ /**
70
+ * A value for a time column (or an array of them) may be a single value, an
71
+ * array, or, as the `IN` operand against an array column, a list of whole
72
+ * arrays; every nested array is converted element by element.
73
+ */
62
74
  function clockTimeOrClockTimeTzToSql(clockTimeClass, _val) {
63
75
  const alreadyAnArray = Array.isArray(_val);
64
- const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map(val => {
76
+ const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map((val) => {
65
77
  if (val === null || val === undefined)
66
78
  return val;
79
+ if (Array.isArray(val))
80
+ return clockTimeOrClockTimeTzToSql(clockTimeClass, val);
67
81
  if (val instanceof BaseClockTime)
68
82
  return val.toSQL();
69
83
  try {
@@ -119,9 +119,13 @@ const ops = {
119
119
  *
120
120
  * **Array columns:** passing an array means literal array equality — the
121
121
  * whole array is bound as a single parameter, so the column must match
122
- * element-for-element, in order. This is the opt-in counterpart to a bare
123
- * array in a where clause (`Post.where({ tags: ['a', 'b'] })`), which means
124
- * `IN`, and to `ops.any`, which tests for containment of a single element.
122
+ * element-for-element, in order. The plain value form of a where clause
123
+ * targets regular (scalar) columns, so comparing an array column against an
124
+ * array value goes through `ops`: a flat list against an array column
125
+ * (`Post.where({ tags: ['a', 'b'] })`) is a compile error. A list of whole
126
+ * arrays (`Post.where({ tags: [['a', 'b'], ['c']] })`) means `IN`, matching
127
+ * rows whose column equals any one of them, and `ops.any` tests for
128
+ * containment of a single element.
125
129
  * Element types are constrained by the column, so an enum array column
126
130
  * rejects a string that is not a member of its enum.
127
131
  *
@@ -8,18 +8,24 @@ import DreamSerializerBuilder from './builders/DreamSerializerBuilder.js';
8
8
  * DreamSerializer(User, user).attribute('email').rendersMany('posts')
9
9
  * ```
10
10
  *
11
- * A serializer must not read its data while being built: what it declares may not
12
- * depend on its data. Dream and Psychic build it without data to read its shape (the
13
- * OpenAPI schema, and the keys a flattened association or `customAttribute` that uses
14
- * it renders as `null` where its value does not supply them), so a serializer that
15
- * reads its data while being built throws when a flattened association or
16
- * `customAttribute` that uses it is rendered. Read the data inside a `customAttribute`
17
- * callback, which runs only when the serializer renders, not while it is built.
11
+ * A serializer must not read its data or its passthrough data while being built: what it
12
+ * declares (which keys, under which names, and which associations it renders) may not
13
+ * depend on either. Dream and Psychic build it without data to read its shape (the OpenAPI
14
+ * schema, the associations `preloadFor` loads, and the keys a flattened association or
15
+ * `customAttribute` that uses it renders as `null` where its value does not supply them),
16
+ * and without passthrough data when registering it, preloading and generating OpenAPI. A
17
+ * serializer that reads its data while being built throws when a flattened association or
18
+ * `customAttribute` that uses it is rendered; one that reads its passthrough data is never
19
+ * registered, or renders keys and associations its OpenAPI schema and `preloadFor` do not
20
+ * describe. Read either inside a `customAttribute` callback, which runs only when the
21
+ * serializer renders, not while it is built, and hand passthrough data on to the
22
+ * serializers it renders.
18
23
  *
19
24
  * @param dreamClass - The Dream model class the serializer renders
20
25
  * @param data - The Dream instance to render
21
- * @param passthroughData - Data available to this serializer and passed down to the serializers
22
- * it renders
26
+ * @param passthroughData - Data available to this serializer's callbacks when it renders,
27
+ * and passed down to the serializers it renders. It must not decide what the serializer
28
+ * declares.
23
29
  * @returns The serializer builder for method chaining
24
30
  */
25
31
  export default function DreamSerializer(dreamClass, data, passthroughData) {
@@ -8,17 +8,23 @@ import ObjectSerializerBuilder from './builders/ObjectSerializerBuilder.js';
8
8
  * ObjectSerializer(address).attribute('city', { openapi: 'string' })
9
9
  * ```
10
10
  *
11
- * A serializer must not read its data while being built: what it declares may not
12
- * depend on its data. Dream and Psychic build it without data to read its shape (the
13
- * OpenAPI schema, and the keys a flattened association or `customAttribute` that uses
14
- * it renders as `null` where its value does not supply them), so a serializer that
15
- * reads its data while being built throws when a flattened association or
16
- * `customAttribute` that uses it is rendered. Read the data inside a `customAttribute`
17
- * callback, which runs only when the serializer renders, not while it is built.
11
+ * A serializer must not read its data or its passthrough data while being built: what it
12
+ * declares (which keys, under which names, and which associations it renders) may not
13
+ * depend on either. Dream and Psychic build it without data to read its shape (the OpenAPI
14
+ * schema, the associations `preloadFor` loads, and the keys a flattened association or
15
+ * `customAttribute` that uses it renders as `null` where its value does not supply them),
16
+ * and without passthrough data when registering it, preloading and generating OpenAPI. A
17
+ * serializer that reads its data while being built throws when a flattened association or
18
+ * `customAttribute` that uses it is rendered; one that reads its passthrough data is never
19
+ * registered, or renders keys and associations its OpenAPI schema and `preloadFor` do not
20
+ * describe. Read either inside a `customAttribute` callback, which runs only when the
21
+ * serializer renders, not while it is built, and hand passthrough data on to the
22
+ * serializers it renders.
18
23
  *
19
24
  * @param data - The object to render
20
- * @param passthroughData - Data available to this serializer and passed down to the serializers
21
- * it renders
25
+ * @param passthroughData - Data available to this serializer's callbacks when it renders,
26
+ * and passed down to the serializers it renders. It must not decide what the serializer
27
+ * declares.
22
28
  * @returns The serializer builder for method chaining
23
29
  */
24
30
  export default function ObjectSerializer(data, passthroughData) {
@@ -78,7 +78,7 @@ export default class SerializerRenderer {
78
78
  if (value === undefined && attribute.options?.required === false)
79
79
  return accumulator;
80
80
  if (attribute.options.flatten) {
81
- const flattenOptions = { casing: this.renderOpts.casing, passthroughData };
81
+ const flattenOptions = { casing: this.renderOpts.casing };
82
82
  // a flattened customAttribute's keys are the parent's own keys, cased like them, and
83
83
  // always include each key any shape of its openapi requires: a callback that returns
84
84
  // null or undefined, or a serializer built over null or undefined data (which renders
@@ -130,7 +130,7 @@ export default class SerializerRenderer {
130
130
  // render with (each STI child, each polymorphic target) requires: as null when the
131
131
  // associated object is null, and beneath the rendered serializer's own keys when it is
132
132
  // present, so a required key the rendered serializer leaves out renders as null
133
- ...nullFlattenedSerializerKeys(serializersForAssociatedClass(data instanceof Dream ? data.constructor : null, attribute.name, attribute.options), { casing: this.renderOpts.casing, passthroughData }),
133
+ ...nullFlattenedSerializerKeys(serializersForAssociatedClass(data instanceof Dream ? data.constructor : null, attribute.name, attribute.options), { casing: this.renderOpts.casing }),
134
134
  // passthrough data must be passed both into the serializer and render
135
135
  // because, if the serializer does accept passthrough data, then passing it in is how
136
136
  // it gets into the serializer, but if it does not accept passthrough data, and therefore
@@ -30,8 +30,9 @@ import { serializersForAssociatedClass } from './serializersForAssociatedClass.j
30
30
  * flattens itself, adds nothing, so the walk always terminates; one reached again along another
31
31
  * path is walked again, so each path adds its keys and their requirements.
32
32
  *
33
- * `passthroughData` is handed to each serializer as it is built, as when rendering; outside a
34
- * render it may be left out.
33
+ * Each serializer is built with empty passthrough data, as Psychic's OpenAPI generation builds it,
34
+ * so the keys are the same whatever passthrough data a render carries: what a serializer declares
35
+ * must not depend on its passthrough data.
35
36
  */
36
37
  export function nullFlattenedSerializerKeys(serializers, options = {}) {
37
38
  return nullRequiredKeys(walkSerializers(serializers, newWalk(options)));
@@ -105,8 +106,8 @@ export function flattenedOpenapiVariants(openapi) {
105
106
  const sharedMembers = ('allOf' in openapi && openapi.allOf) || [];
106
107
  return sharedMembers.length ? variants.map(variant => ({ allOf: [...sharedMembers, variant] })) : variants;
107
108
  }
108
- function newWalk({ casing = 'camel', passthroughData = {}, }) {
109
- return { casing, passthroughData, serializersBeingFlattened: new Set() };
109
+ function newWalk({ casing = 'camel' }) {
110
+ return { casing, serializersBeingFlattened: new Set() };
110
111
  }
111
112
  function nullRequiredKeys(requirements) {
112
113
  return Object.keys(requirements).reduce((keys, key) => {
@@ -139,7 +140,7 @@ function walkSerializers(serializers, walk) {
139
140
  if (walk.serializersBeingFlattened.has(serializer))
140
141
  return flattenedKeys;
141
142
  walk.serializersBeingFlattened.add(serializer);
142
- const serializerBuilder = serializer(undefined, walk.passthroughData);
143
+ const serializerBuilder = serializer(undefined, {});
143
144
  const serializerKeys = walkSerializerBuilder(serializerBuilder, walk);
144
145
  walk.serializersBeingFlattened.delete(serializer);
145
146
  return mergeRequirements(flattenedKeys, serializerKeys);
@@ -20,6 +20,7 @@ import destroyDream from './dream/internal/destroyDream.js';
20
20
  import { destroyOptions, reallyDestroyOptions, undestroyOptions } from './dream/internal/destroyOptions.js';
21
21
  import ensureSTITypeFieldIsSet from './dream/internal/ensureSTITypeFieldIsSet.js';
22
22
  import findOrCreateBy from './dream/internal/findOrCreateBy.js';
23
+ import findOrCreateLookupStatement from './dream/internal/findOrCreateLookupStatement.js';
23
24
  import mergeSerializerAssociationEdges from './dream/internal/mergeSerializerAssociationEdges.js';
24
25
  import printSerializerHierarchyLevel from './dream/internal/printSerializerHierarchyLevel.js';
25
26
  import reload from './dream/internal/reload.js';
@@ -1288,7 +1289,7 @@ export default class Dream {
1288
1289
  }
1289
1290
  catch (err) {
1290
1291
  if (pgErrorType(err) === UNIQUE_VIOLATION) {
1291
- const dreamModel = await this.findBy(this.extractAttributesFromUpdateableProperties(attributes));
1292
+ const dreamModel = await this.findBy(findOrCreateLookupStatement(this, attributes));
1292
1293
  if (!dreamModel)
1293
1294
  throw new CreateOrFindByFailedToCreateAndFind(this);
1294
1295
  return dreamModel;
@@ -1342,7 +1343,7 @@ export default class Dream {
1342
1343
  }
1343
1344
  catch (err) {
1344
1345
  if (pgErrorType(err) === UNIQUE_VIOLATION) {
1345
- const existingRecord = await this.findBy(this.extractAttributesFromUpdateableProperties(attributes));
1346
+ const existingRecord = await this.findBy(findOrCreateLookupStatement(this, attributes));
1346
1347
  if (!existingRecord)
1347
1348
  throw new CreateOrUpdateByFailedToCreateAndUpdate(this);
1348
1349
  const { with: attrs } = extraOpts;
@@ -1,7 +1,6 @@
1
+ import findOrCreateLookupStatement from './findOrCreateLookupStatement.js';
1
2
  export default async function findOrCreateBy(dreamClass, txn = null, attributes, extraOpts = {}) {
2
- const existingRecord = await dreamClass
3
- .txn(txn)
4
- .findBy(dreamClass['extractAttributesFromUpdateableProperties'](attributes));
3
+ const existingRecord = await dreamClass.txn(txn).findBy(findOrCreateLookupStatement(dreamClass, attributes));
5
4
  if (existingRecord)
6
5
  return existingRecord;
7
6
  const { createWith, skipHooks } = extraOpts;
@@ -0,0 +1,19 @@
1
+ import isDatabaseArrayColumn from '../../helpers/db/types/isDatabaseArrayColumn.js';
2
+ import ops from '../../ops/index.js';
3
+ /**
4
+ * Builds the `findBy` statement that findOrCreateBy, createOrFindBy,
5
+ * updateOrCreateBy and createOrUpdateBy use to look up an existing record.
6
+ * Their attributes are both the lookup and the values to persist, so an array
7
+ * given for an array column is the whole array to store: the lookup compares
8
+ * it with `ops.equal`, matching only a record whose array equals it
9
+ * element-for-element, in order, instead of the `IN` a plain list means in a
10
+ * where clause. PostgreSQL defines no equality operator for `json`, so on a
11
+ * `json[]` column this lookup raises at the database, as `ops.equal` does.
12
+ */
13
+ export default function findOrCreateLookupStatement(dreamClass, attributes) {
14
+ const lookup = dreamClass['extractAttributesFromUpdateableProperties'](attributes);
15
+ return Object.fromEntries(Object.entries(lookup).map(([column, value]) => [
16
+ column,
17
+ Array.isArray(value) && isDatabaseArrayColumn(dreamClass, column) ? ops.equal(value) : value,
18
+ ]));
19
+ }
@@ -1,8 +1,7 @@
1
+ import findOrCreateLookupStatement from './findOrCreateLookupStatement.js';
1
2
  import saveDream from './saveDream.js';
2
3
  export default async function updateOrCreateBy(dreamClass, txn = null, attributes, extraOpts = {}) {
3
- const existingRecord = await dreamClass
4
- .txn(txn)
5
- .findBy(dreamClass['extractAttributesFromUpdateableProperties'](attributes));
4
+ const existingRecord = await dreamClass.txn(txn).findBy(findOrCreateLookupStatement(dreamClass, attributes));
6
5
  const { with: attrs, skipHooks } = extraOpts;
7
6
  if (existingRecord) {
8
7
  existingRecord.assignAttributes(attrs ?? {});
@@ -270,6 +270,16 @@ export default class DreamApp {
270
270
  return this._packageManager;
271
271
  }
272
272
  _importExtension = '.js';
273
+ /**
274
+ * The import suffix the CLI generators write: `.js`, `.ts` or `none`.
275
+ *
276
+ * In a Psychic app, set it in conf/app.ts with
277
+ * `psy.set('importExtension', …)`. Psychic forwards it here, and a different
278
+ * value set in conf/dream.ts throws at boot. In a Dream-only app, set it in
279
+ * conf/dream.ts with `dreamApp.set('importExtension', …)`.
280
+ *
281
+ * Defaults to `.js`.
282
+ */
273
283
  get importExtension() {
274
284
  return this._importExtension;
275
285
  }
@@ -277,20 +287,17 @@ export default class DreamApp {
277
287
  /**
278
288
  * The prefix of the import aliases the CLI generators write: the `@` in
279
289
  * `@models/User.js`, `@serializers/UserSerializer.js` and
280
- * `@spec/factories/UserFactory.js`. Set with
281
- * `dreamApp.set('importAliasPrefix', '#')` to have them write
290
+ * `@spec/factories/UserFactory.js`. Set it to `#` to have them write
282
291
  * `#models/User.js` and so on, which Node resolves as subpath imports
283
292
  * declared under `imports` in the app's package.json.
284
293
  *
285
- * Defaults to `@`. The default becomes `#` in Dream 3; an app that wants
286
- * to keep `@` should set it explicitly with
287
- * `dreamApp.set('importAliasPrefix', '@')`.
294
+ * In a Psychic app, set it in conf/app.ts with
295
+ * `psy.set('importAliasPrefix', '#')`. Psychic forwards it here, and a
296
+ * different value set in conf/dream.ts throws at boot. In a Dream-only app,
297
+ * set it in conf/dream.ts with `dreamApp.set('importAliasPrefix', '#')`.
288
298
  *
289
- * Psychic's resource controller-spec generator still writes its
290
- * `@spec/unit/helpers/authentication.js` import with a literal `@` until
291
- * Psychic reads this setting (planned for 3.17.0), so a Psychic app should
292
- * keep its `@spec` alias, or wait for that release, before switching to
293
- * `#` only.
299
+ * Defaults to `@`. The default becomes `#` in Dream 3; an app that wants
300
+ * to keep `@` should set it to `@` explicitly.
294
301
  */
295
302
  get importAliasPrefix() {
296
303
  return this._importAliasPrefix;
@@ -38,11 +38,18 @@ function normalizedString(_val) {
38
38
  const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map(val => typeof val === 'string' ? normalizeUnicode(val) : val);
39
39
  return alreadyAnArray ? normalizedValueArray : normalizedValueArray[0];
40
40
  }
41
+ /**
42
+ * A value for a date or timestamp column (or an array of them) may be a single
43
+ * value, an array, or, as the `IN` operand against an array column, a list of
44
+ * whole arrays; every nested array is converted element by element.
45
+ */
41
46
  function dateTimeOrDateToSql(dateClass, _val) {
42
47
  const alreadyAnArray = Array.isArray(_val);
43
- const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map(val => {
48
+ const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map((val) => {
44
49
  if (val === null || val === undefined)
45
50
  return val;
51
+ if (Array.isArray(val))
52
+ return dateTimeOrDateToSql(dateClass, val);
46
53
  if (val instanceof DateTime || val instanceof CalendarDate)
47
54
  return val.toSQL();
48
55
  try {
@@ -59,11 +66,18 @@ function dateTimeOrDateToSql(dateClass, _val) {
59
66
  });
60
67
  return alreadyAnArray ? normalizedValueArray : normalizedValueArray[0];
61
68
  }
69
+ /**
70
+ * A value for a time column (or an array of them) may be a single value, an
71
+ * array, or, as the `IN` operand against an array column, a list of whole
72
+ * arrays; every nested array is converted element by element.
73
+ */
62
74
  function clockTimeOrClockTimeTzToSql(clockTimeClass, _val) {
63
75
  const alreadyAnArray = Array.isArray(_val);
64
- const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map(val => {
76
+ const normalizedValueArray = (alreadyAnArray ? _val : [_val]).map((val) => {
65
77
  if (val === null || val === undefined)
66
78
  return val;
79
+ if (Array.isArray(val))
80
+ return clockTimeOrClockTimeTzToSql(clockTimeClass, val);
67
81
  if (val instanceof BaseClockTime)
68
82
  return val.toSQL();
69
83
  try {
@@ -119,9 +119,13 @@ const ops = {
119
119
  *
120
120
  * **Array columns:** passing an array means literal array equality — the
121
121
  * whole array is bound as a single parameter, so the column must match
122
- * element-for-element, in order. This is the opt-in counterpart to a bare
123
- * array in a where clause (`Post.where({ tags: ['a', 'b'] })`), which means
124
- * `IN`, and to `ops.any`, which tests for containment of a single element.
122
+ * element-for-element, in order. The plain value form of a where clause
123
+ * targets regular (scalar) columns, so comparing an array column against an
124
+ * array value goes through `ops`: a flat list against an array column
125
+ * (`Post.where({ tags: ['a', 'b'] })`) is a compile error. A list of whole
126
+ * arrays (`Post.where({ tags: [['a', 'b'], ['c']] })`) means `IN`, matching
127
+ * rows whose column equals any one of them, and `ops.any` tests for
128
+ * containment of a single element.
125
129
  * Element types are constrained by the column, so an enum array column
126
130
  * rejects a string that is not a member of its enum.
127
131
  *
@@ -8,18 +8,24 @@ import DreamSerializerBuilder from './builders/DreamSerializerBuilder.js';
8
8
  * DreamSerializer(User, user).attribute('email').rendersMany('posts')
9
9
  * ```
10
10
  *
11
- * A serializer must not read its data while being built: what it declares may not
12
- * depend on its data. Dream and Psychic build it without data to read its shape (the
13
- * OpenAPI schema, and the keys a flattened association or `customAttribute` that uses
14
- * it renders as `null` where its value does not supply them), so a serializer that
15
- * reads its data while being built throws when a flattened association or
16
- * `customAttribute` that uses it is rendered. Read the data inside a `customAttribute`
17
- * callback, which runs only when the serializer renders, not while it is built.
11
+ * A serializer must not read its data or its passthrough data while being built: what it
12
+ * declares (which keys, under which names, and which associations it renders) may not
13
+ * depend on either. Dream and Psychic build it without data to read its shape (the OpenAPI
14
+ * schema, the associations `preloadFor` loads, and the keys a flattened association or
15
+ * `customAttribute` that uses it renders as `null` where its value does not supply them),
16
+ * and without passthrough data when registering it, preloading and generating OpenAPI. A
17
+ * serializer that reads its data while being built throws when a flattened association or
18
+ * `customAttribute` that uses it is rendered; one that reads its passthrough data is never
19
+ * registered, or renders keys and associations its OpenAPI schema and `preloadFor` do not
20
+ * describe. Read either inside a `customAttribute` callback, which runs only when the
21
+ * serializer renders, not while it is built, and hand passthrough data on to the
22
+ * serializers it renders.
18
23
  *
19
24
  * @param dreamClass - The Dream model class the serializer renders
20
25
  * @param data - The Dream instance to render
21
- * @param passthroughData - Data available to this serializer and passed down to the serializers
22
- * it renders
26
+ * @param passthroughData - Data available to this serializer's callbacks when it renders,
27
+ * and passed down to the serializers it renders. It must not decide what the serializer
28
+ * declares.
23
29
  * @returns The serializer builder for method chaining
24
30
  */
25
31
  export default function DreamSerializer(dreamClass, data, passthroughData) {
@@ -8,17 +8,23 @@ import ObjectSerializerBuilder from './builders/ObjectSerializerBuilder.js';
8
8
  * ObjectSerializer(address).attribute('city', { openapi: 'string' })
9
9
  * ```
10
10
  *
11
- * A serializer must not read its data while being built: what it declares may not
12
- * depend on its data. Dream and Psychic build it without data to read its shape (the
13
- * OpenAPI schema, and the keys a flattened association or `customAttribute` that uses
14
- * it renders as `null` where its value does not supply them), so a serializer that
15
- * reads its data while being built throws when a flattened association or
16
- * `customAttribute` that uses it is rendered. Read the data inside a `customAttribute`
17
- * callback, which runs only when the serializer renders, not while it is built.
11
+ * A serializer must not read its data or its passthrough data while being built: what it
12
+ * declares (which keys, under which names, and which associations it renders) may not
13
+ * depend on either. Dream and Psychic build it without data to read its shape (the OpenAPI
14
+ * schema, the associations `preloadFor` loads, and the keys a flattened association or
15
+ * `customAttribute` that uses it renders as `null` where its value does not supply them),
16
+ * and without passthrough data when registering it, preloading and generating OpenAPI. A
17
+ * serializer that reads its data while being built throws when a flattened association or
18
+ * `customAttribute` that uses it is rendered; one that reads its passthrough data is never
19
+ * registered, or renders keys and associations its OpenAPI schema and `preloadFor` do not
20
+ * describe. Read either inside a `customAttribute` callback, which runs only when the
21
+ * serializer renders, not while it is built, and hand passthrough data on to the
22
+ * serializers it renders.
18
23
  *
19
24
  * @param data - The object to render
20
- * @param passthroughData - Data available to this serializer and passed down to the serializers
21
- * it renders
25
+ * @param passthroughData - Data available to this serializer's callbacks when it renders,
26
+ * and passed down to the serializers it renders. It must not decide what the serializer
27
+ * declares.
22
28
  * @returns The serializer builder for method chaining
23
29
  */
24
30
  export default function ObjectSerializer(data, passthroughData) {
@@ -78,7 +78,7 @@ export default class SerializerRenderer {
78
78
  if (value === undefined && attribute.options?.required === false)
79
79
  return accumulator;
80
80
  if (attribute.options.flatten) {
81
- const flattenOptions = { casing: this.renderOpts.casing, passthroughData };
81
+ const flattenOptions = { casing: this.renderOpts.casing };
82
82
  // a flattened customAttribute's keys are the parent's own keys, cased like them, and
83
83
  // always include each key any shape of its openapi requires: a callback that returns
84
84
  // null or undefined, or a serializer built over null or undefined data (which renders
@@ -130,7 +130,7 @@ export default class SerializerRenderer {
130
130
  // render with (each STI child, each polymorphic target) requires: as null when the
131
131
  // associated object is null, and beneath the rendered serializer's own keys when it is
132
132
  // present, so a required key the rendered serializer leaves out renders as null
133
- ...nullFlattenedSerializerKeys(serializersForAssociatedClass(data instanceof Dream ? data.constructor : null, attribute.name, attribute.options), { casing: this.renderOpts.casing, passthroughData }),
133
+ ...nullFlattenedSerializerKeys(serializersForAssociatedClass(data instanceof Dream ? data.constructor : null, attribute.name, attribute.options), { casing: this.renderOpts.casing }),
134
134
  // passthrough data must be passed both into the serializer and render
135
135
  // because, if the serializer does accept passthrough data, then passing it in is how
136
136
  // it gets into the serializer, but if it does not accept passthrough data, and therefore
@@ -30,8 +30,9 @@ import { serializersForAssociatedClass } from './serializersForAssociatedClass.j
30
30
  * flattens itself, adds nothing, so the walk always terminates; one reached again along another
31
31
  * path is walked again, so each path adds its keys and their requirements.
32
32
  *
33
- * `passthroughData` is handed to each serializer as it is built, as when rendering; outside a
34
- * render it may be left out.
33
+ * Each serializer is built with empty passthrough data, as Psychic's OpenAPI generation builds it,
34
+ * so the keys are the same whatever passthrough data a render carries: what a serializer declares
35
+ * must not depend on its passthrough data.
35
36
  */
36
37
  export function nullFlattenedSerializerKeys(serializers, options = {}) {
37
38
  return nullRequiredKeys(walkSerializers(serializers, newWalk(options)));
@@ -105,8 +106,8 @@ export function flattenedOpenapiVariants(openapi) {
105
106
  const sharedMembers = ('allOf' in openapi && openapi.allOf) || [];
106
107
  return sharedMembers.length ? variants.map(variant => ({ allOf: [...sharedMembers, variant] })) : variants;
107
108
  }
108
- function newWalk({ casing = 'camel', passthroughData = {}, }) {
109
- return { casing, passthroughData, serializersBeingFlattened: new Set() };
109
+ function newWalk({ casing = 'camel' }) {
110
+ return { casing, serializersBeingFlattened: new Set() };
110
111
  }
111
112
  function nullRequiredKeys(requirements) {
112
113
  return Object.keys(requirements).reduce((keys, key) => {
@@ -139,7 +140,7 @@ function walkSerializers(serializers, walk) {
139
140
  if (walk.serializersBeingFlattened.has(serializer))
140
141
  return flattenedKeys;
141
142
  walk.serializersBeingFlattened.add(serializer);
142
- const serializerBuilder = serializer(undefined, walk.passthroughData);
143
+ const serializerBuilder = serializer(undefined, {});
143
144
  const serializerKeys = walkSerializerBuilder(serializerBuilder, walk);
144
145
  walk.serializersBeingFlattened.delete(serializer);
145
146
  return mergeRequirements(flattenedKeys, serializerKeys);