@opencrvs/toolkit 1.9.12-rc.d89c437 → 1.9.12-rc.d93dd68

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 (91) hide show
  1. package/build.sh +8 -0
  2. package/dist/application-config/index.js +2045 -41
  3. package/dist/cli.d.ts +2 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +3237 -0
  6. package/dist/commons/api/router.d.ts +106 -75
  7. package/dist/commons/application-config/index.d.ts +13 -16
  8. package/dist/commons/conditionals/conditionals.d.ts +3 -3
  9. package/dist/commons/events/ActionDocument.d.ts +198 -198
  10. package/dist/commons/events/ActionInput.d.ts +113 -113
  11. package/dist/commons/events/ActionType.d.ts +3 -3
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +16 -10
  13. package/dist/commons/events/CompositeFieldValue.d.ts +4 -4
  14. package/dist/commons/events/CountryConfigQueryInput.d.ts +443 -172
  15. package/dist/commons/events/Draft.d.ts +15 -15
  16. package/dist/commons/events/DynamicFieldValue.d.ts +37 -19
  17. package/dist/commons/events/EventConfig.d.ts +1 -1
  18. package/dist/commons/events/EventDocument.d.ts +81 -81
  19. package/dist/commons/events/EventIndex.d.ts +35 -27
  20. package/dist/commons/events/EventInput.d.ts +1 -1
  21. package/dist/commons/events/EventMetadata.d.ts +24 -24
  22. package/dist/commons/events/FieldConfig.d.ts +155 -44
  23. package/dist/commons/events/FieldType.d.ts +2 -1
  24. package/dist/commons/events/FieldTypeMapping.d.ts +98 -72
  25. package/dist/commons/events/FieldValue.d.ts +54 -26
  26. package/dist/commons/events/PlainDate.d.ts +1 -1
  27. package/dist/commons/events/WorkqueueColumnConfig.d.ts +16 -16
  28. package/dist/commons/events/WorkqueueConfig.d.ts +438 -194
  29. package/dist/commons/events/defineConfig.d.ts +0 -4
  30. package/dist/commons/events/locations.d.ts +4 -4
  31. package/dist/commons/events/state/index.d.ts +2 -2
  32. package/dist/commons/events/state/utils.d.ts +3 -3
  33. package/dist/commons/events/utils.d.ts +5 -177
  34. package/dist/conditionals/index.js +13 -5
  35. package/dist/events/index.js +142 -33
  36. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts +3 -0
  37. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -0
  38. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +405 -0
  39. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts +2 -0
  40. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -0
  41. package/dist/migrations/v2.0/convert-config-files-to-ts.js +829 -0
  42. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts +3 -0
  43. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -0
  44. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +159 -0
  45. package/dist/migrations/v2.0/index.d.ts +7 -0
  46. package/dist/migrations/v2.0/index.d.ts.map +1 -0
  47. package/dist/migrations/v2.0/index.js +3176 -0
  48. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts +3 -0
  49. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -0
  50. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +344 -0
  51. package/dist/migrations/v2.0/migrate-scopes.d.ts +3 -0
  52. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -0
  53. package/dist/migrations/v2.0/migrate-scopes.js +282 -0
  54. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts +3 -0
  55. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -0
  56. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +268 -0
  57. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts +3 -0
  58. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -0
  59. package/dist/migrations/v2.0/migrate-workqueue-configs.js +237 -0
  60. package/dist/migrations/v2.0/remove-delete-actions.d.ts +3 -0
  61. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -0
  62. package/dist/migrations/v2.0/remove-delete-actions.js +157 -0
  63. package/dist/migrations/v2.0/remove-demo-scope.d.ts +3 -0
  64. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -0
  65. package/dist/migrations/v2.0/remove-demo-scope.js +75 -0
  66. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts +3 -0
  67. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -0
  68. package/dist/migrations/v2.0/remove-deprecated-imports.js +97 -0
  69. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts +3 -0
  70. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -0
  71. package/dist/migrations/v2.0/remove-hearth-migrations.js +78 -0
  72. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts +3 -0
  73. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -0
  74. package/dist/migrations/v2.0/remove-pending-certification-flag.js +110 -0
  75. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts +3 -0
  76. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -0
  77. package/dist/migrations/v2.0/remove-review-from-register-action.js +164 -0
  78. package/dist/migrations/v2.0/rename-api-paths.d.ts +3 -0
  79. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -0
  80. package/dist/migrations/v2.0/rename-api-paths.js +188 -0
  81. package/dist/migrations/v2.0/rename-location-parent-id.d.ts +3 -0
  82. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -0
  83. package/dist/migrations/v2.0/rename-location-parent-id.js +181 -0
  84. package/dist/notification/index.js +73 -23
  85. package/dist/scopes/index.d.ts +31 -10
  86. package/dist/scopes/index.js +17 -5
  87. package/opencrvs-toolkit-1.9.12-rc.d93dd68.tgz +0 -0
  88. package/package.json +11 -7
  89. package/tsconfig.json +3 -0
  90. package/tsconfig.tsbuildinfo +1 -1
  91. package/opencrvs-toolkit-1.9.12-rc.d89c437.tgz +0 -0
