@expo/entity 0.31.1 → 0.33.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 (257) hide show
  1. package/build/ComposedEntityCacheAdapter.d.ts +4 -6
  2. package/build/ComposedEntityCacheAdapter.js +3 -6
  3. package/build/ComposedEntityCacheAdapter.js.map +1 -1
  4. package/build/EnforcingEntityLoader.d.ts +6 -1
  5. package/build/EnforcingEntityLoader.js +8 -0
  6. package/build/EnforcingEntityLoader.js.map +1 -1
  7. package/build/Entity.d.ts +20 -10
  8. package/build/Entity.js +2 -2
  9. package/build/Entity.js.map +1 -1
  10. package/build/EntityAssociationLoader.d.ts +9 -9
  11. package/build/EntityCompanion.d.ts +6 -5
  12. package/build/EntityCompanion.js +6 -4
  13. package/build/EntityCompanion.js.map +1 -1
  14. package/build/EntityCompanionProvider.d.ts +28 -36
  15. package/build/EntityCompanionProvider.js +4 -19
  16. package/build/EntityCompanionProvider.js.map +1 -1
  17. package/build/EntityConfiguration.d.ts +3 -3
  18. package/build/EntityConfiguration.js +2 -2
  19. package/build/EntityConfiguration.js.map +1 -1
  20. package/build/EntityDatabaseAdapter.d.ts +1 -1
  21. package/build/EntityDatabaseAdapter.js +1 -1
  22. package/build/EntityDatabaseAdapter.js.map +1 -1
  23. package/build/EntityFieldDefinition.d.ts +2 -2
  24. package/build/EntityFieldDefinition.js +1 -1
  25. package/build/EntityFieldDefinition.js.map +1 -1
  26. package/build/EntityLoader.d.ts +10 -2
  27. package/build/EntityLoader.js +32 -7
  28. package/build/EntityLoader.js.map +1 -1
  29. package/build/EntityLoaderFactory.d.ts +4 -7
  30. package/build/EntityLoaderFactory.js +3 -5
  31. package/build/EntityLoaderFactory.js.map +1 -1
  32. package/build/EntityMutationInfo.d.ts +3 -3
  33. package/build/EntityMutationInfo.js +1 -1
  34. package/build/EntityMutationInfo.js.map +1 -1
  35. package/build/EntityMutationTriggerConfiguration.d.ts +3 -3
  36. package/build/EntityMutationValidator.d.ts +1 -1
  37. package/build/EntityMutator.d.ts +9 -7
  38. package/build/EntityMutator.js +21 -21
  39. package/build/EntityMutator.js.map +1 -1
  40. package/build/EntityMutatorFactory.d.ts +4 -2
  41. package/build/EntityMutatorFactory.js +5 -4
  42. package/build/EntityMutatorFactory.js.map +1 -1
  43. package/build/EntityPrivacyPolicy.d.ts +3 -3
  44. package/build/EntityPrivacyPolicy.js +2 -2
  45. package/build/EntityPrivacyPolicy.js.map +1 -1
  46. package/build/EntityQueryContext.d.ts +13 -5
  47. package/build/EntityQueryContext.js +11 -4
  48. package/build/EntityQueryContext.js.map +1 -1
  49. package/build/EntityQueryContextProvider.d.ts +3 -3
  50. package/build/EntityQueryContextProvider.js +2 -2
  51. package/build/EntityQueryContextProvider.js.map +1 -1
  52. package/build/EntitySecondaryCacheLoader.d.ts +1 -1
  53. package/build/EntitySecondaryCacheLoader.js +1 -1
  54. package/build/EntitySecondaryCacheLoader.js.map +1 -1
  55. package/build/GenericEntityCacheAdapter.d.ts +14 -0
  56. package/build/GenericEntityCacheAdapter.js +38 -0
  57. package/build/GenericEntityCacheAdapter.js.map +1 -0
  58. package/build/{EntityCacheAdapter.d.ts → IEntityCacheAdapter.d.ts} +5 -8
  59. package/build/IEntityCacheAdapter.js +3 -0
  60. package/build/IEntityCacheAdapter.js.map +1 -0
  61. package/build/IEntityCacheAdapterProvider.d.ts +2 -2
  62. package/build/IEntityGenericCacher.d.ts +31 -2
  63. package/build/ReadonlyEntity.d.ts +19 -7
  64. package/build/ReadonlyEntity.js +15 -13
  65. package/build/ReadonlyEntity.js.map +1 -1
  66. package/build/ViewerContext.d.ts +3 -3
  67. package/build/ViewerContext.js +3 -3
  68. package/build/ViewerContext.js.map +1 -1
  69. package/build/ViewerScopedEntityCompanion.d.ts +2 -2
  70. package/build/ViewerScopedEntityCompanion.js.map +1 -1
  71. package/build/ViewerScopedEntityCompanionProvider.d.ts +3 -3
  72. package/build/ViewerScopedEntityCompanionProvider.js +3 -3
  73. package/build/ViewerScopedEntityCompanionProvider.js.map +1 -1
  74. package/build/ViewerScopedEntityLoaderFactory.d.ts +1 -1
  75. package/build/ViewerScopedEntityMutatorFactory.d.ts +1 -1
  76. package/build/__tests__/ComposedCacheAdapter-test.js +4 -8
  77. package/build/__tests__/ComposedCacheAdapter-test.js.map +1 -1
  78. package/build/__tests__/EnforcingEntityLoader-test.js +28 -0
  79. package/build/__tests__/EnforcingEntityLoader-test.js.map +1 -1
  80. package/build/__tests__/Entity-test.js +42 -20
  81. package/build/__tests__/Entity-test.js.map +1 -1
  82. package/build/__tests__/EntityAssociationLoader-test.js +6 -6
  83. package/build/__tests__/EntityAssociationLoader-test.js.map +1 -1
  84. package/build/__tests__/EntityCommonUseCases-test.js +20 -22
  85. package/build/__tests__/EntityCommonUseCases-test.js.map +1 -1
  86. package/build/__tests__/EntityCompanion-test.js +2 -1
  87. package/build/__tests__/EntityCompanion-test.js.map +1 -1
  88. package/build/__tests__/EntityCompanionProvider-test.js +15 -40
  89. package/build/__tests__/EntityCompanionProvider-test.js.map +1 -1
  90. package/build/__tests__/EntityEdges-test.js +48 -54
  91. package/build/__tests__/EntityEdges-test.js.map +1 -1
  92. package/build/__tests__/EntityLoader-constructor-test.d.ts +9 -5
  93. package/build/__tests__/EntityLoader-constructor-test.js +13 -14
  94. package/build/__tests__/EntityLoader-constructor-test.js.map +1 -1
  95. package/build/__tests__/EntityLoader-test.js +22 -12
  96. package/build/__tests__/EntityLoader-test.js.map +1 -1
  97. package/build/__tests__/EntityMutator-MutationCacheConsistency-test.js +20 -22
  98. package/build/__tests__/EntityMutator-MutationCacheConsistency-test.js.map +1 -1
  99. package/build/__tests__/EntityMutator-test.js +67 -14
  100. package/build/__tests__/EntityMutator-test.js.map +1 -1
  101. package/build/__tests__/EntityPrivacyPolicy-test.js +82 -29
  102. package/build/__tests__/EntityPrivacyPolicy-test.js.map +1 -1
  103. package/build/__tests__/EntityQueryContext-test.js +12 -0
  104. package/build/__tests__/EntityQueryContext-test.js.map +1 -1
  105. package/build/__tests__/EntitySecondaryCacheLoader-test.js +1 -2
  106. package/build/__tests__/EntitySecondaryCacheLoader-test.js.map +1 -1
  107. package/build/__tests__/EntitySelfReferentialEdges-test.js +16 -20
  108. package/build/__tests__/EntitySelfReferentialEdges-test.js.map +1 -1
  109. package/build/__tests__/GenericEntityCacheAdapter-test.d.ts +1 -0
  110. package/build/__tests__/GenericEntityCacheAdapter-test.js +80 -0
  111. package/build/__tests__/GenericEntityCacheAdapter-test.js.map +1 -0
  112. package/build/__tests__/ReadonlyEntity-test.js +79 -13
  113. package/build/__tests__/ReadonlyEntity-test.js.map +1 -1
  114. package/build/__tests__/ViewerScopedEntityCompanionProvider-test.js +2 -25
  115. package/build/__tests__/ViewerScopedEntityCompanionProvider-test.js.map +1 -1
  116. package/build/__tests__/cases/TwoEntitySameTableDisjointRows-test.js +20 -23
  117. package/build/__tests__/cases/TwoEntitySameTableDisjointRows-test.js.map +1 -1
  118. package/build/__tests__/cases/TwoEntitySameTableOverlappingRows-test.js +17 -20
  119. package/build/__tests__/cases/TwoEntitySameTableOverlappingRows-test.js.map +1 -1
  120. package/build/errors/EntityError.js +2 -2
  121. package/build/errors/EntityError.js.map +1 -1
  122. package/build/errors/EntityInvalidFieldValueError.d.ts +2 -2
  123. package/build/errors/EntityInvalidFieldValueError.js.map +1 -1
  124. package/build/errors/EntityNotAuthorizedError.d.ts +2 -2
  125. package/build/errors/EntityNotAuthorizedError.js +1 -1
  126. package/build/errors/EntityNotAuthorizedError.js.map +1 -1
  127. package/build/errors/EntityNotFoundError.d.ts +2 -2
  128. package/build/errors/EntityNotFoundError.js.map +1 -1
  129. package/build/index.d.ts +2 -1
  130. package/build/index.js +3 -3
  131. package/build/index.js.map +1 -1
  132. package/build/internal/EntityDataManager.d.ts +1 -1
  133. package/build/internal/EntityDataManager.js +1 -1
  134. package/build/internal/EntityDataManager.js.map +1 -1
  135. package/build/internal/EntityFieldTransformationUtils.d.ts +1 -1
  136. package/build/internal/EntityFieldTransformationUtils.js +4 -4
  137. package/build/internal/EntityFieldTransformationUtils.js.map +1 -1
  138. package/build/internal/EntityTableDataCoordinator.d.ts +3 -3
  139. package/build/internal/EntityTableDataCoordinator.js.map +1 -1
  140. package/build/internal/ReadThroughEntityCache.d.ts +3 -3
  141. package/build/internal/ReadThroughEntityCache.js +1 -1
  142. package/build/internal/ReadThroughEntityCache.js.map +1 -1
  143. package/build/internal/__tests__/EntityDataManager-test.js +1 -1
  144. package/build/internal/__tests__/EntityDataManager-test.js.map +1 -1
  145. package/build/internal/__tests__/ReadThroughEntityCache-test.js.map +1 -1
  146. package/build/metrics/EntityMetricsUtils.js.map +1 -1
  147. package/build/metrics/IEntityMetricsAdapter.js +4 -4
  148. package/build/metrics/IEntityMetricsAdapter.js.map +1 -1
  149. package/build/rules/AlwaysAllowPrivacyPolicyRule.d.ts +2 -2
  150. package/build/rules/AlwaysAllowPrivacyPolicyRule.js.map +1 -1
  151. package/build/rules/AlwaysDenyPrivacyPolicyRule.d.ts +2 -2
  152. package/build/rules/AlwaysDenyPrivacyPolicyRule.js.map +1 -1
  153. package/build/rules/AlwaysSkipPrivacyPolicyRule.d.ts +2 -2
  154. package/build/rules/AlwaysSkipPrivacyPolicyRule.js.map +1 -1
  155. package/build/rules/PrivacyPolicyRule.d.ts +1 -1
  156. package/build/rules/PrivacyPolicyRule.js +1 -1
  157. package/build/rules/PrivacyPolicyRule.js.map +1 -1
  158. package/build/testfixtures/DateIDTestEntity.d.ts +2 -3
  159. package/build/testfixtures/DateIDTestEntity.js +7 -9
  160. package/build/testfixtures/DateIDTestEntity.js.map +1 -1
  161. package/build/testfixtures/SimpleTestEntity.d.ts +3 -4
  162. package/build/testfixtures/SimpleTestEntity.js +7 -9
  163. package/build/testfixtures/SimpleTestEntity.js.map +1 -1
  164. package/build/testfixtures/TestEntity.d.ts +2 -3
  165. package/build/testfixtures/TestEntity.js +14 -10
  166. package/build/testfixtures/TestEntity.js.map +1 -1
  167. package/build/testfixtures/TestEntity2.d.ts +2 -3
  168. package/build/testfixtures/TestEntity2.js +7 -9
  169. package/build/testfixtures/TestEntity2.js.map +1 -1
  170. package/build/testfixtures/TestEntityNumberKey.d.ts +2 -3
  171. package/build/testfixtures/TestEntityNumberKey.js +7 -9
  172. package/build/testfixtures/TestEntityNumberKey.js.map +1 -1
  173. package/build/utils/testing/PrivacyPolicyRuleTestUtils.d.ts +4 -4
  174. package/build/utils/testing/StubCacheAdapter.d.ts +6 -5
  175. package/build/utils/testing/StubCacheAdapter.js +5 -6
  176. package/build/utils/testing/StubCacheAdapter.js.map +1 -1
  177. package/build/utils/testing/StubDatabaseAdapterProvider.js.map +1 -1
  178. package/build/utils/testing/StubQueryContextProvider.d.ts +2 -1
  179. package/build/utils/testing/StubQueryContextProvider.js +1 -1
  180. package/build/utils/testing/StubQueryContextProvider.js.map +1 -1
  181. package/build/utils/testing/createUnitTestEntityCompanionProvider.js +2 -2
  182. package/build/utils/testing/createUnitTestEntityCompanionProvider.js.map +1 -1
  183. package/package.json +3 -3
  184. package/src/ComposedEntityCacheAdapter.ts +4 -11
  185. package/src/EnforcingEntityLoader.ts +10 -1
  186. package/src/Entity.ts +23 -12
  187. package/src/EntityAssociationLoader.ts +12 -12
  188. package/src/EntityCompanion.ts +13 -32
  189. package/src/EntityCompanionProvider.ts +41 -80
  190. package/src/EntityConfiguration.ts +4 -5
  191. package/src/EntityFieldDefinition.ts +2 -2
  192. package/src/EntityLoader.ts +36 -2
  193. package/src/EntityLoaderFactory.ts +7 -9
  194. package/src/EntityMutationInfo.ts +2 -2
  195. package/src/EntityMutationTriggerConfiguration.ts +3 -3
  196. package/src/EntityMutationValidator.ts +1 -1
  197. package/src/EntityMutator.ts +38 -31
  198. package/src/EntityMutatorFactory.ts +6 -1
  199. package/src/EntityPrivacyPolicy.ts +2 -2
  200. package/src/EntityQueryContext.ts +24 -4
  201. package/src/EntityQueryContextProvider.ts +7 -5
  202. package/src/EntitySecondaryCacheLoader.ts +1 -1
  203. package/src/GenericEntityCacheAdapter.ts +65 -0
  204. package/src/{EntityCacheAdapter.ts → IEntityCacheAdapter.ts} +5 -8
  205. package/src/IEntityCacheAdapterProvider.ts +2 -2
  206. package/src/IEntityGenericCacher.ts +32 -2
  207. package/src/ReadonlyEntity.ts +32 -32
  208. package/src/ViewerContext.ts +10 -8
  209. package/src/ViewerScopedEntityCompanion.ts +2 -2
  210. package/src/ViewerScopedEntityCompanionProvider.ts +4 -12
  211. package/src/ViewerScopedEntityLoaderFactory.ts +1 -1
  212. package/src/ViewerScopedEntityMutatorFactory.ts +1 -1
  213. package/src/__tests__/ComposedCacheAdapter-test.ts +6 -11
  214. package/src/__tests__/EnforcingEntityLoader-test.ts +44 -0
  215. package/src/__tests__/Entity-test.ts +42 -21
  216. package/src/__tests__/EntityCommonUseCases-test.ts +20 -22
  217. package/src/__tests__/EntityCompanion-test.ts +6 -9
  218. package/src/__tests__/EntityCompanionProvider-test.ts +14 -26
  219. package/src/__tests__/EntityEdges-test.ts +43 -49
  220. package/src/__tests__/EntityLoader-constructor-test.ts +16 -12
  221. package/src/__tests__/EntityLoader-test.ts +14 -1
  222. package/src/__tests__/EntityMutator-MutationCacheConsistency-test.ts +20 -22
  223. package/src/__tests__/EntityMutator-test.ts +119 -19
  224. package/src/__tests__/EntityPrivacyPolicy-test.ts +82 -29
  225. package/src/__tests__/EntityQueryContext-test.ts +23 -1
  226. package/src/__tests__/EntitySelfReferentialEdges-test.ts +8 -10
  227. package/src/__tests__/GenericEntityCacheAdapter-test.ts +102 -0
  228. package/src/__tests__/ReadonlyEntity-test.ts +79 -13
  229. package/src/__tests__/ViewerScopedEntityCompanionProvider-test.ts +2 -5
  230. package/src/__tests__/cases/TwoEntitySameTableDisjointRows-test.ts +30 -24
  231. package/src/__tests__/cases/TwoEntitySameTableOverlappingRows-test.ts +14 -18
  232. package/src/errors/EntityInvalidFieldValueError.ts +2 -2
  233. package/src/errors/EntityNotAuthorizedError.ts +2 -2
  234. package/src/errors/EntityNotFoundError.ts +2 -2
  235. package/src/index.ts +2 -1
  236. package/src/internal/EntityDataManager.ts +1 -1
  237. package/src/internal/EntityTableDataCoordinator.ts +4 -4
  238. package/src/internal/ReadThroughEntityCache.ts +2 -2
  239. package/src/internal/__tests__/EntityDataManager-test.ts +2 -1
  240. package/src/internal/__tests__/ReadThroughEntityCache-test.ts +8 -8
  241. package/src/metrics/EntityMetricsUtils.ts +1 -1
  242. package/src/rules/AlwaysAllowPrivacyPolicyRule.ts +2 -2
  243. package/src/rules/AlwaysDenyPrivacyPolicyRule.ts +2 -2
  244. package/src/rules/AlwaysSkipPrivacyPolicyRule.ts +2 -2
  245. package/src/rules/PrivacyPolicyRule.ts +1 -1
  246. package/src/testfixtures/DateIDTestEntity.ts +6 -8
  247. package/src/testfixtures/SimpleTestEntity.ts +6 -8
  248. package/src/testfixtures/TestEntity.ts +19 -15
  249. package/src/testfixtures/TestEntity2.ts +6 -8
  250. package/src/testfixtures/TestEntityNumberKey.ts +6 -8
  251. package/src/utils/testing/PrivacyPolicyRuleTestUtils.ts +4 -4
  252. package/src/utils/testing/StubCacheAdapter.ts +9 -11
  253. package/src/utils/testing/StubDatabaseAdapterProvider.ts +1 -1
  254. package/src/utils/testing/StubQueryContextProvider.ts +4 -3
  255. package/src/utils/testing/createUnitTestEntityCompanionProvider.ts +3 -3
  256. package/build/EntityCacheAdapter.js +0 -13
  257. package/build/EntityCacheAdapter.js.map +0 -1
