@opencrvs/toolkit 1.9.3-rc.c5b6285 → 1.9.3-rc.da977ad

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 (58) hide show
  1. package/dist/commons/api/router.d.ts +28089 -2317
  2. package/dist/commons/conditionals/conditionals.d.ts +10 -1
  3. package/dist/commons/conditionals/validate.d.ts +11 -4
  4. package/dist/commons/events/ActionConfig.d.ts +23121 -1547
  5. package/dist/commons/events/ActionDocument.d.ts +840 -1849
  6. package/dist/commons/events/ActionInput.d.ts +290 -1066
  7. package/dist/commons/events/ActionType.d.ts +91 -8
  8. package/dist/commons/events/AdvancedSearchConfig.d.ts +222 -1238
  9. package/dist/commons/events/CompositeFieldValue.d.ts +25 -176
  10. package/dist/commons/events/Conditional.d.ts +26 -38
  11. package/dist/commons/events/Constants.d.ts +1 -1
  12. package/dist/commons/events/CountryConfigQueryInput.d.ts +931 -4169
  13. package/dist/commons/events/CreatedAtLocation.d.ts +1 -1
  14. package/dist/commons/events/DeduplicationConfig.d.ts +15 -150
  15. package/dist/commons/events/Draft.d.ts +72 -105
  16. package/dist/commons/events/DynamicFieldValue.d.ts +7 -91
  17. package/dist/commons/events/EventConfig.d.ts +18321 -2120
  18. package/dist/commons/events/EventConfigInput.d.ts +1 -1
  19. package/dist/commons/events/EventDocument.d.ts +336 -1326
  20. package/dist/commons/events/EventIndex.d.ts +197 -967
  21. package/dist/commons/events/EventInput.d.ts +2 -8
  22. package/dist/commons/events/EventMetadata.d.ts +106 -346
  23. package/dist/commons/events/FieldConfig.d.ts +4173 -11778
  24. package/dist/commons/events/FieldType.d.ts +9 -4
  25. package/dist/commons/events/FieldTypeMapping.d.ts +172 -811
  26. package/dist/commons/events/FieldValue.d.ts +82 -355
  27. package/dist/commons/events/Flag.d.ts +70 -0
  28. package/dist/commons/events/FormConfig.d.ts +12876 -721
  29. package/dist/commons/events/PageConfig.d.ts +8604 -319
  30. package/dist/commons/events/SummaryConfig.d.ts +14 -161
  31. package/dist/commons/events/TemplateConfig.d.ts +3 -3
  32. package/dist/commons/events/TranslationConfig.d.ts +2 -2
  33. package/dist/commons/events/WorkqueueColumnConfig.d.ts +74 -37
  34. package/dist/commons/events/WorkqueueConfig.d.ts +1695 -7156
  35. package/dist/commons/events/deduplication.d.ts +3 -3
  36. package/dist/commons/events/defineConfig.d.ts +25160 -152
  37. package/dist/commons/events/event.d.ts +4 -4
  38. package/dist/commons/events/index.d.ts +1 -0
  39. package/dist/commons/events/locations.d.ts +15 -19
  40. package/dist/commons/events/scopes.d.ts +3 -1
  41. package/dist/commons/events/state/availableActions.d.ts +2 -1
  42. package/dist/commons/events/state/flags.d.ts +21 -3
  43. package/dist/commons/events/state/index.d.ts +23 -19
  44. package/dist/commons/events/state/utils.d.ts +142 -110
  45. package/dist/commons/events/test.utils.d.ts +23 -6
  46. package/dist/commons/events/transactions.d.ts +1 -1
  47. package/dist/commons/events/utils.d.ts +50372 -361
  48. package/dist/commons/notification/UserNotifications.d.ts +55 -636
  49. package/dist/conditionals/index.d.ts.map +1 -1
  50. package/dist/conditionals/index.js +38 -5
  51. package/dist/events/deduplication.d.ts +3 -3
  52. package/dist/events/index.js +1813 -1709
  53. package/dist/notification/index.d.ts.map +1 -1
  54. package/dist/notification/index.js +1462 -1602
  55. package/dist/scopes/index.d.ts +138 -138
  56. package/dist/scopes/index.d.ts.map +1 -1
  57. package/dist/scopes/index.js +123 -93
  58. package/package.json +5 -5
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
+ var __create = Object.create;
2
3
  var __defProp = Object.defineProperty;
