@opencrvs/toolkit 2.1.0-rc.d876831 → 2.1.0-rc.d987aec

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 (81) hide show
  1. package/README.md +2 -12
  2. package/build.sh +9 -1
  3. package/create-countryconfig/index.js +412 -59
  4. package/create-countryconfig/node_modules/.bin/degit +21 -0
  5. package/create-countryconfig/package.json +4 -1
  6. package/dist/application-config/index.js +248 -215
  7. package/dist/authentication/index.d.ts +67 -0
  8. package/dist/authentication/index.d.ts.map +1 -0
  9. package/dist/authentication/index.js +750 -0
  10. package/dist/cli.js +1650 -100
  11. package/dist/commons/api/router.d.ts +407 -50
  12. package/dist/commons/conditionals/conditionals.d.ts +6 -6
  13. package/dist/commons/conditionals/validate.d.ts +7 -3
  14. package/dist/commons/events/ActionDocument.d.ts +4 -4
  15. package/dist/commons/events/ActionInput.d.ts +4 -4
  16. package/dist/commons/events/AdvancedSearchConfig.d.ts +12 -0
  17. package/dist/commons/events/EventDocument.d.ts +470 -2
  18. package/dist/commons/events/EventMetadata.d.ts +1 -11
  19. package/dist/commons/events/EventStatus.d.ts +19 -0
  20. package/dist/commons/events/FieldConfig.d.ts +24 -5
  21. package/dist/commons/events/FieldTypeMapping.d.ts +15 -15
  22. package/dist/commons/events/locations.d.ts +63 -10
  23. package/dist/commons/events/test.utils.d.ts +25 -4
  24. package/dist/commons/events/utils.d.ts +13 -2
  25. package/dist/commons/notification/UserNotifications.d.ts +28 -13
  26. package/dist/commons/notification/dispatch.d.ts +10 -0
  27. package/dist/commons/notification/index.d.ts +1 -0
  28. package/dist/conditionals/index.js +79 -57
  29. package/dist/csv.d.ts +25 -0
  30. package/dist/csv.d.ts.map +1 -0
  31. package/dist/csv.js +120 -0
  32. package/dist/environment/logger.d.ts +3 -0
  33. package/dist/environment/logger.d.ts.map +1 -1
  34. package/dist/environment/manage-users.js +1 -1
  35. package/dist/environment/questions.d.ts.map +1 -1
  36. package/dist/environment/questions.js +20 -14
  37. package/dist/environment/setup-environment.js +26 -6
  38. package/dist/environment/templates.d.ts +0 -1
  39. package/dist/environment/templates.d.ts.map +1 -1
  40. package/dist/environment/templates.js +3 -8
  41. package/dist/events/index.js +2632 -2481
  42. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
  43. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  44. package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
  45. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
  46. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
  47. package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
  48. package/dist/migrations/v2.1/add-translations.d.ts +9 -0
  49. package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
  50. package/dist/migrations/v2.1/add-translations.js +213 -0
  51. package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
  52. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
  53. package/dist/migrations/v2.1/enable-telemetry.js +438 -0
  54. package/dist/migrations/v2.1/index.d.ts.map +1 -1
  55. package/dist/migrations/v2.1/index.js +1058 -0
  56. package/dist/notification/index.js +1027 -1452
  57. package/dist/scopes/index.d.ts +77 -7
  58. package/dist/scopes/index.js +79 -57
  59. package/dist/telemetry/index.d.ts +45 -0
  60. package/dist/telemetry/index.d.ts.map +1 -0
  61. package/dist/telemetry/index.js +39 -0
  62. package/dist/templates/charts-values/dependencies/values.yaml +2 -0
  63. package/dist/templates/charts-values/opencrvs-services/values.yaml +1 -1
  64. package/dist/templates/charts-values/opentelemetry/values.yaml +22 -0
  65. package/dist/templates/charts-values/traefik/values.yaml +23 -9
  66. package/dist/templates/inventory/inventory.template.yml +1 -3
  67. package/dist/translations/check.d.ts +21 -0
  68. package/dist/translations/check.d.ts.map +1 -0
  69. package/dist/translations/check.js +132 -0
  70. package/dist/verify/endpoints.d.ts +2 -0
  71. package/dist/verify/endpoints.d.ts.map +1 -0
  72. package/dist/verify/endpoints.js +345 -0
  73. package/opencrvs-toolkit-2.1.0-rc.d987aec.tgz +0 -0
  74. package/package.json +9 -4
  75. package/tsconfig.build.json +11 -0
  76. package/tsconfig.build.tsbuildinfo +1 -0
  77. package/tsconfig.json +3 -0
  78. package/dist/templates/inventory/production.example.yml +0 -77
  79. package/dist/templates/inventory/qa.example.yml +0 -48
  80. package/opencrvs-toolkit-2.1.0-rc.d876831.tgz +0 -0
  81. package/tsconfig.tsbuildinfo +0 -1