@@ -12,7 +12,7 @@ import ViewerContext from './ViewerContext';
12
12
  * by foreign keys.
13
13
  */
14
14
  export default class EntityAssociationLoader<
15
- TFields,
15
+ TFields extends object,
16
16
  TID extends NonNullable<TFields[TSelectedFields]>,
17
17
  TViewerContext extends ViewerContext,
18
18
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -29,7 +29,7 @@ export default class EntityAssociationLoader<
29
29
  */
30
30
  async loadAssociatedEntityAsync<
31
31
  TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
32
- TAssociatedFields,
32
+ TAssociatedFields extends object,
33
33
  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
34
34
  TAssociatedEntity extends ReadonlyEntity<
35
35
  TAssociatedFields,
@@ -91,7 +91,7 @@ export default class EntityAssociationLoader<
91
91
  * @param queryContext - query context in which to perform the load
92
92
  */
93
93
  async loadManyAssociatedEntitiesAsync<
94
- TAssociatedFields,
94
+ TAssociatedFields extends object,
95
95
  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
96
96
  TAssociatedEntity extends ReadonlyEntity<
97
97
  TAssociatedFields,
@@ -144,7 +144,7 @@ export default class EntityAssociationLoader<
144
144
  * @param queryContext - query context in which to perform the load
