@opencrvs/toolkit 2.0.0-rc.f281551 → 2.0.0-rc.f3b5471

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 (95) hide show
  1. package/create-countryconfig/index.js +73 -0
  2. package/create-countryconfig/package.json +11 -0
  3. package/dist/application-config/index.js +54 -36
  4. package/dist/cli.js +1949 -346
  5. package/dist/commons/api/router.d.ts +3335 -273
  6. package/dist/commons/application-config/index.d.ts +16 -4
  7. package/dist/commons/conditionals/conditionals.d.ts +6 -6
  8. package/dist/commons/conditionals/validate.d.ts +1 -0
  9. package/dist/commons/events/ActionInput.d.ts +108 -0
  10. package/dist/commons/events/Draft.d.ts +3 -0
  11. package/dist/commons/events/EventIndex.d.ts +0 -3
  12. package/dist/commons/events/EventMetadata.d.ts +0 -7
  13. package/dist/commons/events/FieldConfig.d.ts +10 -0
  14. package/dist/commons/events/locations.d.ts +38 -1
  15. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  16. package/dist/commons/events/scopes.d.ts +24 -1
  17. package/dist/commons/events/state/index.d.ts +0 -4
  18. package/dist/commons/events/state/utils.d.ts +0 -2
  19. package/dist/commons/events/utils.d.ts +1 -1
  20. package/dist/conditionals/index.js +37 -7
  21. package/dist/events/index.js +159 -62
  22. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  23. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +63 -39
  24. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +3 -0
  25. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +1 -0
  26. package/dist/migrations/v2.0/add-resend-invite-notification.js +373 -0
  27. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +19 -0
  28. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  29. package/dist/migrations/v2.0/checkout-upstream-files.js +17 -14
  30. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -1
  31. package/dist/migrations/v2.0/convert-config-files-to-ts.js +4 -5
  32. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -1
  33. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +4 -5
  34. package/dist/migrations/v2.0/create-events-index.d.ts.map +1 -1
  35. package/dist/migrations/v2.0/create-events-index.js +1 -2
  36. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +11 -0
  37. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -0
  38. package/dist/migrations/v2.0/delete-infrastructure-directory.js +123 -0
  39. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  40. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  41. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  42. package/dist/migrations/v2.0/index.d.ts +10 -4
  43. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  44. package/dist/migrations/v2.0/index.js +1917 -343
  45. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  46. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +95 -7
  47. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +13 -0
  48. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -0
  49. package/dist/migrations/v2.0/merge-infrastructure-directory.js +222 -0
  50. package/dist/migrations/v2.0/migrate-application-config-url.d.ts +3 -0
  51. package/dist/migrations/v2.0/migrate-application-config-url.d.ts.map +1 -0
  52. package/dist/migrations/v2.0/migrate-application-config-url.js +342 -0
  53. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  54. package/dist/migrations/v2.0/migrate-scopes.js +55 -32
  55. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -1
  56. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +3 -4
  57. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  58. package/dist/migrations/v2.0/migrate-workqueue-configs.js +143 -63
  59. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -1
  60. package/dist/migrations/v2.0/remove-delete-actions.js +3 -4
  61. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -1
  62. package/dist/migrations/v2.0/remove-demo-scope.js +2 -3
  63. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -1
  64. package/dist/migrations/v2.0/remove-deprecated-imports.js +3 -4
  65. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts +3 -0
  66. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts.map +1 -0
  67. package/dist/migrations/v2.0/remove-fhir-url-helpers.js +163 -0
  68. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -1
  69. package/dist/migrations/v2.0/remove-hearth-migrations.js +1 -2
  70. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts +3 -0
  71. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts.map +1 -0
  72. package/dist/migrations/v2.0/remove-old-statistics-service.js +356 -0
  73. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -1
  74. package/dist/migrations/v2.0/remove-pending-certification-flag.js +3 -4
  75. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -1
  76. package/dist/migrations/v2.0/remove-review-from-register-action.js +3 -4
  77. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts +3 -0
  78. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts.map +1 -0
  79. package/dist/migrations/v2.0/remove-unused-environment-variables.js +186 -0
  80. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -1
  81. package/dist/migrations/v2.0/rename-api-paths.js +3 -4
  82. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -1
  83. package/dist/migrations/v2.0/rename-location-parent-id.js +3 -4
  84. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +1 -1
  85. package/dist/migrations/v2.0/simplify-analytics-precalculations.js +1 -2
  86. package/dist/migrations/v2.0/update-package-json.d.ts +3 -0
  87. package/dist/migrations/v2.0/update-package-json.d.ts.map +1 -0
  88. package/dist/migrations/v2.0/update-package-json.js +105 -0
  89. package/dist/notification/index.js +53 -32
  90. package/dist/scopes/index.d.ts +87 -10
  91. package/dist/scopes/index.js +43 -8
  92. package/opencrvs-toolkit-2.0.0-rc.f3b5471.tgz +0 -0
  93. package/package.json +1 -1
  94. package/tsconfig.tsbuildinfo +1 -1
  95. package/opencrvs-toolkit-2.0.0-rc.f281551.tgz +0 -0
