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.
- package/SseSubscriptionServer.d.ts +25 -25
- package/SseSubscriptionServer.js +145 -145
- package/ably.d.ts +13 -13
- package/ably.js +59 -59
- package/assign.d.ts +1 -1
- package/assign.js +9 -9
- package/classType.d.ts +3 -3
- package/classType.js +2 -2
- package/esm/SseSubscriptionServer.d.ts +25 -25
- package/esm/SseSubscriptionServer.js +107 -104
- package/esm/ably.d.ts +13 -13
- package/esm/ably.js +30 -28
- package/esm/assign.d.ts +1 -1
- package/esm/assign.js +5 -5
- package/esm/classType.d.ts +3 -3
- package/esm/classType.js +1 -1
- package/esm/graphql.d.ts +14 -14
- package/esm/graphql.js +785 -785
- package/esm/index.d.ts +31 -31
- package/esm/index.js +25 -25
- package/esm/inputTypes.d.ts +9 -9
- package/esm/inputTypes.js +9 -9
- package/esm/live-query/data-provider-live-query-storage.d.ts +23 -23
- package/esm/live-query/data-provider-live-query-storage.js +91 -93
- package/esm/myLog.d.ts +1 -1
- package/esm/myLog.js +5 -5
- package/esm/postgres/index.d.ts +2 -2
- package/esm/postgres/index.js +2 -2
- package/esm/postgres/postgres-data-provider.d.ts +36 -36
- package/esm/postgres/postgres-data-provider.js +126 -122
- package/esm/postgres/schema-builder.d.ts +19 -19
- package/esm/postgres/schema-builder.js +197 -196
- package/esm/remult-express.d.ts +9 -9
- package/esm/remult-express.js +26 -25
- package/esm/remult-fastify.d.ts +6 -6
- package/esm/remult-fastify.js +68 -68
- package/esm/remult-fresh.d.ts +17 -17
- package/esm/remult-fresh.js +26 -26
- package/esm/remult-knex/index.d.ts +30 -30
- package/esm/remult-knex/index.js +466 -460
- package/esm/remult-mongo.d.ts +24 -24
- package/esm/remult-mongo.js +269 -262
- package/esm/remult-next.d.ts +25 -25
- package/esm/remult-next.js +114 -114
- package/esm/remult-sveltekit.d.ts +4 -4
- package/esm/remult-sveltekit.js +71 -71
- package/esm/server/JsonEntityFileStorage.d.ts +11 -11
- package/esm/server/JsonEntityFileStorage.js +27 -26
- package/esm/server/core.d.ts +4 -4
- package/esm/server/core.js +4 -4
- package/esm/server/expressBridge.d.ts +128 -128
- package/esm/server/expressBridge.js +988 -971
- package/esm/server/index.d.ts +6 -6
- package/esm/server/index.js +12 -12
- package/esm/server/initAsyncHooks.d.ts +1 -1
- package/esm/server/initAsyncHooks.js +9 -9
- package/esm/server/initDataProvider.d.ts +2 -2
- package/esm/server/initDataProvider.js +14 -14
- package/esm/src/CompoundIdField.d.ts +27 -27
- package/esm/src/CompoundIdField.js +54 -41
- package/esm/src/__EntityValueProvider.d.ts +11 -11
- package/esm/src/__EntityValueProvider.js +1 -1
- package/esm/src/__RowsOfDataForTesting.d.ts +3 -3
- package/esm/src/__RowsOfDataForTesting.js +1 -1
- package/esm/src/buildRestDataProvider.d.ts +31 -31
- package/esm/src/buildRestDataProvider.js +121 -120
- package/esm/src/column-interfaces.d.ts +160 -160
- package/esm/src/column-interfaces.js +7 -7
- package/esm/src/column.d.ts +31 -31
- package/esm/src/column.js +108 -101
- package/esm/src/context.d.ts +134 -134
- package/esm/src/context.js +287 -282
- package/esm/src/data-api.d.ts +38 -38
- package/esm/src/data-api.js +281 -279
- package/esm/src/data-interfaces.d.ts +41 -41
- package/esm/src/data-interfaces.js +12 -12
- package/esm/src/data-providers/array-entity-data-provider.d.ts +22 -22
- package/esm/src/data-providers/array-entity-data-provider.js +252 -249
- package/esm/src/data-providers/in-memory-database.d.ts +9 -9
- package/esm/src/data-providers/in-memory-database.js +16 -18
- package/esm/src/data-providers/json-data-provider.d.ts +12 -12
- package/esm/src/data-providers/json-data-provider.js +55 -52
- package/esm/src/data-providers/rest-data-provider.d.ts +39 -39
- package/esm/src/data-providers/rest-data-provider.js +272 -267
- package/esm/src/data-providers/sql-database.d.ts +33 -33
- package/esm/src/data-providers/sql-database.js +401 -394
- package/esm/src/data-providers/web-sql-data-provider.d.ts +21 -21
- package/esm/src/data-providers/web-sql-data-provider.js +145 -137
- package/esm/src/entity.d.ts +95 -95
- package/esm/src/entity.js +1 -1
- package/esm/src/filter/filter-consumer-bridge-to-sql-request.d.ts +50 -50
- package/esm/src/filter/filter-consumer-bridge-to-sql-request.js +165 -162
- package/esm/src/filter/filter-interfaces.d.ts +86 -86
- package/esm/src/filter/filter-interfaces.js +524 -515
- package/esm/src/live-query/LiveQueryClient.d.ts +1 -1
- package/esm/src/live-query/LiveQueryClient.js +196 -192
- package/esm/src/live-query/SseSubscriptionClient.d.ts +5 -5
- package/esm/src/live-query/SseSubscriptionClient.js +86 -86
- package/esm/src/live-query/SubscriptionChannel.d.ts +41 -41
- package/esm/src/live-query/SubscriptionChannel.js +126 -121
- package/esm/src/live-query/SubscriptionServer.d.ts +38 -38
- package/esm/src/live-query/SubscriptionServer.js +114 -112
- package/esm/src/remult-proxy.d.ts +2 -2
- package/esm/src/remult-proxy.js +177 -178
- package/esm/src/remult3/DecoratorReplacer.d.ts +10 -10
- package/esm/src/remult3/DecoratorReplacer.js +20 -20
- package/esm/src/remult3/RepositoryImplementation.d.ts +332 -332
- package/esm/src/remult3/RepositoryImplementation.js +2122 -2051
- package/esm/src/remult3/__updateEntityBasedOnWhere.d.ts +2 -2
- package/esm/src/remult3/__updateEntityBasedOnWhere.js +24 -24
- package/esm/src/remult3/entity.d.ts +28 -28
- package/esm/src/remult3/entity.js +70 -70
- package/esm/src/remult3/getEntityRef.d.ts +9 -9
- package/esm/src/remult3/getEntityRef.js +27 -27
- package/esm/src/remult3/remult3.d.ts +397 -397
- package/esm/src/remult3/remult3.js +1 -1
- package/esm/src/resultCompoundIdFilter.d.ts +3 -3
- package/esm/src/resultCompoundIdFilter.js +16 -16
- package/esm/src/server-action-info.d.ts +10 -10
- package/esm/src/server-action-info.js +12 -12
- package/esm/src/server-action.d.ts +79 -79
- package/esm/src/server-action.js +397 -387
- package/esm/src/sort.d.ts +16 -16
- package/esm/src/sort.js +105 -104
- package/esm/src/sql-command.d.ts +19 -19
- package/esm/src/sql-command.js +1 -1
- package/esm/src/validators.d.ts +14 -14
- package/esm/src/validators.js +36 -36
- package/esm/src/valueConverters.d.ts +13 -13
- package/esm/src/valueConverters.js +210 -210
- package/esm/urlBuilder.d.ts +6 -6
- package/esm/urlBuilder.js +20 -19
- package/graphql.d.ts +14 -14
- package/graphql.js +953 -953
- package/index.d.ts +31 -31
- package/index.js +67 -67
- package/inputTypes.d.ts +9 -9
- package/inputTypes.js +16 -16
- package/live-query/data-provider-live-query-storage.d.ts +23 -23
- package/live-query/data-provider-live-query-storage.js +263 -263
- package/myLog.d.ts +1 -1
- package/myLog.js +20 -20
- package/package.json +1 -1
- package/postgres/index.d.ts +2 -2
- package/postgres/index.js +5 -5
- package/postgres/postgres-data-provider.d.ts +36 -36
- package/postgres/postgres-data-provider.js +191 -191
- package/postgres/schema-builder.d.ts +19 -19
- package/postgres/schema-builder.js +369 -369
- package/remult-express.d.ts +9 -9
- package/remult-express.js +34 -33
- package/remult-fastify.d.ts +6 -6
- package/remult-fastify.js +79 -79
- package/remult-fresh.d.ts +17 -17
- package/remult-fresh.js +41 -41
- package/remult-knex/index.d.ts +30 -30
- package/remult-knex/index.js +917 -915
- package/remult-mongo.d.ts +24 -24
- package/remult-mongo.js +515 -515
- package/remult-next.d.ts +25 -25
- package/remult-next.js +171 -171
- package/remult-sveltekit.d.ts +4 -4
- package/remult-sveltekit.js +110 -110
- package/server/JsonEntityFileStorage.d.ts +11 -11
- package/server/JsonEntityFileStorage.js +35 -35
- package/server/core.d.ts +4 -4
- package/server/core.js +12 -12
- package/server/expressBridge.d.ts +128 -128
- package/server/expressBridge.js +1401 -1402
- package/server/index.d.ts +6 -6
- package/server/index.js +24 -24
- package/server/initAsyncHooks.d.ts +1 -1
- package/server/initAsyncHooks.js +13 -13
- package/server/initDataProvider.d.ts +2 -2
- package/server/initDataProvider.js +26 -26
- package/src/CompoundIdField.d.ts +27 -27
- package/src/CompoundIdField.js +54 -54
- package/src/__EntityValueProvider.d.ts +11 -11
- package/src/__EntityValueProvider.js +2 -2
- package/src/__RowsOfDataForTesting.d.ts +3 -3
- package/src/__RowsOfDataForTesting.js +2 -2
- package/src/buildRestDataProvider.d.ts +31 -31
- package/src/buildRestDataProvider.js +177 -174
- package/src/column-interfaces.d.ts +160 -160
- package/src/column-interfaces.js +11 -11
- package/src/column.d.ts +31 -31
- package/src/column.js +132 -132
- package/src/context.d.ts +134 -134
- package/src/context.js +451 -451
- package/src/data-api.d.ts +38 -38
- package/src/data-api.js +524 -524
- package/src/data-interfaces.d.ts +41 -41
- package/src/data-interfaces.js +16 -16
- package/src/data-providers/array-entity-data-provider.d.ts +22 -22
- package/src/data-providers/array-entity-data-provider.js +364 -364
- package/src/data-providers/in-memory-database.d.ts +9 -9
- package/src/data-providers/in-memory-database.js +33 -33
- package/src/data-providers/json-data-provider.d.ts +12 -12
- package/src/data-providers/json-data-provider.js +106 -106
- package/src/data-providers/rest-data-provider.d.ts +39 -39
- package/src/data-providers/rest-data-provider.js +388 -388
- package/src/data-providers/sql-database.d.ts +33 -33
- package/src/data-providers/sql-database.js +653 -653
- package/src/data-providers/web-sql-data-provider.d.ts +21 -21
- package/src/data-providers/web-sql-data-provider.js +229 -229
- package/src/entity.d.ts +95 -95
- package/src/entity.js +2 -2
- package/src/filter/filter-consumer-bridge-to-sql-request.d.ts +50 -50
- package/src/filter/filter-consumer-bridge-to-sql-request.js +307 -307
- package/src/filter/filter-interfaces.d.ts +86 -86
- package/src/filter/filter-interfaces.js +693 -685
- package/src/live-query/LiveQueryClient.d.ts +1 -1
- package/src/live-query/LiveQueryClient.js +293 -293
- package/src/live-query/SseSubscriptionClient.d.ts +5 -5
- package/src/live-query/SseSubscriptionClient.js +154 -154
- package/src/live-query/SubscriptionChannel.d.ts +41 -41
- package/src/live-query/SubscriptionChannel.js +189 -189
- package/src/live-query/SubscriptionServer.d.ts +38 -38
- package/src/live-query/SubscriptionServer.js +264 -264
- package/src/remult-proxy.d.ts +2 -2
- package/src/remult-proxy.js +307 -307
- package/src/remult3/DecoratorReplacer.d.ts +10 -10
- package/src/remult3/DecoratorReplacer.js +24 -24
- package/src/remult3/RepositoryImplementation.d.ts +332 -332
- package/src/remult3/RepositoryImplementation.js +3391 -3373
- package/src/remult3/__updateEntityBasedOnWhere.d.ts +2 -2
- package/src/remult3/__updateEntityBasedOnWhere.js +28 -28
- package/src/remult3/entity.d.ts +28 -28
- package/src/remult3/entity.js +88 -88
- package/src/remult3/getEntityRef.d.ts +9 -9
- package/src/remult3/getEntityRef.js +35 -35
- package/src/remult3/remult3.d.ts +397 -397
- package/src/remult3/remult3.js +2 -2
- package/src/resultCompoundIdFilter.d.ts +3 -3
- package/src/resultCompoundIdFilter.js +20 -20
- package/src/server-action-info.d.ts +10 -10
- package/src/server-action-info.js +15 -15
- package/src/server-action.d.ts +79 -79
- package/src/server-action.js +632 -632
- package/src/sort.d.ts +16 -16
- package/src/sort.js +161 -161
- package/src/sql-command.d.ts +19 -19
- package/src/sql-command.js +2 -2
- package/src/validators.d.ts +14 -14
- package/src/validators.js +71 -69
- package/src/valueConverters.d.ts +13 -13
- package/src/valueConverters.js +213 -213
- package/urlBuilder.d.ts +6 -6
- 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
|
|
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>>;
|