@opencrvs/toolkit 2.2.0-rc.9042a13 → 2.2.0-rc.9dfc125

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 (141) hide show
  1. package/build.sh +2 -12
  2. package/dist/application-config/index.js +12 -7
  3. package/dist/authentication/index.d.ts +1 -0
  4. package/dist/authentication/index.js +16 -5
  5. package/dist/cli.js +875 -193
  6. package/dist/commons/api/router.d.ts +252 -246
  7. package/dist/commons/application-config/index.d.ts +2 -2
  8. package/dist/commons/conditionals/index.d.ts +1 -0
  9. package/dist/commons/conditionals/validate.d.ts +5 -0
  10. package/dist/commons/events/ActionConfig.d.ts +16 -23
  11. package/dist/commons/events/ActionDocument.d.ts +1 -0
  12. package/dist/commons/events/ActionInput.d.ts +4 -4
  13. package/dist/commons/events/CompositeFieldValue.d.ts +5 -1
  14. package/dist/commons/events/CountryConfigQueryInput.d.ts +60 -18
  15. package/dist/commons/events/EventConfig.d.ts +12 -2
  16. package/dist/commons/events/EventIndex.d.ts +23 -6
  17. package/dist/commons/events/EventMetadata.d.ts +0 -1
  18. package/dist/commons/events/FieldConfig.d.ts +1 -1
  19. package/dist/commons/events/FieldTypeMapping.d.ts +6 -6
  20. package/dist/commons/events/Flag.d.ts +1 -7
  21. package/dist/commons/events/PlainDate.d.ts +1 -0
  22. package/dist/commons/events/WorkqueueConfig.d.ts +74 -27
  23. package/dist/commons/events/eventConfigValidation.d.ts +9 -0
  24. package/dist/commons/events/index.d.ts +2 -0
  25. package/dist/commons/events/notificationFormFallback.d.ts +10 -0
  26. package/dist/commons/events/state/flags.d.ts +1 -1
  27. package/dist/commons/events/test.utils.d.ts +3 -0
  28. package/dist/commons/events/utils.d.ts +85 -56
  29. package/dist/conditionals/index.js +2 -3
  30. package/dist/environment/custom-types.d.ts +1 -0
  31. package/dist/environment/custom-types.d.ts.map +1 -1
  32. package/dist/environment/derived-variables.d.ts +12 -4
  33. package/dist/environment/derived-variables.d.ts.map +1 -1
  34. package/dist/environment/derived-variables.js +13 -4
  35. package/dist/environment/questions.d.ts +14 -2
  36. package/dist/environment/questions.d.ts.map +1 -1
  37. package/dist/environment/questions.js +40 -19
  38. package/dist/environment/registry.d.ts +15 -0
  39. package/dist/environment/registry.d.ts.map +1 -0
  40. package/dist/environment/registry.js +112 -0
  41. package/dist/environment/setup-environment.d.ts.map +1 -1
  42. package/dist/environment/setup-environment.js +111 -24
  43. package/dist/environment/templates.d.ts.map +1 -1
  44. package/dist/events/index.js +251 -67
  45. package/dist/migrations/index.d.ts +9 -0
  46. package/dist/migrations/index.d.ts.map +1 -0
  47. package/dist/migrations/index.js +847 -0
  48. package/dist/migrations/move-declaration-to-declare-action.d.ts +38 -0
  49. package/dist/migrations/move-declaration-to-declare-action.d.ts.map +1 -0
  50. package/dist/migrations/move-declaration-to-declare-action.js +377 -0
  51. package/dist/migrations/{add-translations.d.ts → persistent/add-translations.d.ts} +1 -1
  52. package/dist/migrations/persistent/add-translations.d.ts.map +1 -0
  53. package/dist/migrations/{add-translations.js → persistent/add-translations.js} +2 -2
  54. package/dist/migrations/persistent/check-upgrade-path.d.ts +36 -0
  55. package/dist/migrations/persistent/check-upgrade-path.d.ts.map +1 -0
  56. package/dist/migrations/persistent/check-upgrade-path.js +105 -0
  57. package/dist/migrations/persistent/update-toolkit-dependency.d.ts +7 -0
  58. package/dist/migrations/persistent/update-toolkit-dependency.d.ts.map +1 -0
  59. package/dist/migrations/persistent/update-toolkit-dependency.js +77 -0
  60. package/dist/migrations/{v2.2/read-declaration-through-helper.d.ts → read-declaration-through-helper.d.ts} +1 -1
  61. package/dist/migrations/read-declaration-through-helper.d.ts.map +1 -0
  62. package/dist/migrations/{v2.2/read-declaration-through-helper.js → read-declaration-through-helper.js} +1 -1
  63. package/dist/migrations/replace-incomplete-flag.d.ts +26 -0
  64. package/dist/migrations/replace-incomplete-flag.d.ts.map +1 -0
  65. package/dist/migrations/replace-incomplete-flag.js +126 -0
  66. package/dist/notification/index.js +151 -21
  67. package/dist/scopes/index.d.ts +54 -84
  68. package/dist/scopes/index.js +12 -5
  69. package/dist/templates/charts-values/dependencies/values.yaml +1 -1
  70. package/dist/templates/charts-values/opencrvs-services/values.yaml +4 -6
  71. package/dist/templates/charts-values/traefik/values.yaml +2 -0
  72. package/opencrvs-toolkit-2.2.0-rc.9dfc125.tgz +0 -0
  73. package/package.json +2 -2
  74. package/tsconfig.build.tsbuildinfo +1 -1
  75. package/dist/migrations/add-translations.d.ts.map +0 -1
  76. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +0 -3
  77. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +0 -1
  78. package/dist/migrations/v2.1/add-explicit-correction-flags.js +0 -234
  79. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +0 -3
  80. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +0 -1
  81. package/dist/migrations/v2.1/add-recovery-link-notifications.js +0 -511
  82. package/dist/migrations/v2.1/enable-telemetry.d.ts +0 -3
  83. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +0 -1
  84. package/dist/migrations/v2.1/enable-telemetry.js +0 -455
  85. package/dist/migrations/v2.1/index.d.ts +0 -6
  86. package/dist/migrations/v2.1/index.d.ts.map +0 -1
  87. package/dist/migrations/v2.1/index.js +0 -50
  88. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts +0 -17
  89. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts.map +0 -1
  90. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.js +0 -348
  91. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts +0 -2
  92. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts.map +0 -1
  93. package/dist/migrations/v2.1/remove-metabase-package-installs.js +0 -161
  94. package/dist/migrations/v2.1/remove-sentry.d.ts +0 -3
  95. package/dist/migrations/v2.1/remove-sentry.d.ts.map +0 -1
  96. package/dist/migrations/v2.1/remove-sentry.js +0 -354
  97. package/dist/migrations/v2.1/rename-trigger-paths.d.ts +0 -3
  98. package/dist/migrations/v2.1/rename-trigger-paths.d.ts.map +0 -1
  99. package/dist/migrations/v2.1/rename-trigger-paths.js +0 -216
  100. package/dist/migrations/v2.1/template-files.d.ts +0 -8
  101. package/dist/migrations/v2.1/template-files.d.ts.map +0 -1
  102. package/dist/migrations/v2.1/template-files.js +0 -49
  103. package/dist/migrations/v2.1/upgrade-tilt.d.ts +0 -11
  104. package/dist/migrations/v2.1/upgrade-tilt.d.ts.map +0 -1
  105. package/dist/migrations/v2.1/upgrade-tilt.js +0 -139
  106. package/dist/migrations/v2.2/index.d.ts +0 -6
  107. package/dist/migrations/v2.2/index.d.ts.map +0 -1
  108. package/dist/migrations/v2.2/index.js +0 -456
  109. package/dist/migrations/v2.2/read-declaration-through-helper.d.ts.map +0 -1
  110. package/dist/templates/countryconfig-template/.tiltignore +0 -1
  111. package/dist/templates/countryconfig-template/Dockerfile.assets +0 -7
  112. package/dist/templates/countryconfig-template/Tiltfile +0 -112
  113. package/dist/templates/countryconfig-template/assets/README.md +0 -1
  114. package/dist/templates/countryconfig-template/assets/clear-all-data-dev.sh +0 -61
  115. package/dist/templates/countryconfig-template/assets/deployment/deploy.sh +0 -455
  116. package/dist/templates/countryconfig-template/assets/deployment/reindex.sh +0 -168
  117. package/dist/templates/countryconfig-template/assets/deployment/validate-required-variables-in-compose-files.ts +0 -67
  118. package/dist/templates/countryconfig-template/assets/elasticsearch/reindex.sh +0 -168
  119. package/dist/templates/countryconfig-template/assets/metabase/README.md +0 -34
  120. package/dist/templates/countryconfig-template/assets/metabase/environment-configuration.sql +0 -36
  121. package/dist/templates/countryconfig-template/assets/metabase/initialize-database.sh +0 -46
  122. package/dist/templates/countryconfig-template/assets/metabase/metabase.init.db.sql +0 -27737
  123. package/dist/templates/countryconfig-template/assets/metabase/open-shell.sh +0 -21
  124. package/dist/templates/countryconfig-template/assets/metabase/package.json +0 -13
  125. package/dist/templates/countryconfig-template/assets/metabase/run-dev.sh +0 -108
  126. package/dist/templates/countryconfig-template/assets/metabase/run.sh +0 -120
  127. package/dist/templates/countryconfig-template/assets/metabase/update-database.sh +0 -40
  128. package/dist/templates/countryconfig-template/assets/postgres/setup-analytics.sh +0 -135
  129. package/dist/templates/countryconfig-template/assets/postgres/setup-reference-data.sh +0 -108
  130. package/dist/templates/countryconfig-template/tilt/clear-all-data.ps1 +0 -50
  131. package/dist/templates/countryconfig-template/tilt/clear-all-data.sh +0 -35
  132. package/dist/templates/countryconfig-template/tilt/common.tilt +0 -145
  133. package/dist/templates/countryconfig-template/tilt/examples/dependencies/values.yaml +0 -15
  134. package/dist/templates/countryconfig-template/tilt/examples/opencrvs-services/values.yaml +0 -56
  135. package/dist/templates/countryconfig-template/tilt/examples/traefik/values-minikube.yaml +0 -21
  136. package/dist/templates/countryconfig-template/tilt/examples/traefik/values.yaml +0 -38
  137. package/dist/templates/countryconfig-template/tilt/helm/dependencies/values.yaml +0 -17
  138. package/dist/templates/countryconfig-template/tilt/helm/opencrvs-services/values.yaml +0 -16
  139. package/dist/templates/countryconfig-template/tilt/lib.tilt +0 -95
  140. package/dist/templates/countryconfig-template/tilt/opencrvs.tilt +0 -136
  141. package/opencrvs-toolkit-2.2.0-rc.9042a13.tgz +0 -0
