remult 0.22.7-exp.0 → 0.22.7

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 (249) hide show
  1. package/SseSubscriptionServer.d.ts +25 -25
  2. package/SseSubscriptionServer.js +145 -145
  3. package/ably.d.ts +13 -13
  4. package/ably.js +59 -59
  5. package/assign.d.ts +1 -1
  6. package/assign.js +9 -9
  7. package/classType.d.ts +3 -3
  8. package/classType.js +2 -2
  9. package/esm/SseSubscriptionServer.d.ts +25 -25
  10. package/esm/SseSubscriptionServer.js +107 -104
  11. package/esm/ably.d.ts +13 -13
  12. package/esm/ably.js +30 -28
  13. package/esm/assign.d.ts +1 -1
  14. package/esm/assign.js +5 -5
  15. package/esm/classType.d.ts +3 -3
  16. package/esm/classType.js +1 -1
  17. package/esm/graphql.d.ts +14 -14
  18. package/esm/graphql.js +785 -785
  19. package/esm/index.d.ts +31 -31
  20. package/esm/index.js +25 -25
  21. package/esm/inputTypes.d.ts +9 -9
  22. package/esm/inputTypes.js +9 -9
  23. package/esm/live-query/data-provider-live-query-storage.d.ts +23 -23
  24. package/esm/live-query/data-provider-live-query-storage.js +91 -93
  25. package/esm/myLog.d.ts +1 -1
  26. package/esm/myLog.js +5 -5
  27. package/esm/postgres/index.d.ts +2 -2
  28. package/esm/postgres/index.js +2 -2
  29. package/esm/postgres/postgres-data-provider.d.ts +36 -36
  30. package/esm/postgres/postgres-data-provider.js +126 -122
  31. package/esm/postgres/schema-builder.d.ts +19 -19
  32. package/esm/postgres/schema-builder.js +197 -196
  33. package/esm/remult-express.d.ts +9 -9
  34. package/esm/remult-express.js +26 -25
  35. package/esm/remult-fastify.d.ts +6 -6
  36. package/esm/remult-fastify.js +68 -68
  37. package/esm/remult-fresh.d.ts +17 -17
  38. package/esm/remult-fresh.js +26 -26
  39. package/esm/remult-knex/index.d.ts +30 -30
  40. package/esm/remult-knex/index.js +466 -460
  41. package/esm/remult-mongo.d.ts +24 -24
  42. package/esm/remult-mongo.js +269 -262
  43. package/esm/remult-next.d.ts +25 -25
  44. package/esm/remult-next.js +114 -114
  45. package/esm/remult-sveltekit.d.ts +4 -4
  46. package/esm/remult-sveltekit.js +71 -71
  47. package/esm/server/JsonEntityFileStorage.d.ts +11 -11
  48. package/esm/server/JsonEntityFileStorage.js +27 -26
  49. package/esm/server/core.d.ts +4 -4
  50. package/esm/server/core.js +4 -4
  51. package/esm/server/expressBridge.d.ts +128 -128
  52. package/esm/server/expressBridge.js +988 -971
  53. package/esm/server/index.d.ts +6 -6
  54. package/esm/server/index.js +12 -12
  55. package/esm/server/initAsyncHooks.d.ts +1 -1
  56. package/esm/server/initAsyncHooks.js +9 -9
  57. package/esm/server/initDataProvider.d.ts +2 -2
  58. package/esm/server/initDataProvider.js +14 -14
  59. package/esm/src/CompoundIdField.d.ts +27 -27
  60. package/esm/src/CompoundIdField.js +54 -41
  61. package/esm/src/__EntityValueProvider.d.ts +11 -11
  62. package/esm/src/__EntityValueProvider.js +1 -1
  63. package/esm/src/__RowsOfDataForTesting.d.ts +3 -3
  64. package/esm/src/__RowsOfDataForTesting.js +1 -1
  65. package/esm/src/buildRestDataProvider.d.ts +31 -31
  66. package/esm/src/buildRestDataProvider.js +121 -120
  67. package/esm/src/column-interfaces.d.ts +160 -160
  68. package/esm/src/column-interfaces.js +7 -7
  69. package/esm/src/column.d.ts +31 -31
  70. package/esm/src/column.js +108 -101
  71. package/esm/src/context.d.ts +134 -134
  72. package/esm/src/context.js +287 -282
  73. package/esm/src/data-api.d.ts +38 -38
  74. package/esm/src/data-api.js +281 -279
  75. package/esm/src/data-interfaces.d.ts +41 -41
  76. package/esm/src/data-interfaces.js +12 -12
  77. package/esm/src/data-providers/array-entity-data-provider.d.ts +22 -22
  78. package/esm/src/data-providers/array-entity-data-provider.js +252 -249
  79. package/esm/src/data-providers/in-memory-database.d.ts +9 -9
  80. package/esm/src/data-providers/in-memory-database.js +16 -18
  81. package/esm/src/data-providers/json-data-provider.d.ts +12 -12
  82. package/esm/src/data-providers/json-data-provider.js +55 -52
  83. package/esm/src/data-providers/rest-data-provider.d.ts +39 -39
  84. package/esm/src/data-providers/rest-data-provider.js +272 -267
  85. package/esm/src/data-providers/sql-database.d.ts +33 -33
  86. package/esm/src/data-providers/sql-database.js +401 -394
  87. package/esm/src/data-providers/web-sql-data-provider.d.ts +21 -21
  88. package/esm/src/data-providers/web-sql-data-provider.js +145 -137
  89. package/esm/src/entity.d.ts +95 -95
  90. package/esm/src/entity.js +1 -1
  91. package/esm/src/filter/filter-consumer-bridge-to-sql-request.d.ts +50 -50
  92. package/esm/src/filter/filter-consumer-bridge-to-sql-request.js +165 -162
  93. package/esm/src/filter/filter-interfaces.d.ts +86 -86
  94. package/esm/src/filter/filter-interfaces.js +524 -515
  95. package/esm/src/live-query/LiveQueryClient.d.ts +1 -1
  96. package/esm/src/live-query/LiveQueryClient.js +196 -192
  97. package/esm/src/live-query/SseSubscriptionClient.d.ts +5 -5
  98. package/esm/src/live-query/SseSubscriptionClient.js +86 -86
  99. package/esm/src/live-query/SubscriptionChannel.d.ts +41 -41
  100. package/esm/src/live-query/SubscriptionChannel.js +126 -121
  101. package/esm/src/live-query/SubscriptionServer.d.ts +38 -38
  102. package/esm/src/live-query/SubscriptionServer.js +114 -112
  103. package/esm/src/remult-proxy.d.ts +2 -2
  104. package/esm/src/remult-proxy.js +177 -178
  105. package/esm/src/remult3/DecoratorReplacer.d.ts +10 -10
  106. package/esm/src/remult3/DecoratorReplacer.js +20 -20
  107. package/esm/src/remult3/RepositoryImplementation.d.ts +332 -332
  108. package/esm/src/remult3/RepositoryImplementation.js +2122 -2051
  109. package/esm/src/remult3/__updateEntityBasedOnWhere.d.ts +2 -2
  110. package/esm/src/remult3/__updateEntityBasedOnWhere.js +24 -24
  111. package/esm/src/remult3/entity.d.ts +28 -28
  112. package/esm/src/remult3/entity.js +70 -70
  113. package/esm/src/remult3/getEntityRef.d.ts +9 -9
  114. package/esm/src/remult3/getEntityRef.js +27 -27
  115. package/esm/src/remult3/remult3.d.ts +397 -397
  116. package/esm/src/remult3/remult3.js +1 -1
  117. package/esm/src/resultCompoundIdFilter.d.ts +3 -3
  118. package/esm/src/resultCompoundIdFilter.js +16 -16
  119. package/esm/src/server-action-info.d.ts +10 -10
  120. package/esm/src/server-action-info.js +12 -12
  121. package/esm/src/server-action.d.ts +79 -79
  122. package/esm/src/server-action.js +397 -387
  123. package/esm/src/sort.d.ts +16 -16
  124. package/esm/src/sort.js +105 -104
  125. package/esm/src/sql-command.d.ts +19 -19
  126. package/esm/src/sql-command.js +1 -1
  127. package/esm/src/validators.d.ts +14 -14
  128. package/esm/src/validators.js +36 -36
  129. package/esm/src/valueConverters.d.ts +13 -13
  130. package/esm/src/valueConverters.js +210 -210
  131. package/esm/urlBuilder.d.ts +6 -6
  132. package/esm/urlBuilder.js +20 -19
  133. package/graphql.d.ts +14 -14
  134. package/graphql.js +953 -953
  135. package/index.d.ts +31 -31
  136. package/index.js +67 -67
  137. package/inputTypes.d.ts +9 -9
  138. package/inputTypes.js +16 -16
  139. package/live-query/data-provider-live-query-storage.d.ts +23 -23
  140. package/live-query/data-provider-live-query-storage.js +263 -263
  141. package/myLog.d.ts +1 -1
  142. package/myLog.js +20 -20
  143. package/package.json +1 -1
  144. package/postgres/index.d.ts +2 -2
  145. package/postgres/index.js +5 -5
  146. package/postgres/postgres-data-provider.d.ts +36 -36
  147. package/postgres/postgres-data-provider.js +191 -191
  148. package/postgres/schema-builder.d.ts +19 -19
  149. package/postgres/schema-builder.js +369 -369
  150. package/remult-express.d.ts +9 -9
  151. package/remult-express.js +34 -33
  152. package/remult-fastify.d.ts +6 -6
  153. package/remult-fastify.js +79 -79
  154. package/remult-fresh.d.ts +17 -17
  155. package/remult-fresh.js +41 -41
  156. package/remult-knex/index.d.ts +30 -30
  157. package/remult-knex/index.js +917 -915
  158. package/remult-mongo.d.ts +24 -24
  159. package/remult-mongo.js +515 -515
  160. package/remult-next.d.ts +25 -25
  161. package/remult-next.js +171 -171
  162. package/remult-sveltekit.d.ts +4 -4
  163. package/remult-sveltekit.js +110 -110
  164. package/server/JsonEntityFileStorage.d.ts +11 -11
  165. package/server/JsonEntityFileStorage.js +35 -35
  166. package/server/core.d.ts +4 -4
  167. package/server/core.js +12 -12
  168. package/server/expressBridge.d.ts +128 -128
  169. package/server/expressBridge.js +1401 -1402
  170. package/server/index.d.ts +6 -6
  171. package/server/index.js +24 -24
  172. package/server/initAsyncHooks.d.ts +1 -1
  173. package/server/initAsyncHooks.js +13 -13
  174. package/server/initDataProvider.d.ts +2 -2
  175. package/server/initDataProvider.js +26 -26
  176. package/src/CompoundIdField.d.ts +27 -27
  177. package/src/CompoundIdField.js +54 -54
  178. package/src/__EntityValueProvider.d.ts +11 -11
  179. package/src/__EntityValueProvider.js +2 -2
  180. package/src/__RowsOfDataForTesting.d.ts +3 -3
  181. package/src/__RowsOfDataForTesting.js +2 -2
  182. package/src/buildRestDataProvider.d.ts +31 -31
  183. package/src/buildRestDataProvider.js +177 -174
  184. package/src/column-interfaces.d.ts +160 -160
  185. package/src/column-interfaces.js +11 -11
  186. package/src/column.d.ts +31 -31
  187. package/src/column.js +132 -132
  188. package/src/context.d.ts +134 -134
  189. package/src/context.js +451 -451
  190. package/src/data-api.d.ts +38 -38
  191. package/src/data-api.js +524 -524
  192. package/src/data-interfaces.d.ts +41 -41
  193. package/src/data-interfaces.js +16 -16
  194. package/src/data-providers/array-entity-data-provider.d.ts +22 -22
  195. package/src/data-providers/array-entity-data-provider.js +364 -364
  196. package/src/data-providers/in-memory-database.d.ts +9 -9
  197. package/src/data-providers/in-memory-database.js +33 -33
  198. package/src/data-providers/json-data-provider.d.ts +12 -12
  199. package/src/data-providers/json-data-provider.js +106 -106
  200. package/src/data-providers/rest-data-provider.d.ts +39 -39
  201. package/src/data-providers/rest-data-provider.js +388 -388
  202. package/src/data-providers/sql-database.d.ts +33 -33
  203. package/src/data-providers/sql-database.js +653 -653
  204. package/src/data-providers/web-sql-data-provider.d.ts +21 -21
  205. package/src/data-providers/web-sql-data-provider.js +229 -229
  206. package/src/entity.d.ts +95 -95
  207. package/src/entity.js +2 -2
  208. package/src/filter/filter-consumer-bridge-to-sql-request.d.ts +50 -50
  209. package/src/filter/filter-consumer-bridge-to-sql-request.js +307 -307
  210. package/src/filter/filter-interfaces.d.ts +86 -86
  211. package/src/filter/filter-interfaces.js +693 -685
  212. package/src/live-query/LiveQueryClient.d.ts +1 -1
  213. package/src/live-query/LiveQueryClient.js +293 -293
  214. package/src/live-query/SseSubscriptionClient.d.ts +5 -5
  215. package/src/live-query/SseSubscriptionClient.js +154 -154
  216. package/src/live-query/SubscriptionChannel.d.ts +41 -41
  217. package/src/live-query/SubscriptionChannel.js +189 -189
  218. package/src/live-query/SubscriptionServer.d.ts +38 -38
  219. package/src/live-query/SubscriptionServer.js +264 -264
  220. package/src/remult-proxy.d.ts +2 -2
  221. package/src/remult-proxy.js +307 -307
  222. package/src/remult3/DecoratorReplacer.d.ts +10 -10
  223. package/src/remult3/DecoratorReplacer.js +24 -24
  224. package/src/remult3/RepositoryImplementation.d.ts +332 -332
  225. package/src/remult3/RepositoryImplementation.js +3391 -3373
  226. package/src/remult3/__updateEntityBasedOnWhere.d.ts +2 -2
  227. package/src/remult3/__updateEntityBasedOnWhere.js +28 -28
  228. package/src/remult3/entity.d.ts +28 -28
  229. package/src/remult3/entity.js +88 -88
  230. package/src/remult3/getEntityRef.d.ts +9 -9
  231. package/src/remult3/getEntityRef.js +35 -35
  232. package/src/remult3/remult3.d.ts +397 -397
  233. package/src/remult3/remult3.js +2 -2
  234. package/src/resultCompoundIdFilter.d.ts +3 -3
  235. package/src/resultCompoundIdFilter.js +20 -20
  236. package/src/server-action-info.d.ts +10 -10
  237. package/src/server-action-info.js +15 -15
  238. package/src/server-action.d.ts +79 -79
  239. package/src/server-action.js +632 -632
  240. package/src/sort.d.ts +16 -16
  241. package/src/sort.js +161 -161
  242. package/src/sql-command.d.ts +19 -19
  243. package/src/sql-command.js +2 -2
  244. package/src/validators.d.ts +14 -14
  245. package/src/validators.js +71 -69
  246. package/src/valueConverters.d.ts +13 -13
  247. package/src/valueConverters.js +213 -213
  248. package/urlBuilder.d.ts +6 -6
  249. package/urlBuilder.js +25 -25
