@opencrvs/toolkit 2.1.2 → 2.2.0-rc.19ec10b

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 (177) hide show
  1. package/build.sh +9 -14
  2. package/create-countryconfig/package.json +1 -1
  3. package/dist/application-config/index.js +57 -14
  4. package/dist/authentication/index.d.ts +2 -1
  5. package/dist/authentication/index.js +34 -14
  6. package/dist/cli.js +1491 -2020
  7. package/dist/commons/api/router.d.ts +1564 -248
  8. package/dist/commons/application-config/index.d.ts +3 -3
  9. package/dist/commons/conditionals/conditionals.d.ts +58 -7
  10. package/dist/commons/conditionals/index.d.ts +1 -0
  11. package/dist/commons/conditionals/validate.d.ts +6 -1
  12. package/dist/commons/events/ActionConfig.d.ts +146 -20
  13. package/dist/commons/events/ActionDocument.d.ts +89 -0
  14. package/dist/commons/events/ActionInput.d.ts +56 -4
  15. package/dist/commons/events/ActionStatus.d.ts +2 -2
  16. package/dist/commons/events/ActionType.d.ts +13 -1
  17. package/dist/commons/events/AdvancedSearchConfig.d.ts +15 -0
  18. package/dist/commons/events/AuditLog.d.ts +4 -0
  19. package/dist/commons/events/CompositeFieldValue.d.ts +5 -1
  20. package/dist/commons/events/CountryConfigQueryInput.d.ts +192 -18
  21. package/dist/commons/events/Draft.d.ts +36 -1
  22. package/dist/commons/events/EventConfig.d.ts +473 -6
  23. package/dist/commons/events/EventDocument.d.ts +90 -0
  24. package/dist/commons/events/EventIndex.d.ts +44 -6
  25. package/dist/commons/events/EventInput.d.ts +1 -0
  26. package/dist/commons/events/EventMetadata.d.ts +24 -1
  27. package/dist/commons/events/EventStatus.d.ts +1 -0
  28. package/dist/commons/events/FieldConfig.d.ts +11 -1
  29. package/dist/commons/events/FieldTypeMapping.d.ts +17 -17
  30. package/dist/commons/events/Flag.d.ts +1 -7
  31. package/dist/commons/events/PlainDate.d.ts +6 -0
  32. package/dist/commons/events/WorkqueueConfig.d.ts +224 -33
  33. package/dist/commons/events/defineConfig.d.ts +7 -2
  34. package/dist/commons/events/event.d.ts +20 -1
  35. package/dist/commons/events/eventConfigValidation.d.ts +26 -1
  36. package/dist/commons/events/field.d.ts +37 -0
  37. package/dist/commons/events/index.d.ts +3 -0
  38. package/dist/commons/events/locations.d.ts +1 -1
  39. package/dist/commons/events/scopes.d.ts +4 -1
  40. package/dist/commons/events/state/flags.d.ts +1 -1
  41. package/dist/commons/events/state/index.d.ts +11 -2
  42. package/dist/commons/events/state/utils.d.ts +11 -1
  43. package/dist/commons/events/test.utils.d.ts +89 -7
  44. package/dist/commons/events/toNotificationForm.d.ts +17 -0
  45. package/dist/commons/events/utils.d.ts +90 -10
  46. package/dist/commons/users/Role.d.ts +23 -0
  47. package/dist/commons/users/User.d.ts +263 -0
  48. package/dist/commons/users/authentication.d.ts +67 -0
  49. package/dist/commons/users/index.d.ts +5 -0
  50. package/dist/commons/users/roleValidations.d.ts +15 -0
  51. package/dist/commons/users/scopes.d.ts +1402 -0
  52. package/dist/commons/users/userReferences.d.ts +176 -0
  53. package/dist/conditionals/index.js +29 -9
  54. package/dist/environment/custom-types.d.ts +1 -0
  55. package/dist/environment/custom-types.d.ts.map +1 -1
  56. package/dist/environment/derived-variables.d.ts +24 -4
  57. package/dist/environment/derived-variables.d.ts.map +1 -1
  58. package/dist/environment/derived-variables.js +27 -4
  59. package/dist/environment/questions.d.ts +42 -9
  60. package/dist/environment/questions.d.ts.map +1 -1
  61. package/dist/environment/questions.js +71 -48
  62. package/dist/environment/registry.d.ts +15 -0
  63. package/dist/environment/registry.d.ts.map +1 -0
  64. package/dist/environment/registry.js +112 -0
  65. package/dist/environment/setup-environment.d.ts.map +1 -1
  66. package/dist/environment/setup-environment.js +165 -35
  67. package/dist/environment/templates.d.ts.map +1 -1
  68. package/dist/events/index.js +2050 -1156
  69. package/dist/migrations/add-notify-config.d.ts +40 -0
  70. package/dist/migrations/add-notify-config.d.ts.map +1 -0
  71. package/dist/migrations/add-notify-config.js +249 -0
  72. package/dist/migrations/index.d.ts +9 -0
  73. package/dist/migrations/index.d.ts.map +1 -0
  74. package/dist/migrations/index.js +1306 -0
  75. package/dist/migrations/move-declaration-to-declare-action.d.ts +38 -0
  76. package/dist/migrations/move-declaration-to-declare-action.d.ts.map +1 -0
  77. package/dist/migrations/move-declaration-to-declare-action.js +260 -0
  78. package/dist/migrations/{v2.1 → persistent}/add-translations.d.ts +7 -1
  79. package/dist/migrations/persistent/add-translations.d.ts.map +1 -0
  80. package/dist/migrations/{v2.1 → persistent}/add-translations.js +14 -12
  81. package/dist/migrations/persistent/check-upgrade-path.d.ts +36 -0
  82. package/dist/migrations/persistent/check-upgrade-path.d.ts.map +1 -0
  83. package/dist/migrations/persistent/check-upgrade-path.js +105 -0
  84. package/dist/migrations/persistent/update-toolkit-dependency.d.ts +7 -0
  85. package/dist/migrations/persistent/update-toolkit-dependency.d.ts.map +1 -0
  86. package/dist/migrations/persistent/update-toolkit-dependency.js +77 -0
  87. package/dist/migrations/read-declaration-through-helper.d.ts +39 -0
  88. package/dist/migrations/read-declaration-through-helper.d.ts.map +1 -0
  89. package/dist/migrations/read-declaration-through-helper.js +199 -0
  90. package/dist/migrations/replace-incomplete-flag.d.ts +26 -0
  91. package/dist/migrations/replace-incomplete-flag.d.ts.map +1 -0
  92. package/dist/migrations/replace-incomplete-flag.js +126 -0
  93. package/dist/migrations/resolve-versioned-event-config.d.ts +56 -0
  94. package/dist/migrations/resolve-versioned-event-config.d.ts.map +1 -0
  95. package/dist/migrations/resolve-versioned-event-config.js +353 -0
  96. package/dist/migrations/utils.d.ts +61 -0
  97. package/dist/migrations/utils.d.ts.map +1 -0
  98. package/dist/migrations/utils.js +218 -0
  99. package/dist/notification/index.js +1081 -209
  100. package/dist/roles/index.d.ts +2 -0
  101. package/dist/roles/index.d.ts.map +1 -0
  102. package/dist/roles/index.js +730 -0
  103. package/dist/scopes/index.d.ts +83 -100
  104. package/dist/scopes/index.js +29 -13
  105. package/dist/templates/charts-values/dependencies/values.yaml +6 -3
  106. package/dist/templates/charts-values/opencrvs-services/values.yaml +5 -10
  107. package/dist/templates/charts-values/traefik/values.yaml +4 -3
  108. package/dist/verify/endpoints.d.ts +11 -0
  109. package/dist/verify/endpoints.d.ts.map +1 -1
  110. package/dist/verify/endpoints.js +21 -27
  111. package/opencrvs-toolkit-2.2.0-rc.19ec10b.tgz +0 -0
  112. package/package.json +5 -3
  113. package/tsconfig.build.tsbuildinfo +1 -1
  114. package/tsconfig.json +3 -5
  115. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +0 -3
  116. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +0 -1
  117. package/dist/migrations/v2.1/add-explicit-correction-flags.js +0 -234
  118. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +0 -3
  119. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +0 -1
  120. package/dist/migrations/v2.1/add-recovery-link-notifications.js +0 -511
  121. package/dist/migrations/v2.1/add-translations.d.ts.map +0 -1
  122. package/dist/migrations/v2.1/enable-telemetry.d.ts +0 -3
  123. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +0 -1
  124. package/dist/migrations/v2.1/enable-telemetry.js +0 -455
  125. package/dist/migrations/v2.1/index.d.ts +0 -6
  126. package/dist/migrations/v2.1/index.d.ts.map +0 -1
  127. package/dist/migrations/v2.1/index.js +0 -2170
  128. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts +0 -14
  129. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts.map +0 -1
  130. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.js +0 -348
  131. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts +0 -2
  132. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts.map +0 -1
  133. package/dist/migrations/v2.1/remove-metabase-package-installs.js +0 -161
  134. package/dist/migrations/v2.1/remove-sentry.d.ts +0 -3
  135. package/dist/migrations/v2.1/remove-sentry.d.ts.map +0 -1
  136. package/dist/migrations/v2.1/remove-sentry.js +0 -354
  137. package/dist/migrations/v2.1/rename-trigger-paths.d.ts +0 -3
  138. package/dist/migrations/v2.1/rename-trigger-paths.d.ts.map +0 -1
  139. package/dist/migrations/v2.1/rename-trigger-paths.js +0 -216
  140. package/dist/migrations/v2.1/template-files.d.ts +0 -8
  141. package/dist/migrations/v2.1/template-files.d.ts.map +0 -1
  142. package/dist/migrations/v2.1/template-files.js +0 -49
  143. package/dist/migrations/v2.1/upgrade-tilt.d.ts +0 -8
  144. package/dist/migrations/v2.1/upgrade-tilt.d.ts.map +0 -1
  145. package/dist/migrations/v2.1/upgrade-tilt.js +0 -139
  146. package/dist/templates/countryconfig-template/.tiltignore +0 -1
  147. package/dist/templates/countryconfig-template/Dockerfile.assets +0 -7
  148. package/dist/templates/countryconfig-template/Tiltfile +0 -112
  149. package/dist/templates/countryconfig-template/assets/README.md +0 -1
  150. package/dist/templates/countryconfig-template/assets/clear-all-data-dev.sh +0 -61
  151. package/dist/templates/countryconfig-template/assets/deployment/deploy.sh +0 -455
  152. package/dist/templates/countryconfig-template/assets/deployment/reindex.sh +0 -168
  153. package/dist/templates/countryconfig-template/assets/deployment/validate-required-variables-in-compose-files.ts +0 -67
  154. package/dist/templates/countryconfig-template/assets/elasticsearch/reindex.sh +0 -168
  155. package/dist/templates/countryconfig-template/assets/metabase/README.md +0 -34
  156. package/dist/templates/countryconfig-template/assets/metabase/environment-configuration.sql +0 -36
  157. package/dist/templates/countryconfig-template/assets/metabase/initialize-database.sh +0 -46
  158. package/dist/templates/countryconfig-template/assets/metabase/metabase.init.db.sql +0 -27737
  159. package/dist/templates/countryconfig-template/assets/metabase/open-shell.sh +0 -21
  160. package/dist/templates/countryconfig-template/assets/metabase/package.json +0 -13
  161. package/dist/templates/countryconfig-template/assets/metabase/run-dev.sh +0 -108
  162. package/dist/templates/countryconfig-template/assets/metabase/run.sh +0 -120
  163. package/dist/templates/countryconfig-template/assets/metabase/update-database.sh +0 -40
  164. package/dist/templates/countryconfig-template/assets/postgres/setup-analytics.sh +0 -135
  165. package/dist/templates/countryconfig-template/assets/postgres/setup-reference-data.sh +0 -108
  166. package/dist/templates/countryconfig-template/tilt/clear-all-data.ps1 +0 -50
  167. package/dist/templates/countryconfig-template/tilt/clear-all-data.sh +0 -35
  168. package/dist/templates/countryconfig-template/tilt/common.tilt +0 -145
  169. package/dist/templates/countryconfig-template/tilt/examples/dependencies/values.yaml +0 -15
  170. package/dist/templates/countryconfig-template/tilt/examples/opencrvs-services/values.yaml +0 -56
  171. package/dist/templates/countryconfig-template/tilt/examples/traefik/values-minikube.yaml +0 -21
  172. package/dist/templates/countryconfig-template/tilt/examples/traefik/values.yaml +0 -38
  173. package/dist/templates/countryconfig-template/tilt/helm/dependencies/values.yaml +0 -17
  174. package/dist/templates/countryconfig-template/tilt/helm/opencrvs-services/values.yaml +0 -16
  175. package/dist/templates/countryconfig-template/tilt/lib.tilt +0 -95
  176. package/dist/templates/countryconfig-template/tilt/opencrvs.tilt +0 -136
  177. package/opencrvs-toolkit-2.1.2.tgz +0 -0
