@opencrvs/toolkit 1.8.0-rc.fa8bcf6 → 1.8.0-rc.facf9d6

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 (39) hide show
  1. package/dist/commons/api/router.d.ts +7597 -4530
  2. package/dist/commons/conditionals/conditionals.d.ts +7 -6
  3. package/dist/commons/events/ActionConfig.d.ts +47498 -39631
  4. package/dist/commons/events/ActionDocument.d.ts +620 -413
  5. package/dist/commons/events/ActionInput.d.ts +255 -183
  6. package/dist/commons/events/AdvancedSearchConfig.d.ts +637 -48
  7. package/dist/commons/events/Constants.d.ts +2 -0
  8. package/dist/commons/events/CountryConfigQueryInput.d.ts +2982 -0
  9. package/dist/commons/events/CreatedAtLocation.d.ts +3 -0
  10. package/dist/commons/events/Draft.d.ts +29 -26
  11. package/dist/commons/events/EventConfig.d.ts +18414 -16593
  12. package/dist/commons/events/EventDocument.d.ts +373 -325
  13. package/dist/commons/events/EventIndex.d.ts +706 -291
  14. package/dist/commons/events/EventInput.d.ts +0 -13
  15. package/dist/commons/events/EventMetadata.d.ts +290 -14
  16. package/dist/commons/events/FieldConfig.d.ts +1305 -441
  17. package/dist/commons/events/FieldType.d.ts +3 -2
  18. package/dist/commons/events/FieldTypeMapping.d.ts +16 -6
  19. package/dist/commons/events/FieldValue.d.ts +8 -3
  20. package/dist/commons/events/FormConfig.d.ts +8993 -3809
  21. package/dist/commons/events/PageConfig.d.ts +1912 -636
  22. package/dist/commons/events/SummaryConfig.d.ts +17 -0
  23. package/dist/commons/events/User.d.ts +31 -7
  24. package/dist/commons/events/WorkqueueColumnConfig.d.ts +53 -0
  25. package/dist/commons/events/WorkqueueConfig.d.ts +4491 -10
  26. package/dist/commons/events/defineConfig.d.ts +3576 -3692
  27. package/dist/commons/events/event.d.ts +37 -8
  28. package/dist/commons/events/field.d.ts +28 -23
  29. package/dist/commons/events/index.d.ts +4 -0
  30. package/dist/commons/events/scopes.d.ts +21 -2
  31. package/dist/commons/events/serializer.d.ts +2 -0
  32. package/dist/commons/events/test.utils.d.ts +33 -13
  33. package/dist/commons/events/utils.d.ts +619 -291
  34. package/dist/commons/events/workqueueDefaultColumns.d.ts +3 -0
  35. package/dist/conditionals/index.js +28 -8
  36. package/dist/events/index.js +3204 -1546
  37. package/dist/scopes/index.d.ts +158 -1
  38. package/dist/scopes/index.js +152 -1
  39. package/package.json +1 -1
@@ -1,5 +1,6 @@
1
1
  import { EventFieldId } from './AdvancedSearchConfig';
2
2
  import { SelectOption } from './FieldConfig';
3
+ import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
3
4
  /**
4
5
  * Creates a function that acts like a callable + static method container.
5
6
  *
@@ -8,17 +9,45 @@ import { SelectOption } from './FieldConfig';
8
9
  * event.hasAction('CLICKED') // → returns conditional
9
10
  */
