@opencrvs/toolkit 2.0.0-rc.a456517 → 2.0.0-rc.a657c77

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 (84) 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 +41 -11
  4. package/dist/cli.js +1784 -349
  5. package/dist/commons/api/router.d.ts +55 -54
  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/events/FieldConfig.d.ts +10 -0
  9. package/dist/commons/events/locations.d.ts +38 -1
  10. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  11. package/dist/commons/events/scopes.d.ts +24 -1
  12. package/dist/conditionals/index.js +37 -7
  13. package/dist/events/index.js +130 -7
  14. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  15. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +63 -39
  16. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +3 -0
  17. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +1 -0
  18. package/dist/migrations/v2.0/add-resend-invite-notification.js +373 -0
  19. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +19 -0
  20. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  21. package/dist/migrations/v2.0/checkout-upstream-files.js +17 -14
  22. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -1
  23. package/dist/migrations/v2.0/convert-config-files-to-ts.js +4 -5
  24. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -1
  25. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +4 -5
  26. package/dist/migrations/v2.0/create-events-index.d.ts.map +1 -1
  27. package/dist/migrations/v2.0/create-events-index.js +1 -2
  28. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +11 -0
  29. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -0
  30. package/dist/migrations/v2.0/delete-infrastructure-directory.js +123 -0
  31. package/dist/migrations/v2.0/index.d.ts +10 -4
  32. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  33. package/dist/migrations/v2.0/index.js +1752 -346
  34. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  35. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +95 -7
  36. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +13 -0
  37. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -0
  38. package/dist/migrations/v2.0/merge-infrastructure-directory.js +222 -0
  39. package/dist/migrations/v2.0/migrate-application-config-url.d.ts +3 -0
  40. package/dist/migrations/v2.0/migrate-application-config-url.d.ts.map +1 -0
  41. package/dist/migrations/v2.0/migrate-application-config-url.js +342 -0
  42. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  43. package/dist/migrations/v2.0/migrate-scopes.js +6 -7
  44. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -1
  45. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +3 -4
  46. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  47. package/dist/migrations/v2.0/migrate-workqueue-configs.js +143 -63
  48. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -1
  49. package/dist/migrations/v2.0/remove-delete-actions.js +3 -4
  50. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -1
  51. package/dist/migrations/v2.0/remove-demo-scope.js +2 -3
  52. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -1
  53. package/dist/migrations/v2.0/remove-deprecated-imports.js +3 -4
  54. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts +3 -0
  55. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts.map +1 -0
  56. package/dist/migrations/v2.0/remove-fhir-url-helpers.js +163 -0
  57. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -1
  58. package/dist/migrations/v2.0/remove-hearth-migrations.js +1 -2
  59. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts +3 -0
  60. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts.map +1 -0
  61. package/dist/migrations/v2.0/remove-old-statistics-service.js +356 -0
  62. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -1
  63. package/dist/migrations/v2.0/remove-pending-certification-flag.js +3 -4
  64. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -1
  65. package/dist/migrations/v2.0/remove-review-from-register-action.js +3 -4
  66. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts +3 -0
  67. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts.map +1 -0
  68. package/dist/migrations/v2.0/remove-unused-environment-variables.js +186 -0
  69. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -1
  70. package/dist/migrations/v2.0/rename-api-paths.js +3 -4
  71. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -1
  72. package/dist/migrations/v2.0/rename-location-parent-id.js +3 -4
  73. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +1 -1
  74. package/dist/migrations/v2.0/simplify-analytics-precalculations.js +1 -2
  75. package/dist/migrations/v2.0/update-package-json.d.ts +3 -0
  76. package/dist/migrations/v2.0/update-package-json.d.ts.map +1 -0
  77. package/dist/migrations/v2.0/update-package-json.js +105 -0
  78. package/dist/notification/index.js +37 -7
  79. package/dist/scopes/index.d.ts +87 -10
  80. package/dist/scopes/index.js +43 -8
  81. package/opencrvs-toolkit-2.0.0-rc.a657c77.tgz +0 -0
  82. package/package.json +1 -1
  83. package/tsconfig.tsbuildinfo +1 -1
  84. package/opencrvs-toolkit-2.0.0-rc.a456517.tgz +0 -0
