@mikro-orm/core 7.0.2-dev.8 → 7.0.2

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 (207) hide show
  1. package/EntityManager.d.ts +883 -579
  2. package/EntityManager.js +1897 -1865
  3. package/MikroORM.d.ts +103 -72
  4. package/MikroORM.js +178 -177
  5. package/README.md +128 -294
  6. package/cache/CacheAdapter.d.ts +38 -36
  7. package/cache/FileCacheAdapter.d.ts +30 -24
  8. package/cache/FileCacheAdapter.js +80 -78
  9. package/cache/GeneratedCacheAdapter.d.ts +19 -20
  10. package/cache/GeneratedCacheAdapter.js +31 -30
  11. package/cache/MemoryCacheAdapter.d.ts +19 -20
  12. package/cache/MemoryCacheAdapter.js +36 -36
  13. package/cache/NullCacheAdapter.d.ts +17 -16
  14. package/cache/NullCacheAdapter.js +25 -24
  15. package/connections/Connection.d.ts +99 -75
  16. package/connections/Connection.js +166 -160
  17. package/drivers/DatabaseDriver.d.ts +187 -69
  18. package/drivers/DatabaseDriver.js +451 -432
  19. package/drivers/IDatabaseDriver.d.ts +464 -281
  20. package/drivers/IDatabaseDriver.js +1 -0
  21. package/entity/BaseEntity.d.ts +121 -73
  22. package/entity/BaseEntity.js +44 -33
  23. package/entity/Collection.d.ts +216 -157
  24. package/entity/Collection.js +728 -707
  25. package/entity/EntityAssigner.d.ts +90 -76
  26. package/entity/EntityAssigner.js +232 -229
  27. package/entity/EntityFactory.d.ts +68 -40
  28. package/entity/EntityFactory.js +427 -366
  29. package/entity/EntityHelper.d.ts +34 -22
  30. package/entity/EntityHelper.js +280 -267
  31. package/entity/EntityIdentifier.d.ts +4 -4
  32. package/entity/EntityIdentifier.js +10 -10
  33. package/entity/EntityLoader.d.ts +105 -56
  34. package/entity/EntityLoader.js +754 -722
  35. package/entity/EntityRepository.d.ts +317 -200
  36. package/entity/EntityRepository.js +214 -212
  37. package/entity/PolymorphicRef.d.ts +5 -5
  38. package/entity/PolymorphicRef.js +10 -10
  39. package/entity/Reference.d.ts +130 -66
  40. package/entity/Reference.js +280 -260
  41. package/entity/WrappedEntity.d.ts +116 -53
  42. package/entity/WrappedEntity.js +169 -147
  43. package/entity/defineEntity.d.ts +1290 -614
  44. package/entity/defineEntity.js +521 -511
  45. package/entity/utils.d.ts +13 -3
  46. package/entity/utils.js +71 -73
  47. package/entity/validators.js +43 -43
  48. package/entity/wrap.js +8 -8
  49. package/enums.d.ts +275 -138
  50. package/enums.js +268 -137
  51. package/errors.d.ts +120 -72
  52. package/errors.js +356 -253
  53. package/events/EventManager.d.ts +27 -10
  54. package/events/EventManager.js +80 -73
  55. package/events/EventSubscriber.d.ts +33 -29
  56. package/events/TransactionEventBroadcaster.d.ts +16 -7
  57. package/events/TransactionEventBroadcaster.js +15 -13
  58. package/exceptions.d.ts +23 -40
  59. package/exceptions.js +35 -52
  60. package/hydration/Hydrator.d.ts +43 -16
  61. package/hydration/Hydrator.js +44 -42
  62. package/hydration/ObjectHydrator.d.ts +51 -17
  63. package/hydration/ObjectHydrator.js +480 -416
  64. package/index.d.ts +116 -2
  65. package/index.js +10 -1
  66. package/logging/DefaultLogger.d.ts +35 -30
  67. package/logging/DefaultLogger.js +87 -84
  68. package/logging/Logger.d.ts +45 -40
  69. package/logging/SimpleLogger.d.ts +13 -11
  70. package/logging/SimpleLogger.js +22 -22
  71. package/logging/colors.d.ts +6 -6
  72. package/logging/colors.js +11 -10
  73. package/logging/inspect.js +7 -7
  74. package/metadata/EntitySchema.d.ts +214 -108
  75. package/metadata/EntitySchema.js +398 -379
  76. package/metadata/MetadataDiscovery.d.ts +115 -111
  77. package/metadata/MetadataDiscovery.js +1948 -1857
  78. package/metadata/MetadataProvider.d.ts +25 -14
  79. package/metadata/MetadataProvider.js +83 -77
  80. package/metadata/MetadataStorage.d.ts +39 -19
  81. package/metadata/MetadataStorage.js +119 -106
  82. package/metadata/MetadataValidator.d.ts +39 -39
  83. package/metadata/MetadataValidator.js +381 -338
  84. package/metadata/discover-entities.d.ts +5 -2
  85. package/metadata/discover-entities.js +27 -27
  86. package/metadata/types.d.ts +615 -531
  87. package/naming-strategy/AbstractNamingStrategy.d.ts +55 -39
  88. package/naming-strategy/AbstractNamingStrategy.js +91 -85
  89. package/naming-strategy/EntityCaseNamingStrategy.d.ts +6 -6
  90. package/naming-strategy/EntityCaseNamingStrategy.js +22 -22
  91. package/naming-strategy/MongoNamingStrategy.d.ts +7 -6
  92. package/naming-strategy/MongoNamingStrategy.js +19 -18
  93. package/naming-strategy/NamingStrategy.d.ts +109 -99
  94. package/naming-strategy/UnderscoreNamingStrategy.d.ts +8 -7
  95. package/naming-strategy/UnderscoreNamingStrategy.js +22 -21
  96. package/not-supported.js +7 -4
  97. package/package.json +1 -1
  98. package/platforms/ExceptionConverter.d.ts +2 -1
  99. package/platforms/ExceptionConverter.js +5 -4
  100. package/platforms/Platform.d.ts +310 -236
  101. package/platforms/Platform.js +661 -573
  102. package/serialization/EntitySerializer.d.ts +49 -25
  103. package/serialization/EntitySerializer.js +224 -216
  104. package/serialization/EntityTransformer.d.ts +11 -5
  105. package/serialization/EntityTransformer.js +220 -216
  106. package/serialization/SerializationContext.d.ts +27 -18
  107. package/serialization/SerializationContext.js +105 -100
  108. package/types/ArrayType.d.ts +9 -8
  109. package/types/ArrayType.js +34 -33
  110. package/types/BigIntType.d.ts +17 -10
  111. package/types/BigIntType.js +37 -37
  112. package/types/BlobType.d.ts +4 -3
  113. package/types/BlobType.js +14 -13
  114. package/types/BooleanType.d.ts +5 -4
  115. package/types/BooleanType.js +13 -12
  116. package/types/CharacterType.d.ts +3 -2
  117. package/types/CharacterType.js +7 -6
  118. package/types/DateTimeType.d.ts +6 -5
  119. package/types/DateTimeType.js +16 -15
  120. package/types/DateType.d.ts +6 -5
  121. package/types/DateType.js +16 -15
  122. package/types/DecimalType.d.ts +7 -7
  123. package/types/DecimalType.js +26 -26
  124. package/types/DoubleType.d.ts +3 -3
  125. package/types/DoubleType.js +12 -12
  126. package/types/EnumArrayType.d.ts +6 -5
  127. package/types/EnumArrayType.js +25 -24
  128. package/types/EnumType.d.ts +4 -3
  129. package/types/EnumType.js +12 -11
  130. package/types/FloatType.d.ts +4 -3
  131. package/types/FloatType.js +10 -9
  132. package/types/IntegerType.d.ts +4 -3
  133. package/types/IntegerType.js +10 -9
  134. package/types/IntervalType.d.ts +5 -4
  135. package/types/IntervalType.js +13 -12
  136. package/types/JsonType.d.ts +9 -8
  137. package/types/JsonType.js +33 -32
  138. package/types/MediumIntType.d.ts +2 -1
  139. package/types/MediumIntType.js +4 -3
  140. package/types/SmallIntType.d.ts +4 -3
  141. package/types/SmallIntType.js +10 -9
  142. package/types/StringType.d.ts +5 -4
  143. package/types/StringType.js +13 -12
  144. package/types/TextType.d.ts +4 -3
  145. package/types/TextType.js +10 -9
  146. package/types/TimeType.d.ts +6 -5
  147. package/types/TimeType.js +18 -17
  148. package/types/TinyIntType.d.ts +4 -3
  149. package/types/TinyIntType.js +11 -10
  150. package/types/Type.d.ts +88 -73
  151. package/types/Type.js +85 -74
  152. package/types/Uint8ArrayType.d.ts +5 -4
  153. package/types/Uint8ArrayType.js +22 -21
  154. package/types/UnknownType.d.ts +5 -4
  155. package/types/UnknownType.js +13 -12
  156. package/types/UuidType.d.ts +6 -5
  157. package/types/UuidType.js +20 -19
  158. package/types/index.d.ts +77 -49
  159. package/types/index.js +64 -26
  160. package/typings.d.ts +1388 -729
  161. package/typings.js +255 -231
  162. package/unit-of-work/ChangeSet.d.ts +28 -24
  163. package/unit-of-work/ChangeSet.js +58 -54
  164. package/unit-of-work/ChangeSetComputer.d.ts +13 -11
  165. package/unit-of-work/ChangeSetComputer.js +180 -159
  166. package/unit-of-work/ChangeSetPersister.d.ts +64 -41
  167. package/unit-of-work/ChangeSetPersister.js +443 -418
  168. package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
  169. package/unit-of-work/CommitOrderCalculator.js +89 -88
  170. package/unit-of-work/IdentityMap.d.ts +32 -25
  171. package/unit-of-work/IdentityMap.js +106 -99
  172. package/unit-of-work/UnitOfWork.d.ts +182 -127
  173. package/unit-of-work/UnitOfWork.js +1201 -1169
  174. package/utils/AbstractMigrator.d.ts +111 -91
  175. package/utils/AbstractMigrator.js +275 -275
  176. package/utils/AbstractSchemaGenerator.d.ts +43 -34
  177. package/utils/AbstractSchemaGenerator.js +121 -122
  178. package/utils/AsyncContext.d.ts +3 -3
  179. package/utils/AsyncContext.js +34 -35
  180. package/utils/Configuration.d.ts +853 -801
  181. package/utils/Configuration.js +360 -337
  182. package/utils/Cursor.d.ts +40 -22
  183. package/utils/Cursor.js +135 -127
  184. package/utils/DataloaderUtils.d.ts +58 -43
  185. package/utils/DataloaderUtils.js +203 -198
  186. package/utils/EntityComparator.d.ts +99 -80
  187. package/utils/EntityComparator.js +825 -727
  188. package/utils/NullHighlighter.d.ts +2 -1
  189. package/utils/NullHighlighter.js +4 -3
  190. package/utils/QueryHelper.d.ts +79 -51
  191. package/utils/QueryHelper.js +372 -361
  192. package/utils/RawQueryFragment.d.ts +54 -28
  193. package/utils/RawQueryFragment.js +110 -99
  194. package/utils/RequestContext.d.ts +33 -32
  195. package/utils/RequestContext.js +52 -53
  196. package/utils/TransactionContext.d.ts +17 -16
  197. package/utils/TransactionContext.js +28 -27
  198. package/utils/TransactionManager.d.ts +58 -58
  199. package/utils/TransactionManager.js +199 -197
  200. package/utils/Utils.d.ts +210 -145
  201. package/utils/Utils.js +820 -813
  202. package/utils/clone.js +104 -113
  203. package/utils/env-vars.js +90 -88
  204. package/utils/fs-utils.d.ts +15 -15
  205. package/utils/fs-utils.js +180 -181
  206. package/utils/upsert-utils.d.ts +20 -5
  207. package/utils/upsert-utils.js +114 -116