145
145
  */
146
146
  async loadAssociatedEntityByFieldEqualingAsync<
147
- TAssociatedFields,
147
+ TAssociatedFields extends object,
148
148
  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
149
149
  TAssociatedEntity extends ReadonlyEntity<
150
150
  TAssociatedFields,
@@ -201,7 +201,7 @@ export default class EntityAssociationLoader<
201
201
  * @param queryContext - query context in which to perform the load
202
202
  */
203
203
  async loadManyAssociatedEntitiesByFieldEqualingAsync<
204
- TAssociatedFields,
204
+ TAssociatedFields extends object,
205
205
  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
206
206
  TAssociatedEntity extends ReadonlyEntity<
207
207
  TAssociatedFields,
@@ -257,7 +257,7 @@ export default class EntityAssociationLoader<
257
257
  * @param queryContext - query context in which to perform the loads
258
258
  */
259
259
  async loadAssociatedEntityThroughAsync<
260
- TFields2,
260
+ TFields2 extends object,
261
261
  TID2 extends NonNullable<TFields2[TSelectedFields2]>,
262
262
  TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
263
263
  TPrivacyPolicy2 extends EntityPrivacyPolicy<
@@ -291,7 +291,7 @@ export default class EntityAssociationLoader<
291
291
  * @param queryContext - query context in which to perform the loads