@@ -1,4 +1,5 @@
1
1
  import * as z from 'zod/v4';
2
+ import { Role } from './roles';
2
3
  export declare const JurisdictionFilter: z.ZodEnum<{
3
4
  administrativeArea: "administrativeArea";
4
5
  location: "location";
@@ -239,7 +240,7 @@ export declare const ResolvedRecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject
239
240
  }>;
240
241
  options: z.ZodOptional<z.ZodObject<{
241
242
  event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
242
- placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
243
+ placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
243
244
  }, z.core.$strip>>;
244
245
  }, z.core.$strip>, z.ZodObject<{
245
246
  type: z.ZodEnum<{
@@ -251,8 +252,8 @@ export declare const ResolvedRecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject
251
252
  }>;
252
253
  options: z.ZodOptional<z.ZodObject<{
253
254
  event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
254
- placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
255
- declaredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
255
+ placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
256
+ declaredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
256
257
  declaredBy: z.ZodOptional<z.ZodString>;
257
258
  }, z.core.$strip>>;
258
259
  }, z.core.$strip>, z.ZodObject<{
@@ -265,20 +266,20 @@ export declare const ResolvedRecordScopeV2: z.ZodDiscriminatedUnion<[z.ZodObject
265
266
  }>;
266
267
  options: z.ZodOptional<z.ZodObject<{
267
268
  event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
268
- placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
269
- declaredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
269
+ placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
270
+ declaredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
270
271
  declaredBy: z.ZodOptional<z.ZodString>;
271
- registeredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
272
+ registeredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
272
273
  registeredBy: z.ZodOptional<z.ZodString>;
273
274
  }, z.core.$strip>>;
274
275
  }, z.core.$strip>, z.ZodObject<{
275
276
  type: z.ZodLiteral<"record.print-certified-copies">;
276
277
  options: z.ZodOptional<z.ZodObject<{
277
278
  event: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodOptional<z.ZodArray<z.ZodString>>>;
278
- placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
279
- declaredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
279
+ placeOfEvent: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
280
+ declaredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
280
281
  declaredBy: z.ZodOptional<z.ZodString>;
281
- registeredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID">>>;
282
+ registeredIn: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
282
283
  registeredBy: z.ZodOptional<z.ZodString>;
283
284
  templates: z.ZodOptional<z.ZodArray<z.ZodString>>;
284
285
  }, z.core.$strip>>;
@@ -453,6 +454,11 @@ export declare const Scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
453
454
  options: z.ZodObject<{
454
455
  ids: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodArray<z.ZodString>>;
455
456
  }, z.core.$strip>;
457
+ }, z.core.$strip>, z.ZodObject<{
458
+ type: z.ZodLiteral<"dashboard.view">;
459
+ options: z.ZodObject<{
460
+ ids: z.ZodPipe<z.ZodTransform<({} | null)[] | undefined, unknown>, z.ZodArray<z.ZodString>>;
461
+ }, z.core.$strip>;
456
462
  }, z.core.$strip>], "type">;
