@opencrvs/toolkit 2.0.0-rc.e1f588f → 2.0.0-rc.e25c39b

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 (63) hide show
  1. package/create-countryconfig/index.js +103 -0
  2. package/create-countryconfig/package.json +21 -0
  3. package/dist/application-config/index.js +314 -131
  4. package/dist/cli.js +548 -178
  5. package/dist/commons/api/router.d.ts +3392 -241
  6. package/dist/commons/application-config/index.d.ts +17 -4
  7. package/dist/commons/conditionals/conditionals.d.ts +360 -10
  8. package/dist/commons/conditionals/validate.d.ts +52 -2
  9. package/dist/commons/events/ActionConfig.d.ts +28 -2
  10. package/dist/commons/events/ActionDocument.d.ts +6 -0
  11. package/dist/commons/events/ActionInput.d.ts +114 -0
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +342 -0
  13. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  14. package/dist/commons/events/Draft.d.ts +4 -2
  15. package/dist/commons/events/EventDocument.d.ts +3 -0
  16. package/dist/commons/events/EventIndex.d.ts +14 -3
  17. package/dist/commons/events/EventMetadata.d.ts +0 -7
  18. package/dist/commons/events/FieldConfig.d.ts +388 -50
  19. package/dist/commons/events/FieldType.d.ts +1 -0
  20. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  21. package/dist/commons/events/FieldValue.d.ts +6 -0
  22. package/dist/commons/events/WorkqueueConfig.d.ts +189 -150
  23. package/dist/commons/events/field.d.ts +53 -1
  24. package/dist/commons/events/index.d.ts +2 -0
  25. package/dist/commons/events/locations.d.ts +38 -1
  26. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  27. package/dist/commons/events/scopes.d.ts +24 -1
  28. package/dist/commons/events/state/flags.d.ts +16 -0
  29. package/dist/commons/events/state/index.d.ts +0 -4
  30. package/dist/commons/events/state/utils.d.ts +12 -289
  31. package/dist/commons/events/utils.d.ts +13 -2
  32. package/dist/conditionals/index.js +92 -9
  33. package/dist/events/index.js +1206 -291
  34. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  35. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +60 -35
  36. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  37. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  38. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
  39. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
  40. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
  41. package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
  42. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  43. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  44. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  45. package/dist/migrations/v2.0/index.d.ts +5 -3
  46. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  47. package/dist/migrations/v2.0/index.js +546 -176
  48. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  49. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
  50. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
  51. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
  52. package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
  53. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  54. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  55. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  56. package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
  57. package/dist/notification/index.js +938 -163
  58. package/dist/scopes/index.d.ts +91 -16
  59. package/dist/scopes/index.js +55 -12
  60. package/opencrvs-toolkit-2.0.0-rc.e25c39b.tgz +0 -0
  61. package/package.json +6 -2
  62. package/tsconfig.tsbuildinfo +1 -1
  63. package/opencrvs-toolkit-2.0.0-rc.e1f588f.tgz +0 -0
@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
30
30
  // src/conditionals/index.ts
31
31
  var conditionals_exports = {};