292
292
  */
293
293
  async loadAssociatedEntityThroughAsync<
294
- TFields2,
294
+ TFields2 extends object,
295
295
  TID2 extends NonNullable<TFields2[TSelectedFields2]>,
296
296
  TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
297
297
  TPrivacyPolicy2 extends EntityPrivacyPolicy<
@@ -301,7 +301,7 @@ export default class EntityAssociationLoader<
301
301
  TEntity2,
302
302
  TSelectedFields2
303
303
  >,
304
- TFields3,
304
+ TFields3 extends object,
305
305
  TID3 extends NonNullable<TFields3[TSelectedFields3]>,
306
306
  TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
307
307
  TPrivacyPolicy3 extends EntityPrivacyPolicy<
@@ -346,7 +346,7 @@ export default class EntityAssociationLoader<
346
346
  * @param queryContext - query context in which to perform the loads
347
347
  */
348
348
  async loadAssociatedEntityThroughAsync<
349
- TFields2,
349
+ TFields2 extends object,
350
350
  TID2 extends NonNullable<TFields2[TSelectedFields2]>,
351
351
  TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
352
352
  TPrivacyPolicy2 extends EntityPrivacyPolicy<
@@ -356,7 +356,7 @@ export default class EntityAssociationLoader<
356
356
  TEntity2,