package/build.sh CHANGED
@@ -25,6 +25,8 @@ mkdir -p ./dist/commons/events
25
25
  cp -r ../commons/build/dist/common/events/*.d.ts ./dist/commons/events
26
26
  mkdir -p ./dist/commons/events/state
27
27
  cp -r ../commons/build/dist/common/events/state/*.d.ts ./dist/commons/events/state
28
+ mkdir -p ./dist/commons/users
29
+ cp -r ../commons/build/dist/common/users/*.d.ts ./dist/commons/users
28
30
 
29
31
  # Build common conditionals
30
32
  npx esbuild src/conditionals/index.ts --bundle --format=cjs --outdir=./dist/conditionals --allow-overwrite --packages=external
@@ -33,11 +35,14 @@ cp -r ../commons/build/dist/common/conditionals/*.d.ts ./dist/commons/conditiona
33
35
 
34
36
  # Build common scopes
35
37
  npx esbuild src/scopes/index.ts --bundle --format=cjs --outdir=./dist/scopes --allow-overwrite --packages=external
36
- cp -r ../commons/build/dist/common/scopes.d.ts ./dist/scopes/index.d.ts
38
+ cp -r ../commons/build/dist/common/users/scopes.d.ts ./dist/scopes/index.d.ts
39
+
40
+ # Build common roles (.d.ts points at dist/commons/users, copied with the events types)
41
+ npx esbuild src/roles/index.ts --bundle --format=cjs --outdir=./dist/roles --allow-overwrite --packages=external
37
42
 
38
43
  # Build common authentication
39
44
  npx esbuild src/authentication/index.ts --bundle --format=cjs --outdir=./dist/authentication --allow-overwrite --packages=external
40
- cp -r ../commons/build/dist/common/authentication.d.ts ./dist/authentication/index.d.ts
45
+ cp -r ../commons/build/dist/common/users/authentication.d.ts ./dist/authentication/index.d.ts
41
46
 
42
47
  # Build api client
43
48
  npx esbuild src/api/index.ts --bundle --format=cjs --outdir=./dist/api --allow-overwrite --packages=external
@@ -59,8 +64,8 @@ mkdir -p ./dist/commons/application-config
59
64
  cp -r ../commons/build/dist/common/application-config.d.ts ./dist/commons/application-config/index.d.ts
60
65
 
61
66
  # Build migration CLI
62
- npx esbuild src/migrations/v2.1/index.ts --bundle --platform=node --format=cjs --outdir=./dist/migrations/v2.1 --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
63
- chmod +x ./dist/migrations/v2.1/index.js
67
+ npx esbuild src/migrations/index.ts --bundle --platform=node --format=cjs --outdir=./dist/migrations --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
68
+ chmod +x ./dist/migrations/index.js
64
69
 
65
70
  if [[ "$OSTYPE" == "darwin"* ]]; then
66
71
  sed -i '' 's|@opencrvs/events/build/types|../commons/api|g' dist/api/index.d.ts
@@ -73,16 +78,6 @@ fi
73
78
  # Build CLI
74
79
  npx esbuild src/cli.ts --bundle --platform=node --format=cjs --outdir=./dist --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
75
80
  cp -R src/environment/templates dist/templates
76
- # Template files copied into country configs by the upgrade-tilt and
77
- # migrate-infrastructure-to-assets codemods. Image builds that use the toolkit as
78
- # a library (testland, mosip-api) do not copy the template in and do not need them.
79
- TEMPLATE_DIR=../countryconfig-template
80
- if [ -d "$TEMPLATE_DIR" ]; then
81
- mkdir -p dist/templates/countryconfig-template
82
- cp -R $TEMPLATE_DIR/Tiltfile $TEMPLATE_DIR/.tiltignore $TEMPLATE_DIR/tilt $TEMPLATE_DIR/assets $TEMPLATE_DIR/Dockerfile.assets dist/templates/countryconfig-template/
83
- else
84
- echo "$TEMPLATE_DIR not found, 'opencrvs upgrade' will not be able to copy the template files"
85
- fi
86
81
  chmod +x ./dist/cli.js
87
82
 
88
83
  echo "Build completed successfully."
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/create-countryconfig",
3
- "version": "2.1.2",
3
+ "version": "2.2.0",
4
4
  "description": "Scaffold a new OpenCRVS country configuration",
5
5
  "bin": {
6
6
  "create-countryconfig": "./index.js"
@@ -218,7 +218,7 @@ var z7 = __toESM(require("zod/v4"));
218
218
  // ../commons/src/documents.ts
219
219
  var z4 = __toESM(require("zod/v4"));
220
220
  var FullDocumentUrl = z4.string().brand("FullDocumentUrl").describe(
221
- "A full url with protocol, host, bucket name, starting from the root of the S3 server, https://minio.opencrvs.com/bucket-name/document-id.jpg"
221
+ "A full url with protocol, host, bucket name, starting from the root of the S3 server, https://s3.opencrvs.com/bucket-name/document-id.jpg"
222
222
  );
223
223
  var FullDocumentPath = z4.string().overwrite((val) => val.startsWith("/") ? val : `/${val}`).meta({ effectType: "input", type: "string" }).describe(
224
224
  "A full absolute path with bucket name, starting from the root of the S3 server, /bucket-name/document-id.jpg"
@@ -228,7 +228,7 @@ var DocumentPath = z4.string().brand("DocumentPath").describe(
228
228
  );
229
229
 
230
230
  // ../commons/src/events/CompositeFieldValue.ts
231
- var z5 = __toESM(require("zod/v4"));
231
+ var z5 = __toESM(require("zod"));
232
232
  var AddressType = {
233
233
  DOMESTIC: "DOMESTIC",
234
234
  INTERNATIONAL: "INTERNATIONAL"
@@ -433,7 +433,7 @@ function safeUnion(schemas) {
433
433
  );
434
434
  return z7.any().superRefine((val, ctx) => {
435
435
  for (const schema of sortedSchemas) {
436
- if (schema.safeParse(val).success) {
436
+ if (schema.validate(val)) {
437
437
  return;
438
438
  }
439
439
  }
@@ -527,6 +527,8 @@ var ActionType = {
527
527
  REQUEST_CORRECTION: "REQUEST_CORRECTION",
528
528
  REJECT_CORRECTION: "REJECT_CORRECTION",
529
529
  APPROVE_CORRECTION: "APPROVE_CORRECTION",
530
+ REVOKE_REGISTRATION: "REVOKE_REGISTRATION",
531
+ REINSTATE_REGISTRATION: "REINSTATE_REGISTRATION",
530
532
  // General actions
531
533
  READ: "READ",
532
534
  ASSIGN: "ASSIGN",
@@ -546,6 +548,8 @@ var ConfirmableActions = [
546
548
  ActionType.REQUEST_CORRECTION,
547
549
  ActionType.APPROVE_CORRECTION,
548
550
  ActionType.REJECT_CORRECTION,
551
+ ActionType.REVOKE_REGISTRATION,
552
+ ActionType.REINSTATE_REGISTRATION,
549
553
  ActionType.CUSTOM
550
554
  ];
551
555
  var ActionTypes = z10.enum([
@@ -565,6 +569,8 @@ var ActionTypes = z10.enum([
565
569
  "REQUEST_CORRECTION",
566
570
  "REJECT_CORRECTION",
567
571
  "APPROVE_CORRECTION",
572
+ "REVOKE_REGISTRATION",
573
+ "REINSTATE_REGISTRATION",
568
574
  "READ",
569
575
  "ASSIGN",
570
576
  "UNASSIGN",
@@ -603,7 +609,9 @@ var WorkqueueActionType = ActionTypes.extract([
603
609
  ActionType.ARCHIVE,
604
610
  ActionType.UNARCHIVE,
605
611
  ActionType.PRINT_CERTIFICATE,
606
- ActionType.REQUEST_CORRECTION
612
+ ActionType.REQUEST_CORRECTION,
613
+ ActionType.REVOKE_REGISTRATION,
614
+ ActionType.REINSTATE_REGISTRATION
607
615
  ]);
608
616
  var META_ACTIONS = [
609
617
  ActionType.ASSIGN,
@@ -611,11 +619,11 @@ var META_ACTIONS = [
611
619
  ActionType.READ
612
620
  ];
613
621
 
614
- // ../commons/src/authentication.ts
622
+ // ../commons/src/users/authentication.ts
615
623
  var import_jwt_decode = __toESM(require("jwt-decode"));
616
624
  var z14 = __toESM(require("zod/v4"));
617
625
 
618
- // ../commons/src/scopes.ts
626
+ // ../commons/src/users/scopes.ts
619
627
  var z13 = __toESM(require("zod/v4"));
620
628
  var qs = __toESM(require("qs"));
621
629
 
@@ -627,9 +635,8 @@ var ActionStatus = {
627
635
  };
628
636
 
629
637
  // ../commons/src/events/Flag.ts
630
- var z11 = __toESM(require("zod/v4"));
638
+ var z11 = __toESM(require("zod"));
631
639
  var InherentFlags = {
632
- INCOMPLETE: "incomplete",
633
640
  REJECTED: "rejected",
634
641
  CORRECTION_REQUESTED: "correction-requested",
635
642
  POTENTIAL_DUPLICATE: "potential-duplicate",
@@ -657,7 +664,7 @@ var CustomFlag = z11.string().refine((val) => !Object.values(InherentFlags).incl
657
664
  message: `Custom flag cannot be one of the inherent flags: ${Object.values(
658
665
  InherentFlags
659
666
  ).join(", ")}`
660
- }).refine((val) => !ActionFlag.safeParse(val).success, {
667
+ }).refine((val) => !ActionFlag.validate(val), {
661
668
  message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
662
669
  }).describe("Custom flag identifier defined by the country config.");
663
670
  var Flag = ActionFlag.or(z11.enum(InherentFlags)).or(CustomFlag);
@@ -696,10 +703,11 @@ var EventStatus = z12.enum([
696
703
  "NOTIFIED",
697
704
  "DECLARED",
698
705
  "REGISTERED",
706
+ "REVOKED",
699
707
  "ARCHIVED"
700
708
  ]);
701
709
 
702
- // ../commons/src/scopes.ts
710
+ // ../commons/src/users/scopes.ts
703
711
  var JurisdictionFilter = z13.enum(["administrativeArea", "location", "all"]).describe(
704
712
  "Filters based on user jurisdiction relative to their office location in hierarchy."
705
713
  );
@@ -719,6 +727,8 @@ var RecordScopeTypeV2 = z13.enum([
719
727
  "record.print-certified-copies",
720
728
  "record.request-correction",
721
729
  "record.correct",
730
+ "record.revoke-registration",
731
+ "record.reinstate-registration",
722
732
  "record.unassign-others",
723
733
  "record.custom-action",
724
734
  "record.action.accept",
@@ -845,6 +855,8 @@ var ScopesWithFullOptions = RecordScopeTypeV2.extract([
845
855
  "record.read",
846
856
  "record.request-correction",
847
857
  "record.correct",
858
+ "record.revoke-registration",
859
+ "record.reinstate-registration",
848
860
  "record.unassign-others",
849
861
  "record.review-duplicates"
850
862
  ]);
@@ -968,7 +980,7 @@ var DEFAULT_SCOPE_OPTIONS = {
968
980
  registeredIn: JurisdictionFilter.enum.all
969
981
  };
970
982
 
971
- // ../commons/src/authentication.ts
983
+ // ../commons/src/users/authentication.ts
972
984
  var TokenUserType = z14.enum(["user", "system"]);
973
985
  var TokenWithBearer = z14.string().regex(/^Bearer\s/);
974
986
 
@@ -1087,6 +1099,16 @@ var UnarchiveAction = ActionBase.extend(
1087
1099
  type: z15.literal(ActionType.UNARCHIVE)
1088
1100
  }).shape
1089
1101
  );
1102
+ var RevokeRegistrationAction = ActionBase.extend(
1103
+ z15.object({
1104
+ type: z15.literal(ActionType.REVOKE_REGISTRATION)
1105
+ }).shape
1106
+ );
1107
+ var ReinstateRegistrationAction = ActionBase.extend(
1108
+ z15.object({
1109
+ type: z15.literal(ActionType.REINSTATE_REGISTRATION)
1110
+ }).shape
1111
+ );
1090
1112
  var CreatedAction = ActionBase.extend(
1091
1113
  z15.object({
1092
1114
  type: z15.literal(ActionType.CREATE)
@@ -1155,6 +1177,8 @@ var ActionDocument = z15.discriminatedUnion("type", [
1155
1177
  MarkAsDuplicateAction.meta({ id: "MarkAsDuplicateAction" }),
1156
1178
  ArchiveAction.meta({ id: "ArchiveAction" }),
1157
1179
  UnarchiveAction.meta({ id: "UnarchiveAction" }),
1180
+ RevokeRegistrationAction.meta({ id: "RevokeRegistrationAction" }),
1181
+ ReinstateRegistrationAction.meta({ id: "ReinstateRegistrationAction" }),
1158
1182
  NotifiedAction.meta({ id: "NotifiedAction" }),
1159
1183
  RegisterAction.meta({ id: "RegisterAction" }),
1160
1184
  DeclareAction.meta({ id: "DeclareAction" }),
@@ -1203,11 +1227,15 @@ var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1203
1227
  var LegalStatuses = z16.object({
1204
1228
  [EventStatus.enum.NOTIFIED]: ActionCreationMetadata.nullish(),
1205
1229
  [EventStatus.enum.DECLARED]: ActionCreationMetadata.nullish(),
1206
- [EventStatus.enum.REGISTERED]: RegistrationCreationMetadata.nullish()
1230
+ [EventStatus.enum.REGISTERED]: RegistrationCreationMetadata.nullish(),
1231
+ [EventStatus.enum.REVOKED]: ActionCreationMetadata.nullish()
1207
1232
  });
1208
1233
  var EventMetadata = z16.object({
1209
1234
  id: UUID,
1210
1235
  type: z16.string().describe("The type of event, such as birth, death, or marriage."),
1236
+ configVersionId: z16.string().describe(
1237
+ "Id of the event configuration version the record was created under. Records created before versioning have 'initial'."
1238
+ ),
1211
1239
  status: EventStatus,
1212
1240
  legalStatuses: LegalStatuses.describe(
1213
1241
  "Metadata related to the legal registration of the event, such as who registered it and when."
@@ -1326,6 +1354,12 @@ var AnyOfStatus = import_v4.z.object({
1326
1354
  }).meta({
1327
1355
  id: "AnyOfStatus"
1328
1356
  });
1357
+ var NoneOfStatus = import_v4.z.object({
1358
+ type: import_v4.z.literal("noneOf"),
1359
+ terms: import_v4.z.array(EventStatus)
1360
+ }).meta({
1361
+ id: "NoneOfStatus"
1362
+ });
1329
1363
  var Range = import_v4.z.object({
1330
1364
  type: import_v4.z.literal("range"),
1331
1365
  gte: import_v4.z.string(),
@@ -1366,7 +1400,7 @@ var QueryInput = import_v4.z.lazy(
1366
1400
  var QueryExpression = import_v4.z.object({
1367
1401
  id: import_v4.z.optional(import_v4.z.string()),
1368
1402
  eventType: import_v4.z.string(),
1369
- status: import_v4.z.optional(import_v4.z.union([AnyOfStatus, ExactStatus])),
1403
+ status: import_v4.z.optional(import_v4.z.union([AnyOfStatus, NoneOfStatus, ExactStatus])),
1370
1404
  createdAt: import_v4.z.optional(DateCondition),
1371
1405
  updatedAt: import_v4.z.optional(DateCondition),
1372
1406
  "legalStatuses.DECLARED.createdAtLocation": import_v4.z.optional(Within).nullable(),
@@ -1375,6 +1409,7 @@ var QueryExpression = import_v4.z.object({
1375
1409
  "legalStatuses.REGISTERED.createdAtLocation": import_v4.z.optional(Within).nullable(),
1376
1410
  "legalStatuses.REGISTERED.createdByRole": import_v4.z.optional(AnyOf),
1377
1411
  "legalStatuses.REGISTERED.registrationNumber": import_v4.z.optional(Exact),
1412
+ "legalStatuses.REVOKED.createdAtLocation": import_v4.z.optional(Within).nullable(),
1378
1413
  createdAtLocation: import_v4.z.optional(import_v4.z.union([Within, Exact])),
1379
1414
  updatedAtLocation: import_v4.z.optional(import_v4.z.union([Within, Exact])),
1380
1415
  assignedTo: import_v4.z.optional(Exact),
@@ -2405,7 +2440,15 @@ var ClientConfig = z21.object({
2405
2440
  }).optional()
2406
2441
  })
2407
2442
  ),
2408
- FEATURES: z21.object({ V2_EVENTS: z21.boolean().optional().default(true) }).optional().default({ V2_EVENTS: true })
2443
+ FEATURES: z21.object({
2444
+ /**
2445
+ * @experimental The UI of this feature is not a supported feature in 2.2.
2446
+ * It can change, or be removed, without notice.
2447
+ */
2448
+ _EXPERIMENTAL_LEGACY_RECORDS: z21.boolean().optional().default(false).describe(
2449
+ "Experimental. Lets the user pick a past version of the event configuration when creating a record, for example to enter a record that was registered under an earlier form. The UI of this feature is not a supported feature in 2.2. It can change, or be removed, without notice."
2450
+ )
2451
+ }).optional().default({ _EXPERIMENTAL_LEGACY_RECORDS: false })
2409
2452
  });