package/src/entity.d.ts CHANGED
@@ -1,95 +1,95 @@
1
- import type { Allowed, AllowedForInstance } from './context';
2
- import type { FieldMetadata } from './column-interfaces';
3
- import type { EntityFilter, EntityMetadata, EntityOrderBy, EntityRef, FieldsMetadata } from './remult3/remult3';
4
- export interface EntityOptions<entityType = any> {
5
- /**A human readable name for the entity */
6
- caption?: string;
7
- /**
8
- * Determines if this Entity is available for get requests using Rest Api
9
- * @description
10
- * Determines if one has any access to the data of an entity.
11
- * @see [allowed](http://remult.dev/docs/allowed.html)
12
- * @see to restrict data based on a criteria, use [apiPrefilter](https://remult.dev/docs/ref_entity.html#apiprefilter)
13
- * */
14
- allowApiRead?: Allowed;
15
- /**
16
- * Determines if this entity can be updated through the api.
17
- * @see [allowed](http://remult.dev/docs/allowed.html)*/
18
- allowApiUpdate?: AllowedForInstance<entityType>;
19
- /** Determines if entries for this entity can be deleted through the api.
20
- * @see [allowed](http://remult.dev/docs/allowed.html)*/
21
- allowApiDelete?: AllowedForInstance<entityType>;
22
- /** Determines if new entries for this entity can be posted through the api.
23
- * @see [allowed](http://remult.dev/docs/allowed.html)*/
24
- allowApiInsert?: AllowedForInstance<entityType>;
25
- /** sets the `allowApiUpdate`, `allowApiDelete` and `allowApiInsert` properties in a single set */
26
- allowApiCrud?: Allowed;
27
- /** A filter that determines which rows can be queries using the api.
28
- * @description
29
- * Use apiPrefilter in cases where you to restrict data based on user profile
30
- * @example
31
- * apiPrefilter: { archive:false }
32
- *
33
- * @example
34
- * apiPrefilter: ()=> remult.isAllowed("admin")?{}:{ archive:false }
35
- * @see [EntityFilter](http://remult.dev/docs/entityFilter.html)
36
- *
37
- */
38
- apiPrefilter?: EntityFilter<entityType> | (() => EntityFilter<entityType> | Promise<EntityFilter<entityType>>);
39
- /** A filter that will be used for all queries from this entity both from the API and from within the backend.
40
- * @example
41
- * backendPrefilter: { archive:false }
42
- * @see [EntityFilter](http://remult.dev/docs/entityFilter.html)
43
- */
44
- backendPrefilter?: EntityFilter<entityType> | (() => EntityFilter<entityType> | Promise<EntityFilter<entityType>>);
45
- /** An order by to be used, in case no order by was specified
46
- * @example
47
- * defaultOrderBy: { name: "asc" }
48
- *
49
- * @example
50
- * defaultOrderBy: { price: "desc", name: "asc" }
51
- */
52
- defaultOrderBy?: EntityOrderBy<entityType>;
53
- /** An event that will be fired before the Entity will be saved to the database.
54
- * If the `error` property of the entity's ref or any of its fields will be set, the save will be aborted and an exception will be thrown.
55
- * this is the place to run logic that we want to run in any case before an entity is saved.
56
- * @example
57
- * @Entity<Task>("tasks", {
58
- * saving: async task => {
59
- * task.lastUpdated = new Date()
60
- * }
61
- *})
62
- */
63
- saving?: (row: entityType, proceedWithoutSavingToDb: () => void) => Promise<any> | any;
64
- /** will be called after the Entity was saved to the data source. */
65
- saved?: (row: entityType) => Promise<any> | any;
66
- /** Will be called before an Entity is deleted. */
67
- deleting?: (row: entityType) => Promise<any> | any;
68
- /** Will be called after an Entity is deleted */
69
- deleted?: (row: entityType) => Promise<any> | any;
70
- /** Will be called when the entity is being validated, usually prior to the `saving` event */
71
- validation?: (row: entityType, ref: EntityRef<entityType>) => Promise<any> | any;
72
- /** The name of the table in the database that holds the data for this entity.
73
- * If no name is set, the `key` will be used instead.
74
- * @example
75
- * dbName:'myProducts'
76
- *
77
- * You can also add your schema name to the table name
78
- * @example
79
- * dbName:'public."myProducts"'
80
- */
81
- dbName?: string;
82
- /** For entities that are based on SQL expressions instead of a physical table or view*/
83
- sqlExpression?: string | ((entity: EntityMetadata<entityType>) => string | Promise<string>);
84
- /** An arrow function that identifies the `id` column to use for this entity
85
- * @example
86
- * //Single column id
87
- * @Entity<Products>("products", { id:p=>p.productCode })
88
- * @example
89
- * //Multiple columns id
90
- * @Entity<OrderDetails>("orderDetails", { id:od=> [od.orderId, od.productCode] })
91
- */
92
- id?: (entity: FieldsMetadata<entityType>) => FieldMetadata | FieldMetadata[];
93
- entityRefInit?: (ref: EntityRef<entityType>, row: entityType) => void;
94
- apiRequireId?: Allowed;
95
- }
1
+ import type { Allowed, AllowedForInstance } from './context';
2
+ import type { FieldMetadata } from './column-interfaces';
3
+ import type { EntityFilter, EntityMetadata, EntityOrderBy, EntityRef, FieldsMetadata } from './remult3/remult3';
4
+ export interface EntityOptions<entityType = any> {
5
+ /**A human readable name for the entity */
6
+ caption?: string;
7
+ /**
8
+ * Determines if this Entity is available for get requests using Rest Api
9
+ * @description
10
+ * Determines if one has any access to the data of an entity.
11
+ * @see [allowed](http://remult.dev/docs/allowed.html)
12
+ * @see to restrict data based on a criteria, use [apiPrefilter](https://remult.dev/docs/ref_entity.html#apiprefilter)
13
+ * */
14
+ allowApiRead?: Allowed;
15
+ /**
16
+ * Determines if this entity can be updated through the api.
17
+ * @see [allowed](http://remult.dev/docs/allowed.html)*/
18
+ allowApiUpdate?: AllowedForInstance<entityType>;
19
+ /** Determines if entries for this entity can be deleted through the api.
20
+ * @see [allowed](http://remult.dev/docs/allowed.html)*/
21
+ allowApiDelete?: AllowedForInstance<entityType>;
22
+ /** Determines if new entries for this entity can be posted through the api.
23
+ * @see [allowed](http://remult.dev/docs/allowed.html)*/
24
+ allowApiInsert?: AllowedForInstance<entityType>;
25
+ /** sets the `allowApiUpdate`, `allowApiDelete` and `allowApiInsert` properties in a single set */
26
+ allowApiCrud?: Allowed;
27
+ /** A filter that determines which rows can be queries using the api.
28
+ * @description
29
+ * Use apiPrefilter in cases where you to restrict data based on user profile
30
+ * @example
31
+ * apiPrefilter: { archive:false }
32
+ *
33
+ * @example
34
+ * apiPrefilter: ()=> remult.isAllowed("admin")?{}:{ archive:false }
35
+ * @see [EntityFilter](http://remult.dev/docs/entityFilter.html)
36
+ *
37
+ */
38
+ apiPrefilter?: EntityFilter<entityType> | (() => EntityFilter<entityType> | Promise<EntityFilter<entityType>>);
39
+ /** A filter that will be used for all queries from this entity both from the API and from within the backend.
40
+ * @example
41
+ * backendPrefilter: { archive:false }
42
+ * @see [EntityFilter](http://remult.dev/docs/entityFilter.html)
43
+ */
44
+ backendPrefilter?: EntityFilter<entityType> | (() => EntityFilter<entityType> | Promise<EntityFilter<entityType>>);
45
+ /** An order by to be used, in case no order by was specified
46
+ * @example
47
+ * defaultOrderBy: { name: "asc" }
48
+ *
49
+ * @example
50
+ * defaultOrderBy: { price: "desc", name: "asc" }
51
+ */
52
+ defaultOrderBy?: EntityOrderBy<entityType>;
53
+ /** An event that will be fired before the Entity will be saved to the database.
54
+ * If the `error` property of the entity's ref or any of its fields will be set, the save will be aborted and an exception will be thrown.
55
+ * this is the place to run logic that we want to run in any case before an entity is saved.
56
+ * @example
57
+ * @Entity<Task>("tasks", {
58
+ * saving: async task => {
59
+ * task.lastUpdated = new Date()
60
+ * }
61
+ *})
62
+ */
63
+ saving?: (row: entityType, proceedWithoutSavingToDb: () => void) => Promise<any> | any;
64
+ /** will be called after the Entity was saved to the data source. */
65
+ saved?: (row: entityType) => Promise<any> | any;
66
+ /** Will be called before an Entity is deleted. */
67
+ deleting?: (row: entityType) => Promise<any> | any;
68
+ /** Will be called after an Entity is deleted */
69
+ deleted?: (row: entityType) => Promise<any> | any;
70
+ /** Will be called when the entity is being validated, usually prior to the `saving` event */
71
+ validation?: (row: entityType, ref: EntityRef<entityType>) => Promise<any> | any;
72
+ /** The name of the table in the database that holds the data for this entity.
73
+ * If no name is set, the `key` will be used instead.
74
+ * @example
75
+ * dbName:'myProducts'
76
+ *
77
+ * You can also add your schema name to the table name
78
+ * @example
79
+ * dbName:'public."myProducts"'
80
+ */
81
+ dbName?: string;
82
+ /** For entities that are based on SQL expressions instead of a physical table or view*/
83
+ sqlExpression?: string | ((entity: EntityMetadata<entityType>) => string | Promise<string>);
84
+ /** An arrow function that identifies the `id` column to use for this entity
85
+ * @example
86
+ * //Single column id
87
+ * @Entity<Products>("products", { id:p=>p.productCode })
88
+ * @example
89
+ * //Multiple columns id
90
+ * @Entity<OrderDetails>("orderDetails", { id:od=> [od.orderId, od.productCode] })
91
+ */
92
+ id?: (entity: FieldsMetadata<entityType>) => FieldMetadata | FieldMetadata[];
93
+ entityRefInit?: (ref: EntityRef<entityType>, row: entityType) => void;
94
+ apiRequireId?: Allowed;
95
+ }
package/src/entity.js CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,50 +1,50 @@
1
- import type { FieldMetadata } from '../column-interfaces';
2
- import type { EntityMetadataOverloads, RepositoryOverloads } from '../remult3/RepositoryImplementation';
3
- import type { EntityFilter, OmitEB } from '../remult3/remult3';
4
- import type { SqlCommandWithParameters } from '../sql-command';
5
- import type { Filter, FilterConsumer } from './filter-interfaces';
6
- export declare class FilterConsumerBridgeToSqlRequest implements FilterConsumer {
7
- private r;
8
- private nameProvider;
9
- private where;
10
- _addWhere: boolean;
11
- promises: Promise<void>[];
12
- resolveWhere(): Promise<string>;
13
- constructor(r: SqlCommandWithParameters, nameProvider: EntityDbNamesBase);
14
- custom(key: string, customItem: any): void;
15
- or(orElements: Filter[]): void;
16
- isNull(col: FieldMetadata): void;
17
- isNotNull(col: FieldMetadata): void;
18
- isIn(col: FieldMetadata, val: any[]): void;
19
- isEqualTo(col: FieldMetadata, val: any): void;
20
- isDifferentFrom(col: FieldMetadata, val: any): void;
21
- isGreaterOrEqualTo(col: FieldMetadata, val: any): void;
22
- isGreaterThan(col: FieldMetadata, val: any): void;
23
- isLessOrEqualTo(col: FieldMetadata, val: any): void;
24
- isLessThan(col: FieldMetadata, val: any): void;
25
- containsCaseInsensitive(col: FieldMetadata, val: any): void;
26
- private add;
27
- private addToWhere;
28
- databaseCustom(databaseCustom: CustomSqlFilterObject): void;
29
- }
30
- export declare type CustomSqlFilterBuilderFunction = (builder: CustomSqlFilterBuilder) => void | Promise<any>;
31
- export interface CustomSqlFilterObject {
32
- buildSql: CustomSqlFilterBuilderFunction;
33
- }
34
- export declare class CustomSqlFilterBuilder {
35
- private r;
36
- constructor(r: SqlCommandWithParameters);
37
- sql: string;
38
- addParameterAndReturnSqlToken<valueType>(val: valueType, field?: FieldMetadata<valueType>): string;
39
- filterToRaw<entityType>(repo: RepositoryOverloads<entityType>, condition: EntityFilter<entityType>): Promise<string>;
40
- }
41
- export declare function isDbReadonly<entityType>(field: FieldMetadata, dbNames: EntityDbNames<entityType>): boolean;
42
- export declare type EntityDbNamesBase = {
43
- $entityName: string;
44
- $dbNameOf(field: FieldMetadata<any> | string): string;
45
- toString(): string;
46
- };
47
- export declare type EntityDbNames<entityType> = {
48
- [Properties in keyof Required<OmitEB<entityType>>]: string;
49
- } & EntityDbNamesBase;
50
- export declare function dbNamesOf<entityType>(repo: EntityMetadataOverloads<entityType>): Promise<EntityDbNames<entityType>>;
1
+ import type { FieldMetadata } from '../column-interfaces';
2
+ import type { EntityMetadataOverloads, RepositoryOverloads } from '../remult3/RepositoryImplementation';
3
+ import type { EntityFilter, OmitEB } from '../remult3/remult3';
4
+ import type { SqlCommandWithParameters } from '../sql-command';
5
+ import type { Filter, FilterConsumer } from './filter-interfaces';
6
+ export declare class FilterConsumerBridgeToSqlRequest implements FilterConsumer {
7
+ private r;
8
+ private nameProvider;
9
+ private where;
10
+ _addWhere: boolean;
11
+ promises: Promise<void>[];
12
+ resolveWhere(): Promise<string>;
13
+ constructor(r: SqlCommandWithParameters, nameProvider: EntityDbNamesBase);
14
+ custom(key: string, customItem: any): void;
15
+ or(orElements: Filter[]): void;
16
+ isNull(col: FieldMetadata): void;
17
+ isNotNull(col: FieldMetadata): void;
18
+ isIn(col: FieldMetadata, val: any[]): void;
19
+ isEqualTo(col: FieldMetadata, val: any): void;
20
+ isDifferentFrom(col: FieldMetadata, val: any): void;
21
+ isGreaterOrEqualTo(col: FieldMetadata, val: any): void;
22
+ isGreaterThan(col: FieldMetadata, val: any): void;
23
+ isLessOrEqualTo(col: FieldMetadata, val: any): void;
24
+ isLessThan(col: FieldMetadata, val: any): void;
25
+ containsCaseInsensitive(col: FieldMetadata, val: any): void;
26
+ private add;
27
+ private addToWhere;
28
+ databaseCustom(databaseCustom: CustomSqlFilterObject): void;
29
+ }
30
+ export type CustomSqlFilterBuilderFunction = (builder: CustomSqlFilterBuilder) => void | Promise<any>;
31
+ export interface CustomSqlFilterObject {
32
+ buildSql: CustomSqlFilterBuilderFunction;
33
+ }
34
+ export declare class CustomSqlFilterBuilder {
35
+ private r;
36
+ constructor(r: SqlCommandWithParameters);
37
+ sql: string;
38
+ addParameterAndReturnSqlToken<valueType>(val: valueType, field?: FieldMetadata<valueType>): string;
39
+ filterToRaw<entityType>(repo: RepositoryOverloads<entityType>, condition: EntityFilter<entityType>): Promise<string>;
40
+ }
41
+ export declare function isDbReadonly<entityType>(field: FieldMetadata, dbNames: EntityDbNames<entityType>): boolean;
42
+ export declare type EntityDbNamesBase = {
43
+ $entityName: string;
44
+ $dbNameOf(field: FieldMetadata<any> | string): string;
45
+ toString(): string;
46
+ };
47
+ export declare type EntityDbNames<entityType> = {
48
+ [Properties in keyof Required<OmitEB<entityType>>]: string;
49
+ } & EntityDbNamesBase;
50
+ export declare function dbNamesOf<entityType>(repo: EntityMetadataOverloads<entityType>): Promise<EntityDbNames<entityType>>;