package/build.sh CHANGED
@@ -59,8 +59,8 @@ mkdir -p ./dist/commons/application-config
59
59
  cp -r ../commons/build/dist/common/application-config.d.ts ./dist/commons/application-config/index.d.ts
60
60
 
61
61
  # Build migration CLI
62
- npx esbuild src/migrations/v2.2/index.ts --bundle --platform=node --format=cjs --outdir=./dist/migrations/v2.2 --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
63
- chmod +x ./dist/migrations/v2.2/index.js
62
+ npx esbuild src/migrations/index.ts --bundle --platform=node --format=cjs --outdir=./dist/migrations --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
63
+ chmod +x ./dist/migrations/index.js
64
64
 
65
65
  if [[ "$OSTYPE" == "darwin"* ]]; then
66
66
  sed -i '' 's|@opencrvs/events/build/types|../commons/api|g' dist/api/index.d.ts
@@ -73,16 +73,6 @@ fi
73
73
  # Build CLI
74
74
  npx esbuild src/cli.ts --bundle --platform=node --format=cjs --outdir=./dist --allow-overwrite --packages=external --banner:js="#!/usr/bin/env node"
75
75
  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
76
  chmod +x ./dist/cli.js
87
77
 
88
78
  echo "Build completed successfully."
@@ -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
  }
