@opencrvs/toolkit 2.1.0-rc.bb6887b → 2.1.0-rc.bed50b3
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.
- package/README.md +3 -12
- package/build.sh +12 -4
- package/create-countryconfig/index.js +412 -59
- package/create-countryconfig/node_modules/.bin/degit +21 -0
- package/create-countryconfig/package.json +4 -1
- package/dist/application-config/index.js +346 -277
- package/dist/authentication/index.d.ts +67 -0
- package/dist/authentication/index.d.ts.map +1 -0
- package/dist/authentication/index.js +754 -0
- package/dist/cli.js +1944 -283
- package/dist/commons/api/router.d.ts +689 -110
- package/dist/commons/conditionals/conditionals.d.ts +6 -6
- package/dist/commons/conditionals/validate.d.ts +16 -5
- package/dist/commons/events/ActionConfig.d.ts +4 -0
- package/dist/commons/events/ActionDocument.d.ts +5 -11
- package/dist/commons/events/ActionInput.d.ts +4 -4
- package/dist/commons/events/ActionStatus.d.ts +14 -0
- package/dist/commons/events/AdvancedSearchConfig.d.ts +36 -0
- package/dist/commons/events/AuditLog.d.ts +147 -0
- package/dist/commons/events/EventConfig.d.ts +3 -0
- package/dist/commons/events/EventDocument.d.ts +470 -2
- package/dist/commons/events/EventIndex.d.ts +3 -26
- package/dist/commons/events/EventMetadata.d.ts +1 -11
- package/dist/commons/events/EventStatus.d.ts +19 -0
- package/dist/commons/events/FieldConfig.d.ts +99 -53
- package/dist/commons/events/FieldTypeMapping.d.ts +27 -27
- package/dist/commons/events/FieldValue.d.ts +2 -2
- package/dist/commons/events/Flag.d.ts +42 -0
- package/dist/commons/events/FormConfig.d.ts +6 -0
- package/dist/commons/events/PageConfig.d.ts +4 -0
- package/dist/commons/events/PlainDate.d.ts +8 -0
- package/dist/commons/events/SummaryConfig.d.ts +249 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +17 -14
- package/dist/commons/events/event.d.ts +12 -0
- package/dist/commons/events/index.d.ts +1 -0
- package/dist/commons/events/locationPayloads.d.ts +95 -0
- package/dist/commons/events/locations.d.ts +169 -26
- package/dist/commons/events/mocks.test.utils.d.ts +30 -0
- package/dist/commons/events/test.utils.d.ts +25 -4
- package/dist/commons/events/utils.d.ts +17 -2
- package/dist/commons/notification/UserNotifications.d.ts +28 -13
- package/dist/commons/notification/dispatch.d.ts +10 -0
- package/dist/commons/notification/index.d.ts +1 -0
- package/dist/conditionals/index.js +334 -60
- package/dist/csv.d.ts +25 -0
- package/dist/csv.d.ts.map +1 -0
- package/dist/csv.js +120 -0
- package/dist/environment/index.d.ts +1 -0
- package/dist/environment/index.d.ts.map +1 -1
- package/dist/environment/index.js +10 -0
- package/dist/environment/logger.d.ts +15 -3
- package/dist/environment/logger.d.ts.map +1 -1
- package/dist/environment/manage-users.js +1 -1
- package/dist/environment/paths.d.ts +7 -0
- package/dist/environment/paths.d.ts.map +1 -0
- package/dist/environment/paths.js +72 -0
- package/dist/environment/questions.d.ts.map +1 -1
- package/dist/environment/questions.js +20 -14
- package/dist/environment/setup-environment.js +47 -28
- package/dist/environment/templates.d.ts +0 -1
- package/dist/environment/templates.d.ts.map +1 -1
- package/dist/environment/templates.js +5 -9
- package/dist/environment/update-workflows.d.ts.map +1 -1
- package/dist/environment/update-workflows.js +21 -5
- package/dist/environment/upgrade.d.ts +2 -0
- package/dist/environment/upgrade.d.ts.map +1 -0
- package/dist/environment/upgrade.js +82 -0
- package/dist/environment/users.js +11 -13
- package/dist/environment/utils.d.ts +0 -12
- package/dist/environment/utils.d.ts.map +1 -1
- package/dist/environment/utils.js +1 -28
- package/dist/events/index.js +7659 -7152
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
- package/dist/migrations/v2.0/merge-infrastructure-directory.js +3 -3
- package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
- package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
- package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
- package/dist/migrations/v2.1/add-translations.d.ts +9 -0
- package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
- package/dist/migrations/v2.1/add-translations.js +213 -0
- package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
- package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
- package/dist/migrations/v2.1/enable-telemetry.js +455 -0
- package/dist/migrations/v2.1/index.d.ts.map +1 -1
- package/dist/migrations/v2.1/index.js +1081 -0
- package/dist/notification/index.js +1844 -1422
- package/dist/scopes/index.d.ts +435 -32
- package/dist/scopes/index.js +335 -60
- package/dist/telemetry/index.d.ts +45 -0
- package/dist/telemetry/index.d.ts.map +1 -0
- package/dist/telemetry/index.js +43 -0
- package/dist/templates/charts-values/dependencies/values.yaml +2 -0
- package/dist/templates/charts-values/opencrvs-services/values.yaml +4 -3
- package/dist/templates/charts-values/opentelemetry/values.yaml +95 -0
- package/dist/templates/charts-values/traefik/values.yaml +23 -9
- package/dist/templates/inventory/inventory.template.yml +1 -3
- package/dist/translations/check.d.ts +21 -0
- package/dist/translations/check.d.ts.map +1 -0
- package/dist/translations/check.js +132 -0
- package/dist/verify/endpoints.d.ts +2 -0
- package/dist/verify/endpoints.d.ts.map +1 -0
- package/dist/verify/endpoints.js +345 -0
- package/opencrvs-toolkit-2.1.0-rc.bed50b3.tgz +0 -0
- package/package.json +13 -7
- package/tsconfig.build.json +11 -0
- package/tsconfig.build.tsbuildinfo +1 -0
- package/tsconfig.json +3 -0
- package/dist/templates/inventory/production.example.yml +0 -77
- package/dist/templates/inventory/qa.example.yml +0 -48
- package/opencrvs-toolkit-2.1.0-rc.bb6887b.tgz +0 -0
- package/tsconfig.tsbuildinfo +0 -1
|
@@ -42,7 +42,7 @@ __export(application_config_exports, {
|
|
|
42
42
|
module.exports = __toCommonJS(application_config_exports);
|
|
43
43
|
|
|
44
44
|
// ../commons/src/application-config.ts
|
|
45
|
-
var
|
|
45
|
+
var z21 = __toESM(require("zod/v4"));
|
|
46
46
|
|
|
47
47
|
// ../commons/src/events/FieldConfig.ts
|
|
48
48
|
var import_v43 = __toESM(require("zod/v4"));
|
|
@@ -497,10 +497,10 @@ var SerializedUserField = z9.object({
|
|
|
497
497
|
var import_v4 = require("zod/v4");
|
|
498
498
|
|
|
499
499
|
// ../commons/src/events/EventMetadata.ts
|
|
500
|
-
var
|
|
500
|
+
var z16 = __toESM(require("zod/v4"));
|
|
501
501
|
|
|
502
502
|
// ../commons/src/events/ActionDocument.ts
|
|
503
|
-
var
|
|
503
|
+
var z15 = __toESM(require("zod/v4"));
|
|
504
504
|
|
|
505
505
|
// ../commons/src/events/ActionType.ts
|
|
506
506
|
var z10 = __toESM(require("zod/v4"));
|
|
@@ -612,16 +612,98 @@ var META_ACTIONS = [
|
|
|
612
612
|
|
|
613
613
|
// ../commons/src/authentication.ts
|
|
614
614
|
var import_jwt_decode = __toESM(require("jwt-decode"));
|
|
615
|
-
var
|
|
615
|
+
var z14 = __toESM(require("zod/v4"));
|
|
616
616
|
|
|
617
617
|
// ../commons/src/scopes.ts
|
|
618
|
-
var
|
|
618
|
+
var z13 = __toESM(require("zod/v4"));
|
|
619
619
|
var qs = __toESM(require("qs"));
|
|
620
|
-
|
|
620
|
+
|
|
621
|
+
// ../commons/src/events/ActionStatus.ts
|
|
622
|
+
var ActionStatus = {
|
|
623
|
+
Requested: "Requested",
|
|
624
|
+
Accepted: "Accepted",
|
|
625
|
+
Rejected: "Rejected"
|
|
626
|
+
};
|
|
627
|
+
|
|
628
|
+
// ../commons/src/events/Flag.ts
|
|
629
|
+
var z11 = __toESM(require("zod/v4"));
|
|
630
|
+
var InherentFlags = {
|
|
631
|
+
INCOMPLETE: "incomplete",
|
|
632
|
+
REJECTED: "rejected",
|
|
633
|
+
CORRECTION_REQUESTED: "correction-requested",
|
|
634
|
+
POTENTIAL_DUPLICATE: "potential-duplicate",
|
|
635
|
+
/**
|
|
636
|
+
* This flag is set by the Edit-action and removed after the declaration or registration.
|
|
637
|
+
* A record should never stay with the EDIT_IN_PROGRESS flag, since it should always be declared or registered right after.
|
|
638
|
+
*
|
|
639
|
+
* We only use this flag to determine that a NOTIFY, DECLARE or REGISTER action is allowed next.
|
|
640
|
+
*/
|
|
641
|
+
EDIT_IN_PROGRESS: "edit-in-progress"
|
|
642
|
+
};
|
|
643
|
+
var actionFlagPattern;
|
|
644
|
+
function getActionFlagPattern() {
|
|
645
|
+
actionFlagPattern ??= new RegExp(
|
|
646
|
+
`^(${Object.values(ActionType).join("|").toLowerCase()}):(${Object.values(
|
|
647
|
+
ActionStatus
|
|
648
|
+
).join("|").toLowerCase()})$`
|
|
649
|
+
);
|
|
650
|
+
return actionFlagPattern;
|
|
651
|
+
}
|
|
652
|
+
var ActionFlag = z11.string().refine((value) => getActionFlagPattern().test(value), {
|
|
653
|
+
message: "Flag must be in the format ActionType:ActionStatus (lowerCase)"
|
|
654
|
+
});
|
|
655
|
+
var CustomFlag = z11.string().refine((val) => !Object.values(InherentFlags).includes(val), {
|
|
656
|
+
message: `Custom flag cannot be one of the inherent flags: ${Object.values(
|
|
657
|
+
InherentFlags
|
|
658
|
+
).join(", ")}`
|
|
659
|
+
}).refine((val) => !ActionFlag.safeParse(val).success, {
|
|
660
|
+
message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
|
|
661
|
+
}).describe("Custom flag identifier defined by the country config.");
|
|
662
|
+
var Flag = ActionFlag.or(z11.enum(InherentFlags)).or(CustomFlag);
|
|
663
|
+
var ContainsFlags = z11.object({
|
|
664
|
+
anyOf: z11.array(Flag).optional(),
|
|
665
|
+
noneOf: z11.array(Flag).optional(),
|
|
666
|
+
allOf: z11.array(Flag).optional()
|
|
667
|
+
}).meta({
|
|
668
|
+
id: "ContainsFlags"
|
|
669
|
+
});
|
|
670
|
+
var FlagConfig = z11.object({
|
|
671
|
+
id: CustomFlag,
|
|
672
|
+
requiresAction: z11.boolean().describe(
|
|
673
|
+
"Indicates if this flag expects an action to be performed to be cleared."
|
|
674
|
+
),
|
|
675
|
+
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
676
|
+
}).meta({
|
|
677
|
+
id: "FlagConfig",
|
|
678
|
+
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
679
|
+
});
|
|
680
|
+
var ActionFlagConfig = z11.object({
|
|
681
|
+
id: Flag,
|
|
682
|
+
operation: z11.enum(["add", "remove"]).describe("Operation to perform on the flag."),
|
|
683
|
+
conditional: Conditional.optional().describe(
|
|
684
|
+
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
685
|
+
)
|
|
686
|
+
}).meta({
|
|
687
|
+
id: "ActionFlagConfig",
|
|
688
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
689
|
+
});
|
|
690
|
+
|
|
691
|
+
// ../commons/src/events/EventStatus.ts
|
|
692
|
+
var z12 = __toESM(require("zod/v4"));
|
|
693
|
+
var EventStatus = z12.enum([
|
|
694
|
+
"CREATED",
|
|
695
|
+
"NOTIFIED",
|
|
696
|
+
"DECLARED",
|
|
697
|
+
"REGISTERED",
|
|
698
|
+
"ARCHIVED"
|
|
699
|
+
]);
|
|
700
|
+
|
|
701
|
+
// ../commons/src/scopes.ts
|
|
702
|
+
var JurisdictionFilter = z13.enum(["administrativeArea", "location", "all"]).describe(
|
|
621
703
|
"Filters based on user jurisdiction relative to their office location in hierarchy."
|
|
622
704
|
);
|
|
623
|
-
var UserFilter =
|
|
624
|
-
var RecordScopeTypeV2 =
|
|
705
|
+
var UserFilter = z13.enum(["user"]).describe("Filters based on the user. Limits to self.");
|
|
706
|
+
var RecordScopeTypeV2 = z13.enum([
|
|
625
707
|
"record.search",
|
|
626
708
|
"record.create",
|
|
627
709
|
"record.read",
|
|
@@ -639,14 +721,20 @@ var RecordScopeTypeV2 = z11.enum([
|
|
|
639
721
|
"record.unassign-others",
|
|
640
722
|
"record.custom-action"
|
|
641
723
|
]);
|
|
642
|
-
var PlainScopeType =
|
|
724
|
+
var PlainScopeType = z13.enum([
|
|
643
725
|
// Misc. system scopes
|
|
644
726
|
"bypassratelimit",
|
|
645
727
|
"record.reindex",
|
|
646
728
|
"user.data-seeding",
|
|
647
729
|
"integration.create",
|
|
730
|
+
// Reading an integration's audit log. Deliberately separate from
|
|
731
|
+
// 'integration.create' so read-only oversight can be granted on its own, and
|
|
732
|
+
// deliberately option-less: system clients have no office and no
|
|
733
|
+
// administrative area, so jurisdiction options would have nothing to bind to.
|
|
734
|
+
"integration.audit.read",
|
|
648
735
|
"record.import",
|
|
649
736
|
"config.update-all",
|
|
737
|
+
"location.edit",
|
|
650
738
|
"attachment.upload",
|
|
651
739
|
"profile.electronic-signature",
|
|
652
740
|
"user.read-only-my-audit",
|
|
@@ -658,72 +746,85 @@ var PlainScopeType = z11.enum([
|
|
|
658
746
|
"record.confirm-registration",
|
|
659
747
|
"record.reject-registration"
|
|
660
748
|
]);
|
|
661
|
-
var scopeByEvent =
|
|
749
|
+
var scopeByEvent = z13.preprocess(
|
|
662
750
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
663
|
-
|
|
751
|
+
z13.array(z13.string()).optional()
|
|
664
752
|
).describe("Event type, e.g. birth, death");
|
|
665
|
-
var
|
|
753
|
+
var scopeByStatus = z13.preprocess(
|
|
754
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
755
|
+
z13.array(EventStatus).optional()
|
|
756
|
+
).describe(
|
|
757
|
+
"Restricts the scope to records currently in one of these statuses."
|
|
758
|
+
);
|
|
759
|
+
var userRole = z13.preprocess(
|
|
666
760
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
667
|
-
|
|
761
|
+
z13.array(z13.string()).optional()
|
|
668
762
|
).describe("User role, e.g. admin, field agent");
|
|
669
|
-
var scopeOptionsPlaceEvent =
|
|
763
|
+
var scopeOptionsPlaceEvent = z13.object({
|
|
670
764
|
event: scopeByEvent,
|
|
671
|
-
placeOfEvent: JurisdictionFilter.optional()
|
|
765
|
+
placeOfEvent: JurisdictionFilter.optional(),
|
|
766
|
+
createdBy: UserFilter.optional(),
|
|
767
|
+
createdIn: JurisdictionFilter.optional()
|
|
672
768
|
}).describe("Options applicable to all record scopes.");
|
|
673
769
|
var scopeOptionsDeclaredOrNotified = scopeOptionsPlaceEvent.extend({
|
|
674
770
|
notifiedIn: JurisdictionFilter.optional(),
|
|
675
771
|
notifiedBy: UserFilter.optional(),
|
|
676
772
|
declaredIn: JurisdictionFilter.optional(),
|
|
677
|
-
declaredBy: UserFilter.optional()
|
|
773
|
+
declaredBy: UserFilter.optional(),
|
|
774
|
+
status: scopeByStatus
|
|
678
775
|
}).describe("Options applicable to actions that may take place after DECLARE");
|
|
679
776
|
var AllRecordScopeOptions = scopeOptionsDeclaredOrNotified.extend({
|
|
680
777
|
registeredIn: JurisdictionFilter.optional(),
|
|
681
|
-
registeredBy: UserFilter.optional()
|
|
778
|
+
registeredBy: UserFilter.optional(),
|
|
779
|
+
flags: ContainsFlags.optional()
|
|
682
780
|
}).describe(
|
|
683
781
|
"Options applicable to actions that may take place after REGISTER, with full filtering capabilities."
|
|
684
782
|
);
|
|
685
783
|
var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
686
|
-
customActionTypes:
|
|
784
|
+
customActionTypes: z13.preprocess(
|
|
687
785
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
688
|
-
|
|
786
|
+
z13.array(z13.string()).optional()
|
|
689
787
|
).describe("Allowed custom action types")
|
|
690
788
|
});
|
|
691
|
-
var AccessLevelOptions =
|
|
789
|
+
var AccessLevelOptions = z13.object({
|
|
692
790
|
accessLevel: JurisdictionFilter.optional()
|
|
693
791
|
});
|
|
694
792
|
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
695
793
|
role: userRole.optional()
|
|
696
794
|
});
|
|
697
|
-
var WorkqueueOrDashboardOptions =
|
|
698
|
-
ids:
|
|
795
|
+
var WorkqueueOrDashboardOptions = z13.object({
|
|
796
|
+
ids: z13.preprocess(
|
|
699
797
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
700
|
-
|
|
798
|
+
z13.array(z13.string())
|
|
701
799
|
).describe("Must contain a list of workqueue or dashboard ids.")
|
|
702
800
|
});
|
|
703
|
-
var AllScopeOptions =
|
|
801
|
+
var AllScopeOptions = z13.object({
|
|
704
802
|
...AllRecordScopeOptions.shape,
|
|
705
803
|
...AccessLevelOptions.shape,
|
|
706
804
|
...AllUserScopeOptions.shape,
|
|
707
805
|
...WorkqueueOrDashboardOptions.shape
|
|
708
806
|
});
|
|
709
807
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
710
|
-
var ResolvedScopeOptionsPlaceEvent =
|
|
808
|
+
var ResolvedScopeOptionsPlaceEvent = z13.object({
|
|
711
809
|
event: scopeByEvent,
|
|
712
|
-
placeOfEvent: UUID.nullish()
|
|
810
|
+
placeOfEvent: UUID.nullish(),
|
|
811
|
+
createdBy: z13.string().optional(),
|
|
812
|
+
createdIn: UUID.nullish()
|
|
713
813
|
}).describe(
|
|
714
814
|
"Resolved options applicable to all record scopes, with location ID instead of jurisdiction filter."
|
|
715
815
|
);
|
|
716
816
|
var ResolvedScopeOptionsDeclared = ResolvedScopeOptionsPlaceEvent.extend({
|
|
717
817
|
notifiedIn: UUID.nullish(),
|
|
718
|
-
notifiedBy:
|
|
818
|
+
notifiedBy: z13.string().optional(),
|
|
719
819
|
declaredIn: UUID.nullish(),
|
|
720
|
-
declaredBy:
|
|
820
|
+
declaredBy: z13.string().optional()
|
|
721
821
|
}).describe(
|
|
722
822
|
"Resolved options applicable to actions that may take place after DECLARE, with location ID and user ID instead of filters."
|
|
723
823
|
);
|
|
724
824
|
var ResolvedScopeOptionsFull = ResolvedScopeOptionsDeclared.extend({
|
|
725
825
|
registeredIn: UUID.nullish(),
|
|
726
|
-
registeredBy:
|
|
826
|
+
registeredBy: z13.string().optional(),
|
|
827
|
+
flags: ContainsFlags.optional()
|
|
727
828
|
}).describe(
|
|
728
829
|
"Resolved options applicable to actions that may take place after REGISTER, with full filtering capabilities and location/user IDs instead of filters."
|
|
729
830
|
);
|
|
@@ -737,7 +838,6 @@ var ScopesWithDeclaredOptions = RecordScopeTypeV2.extract([
|
|
|
737
838
|
"record.reject",
|
|
738
839
|
"record.archive",
|
|
739
840
|
"record.unarchive",
|
|
740
|
-
"record.review-duplicates",
|
|
741
841
|
"record.register"
|
|
742
842
|
]);
|
|
743
843
|
var ScopesWithFullOptions = RecordScopeTypeV2.extract([
|
|
@@ -745,41 +845,42 @@ var ScopesWithFullOptions = RecordScopeTypeV2.extract([
|
|
|
745
845
|
"record.read",
|
|
746
846
|
"record.request-correction",
|
|
747
847
|
"record.correct",
|
|
748
|
-
"record.unassign-others"
|
|
848
|
+
"record.unassign-others",
|
|
849
|
+
"record.review-duplicates"
|
|
749
850
|
]);
|
|
750
851
|
var ScopeOptionsPrintCertifiedCopies = AllRecordScopeOptions.extend({
|
|
751
|
-
templates:
|
|
852
|
+
templates: z13.preprocess(
|
|
752
853
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
753
|
-
|
|
854
|
+
z13.array(z13.string()).optional()
|
|
754
855
|
).describe(
|
|
755
856
|
"Template IDs for certified copies. Controls which certificate templates are returned to the client via the config service. Certificate printing is a client-side operation \u2014 this option is not validated when the printCertificate action is submitted."
|
|
756
857
|
)
|
|
757
858
|
});
|
|
758
|
-
var RecordScopeV2 =
|
|
759
|
-
|
|
859
|
+
var RecordScopeV2 = z13.discriminatedUnion("type", [
|
|
860
|
+
z13.object({
|
|
760
861
|
type: ScopesWithPlaceEventOptions,
|
|
761
862
|
options: scopeOptionsPlaceEvent.optional()
|
|
762
863
|
}),
|
|
763
|
-
|
|
864
|
+
z13.object({
|
|
764
865
|
type: ScopesWithDeclaredOptions,
|
|
765
866
|
options: scopeOptionsDeclaredOrNotified.optional()
|
|
766
867
|
}),
|
|
767
|
-
|
|
868
|
+
z13.object({
|
|
768
869
|
type: ScopesWithFullOptions,
|
|
769
870
|
options: AllRecordScopeOptions.optional()
|
|
770
871
|
}),
|
|
771
|
-
|
|
772
|
-
type:
|
|
872
|
+
z13.object({
|
|
873
|
+
type: z13.literal("record.custom-action"),
|
|
773
874
|
options: CustomActionScopeOptions.optional()
|
|
774
875
|
}),
|
|
775
|
-
|
|
776
|
-
type:
|
|
876
|
+
z13.object({
|
|
877
|
+
type: z13.literal("record.print-certified-copies"),
|
|
777
878
|
options: ScopeOptionsPrintCertifiedCopies.optional()
|
|
778
879
|
})
|
|
779
880
|
]).describe(
|
|
780
881
|
"Scopes used to check user's permission to perform actions on a record."
|
|
781
882
|
);
|
|
782
|
-
var SystemScopeType =
|
|
883
|
+
var SystemScopeType = z13.enum([
|
|
783
884
|
"organisation.read-locations",
|
|
784
885
|
"user.read",
|
|
785
886
|
"user.create",
|
|
@@ -793,61 +894,61 @@ var UserScopeType = SystemScopeType.extract([
|
|
|
793
894
|
"user.search"
|
|
794
895
|
]);
|
|
795
896
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
796
|
-
var UserScopeV2 =
|
|
797
|
-
|
|
897
|
+
var UserScopeV2 = z13.discriminatedUnion("type", [
|
|
898
|
+
z13.object({
|
|
798
899
|
type: ScopesWithRoleOption,
|
|
799
900
|
options: AllUserScopeOptions.optional()
|
|
800
901
|
}),
|
|
801
|
-
|
|
902
|
+
z13.object({
|
|
802
903
|
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
803
904
|
options: AccessLevelOptions.optional()
|
|
804
905
|
})
|
|
805
906
|
]);
|
|
806
|
-
var ResolvedRecordScopeV2 =
|
|
807
|
-
|
|
907
|
+
var ResolvedRecordScopeV2 = z13.discriminatedUnion("type", [
|
|
908
|
+
z13.object({
|
|
808
909
|
type: ScopesWithPlaceEventOptions,
|
|
809
910
|
options: ResolvedScopeOptionsPlaceEvent.optional()
|
|
810
911
|
}),
|
|
811
|
-
|
|
912
|
+
z13.object({
|
|
812
913
|
type: ScopesWithDeclaredOptions,
|
|
813
914
|
options: ResolvedScopeOptionsDeclared.optional()
|
|
814
915
|
}),
|
|
815
|
-
|
|
916
|
+
z13.object({
|
|
816
917
|
type: ScopesWithFullOptions,
|
|
817
918
|
options: ResolvedScopeOptionsFull.optional()
|
|
818
919
|
}),
|
|
819
|
-
|
|
820
|
-
type:
|
|
920
|
+
z13.object({
|
|
921
|
+
type: z13.literal("record.print-certified-copies"),
|
|
821
922
|
options: ResolvedScopeOptionsFull.extend({
|
|
822
|
-
templates:
|
|
923
|
+
templates: z13.array(z13.string()).optional()
|
|
823
924
|
}).optional()
|
|
824
925
|
})
|
|
825
926
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
826
|
-
var Scope =
|
|
827
|
-
|
|
927
|
+
var Scope = z13.discriminatedUnion("type", [
|
|
928
|
+
z13.object({ type: PlainScopeType }),
|
|
828
929
|
...RecordScopeV2.options,
|
|
829
930
|
...UserScopeV2.options,
|
|
830
|
-
|
|
831
|
-
type:
|
|
931
|
+
z13.object({
|
|
932
|
+
type: z13.literal("organisation.read-locations"),
|
|
832
933
|
options: AccessLevelOptions.optional()
|
|
833
934
|
}),
|
|
834
|
-
|
|
835
|
-
type:
|
|
935
|
+
z13.object({
|
|
936
|
+
type: z13.literal("workqueue"),
|
|
836
937
|
options: WorkqueueOrDashboardOptions
|
|
837
938
|
}),
|
|
838
|
-
|
|
839
|
-
type:
|
|
939
|
+
z13.object({
|
|
940
|
+
type: z13.literal("dashboard.view"),
|
|
840
941
|
options: WorkqueueOrDashboardOptions
|
|
841
942
|
})
|
|
842
943
|
]);
|
|
843
|
-
var ScopeType =
|
|
944
|
+
var ScopeType = z13.enum([
|
|
844
945
|
...SystemScopeType.options,
|
|
845
946
|
...RecordScopeTypeV2.options,
|
|
846
947
|
...PlainScopeType.options,
|
|
847
948
|
"workqueue",
|
|
848
949
|
"dashboard.view"
|
|
849
950
|
]);
|
|
850
|
-
var EncodedScope =
|
|
951
|
+
var EncodedScope = z13.string().brand("EncodedScope");
|
|
851
952
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
852
953
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
853
954
|
accessLevel: JurisdictionFilter.enum.all,
|
|
@@ -857,30 +958,25 @@ var DEFAULT_SCOPE_OPTIONS = {
|
|
|
857
958
|
};
|
|
858
959
|
|
|
859
960
|
// ../commons/src/authentication.ts
|
|
860
|
-
var TokenUserType =
|
|
861
|
-
var TokenWithBearer =
|
|
961
|
+
var TokenUserType = z14.enum(["user", "system"]);
|
|
962
|
+
var TokenWithBearer = z14.string().regex(/^Bearer\s/);
|
|
862
963
|
|
|
863
964
|
// ../commons/src/events/ActionDocument.ts
|
|
864
|
-
var ActionUpdate =
|
|
965
|
+
var ActionUpdate = z15.record(z15.string(), FieldUpdateValue).describe(
|
|
865
966
|
"Record of field-level changes made by an action. Supports partial updates and nullable values."
|
|
866
967
|
);
|
|
867
|
-
var EventState =
|
|
968
|
+
var EventState = z15.record(z15.string(), FieldValue).describe(
|
|
868
969
|
"Aggregate representation of event data after all actions have been applied, with all updates consolidated and null values removed."
|
|
869
970
|
);
|
|
870
|
-
var
|
|
871
|
-
Requested: "Requested",
|
|
872
|
-
Accepted: "Accepted",
|
|
873
|
-
Rejected: "Rejected"
|
|
874
|
-
};
|
|
875
|
-
var ActionBase = z13.object({
|
|
971
|
+
var ActionBase = z15.object({
|
|
876
972
|
id: UUID.describe("Unique identifier of the action."),
|
|
877
|
-
transactionId:
|
|
973
|
+
transactionId: z15.string().describe("Unique identifier of the transaction."),
|
|
878
974
|
createdByUserType: TokenUserType.describe(
|
|
879
975
|
"Indicates whether the action was created by a human-user or by a system-user."
|
|
880
976
|
),
|
|
881
|
-
createdAt:
|
|
882
|
-
createdBy:
|
|
883
|
-
createdByRole:
|
|
977
|
+
createdAt: z15.string().datetime().describe("Timestamp indicating when the action was created."),
|
|
978
|
+
createdBy: z15.string().describe("Identifier of the user who created the action."),
|
|
979
|
+
createdByRole: z15.string().optional().describe("Role of the user who created the action."),
|
|
884
980
|
createdBySignature: DocumentPath.nullish().describe(
|
|
885
981
|
"Reference to the signature of the user who created the action."
|
|
886
982
|
),
|
|
@@ -892,7 +988,7 @@ var ActionBase = z13.object({
|
|
|
892
988
|
"Declaration data defined by the ActionConfig. Supports partial updates."
|
|
893
989
|
),
|
|
894
990
|
annotation: ActionUpdate.optional().nullable().describe("Action-specific metadata used to annotate the event."),
|
|
895
|
-
status:
|
|
991
|
+
status: z15.enum([
|
|
896
992
|
ActionStatus.Requested,
|
|
897
993
|
ActionStatus.Accepted,
|
|
898
994
|
ActionStatus.Rejected
|
|
@@ -904,139 +1000,143 @@ var ActionBase = z13.object({
|
|
|
904
1000
|
)
|
|
905
1001
|
});
|
|
906
1002
|
var AssignedAction = ActionBase.extend(
|
|
907
|
-
|
|
908
|
-
type:
|
|
909
|
-
assignedTo:
|
|
1003
|
+
z15.object({
|
|
1004
|
+
type: z15.literal(ActionType.ASSIGN),
|
|
1005
|
+
assignedTo: z15.string().describe("Identifier of the user to whom the action is assigned.")
|
|
910
1006
|
// TODO move into 'content' property
|
|
911
1007
|
}).shape
|
|
912
1008
|
);
|
|
913
1009
|
var UnassignedAction = ActionBase.extend(
|
|
914
|
-
|
|
915
|
-
type:
|
|
1010
|
+
z15.object({
|
|
1011
|
+
type: z15.literal(ActionType.UNASSIGN)
|
|
916
1012
|
}).shape
|
|
917
1013
|
);
|
|
918
1014
|
var RegisterAction = ActionBase.extend(
|
|
919
|
-
|
|
920
|
-
type:
|
|
921
|
-
registrationNumber:
|
|
1015
|
+
z15.object({
|
|
1016
|
+
type: z15.literal(ActionType.REGISTER),
|
|
1017
|
+
registrationNumber: z15.string().optional().describe(
|
|
922
1018
|
"Registration number of the event. Always present for accepted registrations."
|
|
923
1019
|
)
|
|
924
1020
|
// TODO move into 'content' property
|
|
925
1021
|
}).shape
|
|
926
1022
|
);
|
|
927
1023
|
var DeclareAction = ActionBase.extend(
|
|
928
|
-
|
|
929
|
-
type:
|
|
1024
|
+
z15.object({
|
|
1025
|
+
type: z15.literal(ActionType.DECLARE)
|
|
930
1026
|
}).shape
|
|
931
1027
|
);
|
|
932
|
-
var ReasonContent =
|
|
933
|
-
reason:
|
|
1028
|
+
var ReasonContent = z15.object({
|
|
1029
|
+
reason: z15.string().min(1, { error: "Message cannot be empty" }).describe(
|
|
934
1030
|
"Message describing the reason for rejecting or archiving the event."
|
|
935
1031
|
)
|
|
936
1032
|
});
|
|
937
1033
|
var RejectAction = ActionBase.extend(
|
|
938
|
-
|
|
939
|
-
type:
|
|
1034
|
+
z15.object({
|
|
1035
|
+
type: z15.literal(ActionType.REJECT),
|
|
940
1036
|
content: ReasonContent
|
|
941
1037
|
}).shape
|
|
942
1038
|
);
|
|
943
|
-
var PotentialDuplicate =
|
|
1039
|
+
var PotentialDuplicate = z15.object({
|
|
944
1040
|
id: UUID,
|
|
945
|
-
trackingId:
|
|
1041
|
+
trackingId: z15.string()
|
|
946
1042
|
});
|
|
947
1043
|
var DuplicateDetectedAction = ActionBase.extend(
|
|
948
|
-
|
|
949
|
-
type:
|
|
950
|
-
content:
|
|
951
|
-
duplicates:
|
|
1044
|
+
z15.object({
|
|
1045
|
+
type: z15.literal(ActionType.DUPLICATE_DETECTED),
|
|
1046
|
+
content: z15.object({
|
|
1047
|
+
duplicates: z15.array(PotentialDuplicate)
|
|
952
1048
|
})
|
|
953
1049
|
}).shape
|
|
954
1050
|
);
|
|
955
1051
|
var MarkNotDuplicateAction = ActionBase.extend(
|
|
956
|
-
|
|
957
|
-
type:
|
|
1052
|
+
z15.object({
|
|
1053
|
+
type: z15.literal(ActionType.MARK_AS_NOT_DUPLICATE)
|
|
958
1054
|
}).shape
|
|
959
1055
|
);
|
|
960
1056
|
var MarkAsDuplicateAction = ActionBase.extend(
|
|
961
|
-
|
|
962
|
-
type:
|
|
963
|
-
content:
|
|
1057
|
+
z15.object({
|
|
1058
|
+
type: z15.literal(ActionType.MARK_AS_DUPLICATE),
|
|
1059
|
+
content: z15.object({
|
|
964
1060
|
duplicateOf: UUID
|
|
965
1061
|
}).optional()
|
|
966
1062
|
}).shape
|
|
967
1063
|
);
|
|
968
1064
|
var ArchiveAction = ActionBase.extend(
|
|
969
|
-
|
|
970
|
-
type:
|
|
971
|
-
|
|
1065
|
+
z15.object({
|
|
1066
|
+
type: z15.literal(ActionType.ARCHIVE),
|
|
1067
|
+
/**
|
|
1068
|
+
* Archiving does not collect a reason on its own. Only the
|
|
1069
|
+
* "mark as duplicate" flow archives with a reason attached.
|
|
1070
|
+
*/
|
|
1071
|
+
content: ReasonContent.optional()
|
|
972
1072
|
}).shape
|
|
973
1073
|
);
|
|
974
1074
|
var UnarchiveAction = ActionBase.extend(
|
|
975
|
-
|
|
976
|
-
type:
|
|
1075
|
+
z15.object({
|
|
1076
|
+
type: z15.literal(ActionType.UNARCHIVE)
|
|
977
1077
|
}).shape
|
|
978
1078
|
);
|
|
979
1079
|
var CreatedAction = ActionBase.extend(
|
|
980
|
-
|
|
981
|
-
type:
|
|
1080
|
+
z15.object({
|
|
1081
|
+
type: z15.literal(ActionType.CREATE)
|
|
982
1082
|
}).shape
|
|
983
1083
|
);
|
|
984
1084
|
var NotifiedAction = ActionBase.extend(
|
|
985
|
-
|
|
986
|
-
type:
|
|
1085
|
+
z15.object({
|
|
1086
|
+
type: z15.literal(ActionType.NOTIFY)
|
|
987
1087
|
}).shape
|
|
988
1088
|
);
|
|
989
1089
|
var EditAction = ActionBase.extend(
|
|
990
|
-
|
|
991
|
-
type:
|
|
1090
|
+
z15.object({
|
|
1091
|
+
type: z15.literal(ActionType.EDIT),
|
|
992
1092
|
/** @deprecated New Edit-actions should no longer contain content. This is kept for old 2.0 edits. */
|
|
993
|
-
content:
|
|
994
|
-
comment:
|
|
1093
|
+
content: z15.object({
|
|
1094
|
+
comment: z15.string().describe("Comment for the edit action.").optional()
|
|
995
1095
|
}).optional()
|
|
996
1096
|
}).shape
|
|
997
1097
|
);
|
|
998
|
-
var PrintContent =
|
|
999
|
-
templateId:
|
|
1098
|
+
var PrintContent = z15.object({
|
|
1099
|
+
templateId: z15.string().optional()
|
|
1000
1100
|
});
|
|
1001
1101
|
var PrintCertificateAction = ActionBase.extend(
|
|
1002
|
-
|
|
1003
|
-
type:
|
|
1102
|
+
z15.object({
|
|
1103
|
+
type: z15.literal(ActionType.PRINT_CERTIFICATE),
|
|
1004
1104
|
content: PrintContent.optional().nullable()
|
|
1005
1105
|
}).shape
|
|
1006
1106
|
);
|
|
1007
1107
|
var RequestedCorrectionAction = ActionBase.extend(
|
|
1008
|
-
|
|
1009
|
-
type:
|
|
1108
|
+
z15.object({
|
|
1109
|
+
type: z15.literal(ActionType.REQUEST_CORRECTION)
|
|
1010
1110
|
}).shape
|
|
1011
1111
|
);
|
|
1012
1112
|
var ApprovedCorrectionAction = ActionBase.extend(
|
|
1013
|
-
|
|
1014
|
-
type:
|
|
1015
|
-
requestId:
|
|
1113
|
+
z15.object({
|
|
1114
|
+
type: z15.literal(ActionType.APPROVE_CORRECTION),
|
|
1115
|
+
requestId: z15.string(),
|
|
1016
1116
|
// TODO move into 'content' property
|
|
1017
|
-
content:
|
|
1117
|
+
content: z15.object({ immediateCorrection: z15.boolean().optional() }).optional()
|
|
1018
1118
|
}).shape
|
|
1019
1119
|
);
|
|
1020
1120
|
var RejectedCorrectionAction = ActionBase.extend(
|
|
1021
|
-
|
|
1022
|
-
type:
|
|
1023
|
-
requestId:
|
|
1121
|
+
z15.object({
|
|
1122
|
+
type: z15.literal(ActionType.REJECT_CORRECTION),
|
|
1123
|
+
requestId: z15.string(),
|
|
1024
1124
|
// TODO move into 'content' property
|
|
1025
1125
|
content: ReasonContent
|
|
1026
1126
|
}).shape
|
|
1027
1127
|
);
|
|
1028
1128
|
var ReadAction = ActionBase.extend(
|
|
1029
|
-
|
|
1030
|
-
type:
|
|
1129
|
+
z15.object({
|
|
1130
|
+
type: z15.literal(ActionType.READ)
|
|
1031
1131
|
}).shape
|
|
1032
1132
|
);
|
|
1033
1133
|
var CustomAction = ActionBase.merge(
|
|
1034
|
-
|
|
1035
|
-
type:
|
|
1036
|
-
customActionType:
|
|
1134
|
+
z15.object({
|
|
1135
|
+
type: z15.literal(ActionType.CUSTOM),
|
|
1136
|
+
customActionType: z15.string()
|
|
1037
1137
|
})
|
|
1038
1138
|
);
|
|
1039
|
-
var ActionDocument =
|
|
1139
|
+
var ActionDocument = z15.discriminatedUnion("type", [
|
|
1040
1140
|
CreatedAction.meta({ id: "CreatedAction" }),
|
|
1041
1141
|
RejectAction.meta({ id: "RejectAction" }),
|
|
1042
1142
|
DuplicateDetectedAction.meta({ id: "DuplicateDetectedAction" }),
|
|
@@ -1063,109 +1163,50 @@ var AsyncRejectActionDocument = ActionBase.omit({
|
|
|
1063
1163
|
declaration: true,
|
|
1064
1164
|
annotation: true
|
|
1065
1165
|
}).extend(
|
|
1066
|
-
|
|
1067
|
-
type:
|
|
1068
|
-
status:
|
|
1166
|
+
z15.object({
|
|
1167
|
+
type: z15.enum(ConfirmableActions),
|
|
1168
|
+
status: z15.literal(ActionStatus.Rejected)
|
|
1069
1169
|
}).shape
|
|
1070
1170
|
);
|
|
1071
|
-
var Action =
|
|
1072
|
-
|
|
1073
|
-
// ../commons/src/events/Flag.ts
|
|
1074
|
-
var z14 = __toESM(require("zod/v4"));
|
|
1075
|
-
var InherentFlags = {
|
|
1076
|
-
INCOMPLETE: "incomplete",
|
|
1077
|
-
REJECTED: "rejected",
|
|
1078
|
-
CORRECTION_REQUESTED: "correction-requested",
|
|
1079
|
-
POTENTIAL_DUPLICATE: "potential-duplicate",
|
|
1080
|
-
/**
|
|
1081
|
-
* This flag is set by the Edit-action and removed after the declaration or registration.
|
|
1082
|
-
* A record should never stay with the EDIT_IN_PROGRESS flag, since it should always be declared or registered right after.
|
|
1083
|
-
*
|
|
1084
|
-
* We only use this flag to determine that a NOTIFY, DECLARE or REGISTER action is allowed next.
|
|
1085
|
-
*/
|
|
1086
|
-
EDIT_IN_PROGRESS: "edit-in-progress"
|
|
1087
|
-
};
|
|
1088
|
-
var ActionFlag = z14.string().regex(
|
|
1089
|
-
new RegExp(
|
|
1090
|
-
`^(${Object.values(ActionType).join("|").toLowerCase()}):(${Object.values(
|
|
1091
|
-
ActionStatus
|
|
1092
|
-
).join("|").toLowerCase()})$`
|
|
1093
|
-
),
|
|
1094
|
-
"Flag must be in the format ActionType:ActionStatus (lowerCase)"
|
|
1095
|
-
);
|
|
1096
|
-
var CustomFlag = z14.string().refine((val) => !Object.values(InherentFlags).includes(val), {
|
|
1097
|
-
message: `Custom flag cannot be one of the inherent flags: ${Object.values(
|
|
1098
|
-
InherentFlags
|
|
1099
|
-
).join(", ")}`
|
|
1100
|
-
}).refine((val) => !ActionFlag.safeParse(val).success, {
|
|
1101
|
-
message: "Custom flag cannot match the ActionFlag pattern (ActionType:ActionStatus)."
|
|
1102
|
-
}).describe("Custom flag identifier defined by the country config.");
|
|
1103
|
-
var Flag = ActionFlag.or(z14.enum(InherentFlags)).or(CustomFlag);
|
|
1104
|
-
var FlagConfig = z14.object({
|
|
1105
|
-
id: CustomFlag,
|
|
1106
|
-
requiresAction: z14.boolean().describe(
|
|
1107
|
-
"Indicates if this flag expects an action to be performed to be cleared."
|
|
1108
|
-
),
|
|
1109
|
-
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1110
|
-
}).meta({
|
|
1111
|
-
id: "FlagConfig",
|
|
1112
|
-
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
1113
|
-
});
|
|
1114
|
-
var ActionFlagConfig = z14.object({
|
|
1115
|
-
id: Flag,
|
|
1116
|
-
operation: z14.enum(["add", "remove"]).describe("Operation to perform on the flag."),
|
|
1117
|
-
conditional: Conditional.optional().describe(
|
|
1118
|
-
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1119
|
-
)
|
|
1120
|
-
}).meta({
|
|
1121
|
-
id: "ActionFlagConfig",
|
|
1122
|
-
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1123
|
-
});
|
|
1171
|
+
var Action = z15.union([ActionDocument, AsyncRejectActionDocument]);
|
|
1124
1172
|
|
|
1125
1173
|
// ../commons/src/events/EventMetadata.ts
|
|
1126
|
-
var
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
"
|
|
1130
|
-
"
|
|
1131
|
-
"ARCHIVED"
|
|
1132
|
-
]);
|
|
1133
|
-
var ZodDate = z15.iso.date();
|
|
1134
|
-
var ZodDateTime = z15.string().datetime();
|
|
1135
|
-
var ActionCreationMetadata = z15.object({
|
|
1136
|
-
createdAt: z15.iso.datetime().describe("The timestamp when the action request was created."),
|
|
1137
|
-
createdBy: z15.string().describe("ID of the user who created the action request."),
|
|
1174
|
+
var ZodDate = z16.iso.date();
|
|
1175
|
+
var ZodDateTime = z16.string().datetime();
|
|
1176
|
+
var ActionCreationMetadata = z16.object({
|
|
1177
|
+
createdAt: z16.iso.datetime().describe("The timestamp when the action request was created."),
|
|
1178
|
+
createdBy: z16.string().describe("ID of the user who created the action request."),
|
|
1138
1179
|
// @TODO: createdAtLocation should be non-nullable in the future once all action requests have this field populated.
|
|
1139
1180
|
createdAtLocation: UUID.nullish().describe(
|
|
1140
1181
|
"Location of the user who created the action request."
|
|
1141
1182
|
),
|
|
1142
|
-
createdByUserType:
|
|
1143
|
-
acceptedAt:
|
|
1144
|
-
createdByRole:
|
|
1183
|
+
createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
|
|
1184
|
+
acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
|
|
1185
|
+
createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
|
|
1145
1186
|
});
|
|
1146
1187
|
var RegistrationCreationMetadata = ActionCreationMetadata.extend({
|
|
1147
|
-
registrationNumber:
|
|
1188
|
+
registrationNumber: z16.string().describe(
|
|
1148
1189
|
"Registration number of the event. Always present for accepted registrations."
|
|
1149
1190
|
)
|
|
1150
1191
|
});
|
|
1151
|
-
var LegalStatuses =
|
|
1192
|
+
var LegalStatuses = z16.object({
|
|
1152
1193
|
[EventStatus.enum.NOTIFIED]: ActionCreationMetadata.nullish(),
|
|
1153
1194
|
[EventStatus.enum.DECLARED]: ActionCreationMetadata.nullish(),
|
|
1154
1195
|
[EventStatus.enum.REGISTERED]: RegistrationCreationMetadata.nullish()
|
|
1155
1196
|
});
|
|
1156
|
-
var EventMetadata =
|
|
1197
|
+
var EventMetadata = z16.object({
|
|
1157
1198
|
id: UUID,
|
|
1158
|
-
type:
|
|
1199
|
+
type: z16.string().describe("The type of event, such as birth, death, or marriage."),
|
|
1159
1200
|
status: EventStatus,
|
|
1160
1201
|
legalStatuses: LegalStatuses.describe(
|
|
1161
1202
|
"Metadata related to the legal registration of the event, such as who registered it and when."
|
|
1162
1203
|
),
|
|
1163
|
-
createdAt:
|
|
1204
|
+
createdAt: z16.iso.datetime().describe("The timestamp when the event was first created and saved."),
|
|
1164
1205
|
dateOfEvent: ZodDate.nullish(),
|
|
1165
1206
|
placeOfEvent: UUID.nullish(),
|
|
1166
|
-
createdBy:
|
|
1167
|
-
createdByUserType:
|
|
1168
|
-
updatedByUserRole:
|
|
1207
|
+
createdBy: z16.string().describe("ID of the user who created the event."),
|
|
1208
|
+
createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
|
|
1209
|
+
updatedByUserRole: z16.string().nullish().describe("Role of the user who last changed the status."),
|
|
1169
1210
|
// @TODO: createdAtLocation should be non-nullable in the future once all action requests have this field populated.
|
|
1170
1211
|
createdAtLocation: UUID.nullish().describe(
|
|
1171
1212
|
"Location of the user who created the event."
|
|
@@ -1173,18 +1214,18 @@ var EventMetadata = z15.object({
|
|
|
1173
1214
|
updatedAtLocation: UUID.nullish().describe(
|
|
1174
1215
|
"Location of the user who last changed the status."
|
|
1175
1216
|
),
|
|
1176
|
-
updatedAt:
|
|
1217
|
+
updatedAt: z16.iso.datetime().describe(
|
|
1177
1218
|
"Timestamp of the most recent *accepted* status change. Possibly 3rd party update, if action is validation asynchronously."
|
|
1178
1219
|
),
|
|
1179
|
-
assignedTo:
|
|
1180
|
-
updatedBy:
|
|
1181
|
-
trackingId:
|
|
1220
|
+
assignedTo: z16.string().nullish().describe("ID of the user currently assigned to the event."),
|
|
1221
|
+
updatedBy: z16.string().nullish().describe("ID of the user who last changed the status."),
|
|
1222
|
+
trackingId: z16.string().describe(
|
|
1182
1223
|
"System-generated tracking ID used by informants or registrars to look up the event."
|
|
1183
1224
|
),
|
|
1184
|
-
potentialDuplicates:
|
|
1225
|
+
potentialDuplicates: z16.array(PotentialDuplicate).describe(
|
|
1185
1226
|
"List of event IDs and their tracking IDs that this event could be a duplicate of."
|
|
1186
1227
|
),
|
|
1187
|
-
flags:
|
|
1228
|
+
flags: z16.array(Flag)
|
|
1188
1229
|
});
|
|
1189
1230
|
var EventMetadataKeysArray = [
|
|
1190
1231
|
"id",
|
|
@@ -1205,8 +1246,8 @@ var EventMetadataKeysArray = [
|
|
|
1205
1246
|
"legalStatuses",
|
|
1206
1247
|
"flags"
|
|
1207
1248
|
];
|
|
1208
|
-
var EventMetadataKeys =
|
|
1209
|
-
var EventMetadataDateFieldIdInput =
|
|
1249
|
+
var EventMetadataKeys = z16.enum(EventMetadataKeysArray);
|
|
1250
|
+
var EventMetadataDateFieldIdInput = z16.enum([
|
|
1210
1251
|
"createdAt",
|
|
1211
1252
|
"updatedAt",
|
|
1212
1253
|
"legalStatuses.NOTIFIED.createdAt",
|
|
@@ -1216,7 +1257,7 @@ var EventMetadataDateFieldIdInput = z15.enum([
|
|
|
1216
1257
|
"legalStatuses.REGISTERED.createdAt",
|
|
1217
1258
|
"legalStatuses.REGISTERED.acceptedAt"
|
|
1218
1259
|
]);
|
|
1219
|
-
var EventMetadataDateFieldId =
|
|
1260
|
+
var EventMetadataDateFieldId = z16.enum([
|
|
1220
1261
|
"event.createdAt",
|
|
1221
1262
|
"event.updatedAt",
|
|
1222
1263
|
"event.legalStatuses.NOTIFIED.createdAt",
|
|
@@ -1281,13 +1322,6 @@ var Range = import_v4.z.object({
|
|
|
1281
1322
|
}).meta({
|
|
1282
1323
|
id: "Range"
|
|
1283
1324
|
});
|
|
1284
|
-
var ContainsFlags = import_v4.z.object({
|
|
1285
|
-
anyOf: import_v4.z.array(Flag).optional(),
|
|
1286
|
-
noneOf: import_v4.z.array(Flag).optional(),
|
|
1287
|
-
allOf: import_v4.z.array(Flag).optional()
|
|
1288
|
-
}).meta({
|
|
1289
|
-
id: "ContainsFlags"
|
|
1290
|
-
});
|
|
1291
1325
|
var Within = import_v4.z.object({ type: import_v4.z.literal("within"), location: import_v4.z.string() }).meta({
|
|
1292
1326
|
id: "Within"
|
|
1293
1327
|
});
|
|
@@ -1482,8 +1516,8 @@ var BaseField = import_v43.default.object({
|
|
|
1482
1516
|
conditionals: import_v43.default.array(FieldConditional).default([]).optional().describe(
|
|
1483
1517
|
"Conditions determining when the field is shown or enabled. By default, the field is always shown and enabled."
|
|
1484
1518
|
),
|
|
1485
|
-
secured: import_v43.default.boolean().default(false).optional().describe(
|
|
1486
|
-
"Indicates whether the field is secured. Secured fields are not indexed for search and are only visible when explicitly assigned."
|
|
1519
|
+
secured: import_v43.default.union([import_v43.default.boolean(), Conditional]).default(false).optional().describe(
|
|
1520
|
+
"Indicates whether the field is secured, either always (boolean) or conditionally, evaluated against the event (a JSONSchema conditional, e.g. flag('sealed')). Secured fields are not indexed for search and are only visible when explicitly assigned."
|
|
1487
1521
|
),
|
|
1488
1522
|
placeholder: TranslationConfig.optional(),
|
|
1489
1523
|
validation: import_v43.default.array(ValidationConfig).default([]).optional().describe("Additional validation rules applied to the field."),
|
|
@@ -1881,7 +1915,13 @@ var AdministrativeAreaField = BaseField.extend({
|
|
|
1881
1915
|
configuration: import_v43.default.object({
|
|
1882
1916
|
partOf: FieldReference.optional().describe("Parent location"),
|
|
1883
1917
|
type: AdministrativeAreas,
|
|
1884
|
-
allowedLocations: AllowedLocations
|
|
1918
|
+
allowedLocations: AllowedLocations,
|
|
1919
|
+
activeOnly: import_v43.default.boolean().optional().describe(
|
|
1920
|
+
"Offer only locations that are active at the resolved anchor date (today, or the date of event when anchorToDateOfEvent is set); inactive or not-yet-effective versions are excluded."
|
|
1921
|
+
),
|
|
1922
|
+
anchorToDateOfEvent: import_v43.default.boolean().optional().describe(
|
|
1923
|
+
"Resolve selectable/displayed versions against the event's date of event (falling back to the record's creation date when empty) instead of today. Does not by itself exclude inactive versions; combine with activeOnly for that."
|
|
1924
|
+
)
|
|
1885
1925
|
}).describe("Administrative area options")
|
|
1886
1926
|
}).meta({
|
|
1887
1927
|
description: "Administrative area input field",
|
|
@@ -1892,7 +1932,13 @@ var LocationInput = BaseField.extend({
|
|
|
1892
1932
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1893
1933
|
configuration: import_v43.default.object({
|
|
1894
1934
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
1895
|
-
allowedLocations: AllowedLocations
|
|
1935
|
+
allowedLocations: AllowedLocations,
|
|
1936
|
+
activeOnly: import_v43.default.boolean().optional().describe(
|
|
1937
|
+
"Offer only locations that are active at the resolved anchor date (today, or the date of event when anchorToDateOfEvent is set); inactive or not-yet-effective versions are excluded."
|
|
1938
|
+
),
|
|
1939
|
+
anchorToDateOfEvent: import_v43.default.boolean().optional().describe(
|
|
1940
|
+
"Resolve selectable/displayed versions against the event's date of event (falling back to the record's creation date when empty) instead of today. Does not by itself exclude inactive versions; combine with activeOnly for that."
|
|
1941
|
+
)
|
|
1896
1942
|
}).optional()
|
|
1897
1943
|
}).meta({
|
|
1898
1944
|
description: "A field for selecting a location",
|
|
@@ -1918,12 +1964,20 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
1918
1964
|
var Facility = BaseField.extend({
|
|
1919
1965
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
1920
1966
|
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1921
|
-
configuration: import_v43.default.object({
|
|
1967
|
+
configuration: import_v43.default.object({
|
|
1968
|
+
allowedLocations: AllowedLocations,
|
|
1969
|
+
activeOnly: import_v43.default.boolean().optional(),
|
|
1970
|
+
anchorToDateOfEvent: import_v43.default.boolean().optional()
|
|
1971
|
+
}).optional()
|
|
1922
1972
|
}).describe("Input field for a facility");
|
|
1923
1973
|
var Office = BaseField.extend({
|
|
1924
1974
|
type: import_v43.default.literal(FieldType.OFFICE),
|
|
1925
1975
|
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1926
|
-
configuration: import_v43.default.object({
|
|
1976
|
+
configuration: import_v43.default.object({
|
|
1977
|
+
allowedLocations: AllowedLocations,
|
|
1978
|
+
activeOnly: import_v43.default.boolean().optional(),
|
|
1979
|
+
anchorToDateOfEvent: import_v43.default.boolean().optional()
|
|
1980
|
+
}).optional()
|
|
1927
1981
|
}).describe("Input field for an office");
|
|
1928
1982
|
var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
|
|
1929
1983
|
administrativeArea: import_v43.default.union([UUID, SerializedUserField]).optional()
|
|
@@ -1956,7 +2010,13 @@ var Address = BaseField.extend({
|
|
|
1956
2010
|
parent: FieldReference.optional()
|
|
1957
2011
|
})
|
|
1958
2012
|
).optional(),
|
|
1959
|
-
allowedLocations: AllowedLocations
|
|
2013
|
+
allowedLocations: AllowedLocations,
|
|
2014
|
+
activeOnly: import_v43.default.boolean().optional().describe(
|
|
2015
|
+
"Offer only admin areas that are active at the resolved anchor date (today, or the date of event when anchorToDateOfEvent is set); inactive or not-yet-effective versions are excluded. Propagated to the embedded admin-area selectors."
|
|
2016
|
+
),
|
|
2017
|
+
anchorToDateOfEvent: import_v43.default.boolean().optional().describe(
|
|
2018
|
+
"Resolve selectable/displayed versions against the event's date of event (falling back to the record's creation date when empty) instead of today. Does not by itself exclude inactive versions; combine with activeOnly for that. Propagated to the embedded admin-area selectors."
|
|
2019
|
+
)
|
|
1960
2020
|
}).optional(),
|
|
1961
2021
|
defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
|
|
1962
2022
|
}).meta({
|
|
@@ -2011,10 +2071,19 @@ var ButtonField = BaseField.extend({
|
|
|
2011
2071
|
description: "A generic button that can be used to trigger an action",
|
|
2012
2072
|
id: "ButtonField"
|
|
2013
2073
|
});
|
|
2074
|
+
var FieldGroupConfiguration = import_v43.default.object({
|
|
2075
|
+
separator: import_v43.default.string().optional().describe(
|
|
2076
|
+
'Joins the subfield values when the group is rendered as output, e.g. ", ". Defaults to one subfield per line.'
|
|
2077
|
+
),
|
|
2078
|
+
hideEmptyFields: import_v43.default.boolean().default(false).optional().describe(
|
|
2079
|
+
"Leaves subfields without a value out of the output. Pair it with a separator so the separator does not double up around the gaps."
|
|
2080
|
+
)
|
|
2081
|
+
});
|
|
2014
2082
|
var FieldGroup = BaseField.extend({
|
|
2015
2083
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
2016
2084
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
2017
|
-
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
|
|
2085
|
+
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig)),
|
|
2086
|
+
configuration: FieldGroupConfiguration.optional()
|
|
2018
2087
|
}).meta({
|
|
2019
2088
|
description: "A group of fields that are displayed together",
|
|
2020
2089
|
id: "FieldGroup"
|
|
@@ -2257,7 +2326,7 @@ var AnyFileField = import_v43.default.discriminatedUnion("type", [
|
|
|
2257
2326
|
]);
|
|
2258
2327
|
|
|
2259
2328
|
// ../commons/src/application-config.ts
|
|
2260
|
-
var SearchCriteria =
|
|
2329
|
+
var SearchCriteria = z21.enum([
|
|
2261
2330
|
"TRACKING_ID",
|
|
2262
2331
|
"REGISTRATION_NUMBER",
|
|
2263
2332
|
"NATIONAL_ID",
|
|
@@ -2265,69 +2334,69 @@ var SearchCriteria = z20.enum([
|
|
|
2265
2334
|
"PHONE_NUMBER",
|
|
2266
2335
|
"EMAIL"
|
|
2267
2336
|
]);
|
|
2268
|
-
var ApplicationConfig =
|
|
2269
|
-
APPLICATION_NAME:
|
|
2270
|
-
COUNTRY_LOGO:
|
|
2271
|
-
fileName:
|
|
2272
|
-
file:
|
|
2337
|
+
var ApplicationConfig = z21.object({
|
|
2338
|
+
APPLICATION_NAME: z21.string(),
|
|
2339
|
+
COUNTRY_LOGO: z21.object({
|
|
2340
|
+
fileName: z21.string(),
|
|
2341
|
+
file: z21.string()
|
|
2273
2342
|
}),
|
|
2274
|
-
SYSTEM_IANA_TIMEZONE:
|
|
2275
|
-
CURRENCY:
|
|
2276
|
-
languagesAndCountry:
|
|
2277
|
-
isoCode:
|
|
2343
|
+
SYSTEM_IANA_TIMEZONE: z21.string(),
|
|
2344
|
+
CURRENCY: z21.object({
|
|
2345
|
+
languagesAndCountry: z21.array(z21.string()),
|
|
2346
|
+
isoCode: z21.string()
|
|
2278
2347
|
}),
|
|
2279
|
-
ADMIN_STRUCTURE:
|
|
2280
|
-
|
|
2281
|
-
id:
|
|
2348
|
+
ADMIN_STRUCTURE: z21.array(
|
|
2349
|
+
z21.object({
|
|
2350
|
+
id: z21.string(),
|
|
2282
2351
|
label: TranslationConfig
|
|
2283
2352
|
})
|
|
2284
2353
|
),
|
|
2285
|
-
PHONE_NUMBER_PATTERN:
|
|
2286
|
-
USER_NOTIFICATION_DELIVERY_METHOD:
|
|
2287
|
-
INFORMANT_NOTIFICATION_DELIVERY_METHOD:
|
|
2354
|
+
PHONE_NUMBER_PATTERN: z21.string().or(z21.instanceof(RegExp)),
|
|
2355
|
+
USER_NOTIFICATION_DELIVERY_METHOD: z21.enum(["email", "sms"]),
|
|
2356
|
+
INFORMANT_NOTIFICATION_DELIVERY_METHOD: z21.enum(["email", "sms"]),
|
|
2288
2357
|
SEARCH_DEFAULT_CRITERIA: SearchCriteria.optional().default("TRACKING_ID"),
|
|
2289
|
-
ADDITIONAL_USER_FIELDS:
|
|
2358
|
+
ADDITIONAL_USER_FIELDS: z21.array(FieldConfig).optional().default([])
|
|
2290
2359
|
});
|
|
2291
2360
|
var defineApplicationConfig = (config) => {
|
|
2292
2361
|
return ApplicationConfig.parse(config);
|
|
2293
2362
|
};
|
|
2294
|
-
var BackgroundConfig =
|
|
2295
|
-
backgroundColor:
|
|
2296
|
-
backgroundImage:
|
|
2297
|
-
imageFit:
|
|
2363
|
+
var BackgroundConfig = z21.object({
|
|
2364
|
+
backgroundColor: z21.string().optional(),
|
|
2365
|
+
backgroundImage: z21.string().optional(),
|
|
2366
|
+
imageFit: z21.string().optional()
|
|
2298
2367
|
}).refine(
|
|
2299
2368
|
(data) => !!(data.backgroundColor || data.backgroundImage),
|
|
2300
2369
|
"backgroundColor and backgroundImage cannot be empty at the same time"
|
|
2301
2370
|
);
|
|
2302
|
-
var LoginConfig =
|
|
2303
|
-
COUNTRY:
|
|
2304
|
-
LANGUAGES:
|
|
2305
|
-
USER_NOTIFICATION_DELIVERY_METHOD:
|
|
2306
|
-
INFORMANT_NOTIFICATION_DELIVERY_METHOD:
|
|
2307
|
-
PHONE_NUMBER_PATTERN:
|
|
2371
|
+
var LoginConfig = z21.object({
|
|
2372
|
+
COUNTRY: z21.string(),
|
|
2373
|
+
LANGUAGES: z21.array(z21.string()),
|
|
2374
|
+
USER_NOTIFICATION_DELIVERY_METHOD: z21.enum(["email", "sms"]),
|
|
2375
|
+
INFORMANT_NOTIFICATION_DELIVERY_METHOD: z21.enum(["email", "sms"]),
|
|
2376
|
+
PHONE_NUMBER_PATTERN: z21.string().or(z21.instanceof(RegExp)),
|
|
2308
2377
|
LOGIN_BACKGROUND: BackgroundConfig,
|
|
2309
|
-
SENTRY:
|
|
2378
|
+
SENTRY: z21.string().optional()
|
|
2310
2379
|
});
|
|
2311
2380
|
var defineLoginConfig = (config) => {
|
|
2312
2381
|
return LoginConfig.parse(config);
|
|
2313
2382
|
};
|
|
2314
|
-
var ClientConfig =
|
|
2315
|
-
COUNTRY:
|
|
2316
|
-
LANGUAGES:
|
|
2317
|
-
SENTRY:
|
|
2318
|
-
LOGIN_URL:
|
|
2383
|
+
var ClientConfig = z21.object({
|
|
2384
|
+
COUNTRY: z21.string(),
|
|
2385
|
+
LANGUAGES: z21.array(z21.string()),
|
|
2386
|
+
SENTRY: z21.string().optional(),
|
|
2387
|
+
LOGIN_URL: z21.string().optional(),
|
|
2319
2388
|
REGISTER_BACKGROUND: BackgroundConfig,
|
|
2320
|
-
DASHBOARDS:
|
|
2321
|
-
|
|
2322
|
-
id:
|
|
2389
|
+
DASHBOARDS: z21.array(
|
|
2390
|
+
z21.object({
|
|
2391
|
+
id: z21.string(),
|
|
2323
2392
|
title: TranslationConfig,
|
|
2324
|
-
url:
|
|
2325
|
-
context:
|
|
2326
|
-
auth:
|
|
2393
|
+
url: z21.string(),
|
|
2394
|
+
context: z21.object({
|
|
2395
|
+
auth: z21.literal("REQUEST_AUTH_TOKEN")
|
|
2327
2396
|
}).optional()
|
|
2328
2397
|
})
|
|
2329
2398
|
),
|
|
2330
|
-
FEATURES:
|
|
2399
|
+
FEATURES: z21.object({ V2_EVENTS: z21.boolean().optional().default(true) }).optional().default({ V2_EVENTS: true })
|
|
2331
2400
|
});
|
|
2332
2401
|
var defineClientConfig = (config) => {
|
|
2333
2402
|
return ClientConfig.parse(config);
|