10
11
  declare function eventFn(fieldId: EventFieldId, options?: SelectOption[]): {
11
- fieldId: "status" | "trackingId";
12
- options: {
13
- value: string;
14
- label: import("./TranslationConfig").TranslationConfig;
15
- }[] | undefined;
16
- config: {
17
- type: "EXACT";
12
+ range: () => {
13
+ fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
14
+ options: {
15
+ value: string;
16
+ label: import("./TranslationConfig").TranslationConfig;
17
+ }[] | undefined;
18
+ fieldType: "event";
19
+ } & {
20
+ config: {
21
+ type: "range";
22
+ };
23
+ };
24
+ exact: () => {
25
+ fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
26
+ options: {
27
+ value: string;
28
+ label: import("./TranslationConfig").TranslationConfig;
29
+ }[] | undefined;
30
+ fieldType: "event";
31
+ } & {
32
+ config: {
33
+ type: "exact";
34
+ };
35
+ };
36
+ fuzzy: () => {
37
+ fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
38
+ options: {
39
+ value: string;
40
+ label: import("./TranslationConfig").TranslationConfig;
41
+ }[] | undefined;
42
+ fieldType: "event";
43
+ } & {
44
+ config: {
45
+ type: "fuzzy";
46
+ };
18
47
  };
19
- fieldType: "event";
20
48
  };
21
49
  declare const event: typeof eventFn & {
50
+ field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
22
51
  hasAction: (action: import("./ActionType").ActionType) => import("../conditionals/conditionals").JSONSchema;
23
52
  };
24
53
  export { event };
@@ -1,38 +1,52 @@
1
+ import { FieldConditional } from './Conditional';
2
+ import { TranslationConfig } from './TranslationConfig';
1
3
  /**
2
4
  * Entry point for defining conditional logic or configuration for a form field.
3
5
  * @param fieldId - The ID of the field to define rules or config for.
4
6
  * @returns An object combining conditional methods and configuration builders.
5
7
  */
6
- export declare function field(fieldId: string): {
8
+ export declare function field(fieldId: string, options?: {
9
+ conditionals?: FieldConditional[];
10
+ searchCriteriaLabelPrefix?: TranslationConfig;
11
+ }): {
7
12
  range: () => {
8
- config: {
9
- type: "RANGE";
10
- };
13
+ conditionals?: FieldConditional[];
14
+ searchCriteriaLabelPrefix?: TranslationConfig;
11
15
  fieldId: string;
12
16
  fieldType: "field";
13
- };
14
- exact: () => {
17
+ } & {
15
18
  config: {
16
- type: "EXACT";
19
+ type: "range";
17
20
  };
21
+ };
22
+ exact: () => {
23
+ conditionals?: FieldConditional[];
24
+ searchCriteriaLabelPrefix?: TranslationConfig;
18
25
  fieldId: string;
19
26
  fieldType: "field";
20
- };
21
- fuzzy: () => {
27
+ } & {
22
28
  config: {
23
- type: "FUZZY";
29
+ type: "exact";
24
30
  };
31
+ };
32
+ fuzzy: () => {
33
+ conditionals?: FieldConditional[];
34
+ searchCriteriaLabelPrefix?: TranslationConfig;
25
35
  fieldId: string;
26
36
  fieldType: "field";
37
+ } & {
38
+ config: {
39
+ type: "fuzzy";
40
+ };
27
41
  };
42
+ $$field: string;
28
43
  isAfter: () => {
29
44
  days: (days: number) => {
30
45
  inPast: () => import("../conditionals/conditionals").JSONSchema;
31
46
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
32
47
  };
33
48
  date: (date: string | {
34
- [key: string]: unknown;
35
- _fieldId: string;
49
+ $$field: string;
36
50
  }) => import("../conditionals/conditionals").JSONSchema;
37
51
  now: () => import("../conditionals/conditionals").JSONSchema;
38
52
  };
@@ -42,14 +56,12 @@ export declare function field(fieldId: string): {
42
56
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
43
57
  };
44
58
  date: (date: string | {
45
- [key: string]: unknown;
46
- _fieldId: string;
59
+ $$field: string;
47
60
  }) => import("../conditionals/conditionals").JSONSchema;
48
61
  now: () => import("../conditionals/conditionals").JSONSchema;
49
62
  };
50
63
  isEqualTo: (value: string | boolean | {
51
- [key: string]: unknown;
52
- _fieldId: string;
64
+ $$field: string;
53
65
  }) => import("../conditionals/conditionals").JSONSchema;
54
66
  isFalsy: () => import("../conditionals/conditionals").JSONSchema;
55
67
  isUndefined: () => import("../conditionals/conditionals").JSONSchema;
@@ -57,12 +69,5 @@ export declare function field(fieldId: string): {
57
69
  isValidEnglishName: () => import("../conditionals/conditionals").JSONSchema;
58
70
  matches: (pattern: string) => import("../conditionals/conditionals").JSONSchema;
59
71
  isBetween: (min: number, max: number) => import("../conditionals/conditionals").JSONSchema;
60
- getId: () => {
61
- fieldId: string;
62
- };
63
- /**
64
- * @private Internal property used for field reference tracking.
65
- */
66
- _fieldId: string;
67
72
  };
68
73
  //# sourceMappingURL=field.d.ts.map
@@ -1,3 +1,4 @@
1
+ export * from './Constants';
1
2
  export * from './ActionConfig';
2
3
  export * from './offline';
3
4
  export * from './EventConfig';
@@ -6,6 +7,8 @@ export * from './FieldConfig';
6
7
  export * from './PageConfig';
7
8
  export * from './SummaryConfig';
8
9
  export * from './WorkqueueConfig';
10
+ export * from './WorkqueueColumnConfig';
11
+ export * from './workqueueDefaultColumns';
9
12
  export * from './Draft';
10
13
  export * from './EventMetadata';
11
14
  export * from './EventInput';
@@ -31,6 +34,7 @@ export * from './AdvancedSearchConfig';
31
34
  export * from './test.utils';
32
35
  export * from './TemplateConfig';
33
36
  export * from './scopes';
37
+ export * from './serializer';
34
38
  export * from '../conditionals/conditionals';
35
39
  export * from '../conditionals/validate';
36
40
  export * from './field';
@@ -1,6 +1,5 @@
1
1
  import { Scope } from '../scopes';
2
2
  import { ActionType } from './ActionType';
3
- export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
4
3
  export declare const CONFIG_GET_ALLOWED_SCOPES: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records", "config", "config.update:all"];
5
4
  export declare const CONFIG_SEARCH_ALLOWED_SCOPES: ("search.birth:my-jurisdiction" | "search.birth" | "search.death:my-jurisdiction" | "search.death" | "search.marriage:my-jurisdiction" | "search.marriage")[];
6
5
  export declare const ACTION_ALLOWED_SCOPES: {
@@ -12,7 +11,7 @@ export declare const ACTION_ALLOWED_SCOPES: {
12
11
  VALIDATE: ["record.declaration-submit-for-approval", "record.register"];
13
12
  REGISTER: ["record.register"];
14
13
  PRINT_CERTIFICATE: ["record.registration-print&issue-certified-copies"];
15
- REQUEST_CORRECTION: ["record.registration-request-correction"];
14
+ REQUEST_CORRECTION: ["record.registration-request-correction", "record.registration-correct"];
16
15
  REJECT_CORRECTION: ["record.registration-correct"];
17
16
  APPROVE_CORRECTION: ["record.registration-correct"];
18
17
  MARKED_AS_DUPLICATE: ["record.declaration-archive"];
@@ -22,5 +21,25 @@ export declare const ACTION_ALLOWED_SCOPES: {
22
21
  UNASSIGN: null;
23
22
  DETECT_DUPLICATE: [];
24
23
  };
24
+ export declare const ACTION_ALLOWED_CONFIGURABLE_SCOPES: {
25
+ READ: never[];
26
+ CREATE: "record.notify"[];
27
+ NOTIFY: "record.notify"[];
28
+ DECLARE: never[];
29
+ DELETE: never[];
30
+ VALIDATE: never[];
31
+ REGISTER: never[];
32
+ PRINT_CERTIFICATE: never[];
33
+ REQUEST_CORRECTION: never[];
34
+ REJECT_CORRECTION: never[];
35
+ APPROVE_CORRECTION: never[];
36
+ MARKED_AS_DUPLICATE: never[];
37
+ ARCHIVE: never[];
38
+ REJECT: never[];
39
+ ASSIGN: never[];
40
+ UNASSIGN: never[];
41
+ DETECT_DUPLICATE: never[];
42
+ };
43
+ export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
25
44
  export declare function filterUnallowedActions(actions: ActionType[], userScopes: Scope[]): ActionType[];
26
45
  //# sourceMappingURL=scopes.d.ts.map
@@ -0,0 +1,2 @@
1
+ export { deserializeQuery } from './serializers/user/deserializer';
2
+ //# sourceMappingURL=serializer.d.ts.map
@@ -1,4 +1,4 @@
1
- import { ActionDocument, ActionUpdate } from './ActionDocument';
1
+ import { ActionDocument, ActionUpdate, EventState } from './ActionDocument';
2
2
  import { ArchiveActionInput, AssignActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
3
3
  import { ActionType } from './ActionType';
4
4
  import { Draft } from './Draft';
@@ -6,9 +6,9 @@ import { EventConfig } from './EventConfig';
6
6
  import { EventDocument } from './EventDocument';
7
7
  import { EventIndex } from './EventIndex';
8
8
  import { EventInput } from './EventInput';
9
- import { FieldValue } from './FieldValue';
10
9
  import { TranslationConfig } from './TranslationConfig';
11
- export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): Partial<import("./ActionDocument").EventState>;
10
+ import { WorkqueueConfig } from './WorkqueueConfig';
11
+ export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): EventState;
12
12
  export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
13
13
  export declare const eventPayloadGenerator: {
14
14
  create: (input?: Partial<EventInput>) => {
@@ -65,7 +65,7 @@ export declare const eventPayloadGenerator: {
65
65
  option: string;
66
66
  filename: string;
67
67
  originalFilename: string;
68
- }[] | undefined>;
68
+ }[] | [string, string] | undefined>;
69
69
  annotation: {};
70
70
  eventId: string;
71
71
  };
@@ -115,7 +115,7 @@ export declare const eventPayloadGenerator: {
115
115
  option: string;
116
116
  filename: string;
117
117
  originalFilename: string;
118
- }[] | undefined>>;
118
+ }[] | [string, string] | undefined>>;
119
119
  eventId: string;
120
120
  };
121
121
  validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
@@ -158,7 +158,7 @@ export declare const eventPayloadGenerator: {
158
158
  option: string;
159
159
  filename: string;
160
160
  originalFilename: string;
161
- }[] | undefined>;
161
+ }[] | [string, string] | undefined>;
162
162
  annotation: {};