@@ -635,9 +635,8 @@ var ActionStatus = {
635
635
  };
636
636
 
637
637
  // ../commons/src/events/Flag.ts
638
- var z11 = __toESM(require("zod/v4"));
638
+ var z11 = __toESM(require("zod"));
639
639
  var InherentFlags = {
640
- INCOMPLETE: "incomplete",
641
640
  REJECTED: "rejected",
642
641
  CORRECTION_REQUESTED: "correction-requested",
643
642
  POTENTIAL_DUPLICATE: "potential-duplicate",
@@ -665,7 +664,7 @@ var CustomFlag = z11.string().refine((val) => !Object.values(InherentFlags).incl
665
664
  message: `Custom flag cannot be one of the inherent flags: ${Object.values(
666
665
  InherentFlags
667
666
  ).join(", ")}`
668
- }).refine((val) => !ActionFlag.safeParse(val).success, {
667
+ }).refine((val) => !ActionFlag.validate(val), {
669
668
  message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
670
669
  }).describe("Custom flag identifier defined by the country config.");
671
670
  var Flag = ActionFlag.or(z11.enum(InherentFlags)).or(CustomFlag);
@@ -1352,6 +1351,12 @@ var AnyOfStatus = import_v4.z.object({
1352
1351
  }).meta({
1353
1352
  id: "AnyOfStatus"
1354
1353
  });