2410
2453
  var defineClientConfig = (config) => {
2411
2454
  return ClientConfig.parse(config);
@@ -1,4 +1,4 @@
1
- import { Nominal } from './nominal';
1
+ import { Nominal } from '../nominal';
2
2
  import * as z from 'zod/v4';
3
3
  import { ScopeType, Scope, EncodedScope } from './scopes';
4
4
  export * from './scopes';
@@ -63,4 +63,5 @@ export declare const getUserTypeFromToken: (token: TokenWithBearer) => TokenUser
63
63
  export declare const TokenWithBearer: z.ZodType<`Bearer ${string}`>;
64
64
  export type TokenWithBearer = z.infer<typeof TokenWithBearer>;
65
65
  export type Token = Nominal<string, 'TokenWithoutBearer'>;
66
+ export declare function isTokenWithBearer(value: unknown): value is TokenWithBearer;
66
67
  //# sourceMappingURL=authentication.d.ts.map
@@ -48,8 +48,8 @@ __export(authentication_exports, {
48
48
  UserFilter: () => UserFilter,
49
49
  UserScopeV2: () => UserScopeV2,
50
50
  canUserCreateEvent: () => canUserCreateEvent,
51
+ canUserNotifyEvent: () => canUserNotifyEvent,
51
52
  decodeScope: () => decodeScope,
52
- defineRoles: () => defineRoles,
53
53
  defineScopes: () => defineScopes,
54
54
  encodeScope: () => encodeScope,
55
55
  getAcceptedScopesByType: () => getAcceptedScopesByType,
@@ -62,8 +62,10 @@ __export(authentication_exports, {
62
62
  getUserTypeFromToken: () => getUserTypeFromToken,
63
63
  hasAnyScope: () => hasAnyScope,
64
64
  hasScope: () => hasScope,
65
+ hasScopeForEventType: () => hasScopeForEventType,
65
66
  isCustomActionScope: () => isCustomActionScope,
66
67
  isServiceToken: () => isServiceToken,
68
+ isTokenWithBearer: () => isTokenWithBearer,
67
69
  scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
68
70
  scopeUsesFullOptions: () => scopeUsesFullOptions,
69
71
  scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
@@ -73,11 +75,11 @@ __export(authentication_exports, {
73
75
  module.exports = __toCommonJS(authentication_exports);
74
76
  var z9 = __toESM(require("zod/v4"));
75
77
 
76
- // ../commons/src/authentication.ts
78
+ // ../commons/src/users/authentication.ts
77
79
  var import_jwt_decode = __toESM(require("jwt-decode"));
78
80
  var z8 = __toESM(require("zod/v4"));
79
81
 
80
- // ../commons/src/scopes.ts
82
+ // ../commons/src/users/scopes.ts
81
83
  var z7 = __toESM(require("zod/v4"));
82
84
  var qs = __toESM(require("qs"));
83
85
 
@@ -110,6 +112,8 @@ var ActionType = {
110
112
  REQUEST_CORRECTION: "REQUEST_CORRECTION",
111
113
  REJECT_CORRECTION: "REJECT_CORRECTION",
112
114
  APPROVE_CORRECTION: "APPROVE_CORRECTION",
115
+ REVOKE_REGISTRATION: "REVOKE_REGISTRATION",
116
+ REINSTATE_REGISTRATION: "REINSTATE_REGISTRATION",
113
117
  // General actions
114
118
  READ: "READ",
115
119
  ASSIGN: "ASSIGN",
@@ -129,6 +133,8 @@ var ConfirmableActions = [
129
133
  ActionType.REQUEST_CORRECTION,
130
134
  ActionType.APPROVE_CORRECTION,
131
135
  ActionType.REJECT_CORRECTION,
136
+ ActionType.REVOKE_REGISTRATION,
137
+ ActionType.REINSTATE_REGISTRATION,
132
138
  ActionType.CUSTOM
133
139
  ];
134
140
  var ActionTypes = z2.enum([
@@ -148,6 +154,8 @@ var ActionTypes = z2.enum([
148
154
  "REQUEST_CORRECTION",
149
155
  "REJECT_CORRECTION",
150
156
  "APPROVE_CORRECTION",
157
+ "REVOKE_REGISTRATION",
158
+ "REINSTATE_REGISTRATION",
151
159
  "READ",
152
160
  "ASSIGN",
153
161
  "UNASSIGN",
@@ -186,7 +194,9 @@ var WorkqueueActionType = ActionTypes.extract([
186
194
  ActionType.ARCHIVE,
187
195
  ActionType.UNARCHIVE,
188
196
  ActionType.PRINT_CERTIFICATE,
189
- ActionType.REQUEST_CORRECTION
197
+ ActionType.REQUEST_CORRECTION,
198
+ ActionType.REVOKE_REGISTRATION,
199
+ ActionType.REINSTATE_REGISTRATION
190
200
  ]);
191
201
  var META_ACTIONS = [
192
202
  ActionType.ASSIGN,
@@ -202,7 +212,7 @@ var ActionStatus = {
202
212
  };
203
213
 
204
214
  // ../commons/src/events/Flag.ts
205
- var z5 = __toESM(require("zod/v4"));
215
+ var z5 = __toESM(require("zod"));
206
216
 
207
217
  // ../commons/src/events/TranslationConfig.ts
208
218
  var z3 = __toESM(require("zod/v4"));
@@ -271,7 +281,6 @@ var FieldConditional = z4.discriminatedUnion("type", [
271
281
 
272
282
  // ../commons/src/events/Flag.ts
273
283
  var InherentFlags = {
274
- INCOMPLETE: "incomplete",
275
284
  REJECTED: "rejected",
276
285
  CORRECTION_REQUESTED: "correction-requested",
277
286
  POTENTIAL_DUPLICATE: "potential-duplicate",
@@ -299,7 +308,7 @@ var CustomFlag = z5.string().refine((val) => !Object.values(InherentFlags).inclu
299
308
  message: `Custom flag cannot be one of the inherent flags: ${Object.values(
300
309
  InherentFlags
301
310
  ).join(", ")}`
302
- }).refine((val) => !ActionFlag.safeParse(val).success, {
311
+ }).refine((val) => !ActionFlag.validate(val), {
303
312
  message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
304
313
  }).describe("Custom flag identifier defined by the country config.");
305
314
  var Flag = ActionFlag.or(z5.enum(InherentFlags)).or(CustomFlag);
@@ -338,10 +347,11 @@ var EventStatus = z6.enum([
338
347
  "NOTIFIED",
339
348
  "DECLARED",
340
349
  "REGISTERED",
350
+ "REVOKED",
341
351
  "ARCHIVED"
342
352
  ]);
343
353
 
344
- // ../commons/src/scopes.ts
354
+ // ../commons/src/users/scopes.ts
345
355
  var JurisdictionFilter = z7.enum(["administrativeArea", "location", "all"]).describe(
346
356
  "Filters based on user jurisdiction relative to their office location in hierarchy."
347
357
  );
@@ -361,6 +371,8 @@ var RecordScopeTypeV2 = z7.enum([
361
371
  "record.print-certified-copies",
362
372
  "record.request-correction",
363
373
  "record.correct",
374
+ "record.revoke-registration",
375
+ "record.reinstate-registration",
364
376
  "record.unassign-others",
365
377
  "record.custom-action",
366
378
  "record.action.accept",
@@ -487,6 +499,8 @@ var ScopesWithFullOptions = RecordScopeTypeV2.extract([
487
499
  "record.read",
488
500
  "record.request-correction",
489
501
  "record.correct",
502
+ "record.revoke-registration",
503
+ "record.reinstate-registration",
490
504
  "record.unassign-others",
491
505
  "record.review-duplicates"
492
506
  ]);
@@ -691,9 +705,9 @@ function hasScope(tokenOrScopes, scope) {
691
705
  }
692
706
  return hasAnyScope(tokenOrScopes, [scope]);
693
707
  }
694
- function canUserCreateEvent(userScopes, eventType) {
708
+ function hasScopeForEventType(userScopes, eventType, acceptedScope) {
695
709
  const scopes = getAcceptedScopesByType({
696
- acceptedScopes: ["record.create"],
710
+ acceptedScopes: [acceptedScope],
697
711
  scopes: userScopes
698
712
  });
699
713
  return scopes.some((scope) => {
@@ -703,14 +717,17 @@ function canUserCreateEvent(userScopes, eventType) {
703
717
  return scope.options?.event?.includes(eventType);
704
718
  });
705
719
  }
720
+ function canUserCreateEvent(userScopes, eventType) {
721
+ return hasScopeForEventType(userScopes, eventType, "record.create");
722
+ }
723
+ function canUserNotifyEvent(userScopes, eventType) {
724
+ return hasScopeForEventType(userScopes, eventType, "record.notify");
725
+ }
706
726
  function defineScopes(scopes) {
707
727
  return scopes.map((scope) => Scope.parse(scope)).map(encodeScope);
708
728
  }
709
- function defineRoles(roles) {
710
- return roles;
711
- }
712
729
 
713
- // ../commons/src/authentication.ts
730
+ // ../commons/src/users/authentication.ts
714
731
  function getAcceptedScopesFromToken(token, acceptedScopes) {
715
732
  const tokenScopes = getScopes(token);
716
733
  return tokenScopes.map((scope) => {
@@ -760,6 +777,9 @@ var getUserTypeFromToken = (token) => {
760
777
  return TokenUserType.parse(tokenPayload.userType);
761
778
  };
762
779
  var TokenWithBearer = z8.string().regex(/^Bearer\s/);
780
+ function isTokenWithBearer(value) {
781
+ return TokenWithBearer.validate(value);
782
+ }
763
783
 
764
784
  // src/authentication/index.ts
765
785
  z9.globalRegistry.clear();