@opencrvs/toolkit 2.0.0-rc.3d5d506 → 2.0.0-rc.3ddb687

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 (121) hide show
  1. package/README.md +15 -0
  2. package/build.sh +5 -4
  3. package/create-countryconfig/index.js +50 -20
  4. package/create-countryconfig/package.json +12 -2
  5. package/dist/application-config/index.js +298 -123
  6. package/dist/cli.js +3219 -4778
  7. package/dist/commons/api/router.d.ts +3954 -211
  8. package/dist/commons/application-config/index.d.ts +1 -0
  9. package/dist/commons/conditionals/conditionals.d.ts +360 -10
  10. package/dist/commons/conditionals/validate.d.ts +52 -2
  11. package/dist/commons/events/ActionConfig.d.ts +230 -2
  12. package/dist/commons/events/ActionDocument.d.ts +50 -0
  13. package/dist/commons/events/ActionInput.d.ts +140 -0
  14. package/dist/commons/events/ActionType.d.ts +6 -1
  15. package/dist/commons/events/AdvancedSearchConfig.d.ts +360 -0
  16. package/dist/commons/events/AuditLog.d.ts +2 -0
  17. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  18. package/dist/commons/events/Draft.d.ts +6 -2
  19. package/dist/commons/events/EventConfig.d.ts +2 -0
  20. package/dist/commons/events/EventDocument.d.ts +25 -0
  21. package/dist/commons/events/EventIndex.d.ts +25 -3
  22. package/dist/commons/events/EventMetadata.d.ts +26 -7
  23. package/dist/commons/events/FieldConfig.d.ts +393 -50
  24. package/dist/commons/events/FieldType.d.ts +1 -0
  25. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  26. package/dist/commons/events/FieldValue.d.ts +6 -0
  27. package/dist/commons/events/WorkqueueConfig.d.ts +194 -152
  28. package/dist/commons/events/field.d.ts +53 -1
  29. package/dist/commons/events/index.d.ts +2 -0
  30. package/dist/commons/events/locations.d.ts +1 -0
  31. package/dist/commons/events/scopes.d.ts +1 -0
  32. package/dist/commons/events/state/flags.d.ts +16 -0
  33. package/dist/commons/events/state/index.d.ts +8 -4
  34. package/dist/commons/events/state/utils.d.ts +21 -289
  35. package/dist/commons/events/test.utils.d.ts +9 -1
  36. package/dist/commons/events/utils.d.ts +28 -3
  37. package/dist/conditionals/index.js +65 -5
  38. package/dist/environment/custom-types.d.ts +33 -0
  39. package/dist/environment/custom-types.d.ts.map +1 -0
  40. package/dist/environment/custom-types.js +12 -0
  41. package/dist/environment/derived-variables.d.ts +134 -0
  42. package/dist/environment/derived-variables.d.ts.map +1 -0
  43. package/dist/environment/derived-variables.js +169 -0
  44. package/dist/environment/editor-questions.d.ts +4 -0
  45. package/dist/environment/editor-questions.d.ts.map +1 -0
  46. package/dist/environment/editor-questions.js +67 -0
  47. package/dist/environment/git.d.ts +5 -0
  48. package/dist/environment/git.d.ts.map +1 -0
  49. package/dist/environment/git.js +38 -0
  50. package/dist/environment/github.d.ts +26 -0
  51. package/dist/environment/github.d.ts.map +1 -0
  52. package/dist/environment/github.js +247 -0
  53. package/dist/environment/index.d.ts +5 -0
  54. package/dist/environment/index.d.ts.map +1 -0
  55. package/dist/environment/index.js +71 -0
  56. package/dist/environment/logger.d.ts +15 -0
  57. package/dist/environment/logger.d.ts.map +1 -0
  58. package/dist/environment/logger.js +25 -0
  59. package/dist/environment/manage-users.d.ts +11 -0
  60. package/dist/environment/manage-users.d.ts.map +1 -0
  61. package/dist/environment/manage-users.js +497 -0
  62. package/dist/environment/questions-helper.d.ts +15 -0
  63. package/dist/environment/questions-helper.d.ts.map +1 -0
  64. package/dist/environment/questions-helper.js +70 -0
  65. package/dist/environment/questions.d.ts +199 -0
  66. package/dist/environment/questions.d.ts.map +1 -0
  67. package/dist/environment/questions.js +412 -0
  68. package/dist/environment/setup-environment.d.ts +2 -0
  69. package/dist/environment/setup-environment.d.ts.map +1 -0
  70. package/dist/environment/setup-environment.js +794 -0
  71. package/dist/environment/ssh-keygen.d.ts +5 -0
  72. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  73. package/dist/environment/ssh-keygen.js +21 -0
  74. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  75. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  76. package/dist/environment/swarm-to-k8s.js +173 -0
  77. package/dist/environment/templates.d.ts +27 -0
  78. package/dist/environment/templates.d.ts.map +1 -0
  79. package/dist/environment/templates.js +163 -0
  80. package/dist/environment/update-workflows.d.ts +2 -0
  81. package/dist/environment/update-workflows.d.ts.map +1 -0
  82. package/dist/environment/update-workflows.js +169 -0
  83. package/dist/environment/users.d.ts +2 -0
  84. package/dist/environment/users.d.ts.map +1 -0
  85. package/dist/environment/users.js +112 -0
  86. package/dist/environment/utils.d.ts +18 -0
  87. package/dist/environment/utils.d.ts.map +1 -0
  88. package/dist/environment/utils.js +100 -0
  89. package/dist/events/index.js +1272 -299
  90. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  91. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  92. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  93. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  94. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  95. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  96. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  97. package/dist/migrations/v2.0/index.js +88 -4963
  98. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  99. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  100. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +3 -0
  101. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +1 -0
  102. package/dist/migrations/v2.1/add-explicit-correction-flags.js +234 -0
  103. package/dist/migrations/v2.1/index.d.ts +6 -0
  104. package/dist/migrations/v2.1/index.d.ts.map +1 -0
  105. package/dist/migrations/v2.1/index.js +218 -0
  106. package/dist/notification/index.js +1038 -163
  107. package/dist/scopes/index.d.ts +100 -8
  108. package/dist/scopes/index.js +22 -7
  109. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  110. package/dist/templates/charts-values/dependencies/values.yaml +83 -0
  111. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  112. package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
  113. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  114. package/dist/templates/charts-values/traefik/values.yaml +115 -0
  115. package/dist/templates/inventory/inventory.template.yml +100 -0
  116. package/dist/templates/inventory/production.example.yml +77 -0
  117. package/dist/templates/inventory/qa.example.yml +48 -0
  118. package/opencrvs-toolkit-2.0.0-rc.3ddb687.tgz +0 -0
  119. package/package.json +20 -2
  120. package/tsconfig.tsbuildinfo +1 -1
  121. package/opencrvs-toolkit-2.0.0-rc.3d5d506.tgz +0 -0
