@woltz/rich-domain 1.1.0 → 1.2.1
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/CHANGELOG.md +87 -21
- package/dist/aggregate-changes.d.ts +164 -0
- package/dist/aggregate-changes.d.ts.map +1 -0
- package/dist/aggregate-changes.js +281 -0
- package/dist/aggregate-changes.js.map +1 -0
- package/dist/base-entity.d.ts +32 -8
- package/dist/base-entity.d.ts.map +1 -1
- package/dist/base-entity.js +117 -86
- package/dist/base-entity.js.map +1 -1
- package/dist/criteria.d.ts +31 -15
- package/dist/criteria.d.ts.map +1 -1
- package/dist/criteria.js +151 -61
- package/dist/criteria.js.map +1 -1
- package/dist/crypto.d.ts +3 -0
- package/dist/crypto.d.ts.map +1 -0
- package/dist/crypto.js +29 -0
- package/dist/crypto.js.map +1 -0
- package/dist/entity-changes.d.ts +84 -0
- package/dist/entity-changes.d.ts.map +1 -0
- package/dist/entity-changes.js +135 -0
- package/dist/entity-changes.js.map +1 -0
- package/dist/entity-schema-registry.d.ts +148 -0
- package/dist/entity-schema-registry.d.ts.map +1 -0
- package/dist/entity-schema-registry.js +219 -0
- package/dist/entity-schema-registry.js.map +1 -0
- package/dist/history-tracker.d.ts +97 -0
- package/dist/history-tracker.d.ts.map +1 -0
- package/dist/history-tracker.js +805 -0
- package/dist/history-tracker.js.map +1 -0
- package/dist/id.d.ts +11 -10
- package/dist/id.d.ts.map +1 -1
- package/dist/id.js +4 -28
- package/dist/id.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/mapper.d.ts +1 -1
- package/dist/mapper.d.ts.map +1 -1
- package/dist/mapper.js.map +1 -1
- package/dist/paginated-result.d.ts.map +1 -1
- package/dist/paginated-result.js +7 -6
- package/dist/paginated-result.js.map +1 -1
- package/dist/repository/base-repository.d.ts +6 -32
- package/dist/repository/base-repository.d.ts.map +1 -1
- package/dist/repository/base-repository.js +0 -27
- package/dist/repository/base-repository.js.map +1 -1
- package/dist/repository/unit-of-work.d.ts +0 -25
- package/dist/repository/unit-of-work.d.ts.map +1 -1
- package/dist/repository/unit-of-work.js +0 -25
- package/dist/repository/unit-of-work.js.map +1 -1
- package/dist/types/change-tracker.d.ts +186 -0
- package/dist/types/change-tracker.d.ts.map +1 -0
- package/dist/types/change-tracker.js +2 -0
- package/dist/types/change-tracker.js.map +1 -0
- package/dist/types/criteria.d.ts +31 -7
- package/dist/types/criteria.d.ts.map +1 -1
- package/dist/types/history-tracker.d.ts +11 -0
- package/dist/types/history-tracker.d.ts.map +1 -1
- package/dist/types/utils.d.ts +0 -1
- package/dist/types/utils.d.ts.map +1 -1
- package/dist/utils/criteria-operator-validation.d.ts +5 -0
- package/dist/utils/criteria-operator-validation.d.ts.map +1 -0
- package/dist/utils/criteria-operator-validation.js +143 -0
- package/dist/utils/criteria-operator-validation.js.map +1 -0
- package/dist/utils/helpers.d.ts +2 -0
- package/dist/utils/helpers.d.ts.map +1 -0
- package/dist/utils/helpers.js +10 -0
- package/dist/utils/helpers.js.map +1 -0
- package/dist/validation-error.d.ts.map +1 -1
- package/dist/validation-error.js +0 -3
- package/dist/validation-error.js.map +1 -1
- package/dist/value-object.d.ts +57 -8
- package/dist/value-object.d.ts.map +1 -1
- package/dist/value-object.js +49 -21
- package/dist/value-object.js.map +1 -1
- package/eslint.config.js +6 -0
- package/package.json +2 -1
- package/src/aggregate-changes.ts +335 -0
- package/src/base-entity.ts +140 -100
- package/src/criteria.ts +264 -82
- package/src/crypto.ts +31 -0
- package/src/entity-changes.ts +151 -0
- package/src/entity-schema-registry.ts +275 -0
- package/src/history-tracker.ts +1114 -0
- package/src/id.ts +17 -26
- package/src/index.ts +8 -2
- package/src/mapper.ts +4 -1
- package/src/paginated-result.ts +7 -8
- package/src/repository/base-repository.ts +6 -37
- package/src/repository/unit-of-work.ts +0 -25
- package/src/types/change-tracker.ts +221 -0
- package/src/types/criteria.ts +95 -17
- package/src/types/history-tracker.ts +13 -0
- package/src/types/utils.ts +0 -9
- package/src/utils/criteria-operator-validation.ts +171 -0
- package/src/utils/helpers.ts +6 -0
- package/src/validation-error.ts +0 -4
- package/src/value-object.ts +84 -23
- package/tests/aggregate-changes.test.ts +284 -0
- package/tests/criteria.test.ts +366 -90
- package/tests/entity-equality.test.ts +38 -61
- package/tests/entity-schema-registry.test.ts +382 -0
- package/tests/entity-validation.test.ts +7 -94
- package/tests/history-tracker.spec.ts +349 -617
- package/tests/id.test.ts +41 -44
- package/tests/load-test/data.json +346041 -0
- package/tests/load-test/entities.ts +97 -0
- package/tests/load-test/generate-data.ts +81 -0
- package/tests/load-test/lead-to-domain.mapper.ts +24 -0
- package/tests/load-test/load.test.ts +38 -0
- package/tests/repository.test.ts +30 -54
- package/tests/to-json.test.ts +14 -18
- package/tests/utils.ts +138 -102
- package/tests/value-objects.test.ts +57 -29
- package/dist/deep-proxy.d.ts +0 -36
- package/dist/deep-proxy.d.ts.map +0 -1
- package/dist/deep-proxy.js +0 -384
- package/dist/deep-proxy.js.map +0 -1
- package/src/deep-proxy.ts +0 -447
- package/tests/entity.test.ts +0 -33
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import { Entity } from "../entity";
|
|
2
|
+
import { ValueObject } from "../value-object";
|
|
3
|
+
/**
|
|
4
|
+
* Base operation with common information.
|
|
5
|
+
*/
|
|
6
|
+
export interface BaseOperation {
|
|
7
|
+
/** Entity name in the domain (e.g., 'User', 'Post', 'Comment') */
|
|
8
|
+
entity: string;
|
|
9
|
+
/** Depth in the aggregate tree (0 = root, 1 = direct children, etc.) */
|
|
10
|
+
depth: number;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Create operation.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateOperation<T = any> extends BaseOperation {
|
|
16
|
+
type: "create";
|
|
17
|
+
/** Entity data to be created */
|
|
18
|
+
data: T;
|
|
19
|
+
/** Parent ID (for FK) */
|
|
20
|
+
parentId?: string;
|
|
21
|
+
/** Parent entity name */
|
|
22
|
+
parentEntity?: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Update operation.
|
|
26
|
+
*/
|
|
27
|
+
export interface UpdateOperation<T = any> extends BaseOperation {
|
|
28
|
+
type: "update";
|
|
29
|
+
/** Entity ID */
|
|
30
|
+
id: string;
|
|
31
|
+
/** Current entity instance */
|
|
32
|
+
data: T;
|
|
33
|
+
/** Only fields that have changed */
|
|
34
|
+
changedFields: Record<string, any>;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Delete operation.
|
|
38
|
+
*/
|
|
39
|
+
export interface DeleteOperation<T = any> extends BaseOperation {
|
|
40
|
+
type: "delete";
|
|
41
|
+
/** Entity ID to be deleted */
|
|
42
|
+
id: string;
|
|
43
|
+
/** Entity data (for reference) */
|
|
44
|
+
data: T;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Union of all possible operations.
|
|
48
|
+
*/
|
|
49
|
+
export type Operation<T = any> = CreateOperation<T> | UpdateOperation<T> | DeleteOperation<T>;
|
|
50
|
+
/**
|
|
51
|
+
* Item for batch creation.
|
|
52
|
+
*/
|
|
53
|
+
export interface BatchCreateItem<T = any> {
|
|
54
|
+
/** Entity data */
|
|
55
|
+
data: T;
|
|
56
|
+
/** Parent ID (for FK) */
|
|
57
|
+
parentId?: string;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Item for batch update.
|
|
61
|
+
*/
|
|
62
|
+
export interface BatchUpdateItem {
|
|
63
|
+
/** Entity ID */
|
|
64
|
+
id: string;
|
|
65
|
+
/** Fields that have changed */
|
|
66
|
+
changedFields: Record<string, any>;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Grouped and ordered operations for batch execution.
|
|
70
|
+
*/
|
|
71
|
+
export interface BatchOperations {
|
|
72
|
+
/**
|
|
73
|
+
* Deletes grouped by entity, ordered by depth descending (leaf → root).
|
|
74
|
+
*/
|
|
75
|
+
deletes: Array<{
|
|
76
|
+
entity: string;
|
|
77
|
+
depth: number;
|
|
78
|
+
ids: string[];
|
|
79
|
+
}>;
|
|
80
|
+
/**
|
|
81
|
+
* Creates grouped by entity, ordered by depth ascending (root → leaf).
|
|
82
|
+
*/
|
|
83
|
+
creates: Array<{
|
|
84
|
+
entity: string;
|
|
85
|
+
depth: number;
|
|
86
|
+
items: BatchCreateItem[];
|
|
87
|
+
}>;
|
|
88
|
+
/**
|
|
89
|
+
* Updates grouped by entity.
|
|
90
|
+
*/
|
|
91
|
+
updates: Array<{
|
|
92
|
+
entity: string;
|
|
93
|
+
items: BatchUpdateItem[];
|
|
94
|
+
}>;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Changes detected in a collection (1:N).
|
|
98
|
+
*/
|
|
99
|
+
export interface CollectionChanges<T = any> {
|
|
100
|
+
/** Created items */
|
|
101
|
+
created: T[];
|
|
102
|
+
/** Updated items with their changes */
|
|
103
|
+
updated: Array<{
|
|
104
|
+
entity: T;
|
|
105
|
+
changes: Record<string, {
|
|
106
|
+
from: any;
|
|
107
|
+
to: any;
|
|
108
|
+
}>;
|
|
109
|
+
}>;
|
|
110
|
+
/** Deleted items */
|
|
111
|
+
deleted: T[];
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Possible states for a 1:1 relationship.
|
|
115
|
+
*/
|
|
116
|
+
export type EntityChangeState = "created" | "updated" | "deleted" | "replaced" | "unchanged";
|
|
117
|
+
/**
|
|
118
|
+
* Change in a 1:1 entity relationship.
|
|
119
|
+
*/
|
|
120
|
+
export interface EntityChange<T = any> {
|
|
121
|
+
/** State of the change */
|
|
122
|
+
state: EntityChangeState;
|
|
123
|
+
/** Current entity (null if deleted) */
|
|
124
|
+
current: T | null;
|
|
125
|
+
/** Previous entity (null if created) */
|
|
126
|
+
previous: T | null;
|
|
127
|
+
/** Field changes (if state === 'updated') */
|
|
128
|
+
changes?: Record<string, {
|
|
129
|
+
from: any;
|
|
130
|
+
to: any;
|
|
131
|
+
}>;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Change in a primitive field.
|
|
135
|
+
*/
|
|
136
|
+
export interface FieldChange<T = any> {
|
|
137
|
+
from: T;
|
|
138
|
+
to: T;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Extracts the props type from an Entity or ValueObject.
|
|
142
|
+
*/
|
|
143
|
+
export type ExtractProps<T> = T extends Entity<infer P> ? P : T extends ValueObject<infer P> ? P : never;
|
|
144
|
+
/**
|
|
145
|
+
* Keys of primitive properties (not Entity, ValueObject or Array).
|
|
146
|
+
*/
|
|
147
|
+
export type PrimitiveKeys<T> = {
|
|
148
|
+
[K in keyof T]: T[K] extends Entity<any> | ValueObject<any> | Array<any> | undefined ? never : K;
|
|
149
|
+
}[keyof T];
|
|
150
|
+
/**
|
|
151
|
+
* Keys of collections (arrays).
|
|
152
|
+
*/
|
|
153
|
+
export type CollectionKeys<T> = {
|
|
154
|
+
[K in keyof T]: T[K] extends Array<any> ? K : never;
|
|
155
|
+
}[keyof T];
|
|
156
|
+
/**
|
|
157
|
+
* Keys of single entities (1:1).
|
|
158
|
+
*/
|
|
159
|
+
export type SingleEntityKeys<T> = {
|
|
160
|
+
[K in keyof T]: T[K] extends Entity<any> | ValueObject<any> | null | undefined ? T[K] extends Array<any> ? never : K : never;
|
|
161
|
+
}[keyof T];
|
|
162
|
+
/**
|
|
163
|
+
* Change history entry.
|
|
164
|
+
*/
|
|
165
|
+
export interface HistoryEntry {
|
|
166
|
+
path: string;
|
|
167
|
+
previousValue: any;
|
|
168
|
+
currentValue: any;
|
|
169
|
+
timestamp: number;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Metadata from a tracked entity/VO.
|
|
173
|
+
*/
|
|
174
|
+
export interface TrackedEntityMetadata {
|
|
175
|
+
/** Entity name */
|
|
176
|
+
entityName: string;
|
|
177
|
+
/** Depth in the tree */
|
|
178
|
+
depth: number;
|
|
179
|
+
/** Parent ID */
|
|
180
|
+
parentId?: string;
|
|
181
|
+
/** Parent entity name */
|
|
182
|
+
parentEntity?: string;
|
|
183
|
+
/** Path in the object (e.g., 'posts[0].comments[1]') */
|
|
184
|
+
path: string;
|
|
185
|
+
}
|
|
186
|
+
//# sourceMappingURL=change-tracker.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"change-tracker.d.ts","sourceRoot":"","sources":["../../src/types/change-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa;IAC7D,IAAI,EAAE,QAAQ,CAAC;IACf,gCAAgC;IAChC,IAAI,EAAE,CAAC,CAAC;IACR,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa;IAC7D,IAAI,EAAE,QAAQ,CAAC;IACf,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,IAAI,EAAE,CAAC,CAAC;IACR,oCAAoC;IACpC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa;IAC7D,IAAI,EAAE,QAAQ,CAAC;IACf,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,GAAG,IACzB,eAAe,CAAC,CAAC,CAAC,GAClB,eAAe,CAAC,CAAC,CAAC,GAClB,eAAe,CAAC,CAAC,CAAC,CAAC;AAEvB;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG;IACtC,kBAAkB;IAClB,IAAI,EAAE,CAAC,CAAC;IACR,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,+BAA+B;IAC/B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,EAAE,CAAC;KACf,CAAC,CAAC;IAEH;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,EAAE,CAAC;KAC1B,CAAC,CAAC;IAEH;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,eAAe,EAAE,CAAC;KAC1B,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,GAAG;IACxC,oBAAoB;IACpB,OAAO,EAAE,CAAC,EAAE,CAAC;IACb,uCAAuC;IACvC,OAAO,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,CAAC,CAAC;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,IAAI,EAAE,GAAG,CAAC;YAAC,EAAE,EAAE,GAAG,CAAA;SAAE,CAAC,CAAC;KACjD,CAAC,CAAC;IACH,oBAAoB;IACpB,OAAO,EAAE,CAAC,EAAE,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,SAAS,GACT,SAAS,GACT,UAAU,GACV,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,GAAG;IACnC,0BAA0B;IAC1B,KAAK,EAAE,iBAAiB,CAAC;IACzB,uCAAuC;IACvC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAClB,wCAAwC;IACxC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC;IACnB,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,GAAG,CAAC;QAAC,EAAE,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,CAAC,CAAC;CACP;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,CAAC,GACnD,CAAC,GACD,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC9B,CAAC,GACD,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAChB,MAAM,CAAC,GAAG,CAAC,GACX,WAAW,CAAC,GAAG,CAAC,GAChB,KAAK,CAAC,GAAG,CAAC,GACV,SAAS,GACT,KAAK,GACL,CAAC;CACN,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK;CACpD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;KAC/B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,GAC1E,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GACrB,KAAK,GACL,CAAC,GACH,KAAK;CACV,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,GAAG,CAAC;IACnB,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;CACd"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"change-tracker.js","sourceRoot":"","sources":["../../src/types/change-tracker.ts"],"names":[],"mappings":""}
|
package/dist/types/criteria.d.ts
CHANGED
|
@@ -1,21 +1,40 @@
|
|
|
1
1
|
import { Primitive } from "./utils";
|
|
2
2
|
export declare const FILTER_OPERATORS: readonly ["equals", "notEquals", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "contains", "startsWith", "endsWith", "in", "notIn", "between", "isNull", "isNotNull"];
|
|
3
|
-
export type FilterValueFor<T> = T | (T extends number | Date ? [T, T] : never) | T[] | null;
|
|
4
|
-
export type PathValue<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? PathValue<T[K], Rest> : never : P extends keyof T ? T[P] : never;
|
|
5
3
|
export type FilterOperator = (typeof FILTER_OPERATORS)[number];
|
|
4
|
+
export type StringOperators = "equals" | "notEquals" | "contains" | "startsWith" | "endsWith" | "in" | "notIn" | "isNull" | "isNotNull";
|
|
5
|
+
export type NumberOperators = "equals" | "notEquals" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual" | "in" | "notIn" | "between" | "isNull" | "isNotNull";
|
|
6
|
+
export type DateOperators = "equals" | "notEquals" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual" | "in" | "notIn" | "between" | "isNull" | "isNotNull";
|
|
7
|
+
export type BooleanOperators = "equals" | "notEquals" | "isNull" | "isNotNull";
|
|
8
|
+
export type ArrayOperators = "in" | "notIn" | "isNull" | "isNotNull";
|
|
9
|
+
export type OperatorsForType<T> = T extends string ? StringOperators : T extends number ? NumberOperators : T extends Date ? DateOperators : T extends boolean ? BooleanOperators : T extends Array<any> ? ArrayOperators : FilterOperator;
|
|
10
|
+
export type FilterValueFor<T> = T | (T extends number | Date ? [T, T] : never) | T[] | null;
|
|
11
|
+
export type PathValue<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? T[K] extends Array<infer U> ? PathValue<U, Rest> : PathValue<T[K], Rest> : never : P extends keyof T ? T[P] : never;
|
|
6
12
|
export interface Filter<TField = string, TValue = unknown> {
|
|
7
13
|
field: TField;
|
|
8
|
-
operator: FilterOperator
|
|
14
|
+
operator: unknown extends TValue ? FilterOperator : OperatorsForType<TValue>;
|
|
9
15
|
value: TValue;
|
|
16
|
+
options?: CriteriaOptions;
|
|
10
17
|
}
|
|
11
18
|
export type TypedFilter<T> = {
|
|
12
|
-
[K in FieldPath<T>]:
|
|
19
|
+
[K in FieldPath<T>]: {
|
|
20
|
+
field: K;
|
|
21
|
+
operator: OperatorsForType<NonNullable<PathValue<T, K>>>;
|
|
22
|
+
value: FilterValueFor<NonNullable<PathValue<T, K>>>;
|
|
23
|
+
options?: CriteriaOptions;
|
|
24
|
+
};
|
|
13
25
|
}[FieldPath<T>];
|
|
26
|
+
export type CriteriaAdapter<Input, Output> = {
|
|
27
|
+
[K in FieldPath<Input>]?: FieldPath<Output>;
|
|
28
|
+
};
|
|
14
29
|
export type OrderDirection = "asc" | "desc";
|
|
15
30
|
export interface Order {
|
|
16
31
|
field: string;
|
|
17
32
|
direction: OrderDirection;
|
|
18
33
|
}
|
|
34
|
+
export type TypedOrder<T> = {
|
|
35
|
+
field: FieldPath<T>;
|
|
36
|
+
direction: OrderDirection;
|
|
37
|
+
};
|
|
19
38
|
export interface Pagination {
|
|
20
39
|
page: number;
|
|
21
40
|
limit: number;
|
|
@@ -33,7 +52,12 @@ export interface PaginationMeta {
|
|
|
33
52
|
hasNext: boolean;
|
|
34
53
|
hasPrevious: boolean;
|
|
35
54
|
}
|
|
36
|
-
export
|
|
37
|
-
|
|
38
|
-
}
|
|
55
|
+
export interface CriteriaOptions {
|
|
56
|
+
quantifier?: "some" | "every" | "none";
|
|
57
|
+
}
|
|
58
|
+
type ExcludeBuiltInKeys<T> = Exclude<keyof T, keyof any[] | number | symbol>;
|
|
59
|
+
export type FieldPath<T> = T extends Primitive ? never : {
|
|
60
|
+
[K in ExcludeBuiltInKeys<T> & string]: NonNullable<T[K]> extends Primitive ? K : NonNullable<T[K]> extends Array<infer U> ? U extends Primitive ? K : K | `${K}.${FieldPath<U>}` : `${K}.${FieldPath<NonNullable<T[K]>>}`;
|
|
61
|
+
}[ExcludeBuiltInKeys<T> & string];
|
|
62
|
+
export {};
|
|
39
63
|
//# sourceMappingURL=criteria.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"criteria.d.ts","sourceRoot":"","sources":["../../src/types/criteria.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,eAAO,MAAM,gBAAgB,6LAenB,CAAC;AAEX,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB,CAAC,GACD,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,
|
|
1
|
+
{"version":3,"file":"criteria.d.ts","sourceRoot":"","sources":["../../src/types/criteria.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,eAAO,MAAM,gBAAgB,6LAenB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,WAAW,GACX,UAAU,GACV,YAAY,GACZ,UAAU,GACV,IAAI,GACJ,OAAO,GACP,QAAQ,GACR,WAAW,CAAC;AAEhB,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,WAAW,GACX,aAAa,GACb,oBAAoB,GACpB,UAAU,GACV,iBAAiB,GACjB,IAAI,GACJ,OAAO,GACP,SAAS,GACT,QAAQ,GACR,WAAW,CAAC;AAEhB,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,WAAW,GACX,aAAa,GACb,oBAAoB,GACpB,UAAU,GACV,iBAAiB,GACjB,IAAI,GACJ,OAAO,GACP,SAAS,GACT,QAAQ,GACR,WAAW,CAAC;AAEhB,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAE/E,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,CAAC;AAErE,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC9C,eAAe,GACf,CAAC,SAAS,MAAM,GAChB,eAAe,GACf,CAAC,SAAS,IAAI,GACd,aAAa,GACb,CAAC,SAAS,OAAO,GACjB,gBAAgB,GAChB,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GACpB,cAAc,GACd,cAAc,CAAC;AAEnB,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB,CAAC,GACD,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,GAC1C,CAAC,EAAE,GACH,IAAI,CAAC;AAET,MAAM,MAAM,SAAS,CACnB,CAAC,EACD,CAAC,SAAS,MAAM,IACd,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,MAAM,IAAI,EAAE,GACpC,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACzB,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,GAClB,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GACvB,KAAK,GACP,CAAC,SAAS,MAAM,CAAC,GACjB,CAAC,CAAC,CAAC,CAAC,GACJ,KAAK,CAAC;AAEV,MAAM,WAAW,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,OAAO;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,SAAS,MAAM,GAAG,cAAc,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC7E,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG;QACnB,KAAK,EAAE,CAAC,CAAC;QACT,QAAQ,EAAE,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,KAAK,EAAE,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,OAAO,CAAC,EAAE,eAAe,CAAC;KAC3B;CACF,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhB,MAAM,MAAM,eAAe,CAAC,KAAK,EAAE,MAAM,IAAI;KAC1C,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5C,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAC1B,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACpB,SAAS,EAAE,cAAc,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;CACxC;AAED,KAAK,kBAAkB,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC;AAE7E,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAC1C,KAAK,GACL;KACG,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GACtE,CAAC,GACD,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACxC,CAAC,SAAS,SAAS,GACjB,CAAC,GACD,CAAC,GAAG,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,GAC5B,GAAG,CAAC,IAAI,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;CAC3C,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { TrackedEntityMetadata } from "./change-tracker";
|
|
1
2
|
import { BaseProps } from "./domain";
|
|
2
3
|
import { IsArray, NonUndefined, UnwrapArray } from "./utils";
|
|
3
4
|
export interface ChangeEvent<T> {
|
|
@@ -5,6 +6,16 @@ export interface ChangeEvent<T> {
|
|
|
5
6
|
current: T;
|
|
6
7
|
path: string;
|
|
7
8
|
}
|
|
9
|
+
export interface TrackedItem {
|
|
10
|
+
entity: any;
|
|
11
|
+
metadata: TrackedEntityMetadata;
|
|
12
|
+
originalState: any;
|
|
13
|
+
}
|
|
14
|
+
export interface ArrayState {
|
|
15
|
+
cloned: any[];
|
|
16
|
+
original: any[];
|
|
17
|
+
metadata: TrackedEntityMetadata;
|
|
18
|
+
}
|
|
8
19
|
export interface ArrayChangeEvent<T> {
|
|
9
20
|
toCreate: T[];
|
|
10
21
|
toUpdate: T[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"history-tracker.d.ts","sourceRoot":"","sources":["../../src/types/history-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE7D,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,QAAQ,EAAE,CAAC,GAAG,SAAS,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AACpE,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEtE,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACrC,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,SAAS,IAAI;KACnD,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GACrD,iBAAiB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAClD,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,GAAG,CAAC;IACnB,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB"}
|
|
1
|
+
{"version":3,"file":"history-tracker.d.ts","sourceRoot":"","sources":["../../src/types/history-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE7D,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,QAAQ,EAAE,CAAC,GAAG,SAAS,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,qBAAqB,CAAC;IAChC,aAAa,EAAE,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChB,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AACpE,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEtE,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACrC,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,SAAS,IAAI;KACnD,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GACrD,iBAAiB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAClD,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,GAAG,CAAC;IACnB,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB"}
|
package/dist/types/utils.d.ts
CHANGED
|
@@ -6,7 +6,6 @@ export type DeepJsonResult<T> = {
|
|
|
6
6
|
toJson(): infer V;
|
|
7
7
|
} ? V[] : U extends Id ? string[] : U[] : T[K];
|
|
8
8
|
};
|
|
9
|
-
export type DeepKeyOf<T, K extends keyof T = keyof T> = K extends string ? T[K] extends Primitive ? K : T[K] extends object ? `${K}` | `${K}.${DeepKeyOf<T[K]>}` : never : never;
|
|
10
9
|
export type Primitive = string | number | boolean | Date | null | undefined;
|
|
11
10
|
export type UnwrapArray<T> = T extends Array<infer U> ? U : never;
|
|
12
11
|
export type IsArray<T> = T extends Array<any> ? true : false;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/types/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AAE3B,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAC3B,MAAM,GACN,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,MAAM,IAAI,MAAM,CAAC,CAAA;KAAE,GAClC,CAAC,GACD,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC3B,CAAC,SAAS;QAAE,MAAM,IAAI,MAAM,CAAC,CAAA;KAAE,GAC7B,CAAC,EAAE,GACH,CAAC,SAAS,EAAE,GACZ,MAAM,EAAE,GACR,CAAC,EAAE,GACL,CAAC,CAAC,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,SAAS,
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/types/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AAE3B,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAC3B,MAAM,GACN,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,MAAM,IAAI,MAAM,CAAC,CAAA;KAAE,GAClC,CAAC,GACD,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC3B,CAAC,SAAS;QAAE,MAAM,IAAI,MAAM,CAAC,CAAA;KAAE,GAC7B,CAAC,EAAE,GACH,CAAC,SAAS,EAAE,GACZ,MAAM,EAAE,GACR,CAAC,EAAE,GACL,CAAC,CAAC,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;AAC5E,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAClE,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAC7D,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { FilterOperator } from "../types";
|
|
2
|
+
export declare function isValidOperatorForType(value: unknown, operator: FilterOperator): boolean;
|
|
3
|
+
export declare function getValidOperatorsForType(value: unknown): FilterOperator[];
|
|
4
|
+
export declare function isOperator(value: string): value is FilterOperator;
|
|
5
|
+
//# sourceMappingURL=criteria-operator-validation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"criteria-operator-validation.d.ts","sourceRoot":"","sources":["../../src/utils/criteria-operator-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,cAAc,EAGf,MAAM,UAAU,CAAC;AAElB,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,cAAc,GACvB,OAAO,CAyFT;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,EAAE,CA8DzE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,cAAc,CAEjE"}
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
import { FILTER_OPERATORS, } from "../types";
|
|
2
|
+
export function isValidOperatorForType(value, operator) {
|
|
3
|
+
// Handle null/undefined
|
|
4
|
+
if (value === null || value === undefined) {
|
|
5
|
+
return ["isNull", "isNotNull", "equals", "notEquals"].includes(operator);
|
|
6
|
+
}
|
|
7
|
+
// Special case: between operator with array [min, max]
|
|
8
|
+
if (operator === "between" && Array.isArray(value) && value.length === 2) {
|
|
9
|
+
// Validate based on the type of the first element
|
|
10
|
+
const elementType = typeof value[0];
|
|
11
|
+
if (elementType === "number" || value[0] instanceof Date) {
|
|
12
|
+
return true;
|
|
13
|
+
}
|
|
14
|
+
return false;
|
|
15
|
+
}
|
|
16
|
+
const valueType = typeof value;
|
|
17
|
+
// String operators
|
|
18
|
+
if (valueType === "string") {
|
|
19
|
+
const validOps = [
|
|
20
|
+
"equals",
|
|
21
|
+
"notEquals",
|
|
22
|
+
"contains",
|
|
23
|
+
"startsWith",
|
|
24
|
+
"endsWith",
|
|
25
|
+
"in",
|
|
26
|
+
"notIn",
|
|
27
|
+
"isNull",
|
|
28
|
+
"isNotNull",
|
|
29
|
+
];
|
|
30
|
+
return validOps.includes(operator);
|
|
31
|
+
}
|
|
32
|
+
// Number operators
|
|
33
|
+
if (valueType === "number") {
|
|
34
|
+
const validOps = [
|
|
35
|
+
"equals",
|
|
36
|
+
"notEquals",
|
|
37
|
+
"greaterThan",
|
|
38
|
+
"greaterThanOrEqual",
|
|
39
|
+
"lessThan",
|
|
40
|
+
"lessThanOrEqual",
|
|
41
|
+
"in",
|
|
42
|
+
"notIn",
|
|
43
|
+
"between",
|
|
44
|
+
"isNull",
|
|
45
|
+
"isNotNull",
|
|
46
|
+
];
|
|
47
|
+
return validOps.includes(operator);
|
|
48
|
+
}
|
|
49
|
+
// Boolean operators
|
|
50
|
+
if (valueType === "boolean") {
|
|
51
|
+
const validOps = [
|
|
52
|
+
"equals",
|
|
53
|
+
"notEquals",
|
|
54
|
+
"isNull",
|
|
55
|
+
"isNotNull",
|
|
56
|
+
];
|
|
57
|
+
return validOps.includes(operator);
|
|
58
|
+
}
|
|
59
|
+
// Date operators
|
|
60
|
+
if (value instanceof Date) {
|
|
61
|
+
const validOps = [
|
|
62
|
+
"equals",
|
|
63
|
+
"notEquals",
|
|
64
|
+
"greaterThan",
|
|
65
|
+
"greaterThanOrEqual",
|
|
66
|
+
"lessThan",
|
|
67
|
+
"lessThanOrEqual",
|
|
68
|
+
"in",
|
|
69
|
+
"notIn",
|
|
70
|
+
"between",
|
|
71
|
+
"isNull",
|
|
72
|
+
"isNotNull",
|
|
73
|
+
];
|
|
74
|
+
return validOps.includes(operator);
|
|
75
|
+
}
|
|
76
|
+
// Array operators
|
|
77
|
+
if (Array.isArray(value)) {
|
|
78
|
+
const validOps = ["in", "notIn", "isNull", "isNotNull"];
|
|
79
|
+
return validOps.includes(operator);
|
|
80
|
+
}
|
|
81
|
+
// For unknown types, allow all operators
|
|
82
|
+
return true;
|
|
83
|
+
}
|
|
84
|
+
export function getValidOperatorsForType(value) {
|
|
85
|
+
if (value === null || value === undefined) {
|
|
86
|
+
return ["isNull", "isNotNull", "equals", "notEquals"];
|
|
87
|
+
}
|
|
88
|
+
const valueType = typeof value;
|
|
89
|
+
if (valueType === "string" && Number.isNaN(Number(value))) {
|
|
90
|
+
return [
|
|
91
|
+
"equals",
|
|
92
|
+
"notEquals",
|
|
93
|
+
"contains",
|
|
94
|
+
"startsWith",
|
|
95
|
+
"endsWith",
|
|
96
|
+
"in",
|
|
97
|
+
"notIn",
|
|
98
|
+
"isNull",
|
|
99
|
+
"isNotNull",
|
|
100
|
+
];
|
|
101
|
+
}
|
|
102
|
+
if (valueType === "number") {
|
|
103
|
+
return [
|
|
104
|
+
"equals",
|
|
105
|
+
"notEquals",
|
|
106
|
+
"greaterThan",
|
|
107
|
+
"greaterThanOrEqual",
|
|
108
|
+
"lessThan",
|
|
109
|
+
"lessThanOrEqual",
|
|
110
|
+
"in",
|
|
111
|
+
"notIn",
|
|
112
|
+
"between",
|
|
113
|
+
"isNull",
|
|
114
|
+
"isNotNull",
|
|
115
|
+
];
|
|
116
|
+
}
|
|
117
|
+
if (valueType === "boolean") {
|
|
118
|
+
return ["equals", "notEquals", "isNull", "isNotNull"];
|
|
119
|
+
}
|
|
120
|
+
if (value instanceof Date) {
|
|
121
|
+
return [
|
|
122
|
+
"equals",
|
|
123
|
+
"notEquals",
|
|
124
|
+
"greaterThan",
|
|
125
|
+
"greaterThanOrEqual",
|
|
126
|
+
"lessThan",
|
|
127
|
+
"lessThanOrEqual",
|
|
128
|
+
"in",
|
|
129
|
+
"notIn",
|
|
130
|
+
"between",
|
|
131
|
+
"isNull",
|
|
132
|
+
"isNotNull",
|
|
133
|
+
];
|
|
134
|
+
}
|
|
135
|
+
if (Array.isArray(value)) {
|
|
136
|
+
return ["in", "notIn", "isNull", "isNotNull"];
|
|
137
|
+
}
|
|
138
|
+
return [...FILTER_OPERATORS];
|
|
139
|
+
}
|
|
140
|
+
export function isOperator(value) {
|
|
141
|
+
return FILTER_OPERATORS.includes(value);
|
|
142
|
+
}
|
|
143
|
+
//# sourceMappingURL=criteria-operator-validation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"criteria-operator-validation.js","sourceRoot":"","sources":["../../src/utils/criteria-operator-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,gBAAgB,GAIjB,MAAM,UAAU,CAAC;AAElB,MAAM,UAAU,sBAAsB,CACpC,KAAc,EACd,QAAwB;IAExB,wBAAwB;IACxB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3E,CAAC;IAED,uDAAuD;IACvD,IAAI,QAAQ,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzE,kDAAkD;QAClD,MAAM,WAAW,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,WAAW,KAAK,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAE/B,mBAAmB;IACnB,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAsB;YAClC,QAAQ;YACR,WAAW;YACX,UAAU;YACV,YAAY;YACZ,UAAU;YACV,IAAI;YACJ,OAAO;YACP,QAAQ;YACR,WAAW;SACZ,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAA2B,CAAC,CAAC;IACxD,CAAC;IAED,mBAAmB;IACnB,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAsB;YAClC,QAAQ;YACR,WAAW;YACX,aAAa;YACb,oBAAoB;YACpB,UAAU;YACV,iBAAiB;YACjB,IAAI;YACJ,OAAO;YACP,SAAS;YACT,QAAQ;YACR,WAAW;SACZ,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAA2B,CAAC,CAAC;IACxD,CAAC;IAED,oBAAoB;IACpB,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAuB;YACnC,QAAQ;YACR,WAAW;YACX,QAAQ;YACR,WAAW;SACZ,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAA4B,CAAC,CAAC;IACzD,CAAC;IAED,iBAAiB;IACjB,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAoB;YAChC,QAAQ;YACR,WAAW;YACX,aAAa;YACb,oBAAoB;YACpB,UAAU;YACV,iBAAiB;YACjB,IAAI;YACJ,OAAO;YACP,SAAS;YACT,QAAQ;YACR,WAAW;SACZ,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAAyB,CAAC,CAAC;IACtD,CAAC;IAED,kBAAkB;IAClB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC1E,OAAO,QAAQ,CAAC,QAAQ,CAAC,QAA0B,CAAC,CAAC;IACvD,CAAC;IAED,yCAAyC;IACzC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAE/B,IAAI,SAAS,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC1D,OAAO;YACL,QAAQ;YACR,WAAW;YACX,UAAU;YACV,YAAY;YACZ,UAAU;YACV,IAAI;YACJ,OAAO;YACP,QAAQ;YACR,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO;YACL,QAAQ;YACR,WAAW;YACX,aAAa;YACb,oBAAoB;YACpB,UAAU;YACV,iBAAiB;YACjB,IAAI;YACJ,OAAO;YACP,SAAS;YACT,QAAQ;YACR,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO;YACL,QAAQ;YACR,WAAW;YACX,aAAa;YACb,oBAAoB;YACpB,UAAU;YACV,iBAAiB;YACjB,IAAI;YACJ,OAAO;YACP,SAAS;YACT,QAAQ;YACR,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,CAAC,GAAG,gBAAgB,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,KAAuB,CAAC,CAAC;AAC5D,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAAA,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAKlD"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export function parseQueryValue(value) {
|
|
2
|
+
if (!isNaN(Number(value)))
|
|
3
|
+
return Number(value); // number
|
|
4
|
+
if (value === "true" || value === "false")
|
|
5
|
+
return value === "true"; // boolean
|
|
6
|
+
if (!isNaN(Date.parse(value)))
|
|
7
|
+
return new Date(value); // Date
|
|
8
|
+
return value; // string
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;IAC1D,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,KAAK,KAAK,MAAM,CAAC,CAAC,UAAU;IAC9E,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO;IAC9D,OAAO,KAAK,CAAC,CAAC,SAAS;AACzB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validation-error.d.ts","sourceRoot":"","sources":["../src/validation-error.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"validation-error.d.ts","sourceRoot":"","sources":["../src/validation-error.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,eAAgB,SAAQ,KAAK;IACxC,SAAgB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1C,SAAgB,mBAAmB,QAAQ;gBAE/B,MAAM,EAAE,eAAe,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM;IAavD;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe;IAalE;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE;IAIvB;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,EAAE;IAIjD;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIvC;;OAEG;IACH,MAAM,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,eAAe,EAAE,CAAA;KAAE;CAOvE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,OAAO,EAAE,MAAM,GACd,eAAe,CAKjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,OAAO,EAAE,MAAM,GACd,KAAK,CAEP"}
|
package/dist/validation-error.js
CHANGED
|
@@ -1,6 +1,3 @@
|
|
|
1
|
-
// ============================================================================
|
|
2
|
-
// Validation Error - Domain Validation Errors
|
|
3
|
-
// ============================================================================
|
|
4
1
|
export class ValidationError extends Error {
|
|
5
2
|
constructor(issues, message) {
|
|
6
3
|
const errorMessage = message || `Validation failed: ${issues.map(i => i.message).join(', ')}`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validation-error.js","sourceRoot":"","sources":["../src/validation-error.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"validation-error.js","sourceRoot":"","sources":["../src/validation-error.ts"],"names":[],"mappings":"AAKA,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAIxC,YAAY,MAAyB,EAAE,OAAgB;QACrD,MAAM,YAAY,GAChB,OAAO,IAAI,sBAAsB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3E,KAAK,CAAC,YAAY,CAAC,CAAC;QALN,wBAAmB,GAAG,IAAI,CAAC,CAAC,2BAA2B;QAMrE,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,8BAA8B;QAC9B,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAc;QACrC,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,sDAAsD;QACtD,OAAO,CACL,KAAK,YAAY,KAAK;YACtB,KAAK,CAAC,IAAI,KAAK,iBAAiB;YAChC,QAAQ,IAAI,KAAK;YACjB,KAAK,CAAC,OAAO,CAAE,KAAa,CAAC,MAAM,CAAC,CACrC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,IAAuB,EACvB,OAAe;IAEf,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAClD,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAuB,EACvB,OAAe;IAEf,MAAM,IAAI,eAAe,CAAC,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC"}
|
package/dist/value-object.d.ts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import { ValidationError } from "./validation-error";
|
|
2
2
|
import { IDomainEvent } from ".";
|
|
3
3
|
import { VOHooks, EntityValidation } from "./types";
|
|
4
|
+
/**
|
|
5
|
+
* Identity key type for a Value Object. Can be a single key or an array of keys (composite key).
|
|
6
|
+
*/
|
|
7
|
+
export type IdentityKeyDefinition<T> = (keyof T)[] | keyof T;
|
|
4
8
|
export declare abstract class ValueObject<T> {
|
|
5
9
|
protected readonly props: T;
|
|
6
10
|
private validationConfig;
|
|
@@ -9,38 +13,83 @@ export declare abstract class ValueObject<T> {
|
|
|
9
13
|
private domainEvents;
|
|
10
14
|
protected static validation?: EntityValidation<any>;
|
|
11
15
|
protected static hooks?: VOHooks<any, any>;
|
|
16
|
+
/**
|
|
17
|
+
* Identity key for identification in collections.
|
|
18
|
+
* Used by HistoryTracker to track changes in arrays of Value Objects.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```typescript
|
|
22
|
+
* // Simple key
|
|
23
|
+
* class TagReference extends ValueObject<{ tagId: string }> {
|
|
24
|
+
* static readonly identityKey = 'tagId';
|
|
25
|
+
* }
|
|
26
|
+
*
|
|
27
|
+
* // Composite key
|
|
28
|
+
* class Like extends ValueObject<{ postId: string; userId: string }> {
|
|
29
|
+
* static readonly identityKey = ['postId', 'userId'];
|
|
30
|
+
* }
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
protected static identityKey?: IdentityKeyDefinition<any>;
|
|
12
34
|
constructor(props: T);
|
|
13
35
|
private validateProps;
|
|
14
36
|
private extractPathKey;
|
|
15
37
|
/**
|
|
16
|
-
*
|
|
38
|
+
* Returns true if the value object has validation errors (when throwOnError is false).
|
|
17
39
|
*/
|
|
18
40
|
get hasValidationErrors(): boolean;
|
|
19
41
|
/**
|
|
20
|
-
*
|
|
42
|
+
* Returns the validation errors (when throwOnError is false).
|
|
21
43
|
*/
|
|
22
44
|
get validationErrors(): ValidationError | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* Compare this ValueObject with another for equality based on their properties.
|
|
47
|
+
*/
|
|
23
48
|
equals(other: ValueObject<T>): boolean;
|
|
24
49
|
/**
|
|
25
|
-
*
|
|
50
|
+
* Returns the identity key for this Value Object.
|
|
51
|
+
* Used for identification in collections when identityKey is set.
|
|
52
|
+
*
|
|
53
|
+
* @returns String with the identity key or null if not defined
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```typescript
|
|
57
|
+
* const like = new Like({ postId: 'p1', userId: 'u1' });
|
|
58
|
+
* like.getIdentityKey(); // 'p1:u1'
|
|
59
|
+
*
|
|
60
|
+
* const tag = new TagReference({ tagId: 'tag-123' });
|
|
61
|
+
* tag.getIdentityKey(); // 'tag-123'
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
getIdentityKey(): string | null;
|
|
65
|
+
/**
|
|
66
|
+
* Returns true if this Value Object has an identity key defined.
|
|
67
|
+
*/
|
|
68
|
+
hasIdentityKey(): boolean;
|
|
69
|
+
/**
|
|
70
|
+
* Returns the identity key definition (if any).
|
|
71
|
+
*/
|
|
72
|
+
static getIdentityKeyDefinition<P>(): IdentityKeyDefinition<P> | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* Adds a domain event to this value object.
|
|
26
75
|
*/
|
|
27
76
|
protected addDomainEvent(event: IDomainEvent): void;
|
|
28
77
|
/**
|
|
29
|
-
*
|
|
78
|
+
* Returns all uncommitted domain events.
|
|
30
79
|
*/
|
|
31
80
|
getUncommittedEvents(): IDomainEvent[];
|
|
32
81
|
/**
|
|
33
|
-
*
|
|
82
|
+
* Clears all domain events (call after publishing).
|
|
34
83
|
*/
|
|
35
84
|
clearEvents(): void;
|
|
36
85
|
/**
|
|
37
|
-
*
|
|
86
|
+
* Returns true if the value object has uncommitted events.
|
|
38
87
|
*/
|
|
39
88
|
hasUncommittedEvents(): boolean;
|
|
40
89
|
toJson(): T;
|
|
41
90
|
/**
|
|
42
|
-
*
|
|
43
|
-
*
|
|
91
|
+
* Creates a new ValueObject with updated properties.
|
|
92
|
+
* ValueObjects are immutable, so this returns a new instance.
|
|
44
93
|
*/
|
|
45
94
|
protected clone(updates: Partial<T>): this;
|
|
46
95
|
}
|