@rvoh/dream 0.45.2 → 0.45.4

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 (184) hide show
  1. package/dist/cjs/src/Dream.js +1 -1
  2. package/dist/cjs/src/cli/index.js +20 -10
  3. package/dist/cjs/src/helpers/cli/generateDream.js +1 -1
  4. package/dist/cjs/src/helpers/cli/generateFactoryContent.js +13 -1
  5. package/dist/cjs/src/helpers/cli/generateMigrationContent.js +1 -0
  6. package/dist/cjs/src/helpers/cli/generateSerializerContent.js +2 -2
  7. package/dist/esm/src/Dream.js +1 -1
  8. package/dist/esm/src/cli/index.js +20 -10
  9. package/dist/esm/src/helpers/cli/generateDream.js +1 -1
  10. package/dist/esm/src/helpers/cli/generateFactoryContent.js +13 -1
  11. package/dist/esm/src/helpers/cli/generateMigrationContent.js +1 -1
  12. package/dist/esm/src/helpers/cli/generateSerializerContent.js +2 -2
  13. package/dist/types/src/helpers/cli/generateMigrationContent.d.ts +1 -0
  14. package/dist/types/src/types/serializer.d.ts +1 -1
  15. package/dist/types/src/types/serializer.ts +1 -5
  16. package/docs/classes/Benchmark.html +2 -2
  17. package/docs/classes/CalendarDate.html +2 -2
  18. package/docs/classes/CreateOrFindByFailedToCreateAndFind.html +3 -3
  19. package/docs/classes/Decorators.html +19 -19
  20. package/docs/classes/Dream.html +136 -136
  21. package/docs/classes/DreamApp.html +4 -4
  22. package/docs/classes/DreamBin.html +2 -2
  23. package/docs/classes/DreamCLI.html +4 -4
  24. package/docs/classes/DreamImporter.html +2 -2
  25. package/docs/classes/DreamLogos.html +2 -2
  26. package/docs/classes/DreamMigrationHelpers.html +7 -7
  27. package/docs/classes/DreamSerializerBuilder.html +8 -8
  28. package/docs/classes/DreamTransaction.html +2 -2
  29. package/docs/classes/Encrypt.html +2 -2
  30. package/docs/classes/Env.html +2 -2
  31. package/docs/classes/GlobalNameNotSet.html +3 -3
  32. package/docs/classes/NonLoadedAssociation.html +3 -3
  33. package/docs/classes/ObjectSerializerBuilder.html +8 -8
  34. package/docs/classes/Query.html +60 -60
  35. package/docs/classes/Range.html +2 -2
  36. package/docs/classes/RecordNotFound.html +3 -3
  37. package/docs/classes/ValidationError.html +3 -3
  38. package/docs/functions/DreamSerializer.html +1 -1
  39. package/docs/functions/ObjectSerializer.html +1 -1
  40. package/docs/functions/ReplicaSafe.html +1 -1
  41. package/docs/functions/STI.html +1 -1
  42. package/docs/functions/SoftDelete.html +1 -1
  43. package/docs/functions/camelize.html +1 -1
  44. package/docs/functions/capitalize.html +1 -1
  45. package/docs/functions/cloneDeepSafe.html +1 -1
  46. package/docs/functions/closeAllDbConnections.html +1 -1
  47. package/docs/functions/compact.html +1 -1
  48. package/docs/functions/dreamDbConnections.html +1 -1
  49. package/docs/functions/dreamPath.html +1 -1
  50. package/docs/functions/expandStiClasses.html +1 -1
  51. package/docs/functions/generateDream.html +1 -1
  52. package/docs/functions/globalClassNameFromFullyQualifiedModelName.html +1 -1
  53. package/docs/functions/groupBy.html +1 -1
  54. package/docs/functions/hyphenize.html +1 -1
  55. package/docs/functions/inferSerializerFromDreamOrViewModel.html +1 -1
  56. package/docs/functions/inferSerializersFromDreamClassOrViewModelClass.html +1 -1
  57. package/docs/functions/intersection.html +1 -1
  58. package/docs/functions/isDreamSerializer.html +1 -1
  59. package/docs/functions/isEmpty.html +1 -1
  60. package/docs/functions/loadRepl.html +1 -1
  61. package/docs/functions/lookupClassByGlobalName.html +1 -1
  62. package/docs/functions/normalizeUnicode.html +1 -1
  63. package/docs/functions/pascalize.html +1 -1
  64. package/docs/functions/pgErrorType.html +1 -1
  65. package/docs/functions/range-1.html +1 -1
  66. package/docs/functions/relativeDreamPath.html +1 -1
  67. package/docs/functions/round.html +1 -1
  68. package/docs/functions/serializerNameFromFullyQualifiedModelName.html +1 -1
  69. package/docs/functions/sharedPathPrefix.html +1 -1
  70. package/docs/functions/snakeify.html +1 -1
  71. package/docs/functions/sort.html +1 -1
  72. package/docs/functions/sortBy.html +1 -1
  73. package/docs/functions/sortObjectByKey.html +1 -1
  74. package/docs/functions/sortObjectByValue.html +1 -1
  75. package/docs/functions/standardizeFullyQualifiedModelName.html +1 -1
  76. package/docs/functions/uncapitalize.html +1 -1
  77. package/docs/functions/uniq.html +1 -1
  78. package/docs/functions/untypedDb.html +1 -1
  79. package/docs/functions/validateColumn.html +1 -1
  80. package/docs/functions/validateTable.html +1 -1
  81. package/docs/interfaces/BelongsToStatement.html +2 -2
  82. package/docs/interfaces/DecoratorContext.html +2 -2
  83. package/docs/interfaces/DreamAppInitOptions.html +2 -2
  84. package/docs/interfaces/DreamAppOpts.html +2 -2
  85. package/docs/interfaces/EncryptOptions.html +2 -2
  86. package/docs/interfaces/InternalAnyTypedSerializerRendersMany.html +2 -2
  87. package/docs/interfaces/InternalAnyTypedSerializerRendersOne.html +2 -2
  88. package/docs/interfaces/OpenapiDescription.html +2 -2
  89. package/docs/interfaces/OpenapiSchemaProperties.html +1 -1
  90. package/docs/interfaces/OpenapiSchemaPropertiesShorthand.html +1 -1
  91. package/docs/interfaces/OpenapiTypeFieldObject.html +1 -1
  92. package/docs/interfaces/SerializerRendererOpts.html +2 -2
  93. package/docs/types/Camelized.html +1 -1
  94. package/docs/types/CommonOpenapiSchemaObjectFields.html +1 -1
  95. package/docs/types/DateTime.html +1 -1
  96. package/docs/types/DbConnectionType.html +1 -1
  97. package/docs/types/DbTypes.html +1 -1
  98. package/docs/types/DreamAssociationMetadata.html +1 -1
  99. package/docs/types/DreamAttributes.html +1 -1
  100. package/docs/types/DreamClassAssociationAndStatement.html +1 -1
  101. package/docs/types/DreamClassColumn.html +1 -1
  102. package/docs/types/DreamColumn.html +1 -1
  103. package/docs/types/DreamColumnNames.html +1 -1
  104. package/docs/types/DreamLogLevel.html +1 -1
  105. package/docs/types/DreamLogger.html +1 -1
  106. package/docs/types/DreamModelSerializerType.html +1 -1
  107. package/docs/types/DreamOrViewModelClassSerializerKey.html +1 -1
  108. package/docs/types/DreamOrViewModelSerializerKey.html +1 -1
  109. package/docs/types/DreamParamSafeAttributes.html +1 -1
  110. package/docs/types/DreamParamSafeColumnNames.html +1 -1
  111. package/docs/types/DreamSerializable.html +1 -1
  112. package/docs/types/DreamSerializableArray.html +1 -1
  113. package/docs/types/DreamSerializerKey.html +1 -1
  114. package/docs/types/DreamSerializers.html +1 -1
  115. package/docs/types/DreamTableSchema.html +1 -1
  116. package/docs/types/DreamVirtualColumns.html +1 -1
  117. package/docs/types/EncryptAlgorithm.html +1 -1
  118. package/docs/types/HasManyStatement.html +1 -1
  119. package/docs/types/HasOneStatement.html +1 -1
  120. package/docs/types/Hyphenized.html +1 -1
  121. package/docs/types/IdType.html +1 -1
  122. package/docs/types/OpenapiAllTypes.html +1 -1
  123. package/docs/types/OpenapiFormats.html +1 -1
  124. package/docs/types/OpenapiNumberFormats.html +1 -1
  125. package/docs/types/OpenapiPrimitiveBaseTypes.html +1 -1
  126. package/docs/types/OpenapiPrimitiveTypes.html +1 -1
  127. package/docs/types/OpenapiSchemaArray.html +1 -1
  128. package/docs/types/OpenapiSchemaArrayShorthand.html +1 -1
  129. package/docs/types/OpenapiSchemaBase.html +1 -1
  130. package/docs/types/OpenapiSchemaBody.html +1 -1
  131. package/docs/types/OpenapiSchemaBodyShorthand.html +1 -1
  132. package/docs/types/OpenapiSchemaCommonFields.html +1 -1
  133. package/docs/types/OpenapiSchemaExpressionAllOf.html +1 -1
  134. package/docs/types/OpenapiSchemaExpressionAnyOf.html +1 -1
  135. package/docs/types/OpenapiSchemaExpressionOneOf.html +1 -1
  136. package/docs/types/OpenapiSchemaExpressionRef.html +1 -1
  137. package/docs/types/OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
  138. package/docs/types/OpenapiSchemaInteger.html +1 -1
  139. package/docs/types/OpenapiSchemaNull.html +1 -1
  140. package/docs/types/OpenapiSchemaNumber.html +1 -1
  141. package/docs/types/OpenapiSchemaObject.html +1 -1
  142. package/docs/types/OpenapiSchemaObjectAllOf.html +1 -1
  143. package/docs/types/OpenapiSchemaObjectAllOfShorthand.html +1 -1
  144. package/docs/types/OpenapiSchemaObjectAnyOf.html +1 -1
  145. package/docs/types/OpenapiSchemaObjectAnyOfShorthand.html +1 -1
  146. package/docs/types/OpenapiSchemaObjectBase.html +1 -1
  147. package/docs/types/OpenapiSchemaObjectBaseShorthand.html +1 -1
  148. package/docs/types/OpenapiSchemaObjectOneOf.html +1 -1
  149. package/docs/types/OpenapiSchemaObjectOneOfShorthand.html +1 -1
  150. package/docs/types/OpenapiSchemaObjectShorthand.html +1 -1
  151. package/docs/types/OpenapiSchemaPrimitiveGeneric.html +1 -1
  152. package/docs/types/OpenapiSchemaShorthandExpressionAllOf.html +1 -1
  153. package/docs/types/OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
  154. package/docs/types/OpenapiSchemaShorthandExpressionOneOf.html +1 -1
  155. package/docs/types/OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
  156. package/docs/types/OpenapiSchemaShorthandExpressionSerializerRef.html +1 -1
  157. package/docs/types/OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
  158. package/docs/types/OpenapiSchemaString.html +1 -1
  159. package/docs/types/OpenapiShorthandAllTypes.html +1 -1
  160. package/docs/types/OpenapiShorthandPrimitiveBaseTypes.html +1 -1
  161. package/docs/types/OpenapiShorthandPrimitiveTypes.html +1 -1
  162. package/docs/types/OpenapiTypeField.html +1 -1
  163. package/docs/types/Pascalized.html +1 -1
  164. package/docs/types/PrimaryKeyType.html +1 -1
  165. package/docs/types/RoundingPrecision.html +1 -1
  166. package/docs/types/SerializerCasing.html +1 -1
  167. package/docs/types/SimpleObjectSerializerType.html +1 -1
  168. package/docs/types/Snakeified.html +1 -1
  169. package/docs/types/Timestamp.html +1 -1
  170. package/docs/types/UpdateableAssociationProperties.html +1 -1
  171. package/docs/types/UpdateableProperties.html +1 -1
  172. package/docs/types/ValidationType.html +1 -1
  173. package/docs/types/ViewModel.html +1 -1
  174. package/docs/types/ViewModelClass.html +1 -1
  175. package/docs/types/WhereStatementForDream.html +1 -1
  176. package/docs/types/WhereStatementForDreamClass.html +1 -1
  177. package/docs/variables/DateTime-1.html +1 -1
  178. package/docs/variables/DreamConst.html +1 -1
  179. package/docs/variables/TRIGRAM_OPERATORS.html +1 -1
  180. package/docs/variables/openapiPrimitiveTypes-1.html +1 -1
  181. package/docs/variables/openapiShorthandPrimitiveTypes-1.html +1 -1
  182. package/docs/variables/ops.html +1 -1
  183. package/docs/variables/primaryKeyTypes.html +1 -1
  184. package/package.json +1 -1