357
357
  TSelectedFields2
358
358
  >,
359
- TFields3,
359
+ TFields3 extends object,
360
360
  TID3 extends NonNullable<TFields3[TSelectedFields3]>,
361
361
  TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
362
362
  TPrivacyPolicy3 extends EntityPrivacyPolicy<
@@ -366,7 +366,7 @@ export default class EntityAssociationLoader<
366
366
  TEntity3,
367
367
  TSelectedFields3
368
368
  >,
369
- TFields4,
369
+ TFields4 extends object,
370
370
  TID4 extends NonNullable<TFields4[TSelectedFields4]>,
371
371
  TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
372
372
  TPrivacyPolicy4 extends EntityPrivacyPolicy<
@@ -482,7 +482,7 @@ export default class EntityAssociationLoader<
482
482
  export interface EntityLoadThroughDirective<
483
483
  TViewerContext extends ViewerContext,
484
484
  TFields,
485
- TAssociatedFields,
485
+ TAssociatedFields extends object,
486
486
  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
487
487
  TAssociatedEntity extends ReadonlyEntity<
488
488
  TAssociatedFields,
@@ -1,7 +1,5 @@
1
- import { IEntityClass } from './Entity';
1
+ import EntityCompanionProvider, { EntityCompanionDefinition } from './EntityCompanionProvider';
2
2
  import EntityLoaderFactory from './EntityLoaderFactory';
3
- import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
4
- import EntityMutationValidator from './EntityMutationValidator';
5
3
  import EntityMutatorFactory from './EntityMutatorFactory';
6
4
  import EntityPrivacyPolicy from './EntityPrivacyPolicy';
7
5
  import EntityQueryContextProvider from './EntityQueryContextProvider';
@@ -18,7 +16,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
18
16
  * Composition root responsible for orchestrating setup of Entity mutators and loaders.
19
17
  */
20
18
  export default class EntityCompanion<
21
- TFields,
19
+ TFields extends object,
22
20
  TID extends NonNullable<TFields[TSelectedFields]>,
23
21
  TViewerContext extends ViewerContext,
24
22
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -31,6 +29,8 @@ export default class EntityCompanion<
31
29
  >,
32
30
  TSelectedFields extends keyof TFields
