@opencrvs/toolkit 2.1.0-rc.193cdd8 → 2.1.0-rc.1bb0cb2

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 (118) hide show
  1. package/README.md +1 -0
  2. package/build.sh +5 -1
  3. package/create-countryconfig/index.js +284 -62
  4. package/create-countryconfig/node_modules/.bin/degit +21 -0
  5. package/create-countryconfig/package.json +4 -1
  6. package/dist/application-config/index.js +341 -274
  7. package/dist/cli.js +1423 -104
  8. package/dist/commons/api/router.d.ts +3897 -3263
  9. package/dist/commons/application-config/index.d.ts +6 -6
  10. package/dist/commons/conditionals/conditionals.d.ts +259 -2102
  11. package/dist/commons/conditionals/validate.d.ts +16 -5
  12. package/dist/commons/events/ActionConfig.d.ts +105 -105
  13. package/dist/commons/events/ActionDocument.d.ts +115 -121
  14. package/dist/commons/events/ActionInput.d.ts +4 -4
  15. package/dist/commons/events/ActionStatus.d.ts +14 -0
  16. package/dist/commons/events/ActionType.d.ts +62 -62
  17. package/dist/commons/events/AdvancedSearchConfig.d.ts +531 -507
  18. package/dist/commons/events/AuditLog.d.ts +189 -42
  19. package/dist/commons/events/CompositeFieldValue.d.ts +4 -4
  20. package/dist/commons/events/Conditional.d.ts +3 -3
  21. package/dist/commons/events/CountryConfigQueryInput.d.ts +590 -590
  22. package/dist/commons/events/Draft.d.ts +37 -37
  23. package/dist/commons/events/DynamicFieldValue.d.ts +9 -9
  24. package/dist/commons/events/EventConfig.d.ts +8 -5
  25. package/dist/commons/events/EventDocument.d.ts +516 -48
  26. package/dist/commons/events/EventIndex.d.ts +49 -72
  27. package/dist/commons/events/EventMetadata.d.ts +39 -49
  28. package/dist/commons/events/EventStatus.d.ts +19 -0
  29. package/dist/commons/events/FieldConfig.d.ts +424 -389
  30. package/dist/commons/events/FieldType.d.ts +51 -51
  31. package/dist/commons/events/FieldTypeMapping.d.ts +86 -86
  32. package/dist/commons/events/FieldValue.d.ts +14 -14
  33. package/dist/commons/events/Flag.d.ts +57 -15
  34. package/dist/commons/events/PlainDate.d.ts +8 -0
  35. package/dist/commons/events/SummaryConfig.d.ts +249 -0
  36. package/dist/commons/events/TemplateConfig.d.ts +1 -1
  37. package/dist/commons/events/WorkqueueColumnConfig.d.ts +40 -40
  38. package/dist/commons/events/WorkqueueConfig.d.ts +817 -814
  39. package/dist/commons/events/deduplication.d.ts +1 -1
  40. package/dist/commons/events/event.d.ts +14 -2
  41. package/dist/commons/events/field.d.ts +78 -895
  42. package/dist/commons/events/index.d.ts +1 -0
  43. package/dist/commons/events/locationPayloads.d.ts +95 -0
  44. package/dist/commons/events/locations.d.ts +243 -14
  45. package/dist/commons/events/mocks.test.utils.d.ts +48 -4
  46. package/dist/commons/events/scopes.d.ts +4 -4
  47. package/dist/commons/events/state/index.d.ts +17 -17
  48. package/dist/commons/events/state/utils.d.ts +7 -7
  49. package/dist/commons/events/test.utils.d.ts +47 -43
  50. package/dist/commons/events/utils.d.ts +114 -114
  51. package/dist/commons/notification/UserNotifications.d.ts +38 -23
  52. package/dist/commons/notification/dispatch.d.ts +15 -0
  53. package/dist/commons/notification/index.d.ts +1 -0
  54. package/dist/conditionals/index.js +328 -58
  55. package/dist/csv.d.ts +25 -0
  56. package/dist/csv.d.ts.map +1 -0
  57. package/dist/csv.js +120 -0
  58. package/dist/environment/derived-variables.d.ts +119 -119
  59. package/dist/environment/derived-variables.d.ts.map +1 -1
  60. package/dist/environment/index.d.ts +1 -0
  61. package/dist/environment/index.d.ts.map +1 -1
  62. package/dist/environment/index.js +10 -0
  63. package/dist/environment/logger.d.ts +12 -3
  64. package/dist/environment/logger.d.ts.map +1 -1
  65. package/dist/environment/paths.d.ts +7 -0
  66. package/dist/environment/paths.d.ts.map +1 -0
  67. package/dist/environment/paths.js +72 -0
  68. package/dist/environment/questions.d.ts +75 -74
  69. package/dist/environment/questions.d.ts.map +1 -1
  70. package/dist/environment/questions.js +20 -14
  71. package/dist/environment/setup-environment.js +11 -16
  72. package/dist/environment/templates.d.ts.map +1 -1
  73. package/dist/environment/templates.js +2 -1
  74. package/dist/environment/update-workflows.d.ts.map +1 -1
  75. package/dist/environment/update-workflows.js +17 -5
  76. package/dist/environment/upgrade.d.ts +2 -0
  77. package/dist/environment/upgrade.d.ts.map +1 -0
  78. package/dist/environment/upgrade.js +82 -0
  79. package/dist/environment/users.js +11 -13
  80. package/dist/environment/utils.d.ts +1 -1
  81. package/dist/events/deduplication.d.ts +1 -1
  82. package/dist/events/index.js +3759 -3357
  83. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
  84. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  85. package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
  86. package/dist/migrations/v2.0/migrate-application-config-url.js +4 -3
  87. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
  88. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
  89. package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
  90. package/dist/migrations/v2.1/add-translations.d.ts +9 -0
  91. package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
  92. package/dist/migrations/v2.1/add-translations.js +213 -0
  93. package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
  94. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
  95. package/dist/migrations/v2.1/enable-telemetry.js +438 -0
  96. package/dist/migrations/v2.1/index.d.ts.map +1 -1
  97. package/dist/migrations/v2.1/index.js +1058 -0
  98. package/dist/notification/index.js +1863 -1463
  99. package/dist/scopes/index.d.ts +464 -169
  100. package/dist/scopes/index.js +329 -58
  101. package/dist/telemetry/index.d.ts +45 -0
  102. package/dist/telemetry/index.d.ts.map +1 -0
  103. package/dist/telemetry/index.js +39 -0
  104. package/dist/templates/charts-values/opencrvs-services/values.yaml +4 -3
  105. package/dist/templates/charts-values/opentelemetry/values.yaml +95 -0
  106. package/dist/templates/charts-values/traefik/values.yaml +23 -9
  107. package/dist/templates/inventory/inventory.template.yml +1 -3
  108. package/dist/translations/check.d.ts +23 -0
  109. package/dist/translations/check.d.ts.map +1 -0
  110. package/dist/translations/check.js +128 -0
  111. package/opencrvs-toolkit-2.1.0-rc.1bb0cb2.tgz +0 -0
  112. package/package.json +10 -6
  113. package/tsconfig.build.json +11 -0
  114. package/tsconfig.build.tsbuildinfo +1 -0
  115. package/dist/templates/inventory/production.example.yml +0 -77
  116. package/dist/templates/inventory/qa.example.yml +0 -48
  117. package/opencrvs-toolkit-2.1.0-rc.193cdd8.tgz +0 -0
  118. package/tsconfig.tsbuildinfo +0 -1