@@ -581,7 +581,7 @@ class Dream {
581
581
  return false;
582
582
  if (this.isBelongsToAssociationPolymorphicTypeField(column))
583
583
  return false;
584
- if (this.sti.active && column === 'type')
584
+ if ((this.isSTIChild || this.isSTIBase) && column === 'type')
585
585
  return false;
586
586
  return true;
587
587
  });
@@ -7,7 +7,7 @@ const EnvInternal_js_1 = require("../helpers/EnvInternal.js");
7
7
  const sspawn_js_1 = require("../helpers/sspawn.js");
8
8
  const DreamCliLogger_js_1 = require("./logger/DreamCliLogger.js");
9
9
  const INDENT = ' ';
10
- const columnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
10
+ const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
11
11
  ${INDENT} title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to
12
12
  ${INDENT}
13
13
  ${INDENT}all properties default to not nullable; null can be allowed by appending ':optional':
@@ -21,7 +21,8 @@ ${INDENT} - string:
21
21
  ${INDENT} varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional
22
22
  ${INDENT}
23
23
  ${INDENT} - text
24
- ${INDENT}
24
+ ${INDENT} - date
25
+ ${INDENT} - datetime
25
26
  ${INDENT} - integer
26
27
  ${INDENT}
27
28
  ${INDENT} - decimal:
@@ -32,13 +33,22 @@ ${INDENT} include the enum name to automatically create the enum:
32
33
  ${INDENT} type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional
33
34
  ${INDENT}
34
35
  ${INDENT} omit the enum values to leverage an existing enum (omits the enum type creation):
35
- ${INDENT} type:enum:room_types or type:enum:room_types:optional
36
+ ${INDENT} type:enum:room_types or type:enum:room_types:optional`;
37
+ const columnsWithTypesDescription = baseColumnsWithTypesDescription +
38
+ `
39
+ ${INDENT}
40
+ ${INDENT} - belongs_to:
41
+ ${INDENT} not only adds a foreign key to the migration, but also adds a BelongsTo association to the generated model:
42
+ ${INDENT}
43
+ ${INDENT} include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
44
+ ${INDENT} Health/Coach:belongs_to`;
45
+ const columnsWithTypesDescriptionForMigration = baseColumnsWithTypesDescription +
46
+ `
36
47
  ${INDENT}
37
48
  ${INDENT} - belongs_to:
38
- ${INDENT} Not only updates the migration but also adds a BelongsTo association to the generated model:
39
- ${INDENT} Place:belongs_to
40
- ${INDENT}
41
- ${INDENT} Include the full Path to the model. E.g., if the Coach model is in src/app/models/Health/Coach:
49
+ ${INDENT} adds a foreign key to migration
50
+ ${INDENT}
51
+ ${INDENT} include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
42
52
  ${INDENT} Health/Coach:belongs_to`;
43
53
  class DreamCLI {
44
54
  /**
@@ -69,7 +79,7 @@ class DreamCLI {
69
79
  .alias('g:migration')
70
80
  .description('create a new migration')
71
81
  .argument('<migrationName>', 'end with -to-table-name to prepopulate with an alterTable command')
72
- .argument('[columnsWithTypes...]', columnsWithTypesDescription)
82
+ .argument('[columnsWithTypes...]', columnsWithTypesDescriptionForMigration)
73
83
  .action(async (migrationName, columnsWithTypes) => {
74
84
  await initializeDreamApp();
75
85
  await index_js_1.default.generateMigration(migrationName, columnsWithTypes);
@@ -81,10 +91,10 @@ class DreamCLI {
81
91
  .alias('generate:dream')
82
92
  .alias('g:dream')
83
93
  .option('--no-serializer')
84
- .option('--sti-base-serializer', 'omits the serializer from the dream model, but does create the serializer so it can be extended by STI children')
94
+ .option('--sti-base-serializer')
85
95
  .description('create a new Dream model')
86
96
  .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
87
- .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
97
+ .argument('[columnsWithTypes...]', columnsWithTypesDescription)
88
98
  .action(async (modelName, columnsWithTypes, options) => {
89
99
  await initializeDreamApp();
90
100
  await index_js_1.default.generateDream(modelName, columnsWithTypes, options);
@@ -20,7 +20,7 @@ async function generateDream({ fullyQualifiedModelName, columnsWithTypes, option
20
20
  fullyQualifiedModelName,
21
21
  columnsWithTypes,
22
22
  fullyQualifiedParentName,
23
- serializer: options.serializer && !options.stiBaseSerializer,
23
+ serializer: options.serializer,
24
24
  includeAdminSerializers: options.includeAdminSerializers,
25
25
  }));
26
26
  }
@@ -6,6 +6,7 @@ const globalClassNameFromFullyQualifiedModelName_js_1 = require("../globalClassN
6
6
  const relativeDreamPath_js_1 = require("../path/relativeDreamPath.js");
7
7
  const standardizeFullyQualifiedModelName_js_1 = require("../standardizeFullyQualifiedModelName.js");
8
8
  const uniq_js_1 = require("../uniq.js");
9
+ const generateMigrationContent_js_1 = require("./generateMigrationContent.js");
9
10
  function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, }) {
10
11
  fullyQualifiedModelName = (0, standardizeFullyQualifiedModelName_js_1.default)(fullyQualifiedModelName);
11
12
  const dreamImports = ['UpdateableProperties'];
@@ -19,7 +20,10 @@ function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, })
19
20
  const [attributeName, attributeType, ...descriptors] = attribute.split(':');
20
21
  if (attributeName === undefined)
21
22
  continue;
22
- if (attributeName === undefined)
23
+ if (attributeType === undefined)
24
+ continue;
25
+ const optional = (0, generateMigrationContent_js_1.optionalFromDescriptors)(descriptors);
26
+ if (optional)
23
27
  continue;
24
28
  const attributeVariable = (0, camelize_js_1.default)(attributeName.replace(/\//g, ''));
25
29
  if (/(_type|_id)$/.test(attributeName))
@@ -55,6 +59,14 @@ function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, })
55
59
  case 'decimal':
56
60
  attributeDefaults.push(`${attributeVariable}: 1.1,`);
57
61
  break;
62
+ case 'date':
63
+ dreamImports.push('CalendarDate');
64
+ attributeDefaults.push(`${attributeVariable}: CalendarDate.today(),`);
65
+ break;
66
+ case 'datetime':
67
+ dreamImports.push('DateTime');
68
+ attributeDefaults.push(`${attributeVariable}: DateTime.now(),`);
69
+ break;
58
70
  default:
59
71
  // noop
60
72
  }
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.default = generateMigrationContent;
4
+ exports.optionalFromDescriptors = optionalFromDescriptors;
4
5
  const pluralize_esm_1 = require("pluralize-esm");
5
6
  const InvalidDecimalFieldPassedToGenerator_js_1 = require("../../errors/InvalidDecimalFieldPassedToGenerator.js");
6
7
  const compact_js_1 = require("../compact.js");
@@ -26,7 +26,7 @@ function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes =
26
26
  ? `<T extends ${modelClassName}>(StiChildClass: typeof ${modelClassName}, ${modelInstanceName}: T)`
27
27
  : `(${modelInstanceName}: ${modelClassName})`;
28
28
  const modelSerializerArgs = `${modelInstanceName}`;
29
- const dreamSerializerArgs = `${stiBaseSerializer ? 'StiChildClass' : modelClassName}, ${modelInstanceName}`;
29
+ const dreamSerializerArgs = `${stiBaseSerializer ? `StiChildClass ?? ${modelClassName}` : modelClassName}, ${modelInstanceName}`;
30
30
  const serializerClassName = (0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
31
31
  const summarySerializerClassName = (0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName), 'summary');
32
32
  const defaultSerializerExtends = isSTI
@@ -92,7 +92,7 @@ function importStatementForSerializer(originModelName, destinationModelName) {
92
92
  const defaultSerializer = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)((0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(destinationModelName)));
93
93
  const summarySerializer = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)((0, serializerNameFromFullyQualifiedModelName_js_1.default)(fullyQualifiedModelNameToSerializerBaseName(destinationModelName), 'summary'));
94
94
  const importFrom = (0, relativeDreamPath_js_1.default)('serializers', 'serializers', originModelName, destinationModelName);
95
- return `import ${defaultSerializer}, { ${summarySerializer} } from '${importFrom}'\n`;
95
+ return `import { ${defaultSerializer}, ${summarySerializer} } from '${importFrom}'\n`;
96
96
  }
97
97
  function importStatementForModel(originModelName, destinationModelName = originModelName) {
98
98
  const modelName = (0, globalClassNameFromFullyQualifiedModelName_js_1.default)(destinationModelName);
@@ -579,7 +579,7 @@ export default class Dream {
579
579
  return false;
580
580
  if (this.isBelongsToAssociationPolymorphicTypeField(column))
581
581
  return false;
582
- if (this.sti.active && column === 'type')
582
+ if ((this.isSTIChild || this.isSTIBase) && column === 'type')
583
583
  return false;
584
584
  return true;
585
585
  });
@@ -5,7 +5,7 @@ import EnvInternal from '../helpers/EnvInternal.js';
5
5
  import sspawn from '../helpers/sspawn.js';
6
6
  import DreamCliLogger from './logger/DreamCliLogger.js';
7
7
  const INDENT = ' ';
8
- const columnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
8
+ const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
9
9
  ${INDENT} title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to
10
10
  ${INDENT}
11
11
  ${INDENT}all properties default to not nullable; null can be allowed by appending ':optional':
@@ -19,7 +19,8 @@ ${INDENT} - string:
19
19
  ${INDENT} varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional
20
20
  ${INDENT}
21
21
  ${INDENT} - text
22
- ${INDENT}
22
+ ${INDENT} - date
23
+ ${INDENT} - datetime
23
24
  ${INDENT} - integer
24
25
  ${INDENT}
25
26
  ${INDENT} - decimal:
@@ -30,13 +31,22 @@ ${INDENT} include the enum name to automatically create the enum:
30
31
  ${INDENT} type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional
31
32
  ${INDENT}
32
33
  ${INDENT} omit the enum values to leverage an existing enum (omits the enum type creation):
33
- ${INDENT} type:enum:room_types or type:enum:room_types:optional
34
+ ${INDENT} type:enum:room_types or type:enum:room_types:optional`;
35
+ const columnsWithTypesDescription = baseColumnsWithTypesDescription +
36
+ `
37
+ ${INDENT}
38
+ ${INDENT} - belongs_to:
39
+ ${INDENT} not only adds a foreign key to the migration, but also adds a BelongsTo association to the generated model:
40
+ ${INDENT}
41
+ ${INDENT} include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
42
+ ${INDENT} Health/Coach:belongs_to`;
43
+ const columnsWithTypesDescriptionForMigration = baseColumnsWithTypesDescription +
44
+ `
34
45
  ${INDENT}
35
46
  ${INDENT} - belongs_to:
36
- ${INDENT} Not only updates the migration but also adds a BelongsTo association to the generated model:
37
- ${INDENT} Place:belongs_to
38
- ${INDENT}
39
- ${INDENT} Include the full Path to the model. E.g., if the Coach model is in src/app/models/Health/Coach:
47
+ ${INDENT} adds a foreign key to migration
48
+ ${INDENT}
49
+ ${INDENT} include the fully qualified model name, e.g., if the Coach model is in src/app/models/Health/Coach:
40
50
  ${INDENT} Health/Coach:belongs_to`;