1354
+ var NoneOfStatus = import_v4.z.object({
1355
+ type: import_v4.z.literal("noneOf"),
1356
+ terms: import_v4.z.array(EventStatus)
1357
+ }).meta({
1358
+ id: "NoneOfStatus"
1359
+ });
1355
1360
  var Range = import_v4.z.object({
1356
1361
  type: import_v4.z.literal("range"),
1357
1362
  gte: import_v4.z.string(),
@@ -1392,7 +1397,7 @@ var QueryInput = import_v4.z.lazy(
1392
1397
  var QueryExpression = import_v4.z.object({
1393
1398
  id: import_v4.z.optional(import_v4.z.string()),
1394
1399
  eventType: import_v4.z.string(),
1395
- status: import_v4.z.optional(import_v4.z.union([AnyOfStatus, ExactStatus])),
1400
+ status: import_v4.z.optional(import_v4.z.union([AnyOfStatus, NoneOfStatus, ExactStatus])),
1396
1401
  createdAt: import_v4.z.optional(DateCondition),
1397
1402
  updatedAt: import_v4.z.optional(DateCondition),
1398
1403
  "legalStatuses.DECLARED.createdAtLocation": import_v4.z.optional(Within).nullable(),
@@ -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,6 +48,7 @@ __export(authentication_exports, {
48
48
  UserFilter: () => UserFilter,
49
49
  UserScopeV2: () => UserScopeV2,
50
50
  canUserCreateEvent: () => canUserCreateEvent,
51
+ canUserNotifyEvent: () => canUserNotifyEvent,
51
52
  decodeScope: () => decodeScope,
52
53
  defineRoles: () => defineRoles,
53
54
  defineScopes: () => defineScopes,
@@ -62,8 +63,10 @@ __export(authentication_exports, {
62
63
  getUserTypeFromToken: () => getUserTypeFromToken,
63
64
  hasAnyScope: () => hasAnyScope,
64
65
  hasScope: () => hasScope,
66
+ hasScopeForEventType: () => hasScopeForEventType,
65
67
  isCustomActionScope: () => isCustomActionScope,
66
68
  isServiceToken: () => isServiceToken,
69
+ isTokenWithBearer: () => isTokenWithBearer,
67
70
  scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
68
71
  scopeUsesFullOptions: () => scopeUsesFullOptions,
69
72
  scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
@@ -210,7 +213,7 @@ var ActionStatus = {
210
213
  };
211
214
 
212
215
  // ../commons/src/events/Flag.ts
213
- var z5 = __toESM(require("zod/v4"));
216
+ var z5 = __toESM(require("zod"));
214
217
 
215
218
  // ../commons/src/events/TranslationConfig.ts
216
219
  var z3 = __toESM(require("zod/v4"));
@@ -279,7 +282,6 @@ var FieldConditional = z4.discriminatedUnion("type", [
279
282
 
280
283
  // ../commons/src/events/Flag.ts
281
284
  var InherentFlags = {
282
- INCOMPLETE: "incomplete",
283
285
  REJECTED: "rejected",
284
286
  CORRECTION_REQUESTED: "correction-requested",
285
287
  POTENTIAL_DUPLICATE: "potential-duplicate",
@@ -307,7 +309,7 @@ var CustomFlag = z5.string().refine((val) => !Object.values(InherentFlags).inclu
307
309
  message: `Custom flag cannot be one of the inherent flags: ${Object.values(
308
310
  InherentFlags
309
311
  ).join(", ")}`
310
- }).refine((val) => !ActionFlag.safeParse(val).success, {
312
+ }).refine((val) => !ActionFlag.validate(val), {
311
313
  message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
312
314
  }).describe("Custom flag identifier defined by the country config.");
313
315
  var Flag = ActionFlag.or(z5.enum(InherentFlags)).or(CustomFlag);
@@ -704,9 +706,9 @@ function hasScope(tokenOrScopes, scope) {
704
706
  }
705
707
  return hasAnyScope(tokenOrScopes, [scope]);
706
708
  }
707
- function canUserCreateEvent(userScopes, eventType) {
709
+ function hasScopeForEventType(userScopes, eventType, acceptedScope) {
708
710
  const scopes = getAcceptedScopesByType({
709
- acceptedScopes: ["record.create"],
711
+ acceptedScopes: [acceptedScope],
710
712
  scopes: userScopes
711
713
  });
712
714
  return scopes.some((scope) => {
@@ -716,6 +718,12 @@ function canUserCreateEvent(userScopes, eventType) {
716
718
  return scope.options?.event?.includes(eventType);
717
719
  });
718
720
  }
721
+ function canUserCreateEvent(userScopes, eventType) {
722
+ return hasScopeForEventType(userScopes, eventType, "record.create");
723
+ }
724
+ function canUserNotifyEvent(userScopes, eventType) {
725
+ return hasScopeForEventType(userScopes, eventType, "record.notify");
726
+ }
719
727
  function defineScopes(scopes) {
720
728
  return scopes.map((scope) => Scope.parse(scope)).map(encodeScope);
721
729
  }
@@ -773,6 +781,9 @@ var getUserTypeFromToken = (token) => {
773
781
  return TokenUserType.parse(tokenPayload.userType);
774
782
  };
775
783
  var TokenWithBearer = z8.string().regex(/^Bearer\s/);
784
+ function isTokenWithBearer(value) {
785
+ return TokenWithBearer.validate(value);
786
+ }
776
787
 
777
788
  // src/authentication/index.ts
778
789
  z9.globalRegistry.clear();