@@ -0,0 +1,73 @@
1
+ #!/usr/bin/env node
2
+
3
+ /*
4
+ * This Source Code Form is subject to the terms of the Mozilla Public
5
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
6
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
7
+ *
8
+ * OpenCRVS is also distributed under the terms of the Civil Registration
9
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
10
+ *
11
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
12
+ */
13
+
14
+ const { execSync } = require('child_process')
15
+ const path = require('path')
16
+ const fs = require('fs')
17
+
18
+ const REPO_URL = 'https://github.com/opencrvs/opencrvs-countryconfig.git'
19
+
20
+ const projectName = process.argv[2]
21
+
22
+ if (!projectName) {
23
+ console.error(
24
+ 'Please specify a project name:\n\n npm create @opencrvs/countryconfig <project-name>\n'
25
+ )
26
+ process.exit(1)
27
+ }
28
+
29
+ const targetDir = path.resolve(process.cwd(), projectName)
30
+
31
+ if (fs.existsSync(targetDir)) {
32
+ console.error(`Error: Directory "${projectName}" already exists.`)
33
+ process.exit(1)
34
+ }
35
+
36
+ console.log(`\nScaffolding OpenCRVS country config in ./${projectName}...\n`)
37
+
38
+ try {
39
+ execSync(`git clone --depth 1 ${REPO_URL} ${projectName}`, {
40
+ stdio: 'inherit'
41
+ })
42
+ } catch (err) {
43
+ console.error('Failed to clone the repository:', err.message)
44
+ process.exit(1)
45
+ }
46
+
47
+ try {
48
+ fs.rmSync(path.join(targetDir, '.git'), { recursive: true, force: true })
49
+ } catch (err) {
50
+ console.error('Failed to remove .git directory:', err.message)
51
+ process.exit(1)
52
+ }
53
+
54
+ const pkgPath = path.join(targetDir, 'package.json')
55
+ if (fs.existsSync(pkgPath)) {
56
+ try {
57
+ const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
58
+ pkg.name = projectName
59
+ fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
60
+ } catch (err) {
61
+ console.error('Failed to update package.json:', err.message)
62
+ process.exit(1)
63
+ }
64
+ } else {
65
+ console.warn(
66
+ `Warning: No package.json found in the cloned repository. Project name was not updated.`
67
+ )
68
+ }
69
+
70
+ console.log(`\nDone! To get started:\n`)
71
+ console.log(` cd ${projectName}`)
72
+ console.log(` git init`)
73
+ console.log(` npm install\n`)
@@ -0,0 +1,11 @@
1
+ {
2
+ "name": "@opencrvs/create-countryconfig",
3
+ "version": "1.0.0",
4
+ "description": "Scaffold a new OpenCRVS country configuration",
5
+ "bin": {
6
+ "create-countryconfig": "./index.js"
7
+ },
8
+ "files": ["index.js"],
9
+ "keywords": ["opencrvs", "countryconfig", "create"],
10
+ "license": "MPL-2.0"
11
+ }
@@ -418,28 +418,20 @@ function schemaPriority(schema) {
418
418
  return idx === -1 ? 9999 : idx;
419
419
  }