@@ -9,7 +9,7 @@ import { EventIndex } from './EventIndex';
9
9
  import { EventInput } from './EventInput';
10
10
  import { TranslationConfig } from './TranslationConfig';
11
11
  import { FieldConfig } from './FieldConfig';
12
- import { Location, AdministrativeArea } from './locations';
12
+ import { LocationVersion, SetLocationPayload, SetAdministrativeAreaPayload } from './locations';
13
13
  import { WorkqueueConfig } from './WorkqueueConfig';
14
14
  import * as z from 'zod/v4';
15
15
  import { DocumentPath } from '../documents';
@@ -23,15 +23,15 @@ export declare const TEST_SYSTEM_IANA_TIMEZONE = "Asia/Dhaka";
23
23
  * These are just for testing purposes to generate realistic mock data.
24
24
  */
25
25
  export declare const TestUserRole: z.ZodEnum<{
26
+ COMMUNITY_LEADER: "COMMUNITY_LEADER";
26
27
  FIELD_AGENT: "FIELD_AGENT";
27
28
  LOCAL_REGISTRAR: "LOCAL_REGISTRAR";
28
29
  LOCAL_SYSTEM_ADMIN: "LOCAL_SYSTEM_ADMIN";
29
30
  NATIONAL_REGISTRAR: "NATIONAL_REGISTRAR";
30
- REGISTRATION_AGENT: "REGISTRATION_AGENT";
31
31
  NATIONAL_SYSTEM_ADMIN: "NATIONAL_SYSTEM_ADMIN";
32
- SOCIAL_WORKER: "SOCIAL_WORKER";
33
- COMMUNITY_LEADER: "COMMUNITY_LEADER";
34
32
  PROVINCIAL_REGISTRAR: "PROVINCIAL_REGISTRAR";
33
+ REGISTRATION_AGENT: "REGISTRATION_AGENT";
34
+ SOCIAL_WORKER: "SOCIAL_WORKER";
35
35
  }>;