@@ -1,6 +1,31 @@
1
+ import { FormConditionalParameters } from '../conditionals/conditionals';
1
2
  import { FieldConditional } from './Conditional';
2
3
  import { TranslationConfig } from './TranslationConfig';
3
- import { SelectOption, ValidationConfig } from './FieldConfig';
4
+ import { JurisdictionReference } from '../users/userReferences';
5
+ import { ComputedDefaultValue, SelectOption, ValidationConfig } from './FieldConfig';
6
+ /**
7
+ * Creates a {@link ComputedDefaultValue} descriptor for use in a field's `defaultValue`.
8
+ *
9
+ * Unlike `field(id).customClientEvaluation(fn)`, this builder is **not tied to any
10
+ * specific field**. Use it when the initial value should be derived purely from
11
+ * context variables (`$now`, `$online`, system variables such as `$user`) rather
12
+ * than from another field's current value.
13
+ *
14
+ * The serialised function receives `(undefined, context)` at runtime, where
15
+ * `context` is a {@link FormConditionalParameters} object.
16
+ *
17
+ * External references (e.g. lodash) are **not** available inside the function body —
18
+ * all logic must be self-contained so the code survives serialisation.
19
+ *
20
+ * @example
21
+ * // Default a date field to today
22
+ * defaultValue: evaluate((_, ctx) => ctx.$now)
23
+ *
24
+ * @example
25
+ * // Default to the current user's role
26
+ * defaultValue: evaluate((_, ctx) => ctx.user.role)
27
+ */
28
+ export declare function evaluate(computationFn: (fieldValue: undefined, context: FormConditionalParameters) => unknown): ComputedDefaultValue;
4
29
  /**
5
30
  * Entry point for defining conditional logic or configuration for a form field.
6
31
  * @param fieldId - The ID of the field to define rules or config for.
@@ -11,12 +36,14 @@ export declare function field(fieldId: string, options?: {
11
36
  conditionals?: FieldConditional[];
12
37
  validations?: ValidationConfig[];
13
38
  searchCriteriaLabelPrefix?: TranslationConfig;
39
+ allowedLocations?: JurisdictionReference;
14
40
  }): {
15
41
  range: () => {
16
42
  options?: SelectOption[];
17
43
  conditionals?: FieldConditional[];
18
44
  validations?: ValidationConfig[];
19
45
  searchCriteriaLabelPrefix?: TranslationConfig;
46
+ allowedLocations?: JurisdictionReference;
20
47
  fieldId: string;
21
48
  fieldType: "field";
22
49
  } & {
@@ -29,6 +56,7 @@ export declare function field(fieldId: string, options?: {
29
56
  conditionals?: FieldConditional[];
30
57
  validations?: ValidationConfig[];
31
58
  searchCriteriaLabelPrefix?: TranslationConfig;
59
+ allowedLocations?: JurisdictionReference;
32
60
  fieldId: string;
33
61
  fieldType: "field";
34
62
  } & {
@@ -41,6 +69,7 @@ export declare function field(fieldId: string, options?: {
41
69
  conditionals?: FieldConditional[];
42
70
  validations?: ValidationConfig[];
43
71
  searchCriteriaLabelPrefix?: TranslationConfig;
72
+ allowedLocations?: JurisdictionReference;
44
73
  fieldId: string;
45
74
  fieldType: "field";
46
75
  } & {
@@ -53,6 +82,7 @@ export declare function field(fieldId: string, options?: {
53
82
  conditionals?: FieldConditional[];
54
83
  validations?: ValidationConfig[];
55
84
  searchCriteriaLabelPrefix?: TranslationConfig;
85
+ allowedLocations?: JurisdictionReference;
56
86
  fieldId: string;
57
87
  fieldType: "field";
58
88
  } & {
@@ -107,6 +137,8 @@ export declare function field(fieldId: string, options?: {
107
137
  fieldId: string;
108
138
  };
109
139
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
140
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
141
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
110
142
  };
111
143
  asDob(): any;
112
144
  asAge(): any;
@@ -144,6 +176,8 @@ export declare function field(fieldId: string, options?: {
144
176
  fieldId: string;
145
177
  };
146
178
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
179
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
180
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
147
181
  };
148
182
  getByPath(fieldPath: string[]): {
149
183
  $$subfield: string[];
@@ -189,6 +223,8 @@ export declare function field(fieldId: string, options?: {
189
223
  fieldId: string;
190
224
  };
191
225
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
226
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
227
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
192
228
  };
193
229
  getByPath(fieldPath: string[]): any;
194
230
  asDob(): {
@@ -232,6 +268,8 @@ export declare function field(fieldId: string, options?: {
232
268
  fieldId: string;
233
269
  };
234
270
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
271
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
272
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
235
273
  };
236
274
  asAge(): {
237
275
  $$subfield: string[];
@@ -274,6 +312,8 @@ export declare function field(fieldId: string, options?: {
274
312
  fieldId: string;
275
313
  };
276
314
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
315
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
316
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
277
317
  };
278
318
  isAfter(): {
279
319
  days: (days: number) => {
@@ -309,6 +349,8 @@ export declare function field(fieldId: string, options?: {
309
349
  fieldId: string;
310
350
  };
311
351
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
352
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
353
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
312
354
  };
313
355
  asDob(): {
314
356
  $$subfield: string[];
@@ -355,6 +397,8 @@ export declare function field(fieldId: string, options?: {
355
397
  fieldId: string;
356
398
  };
357
399
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
400
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
401
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
358
402
  };
359
403
  asDob(): any;
360
404
  asAge(): any;
@@ -392,6 +436,8 @@ export declare function field(fieldId: string, options?: {
392
436
  fieldId: string;
393
437
  };
394
438
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
439
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
440
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
395
441
  };
396
442
  asAge(): {
397
443
  $$subfield: string[];
@@ -438,6 +484,8 @@ export declare function field(fieldId: string, options?: {
438
484
  fieldId: string;
439
485
  };
440
486
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
487
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
488
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
441
489
  };
442
490
  asDob(): any;
443
491
  asAge(): any;
@@ -475,6 +523,8 @@ export declare function field(fieldId: string, options?: {
475
523
  fieldId: string;
476
524
  };
477
525
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
526
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
527
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
478
528
  };
479
529
  isAfter(): {
480
530
  days: (days: number) => {
@@ -510,5 +560,7 @@ export declare function field(fieldId: string, options?: {
510
560
  fieldId: string;
511
561
  };
512
562
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
563
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
564
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
513
565
  };
514
566
  //# sourceMappingURL=field.d.ts.map
@@ -22,6 +22,7 @@ export * from './FieldValue';
22
22
  export * from './FormConfig';
23
23
  export * from './CompositeFieldValue';
24
24
  export * from './state';
25
+ export * from './state/flags';
25
26
  export * from './utils';
26
27
  export * from './defineConfig';
27
28
  export * from './DeduplicationConfig';
@@ -37,6 +38,7 @@ export * from './scopes';
37
38
  export * from './serializer';
38
39
  export * from './state/availableActions';
39
40
  export * from './FileUtils';
41
+ export * from './mocks.test.utils';
40
42
  export * from '../conditionals/conditionals';
41
43
  export * from '../conditionals/validate';
42
44
  export * from './field';
@@ -40,6 +40,7 @@ type ToArrayFields<T, K extends PropertyKey> = T extends unknown ? T extends obj
40
40
  */