@@ -1 +1 @@
1
- {"version":3,"file":"rename-location-parent-id.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/rename-location-parent-id.ts"],"names":[],"mappings":"AAqJA,iBAAe,IAAI,kBAiDlB;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
1
+ {"version":3,"file":"rename-location-parent-id.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/rename-location-parent-id.ts"],"names":[],"mappings":"AAmJA,iBAAe,IAAI,kBAiDlB;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
@@ -45,7 +45,6 @@ exports.main = main;
45
45
  */
46
46
  const ts_morph_1 = require("ts-morph");
47
47
  const path_1 = __importDefault(require("path"));
48
- const _1 = require(".");
49
48
  const OLD_PROPERTY_NAME = 'parentId';
50
49
  const NEW_PROPERTY_NAME = 'administrativeAreaId';
51
50
  const LOCATION_TYPE_NAME = 'Location';
@@ -138,14 +137,14 @@ function processFile(filePath, project) {
138
137
  // surrounding whitespace and optional-chain tokens (?.)
139
138
  propAccess.getNameNode().replaceWithText(NEW_PROPERTY_NAME);
140
139
  renamedCount++;
141
- console.log(` [${path_1.default.relative((0, _1.getCwd)(), filePath)}] Renamed Location.${OLD_PROPERTY_NAME} → Location.${NEW_PROPERTY_NAME}`);
140
+ console.log(` [${path_1.default.relative(process.cwd(), filePath)}] Renamed Location.${OLD_PROPERTY_NAME} → Location.${NEW_PROPERTY_NAME}`);
142
141
  }
143
142
  return renamedCount;
144
143
  }
145
144
  // ─── Entry point ─────────────────────────────────────────────────────────────