@@ -1,43 +1,59 @@
1
1
  import type { NamingStrategy } from './NamingStrategy.js';
2
2
  import { type ReferenceKind } from '../enums.js';
3
+ /** Base class for naming strategies, providing default implementations for common naming conventions. */
3
4
  export declare abstract class AbstractNamingStrategy implements NamingStrategy {
4
- getClassName(file: string, separator?: string): string;
5
- classToMigrationName(timestamp: string, customMigrationName?: string): string;
6
- indexName(tableName: string, columns: string[], type: 'primary' | 'foreign' | 'unique' | 'index' | 'sequence' | 'check' | 'default'): string;
7
- /**
8
- * @inheritDoc
9
- */
10
- getEntityName(tableName: string, schemaName?: string): string;
11
- columnNameToProperty(columnName: string): string;
12
- /**
13
- * @inheritDoc
14
- */
15
- getEnumClassName(columnName: string, tableName: string | undefined, schemaName?: string): string;
16
- /**
17
- * @inheritDoc
18
- */
19
- getEnumTypeName(columnName: string, tableName: string | undefined, schemaName?: string): string;
20
- /**
21
- * @inheritDoc
22
- */
23
- enumValueToEnumProperty(enumValue: string, columnName: string, tableName: string, schemaName?: string): string;
24
- aliasName(entityName: string, index: number): string;
25
- /**
26
- * @inheritDoc
27
- */
28
- inverseSideName(entityName: string, propertyName: string, kind: ReferenceKind): string;
29
- /**
30
- * @inheritDoc
31
- */
32
- manyToManyPropertyName(ownerEntityName: string, targetEntityName: string, pivotTableName: string, ownerTableName: string, schemaName?: string): string;
33
- /**
34
- * @inheritDoc
35
- */
36
- discriminatorColumnName(baseName: string): string;
37
- abstract classToTableName(entityName: string, tableName?: string): string;
38
- abstract joinColumnName(propertyName: string): string;
39
- abstract joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
40
- abstract joinTableName(sourceEntity: string, targetEntity: string, propertyName?: string, tableName?: string): string;
41
- abstract propertyToColumnName(propertyName: string, object?: boolean): string;
42
- abstract referenceColumnName(): string;
5
+ getClassName(file: string, separator?: string): string;
6
+ classToMigrationName(timestamp: string, customMigrationName?: string): string;
7
+ indexName(
8
+ tableName: string,
9
+ columns: string[],
10
+ type: 'primary' | 'foreign' | 'unique' | 'index' | 'sequence' | 'check' | 'default',
11
+ ): string;
12
+ /**
13
+ * @inheritDoc
14
+ */
15
+ getEntityName(tableName: string, schemaName?: string): string;
16
+ columnNameToProperty(columnName: string): string;
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ getEnumClassName(columnName: string, tableName: string | undefined, schemaName?: string): string;
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ getEnumTypeName(columnName: string, tableName: string | undefined, schemaName?: string): string;
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ enumValueToEnumProperty(enumValue: string, columnName: string, tableName: string, schemaName?: string): string;
29
+ aliasName(entityName: string, index: number): string;
30
+ /**
31
+ * @inheritDoc
32
+ */
33
+ inverseSideName(entityName: string, propertyName: string, kind: ReferenceKind): string;
34
+ /**
35
+ * @inheritDoc
36
+ */
37
+ manyToManyPropertyName(
38
+ ownerEntityName: string,
39
+ targetEntityName: string,
40
+ pivotTableName: string,
41
+ ownerTableName: string,
42
+ schemaName?: string,
43
+ ): string;
44
+ /**
45
+ * @inheritDoc
46
+ */
47
+ discriminatorColumnName(baseName: string): string;
48
+ abstract classToTableName(entityName: string, tableName?: string): string;
49
+ abstract joinColumnName(propertyName: string): string;
50
+ abstract joinKeyColumnName(
51
+ entityName: string,
52
+ referencedColumnName?: string,
53
+ composite?: boolean,
54
+ tableName?: string,
55
+ ): string;
56
+ abstract joinTableName(sourceEntity: string, targetEntity: string, propertyName?: string, tableName?: string): string;
57
+ abstract propertyToColumnName(propertyName: string, object?: boolean): string;
58
+ abstract referenceColumnName(): string;
43
59
  }