41
41
  export type EventIndexWithAdministrativeHierarchy = Omit<ToArrayFields<EventIndex, 'createdAtLocation' | 'updatedAtLocation' | 'placeOfEvent'>, 'legalStatuses'> & {
42
42
  legalStatuses: {
43
+ NOTIFIED: ToArrayFields<ActionCreationMetadata, 'createdAtLocation'> | undefined;
43
44
  DECLARED: ToArrayFields<ActionCreationMetadata, 'createdAtLocation'> | undefined;
44
45
  REGISTERED: ToArrayFields<RegistrationCreationMetadata, 'createdAtLocation'> | undefined;
45
46
  };
@@ -20,6 +20,7 @@ export declare const ACTION_SCOPE_MAP: {
20
20
  MARK_AS_DUPLICATE: "record.review-duplicates"[];
21
21
  MARK_AS_NOT_DUPLICATE: "record.review-duplicates"[];
22
22
  ARCHIVE: "record.archive"[];
23
+ UNARCHIVE: "record.unarchive"[];
23
24
  REJECT: "record.reject"[];
24
25
  ASSIGN: null;
25
26
  UNASSIGN: null;
@@ -1,6 +1,9 @@
1
+ import { Action, RequestedCorrectionAction } from '../ActionDocument';
1
2
  import { Flag, CustomFlag } from '../Flag';
2
3
  import { EventConfig } from '../EventConfig';
3
4
  import { EventDocument } from '../EventDocument';
5
+ export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
6
+ export declare function isPotentialDuplicate(actions: Action[]): boolean;
4
7
  /**
5
8
  * This function resolves custom flags for an event based on its actions.
6
9
  * Flags are not stored to the event state or any database directly, instead they are always computed/evaluated from the event actions.
@@ -18,5 +21,18 @@ import { EventDocument } from '../EventDocument';
18
21
  * // Returns: ['flag-1', 'flag-3']
19
22
  */
20
23
  export declare function resolveEventCustomFlags(event: EventDocument, eventConfiguration: EventConfig): CustomFlag[];
24
+ /**
25
+ * Computes all flags (inherent, action status, and custom) that should be attached to the given event,
26
+ * based on its actions and event-specific configuration.
27
+ *
28
+ * Flags are determined by combining:
29
+ * - Action status flags (format 'ActionType:ActionStatus')
30
+ * - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
31
+ * - Event type-specific custom flags defined in the event configuration
32
+ *
33
+ * @param event - The EventDocument containing the action history and payload
34
+ * @param config - The EventConfig providing rules for custom flag evaluation
35
+ * @returns An array of flags currently relevant/applicable to the event
36
+ */
21
37
  export declare function getEventFlags(event: EventDocument, config: EventConfig): Flag[];
22
38
  //# sourceMappingURL=flags.d.ts.map
@@ -9,7 +9,6 @@ import { UUID } from '../../uuid';
9
9
  import { DocumentPath } from '../../documents';
10
10
  export declare function getStatusFromActions(actions: Array<Action>): "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
11
11
  export declare function getAssignedUserFromActions(actions: Array<ActionDocument>): string | null;
12
- export declare function getAssignedUserSignatureFromActions(actions: Array<ActionDocument>): string | null;
13
12
  type NonNullableDeep<T> = T extends [unknown, ...unknown[]] ? {
14
13
  [K in keyof T]: NonNullableDeep<NonNullable<T[K]>>;
15
14
  } : T extends UUID ? T : T extends DocumentPath ? T : T extends string ? NonNullable<T> : T extends (infer U)[] ? NonNullableDeep<U>[] : T extends object ? {
@@ -66,6 +65,14 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
66
65
  type: string;
67
66
  status: "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
68
67
  legalStatuses: {
68
+ NOTIFIED?: {
69
+ createdAt: string;
70
+ createdBy: string;
71
+ acceptedAt: string;
72
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
73
+ createdByUserType?: "user" | "system" | null | undefined;
74
+ createdByRole?: string | undefined;
75
+ } | null | undefined;
69
76
  DECLARED?: {
70
77
  createdAt: string;
71
78
  createdBy: string;
@@ -73,7 +80,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
73
80
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
74
81
  createdByUserType?: "user" | "system" | null | undefined;
75
82
  createdByRole?: string | undefined;
76
- createdBySignature?: string | null | undefined;
77
83
  } | null | undefined;
78
84
  REGISTERED?: {
79
85
  createdAt: string;
@@ -83,7 +89,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
83
89
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
84
90
  createdByUserType?: "user" | "system" | null | undefined;
85
91
  createdByRole?: string | undefined;
86
- createdBySignature?: string | null | undefined;
87
92
  } | null | undefined;
88
93
  };
89
94
  createdAt: string;
@@ -101,7 +106,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
101
106
  createdByUserType?: "user" | "system" | null | undefined;
102
107
  updatedByUserRole?: string | null | undefined;
103
108
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
104
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
105
109
  updatedAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
106
110
  assignedTo?: string | null | undefined;
107
111
  updatedBy?: string | null | undefined;
@@ -1,279 +1,17 @@
1
1
  import { Action } from '../ActionDocument';
2
2
  /**
3
- * Given action type and actions, returns the action creation metadata for the event.
4
- * Since we do not consistently store the request action, we need to check if it exists.
5
- * @returns details of last user who triggered **Declaration** action.
6
- * @see EventIndex for the description of the returned object.
3
+ * Returns the creation metadata of the last update action (Requested or Accepted).
4
+ * Requested actions are included so that async flows (202) correctly reflect the
5
+ * metadata of the user who triggered the action before country config accepts it.
7
6
  *
8
- * */
9
- export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
10
- id: string & import("zod").$brand<"UUID">;
11
- transactionId: string;
12
- createdByUserType: "user" | "system";
13
- createdAt: string;
14
- createdBy: string;
15
- declaration: Record<string, import("..").FieldUpdateValue>;
16
- status: "Requested" | "Accepted" | "Rejected";
17
- type: "REGISTER";
18
- createdByRole?: string | undefined;
19
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
20
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
21
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
22
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
23
- registrationNumber?: string | undefined;
24
- } | {
25
- id: string & import("zod").$brand<"UUID">;
26
- transactionId: string;
27
- createdByUserType: "user" | "system";
28
- createdAt: string;
29
- createdBy: string;
30
- declaration: Record<string, import("..").FieldUpdateValue>;
31
- status: "Requested" | "Accepted" | "Rejected";
32
- type: "DUPLICATE_DETECTED";
33
- content: {
34
- duplicates: {
35
- id: string & import("zod").$brand<"UUID">;
36
- trackingId: string;
37
- }[];
38
- };
39
- createdByRole?: string | undefined;
40
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
41
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
42
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
43
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
44
- } | {
45
- id: string & import("zod").$brand<"UUID">;
46
- transactionId: string;
47
- createdByUserType: "user" | "system";
48
- createdAt: string;
49
- createdBy: string;
50
- declaration: Record<string, import("..").FieldUpdateValue>;
51
- status: "Requested" | "Accepted" | "Rejected";
52
- type: "EDIT";
53
- content: {
54
- comment?: string | undefined;
55
- };
56
- createdByRole?: string | undefined;
57
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
58
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
59
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
60
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
61
- } | {
62
- id: string & import("zod").$brand<"UUID">;
63
- transactionId: string;
64
- createdByUserType: "user" | "system";
65
- createdAt: string;
66
- createdBy: string;
67
- declaration: Record<string, import("..").FieldUpdateValue>;
68
- status: "Requested" | "Accepted" | "Rejected";
69
- type: "PRINT_CERTIFICATE";
70
- createdByRole?: string | undefined;
71
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
72
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
73
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
74
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
75
- content?: {
76
- templateId?: string | undefined;
77
- } | null | undefined;
78
- } | {
79
- id: string & import("zod").$brand<"UUID">;
80
- transactionId: string;
81
- createdByUserType: "user" | "system";
82
- createdAt: string;
83
- createdBy: string;
84
- declaration: Record<string, import("..").FieldUpdateValue>;
85
- status: "Requested" | "Accepted" | "Rejected";
86
- type: "REQUEST_CORRECTION";
87
- createdByRole?: string | undefined;
88
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
89
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
90
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
91
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
92
- } | {
93
- id: string & import("zod").$brand<"UUID">;
94
- transactionId: string;
95
- createdByUserType: "user" | "system";
96
- createdAt: string;
97
- createdBy: string;
98
- declaration: Record<string, import("..").FieldUpdateValue>;
99
- status: "Requested" | "Accepted" | "Rejected";
100
- type: "CUSTOM";
101
- customActionType: string;
102
- createdByRole?: string | undefined;
103
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
104
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
105
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
106
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
107
- } | {
108
- id: string & import("zod").$brand<"UUID">;
109
- transactionId: string;
110
- createdByUserType: "user" | "system";
111
- createdAt: string;
112
- createdBy: string;
113
- declaration: Record<string, import("..").FieldUpdateValue>;
114
- status: "Requested" | "Accepted" | "Rejected";
115
- type: "CREATE";
116
- createdByRole?: string | undefined;
117
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
118
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
119
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
120
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
121
- } | {
122
- id: string & import("zod").$brand<"UUID">;
123
- transactionId: string;
124
- createdByUserType: "user" | "system";
125
- createdAt: string;
126
- createdBy: string;
127
- declaration: Record<string, import("..").FieldUpdateValue>;
128
- status: "Requested" | "Accepted" | "Rejected";
129
- type: "REJECT";
130
- content: {
131
- reason: string;
132
- };
133
- createdByRole?: string | undefined;
134
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
135
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
136
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
137
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
138
- } | {
139
- id: string & import("zod").$brand<"UUID">;
140
- transactionId: string;
141
- createdByUserType: "user" | "system";
142
- createdAt: string;
143
- createdBy: string;
144
- declaration: Record<string, import("..").FieldUpdateValue>;
145
- status: "Requested" | "Accepted" | "Rejected";
146
- type: "MARK_AS_NOT_DUPLICATE";
147
- createdByRole?: string | undefined;
148
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
149
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
150
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
151
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
152
- } | {
153
- id: string & import("zod").$brand<"UUID">;
154
- transactionId: string;
155
- createdByUserType: "user" | "system";
156
- createdAt: string;
157
- createdBy: string;
158
- declaration: Record<string, import("..").FieldUpdateValue>;
159
- status: "Requested" | "Accepted" | "Rejected";
160
- type: "MARK_AS_DUPLICATE";
161
- createdByRole?: string | undefined;
162
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
163
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
164
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
165
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
166
- content?: {
167
- duplicateOf: string & import("zod").$brand<"UUID">;
168
- } | undefined;
169
- } | {
170
- id: string & import("zod").$brand<"UUID">;
171
- transactionId: string;
172
- createdByUserType: "user" | "system";
173
- createdAt: string;
174
- createdBy: string;
175
- declaration: Record<string, import("..").FieldUpdateValue>;
176
- status: "Requested" | "Accepted" | "Rejected";
177
- type: "ARCHIVE";
178
- content: {
179
- reason: string;
180
- };
181
- createdByRole?: string | undefined;
182
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
183
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
184
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
185
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
186
- } | {
187
- id: string & import("zod").$brand<"UUID">;
188
- transactionId: string;
189
- createdByUserType: "user" | "system";
190
- createdAt: string;
191
- createdBy: string;
192
- declaration: Record<string, import("..").FieldUpdateValue>;
193
- status: "Requested" | "Accepted" | "Rejected";
194
- type: "NOTIFY";
195
- createdByRole?: string | undefined;
196
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
197
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
198
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
199
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
200
- } | {
201
- id: string & import("zod").$brand<"UUID">;
202
- transactionId: string;
203
- createdByUserType: "user" | "system";
204
- createdAt: string;
205
- createdBy: string;
206
- declaration: Record<string, import("..").FieldUpdateValue>;
207
- status: "Requested" | "Accepted" | "Rejected";
208
- type: "DECLARE";
209
- createdByRole?: string | undefined;
210
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
211
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
212
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
213
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
214
- } | {
215
- id: string & import("zod").$brand<"UUID">;
216
- transactionId: string;
217
- createdByUserType: "user" | "system";
218
- createdAt: string;
219
- createdBy: string;
220
- declaration: Record<string, import("..").FieldUpdateValue>;
221
- status: "Requested" | "Accepted" | "Rejected";
222
- type: "ASSIGN";
223
- assignedTo: string;
224
- createdByRole?: string | undefined;
225
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
226
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
227
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
228
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
229
- } | {
230
- id: string & import("zod").$brand<"UUID">;
231
- transactionId: string;
232
- createdByUserType: "user" | "system";
233
- createdAt: string;
234
- createdBy: string;
235
- declaration: Record<string, import("..").FieldUpdateValue>;
236
- status: "Requested" | "Accepted" | "Rejected";
237
- type: "APPROVE_CORRECTION";
238
- requestId: string;
239
- createdByRole?: string | undefined;
240
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
241
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
242
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
243
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
244
- } | {
245
- id: string & import("zod").$brand<"UUID">;
246
- transactionId: string;
247
- createdByUserType: "user" | "system";
248
- createdAt: string;
249
- createdBy: string;
250
- declaration: Record<string, import("..").FieldUpdateValue>;
251
- status: "Requested" | "Accepted" | "Rejected";
252
- type: "REJECT_CORRECTION";
253
- requestId: string;
254
- content: {
255
- reason: string;
256
- };
257
- createdByRole?: string | undefined;
258
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
259
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
260
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
261
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
262
- } | {
263
- id: string & import("zod").$brand<"UUID">;
264
- transactionId: string;
265
- createdByUserType: "user" | "system";
266
- createdAt: string;
267
- createdBy: string;
268
- declaration: Record<string, import("..").FieldUpdateValue>;
269
- status: "Requested" | "Accepted" | "Rejected";
270
- type: "UNASSIGN";
271
- createdByRole?: string | undefined;
272
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
273
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
274
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
275
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
276
- } | {
7
+ * When an Accepted action carries an originalActionId, its metadata is sourced from
8
+ * the original Requested action (the human who triggered it), not from the system
9
+ * or 3rd party that accepted it.
10
+ *
11
+ * @returns metadata of the last user who triggered a status-changing action.
12
+ * @see EventIndex for the description of the returned object.
13
+ */
14
+ export declare function getActionUpdateMetadata(actions: Action[]): Pick<{
277
15
  id: string & import("zod").$brand<"UUID">;
278
16
  transactionId: string;
279
17
  createdByUserType: "user" | "system";
@@ -281,30 +19,26 @@ export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
281
19
  createdBy: string;
282
20
  declaration: Record<string, import("..").FieldUpdateValue>;
283
21
  status: "Requested" | "Accepted" | "Rejected";
284
- type: "READ";
285
22
  createdByRole?: string | undefined;
286
23
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
287
24
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
288
25
  annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
289
26
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
290
- } | {
291
- id: string & import("zod").$brand<"UUID">;
292
- transactionId: string;
293
- createdByUserType: "user" | "system";
294
- createdAt: string;
295
- createdBy: string;
296
- type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
297
- status: "Rejected";
298
- createdByRole?: string | undefined;
299
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
300
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
301
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
302
- }>;
27
+ }, "createdByUserType" | "createdAt" | "createdBy" | "createdByRole" | "createdAtLocation">;
303
28
  /**
304
29
  * @returns the legal statuses of the event. Event is considered legal if it has been accepted.
305
30
  * @see EventIndex for the description of the returned object.
306
31
  */
307
32
  export declare function getLegalStatuses(actions: Action[]): {
33
+ NOTIFIED: {
34
+ createdAt: string;
35
+ createdBy: string;
36
+ createdByUserType: "user" | "system";
37
+ createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
38
+ acceptedAt: string;
39
+ createdByRole: string | undefined;
40
+ registrationNumber: string | null | undefined;
41
+ } | null;
308
42
  DECLARED: {
309
43
  createdAt: string;
310
44
  createdBy: string;
@@ -312,7 +46,6 @@ export declare function getLegalStatuses(actions: Action[]): {
312
46
  createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
313
47
  acceptedAt: string;
314
48
  createdByRole: string | undefined;
315
- createdBySignature: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
316
49
  registrationNumber: string | null | undefined;
317
50
  } | null;
318
51
  REGISTERED: {
@@ -322,7 +55,6 @@ export declare function getLegalStatuses(actions: Action[]): {
322
55
  createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
323
56
  acceptedAt: string;
324
57
  createdByRole: string | undefined;
325
- createdBySignature: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
326
58
  registrationNumber: string | null | undefined;
327
59
  } | null;
328
60
  };
@@ -1,6 +1,6 @@
1
1
  import { UUID } from '../uuid';
2
2
  import { ActionDocument, ActionUpdate } from './ActionDocument';
3
- import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, EditActionInput, MarkAsDuplicateActionInput, MarkNotDuplicateActionInput, NotifyActionInput, RegisterActionInput, RejectCorrectionActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput } from './ActionInput';
3
+ import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, EditActionInput, MarkAsDuplicateActionInput, MarkNotDuplicateActionInput, NotifyActionInput, RegisterActionInput, RejectCorrectionActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnarchiveActionInput, UnassignActionInput } from './ActionInput';
4
4
  import { ActionType } from './ActionType';
5
5
  import { Draft } from './Draft';
6
6
  import { EventConfig } from './EventConfig';
@@ -131,6 +131,14 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
131
131
  reason: string;
132
132
  };
133
133
  };
134
+ unarchive: (eventId: string, input?: Partial<Pick<UnarchiveActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
135
+ transactionId: string;
136
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
137
+ keepAssignment?: boolean | undefined;
138
+ type: "UNARCHIVE";
139
+ annotation: {};
140
+ eventId: string;
141
+ };
134
142
  reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
135
143
  transactionId: string;
136
144
  annotation: {};