36
36
  export type TestUserRole = z.infer<typeof TestUserRole>;
37
37
  export declare function pickRandom<T>(rng: () => number, items: T[]): T;
@@ -43,21 +43,28 @@ export declare function generateUuid(rng?: () => number): UUID;
43
43
  export declare function generateTrackingId(rng: () => number): string;
44
44
  export declare function generateRegistrationNumber(rng: () => number): string;
45
45
  export declare function generateRandomSignature(rng: () => number): DocumentPath;
46
+ /**
47
+ * Builds one element of a location / administrative area `versions` history.
48
+ * Every field is defaulted so a call names only what its assertion is about —
49
+ * an `effectiveFrom`, a `name`, or an explicit `versionId` when the test needs
50
+ * to control version identity.
51
+ */
52
+ export declare function locationVersion(overrides?: Partial<LocationVersion>, rng?: () => number): LocationVersion;
46
53
  export declare function fieldConfigsToActionPayload(fields: FieldConfig[], rng: () => number,
47
54
  /**
48
55
  * Given hierarchy, ensures that related fields (e.g. location and administrative area) have valid values based on the hierarchy.
49
56
  */
50
57
  administrativeHierarchy?: {
51
- administrativeAreas: AdministrativeArea[];
52
- locations: Location[];
58
+ administrativeAreas: SetAdministrativeAreaPayload[];
59
+ locations: SetLocationPayload[];
53
60
  }): ActionUpdate;
54
61
  export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType, rng: () => number, overrides?: ActionUpdate,
55
62
  /**
56
63
  * Given hierarchy, ensures that related fields (e.g. location and administrative area) have valid values based on the hierarchy.
57
64
  */
58
65
  administrativeHierarchy?: {
59
- administrativeAreas: AdministrativeArea[];
60
- locations: Location[];
66
+ administrativeAreas: SetAdministrativeAreaPayload[];
67
+ locations: SetLocationPayload[];
61
68
  }): ActionUpdate;
62
69
  export declare function generateActionDuplicateDeclarationInput(...args: Parameters<typeof generateActionDeclarationInput>): ReturnType<typeof generateActionDeclarationInput>;
63
70
  export declare function eventPayloadGenerator(rng: () => number, configuration?: EventConfig): {
@@ -72,108 +79,105 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
72
79
  };