146
145
  function main() {
147
146
  return __awaiter(this, void 0, void 0, function* () {
148
- const srcDir = path_1.default.join((0, _1.getCwd)(), 'src');
147
+ const srcDir = path_1.default.join(process.cwd(), 'src');
149
148
  console.log(`Scanning for Location.${OLD_PROPERTY_NAME} references in: ${srcDir}\n`);
150
149
  const project = new ts_morph_1.Project({
151
150
  tsConfigFilePath: path_1.default.resolve(srcDir, '../tsconfig.json'),
@@ -174,7 +173,7 @@ function main() {
174
173
  for (const filePath of modifiedFiles) {
175
174
  const sourceFile = project.getSourceFileOrThrow(filePath);
176
175
  yield sourceFile.save();
177
- console.log(` Saved: ${path_1.default.relative((0, _1.getCwd)(), filePath)}`);
176
+ console.log(` Saved: ${path_1.default.relative(process.cwd(), filePath)}`);
178
177
  }
179
178
  console.log(`\nDone. Renamed ${totalRenamed} Location.${OLD_PROPERTY_NAME} reference(s) to Location.${NEW_PROPERTY_NAME}.`);
180
179
  });
@@ -1 +1 @@
1
- {"version":3,"file":"simplify-analytics-precalculations.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/simplify-analytics-precalculations.ts"],"names":[],"mappings":"AAuLA,iBAAe,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAyCnC;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
1
+ {"version":3,"file":"simplify-analytics-precalculations.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/simplify-analytics-precalculations.ts"],"names":[],"mappings":"AAqLA,iBAAe,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAyCnC;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
@@ -51,7 +51,6 @@ exports.main = main;
51
51
  const ts_morph_1 = require("ts-morph");
52
52
  const fs_1 = __importDefault(require("fs"));
53
53
  const path_1 = __importDefault(require("path"));
54
- const _1 = require(".");
55
54
  const ANALYTICS_FILE_REL = 'src/analytics/analytics.ts';
56
55
  const FUNCTION_NAME = 'precalculateAdditionalAnalytics';
57
56
  const IMPORT_NAMES_TO_REMOVE = new Set(['Event', 'precalculateBirthEvent']);
@@ -164,7 +163,7 @@ function simplifyPrecalculateFunction(sourceFile) {
164
163
  // ─── Entry point ─────────────────────────────────────────────────────────────
165
164
  function main() {
166
165
  return __awaiter(this, void 0, void 0, function* () {
167
- const cwd = (0, _1.getCwd)();
166
+ const cwd = process.cwd();
168
167
  const absPath = path_1.default.join(cwd, ANALYTICS_FILE_REL);
169
168
  if (!fs_1.default.existsSync(absPath)) {
170
169
  console.log(`[${ANALYTICS_FILE_REL}] does not exist — nothing to clean up.`);
@@ -0,0 +1,3 @@
1
+ declare function main(): Promise<void>;
2
+ export { main };
3
+ //# sourceMappingURL=update-package-json.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"update-package-json.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/update-package-json.ts"],"names":[],"mappings":"AA2CA,iBAAe,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAyEnC;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
@@ -0,0 +1,105 @@
1
+ "use strict";
2
+ /*
3
+ * This Source Code Form is subject to the terms of the Mozilla Public
4
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
5
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
6
+ *
7
+ * OpenCRVS is also distributed under the terms of the Civil Registration
8
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
9
+ *
10
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
11
+ */
12
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
13
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
14
+ return new (P || (P = Promise))(function (resolve, reject) {
15
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
16
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
17
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
18
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
19
+ });
20
+ };
21
+ var __importDefault = (this && this.__importDefault) || function (mod) {
22
+ return (mod && mod.__esModule) ? mod : { "default": mod };
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.main = main;
26
+ /**
27
+ * Codemod: Update root `package.json` for the v1.9 → v2.0 upgrade.
28
+ *
29
+ * Changes applied:
30
+ * 1. Sets `version` to `2.0.0`.
31
+ * 2. Sets `zod` to `^4.2.1` in `dependencies` (or `devDependencies` if it
32
+ * already lives there). If `zod` is absent from both, it's added to
33
+ * `dependencies`.
34
+ *
35
+ * Caveats:
36
+ * - The codemod preserves the file's existing 2-space indentation and
37
+ * trailing newline. Any non-standard formatting (e.g. tabs) will be
38
+ * replaced with 2-space indentation.
39
+ * - No-op when `package.json` is missing.
40
+ * - No automatic `yarn install` is run; the developer should reinstall
41
+ * dependencies after the codemods complete.
42
+ */
43
+ const fs_1 = require("fs");
44
+ const path_1 = __importDefault(require("path"));
45
+ const PACKAGE_JSON_RELATIVE = 'package.json';
46
+ const TARGET_VERSION = '2.0.0';
47
+ const TARGET_ZOD_RANGE = '^4.2.1';
48
+ function main() {
49
+ return __awaiter(this, void 0, void 0, function* () {
50
+ const packageJsonPath = path_1.default.join(process.cwd(), PACKAGE_JSON_RELATIVE);
51
+ if (!(0, fs_1.existsSync)(packageJsonPath)) {
52
+ console.log(`'${PACKAGE_JSON_RELATIVE}' not found in ${process.cwd()} — skipping.`);
53
+ return;
54
+ }
55
+ const raw = (0, fs_1.readFileSync)(packageJsonPath, 'utf8');
56
+ let parsed;
57
+ try {
58
+ parsed = JSON.parse(raw);
59
+ }
60
+ catch (error) {
61
+ console.warn(` [${PACKAGE_JSON_RELATIVE}] Failed to parse JSON — skipping update. ${error.message}`);
62
+ return;
63
+ }
64
+ console.log(`Updating '${PACKAGE_JSON_RELATIVE}'...`);
65
+ const previousVersion = parsed.version;
66
+ const versionChanged = previousVersion !== TARGET_VERSION;
67
+ parsed.version = TARGET_VERSION;
68
+ if (versionChanged) {
69
+ console.log(` Set version: ${previousVersion !== null && previousVersion !== void 0 ? previousVersion : '<unset>'} → ${TARGET_VERSION}`);
70
+ }
71
+ else {
72
+ console.log(` Version already ${TARGET_VERSION} — no change.`);
73
+ }
74
+ // Resolve which dependency bucket already holds zod, defaulting to
75
+ // `dependencies` when absent.
76
+ let zodBucket = 'dependencies';
77
+ if (parsed.devDependencies && 'zod' in parsed.devDependencies) {
78
+ zodBucket = 'devDependencies';
79
+ }
80
+ if (!parsed[zodBucket]) {
81
+ parsed[zodBucket] = {};
82
+ }
83
+ const bucket = parsed[zodBucket];
84
+ const previousZod = bucket.zod;
85
+ const zodChanged = previousZod !== TARGET_ZOD_RANGE;
86
+ bucket.zod = TARGET_ZOD_RANGE;
87
+ if (zodChanged) {
88
+ console.log(` Set ${zodBucket}.zod: ${previousZod !== null && previousZod !== void 0 ? previousZod : '<absent>'} → ${TARGET_ZOD_RANGE}`);
89
+ }
90
+ else {
91
+ console.log(` ${zodBucket}.zod already ${TARGET_ZOD_RANGE} — no change.`);
92
+ }
93
+ // Preserve trailing newline if the source had one (default to LF since
94
+ // most repos commit JSON with a trailing newline).
95
+ const trailingNewline = raw.endsWith('\n') ? '\n' : '';
96
+ const next = JSON.stringify(parsed, null, 2) + trailingNewline;
97
+ if (next === raw) {
98
+ console.log('\n No changes to write.');
99
+ return;
100
+ }
101
+ (0, fs_1.writeFileSync)(packageJsonPath, next, 'utf8');
102
+ console.log(`\n Saved '${PACKAGE_JSON_RELATIVE}'.`);
103
+ console.log(` NOTE: run \`yarn install\` (or your package manager equivalent) to install the updated dependency versions.`);
104
+ });
105
+ }
@@ -110,6 +110,10 @@ var scopeByEvent = z2.preprocess(
110
110
  (val) => val === void 0 ? void 0 : [val].flat(),
111
111
  z2.array(z2.string()).optional()
112
112
  ).describe("Event type, e.g. birth, death");
113
+ var userRole = z2.preprocess(
114
+ (val) => val === void 0 ? void 0 : [val].flat(),
115
+ z2.array(z2.string()).optional()
116
+ ).describe("User role, e.g. admin, field agent");
113
117
  var scopeOptionsPlaceEvent = z2.object({
114
118
  event: scopeByEvent,
115
119
  placeOfEvent: JurisdictionFilter.optional()
@@ -133,6 +137,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
133
137
  var AccessLevelOptions = z2.object({
134
138
  accessLevel: JurisdictionFilter.optional()
135
139
  });
140
+ var AllUserScopeOptions = AccessLevelOptions.extend({
141
+ role: userRole.optional()
142
+ });
136
143
  var WorkqueueOrDashboardOptions = z2.object({
137
144
  ids: z2.preprocess(
138
145
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -142,6 +149,7 @@ var WorkqueueOrDashboardOptions = z2.object({
142
149
  var AllScopeOptions = z2.object({
143
150
  ...AllRecordScopeOptions.shape,
144
151
  ...AccessLevelOptions.shape,
152
+ ...AllUserScopeOptions.shape,
145
153
  ...WorkqueueOrDashboardOptions.shape
146
154
  });
147
155
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -214,6 +222,30 @@ var RecordScopeV2 = z2.discriminatedUnion("type", [
214
222
  ]).describe(
215
223
  "Scopes used to check user's permission to perform actions on a record."
216
224
  );
225
+ var SystemScopeType = z2.enum([
226
+ "organisation.read-locations",
227
+ "user.read",
228
+ "user.create",
229
+ "user.edit",
230
+ "user.search"
231
+ ]);
232
+ var UserScopeType = SystemScopeType.extract([
233
+ "user.read",
234
+ "user.create",
235
+ "user.edit",
236
+ "user.search"
237
+ ]);
238
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
239
+ var UserScopeV2 = z2.discriminatedUnion("type", [
240
+ z2.object({
241
+ type: ScopesWithRoleOption,
242
+ options: AllUserScopeOptions.optional()
243
+ }),
244
+ z2.object({
245
+ type: UserScopeType.extract(["user.read", "user.search"]),
246
+ options: AccessLevelOptions.optional()
247
+ })
248
+ ]);
217
249
  var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
218
250
  z2.object({
219
251
  type: ScopesWithPlaceEventOptions,
@@ -234,16 +266,14 @@ var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
234
266
  }).optional()
235
267
  })
236
268
  ]).describe("Resolved scope with location/user IDs instead of filters.");
237
- var SystemScopeType = z2.enum([
238
- "organisation.read-locations",
239
- "user.read",
240
- "user.create",
241
- "user.edit"
242
- ]);
243
269
  var Scope = z2.discriminatedUnion("type", [
244
270
  z2.object({ type: PlainScopeType }),
245
271
  ...RecordScopeV2.options,
246
- z2.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
272
+ ...UserScopeV2.options,
273
+ z2.object({
274
+ type: z2.literal("organisation.read-locations"),
275
+ options: AccessLevelOptions.optional()
276
+ }),
247
277
  z2.object({
248
278
  type: z2.literal("workqueue"),
249
279
  options: WorkqueueOrDashboardOptions
@@ -41,6 +41,7 @@ declare const AllScopeOptions: z.ZodObject<{
41
41
  location: "location";
42
42
  all: "all";
43
43
  }>>;
44
+ role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
44
45
  event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
45
46
  placeOfEvent: z.ZodOptional<z.ZodEnum<{
46
47
  administrativeArea: "administrativeArea";
@@ -66,6 +67,7 @@ declare const AllScopeOptions: z.ZodObject<{
66
67
  }, z.core.$strip>;
67
68
  type AllScopeOptions = z.infer<typeof AllScopeOptions>;
68
69
  export declare const ScopeOptionKey: z.ZodEnum<{
70
+ role: "role";
69
71
  event: "event";
70
72
  placeOfEvent: "placeOfEvent";
71
73
  declaredIn: "declaredIn";
@@ -220,6 +222,56 @@ export declare const RecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
220
222
  templates: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
221
223
  }, z.core.$strip>>;
222
224
  }, z.core.$strip>], "type">;
225
+ declare const SystemScopeType: z.ZodEnum<{
226
+ "organisation.read-locations": "organisation.read-locations";
227
+ "user.read": "user.read";
228
+ "user.create": "user.create";
229
+ "user.edit": "user.edit";
230
+ "user.search": "user.search";
231
+ }>;
232
+ export type SystemScopeType = z.infer<typeof SystemScopeType>;
233
+ declare const UserScopeType: z.ZodEnum<{
234
+ "user.read": "user.read";
235
+ "user.create": "user.create";
236
+ "user.edit": "user.edit";
237
+ "user.search": "user.search";
238
+ }>;
239
+ export type UserScopeType = z.infer<typeof UserScopeType>;
240
+ declare const ScopesWithRoleOption: z.ZodEnum<{
241
+ "user.create": "user.create";
242
+ "user.edit": "user.edit";
243
+ }>;
244
+ export type ScopesWithRoleOption = z.infer<typeof ScopesWithRoleOption>;
245
+ export declare const UserScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject<{
246
+ type: z.ZodEnum<{
247
+ "user.create": "user.create";
248
+ "user.edit": "user.edit";
249
+ }>;
250
+ options: z.ZodOptional<z.ZodObject<{
251
+ accessLevel: z.ZodOptional<z.ZodEnum<{
252
+ administrativeArea: "administrativeArea";
253
+ location: "location";
254
+ all: "all";
255
+ }>>;
256
+ role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
257
+ }, z.core.$strip>>;
258
+ }, z.core.$strip>, z.ZodObject<{
259
+ type: z.ZodEnum<{
260
+ "user.read": "user.read";
261
+ "user.search": "user.search";
262
+ }>;
263
+ options: z.ZodOptional<z.ZodObject<{
264
+ accessLevel: z.ZodOptional<z.ZodEnum<{
265
+ administrativeArea: "administrativeArea";
266
+ location: "location";
267
+ all: "all";
268
+ }>>;
269
+ }, z.core.$strip>>;
270
+ }, z.core.$strip>], "type">;
271
+ export type UserScopeV2 = z.infer<typeof UserScopeV2>;
272
+ export declare function scopeUsesRoleOptions(scope: UserScopeV2): scope is Extract<UserScopeV2, {
273
+ type: ScopesWithRoleOption;
274
+ }>;
223
275
  export declare function scopeUsesDeclaredOptions(scope: Scope): scope is Extract<Scope, {
224
276
  type: z.infer<typeof ScopesWithDeclaredOptions>;
225
277
  }>;
@@ -286,13 +338,6 @@ export declare const ResolvedRecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject
286
338
  }, z.core.$strip>], "type">;
287
339
  export type RecordScopeV2 = z.infer<typeof RecordScopeV2>;
288
340
  export type ResolvedRecordScopeV2 = z.infer<typeof ResolvedRecordScopeV2>;
289
- declare const SystemScopeType: z.ZodEnum<{
290
- "organisation.read-locations": "organisation.read-locations";
291
- "user.read": "user.read";
292
- "user.create": "user.create";
293
- "user.edit": "user.edit";
294
- }>;
295
- export type SystemScopeType = z.infer<typeof SystemScopeType>;
296
341
  /** The primary scope schema which gathers all scope types together. All scopes are discriminated by type and options are determined according to the type. */
297
342
  export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
298
343
  type: z.ZodEnum<{
@@ -437,11 +482,31 @@ export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
437
482
  }, z.core.$strip>>;
438
483
  }, z.core.$strip>, z.ZodObject<{
439
484
  type: z.ZodEnum<{
440
- "organisation.read-locations": "organisation.read-locations";
441
- "user.read": "user.read";
442
485
  "user.create": "user.create";
443
486
  "user.edit": "user.edit";
444
487
  }>;
488
+ options: z.ZodOptional<z.ZodObject<{
489
+ accessLevel: z.ZodOptional<z.ZodEnum<{
490
+ administrativeArea: "administrativeArea";
491
+ location: "location";
492
+ all: "all";
493
+ }>>;
494
+ role: z.ZodOptional<z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>>;
495
+ }, z.core.$strip>>;
496
+ }, z.core.$strip>, z.ZodObject<{
497
+ type: z.ZodEnum<{
498
+ "user.read": "user.read";
499
+ "user.search": "user.search";
500
+ }>;
501
+ options: z.ZodOptional<z.ZodObject<{
502
+ accessLevel: z.ZodOptional<z.ZodEnum<{
503
+ administrativeArea: "administrativeArea";
504
+ location: "location";
505
+ all: "all";
506
+ }>>;
507
+ }, z.core.$strip>>;
508
+ }, z.core.$strip>, z.ZodObject<{
509
+ type: z.ZodLiteral<"organisation.read-locations">;
445
510
  options: z.ZodOptional<z.ZodObject<{
446
511
  accessLevel: z.ZodOptional<z.ZodEnum<{
447
512
  administrativeArea: "administrativeArea";
@@ -495,6 +560,7 @@ export declare const ScopeType: z.ZodEnum<{
495
560
  "user.read": "user.read";
496
561
  "user.create": "user.create";
497
562
  "user.edit": "user.edit";
563
+ "user.search": "user.search";
498
564
  workqueue: "workqueue";
499
565
  "dashboard.view": "dashboard.view";
500
566
  }>;
@@ -567,10 +633,21 @@ export declare const decodeScope: (query: EncodedScope) => {
567
633
  registeredBy?: "user" | undefined;
568
634
  templates?: string[] | undefined;
569
635
  } | undefined;
636
+ } | {
637
+ type: "user.create" | "user.edit";
638
+ options?: {
639
+ accessLevel?: "administrativeArea" | "location" | "all" | undefined;
640
+ role?: string[] | undefined;
641
+ } | undefined;
642
+ } | {
643
+ type: "user.read" | "user.search";
644
+ options?: {
645
+ accessLevel?: "administrativeArea" | "location" | "all" | undefined;
646
+ } | undefined;
570
647
  } | {
571
648
  type: "bypassratelimit" | "record.reindex" | "user.data-seeding" | "integration.create" | "record.import" | "config.update-all" | "attachment.upload" | "profile.electronic-signature" | "user.read-only-my-audit" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "record.confirm-registration" | "record.reject-registration";
572
649
  } | {
573
- type: "organisation.read-locations" | "user.read" | "user.create" | "user.edit";
650
+ type: "organisation.read-locations";
574
651
  options?: {
575
652
  accessLevel?: "administrativeArea" | "location" | "all" | undefined;
576
653
  } | undefined;
@@ -42,6 +42,7 @@ __export(scopes_exports, {
42
42
  ScopesWithFullOptions: () => ScopesWithFullOptions,
43
43
  ScopesWithPlaceEventOptions: () => ScopesWithPlaceEventOptions,
44
44
  UserFilter: () => UserFilter,
45
+ UserScopeV2: () => UserScopeV2,
45
46
  canUserCreateEvent: () => canUserCreateEvent,
46
47
  decodeScope: () => decodeScope,
47
48
  defineRoles: () => defineRoles,
@@ -54,7 +55,8 @@ __export(scopes_exports, {
54
55
  isCustomActionScope: () => isCustomActionScope,
55
56
  scopeUsesDeclaredOptions: () => scopeUsesDeclaredOptions,
56
57
  scopeUsesFullOptions: () => scopeUsesFullOptions,
57
- scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions
58
+ scopeUsesPrintCertifiedCopiesOptions: () => scopeUsesPrintCertifiedCopiesOptions,
59
+ scopeUsesRoleOptions: () => scopeUsesRoleOptions
58
60
  });
59
61
  module.exports = __toCommonJS(scopes_exports);
60
62
  var z4 = __toESM(require("zod/v4"));
@@ -139,6 +141,10 @@ var scopeByEvent = z3.preprocess(
139
141
  (val) => val === void 0 ? void 0 : [val].flat(),
140
142
  z3.array(z3.string()).optional()
141
143
  ).describe("Event type, e.g. birth, death");
144
+ var userRole = z3.preprocess(
145
+ (val) => val === void 0 ? void 0 : [val].flat(),
146
+ z3.array(z3.string()).optional()
147
+ ).describe("User role, e.g. admin, field agent");
142
148
  var scopeOptionsPlaceEvent = z3.object({
143
149
  event: scopeByEvent,
144
150
  placeOfEvent: JurisdictionFilter.optional()
@@ -162,6 +168,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
162
168
  var AccessLevelOptions = z3.object({
163
169
  accessLevel: JurisdictionFilter.optional()
164
170
  });
171
+ var AllUserScopeOptions = AccessLevelOptions.extend({
172
+ role: userRole.optional()
173
+ });
165
174
  var WorkqueueOrDashboardOptions = z3.object({
166
175
  ids: z3.preprocess(
167
176
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -171,6 +180,7 @@ var WorkqueueOrDashboardOptions = z3.object({
171
180
  var AllScopeOptions = z3.object({
172
181
  ...AllRecordScopeOptions.shape,
173
182
  ...AccessLevelOptions.shape,
183
+ ...AllUserScopeOptions.shape,
174
184
  ...WorkqueueOrDashboardOptions.shape
175
185
  });
176
186
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -243,6 +253,33 @@ var RecordScopeV2 = z3.discriminatedUnion("type", [
243
253
  ]).describe(
244
254
  "Scopes used to check user's permission to perform actions on a record."
245
255
  );
256
+ var SystemScopeType = z3.enum([
257
+ "organisation.read-locations",
258
+ "user.read",
259
+ "user.create",
260
+ "user.edit",
261
+ "user.search"
262
+ ]);
263
+ var UserScopeType = SystemScopeType.extract([
264
+ "user.read",
265
+ "user.create",
266
+ "user.edit",
267
+ "user.search"
268
+ ]);
269
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
270
+ var UserScopeV2 = z3.discriminatedUnion("type", [
271
+ z3.object({
272
+ type: ScopesWithRoleOption,
273
+ options: AllUserScopeOptions.optional()
274
+ }),
275
+ z3.object({
276
+ type: UserScopeType.extract(["user.read", "user.search"]),
277
+ options: AccessLevelOptions.optional()
278
+ })
279
+ ]);
280
+ function scopeUsesRoleOptions(scope) {
281
+ return ScopesWithRoleOption?.options.some((opt) => opt === scope.type);
282
+ }
246
283
  function scopeUsesDeclaredOptions(scope) {
247
284
  return !ScopesWithPlaceEventOptions.options.some((opt) => opt === scope.type);
248
285
  }
@@ -275,16 +312,14 @@ var ResolvedRecordScopeV2 = z3.discriminatedUnion("type", [
275
312
  }).optional()
276
313
  })
277
314
  ]).describe("Resolved scope with location/user IDs instead of filters.");
278
- var SystemScopeType = z3.enum([
279
- "organisation.read-locations",
280
- "user.read",
281
- "user.create",
282
- "user.edit"
283
- ]);
284
315
  var Scope2 = z3.discriminatedUnion("type", [
285
316
  z3.object({ type: PlainScopeType }),
286
317
  ...RecordScopeV2.options,
287
- z3.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
318
+ ...UserScopeV2.options,
319
+ z3.object({
320
+ type: z3.literal("organisation.read-locations"),
321
+ options: AccessLevelOptions.optional()
322
+ }),
288
323
  z3.object({
289
324
  type: z3.literal("workqueue"),
290
325
  options: WorkqueueOrDashboardOptions
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "2.0.0-rc.a456517",
3
+ "version": "2.0.0-rc.a657c77",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
6
  "bin": {
@@ -1 +1 @@
1
- {"root":["./src/cli.ts","./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.ts","./src/migrations/v2.0/add-birth-certificate-issuance-flag.ts","./src/migrations/v2.0/checkout-upstream-files.ts","./src/migrations/v2.0/convert-config-files-to-ts.ts","./src/migrations/v2.0/convert-paragraph-to-heading.ts","./src/migrations/v2.0/create-events-index.ts","./src/migrations/v2.0/index.ts","./src/migrations/v2.0/make-built-in-validate-actions-custom.ts","./src/migrations/v2.0/migrate-scopes.ts","./src/migrations/v2.0/migrate-validated-workqueue-status-to-flag.ts","./src/migrations/v2.0/migrate-workqueue-configs.ts","./src/migrations/v2.0/remove-delete-actions.ts","./src/migrations/v2.0/remove-demo-scope.ts","./src/migrations/v2.0/remove-deprecated-imports.ts","./src/migrations/v2.0/remove-hearth-migrations.ts","./src/migrations/v2.0/remove-pending-certification-flag.ts","./src/migrations/v2.0/remove-review-from-register-action.ts","./src/migrations/v2.0/rename-api-paths.ts","./src/migrations/v2.0/rename-location-parent-id.ts","./src/migrations/v2.0/simplify-analytics-precalculations.ts","./src/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}
1
+ {"root":["./src/cli.ts","./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.ts","./src/migrations/v2.0/add-birth-certificate-issuance-flag.ts","./src/migrations/v2.0/add-resend-invite-notification.ts","./src/migrations/v2.0/checkout-upstream-files.ts","./src/migrations/v2.0/convert-config-files-to-ts.ts","./src/migrations/v2.0/convert-paragraph-to-heading.ts","./src/migrations/v2.0/create-events-index.ts","./src/migrations/v2.0/delete-infrastructure-directory.ts","./src/migrations/v2.0/index.ts","./src/migrations/v2.0/make-built-in-validate-actions-custom.ts","./src/migrations/v2.0/merge-infrastructure-directory.ts","./src/migrations/v2.0/migrate-application-config-url.ts","./src/migrations/v2.0/migrate-scopes.ts","./src/migrations/v2.0/migrate-validated-workqueue-status-to-flag.ts","./src/migrations/v2.0/migrate-workqueue-configs.ts","./src/migrations/v2.0/remove-delete-actions.ts","./src/migrations/v2.0/remove-demo-scope.ts","./src/migrations/v2.0/remove-deprecated-imports.ts","./src/migrations/v2.0/remove-fhir-url-helpers.ts","./src/migrations/v2.0/remove-hearth-migrations.ts","./src/migrations/v2.0/remove-old-statistics-service.ts","./src/migrations/v2.0/remove-pending-certification-flag.ts","./src/migrations/v2.0/remove-review-from-register-action.ts","./src/migrations/v2.0/remove-unused-environment-variables.ts","./src/migrations/v2.0/rename-api-paths.ts","./src/migrations/v2.0/rename-location-parent-id.ts","./src/migrations/v2.0/simplify-analytics-precalculations.ts","./src/migrations/v2.0/update-package-json.ts","./src/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}