41
51
  export default class DreamCLI {
42
52
  /**
@@ -67,7 +77,7 @@ export default class DreamCLI {
67
77
  .alias('g:migration')
68
78
  .description('create a new migration')
69
79
  .argument('<migrationName>', 'end with -to-table-name to prepopulate with an alterTable command')
70
- .argument('[columnsWithTypes...]', columnsWithTypesDescription)
80
+ .argument('[columnsWithTypes...]', columnsWithTypesDescriptionForMigration)
71
81
  .action(async (migrationName, columnsWithTypes) => {
72
82
  await initializeDreamApp();
73
83
  await DreamBin.generateMigration(migrationName, columnsWithTypes);
@@ -79,10 +89,10 @@ export default class DreamCLI {
79
89
  .alias('generate:dream')
80
90
  .alias('g:dream')
81
91
  .option('--no-serializer')
82
- .option('--sti-base-serializer', 'omits the serializer from the dream model, but does create the serializer so it can be extended by STI children')
92
+ .option('--sti-base-serializer')
83
93
  .description('create a new Dream model')
84
94
  .argument('<modelName>', 'the name of the model to create, e.g. Post or Settings/CommunicationPreferences')
85
- .argument('[columnsWithTypes...]', 'properties of the model property1:text/string/enum/etc. property2:text/string/enum/etc. ... propertyN:text/string/enum/etc.')
95
+ .argument('[columnsWithTypes...]', columnsWithTypesDescription)
86
96
  .action(async (modelName, columnsWithTypes, options) => {
87
97
  await initializeDreamApp();
88
98
  await DreamBin.generateDream(modelName, columnsWithTypes, options);
@@ -17,7 +17,7 @@ export default async function generateDream({ fullyQualifiedModelName, columnsWi
17
17
  fullyQualifiedModelName,
18
18
  columnsWithTypes,
19
19
  fullyQualifiedParentName,
20
- serializer: options.serializer && !options.stiBaseSerializer,
20
+ serializer: options.serializer,
21
21
  includeAdminSerializers: options.includeAdminSerializers,
22
22
  }));
23
23
  }
@@ -3,6 +3,7 @@ import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFu
3
3
  import relativeDreamPath from '../path/relativeDreamPath.js';
4
4
  import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
5
5
  import uniq from '../uniq.js';
6
+ import { optionalFromDescriptors } from './generateMigrationContent.js';
6
7
  export default function generateFactoryContent({ fullyQualifiedModelName, columnsWithTypes, }) {
7
8
  fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
8
9
  const dreamImports = ['UpdateableProperties'];
@@ -16,7 +17,10 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
16
17
  const [attributeName, attributeType, ...descriptors] = attribute.split(':');
17
18
  if (attributeName === undefined)
18
19
  continue;
19
- if (attributeName === undefined)
20
+ if (attributeType === undefined)
21
+ continue;
22
+ const optional = optionalFromDescriptors(descriptors);
23
+ if (optional)
20
24
  continue;
21
25
  const attributeVariable = camelize(attributeName.replace(/\//g, ''));
22
26
  if (/(_type|_id)$/.test(attributeName))
@@ -52,6 +56,14 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
52
56
  case 'decimal':
53
57
  attributeDefaults.push(`${attributeVariable}: 1.1,`);
54
58
  break;
59
+ case 'date':
60
+ dreamImports.push('CalendarDate');
61
+ attributeDefaults.push(`${attributeVariable}: CalendarDate.today(),`);
62
+ break;
63
+ case 'datetime':
64
+ dreamImports.push('DateTime');
65
+ attributeDefaults.push(`${attributeVariable}: DateTime.now(),`);
66
+ break;
55
67
  default:
56
68
  // noop
57
69
  }
@@ -223,7 +223,7 @@ function generateIdStr({ primaryKeyType }) {
223
223
  function associationNameToForeignKey(associationName) {
224
224
  return snakeify(associationName.replace(/\//g, '_').replace(/_id$/, '') + '_id');
225
225
  }
226
- function optionalFromDescriptors(descriptors) {
226
+ export function optionalFromDescriptors(descriptors) {
227
227
  const optional = descriptors.at(-1) === 'optional';
228
228
  if (optional)
229
229
  descriptors.pop();
@@ -23,7 +23,7 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
23
23
  ? `<T extends ${modelClassName}>(StiChildClass: typeof ${modelClassName}, ${modelInstanceName}: T)`
24
24
  : `(${modelInstanceName}: ${modelClassName})`;
25
25
  const modelSerializerArgs = `${modelInstanceName}`;
26
- const dreamSerializerArgs = `${stiBaseSerializer ? 'StiChildClass' : modelClassName}, ${modelInstanceName}`;
26
+ const dreamSerializerArgs = `${stiBaseSerializer ? `StiChildClass ?? ${modelClassName}` : modelClassName}, ${modelInstanceName}`;
27
27
  const serializerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
28
28
  const summarySerializerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName), 'summary');
29
29
  const defaultSerializerExtends = isSTI
@@ -89,7 +89,7 @@ function importStatementForSerializer(originModelName, destinationModelName) {
89
89
  const defaultSerializer = globalClassNameFromFullyQualifiedModelName(serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(destinationModelName)));
90
90
  const summarySerializer = globalClassNameFromFullyQualifiedModelName(serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(destinationModelName), 'summary'));
91
91
  const importFrom = relativeDreamPath('serializers', 'serializers', originModelName, destinationModelName);
92
- return `import ${defaultSerializer}, { ${summarySerializer} } from '${importFrom}'\n`;
92
+ return `import { ${defaultSerializer}, ${summarySerializer} } from '${importFrom}'\n`;
93
93
  }
94
94
  function importStatementForModel(originModelName, destinationModelName = originModelName) {
95
95
  const modelName = globalClassNameFromFullyQualifiedModelName(destinationModelName);
@@ -5,3 +5,4 @@ export default function generateMigrationContent({ table, columnsWithTypes, prim
5
5
  primaryKeyType?: PrimaryKeyType | undefined;
6
6
  createOrAlter?: 'create' | 'alter' | undefined;
7
7
  }): string;
8
+ export declare function optionalFromDescriptors(descriptors: string[]): boolean;
@@ -59,6 +59,6 @@ export type NonAutomaticSerializerAttributeOptions = {
59
59
  export type NonAutomaticSerializerAttributeOptionsWithPossibleDecimalRenderOption = NonAutomaticSerializerAttributeOptions & {
60
60
  precision?: RoundingPrecision;
61
61
  };
62
- export type DreamModelSerializerType = (dreamClass: any, data: any, passthroughData?: any) => DreamSerializerBuilder<any, any>;
62
+ export type DreamModelSerializerType = (data: any, passthroughData?: any) => DreamSerializerBuilder<any, any>;
63
63
  export type SimpleObjectSerializerType = (data: any, passthroughData?: any) => ObjectSerializerBuilder<any, any>;
64
64
  export type SerializerType<T extends Dream | object | Dream[] | object[]> = T extends Dream | Dream[] ? DreamModelSerializerType : SimpleObjectSerializerType;
@@ -89,11 +89,7 @@ export type NonAutomaticSerializerAttributeOptionsWithPossibleDecimalRenderOptio
89
89
  precision?: RoundingPrecision
90
90
  }
91
91
 
92
- export type DreamModelSerializerType = (
93
- dreamClass: any,
94
- data: any,
95
- passthroughData?: any
96
- ) => DreamSerializerBuilder<any, any>
92
+ export type DreamModelSerializerType = (data: any, passthroughData?: any) => DreamSerializerBuilder<any, any>
97
93
 
98
94
  export type SimpleObjectSerializerType = (
99
95
  data: any,
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Benchmark | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="Benchmark.html">Benchmark</a></li></ul><h1>Class Benchmark</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/605422b2ac68c94b3f0fd8eb8077784dafe370d7/src/helpers/benchmark.ts#L6">src/helpers/benchmark.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Benchmark.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Benchmark | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="Benchmark.html">Benchmark</a></li></ul><h1>Class Benchmark</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/775968576cc72bb2ab463012eebe1853f8c70a3e/src/helpers/benchmark.ts#L6">src/helpers/benchmark.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Benchmark.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
2
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Benchmark.html#mark" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark</span></a>
3
3
  <a href="Benchmark.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
4
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Benchmark" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Benchmark</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a><a href="#constructor.new_Benchmark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="mark" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mark</span><a href="#mark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mark.mark-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mark</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mark.mark-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">BenchmarkLogLevel</span><span class="tsd-signature-symbol"> = &#39;log&#39;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/605422b2ac68c94b3f0fd8eb8077784dafe370d7/src/helpers/benchmark.ts#L12">src/helpers/benchmark.ts:12</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/605422b2ac68c94b3f0fd8eb8077784dafe370d7/src/helpers/benchmark.ts#L8">src/helpers/benchmark.ts:8</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#mark" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark</span></a><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
4
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Benchmark" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Benchmark</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a><a href="#constructor.new_Benchmark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="mark" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mark</span><a href="#mark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mark.mark-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mark</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mark.mark-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">BenchmarkLogLevel</span><span class="tsd-signature-symbol"> = &#39;log&#39;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/775968576cc72bb2ab463012eebe1853f8c70a3e/src/helpers/benchmark.ts#L12">src/helpers/benchmark.ts:12</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/775968576cc72bb2ab463012eebe1853f8c70a3e/src/helpers/benchmark.ts#L8">src/helpers/benchmark.ts:8</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#mark" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark</span></a><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>