@@ -1,97 +1,103 @@
1
1
  import { PopulatePath } from '../enums.js';
2
2
  const populatePathMembers = Object.values(PopulatePath);
3
+ /** Base class for naming strategies, providing default implementations for common naming conventions. */
3
4
  export class AbstractNamingStrategy {
4
- getClassName(file, separator = '-') {
5
- const name = file.split('.')[0];
6
- const ret = name.replace(new RegExp(`(?:${separator})+(\\w)`, 'ug'), (_, p1) => p1.toUpperCase());
7
- return ret.charAt(0).toUpperCase() + ret.slice(1);
5
+ getClassName(file, separator = '-') {
6
+ const name = file.split('.')[0];
7
+ const ret = name.replace(new RegExp(`(?:${separator})+(\\w)`, 'ug'), (_, p1) => p1.toUpperCase());
8
+ return ret.charAt(0).toUpperCase() + ret.slice(1);
9
+ }
10
+ classToMigrationName(timestamp, customMigrationName) {
11
+ let migrationName = `Migration${timestamp}`;
12
+ if (customMigrationName) {
13
+ migrationName += `_${customMigrationName}`;
8
14
  }
9
- classToMigrationName(timestamp, customMigrationName) {
10
- let migrationName = `Migration${timestamp}`;
11
- if (customMigrationName) {
12
- migrationName += `_${customMigrationName}`;
13
- }
14
- return migrationName;
15
+ return migrationName;
16
+ }
17
+ indexName(tableName, columns, type) {
18
+ /* v8 ignore next */
19
+ if (tableName.includes('.')) {
20
+ tableName = tableName.substring(tableName.indexOf('.') + 1);
15
21
  }
16
- indexName(tableName, columns, type) {
17
- /* v8 ignore next */
18
- if (tableName.includes('.')) {
19
- tableName = tableName.substring(tableName.indexOf('.') + 1);
20
- }
21
- if (type === 'primary') {
22
- return `${tableName}_pkey`;
23
- }
24
- columns = columns.map(col => col.replace(/\./g, '_'));
25
- if (type === 'sequence') {
26
- return `${tableName}_${columns.join('_')}_seq`;
27
- }
28
- if (columns.length > 0) {
29
- return `${tableName}_${columns.join('_')}_${type}`;
30
- }
31
- return `${tableName}_${type}`;
22
+ if (type === 'primary') {
23
+ return `${tableName}_pkey`;
32
24
  }
33
- /**
34
- * @inheritDoc
35
- */
36
- getEntityName(tableName, schemaName) {
37
- const name = /^[^$_\p{ID_Start}]/u.exec(tableName) ? `E_${tableName}` : tableName;
38
- return this.getClassName(name.replaceAll(/[^\u200C\u200D\p{ID_Continue}]+/gu, r => r
39
- .split('')
40
- .map(c => `$${c.codePointAt(0)}`)
41
- .join('')), '_');
25
+ columns = columns.map(col => col.replace(/\./g, '_'));
26
+ if (type === 'sequence') {
27
+ return `${tableName}_${columns.join('_')}_seq`;
42
28
  }
43
- columnNameToProperty(columnName) {
44
- const propName = columnName.replace(/[_\- ]+(\w)/gu, (_, p1) => p1.toUpperCase());
45
- if (populatePathMembers.includes(propName.replace(/^\${2,}/u, '$$').replace(/^\$\*$/u, '*'))) {
46
- return `$${propName}`;
47
- }
48
- return propName;
29
+ if (columns.length > 0) {
30
+ return `${tableName}_${columns.join('_')}_${type}`;
49
31
  }
50
- /**
51
- * @inheritDoc
52
- */
53
- getEnumClassName(columnName, tableName, schemaName) {
54
- return this.getEntityName(tableName ? `${tableName}_${columnName}` : columnName, schemaName);
32
+ return `${tableName}_${type}`;
33
+ }
34
+ /**
35
+ * @inheritDoc
36
+ */
37
+ getEntityName(tableName, schemaName) {
38
+ const name = /^[^$_\p{ID_Start}]/u.exec(tableName) ? `E_${tableName}` : tableName;
39
+ return this.getClassName(
40
+ name.replaceAll(/[^\u200C\u200D\p{ID_Continue}]+/gu, r =>
41
+ r
42
+ .split('')
43
+ .map(c => `$${c.codePointAt(0)}`)
44
+ .join(''),
45
+ ),
46
+ '_',
47
+ );
48
+ }
49
+ columnNameToProperty(columnName) {
50
+ const propName = columnName.replace(/[_\- ]+(\w)/gu, (_, p1) => p1.toUpperCase());
51
+ if (populatePathMembers.includes(propName.replace(/^\${2,}/u, '$$').replace(/^\$\*$/u, '*'))) {
52
+ return `$${propName}`;
55
53
  }
56
- /**
57
- * @inheritDoc
58
- */
59
- getEnumTypeName(columnName, tableName, schemaName) {
60
- return 'T' + this.getEnumClassName(columnName, tableName, schemaName);
54
+ return propName;
55
+ }
56
+ /**
57
+ * @inheritDoc
58
+ */
59
+ getEnumClassName(columnName, tableName, schemaName) {
60
+ return this.getEntityName(tableName ? `${tableName}_${columnName}` : columnName, schemaName);
61
+ }
62
+ /**
63
+ * @inheritDoc
64
+ */
65
+ getEnumTypeName(columnName, tableName, schemaName) {
66
+ return 'T' + this.getEnumClassName(columnName, tableName, schemaName);
67
+ }
68
+ /**
69
+ * @inheritDoc
70
+ */
71
+ enumValueToEnumProperty(enumValue, columnName, tableName, schemaName) {
72
+ return enumValue.toUpperCase();
73
+ }
74
+ aliasName(entityName, index) {
75
+ // Take only the first letter of the prefix to keep character counts down since some engines have character limits
76
+ return entityName.charAt(0).toLowerCase() + index;
77
+ }
78
+ /**
79
+ * @inheritDoc
80
+ */
81
+ inverseSideName(entityName, propertyName, kind) {
82
+ if (kind === 'm:n') {
83
+ return propertyName + 'Inverse';
61
84
  }
62
- /**
63
- * @inheritDoc
64
- */
65
- enumValueToEnumProperty(enumValue, columnName, tableName, schemaName) {
66
- return enumValue.toUpperCase();
67
- }
68
- aliasName(entityName, index) {
69
- // Take only the first letter of the prefix to keep character counts down since some engines have character limits
70
- return entityName.charAt(0).toLowerCase() + index;
71
- }
72
- /**
73
- * @inheritDoc
74
- */
75
- inverseSideName(entityName, propertyName, kind) {
76
- if (kind === 'm:n') {
77
- return propertyName + 'Inverse';
78
- }
79
- const suffix = kind === '1:m' && !entityName.endsWith('Collection') ? 'Collection' : '';
80
- if (entityName.length === 1) {
81
- return entityName[0].toLowerCase() + suffix;
82
- }
83
- return entityName[0].toLowerCase() + entityName.substring(1) + suffix;
84
- }
85
- /**
86
- * @inheritDoc
87
- */
88
- manyToManyPropertyName(ownerEntityName, targetEntityName, pivotTableName, ownerTableName, schemaName) {
89
- return this.columnNameToProperty(pivotTableName.replace(new RegExp('^' + ownerTableName + '_'), ''));
90
- }
91
- /**
92
- * @inheritDoc
93
- */
94
- discriminatorColumnName(baseName) {
95
- return this.propertyToColumnName(baseName + 'Type');
85
+ const suffix = kind === '1:m' && !entityName.endsWith('Collection') ? 'Collection' : '';
86
+ if (entityName.length === 1) {
87
+ return entityName[0].toLowerCase() + suffix;
96
88
  }
89
+ return entityName[0].toLowerCase() + entityName.substring(1) + suffix;
90
+ }
91
+ /**
92
+ * @inheritDoc
93
+ */
94
+ manyToManyPropertyName(ownerEntityName, targetEntityName, pivotTableName, ownerTableName, schemaName) {
95
+ return this.columnNameToProperty(pivotTableName.replace(new RegExp('^' + ownerTableName + '_'), ''));
96
+ }
97
+ /**
98
+ * @inheritDoc
99
+ */
100
+ discriminatorColumnName(baseName) {
101
+ return this.propertyToColumnName(baseName + 'Type');
102
+ }
97
103
  }
@@ -3,10 +3,10 @@ import { AbstractNamingStrategy } from './AbstractNamingStrategy.js';
3
3
  * This strategy keeps original entity/property names for table/column.
4
4
  */
5
5
  export declare class EntityCaseNamingStrategy extends AbstractNamingStrategy {
6
- classToTableName(entityName: string, tableName?: string): string;
7
- joinColumnName(propertyName: string): string;
8
- joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
9
- joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
10
- propertyToColumnName(propertyName: string): string;
11
- referenceColumnName(): string;
6
+ classToTableName(entityName: string, tableName?: string): string;
7
+ joinColumnName(propertyName: string): string;
8
+ joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
9
+ joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
10
+ propertyToColumnName(propertyName: string): string;
11
+ referenceColumnName(): string;
12
12
  }
@@ -3,27 +3,27 @@ import { AbstractNamingStrategy } from './AbstractNamingStrategy.js';
3
3
  * This strategy keeps original entity/property names for table/column.
4
4
  */
5
5
  export class EntityCaseNamingStrategy extends AbstractNamingStrategy {
6
- classToTableName(entityName, tableName) {
7
- return tableName ?? entityName;
8
- }
9
- joinColumnName(propertyName) {
10
- return propertyName;
11
- }
12
- joinKeyColumnName(entityName, referencedColumnName, composite, tableName) {
13
- entityName = this.classToTableName(entityName, tableName);
14
- const name = entityName.substring(0, 1).toLowerCase() + entityName.substring(1);
15
- if (composite && referencedColumnName) {
16
- return name + '_' + referencedColumnName;
17
- }
18
- return name;
19
- }
20
- joinTableName(sourceEntity, targetEntity, propertyName, tableName) {
21
- return this.classToTableName(sourceEntity, tableName) + '_' + this.propertyToColumnName(propertyName);
22
- }
23
- propertyToColumnName(propertyName) {
24
- return propertyName;
25
- }
26
- referenceColumnName() {
27
- return 'id';
6
+ classToTableName(entityName, tableName) {
7
+ return tableName ?? entityName;
8
+ }
9
+ joinColumnName(propertyName) {
10
+ return propertyName;
11
+ }
12
+ joinKeyColumnName(entityName, referencedColumnName, composite, tableName) {
13
+ entityName = this.classToTableName(entityName, tableName);
14
+ const name = entityName.substring(0, 1).toLowerCase() + entityName.substring(1);
15
+ if (composite && referencedColumnName) {
16
+ return name + '_' + referencedColumnName;
28
17
  }
18
+ return name;
19
+ }
20
+ joinTableName(sourceEntity, targetEntity, propertyName, tableName) {
21
+ return this.classToTableName(sourceEntity, tableName) + '_' + this.propertyToColumnName(propertyName);
22
+ }
23
+ propertyToColumnName(propertyName) {
24
+ return propertyName;
25
+ }
26
+ referenceColumnName() {
27
+ return 'id';
28
+ }
29
29
  }
@@ -1,9 +1,10 @@
1
1
  import { AbstractNamingStrategy } from './AbstractNamingStrategy.js';
2
+ /** Naming strategy for MongoDB that uses camelCase property names and hyphenated collection names. */
2
3
  export declare class MongoNamingStrategy extends AbstractNamingStrategy {
3
- classToTableName(entityName: string, tableName?: string): string;
4
- joinColumnName(propertyName: string): string;
5
- joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
6
- joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
7
- propertyToColumnName(propertyName: string): string;
8
- referenceColumnName(): string;
4
+ classToTableName(entityName: string, tableName?: string): string;
5
+ joinColumnName(propertyName: string): string;
6
+ joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
7
+ joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
8
+ propertyToColumnName(propertyName: string): string;
9
+ referenceColumnName(): string;
9
10
  }
@@ -1,21 +1,22 @@
1
1
  import { AbstractNamingStrategy } from './AbstractNamingStrategy.js';
2
+ /** Naming strategy for MongoDB that uses camelCase property names and hyphenated collection names. */
2
3
  export class MongoNamingStrategy extends AbstractNamingStrategy {
3
- classToTableName(entityName, tableName) {
4
- return tableName ?? entityName.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
5
- }
6
- joinColumnName(propertyName) {
7
- return propertyName;
8
- }
9
- joinKeyColumnName(entityName, referencedColumnName, composite, tableName) {
10
- return tableName ?? entityName;
11
- }
12
- joinTableName(sourceEntity, targetEntity, propertyName, tableName) {
13
- return this.classToTableName(sourceEntity, tableName) + '_' + this.propertyToColumnName(propertyName);
14
- }
15
- propertyToColumnName(propertyName) {
16
- return propertyName;
17
- }
18
- referenceColumnName() {
19
- return '_id';
20
- }
4
+ classToTableName(entityName, tableName) {
5
+ return tableName ?? entityName.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
6
+ }
7
+ joinColumnName(propertyName) {
8
+ return propertyName;
9
+ }
10
+ joinKeyColumnName(entityName, referencedColumnName, composite, tableName) {
11
+ return tableName ?? entityName;
12
+ }
13
+ joinTableName(sourceEntity, targetEntity, propertyName, tableName) {
14
+ return this.classToTableName(sourceEntity, tableName) + '_' + this.propertyToColumnName(propertyName);
15
+ }
16
+ propertyToColumnName(propertyName) {
17
+ return propertyName;
18
+ }
19
+ referenceColumnName() {
20
+ return '_id';
21
+ }
21
22
  }
@@ -1,102 +1,112 @@
1
1
  import type { ReferenceKind } from '../enums.js';
2
2
  export interface NamingStrategy {
3
- /**
4
- * Return a name of the class based on its file name
5
- */
6
- getClassName(file: string, separator?: string): string;
7
- /**
8
- * Return a table name for an entity class
9
- */
10
- classToTableName(entityName: string, tableName?: string): string;
11
- /**
12
- * Return a migration name. This name should allow ordering.
13
- */
14
- classToMigrationName(timestamp: string, customMigrationName?: string): string;
15
- /**
16
- * Return a column name for a property
17
- */
18
- propertyToColumnName(propertyName: string, object?: boolean): string;
19
- /**
20
- * Get an enum class name.
21
- *
22
- * @param columnName The column name which has the enum.
23
- * @param tableName The table name of the column.
24
- * @param schemaName The schema name of the column.
25
- *
26
- * @return A new class name that will be used for the enum.
27
- */
28
- getEnumClassName(columnName: string, tableName: string | undefined, schemaName?: string): string;
29
- /**
30
- * Get an enum type name. Used with `enumType: 'dictionary'` and `enumType: 'union-type'` entity generator option.
31
- *
32
- * @param columnName The column name which has the enum.
33
- * @param tableName The table name of the column.
34
- * @param schemaName The schema name of the column.
35
- *
36
- * @return A new type name that will be used for the enum.
37
- */
38
- getEnumTypeName(columnName: string, tableName: string | undefined, schemaName?: string): string;
39
- /**
40
- * Get an enum option name for a given enum value.
41
- *
42
- * @param enumValue The enum value to generate a name for.
43
- * @param columnName The column name which has the enum.
44
- * @param tableName The table name of the column.
45
- * @param schemaName The schema name of the column.
46
- *
47
- * @return The name of the enum property that will hold the value.
48
- */
49
- enumValueToEnumProperty(enumValue: string, columnName: string, tableName: string, schemaName?: string): string;
50
- /**
51
- * Return a name of the entity class based on database table name (used in `EntityGenerator`).
52
- * Default implementation ignores the schema name.
53
- */
54
- getEntityName(tableName: string, schemaName?: string): string;
55
- /**
56
- * Return a property for a column name (used in `EntityGenerator`).
57
- */
58
- columnNameToProperty(columnName: string): string;
59
- /**
60
- * Return the default reference column name
61
- */
62
- referenceColumnName(): string;
63
- /**
64
- * Return a join column name for a property
65
- */
66
- joinColumnName(propertyName: string): string;
67
- /**
68
- * Return a join table name
69
- */
70
- joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
71
- /**
72
- * Return the foreign key column name for the given parameters
73
- */
74
- joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
75
- /**
76
- * Returns key/constraint name for the given type. Some drivers might not support all the types (e.g. mysql and sqlite enforce the PK name).
77
- */
78
- indexName(tableName: string, columns: string[], type: 'primary' | 'foreign' | 'unique' | 'index' | 'sequence' | 'check' | 'default'): string;
79
- /**
80
- * Returns alias name for given entity. The alias needs to be unique across the query, which is by default
81
- * ensured via appended index parameter. It is optional to use it as long as you ensure it will be unique.
82
- */
83
- aliasName(entityName: string, index: number): string;
84
- /**
85
- * Returns the name of the inverse side property. Used in the `EntityGenerator` with `bidirectionalRelations` option.
86
- */
87
- inverseSideName(entityName: string, propertyName: string, kind: ReferenceKind): string;
88
- /**
89
- * Return a property name for a many-to-many relation (used in `EntityGenerator`).
90
- *
91
- * @param ownerEntityName - The owner entity class name
92
- * @param targetEntityName - The target entity class name
93
- * @param pivotTableName - The pivot table name
94
- * @param ownerTableName - The owner table name
95
- * @param schemaName - The schema name (if any)
96
- */
97
- manyToManyPropertyName(ownerEntityName: string, targetEntityName: string, pivotTableName: string, ownerTableName: string, schemaName?: string): string;
98
- /**
99
- * Returns the discriminator column name for polymorphic relations.
100
- */
101
- discriminatorColumnName(baseName: string): string;
3
+ /**
4
+ * Return a name of the class based on its file name
5
+ */
6
+ getClassName(file: string, separator?: string): string;
7
+ /**
8
+ * Return a table name for an entity class
9
+ */
10
+ classToTableName(entityName: string, tableName?: string): string;
11
+ /**
12
+ * Return a migration name. This name should allow ordering.
13
+ */
14
+ classToMigrationName(timestamp: string, customMigrationName?: string): string;
15
+ /**
16
+ * Return a column name for a property
17
+ */
18
+ propertyToColumnName(propertyName: string, object?: boolean): string;
19
+ /**
20
+ * Get an enum class name.
21
+ *
22
+ * @param columnName The column name which has the enum.
23
+ * @param tableName The table name of the column.
24
+ * @param schemaName The schema name of the column.
25
+ *
26
+ * @return A new class name that will be used for the enum.
27
+ */
28
+ getEnumClassName(columnName: string, tableName: string | undefined, schemaName?: string): string;
29
+ /**
30
+ * Get an enum type name. Used with `enumType: 'dictionary'` and `enumType: 'union-type'` entity generator option.
31
+ *
32
+ * @param columnName The column name which has the enum.
33
+ * @param tableName The table name of the column.
34
+ * @param schemaName The schema name of the column.
35
+ *
36
+ * @return A new type name that will be used for the enum.
37
+ */
38
+ getEnumTypeName(columnName: string, tableName: string | undefined, schemaName?: string): string;
39
+ /**
40
+ * Get an enum option name for a given enum value.
41
+ *
42
+ * @param enumValue The enum value to generate a name for.
43
+ * @param columnName The column name which has the enum.
44
+ * @param tableName The table name of the column.
45
+ * @param schemaName The schema name of the column.
46
+ *
47
+ * @return The name of the enum property that will hold the value.
48
+ */
49
+ enumValueToEnumProperty(enumValue: string, columnName: string, tableName: string, schemaName?: string): string;
50
+ /**
51
+ * Return a name of the entity class based on database table name (used in `EntityGenerator`).
52
+ * Default implementation ignores the schema name.
53
+ */
54
+ getEntityName(tableName: string, schemaName?: string): string;
55
+ /**
56
+ * Return a property for a column name (used in `EntityGenerator`).
57
+ */
58
+ columnNameToProperty(columnName: string): string;
59
+ /**
60
+ * Return the default reference column name
61
+ */
62
+ referenceColumnName(): string;
63
+ /**
64
+ * Return a join column name for a property
65
+ */
66
+ joinColumnName(propertyName: string): string;
67
+ /**
68
+ * Return a join table name
69
+ */
70
+ joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
71
+ /**
72
+ * Return the foreign key column name for the given parameters
73
+ */
74
+ joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
75
+ /**
76
+ * Returns key/constraint name for the given type. Some drivers might not support all the types (e.g. mysql and sqlite enforce the PK name).
77
+ */
78
+ indexName(
79
+ tableName: string,
80
+ columns: string[],
81
+ type: 'primary' | 'foreign' | 'unique' | 'index' | 'sequence' | 'check' | 'default',
82
+ ): string;
83
+ /**
84
+ * Returns alias name for given entity. The alias needs to be unique across the query, which is by default
85
+ * ensured via appended index parameter. It is optional to use it as long as you ensure it will be unique.
86
+ */
87
+ aliasName(entityName: string, index: number): string;
88
+ /**
89
+ * Returns the name of the inverse side property. Used in the `EntityGenerator` with `bidirectionalRelations` option.
90
+ */
91
+ inverseSideName(entityName: string, propertyName: string, kind: ReferenceKind): string;
92
+ /**
93
+ * Return a property name for a many-to-many relation (used in `EntityGenerator`).
94
+ *
95
+ * @param ownerEntityName - The owner entity class name
96
+ * @param targetEntityName - The target entity class name
97
+ * @param pivotTableName - The pivot table name
98
+ * @param ownerTableName - The owner table name
99
+ * @param schemaName - The schema name (if any)
100
+ */
101
+ manyToManyPropertyName(
102
+ ownerEntityName: string,
103
+ targetEntityName: string,
104
+ pivotTableName: string,
105
+ ownerTableName: string,
106
+ schemaName?: string,
107
+ ): string;
108
+ /**
109
+ * Returns the discriminator column name for polymorphic relations.
110
+ */
111
+ discriminatorColumnName(baseName: string): string;
102
112
  }
@@ -1,10 +1,11 @@
1
1
  import { AbstractNamingStrategy } from './AbstractNamingStrategy.js';
2
+ /** Naming strategy that converts camelCase names to snake_case for table and column names. */
2
3
  export declare class UnderscoreNamingStrategy extends AbstractNamingStrategy {
3
- classToTableName(entityName: string, tableName?: string): string;
4
- joinColumnName(propertyName: string): string;
5
- joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
6
- joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
7
- propertyToColumnName(propertyName: string, object?: boolean): string;
8
- referenceColumnName(): string;
9
- private underscore;
4
+ classToTableName(entityName: string, tableName?: string): string;
5
+ joinColumnName(propertyName: string): string;
6
+ joinKeyColumnName(entityName: string, referencedColumnName?: string, composite?: boolean, tableName?: string): string;
7
+ joinTableName(sourceEntity: string, targetEntity: string, propertyName: string, tableName?: string): string;
8
+ propertyToColumnName(propertyName: string, object?: boolean): string;
9
+ referenceColumnName(): string;
10
+ private underscore;
10
11
  }