@@ -85,17 +85,17 @@ export declare const now: typeof todayDateTimeValueSerializer;
85
85
  export declare const user: typeof userSerializer & {
86
86
  scope: (scope: import("../scopes").ScopeType) => {
87
87
  attribute: (option: import("../scopes").ScopeOptionKey) => {
88
- $scope: "attachment.upload" | "bypassratelimit" | "config.update-all" | "dashboard.view" | "integration.create" | "location.edit" | "organisation.read-locations" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "profile.electronic-signature" | "record.archive" | "record.confirm-registration" | "record.correct" | "record.create" | "record.custom-action" | "record.declare" | "record.edit" | "record.import" | "record.notify" | "record.print-certified-copies" | "record.read" | "record.register" | "record.reindex" | "record.reject" | "record.reject-registration" | "record.request-correction" | "record.review-duplicates" | "record.search" | "record.unarchive" | "record.unassign-others" | "user.create" | "user.data-seeding" | "user.edit" | "user.read" | "user.read-only-my-audit" | "user.search" | "workqueue";
89
- $option: "accessLevel" | "declaredBy" | "declaredIn" | "event" | "flags" | "ids" | "notifiedBy" | "notifiedIn" | "placeOfEvent" | "registeredBy" | "registeredIn" | "role";
88
+ $scope: "attachment.upload" | "bypassratelimit" | "config.update-all" | "dashboard.view" | "integration.audit.read" | "integration.create" | "location.edit" | "organisation.read-locations" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "profile.electronic-signature" | "record.archive" | "record.confirm-registration" | "record.correct" | "record.create" | "record.custom-action" | "record.declare" | "record.edit" | "record.import" | "record.notify" | "record.print-certified-copies" | "record.read" | "record.register" | "record.reindex" | "record.reject" | "record.reject-registration" | "record.request-correction" | "record.review-duplicates" | "record.search" | "record.unarchive" | "record.unassign-others" | "user.create" | "user.data-seeding" | "user.edit" | "user.read" | "user.read-only-my-audit" | "user.search" | "workqueue";
89
+ $option: "accessLevel" | "declaredBy" | "declaredIn" | "event" | "flags" | "ids" | "notifiedBy" | "notifiedIn" | "placeOfEvent" | "registeredBy" | "registeredIn" | "role" | "status";
90
90
  };
91
91
  };
92
92
  jurisdiction: (jurisdiction: import("../scopes").JurisdictionFilter | {
93
- $scope: "attachment.upload" | "bypassratelimit" | "config.update-all" | "dashboard.view" | "integration.create" | "location.edit" | "organisation.read-locations" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "profile.electronic-signature" | "record.archive" | "record.confirm-registration" | "record.correct" | "record.create" | "record.custom-action" | "record.declare" | "record.edit" | "record.import" | "record.notify" | "record.print-certified-copies" | "record.read" | "record.register" | "record.reindex" | "record.reject" | "record.reject-registration" | "record.request-correction" | "record.review-duplicates" | "record.search" | "record.unarchive" | "record.unassign-others" | "user.create" | "user.data-seeding" | "user.edit" | "user.read" | "user.read-only-my-audit" | "user.search" | "workqueue";
94
- $option: "accessLevel" | "declaredBy" | "declaredIn" | "event" | "flags" | "ids" | "notifiedBy" | "notifiedIn" | "placeOfEvent" | "registeredBy" | "registeredIn" | "role";
93
+ $scope: "attachment.upload" | "bypassratelimit" | "config.update-all" | "dashboard.view" | "integration.audit.read" | "integration.create" | "location.edit" | "organisation.read-locations" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "profile.electronic-signature" | "record.archive" | "record.confirm-registration" | "record.correct" | "record.create" | "record.custom-action" | "record.declare" | "record.edit" | "record.import" | "record.notify" | "record.print-certified-copies" | "record.read" | "record.register" | "record.reindex" | "record.reject" | "record.reject-registration" | "record.request-correction" | "record.review-duplicates" | "record.search" | "record.unarchive" | "record.unassign-others" | "user.create" | "user.data-seeding" | "user.edit" | "user.read" | "user.read-only-my-audit" | "user.search" | "workqueue";
94
+ $option: "accessLevel" | "declaredBy" | "declaredIn" | "event" | "flags" | "ids" | "notifiedBy" | "notifiedIn" | "placeOfEvent" | "registeredBy" | "registeredIn" | "role" | "status";
95
95
  }) => {
96
96
  $jurisdiction: "administrativeArea" | "all" | "location" | {
97
- $scope: "attachment.upload" | "bypassratelimit" | "config.update-all" | "dashboard.view" | "integration.create" | "location.edit" | "organisation.read-locations" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "profile.electronic-signature" | "record.archive" | "record.confirm-registration" | "record.correct" | "record.create" | "record.custom-action" | "record.declare" | "record.edit" | "record.import" | "record.notify" | "record.print-certified-copies" | "record.read" | "record.register" | "record.reindex" | "record.reject" | "record.reject-registration" | "record.request-correction" | "record.review-duplicates" | "record.search" | "record.unarchive" | "record.unassign-others" | "user.create" | "user.data-seeding" | "user.edit" | "user.read" | "user.read-only-my-audit" | "user.search" | "workqueue";
98
- $option: "accessLevel" | "declaredBy" | "declaredIn" | "event" | "flags" | "ids" | "notifiedBy" | "notifiedIn" | "placeOfEvent" | "registeredBy" | "registeredIn" | "role";
97
+ $scope: "attachment.upload" | "bypassratelimit" | "config.update-all" | "dashboard.view" | "integration.audit.read" | "integration.create" | "location.edit" | "organisation.read-locations" | "performance.read" | "performance.read-dashboards" | "performance.vital-statistics-export" | "profile.electronic-signature" | "record.archive" | "record.confirm-registration" | "record.correct" | "record.create" | "record.custom-action" | "record.declare" | "record.edit" | "record.import" | "record.notify" | "record.print-certified-copies" | "record.read" | "record.register" | "record.reindex" | "record.reject" | "record.reject-registration" | "record.request-correction" | "record.review-duplicates" | "record.search" | "record.unarchive" | "record.unassign-others" | "user.create" | "user.data-seeding" | "user.edit" | "user.read" | "user.read-only-my-audit" | "user.search" | "workqueue";
98
+ $option: "accessLevel" | "declaredBy" | "declaredIn" | "event" | "flags" | "ids" | "notifiedBy" | "notifiedIn" | "placeOfEvent" | "registeredBy" | "registeredIn" | "role" | "status";
99
99
  };
100
100
  };
101
101
  hasScope: (scope: string) => JSONSchema;
@@ -75,15 +75,19 @@ export declare function areConditionsMet(conditions: FieldConditional[], values:
75
75
  * evaluated against the event, e.g. `flag('sealed')`), returns whether the
76
76
  * field is currently secured for the given event.
77
77
  */
78
- export declare function isFieldSecured(field: Pick<FieldConfig, 'secured'>, event: EventIndex, context?: ValidatorContext): boolean;
78
+ export declare function isFieldSecured(field: Pick<FieldConfig, 'secured'>, event: EventIndex, context: ValidatorContext): boolean;
79
+ export type EventValidatorContext = {
80
+ document: EventDocument;
81
+ state: EventIndex;
82
+ };
83
+ export declare function getEventValidatorContext(document: EventDocument, config: EventConfig): EventValidatorContext;
79
84
  export type ValidatorContext = {
80
85
  user?: ITokenPayload;
81
86
  leafAdminStructureLocationIds?: Array<{
82
87
  id: UUID;
83
88
  }>;
84
- event?: EventDocument;
85
- eventConfig?: EventConfig;
86
89
  baseFormState?: EventState;
90
+ event?: EventValidatorContext;
87
91
  };
88
92
  export declare function isFieldVisible(field: FieldConfig, form: Partial<ActionUpdate | EventState>, context: ValidatorContext): boolean;
89
93
  export declare function isFieldEnabled(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
@@ -380,9 +380,9 @@ export declare const ActionDocument: z.ZodDiscriminatedUnion<[z.ZodObject<{
380
380
  }>;
381
381
  originalActionId: z.ZodNullable<z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
382
382
  type: z.ZodLiteral<"ARCHIVE">;
383
- content: z.ZodObject<{
383
+ content: z.ZodOptional<z.ZodObject<{
384
384
  reason: z.ZodString;
385
- }, z.core.$strip>;
385
+ }, z.core.$strip>>;
386
386
  }, z.core.$strip>, z.ZodObject<{
387
387
  id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
388
388
  transactionId: z.ZodString;
@@ -843,9 +843,9 @@ export declare const Action: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.Zod
843
843
  }>;
844
844
  originalActionId: z.ZodNullable<z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
845
845
  type: z.ZodLiteral<"ARCHIVE">;
846
- content: z.ZodObject<{
846
+ content: z.ZodOptional<z.ZodObject<{
847
847
  reason: z.ZodString;
848
- }, z.core.$strip>;
848
+ }, z.core.$strip>>;
849
849
  }, z.core.$strip>, z.ZodObject<{
850
850
  id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
851
851
  transactionId: z.ZodString;
@@ -163,9 +163,9 @@ export declare const ArchiveActionInput: z.ZodObject<{
163
163
  waitFor: z.ZodDefault<z.ZodBoolean>;
164
164
  createdAtLocation: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
165
165
  type: z.ZodDefault<z.ZodLiteral<"ARCHIVE">>;
166
- content: z.ZodObject<{
166
+ content: z.ZodOptional<z.ZodObject<{
167
167
  reason: z.ZodString;
168
- }, z.core.$strip>;
168
+ }, z.core.$strip>>;
169
169
  }, z.core.$strip>;
170
170
  export type ArchiveActionInput = z.infer<typeof ArchiveActionInput>;
171
171
  export declare const UnarchiveActionInput: z.ZodObject<{
@@ -424,9 +424,9 @@ export declare const ActionInput: z.ZodDiscriminatedUnion<[z.ZodObject<{
424
424
  waitFor: z.ZodDefault<z.ZodBoolean>;
425
425
  createdAtLocation: z.ZodOptional<z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>>;
426
426
  type: z.ZodDefault<z.ZodLiteral<"ARCHIVE">>;
427
- content: z.ZodObject<{
427
+ content: z.ZodOptional<z.ZodObject<{
428
428
  reason: z.ZodString;
429
- }, z.core.$strip>;
429
+ }, z.core.$strip>>;
430
430
  }, z.core.$strip>, z.ZodObject<{
431
431
  eventId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
432
432
  transactionId: z.ZodString;
@@ -102,6 +102,7 @@ export declare const FieldConfigSchema: z.ZodObject<{
102
102
  bypassratelimit: "bypassratelimit";
103
103
  "config.update-all": "config.update-all";
104
104
  "dashboard.view": "dashboard.view";
105
+ "integration.audit.read": "integration.audit.read";
105
106
  "integration.create": "integration.create";
106
107
  "location.edit": "location.edit";
107
108
  "organisation.read-locations": "organisation.read-locations";
@@ -150,6 +151,7 @@ export declare const FieldConfigSchema: z.ZodObject<{
150
151
  registeredBy: "registeredBy";
151
152
  registeredIn: "registeredIn";
152
153
  role: "role";
154
+ status: "status";
153
155
  }>;
154
156
  }, z.core.$strip>]>;
155
157
  }, z.core.$strip>>;
@@ -284,6 +286,7 @@ export declare const EventFieldConfigSchema: z.ZodObject<{
284
286
  bypassratelimit: "bypassratelimit";
285
287
  "config.update-all": "config.update-all";
286
288
  "dashboard.view": "dashboard.view";
289
+ "integration.audit.read": "integration.audit.read";
287
290
  "integration.create": "integration.create";
288
291
  "location.edit": "location.edit";
289
292
  "organisation.read-locations": "organisation.read-locations";
@@ -332,6 +335,7 @@ export declare const EventFieldConfigSchema: z.ZodObject<{
332
335
  registeredBy: "registeredBy";
333
336
  registeredIn: "registeredIn";
334
337
  role: "role";
338
+ status: "status";
335
339
  }>;
336
340
  }, z.core.$strip>]>;
337
341
  }, z.core.$strip>>;
@@ -442,6 +446,7 @@ export declare const AdvancedSearchField: z.ZodDiscriminatedUnion<[z.ZodObject<{
442
446
  bypassratelimit: "bypassratelimit";
443
447
  "config.update-all": "config.update-all";
444
448
  "dashboard.view": "dashboard.view";
449
+ "integration.audit.read": "integration.audit.read";
445
450
  "integration.create": "integration.create";
446
451
  "location.edit": "location.edit";
447
452
  "organisation.read-locations": "organisation.read-locations";
@@ -490,6 +495,7 @@ export declare const AdvancedSearchField: z.ZodDiscriminatedUnion<[z.ZodObject<{
490
495
  registeredBy: "registeredBy";
491
496
  registeredIn: "registeredIn";
492
497
  role: "role";
498
+ status: "status";
493
499
  }>;
494
500
  }, z.core.$strip>]>;
495
501
  }, z.core.$strip>>;
@@ -592,6 +598,7 @@ export declare const AdvancedSearchField: z.ZodDiscriminatedUnion<[z.ZodObject<{
592
598
  bypassratelimit: "bypassratelimit";
593
599
  "config.update-all": "config.update-all";
594
600
  "dashboard.view": "dashboard.view";
601
+ "integration.audit.read": "integration.audit.read";
595
602
  "integration.create": "integration.create";
596
603
  "location.edit": "location.edit";
597
604
  "organisation.read-locations": "organisation.read-locations";
@@ -640,6 +647,7 @@ export declare const AdvancedSearchField: z.ZodDiscriminatedUnion<[z.ZodObject<{
640
647
  registeredBy: "registeredBy";
641
648
  registeredIn: "registeredIn";
642
649
  role: "role";
650
+ status: "status";
643
651
  }>;
644
652
  }, z.core.$strip>]>;
645
653
  }, z.core.$strip>>;
@@ -753,6 +761,7 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
753
761
  bypassratelimit: "bypassratelimit";
754
762
  "config.update-all": "config.update-all";
755
763
  "dashboard.view": "dashboard.view";
764
+ "integration.audit.read": "integration.audit.read";
756
765
  "integration.create": "integration.create";
757
766
  "location.edit": "location.edit";
758
767
  "organisation.read-locations": "organisation.read-locations";
@@ -801,6 +810,7 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
801
810
  registeredBy: "registeredBy";
802
811
  registeredIn: "registeredIn";
803
812
  role: "role";
813
+ status: "status";
804
814
  }>;
805
815
  }, z.core.$strip>]>;
806
816
  }, z.core.$strip>>;
@@ -903,6 +913,7 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
903
913
  bypassratelimit: "bypassratelimit";
904
914
  "config.update-all": "config.update-all";
905
915
  "dashboard.view": "dashboard.view";
916
+ "integration.audit.read": "integration.audit.read";
906
917
  "integration.create": "integration.create";
907
918
  "location.edit": "location.edit";
908
919
  "organisation.read-locations": "organisation.read-locations";
@@ -951,6 +962,7 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
951
962
  registeredBy: "registeredBy";
952
963
  registeredIn: "registeredIn";
953
964
  role: "role";
965
+ status: "status";
954
966
  }>;
955
967
  }, z.core.$strip>]>;
956
968
  }, z.core.$strip>>;