73
80
  draft: ({ eventId, actionType, annotation, omitFields }: {
74
81
  eventId: UUID;
75
- actionType: Draft["action"]["type"];
82
+ actionType: Draft['action']['type'];
76
83
  annotation?: Record<string, any>;
77
84
  omitFields?: string[];
78
85
  }, input?: Partial<Draft>) => Draft;
79
86
  actions: {
80
- declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
87
+ declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, 'transactionId' | 'declaration' | 'annotation' | 'keepAssignment'>>) => {
88
+ keepAssignment?: boolean | undefined;
89
+ type: "DECLARE";
81
90
  transactionId: string;
82
91
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
83
92
  annotation: {};
84
- keepAssignment?: boolean | undefined;
85
- type: "DECLARE";
86
93
  eventId: string;
87
94
  };
88
95
  /**
89
96
  * Notify allows sending incomplete data. Think it as 'partial declare' for now.
90
97
  */
91
- notify: (eventId: string, input?: Partial<Pick<NotifyActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
98
+ notify: (eventId: string, input?: Partial<Pick<NotifyActionInput, 'transactionId' | 'declaration' | 'keepAssignment'>>) => {
92
99
  type: "NOTIFY";
93
100
  transactionId: string;
94
101
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
95
102
  eventId: string;
96
103
  keepAssignment: boolean | undefined;
97
104
  };
98
- edit: (eventId: string, input?: Partial<Pick<EditActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
105
+ edit: (eventId: string, input?: Partial<Pick<EditActionInput, 'transactionId' | 'declaration' | 'annotation' | 'keepAssignment'>>) => {
106
+ keepAssignment?: boolean | undefined;
107
+ type: "EDIT";
99
108
  transactionId: string;
100
109
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
101
110
  annotation: {};
102
- keepAssignment?: boolean | undefined;
103
- type: "EDIT";
104
111
  eventId: string;
105
112
  };
106
- assign: (eventId: string, input?: Partial<Pick<AssignActionInput, "transactionId" | "assignedTo">>) => {
113
+ assign: (eventId: string, input?: Partial<Pick<AssignActionInput, 'transactionId' | 'assignedTo'>>) => {
107
114
  type: "ASSIGN";
108
115
  transactionId: string;
109
116
  declaration: {};
110
117
  assignedTo: string;
111
118
  eventId: string;
112
119
  };
113
- unassign: (eventId: string, input?: Partial<Pick<UnassignActionInput, "transactionId">>) => {
120
+ unassign: (eventId: string, input?: Partial<Pick<UnassignActionInput, 'transactionId'>>) => {
114
121
  type: "UNASSIGN";
115
122
  transactionId: string;
116
123
  declaration: {};
117
124
  assignedTo: null;
118
125
  eventId: string;
119
126
  };
120
- archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
121
- transactionId: string;
122
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
127
+ archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, 'transactionId' | 'declaration' | 'keepAssignment'>>) => {
123
128
  keepAssignment?: boolean | undefined;
124
129
  type: "ARCHIVE";
130
+ transactionId: string;
131
+ declaration: {};
125
132
  annotation: {};
126
133
  eventId: string;
127
- content: {
128
- reason: string;
129
- };
130
134
  };
131
- unarchive: (eventId: string, input?: Partial<Pick<UnarchiveActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
132
- transactionId: string;
133
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
135
+ unarchive: (eventId: string, input?: Partial<Pick<UnarchiveActionInput, 'transactionId' | 'declaration' | 'keepAssignment'>>) => {
134
136
  keepAssignment?: boolean | undefined;
135
137
  type: "UNARCHIVE";
138
+ transactionId: string;
139
+ declaration: {};
136
140
  annotation: {};
137
141
  eventId: string;
138
142
  };
139
- reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
140
- transactionId: string;
141
- annotation: {};
143
+ reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, 'transactionId' | 'annotation' | 'keepAssignment'>>) => {
142
144
  keepAssignment?: boolean | undefined;
143
145
  type: "REJECT";
146
+ transactionId: string;
144
147
  declaration: {};
148
+ annotation: {};
145
149
  eventId: string;
146
150
  content: {
147
151
  reason: string;
148
152
  };
149
153
  };
150
- register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment" | "registrationNumber">>) => {
154
+ register: (eventId: string, input?: Partial<Pick<RegisterActionInput, 'transactionId' | 'declaration' | 'annotation' | 'keepAssignment' | 'registrationNumber'>>) => {
155
+ keepAssignment?: boolean | undefined;
156
+ registrationNumber?: string | undefined;
157
+ type: "REGISTER";
151
158
  transactionId: string;
152
159
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
153
160
  annotation: {};
154
- registrationNumber?: string | undefined;
155
- keepAssignment?: boolean | undefined;
156
- type: "REGISTER";
157
161
  eventId: string;
158
162
  };
159
- printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
160
- transactionId: string;
161
- annotation: {};
163
+ printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, 'transactionId' | 'annotation' | 'keepAssignment'>>) => {
162
164
  keepAssignment?: boolean | undefined;
163
165
  type: "PRINT_CERTIFICATE";
166
+ transactionId: string;
164
167
  declaration: {};
168
+ annotation: {};
165
169
  eventId: string;
166
170
  };
167
171
  correction: {
168
- request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
172
+ request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, 'transactionId' | 'declaration' | 'annotation' | 'keepAssignment'>>) => {
169
173
  type: "REQUEST_CORRECTION";
170
174
  transactionId: string;
171
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
175
+ declaration: import("lodash").Omit<Record<string, import("./FieldValue").FieldUpdateValue>, "applicant.email" | "applicant.image">;
172
176
  annotation: {};
173
177
  eventId: string;
174
178
  keepAssignment: boolean | undefined;
175
179
  };
176
- approve: (eventId: string, requestId: string, input?: Partial<Pick<ApproveCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
180
+ approve: (eventId: string, requestId: string, input?: Partial<Pick<ApproveCorrectionActionInput, 'transactionId' | 'annotation' | 'keepAssignment'>>) => {
177
181
  type: "APPROVE_CORRECTION";
178
182
  transactionId: string;
179
183
  declaration: {};
@@ -182,7 +186,7 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
182
186
  requestId: string;
183
187
  keepAssignment: boolean | undefined;
184
188
  };
185
- reject: (eventId: string, requestId: string, input: Partial<Pick<RejectCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment" | "content">>) => {
189
+ reject: (eventId: string, requestId: string, input: Partial<Pick<RejectCorrectionActionInput, 'transactionId' | 'annotation' | 'keepAssignment' | 'content'>>) => {
186
190
  type: "REJECT_CORRECTION";
187
191
  transactionId: string;
188
192
  declaration: {};
@@ -196,7 +200,7 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
196
200
  };
197
201
  };
198
202
  duplicate: {
199
- markAsDuplicate: (eventId: string, input?: Partial<Pick<MarkAsDuplicateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
203
+ markAsDuplicate: (eventId: string, input?: Partial<Pick<MarkAsDuplicateActionInput, 'transactionId' | 'declaration' | 'annotation' | 'keepAssignment'>>) => {
200
204
  type: "MARK_AS_DUPLICATE";
201
205
  transactionId: string;
202
206
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
@@ -204,7 +208,7 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
204
208
  eventId: string;
205
209
  keepAssignment: boolean | undefined;
206
210
  };
207
- markNotDuplicate: (eventId: string, input?: Partial<Pick<MarkNotDuplicateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
211
+ markNotDuplicate: (eventId: string, input?: Partial<Pick<MarkNotDuplicateActionInput, 'transactionId' | 'declaration' | 'annotation' | 'keepAssignment'>>) => {
208
212
  type: "MARK_AS_NOT_DUPLICATE";
209
213
  transactionId: string;
210
214
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;