32
32
  __export(conditionals_exports, {
33
+ always: () => always,
33
34
  alwaysTrue: () => alwaysTrue,
34
35
  and: () => and,
35
36
  createFieldConditionals: () => createFieldConditionals,
@@ -182,6 +183,10 @@ var scopeByEvent = z6.preprocess(
182
183
  (val) => val === void 0 ? void 0 : [val].flat(),
183
184
  z6.array(z6.string()).optional()
184
185
  ).describe("Event type, e.g. birth, death");
186
+ var userRole = z6.preprocess(
187
+ (val) => val === void 0 ? void 0 : [val].flat(),
188
+ z6.array(z6.string()).optional()
189
+ ).describe("User role, e.g. admin, field agent");
185
190
  var scopeOptionsPlaceEvent = z6.object({
186
191
  event: scopeByEvent,
187
192
  placeOfEvent: JurisdictionFilter.optional()
@@ -205,6 +210,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
205
210
  var AccessLevelOptions = z6.object({
206
211
  accessLevel: JurisdictionFilter.optional()
207
212
  });
213
+ var AllUserScopeOptions = AccessLevelOptions.extend({
214
+ role: userRole.optional()
215
+ });
208
216
  var WorkqueueOrDashboardOptions = z6.object({
209
217
  ids: z6.preprocess(
210
218
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -214,6 +222,7 @@ var WorkqueueOrDashboardOptions = z6.object({
214
222
  var AllScopeOptions = z6.object({
215
223
  ...AllRecordScopeOptions.shape,
216
224
  ...AccessLevelOptions.shape,
225
+ ...AllUserScopeOptions.shape,
217
226
  ...WorkqueueOrDashboardOptions.shape
218
227
  });
219
228
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -286,6 +295,30 @@ var RecordScopeV2 = z6.discriminatedUnion("type", [
286
295
  ]).describe(
287
296
  "Scopes used to check user's permission to perform actions on a record."
288
297
  );
298
+ var SystemScopeType = z6.enum([
299
+ "organisation.read-locations",
300
+ "user.read",
301
+ "user.create",
302
+ "user.edit",
303
+ "user.search"
304
+ ]);
305
+ var UserScopeType = SystemScopeType.extract([
306
+ "user.read",
307
+ "user.create",
308
+ "user.edit",
309
+ "user.search"
310
+ ]);
311
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
312
+ var UserScopeV2 = z6.discriminatedUnion("type", [
313
+ z6.object({
314
+ type: ScopesWithRoleOption,
315
+ options: AllUserScopeOptions.optional()
316
+ }),
317
+ z6.object({
318
+ type: UserScopeType.extract(["user.read", "user.search"]),
319
+ options: AccessLevelOptions.optional()
320
+ })
321
+ ]);
289
322
  var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
290
323
  z6.object({
291
324
  type: ScopesWithPlaceEventOptions,
@@ -306,16 +339,14 @@ var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
306
339
  }).optional()
307
340
  })
308
341
  ]).describe("Resolved scope with location/user IDs instead of filters.");
309
- var SystemScopeType = z6.enum([
310
- "organisation.read-locations",
311
- "user.read",
312
- "user.create",
313
- "user.edit"
314
- ]);
315
342
  var Scope2 = z6.discriminatedUnion("type", [
316
343
  z6.object({ type: PlainScopeType }),
317
344
  ...RecordScopeV2.options,
318
- z6.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
345
+ ...UserScopeV2.options,
346
+ z6.object({
347
+ type: z6.literal("organisation.read-locations"),
348
+ options: AccessLevelOptions.optional()
349
+ }),
319
350
  z6.object({
320
351
  type: z6.literal("workqueue"),
321
352
  options: WorkqueueOrDashboardOptions
@@ -335,7 +366,9 @@ var ScopeType2 = z6.enum([
335
366
  var EncodedScope2 = z6.string().brand("EncodedScope");
336
367
  var DEFAULT_SCOPE_OPTIONS = {
337
368
  placeOfEvent: JurisdictionFilter.enum.all,
338
- accessLevel: JurisdictionFilter.enum.all
369
+ accessLevel: JurisdictionFilter.enum.all,
370
+ registeredIn: JurisdictionFilter.enum.all,
371
+ declaredIn: JurisdictionFilter.enum.all
339
372
  };
340
373
 
341
374
  // ../commons/src/users/userReferences.ts
@@ -422,6 +455,9 @@ function not(condition) {
422
455
  function never() {
423
456
  return not(alwaysTrue());
424
457
  }
458
+ function always() {
459
+ return defineConditional(alwaysTrue());
460
+ }
425
461
  function jsonFieldPath(field) {
426
462
  return [field.$$field, ...field.$$subfield].join("/");
427
463
  }
@@ -969,7 +1005,54 @@ function createFieldConditionals(fieldId) {
969
1005
  }
970
1006
  },
971
1007
  required: [fieldId]
972
- })
1008
+ }),
1009
+ /**
1010
+ * Custom client-side validator. The provided function is serialised and executed
1011
+ * just-in-time on the client only. External references (e.g. lodash) are not
1012
+ * available inside the function body — all logic must be self-contained.
1013
+ *
1014
+ * @example
1015
+ * field('nid').customClientValidator((value) => {
1016
+ * // LUHN check — all logic must be inline
1017
+ * const digits = String(value).split('').map(Number)
1018
+ * // ...
1019
+ * return isValid
1020
+ * })
1021
+ */
1022
+ customClientValidator(validationFn) {
1023
+ const code = validationFn.toString();
1024
+ return defineFormConditional({
1025
+ type: "object",
1026
+ properties: wrapToPath(
1027
+ { [fieldId]: { customClientValidator: { code } } },
1028
+ this.$$subfield
1029
+ ),
1030
+ required: [fieldId]
1031
+ });
1032
+ },
1033
+ /**
1034
+ * Custom client-side evaluation. Returns a {@link FieldReference} descriptor
1035
+ * that can be used as the `value` property or a DATA component entry.
1036
+ * The function receives the referenced field's value as the first argument and
1037
+ * the full form context as the second; its return value replaces the field reference.
1038
+ * The function is serialised and executed just-in-time on the client only.
1039
+ * External references (e.g. lodash) are not available inside the function body.
1040
+ *
1041
+ * For computing a default value without referencing a specific field, use
1042
+ * `evaluate(fn)` in the `defaultValue` property instead.
1043
+ *
1044
+ * @example
1045
+ * field('a').customClientEvaluation((aValue, ctx) =>
1046
+ * Number(aValue) + Number(ctx.$form.b)
1047
+ * )
1048
+ */
1049
+ customClientEvaluation(computationFn) {
1050
+ return {
1051
+ $$code: computationFn.toString(),
1052
+ $$field: fieldId,
1053
+ $$subfield: this.$$subfield
1054
+ };
1055
+ }
973
1056
  };
974
1057
  }
975
1058