163
163
  duplicates: never[];
164
164
  eventId: string;
@@ -181,11 +181,13 @@ export declare const eventPayloadGenerator: {
181
181
  type: "ARCHIVE";
182
182
  transactionId: string;
183
183
  declaration: {};
184
- annotation: {
185
- isDuplicate: boolean;
186
- };
184
+ annotation: {};
187
185
  duplicates: never[];
188
186
  eventId: string;
187
+ reason: {
188
+ message: string;
189
+ isDuplicate: boolean;
190
+ };
189
191
  };
190
192
  reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
191
193
  type: "REJECT";
@@ -194,6 +196,9 @@ export declare const eventPayloadGenerator: {
194
196
  annotation: {};
195
197
  duplicates: never[];
196
198
  eventId: string;
199
+ reason: {
200
+ message: string;
201
+ };
197
202
  };
198
203
  register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
199
204
  type: "REGISTER";
@@ -235,7 +240,7 @@ export declare const eventPayloadGenerator: {
235
240
  option: string;
236
241
  filename: string;
237
242
  originalFilename: string;
238
- }[] | undefined>;
243
+ }[] | [string, string] | undefined>;
239
244
  annotation: {};
240
245
  eventId: string;
241
246
  };
@@ -287,7 +292,7 @@ export declare const eventPayloadGenerator: {
287
292
  option: string;
288
293
  filename: string;
289
294
  originalFilename: string;
290
- }[] | undefined>;
295
+ }[] | [string, string] | undefined>;
291
296
  annotation: {};