457
463
  export type Scope = z.infer<typeof Scope>;
458
464
  export declare const ScopeType: z.ZodEnum<{
@@ -490,13 +496,14 @@ export declare const ScopeType: z.ZodEnum<{
490
496
  "user.create": "user.create";
491
497
  "user.edit": "user.edit";
492
498
  workqueue: "workqueue";
499
+ "dashboard.view": "dashboard.view";
493
500
  }>;
494
501
  export type ScopeType = z.infer<typeof ScopeType>;
495
502
  /**
496
503
  * Branded encoded scope string, in query string format.
497
504
  *
498
505
  */
499
- export declare const EncodedScope: z.core.$ZodBranded<z.ZodString, "EncodedScope">;
506
+ export declare const EncodedScope: z.core.$ZodBranded<z.ZodString, "EncodedScope", "out">;
500
507
  export type EncodedScope = z.infer<typeof EncodedScope>;
501
508
  /**
502
509
  * Encodes a scope object into an EncodedScope branded query string.
@@ -572,6 +579,11 @@ export declare const decodeScope: (query: EncodedScope) => {
572
579
  options: {
573
580
  ids: string[];
574
581
  };
582
+ } | {
583
+ type: "dashboard.view";
584
+ options: {
585
+ ids: string[];
586
+ };
575
587
  } | undefined;
576
588
  /**
577
589
  * Function to get the value of a scope option (aka. scope attribute)
@@ -647,5 +659,14 @@ export declare function canUserCreateEvent(userScopes: EncodedScope[], eventType
647
659
  * @returns Array of scopes in string format, encoded for use in JWT tokens.
648
660
  */
649
661
  export declare function defineScopes(scopes: Scope[]): (string & z.core.$brand<"EncodedScope">)[];
662
+ /**
663
+ * Helper for defining user roles. Should be used in country config.
664
+ *
665
+ * @param roles Array of roles in object format.
666
+ */
667
+ export declare function defineRoles(roles: Role[]): {
668
+ id: string;
669
+ scopes: (string & z.core.$brand<"EncodedScope">)[];
670
+ }[];
650
671
  export {};
651
672
  //# sourceMappingURL=scopes.d.ts.map
@@ -44,6 +44,7 @@ __export(scopes_exports, {
44
44
  UserFilter: () => UserFilter,
45
45
  canUserCreateEvent: () => canUserCreateEvent,
46
46
  decodeScope: () => decodeScope,
47
+ defineRoles: () => defineRoles,
47
48
  defineScopes: () => defineScopes,
48
49
  encodeScope: () => encodeScope,
49
50
  getAcceptedScopesByType: () => getAcceptedScopesByType,
@@ -161,16 +162,16 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
161
162
  var AccessLevelOptions = z3.object({
162
163
  accessLevel: JurisdictionFilter.optional()
163
164
  });
164
- var WorkqueueOptions = z3.object({
165
+ var WorkqueueOrDashboardOptions = z3.object({
165
166
  ids: z3.preprocess(
166
167
  (val) => val === void 0 ? void 0 : [val].flat(),
167
168
  z3.array(z3.string())
168
- ).describe("Must contain a list of workqueue ids.")
169
+ ).describe("Must contain a list of workqueue or dashboard ids.")
169
170
  });
170
171
  var AllScopeOptions = z3.object({
171
172
  ...AllRecordScopeOptions.shape,
172
173
  ...AccessLevelOptions.shape,
173
- ...WorkqueueOptions.shape
174
+ ...WorkqueueOrDashboardOptions.shape
174
175
  });
175
176
  var ScopeOptionKey = AllScopeOptions.keyof();
176
177
  var ResolvedScopeOptionsPlaceEvent = z3.object({
@@ -284,13 +285,21 @@ var Scope2 = z3.discriminatedUnion("type", [
284
285
  z3.object({ type: PlainScopeType }),
285
286
  ...RecordScopeV2.options,
286
287
  z3.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
287
- z3.object({ type: z3.literal("workqueue"), options: WorkqueueOptions })
288
+ z3.object({
289
+ type: z3.literal("workqueue"),
290
+ options: WorkqueueOrDashboardOptions
291
+ }),
292
+ z3.object({
293
+ type: z3.literal("dashboard.view"),
294
+ options: WorkqueueOrDashboardOptions
295
+ })
288
296
  ]);
289
297
  var ScopeType2 = z3.enum([
290
298
  ...SystemScopeType.options,
291
299
  ...RecordScopeTypeV2.options,
292
300
  ...PlainScopeType.options,
293
- "workqueue"
301
+ "workqueue",
302
+ "dashboard.view"
294
303
  ]);
295
304
  var flattenScope = (scope) => ({
296
305
  type: scope.type,
@@ -372,6 +381,9 @@ function canUserCreateEvent(userScopes, eventType) {
372
381
  function defineScopes(scopes) {
373
382
  return scopes.map((scope) => Scope2.parse(scope)).map(encodeScope);
374
383
  }
384
+ function defineRoles(roles) {
385
+ return roles;
386
+ }
375
387
 
376
388
  // src/scopes/index.ts
377
389
  z4.globalRegistry.clear();
package/package.json CHANGED
@@ -1,8 +1,11 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "1.9.12-rc.d89c437",
3
+ "version": "1.9.12-rc.d93dd68",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
+ "bin": {
7
+ "opencrvs": "./dist/cli.js"
8
+ },
6
9
  "exports": {
7
10
  "./lib": "./dist/lib.js",
8
11
  "./api": "./dist/api/index.js",
@@ -19,7 +22,7 @@
19
22
  },
20
23
  "dependencies": {
21
24
  "@trpc/client": "11.4.3",
22
- "@trpc/server": "11.4.3",
25
+ "@trpc/server": "^11.8.0",
23
26
  "ajv": "^8.17.1",
24
27
  "ajv-formats": "^3.0.1",
25
28
  "date-fns": "^2.28.0",
@@ -28,16 +31,17 @@
28
31
  "object-hash": "^3.0.0",
29
32
  "qs": "6.14.0",
30
33
  "superjson": "1.9.0-0",
34
+ "ts-morph": "^27.0.2",
31
35
  "uuid": "^9.0.0",
32
- "zod": "^4.1.12",
33
- "zod-openapi": "^5.4.3"
36
+ "zod": "^4.2.1",
37
+ "zod-openapi": "^5.4.6"
34
38
  },
35
39
  "devDependencies": {
40
+ "@opencrvs/events": "^1.9.0",
41
+ "@types/object-hash": "^3.0.6",
36
42
  "@types/uuid": "^9.0.3",
37
43
  "esbuild": "^0.24.0",
38
- "typescript": "^5.6.3",
39
- "@opencrvs/events": "^1.9.0",
40
- "@types/object-hash": "^3.0.6"
44
+ "typescript": "^5.6.3"
41
45
  },
42
46
  "moduleNameMapper": {
43
47
  "@opencrvs/commons/events": "@opencrvs/commons/build/dist/common/events/index.js",
package/tsconfig.json CHANGED
@@ -20,6 +20,9 @@
20
20
  "@opencrvs/commons/events/deduplication": [
21
21
  "../commons/src/events/deduplication.ts"
22
22
  ],
23
+ "@opencrvs/commons/scopes.deprecated.do-not-use": [
24
+ "../commons/src/scopes.deprecated.do-not-use.ts"
25
+ ],
23
26
  "@opencrvs/commons/notification": [
24
27
  "../commons/src/notification/index.ts"
25
28
  ],
@@ -1 +1 @@
1
- {"root":["./src/api/index.ts","./src/application-config/index.ts","./src/conditionals/index.ts","./src/events/deduplication.ts","./src/events/index.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/convert-config-files-to-ts.ts","./src/migrations/v2.0/convert-paragraph-to-heading.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/notification/index.ts","./src/scopes/index.ts"],"version":"5.6.3"}