420
420
  function safeUnion(schemas) {
421
+ const sortedSchemas = [...schemas].sort(
422
+ (a, b) => schemaPriority(a) - schemaPriority(b)
423
+ );
421
424
  return z7.any().superRefine((val, ctx) => {
422
- const successful = schemas.filter((s) => s.safeParse(val).success);
423
- if (successful.length === 1) {
424
- return;
425
- }
426
- if (successful.length === 0) {
427
- ctx.addIssue({
428
- code: "invalid_type",
429
- expected: "custom",
430
- message: "Value does not match any schema"
431
- });
432
- return;
433
- }
434
- successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
435
- const best = successful[0];
436
- if (!best.safeParse(val).success) {
437
- ctx.addIssue({
438
- expected: "custom",
439
- code: "invalid_type",
440
- message: "Value did not match the best schema"
441
- });
425
+ for (const schema of sortedSchemas) {
426
+ if (schema.safeParse(val).success) {
427
+ return;
428
+ }
442
429
  }
430
+ ctx.addIssue({
431
+ code: "invalid_type",
432
+ expected: "custom",
433
+ message: "Value does not match any schema"
434
+ });
443
435
  }).meta({
444
436
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
445
437
  });
@@ -656,6 +648,10 @@ var scopeByEvent = z11.preprocess(
656
648
  (val) => val === void 0 ? void 0 : [val].flat(),
657
649
  z11.array(z11.string()).optional()
658
650
  ).describe("Event type, e.g. birth, death");
651
+ var userRole = z11.preprocess(
652
+ (val) => val === void 0 ? void 0 : [val].flat(),
653
+ z11.array(z11.string()).optional()
654
+ ).describe("User role, e.g. admin, field agent");
659
655
  var scopeOptionsPlaceEvent = z11.object({
660
656
  event: scopeByEvent,
661
657
  placeOfEvent: JurisdictionFilter.optional()
@@ -679,6 +675,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
679
675
  var AccessLevelOptions = z11.object({
680
676
  accessLevel: JurisdictionFilter.optional()
681
677
  });
678
+ var AllUserScopeOptions = AccessLevelOptions.extend({
679
+ role: userRole.optional()
680
+ });
682
681
  var WorkqueueOrDashboardOptions = z11.object({
683
682
  ids: z11.preprocess(
684
683
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -688,6 +687,7 @@ var WorkqueueOrDashboardOptions = z11.object({
688
687
  var AllScopeOptions = z11.object({
689
688
  ...AllRecordScopeOptions.shape,
690
689
  ...AccessLevelOptions.shape,
690
+ ...AllUserScopeOptions.shape,
691
691
  ...WorkqueueOrDashboardOptions.shape
692
692
  });
693
693
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -760,6 +760,30 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
760
760
  ]).describe(
761
761
  "Scopes used to check user's permission to perform actions on a record."
762
762
  );
763
+ var SystemScopeType = z11.enum([
764
+ "organisation.read-locations",
765
+ "user.read",
766
+ "user.create",
767
+ "user.edit",
768
+ "user.search"
769
+ ]);
770
+ var UserScopeType = SystemScopeType.extract([
771
+ "user.read",
772
+ "user.create",
773
+ "user.edit",
774
+ "user.search"
775
+ ]);
776
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
777
+ var UserScopeV2 = z11.discriminatedUnion("type", [
778
+ z11.object({
779
+ type: ScopesWithRoleOption,
780
+ options: AllUserScopeOptions.optional()
781
+ }),
782
+ z11.object({
783
+ type: UserScopeType.extract(["user.read", "user.search"]),
784
+ options: AccessLevelOptions.optional()
785
+ })
786
+ ]);
763
787
  var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
764
788
  z11.object({
765
789
  type: ScopesWithPlaceEventOptions,
@@ -780,16 +804,14 @@ var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
780
804
  }).optional()
781
805
  })
782
806
  ]).describe("Resolved scope with location/user IDs instead of filters.");
783
- var SystemScopeType = z11.enum([
784
- "organisation.read-locations",
785
- "user.read",
786
- "user.create",
787
- "user.edit"
788
- ]);
789
807
  var Scope = z11.discriminatedUnion("type", [
790
808
  z11.object({ type: PlainScopeType }),
791
809
  ...RecordScopeV2.options,
792
- z11.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
810
+ ...UserScopeV2.options,
811
+ z11.object({
812
+ type: z11.literal("organisation.read-locations"),
813
+ options: AccessLevelOptions.optional()
814
+ }),
793
815
  z11.object({
794
816
  type: z11.literal("workqueue"),
795
817
  options: WorkqueueOrDashboardOptions
@@ -1083,8 +1105,7 @@ var ActionCreationMetadata = z15.object({
1083
1105
  ),
1084
1106
  createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1085
1107
  acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
1086
- createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
1087
- createdBySignature: z15.string().nullish().describe("Signature of the user who created the action request.")
1108
+ createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
1088
1109
  });
1089
1110
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1090
1111
  registrationNumber: z15.string().describe(
@@ -1112,9 +1133,6 @@ var EventMetadata = z15.object({
1112
1133
  createdAtLocation: UUID.nullish().describe(
1113
1134
  "Location of the user who created the event."
1114
1135
  ),
1115
- createdBySignature: DocumentPath.nullish().describe(
1116
- "Signature of the user who created the event."
1117
- ),
1118
1136
  updatedAtLocation: UUID.nullish().describe(
1119
1137
  "Location of the user who last changed the status."
1120
1138
  ),
@@ -2078,8 +2096,8 @@ var ApplicationConfig = z20.object({
2078
2096
  })
2079
2097
  ),
2080
2098
  PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
2081
- USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2082
- INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2099
+ USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2100
+ INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2083
2101
  SEARCH_DEFAULT_CRITERIA: SearchCriteria.optional().default("TRACKING_ID"),
2084
2102
  ADDITIONAL_USER_FIELDS: z20.array(FieldConfig).optional().default([])
2085
2103
  });
@@ -2097,8 +2115,8 @@ var BackgroundConfig = z20.object({
2097
2115
  var LoginConfig = z20.object({
2098
2116
  COUNTRY: z20.string(),
2099
2117
  LANGUAGES: z20.array(z20.string()),
2100
- USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2101
- INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2118
+ USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2119
+ INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2102
2120
  PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
2103
2121
  LOGIN_BACKGROUND: BackgroundConfig,
2104
2122
  SENTRY: z20.string().optional()