3
4
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
5
  var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
5
7
  var __hasOwnProp = Object.prototype.hasOwnProperty;
6
8
  var __export = (target, all) => {
7
9
  for (var name in all)
@@ -15,12 +17,22 @@ var __copyProps = (to, from, except, desc) => {
15
17
  }
16
18
  return to;
17
19
  };
20
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
+ // If the importer is in node compatibility mode or this is not an ESM
22
+ // file that has been converted to a CommonJS file using a Babel-
23
+ // compatible transform (i.e. "__esModule" has not been set), then set
24
+ // "default" to the CommonJS "module.exports" for node compatibility.
25
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
+ mod
27
+ ));
18
28
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
29
 
20
30
  // src/scopes/index.ts
21
31
  var scopes_exports = {};
22
32
  __export(scopes_exports, {
23
33
  ActionScopes: () => ActionScopes,
34
+ ConfigurableActionScopes: () => ConfigurableActionScopes,
35
+ CustomActionScope: () => CustomActionScope,
24
36
  RecordScope: () => RecordScope,
25
37
  RecordScopeType: () => RecordScopeType,
26
38
  SCOPES: () => SCOPES,
@@ -33,9 +45,10 @@ __export(scopes_exports, {
33
45
  stringifyScope: () => stringifyScope
34
46
  });
35
47
  module.exports = __toCommonJS(scopes_exports);
48
+ var z2 = __toESM(require("zod/v4"));
36
49
 
37
50
  // ../commons/src/scopes.ts
38
- var import_zod = require("zod");
51
+ var z = __toESM(require("zod/v4"));
39
52
  var SCOPES = {
40
53
  // TODO v1.8 legacy scopes
41
54
  BYPASSRATELIMIT: "bypassratelimit",
@@ -114,91 +127,91 @@ var SCOPES = {
114
127
  // data seeding
115
128
  USER_DATA_SEEDING: "user.data-seeding"
116
129
  };
117
- var LegacyScopes = import_zod.z.union([
118
- import_zod.z.literal(SCOPES.BYPASSRATELIMIT),
119
- import_zod.z.literal(SCOPES.REGISTER),
120
- import_zod.z.literal(SCOPES.DEMO),
121
- import_zod.z.literal(SCOPES.CONFIG)
130
+ var LegacyScopes = z.union([
131
+ z.literal(SCOPES.BYPASSRATELIMIT),
132
+ z.literal(SCOPES.REGISTER),
133
+ z.literal(SCOPES.DEMO),
134
+ z.literal(SCOPES.CONFIG)
122
135
  ]);
123
- var IntegrationScopes = import_zod.z.union([
124
- import_zod.z.literal(SCOPES.WEBHOOK),
125
- import_zod.z.literal(SCOPES.NATIONALID),
126
- import_zod.z.literal(SCOPES.NOTIFICATION_API),
127
- import_zod.z.literal(SCOPES.RECORDSEARCH)
136
+ var IntegrationScopes = z.union([
137
+ z.literal(SCOPES.WEBHOOK),
138
+ z.literal(SCOPES.NATIONALID),
139
+ z.literal(SCOPES.NOTIFICATION_API),
140
+ z.literal(SCOPES.RECORDSEARCH)
128
141
  ]);
129
- var InternalOperationsScopes = import_zod.z.union([
130
- import_zod.z.literal(SCOPES.RECORD_REINDEX),
131
- import_zod.z.literal(SCOPES.RECORD_IMPORT)
142
+ var InternalOperationsScopes = z.union([
143
+ z.literal(SCOPES.RECORD_REINDEX),
144
+ z.literal(SCOPES.RECORD_IMPORT)
132
145
  ]);
133
- var DeclareScopes = import_zod.z.union([
134
- import_zod.z.literal(SCOPES.RECORD_DECLARE_BIRTH),
135
- import_zod.z.literal(SCOPES.RECORD_DECLARE_BIRTH_MY_JURISDICTION),
136
- import_zod.z.literal(SCOPES.RECORD_DECLARE_DEATH),
137
- import_zod.z.literal(SCOPES.RECORD_DECLARE_DEATH_MY_JURISDICTION),
138
- import_zod.z.literal(SCOPES.RECORD_DECLARE_MARRIAGE),
139
- import_zod.z.literal(SCOPES.RECORD_DECLARE_MARRIAGE_MY_JURISDICTION),
140
- import_zod.z.literal(SCOPES.RECORD_SUBMIT_INCOMPLETE),
141
- import_zod.z.literal(SCOPES.RECORD_SUBMIT_FOR_REVIEW)
146
+ var DeclareScopes = z.union([
147
+ z.literal(SCOPES.RECORD_DECLARE_BIRTH),
148
+ z.literal(SCOPES.RECORD_DECLARE_BIRTH_MY_JURISDICTION),
149
+ z.literal(SCOPES.RECORD_DECLARE_DEATH),
150
+ z.literal(SCOPES.RECORD_DECLARE_DEATH_MY_JURISDICTION),
151
+ z.literal(SCOPES.RECORD_DECLARE_MARRIAGE),
152
+ z.literal(SCOPES.RECORD_DECLARE_MARRIAGE_MY_JURISDICTION),
153
+ z.literal(SCOPES.RECORD_SUBMIT_INCOMPLETE),
154
+ z.literal(SCOPES.RECORD_SUBMIT_FOR_REVIEW)
142
155
  ]);
143
- var UnassignScope = import_zod.z.literal(SCOPES.RECORD_UNASSIGN_OTHERS);
144
- var ValidateScopes = import_zod.z.union([
145
- import_zod.z.literal(SCOPES.RECORD_SUBMIT_FOR_APPROVAL),
146
- import_zod.z.literal(SCOPES.RECORD_SUBMIT_FOR_UPDATES),
147
- import_zod.z.literal(SCOPES.RECORD_DECLARATION_EDIT),
148
- import_zod.z.literal(SCOPES.RECORD_REVIEW_DUPLICATES),
149
- import_zod.z.literal(SCOPES.RECORD_DECLARATION_ARCHIVE),
150
- import_zod.z.literal(SCOPES.RECORD_DECLARATION_REINSTATE)
156
+ var UnassignScope = z.literal(SCOPES.RECORD_UNASSIGN_OTHERS);
157
+ var ValidateScopes = z.union([
158
+ z.literal(SCOPES.RECORD_SUBMIT_FOR_APPROVAL),
159
+ z.literal(SCOPES.RECORD_SUBMIT_FOR_UPDATES),
160
+ z.literal(SCOPES.RECORD_DECLARATION_EDIT),
161
+ z.literal(SCOPES.RECORD_REVIEW_DUPLICATES),
162
+ z.literal(SCOPES.RECORD_DECLARATION_ARCHIVE),
163
+ z.literal(SCOPES.RECORD_DECLARATION_REINSTATE)
151
164
  ]);
152
- var RegisterScope = import_zod.z.literal(SCOPES.RECORD_REGISTER);
153
- var CorrectionScopes = import_zod.z.union([
154
- import_zod.z.literal(SCOPES.RECORD_REGISTRATION_REQUEST_CORRECTION),
155
- import_zod.z.literal(SCOPES.RECORD_REGISTRATION_CORRECT),
156
- import_zod.z.literal(SCOPES.RECORD_CONFIRM_REGISTRATION),
157
- import_zod.z.literal(SCOPES.RECORD_REJECT_REGISTRATION)
165
+ var RegisterScope = z.literal(SCOPES.RECORD_REGISTER);
166
+ var CorrectionScopes = z.union([
167
+ z.literal(SCOPES.RECORD_REGISTRATION_REQUEST_CORRECTION),
168
+ z.literal(SCOPES.RECORD_REGISTRATION_CORRECT),
169
+ z.literal(SCOPES.RECORD_CONFIRM_REGISTRATION),
170
+ z.literal(SCOPES.RECORD_REJECT_REGISTRATION)
158
171
  ]);
159
- var SearchScopes = import_zod.z.union([
160
- import_zod.z.literal(SCOPES.SEARCH_BIRTH_MY_JURISDICTION),
161
- import_zod.z.literal(SCOPES.SEARCH_BIRTH),
162
- import_zod.z.literal(SCOPES.SEARCH_DEATH_MY_JURISDICTION),
163
- import_zod.z.literal(SCOPES.SEARCH_DEATH),
164
- import_zod.z.literal(SCOPES.SEARCH_MARRIAGE_MY_JURISDICTION),
165
- import_zod.z.literal(SCOPES.SEARCH_MARRIAGE)
172
+ var SearchScopes = z.union([
173
+ z.literal(SCOPES.SEARCH_BIRTH_MY_JURISDICTION),
174
+ z.literal(SCOPES.SEARCH_BIRTH),
175
+ z.literal(SCOPES.SEARCH_DEATH_MY_JURISDICTION),
176
+ z.literal(SCOPES.SEARCH_DEATH),
177
+ z.literal(SCOPES.SEARCH_MARRIAGE_MY_JURISDICTION),
178
+ z.literal(SCOPES.SEARCH_MARRIAGE)
166
179
  ]);
167
- var AuditScopes = import_zod.z.literal(SCOPES.RECORD_READ);
168
- var PerformanceScopes = import_zod.z.union([
169
- import_zod.z.literal(SCOPES.PERFORMANCE_READ),
170
- import_zod.z.literal(SCOPES.PERFORMANCE_READ_DASHBOARDS),
171
- import_zod.z.literal(SCOPES.PERFORMANCE_EXPORT_VITAL_STATISTICS)
180
+ var AuditScopes = z.literal(SCOPES.RECORD_READ);
181
+ var PerformanceScopes = z.union([
182
+ z.literal(SCOPES.PERFORMANCE_READ),
183
+ z.literal(SCOPES.PERFORMANCE_READ_DASHBOARDS),
184
+ z.literal(SCOPES.PERFORMANCE_EXPORT_VITAL_STATISTICS)
172
185
  ]);
173
- var OrganisationScopes = import_zod.z.union([
174
- import_zod.z.literal(SCOPES.ORGANISATION_READ_LOCATIONS),
175
- import_zod.z.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_OFFICE),
176
- import_zod.z.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_JURISDICTION)
186
+ var OrganisationScopes = z.union([
187
+ z.literal(SCOPES.ORGANISATION_READ_LOCATIONS),
188
+ z.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_OFFICE),
189
+ z.literal(SCOPES.ORGANISATION_READ_LOCATIONS_MY_JURISDICTION)
177
190
  ]);
178
- var UserScopes = import_zod.z.union([
179
- import_zod.z.literal(SCOPES.USER_READ),
180
- import_zod.z.literal(SCOPES.USER_READ_MY_OFFICE),
181
- import_zod.z.literal(SCOPES.USER_READ_MY_JURISDICTION),
182
- import_zod.z.literal(SCOPES.USER_READ_ONLY_MY_AUDIT),
183
- import_zod.z.literal(SCOPES.USER_CREATE),
184
- import_zod.z.literal(SCOPES.USER_CREATE_MY_JURISDICTION),
185
- import_zod.z.literal(SCOPES.USER_UPDATE),
186
- import_zod.z.literal(SCOPES.USER_UPDATE_MY_JURISDICTION)
191
+ var UserScopes = z.union([
192
+ z.literal(SCOPES.USER_READ),
193
+ z.literal(SCOPES.USER_READ_MY_OFFICE),
194
+ z.literal(SCOPES.USER_READ_MY_JURISDICTION),
195
+ z.literal(SCOPES.USER_READ_ONLY_MY_AUDIT),
196
+ z.literal(SCOPES.USER_CREATE),
197
+ z.literal(SCOPES.USER_CREATE_MY_JURISDICTION),
198
+ z.literal(SCOPES.USER_UPDATE),
199
+ z.literal(SCOPES.USER_UPDATE_MY_JURISDICTION)
187
200
  ]);
188
- var ConfigScope = import_zod.z.literal(SCOPES.CONFIG_UPDATE_ALL);
189
- var DataSeedingScope = import_zod.z.literal(SCOPES.USER_DATA_SEEDING);
190
- var LiteralScopes = import_zod.z.union([
201
+ var ConfigScope = z.literal(SCOPES.CONFIG_UPDATE_ALL);
202
+ var DataSeedingScope = z.literal(SCOPES.USER_DATA_SEEDING);
203
+ var LiteralScopes = z.union([
191
204
  LegacyScopes,
192
205
  IntegrationScopes,
193
206
  UnassignScope,
194
207
  DeclareScopes,
195
208
  ValidateScopes,
196
209
  RegisterScope,
197
- import_zod.z.literal(SCOPES.RECORD_PRINT_ISSUE_CERTIFIED_COPIES),
210
+ z.literal(SCOPES.RECORD_PRINT_ISSUE_CERTIFIED_COPIES),
198
211
  CorrectionScopes,
199
212
  SearchScopes,
200
213
  AuditScopes,
201
- import_zod.z.literal(SCOPES.PROFILE_ELECTRONIC_SIGNATURE),
214
+ z.literal(SCOPES.PROFILE_ELECTRONIC_SIGNATURE),
202
215
  PerformanceScopes,
203
216
  OrganisationScopes,
204
217
  UserScopes,
@@ -207,37 +220,38 @@ var LiteralScopes = import_zod.z.union([
207
220
  InternalOperationsScopes
208
221
  ]);
209
222
  var rawConfigurableScopeRegex = /^([a-zA-Z][a-zA-Z0-9.-]*(?:\.[a-zA-Z0-9.-]+)*)\[((?:\w+=[\w.-]+(?:\|[\w.-]+)*)(?:,[\w]+=[\w.-]+(?:\|[\w.-]+)*)*)\]$/;
210
- var rawConfigurableScope = import_zod.z.string().regex(rawConfigurableScopeRegex);
211
- var CreateUserScope = import_zod.z.object({
212
- type: import_zod.z.literal("user.create"),
213
- options: import_zod.z.object({
214
- role: import_zod.z.array(import_zod.z.string())
223
+ var rawConfigurableScope = z.string().regex(rawConfigurableScopeRegex);
224
+ var CreateUserScope = z.object({
225
+ type: z.literal("user.create"),
226
+ options: z.object({
227
+ role: z.array(z.string())
215
228
  })
216
229
  });
217
- var EditUserScope = import_zod.z.object({
218
- type: import_zod.z.literal("user.edit"),
219
- options: import_zod.z.object({
220
- role: import_zod.z.array(import_zod.z.string())
230
+ var EditUserScope = z.object({
231
+ type: z.literal("user.edit"),
232
+ options: z.object({
233
+ role: z.array(z.string())
221
234
  })
222
235
  });
223
- var WorkqueueScope = import_zod.z.object({
224
- type: import_zod.z.literal("workqueue"),
225
- options: import_zod.z.object({
226
- id: import_zod.z.array(import_zod.z.string())
236
+ var WorkqueueScope = z.object({
237
+ type: z.literal("workqueue"),
238
+ options: z.object({
239
+ id: z.array(z.string())
227
240
  })
228
241
  });
229
- var SearchScope = import_zod.z.object({
230
- type: import_zod.z.literal("search"),
231
- options: import_zod.z.object({
232
- event: import_zod.z.array(import_zod.z.string()).length(1),
233
- access: import_zod.z.array(import_zod.z.enum(["my-jurisdiction", "all"])).length(1)
242
+ var SearchScope = z.object({
243
+ type: z.literal("search"),
244
+ options: z.object({
245
+ event: z.array(z.string()).length(1),
246
+ access: z.array(z.enum(["my-jurisdiction", "all"])).length(1)
234
247
  })
235
248
  });
236
- var RecordScopeType = import_zod.z.enum([
249
+ var RecordScopeType = z.enum([
237
250
  "record.create",
238
251
  "record.read",
239
252
  "record.declare",
240
253
  "record.notify",
254
+ "record.declared.edit",
241
255
  "record.declared.validate",
242
256
  "record.declared.reject",
243
257
  "record.declared.archive",
@@ -248,20 +262,33 @@ var RecordScopeType = import_zod.z.enum([
248
262
  "record.registered.correct",
249
263
  "record.unassign-others"
250
264
  ]);
251
- var RecordScope = import_zod.z.object({
265
+ var RecordScope = z.object({
252
266
  type: RecordScopeType,
253
- options: import_zod.z.object({
254
- event: import_zod.z.array(import_zod.z.string()).describe("Event type, e.g. birth, death")
267
+ options: z.object({
268
+ event: z.array(z.string()).describe("Event type, e.g. birth, death")
255
269
  })
256
270
  }).describe(
257
271
  "Scopes used to check user's permission to perform actions on a record."
258
272
  );
259
- var ConfigurableRawScopes = import_zod.z.discriminatedUnion("type", [
273
+ var CustomActionScope = z.object({
274
+ type: z.literal("record.custom-action"),
275
+ options: z.object({
276
+ event: z.array(z.string()).describe("Allowed event type, e.g. birth, death"),
277
+ customActionType: z.array(z.string()).describe("Allowed custom action types")
278
+ })
279
+ });
280
+ var ConfigurableRawScopes = z.discriminatedUnion("type", [
260
281
  SearchScope,
261
282
  CreateUserScope,
262
283
  EditUserScope,
263
284
  WorkqueueScope,
264
- RecordScope
285
+ RecordScope,
286
+ CustomActionScope
287
+ ]);
288
+ var ConfigurableActionScopes = z.discriminatedUnion("type", [
289
+ // @TODO - Record scope holds non-action scopes as well e.g., `record.read`
290
+ RecordScope,
291
+ CustomActionScope
265
292
  ]);
266
293
  function flattenAndMergeScopes(scopes2) {
267
294
  if (scopes2.length === 0) return null;
@@ -331,10 +358,13 @@ function getAuthorizedEventsFromScopes(scopes2) {
331
358
  }).filter((event) => event !== void 0).filter((event, index, self) => self.indexOf(event) === index);
332
359
  }
333
360
  var scopes = Object.values(SCOPES);
334
- var ActionScopes = import_zod.z.union([
361
+ var ActionScopes = z.union([
335
362
  DeclareScopes,
336
363
  ValidateScopes,
337
364
  RegisterScope,
338
- import_zod.z.literal(SCOPES.RECORD_PRINT_ISSUE_CERTIFIED_COPIES),
365
+ z.literal(SCOPES.RECORD_PRINT_ISSUE_CERTIFIED_COPIES),
339
366
  CorrectionScopes
340
367
  ]);
368
+
369
+ // src/scopes/index.ts
370
+ z2.globalRegistry.clear();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "1.9.3-rc.c5b6285",
3
+ "version": "1.9.3-rc.da977ad",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
6
  "exports": {
@@ -17,14 +17,14 @@
17
17
  "build:all": "lerna run build --include-dependencies --scope @opencrvs/toolkit && ./build.sh"
18
18
  },
19
19
  "dependencies": {
20
- "uuid": "^9.0.0",
20
+ "@trpc/client": "11.4.3",
21
+ "@trpc/server": "11.4.3",
21
22
  "ajv": "^8.17.1",
22
23
  "ajv-formats": "^3.0.1",
23
24
  "object-hash": "^3.0.0",
24
25
  "superjson": "1.9.0-0",
25
- "@trpc/client": "11.4.3",
26
- "@trpc/server": "11.4.3",
27
- "zod-openapi": "^4.2.4"
26
+ "uuid": "^9.0.0",
27
+ "zod-openapi": "^5.4.3"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@types/uuid": "^9.0.3",