292
297
  eventId: string;
293
298
  };
@@ -319,7 +324,22 @@ export declare function generateEventDocument({ configuration, actions }: {
319
324
  configuration: EventConfig;
320
325
  actions: ActionType[];
321
326
  }): EventDocument;
322
- export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: Record<string, FieldValue>): Draft;
323
- export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => EventIndex;
327
+ export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: EventState): Draft;
328
+ export declare function getRandomDatetime(rng: () => number, start: Date, end: Date): string;
329
+ /**
330
+ * Useful for testing when we need deterministic outcome.
331
+ * @param seed - Seed value for the pseudo-random number generator
332
+ *
333
+ * @returns A function that generates pseudo-random numbers between 0 and 1
334
+ */
335
+ export declare function createPseudoRandomNumberGenerator(seed: number): () => number;
336
+ export declare function generateRandomSignature(rng: () => number): string;
337
+ export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>, seed?: number) => EventIndex;
324
338
  export declare const generateTranslationConfig: (message: string) => TranslationConfig;
339
+ export declare const BearerTokenByUserType: {
340
+ fieldAgent: string;
341
+ registrationAgent: string;
342
+ localRegistrar: string;
343
+ };
344
+ export declare const generateWorkqueues: (slug?: string) => WorkqueueConfig[];
325
345
  //# sourceMappingURL=test.utils.d.ts.map