33
31
  > {
32
+ public readonly privacyPolicy: TPrivacyPolicy;
33
+
34
34
  private readonly entityLoaderFactory: EntityLoaderFactory<
35
35
  TFields,
36
36
  TID,
@@ -49,7 +49,8 @@ export default class EntityCompanion<
49
49
  >;
50
50
 
51
51
  constructor(
52
- entityClass: IEntityClass<
52
+ public readonly entityCompanionProvider: EntityCompanionProvider,
53
+ public readonly entityCompanionDefinition: EntityCompanionDefinition<
53
54
  TFields,
54
55
  TID,
55
56
  TViewerContext,
@@ -58,24 +59,9 @@ export default class EntityCompanion<
58
59
  TSelectedFields
59
60
  >,
60
61
  private readonly tableDataCoordinator: EntityTableDataCoordinator<TFields>,
61
- PrivacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>,
62
- mutationValidators: EntityMutationValidator<
63
- TFields,
64
- TID,
65
- TViewerContext,
66
- TEntity,
67
- TSelectedFields
68
- >[],
69
- mutationTriggers: EntityMutationTriggerConfiguration<
70
- TFields,
71
- TID,
72
- TViewerContext,
73
- TEntity,
74
- TSelectedFields
75
- >,
76
62
  private readonly metricsAdapter: IEntityMetricsAdapter
77
63
  ) {
78
- const privacyPolicy = new PrivacyPolicyClass();
64
+ this.privacyPolicy = new entityCompanionDefinition.privacyPolicyClass();
79
65
  this.entityLoaderFactory = new EntityLoaderFactory<
80
66
  TFields,
81
67
  TID,
@@ -83,19 +69,14 @@ export default class EntityCompanion<
83
69
  TEntity,
84
70
  TPrivacyPolicy,
85
71
  TSelectedFields
86
- >(
87
- tableDataCoordinator.entityConfiguration,
88
- entityClass,
89
- privacyPolicy,
90
- tableDataCoordinator.dataManager,
91
- metricsAdapter
92
- );
72
+ >(this, tableDataCoordinator.dataManager, metricsAdapter);
93
73
  this.entityMutatorFactory = new EntityMutatorFactory(
74
+ entityCompanionProvider,
94
75
  tableDataCoordinator.entityConfiguration,
95
- entityClass,
96
- privacyPolicy,
97
- mutationValidators,
98
- mutationTriggers,
76
+ entityCompanionDefinition.entityClass,
77
+ this.privacyPolicy,
78
+ entityCompanionDefinition.mutationValidators ?? [],
79
+ entityCompanionDefinition.mutationTriggers ?? {},
99
80
  this.entityLoaderFactory,
100
81
  tableDataCoordinator.databaseAdapter,
101
82
  metricsAdapter
@@ -49,8 +49,8 @@ export interface CacheAdapterFlavorDefinition {
49
49
  * Definition for constructing a companion for an entity. Defines the core set of objects
50
50
  * used to power the entity framework for a particular type of entity.
51
51
  */
52
- export class EntityCompanionDefinition<
53
- TFields,
52
+ export interface EntityCompanionDefinition<
53
+ TFields extends object,
54
54
  TID extends NonNullable<TFields[TSelectedFields]>,
55
55
  TViewerContext extends ViewerContext,
56
56
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -63,6 +63,9 @@ export class EntityCompanionDefinition<
63
63
  >,
64
64
  TSelectedFields extends keyof TFields = keyof TFields
65
65
  > {
66
+ /**
67
+ * The concrete Entity class for which this is the definition.
68
+ */
66
69
  readonly entityClass: IEntityClass<
67
70
  TFields,
68
71
  TID,
@@ -71,85 +74,45 @@ export class EntityCompanionDefinition<
71
74
  TPrivacyPolicy,
72
75
  TSelectedFields
73
76
  >;
77
+
78
+ /**
79
+ * The EntityConfiguration for this entity.
80
+ */
74
81
  readonly entityConfiguration: EntityConfiguration<TFields>;
82
+
83
+ /**
84
+ * The EntityPrivacyPolicy class for this entity.
85
+ */
75
86
  readonly privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
76
- readonly mutationValidators: () => EntityMutationValidator<
87
+
88
+ /**
89
+ * An optional list of EntityMutationValidator for this entity.
90
+ */
91
+ readonly mutationValidators?: EntityMutationValidator<
77
92
  TFields,
78
93
  TID,
79
94
  TViewerContext,
80
95
  TEntity,
81
96
  TSelectedFields
82
97
  >[];
83
- readonly mutationTriggers: () => EntityMutationTriggerConfiguration<
98
+
99
+ /**
100
+ * An optional list of EntityMutationTrigger for this entity.
101
+ */
102
+ readonly mutationTriggers?: EntityMutationTriggerConfiguration<
84
103
  TFields,
85
104
  TID,
86
105
  TViewerContext,
87
106
  TEntity,
88
107
  TSelectedFields
89
108
  >;
90
- readonly entitySelectedFields: TSelectedFields[];
91
109
 
92
- constructor({
93
- entityClass,
94
- entityConfiguration,
95
- privacyPolicyClass,
96
- mutationValidators = () => [],
97
- mutationTriggers = () => ({}),
98
- entitySelectedFields = Array.from(entityConfiguration.schema.keys()) as TSelectedFields[],
99
- }: {
100
- /**
101
- * The concrete Entity class for which this is the definition.
102
- */
103
- entityClass: IEntityClass<
104
- TFields,
105
- TID,
106
- TViewerContext,
107
- TEntity,
108
- TPrivacyPolicy,
109
- TSelectedFields
110
- >;
111
- /**
112
- * The EntityConfiguration for this entity.
113
- */
114
- entityConfiguration: EntityConfiguration<TFields>;
115
- /**
116
- * The EntityPrivacyPolicy class for this entity.
117
- */
118
- privacyPolicyClass: IPrivacyPolicyClass<TPrivacyPolicy>;
119
- /**
120
- * An optional list of EntityMutationValidator for this entity.
121
- */
122
- mutationValidators?: () => EntityMutationValidator<
123
- TFields,
124
- TID,
125
- TViewerContext,
126
- TEntity,
127
- TSelectedFields
128
- >[];
129
- /**
130
- * An optional list of EntityMutationTrigger for this entity.
131
- */
132
- mutationTriggers?: () => EntityMutationTriggerConfiguration<
133
- TFields,
134
- TID,
135
- TViewerContext,
136
- TEntity,
137
- TSelectedFields
138
- >;
139
- /**
140
- * An optional subset of fields defined in the EntityConfiguration which belong to this entity.
141
- * For use when multiple types of entities are backed by a single table (EntityConfiguration) yet
142
- * only expose a subset of the fields.
143
- */
144
- entitySelectedFields?: TSelectedFields[];
145
- }) {
146
- this.entityClass = entityClass;
147
- this.entityConfiguration = entityConfiguration;
148
- this.privacyPolicyClass = privacyPolicyClass;
149
- this.mutationValidators = mutationValidators;
150
- this.mutationTriggers = mutationTriggers;
151
- this.entitySelectedFields = entitySelectedFields;
152
- }
110
+ /**
111
+ * An optional subset of fields defined in the EntityConfiguration which belong to this entity.
112
+ * For use when multiple types of entities are backed by a single table (EntityConfiguration) yet
113
+ * only expose a subset of the fields.
114
+ */
115
+ readonly entitySelectedFields?: TSelectedFields[];
153
116
  }
154
117
 
155
118
  /**
@@ -162,6 +125,10 @@ export class EntityCompanionDefinition<
162
125
  * EntityCompanion for each type of Entity.
163
126
  */
164
127
  export default class EntityCompanionProvider {
128
+ private readonly companionDefinitionMap: Map<
129
+ string,
130
+ EntityCompanionDefinition<any, any, any, any, any, any>
131
+ > = new Map();
165
132
  private readonly companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> =
166
133
  new Map();
167
134
  private readonly tableDataCoordinatorMap: Map<string, EntityTableDataCoordinator<any>> =
@@ -187,10 +154,9 @@ export default class EntityCompanionProvider {
187
154
  * companion is constructed using the configuration provided by the factory.
188
155
  *
189
156
  * @param entityClass - entity class to load
190
- * @param factory - entity companion factory
191
157
  */
192
158
  getCompanionForEntity<
193
- TFields,
159
+ TFields extends object,
194
160
  TID extends NonNullable<TFields[TSelectedFields]>,
195
161
  TViewerContext extends ViewerContext,
196
162
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -210,27 +176,22 @@ export default class EntityCompanionProvider {
210
176
  TEntity,
211
177
  TPrivacyPolicy,
212
178
  TSelectedFields
213
- >,
214
- entityCompanionDefinition: EntityCompanionDefinition<
215
- TFields,
216
- TID,
217
- TViewerContext,
218
- TEntity,
219
- TPrivacyPolicy,
220
- TSelectedFields
221
179
  >
222
180
  ): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
181
+ const entityCompanionDefinition = computeIfAbsent(
182
+ this.companionDefinitionMap,
183
+ entityClass.name,
184
+ () => entityClass.defineCompanionDefinition()
185
+ );
223
186
  const tableDataCoordinator = this.getTableDataCoordinatorForEntity(
224
187
  entityCompanionDefinition.entityConfiguration,
225
188
  entityClass.name
226
189
  );
227
190
  return computeIfAbsent(this.companionMap, entityClass.name, () => {
228
191
  return new EntityCompanion(
229
- entityCompanionDefinition.entityClass,
192
+ this,
193
+ entityCompanionDefinition,
230
194
  tableDataCoordinator,
231
- entityCompanionDefinition.privacyPolicyClass,
232
- entityCompanionDefinition.mutationValidators(),
233
- entityCompanionDefinition.mutationTriggers(),
234
195
  this.metricsAdapter
235
196
  );
236
197
  });
@@ -13,7 +13,7 @@ export default class EntityConfiguration<TFields> {
13
13
  readonly cacheableKeys: ReadonlySet<keyof TFields>;
14
14
  readonly cacheKeyVersion: number;
15
15
 
16
- readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
16
+ readonly inboundEdges: IEntityClass<any, any, any, any, any, any>[];
17
17
  readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
18
18
  readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
19
19
  readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
@@ -25,7 +25,7 @@ export default class EntityConfiguration<TFields> {
25
25
  idField,
26
26
  tableName,
27
27
  schema,
28
- getInboundEdges = () => [],
28
+ inboundEdges = [],
29
29
  cacheKeyVersion = 0,
30
30
  databaseAdapterFlavor,
31
31
  cacheAdapterFlavor,
@@ -48,7 +48,7 @@ export default class EntityConfiguration<TFields> {
48
48
  /**
49
49
  * List of other entity types that reference this type in EntityFieldDefinition associations.
50
50
  */
51
- getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
51
+ inboundEdges?: IEntityClass<any, any, any, any, any, any>[];
52
52
 
53
53
  /**
54
54
  * Cache key version for this entity type. Should be bumped when a field is added to, removed from, or changed
@@ -71,8 +71,7 @@ export default class EntityConfiguration<TFields> {
71
71
  this.cacheKeyVersion = cacheKeyVersion;
72
72
  this.databaseAdapterFlavor = databaseAdapterFlavor;
73
73
  this.cacheAdapterFlavor = cacheAdapterFlavor;
74
-
75
- this.getInboundEdges = getInboundEdges;
74
+ this.inboundEdges = inboundEdges;
76
75
 
77
76
  // external schema is a Record to typecheck that all fields have FieldDefinitions,
78
77
  // but internally the most useful representation is a map for lookups
@@ -41,7 +41,7 @@ export enum EntityEdgeDeletionBehavior {
41
41
  */
42
42
  export interface EntityAssociationDefinition<
43
43
  TViewerContext extends ViewerContext,
44
- TAssociatedFields,
44
+ TAssociatedFields extends object,
45
45
  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
46
46
  TAssociatedEntity extends ReadonlyEntity<
47
47
  TAssociatedFields,
@@ -61,7 +61,7 @@ export interface EntityAssociationDefinition<
61
61
  /**
62
62
  * Class of entity on the other end of this edge.
63
63
  */
64
- getAssociatedEntityClass: () => IEntityClass<
64
+ associatedEntityClass: IEntityClass<
65
65
  TAssociatedFields,
66
66
  TAssociatedID,
67
67
  TViewerContext,
@@ -1,5 +1,6 @@
1
1
  import { Result, asyncResult, result } from '@expo/results';
2
2
  import invariant from 'invariant';
3
+ import nullthrows from 'nullthrows';
3
4
 
4
5
  import EnforcingEntityLoader from './EnforcingEntityLoader';
5
6
  import { IEntityClass } from './Entity';
@@ -14,6 +15,7 @@ import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './Ent
14
15
  import { EntityQueryContext } from './EntityQueryContext';
15
16
  import ReadonlyEntity from './ReadonlyEntity';
16
17
  import ViewerContext from './ViewerContext';
18
+ import { pick } from './entityUtils';
17
19
  import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
18
20
  import EntityNotFoundError from './errors/EntityNotFoundError';
19
21
  import EntityDataManager from './internal/EntityDataManager';
@@ -25,7 +27,7 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
25
27
  * cached, and authorized against the entity's EntityPrivacyPolicy.
26
28
  */
27
29
  export default class EntityLoader<
28
- TFields,
30
+ TFields extends object,
29
31
  TID extends NonNullable<TFields[TSelectedFields]>,
30
32
  TViewerContext extends ViewerContext,
31
33
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -51,6 +53,7 @@ export default class EntityLoader<
51
53
  TPrivacyPolicy,
52
54
  TSelectedFields
53
55
  >,
56
+ private readonly entitySelectedFields: TSelectedFields[] | undefined,
54
57
  private readonly privacyPolicy: TPrivacyPolicy,
55
58
  private readonly dataManager: EntityDataManager<TFields>,
56
59
  protected readonly metricsAdapter: IEntityMetricsAdapter
@@ -182,6 +185,23 @@ export default class EntityLoader<
182
185
  });
183
186
  }
184
187
 
188
+ /**
189
+ * Loads many entities for a list of IDs, returning null for any IDs that are non-existent.
190
+ * @param ids - IDs of the entities to load
191
+ * @returns map from ID to nullable corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
192
+ */
193
+ async loadManyByIDsNullableAsync(
194
+ ids: readonly TID[]
195
+ ): Promise<ReadonlyMap<TID, Result<TEntity> | null>> {
196
+ const entityResults = (await this.loadManyByFieldEqualingManyAsync(
197
+ this.entityConfiguration.idField as TSelectedFields,
198
+ ids
199
+ )) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
200
+ return mapMap(entityResults, (entityResultsForId) => {
201
+ return entityResultsForId[0] ?? null;
202
+ });
203
+ }
204
+
185
205
  /**
186
206
  * Loads the first entity matching the selection constructed from the conjunction of specified
187
207
  * operands, or null if no matching entity exists. Entities loaded using this method are not
@@ -332,7 +352,7 @@ export default class EntityLoader<
332
352
  private tryConstructEntities(fieldsObjects: readonly TFields[]): readonly Result<TEntity>[] {
333
353
  return fieldsObjects.map((fieldsObject) => {
334
354
  try {
335
- return result(new this.entityClass(this.viewerContext, fieldsObject));
355
+ return result(this.constructEntity(fieldsObject));
336
356
  } catch (e) {
337
357
  if (!(e instanceof Error)) {
338
358
  throw e;
@@ -342,6 +362,20 @@ export default class EntityLoader<
342
362
  });
343
363
  }
344
364
 
365
+ public constructEntity(fieldsObject: TFields): TEntity {
366
+ const idField = this.entityConfiguration.idField;
367
+ const id = nullthrows(fieldsObject[idField], 'must provide ID to create an entity');
368
+ const entitySelectedFields =
369
+ this.entitySelectedFields ?? Array.from(this.entityConfiguration.schema.keys());
370
+ const selectedFields = pick(fieldsObject, entitySelectedFields);
371
+ return new this.entityClass({
372
+ viewerContext: this.viewerContext,
373
+ id: id as TID,
374
+ databaseFields: fieldsObject,
375
+ selectedFields,
376
+ });
377
+ }
378
+
345
379
  /**
346
380
  * Construct and authorize entities from fields map, returning error results for entities that fail
347
381
  * to construct or fail to authorize.
@@ -1,5 +1,4 @@
1
- import { IEntityClass } from './Entity';
2
- import EntityConfiguration from './EntityConfiguration';
1
+ import EntityCompanion from './EntityCompanion';
3
2
  import EntityLoader from './EntityLoader';
4
3
  import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
5
4
  import { EntityQueryContext } from './EntityQueryContext';
@@ -12,7 +11,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
12
11
  * The primary entry point for loading entities.
13
12
  */
14
13
  export default class EntityLoaderFactory<
15
- TFields,
14
+ TFields extends object,
16
15
  TID extends NonNullable<TFields[TSelectedFields]>,
17
16
  TViewerContext extends ViewerContext,
18
17
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -26,8 +25,7 @@ export default class EntityLoaderFactory<
26
25
  TSelectedFields extends keyof TFields
27
26
  > {
28
27
  constructor(
29
- private readonly entityConfiguration: EntityConfiguration<TFields>,
30
- private readonly entityClass: IEntityClass<
28
+ private readonly entityCompanion: EntityCompanion<
31
29
  TFields,
32
30
  TID,
33
31
  TViewerContext,
@@ -35,7 +33,6 @@ export default class EntityLoaderFactory<
35
33
  TPrivacyPolicy,
36
34
  TSelectedFields
37
35
  >,
38
- private readonly privacyPolicyClass: TPrivacyPolicy,
39
36
  private readonly dataManager: EntityDataManager<TFields>,
40
37
  protected readonly metricsAdapter: IEntityMetricsAdapter
41
38
  ) {}
@@ -54,9 +51,10 @@ export default class EntityLoaderFactory<
54
51
  viewerContext,
55
52
  queryContext,
56
53
  privacyPolicyEvaluationContext,
57
- this.entityConfiguration,
58
- this.entityClass,
59
- this.privacyPolicyClass,
54
+ this.entityCompanion.entityCompanionDefinition.entityConfiguration,
55
+ this.entityCompanion.entityCompanionDefinition.entityClass,
56
+ this.entityCompanion.entityCompanionDefinition.entitySelectedFields,
57
+ this.entityCompanion.privacyPolicy,
60
58
  this.dataManager,
61
59
  this.metricsAdapter
62
60
  );
@@ -8,7 +8,7 @@ export enum EntityMutationType {
8
8
  }
9
9
 
10
10
  export type EntityValidatorMutationInfo<
11
- TFields,
11
+ TFields extends object,
12
12
  TID extends NonNullable<TFields[TSelectedFields]>,
13
13
  TViewerContext extends ViewerContext,
14
14
  TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -39,7 +39,7 @@ export type EntityCascadingDeletionInfo = {
39
39
  };
40
40
 
41
41
  export type EntityTriggerMutationInfo<
42
- TFields,
42
+ TFields extends object,
43
43
  TID extends NonNullable<TFields[TSelectedFields]>,
44
44
  TViewerContext extends ViewerContext,
45
45
  TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -7,7 +7,7 @@ import ViewerContext from './ViewerContext';
7
7
  * Interface to define trigger behavior for entities.
8
8
  */
9
9
  export default interface EntityMutationTriggerConfiguration<
10
- TFields,
10
+ TFields extends object,
11
11
  TID extends NonNullable<TFields[TSelectedFields]>,
12
12
  TViewerContext extends ViewerContext,
13
13
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -70,7 +70,7 @@ export default interface EntityMutationTriggerConfiguration<
70
70
  * the transaction if a transaction is supplied.
71
71
  */
72
72
  export abstract class EntityMutationTrigger<
73
- TFields,
73
+ TFields extends object,
74
74
  TID extends NonNullable<TFields[TSelectedFields]>,
75
75
  TViewerContext extends ViewerContext,
76
76
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -89,7 +89,7 @@ export abstract class EntityMutationTrigger<
89
89
  * since they explicitly occur outside of the transaction.
90
90
  */
91
91
  export abstract class EntityNonTransactionalMutationTrigger<
92
- TFields,
92
+ TFields extends object,
93
93
  TID extends NonNullable<TFields[TSelectedFields]>,
94
94
  TViewerContext extends ViewerContext,
95
95
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -8,7 +8,7 @@ import ViewerContext from './ViewerContext';
8
8
  * same transaction as the mutation itself before creating or updating an entity.
9
9
  */
10
10
  export default abstract class EntityMutationValidator<
11
- TFields,
11
+ TFields extends object,
12
12
  TID extends NonNullable<TFields[TSelectedFields]>,
13
13
  TViewerContext extends ViewerContext,
14
14
  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,