@opencrvs/toolkit 2.0.0-rc.0cacf8f → 2.0.0-rc.0cc38f9

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.
@@ -75,7 +75,10 @@ var ActionConditional = z.discriminatedUnion("type", [
75
75
  ShowConditional,
76
76
  // Action can be shown to the user in the list but as disabled
77
77
  EnableConditional
78
- ]);
78
+ ]).meta({
79
+ description: "Action conditional configuration",
80
+ id: "ActionConditional"
81
+ });
79
82
  var DisplayOnReviewConditional = z.object({
80
83
  type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
81
84
  conditional: Conditional
@@ -831,7 +834,9 @@ var ScopeType = z11.enum([
831
834
  var EncodedScope = z11.string().brand("EncodedScope");
832
835
  var DEFAULT_SCOPE_OPTIONS = {
833
836
  placeOfEvent: JurisdictionFilter.enum.all,
834
- accessLevel: JurisdictionFilter.enum.all
837
+ accessLevel: JurisdictionFilter.enum.all,
838
+ registeredIn: JurisdictionFilter.enum.all,
839
+ declaredIn: JurisdictionFilter.enum.all
835
840
  };
836
841
 
837
842
  // ../commons/src/authentication.ts
@@ -1077,6 +1082,9 @@ var FlagConfig = z14.object({
1077
1082
  "Indicates if this flag expects an action to be performed to be cleared."
1078
1083
  ),
1079
1084
  label: TranslationConfig.describe("Human readable label of the flag.")
1085
+ }).meta({
1086
+ description: "Flag configuration",
1087
+ id: "FlagConfig"
1080
1088
  });
1081
1089
  var ActionFlagConfig = z14.object({
1082
1090
  id: Flag,
@@ -1084,6 +1092,9 @@ var ActionFlagConfig = z14.object({
1084
1092
  conditional: Conditional.optional().describe(
1085
1093
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1086
1094
  )
1095
+ }).meta({
1096
+ description: "Action flag configuration",
1097
+ id: "ActionFlagConfig"
1087
1098
  });
1088
1099
 
1089
1100
  // ../commons/src/events/EventMetadata.ts
@@ -1396,7 +1407,7 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1396
1407
  }
1397
1408
  }).describe("Unique identifier for the field");
1398
1409
  var FieldReference = import_v43.default.object({
1399
- $$field: FieldId,
1410
+ $$field: FieldId.describe("Id of the field to reference"),
1400
1411
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1401
1412
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1402
1413
  )
package/dist/cli.js CHANGED
@@ -2393,7 +2393,9 @@ var decodeScope = (query) => {
2393
2393
  };
2394
2394
  var DEFAULT_SCOPE_OPTIONS = {
2395
2395
  placeOfEvent: JurisdictionFilter.enum.all,
2396
- accessLevel: JurisdictionFilter.enum.all
2396
+ accessLevel: JurisdictionFilter.enum.all,
2397
+ registeredIn: JurisdictionFilter.enum.all,
2398
+ declaredIn: JurisdictionFilter.enum.all
2397
2399
  };
2398
2400
 
2399
2401
  // ../commons/src/scopes.deprecated.do-not-use.ts
@@ -910,6 +910,152 @@ export declare const WorkqueueConfigWithoutQuery: z.ZodObject<{
910
910
  export declare const WorkqueueConfigInput: z.ZodObject<{
911
911
  slug: z.ZodString;
912
912
  name: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>;
913
+ action: z.ZodOptional<z.ZodObject<{
914
+ type: z.ZodEnum<{
915
+ DELETE: "DELETE";
916
+ DECLARE: "DECLARE";
917
+ REGISTER: "REGISTER";
918
+ EDIT: "EDIT";
919
+ REJECT: "REJECT";
920
+ MARK_AS_DUPLICATE: "MARK_AS_DUPLICATE";
921
+ ARCHIVE: "ARCHIVE";
922
+ PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
923
+ REQUEST_CORRECTION: "REQUEST_CORRECTION";
924
+ READ: "READ";
925
+ }>;
926
+ }, z.core.$strip>>;
927
+ columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
928
+ label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>;
929
+ value: z.ZodObject<{
930
+ $event: z.ZodEnum<{
931
+ id: "id";
932
+ title: "title";
933
+ type: "type";
934
+ updatedAt: "updatedAt";
935
+ placeOfEvent: "placeOfEvent";
936
+ createdByUserType: "createdByUserType";
937
+ createdAt: "createdAt";
938
+ createdBy: "createdBy";
939
+ createdAtLocation: "createdAtLocation";
940
+ status: "status";
941
+ assignedTo: "assignedTo";
942
+ trackingId: "trackingId";
943
+ legalStatuses: "legalStatuses";
944
+ dateOfEvent: "dateOfEvent";
945
+ updatedByUserRole: "updatedByUserRole";
946
+ updatedAtLocation: "updatedAtLocation";
947
+ updatedBy: "updatedBy";
948
+ flags: "flags";
949
+ outbox: "outbox";
950
+ }>;
951
+ }, z.core.$strip>;
952
+ }, z.core.$strip>>>;
953
+ icon: z.ZodEnum<{
954
+ Archived: "Archived";
955
+ Assigned: "Assigned";
956
+ Briefcase: "Briefcase";
957
+ Certified: "Certified";
958
+ Close: "Close";
959
+ Collapse: "Collapse";
960
+ Draft: "Draft";
961
+ DuplicateYellow: "DuplicateYellow";
962
+ Expand: "Expand";
963
+ ExternalValidate: "ExternalValidate";
964
+ FilledCheck: "FilledCheck";
965
+ InReview: "InReview";
966
+ Offline: "Offline";
967
+ Registered: "Registered";
968
+ RequiresUpdates: "RequiresUpdates";
969
+ Sent: "Sent";
970
+ Validated: "Validated";
971
+ WaitingApproval: "WaitingApproval";
972
+ ChartActivity: "ChartActivity";
973
+ Activity: "Activity";
974
+ Archive: "Archive";
975
+ ArchiveTray: "ArchiveTray";
976
+ ArrowLeft: "ArrowLeft";
977
+ ArrowRight: "ArrowRight";
978
+ Buildings: "Buildings";
979
+ Circle: "Circle";
980
+ CaretDown: "CaretDown";
981
+ CaretLeft: "CaretLeft";
982
+ CaretRight: "CaretRight";
983
+ ChartBar: "ChartBar";
984
+ ChartLine: "ChartLine";
985
+ ChatCircle: "ChatCircle";
986
+ CheckSquare: "CheckSquare";
987
+ Compass: "Compass";
988
+ Check: "Check";
989
+ Copy: "Copy";
990
+ Database: "Database";
991
+ DotsThreeVertical: "DotsThreeVertical";
992
+ ArrowCounterClockwise: "ArrowCounterClockwise";
993
+ MagnifyingGlassMinus: "MagnifyingGlassMinus";
994
+ MagnifyingGlassPlus: "MagnifyingGlassPlus";
995
+ Export: "Export";
996
+ Eye: "Eye";
997
+ EyeSlash: "EyeSlash";
998
+ Envelope: "Envelope";
999
+ File: "File";
1000
+ FileSearch: "FileSearch";
1001
+ FileMinus: "FileMinus";
1002
+ FilePlus: "FilePlus";
1003
+ FileText: "FileText";
1004
+ FileX: "FileX";
1005
+ Handshake: "Handshake";
1006
+ Gear: "Gear";
1007
+ GitBranch: "GitBranch";
1008
+ IdentificationCard: "IdentificationCard";
1009
+ List: "List";
1010
+ ListBullets: "ListBullets";
1011
+ Lock: "Lock";
1012
+ MagnifyingGlass: "MagnifyingGlass";
1013
+ MapPin: "MapPin";
1014
+ Medal: "Medal";
1015
+ NotePencil: "NotePencil";
1016
+ Paperclip: "Paperclip";
1017
+ PaperPlaneTilt: "PaperPlaneTilt";
1018
+ Pen: "Pen";
1019
+ PenNib: "PenNib";
1020
+ Pencil: "Pencil";
1021
+ PencilSimpleLine: "PencilSimpleLine";
1022
+ Phone: "Phone";
1023
+ Plus: "Plus";
1024
+ Printer: "Printer";
1025
+ SignOut: "SignOut";
1026
+ Stamp: "Stamp";
1027
+ Star: "Star";
1028
+ Target: "Target";
1029
+ TextT: "TextT";
1030
+ Trash: "Trash";
1031
+ UploadSimple: "UploadSimple";
1032
+ User: "User";
1033
+ UserPlus: "UserPlus";
1034
+ Users: "Users";
1035
+ WarningCircle: "WarningCircle";
1036
+ X: "X";
1037
+ ChatText: "ChatText";
1038
+ CircleWavyCheck: "CircleWavyCheck";
1039
+ CircleWavyQuestion: "CircleWavyQuestion";
1040
+ ArchiveBox: "ArchiveBox";
1041
+ ArrowCircleDown: "ArrowCircleDown";
1042
+ FileArrowUp: "FileArrowUp";
1043
+ FileDotted: "FileDotted";
1044
+ Files: "Files";
1045
+ PencilLine: "PencilLine";
1046
+ PencilCircle: "PencilCircle";
1047
+ UserCircle: "UserCircle";
1048
+ Clock: "Clock";
1049
+ QrCode: "QrCode";
1050
+ Webcam: "Webcam";
1051
+ Sun: "Sun";
1052
+ DeviceTabletCamera: "DeviceTabletCamera";
1053
+ Globe: "Globe";
1054
+ Fingerprint: "Fingerprint";
1055
+ PushPin: "PushPin";
1056
+ Timer: "Timer";
1057
+ }>;
1058
+ emptyMessage: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>>;
913
1059
  query: z.ZodUnion<readonly [z.ZodObject<{
914
1060
  eventType: z.ZodOptional<z.ZodString>;
915
1061
  status: z.ZodOptional<z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
@@ -1838,152 +1984,6 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
1838
1984
  data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
1839
1985
  }, z.core.$strip>>;
1840
1986
  }, z.core.$strip>]>;
1841
- action: z.ZodOptional<z.ZodObject<{
1842
- type: z.ZodEnum<{
1843
- DELETE: "DELETE";
1844
- DECLARE: "DECLARE";
1845
- REGISTER: "REGISTER";
1846
- EDIT: "EDIT";
1847
- REJECT: "REJECT";
1848
- MARK_AS_DUPLICATE: "MARK_AS_DUPLICATE";
1849
- ARCHIVE: "ARCHIVE";
1850
- PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
1851
- REQUEST_CORRECTION: "REQUEST_CORRECTION";
1852
- READ: "READ";
1853
- }>;
1854
- }, z.core.$strip>>;
1855
- columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
1856
- label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>;
1857
- value: z.ZodObject<{
1858
- $event: z.ZodEnum<{
1859
- id: "id";
1860
- title: "title";
1861
- type: "type";
1862
- updatedAt: "updatedAt";
1863
- placeOfEvent: "placeOfEvent";
1864
- createdByUserType: "createdByUserType";
1865
- createdAt: "createdAt";
1866
- createdBy: "createdBy";
1867
- createdAtLocation: "createdAtLocation";
1868
- status: "status";
1869
- assignedTo: "assignedTo";
1870
- trackingId: "trackingId";
1871
- legalStatuses: "legalStatuses";
1872
- dateOfEvent: "dateOfEvent";
1873
- updatedByUserRole: "updatedByUserRole";
1874
- updatedAtLocation: "updatedAtLocation";
1875
- updatedBy: "updatedBy";
1876
- flags: "flags";
1877
- outbox: "outbox";
1878
- }>;
1879
- }, z.core.$strip>;
1880
- }, z.core.$strip>>>;
1881
- icon: z.ZodEnum<{
1882
- Archived: "Archived";
1883
- Assigned: "Assigned";
1884
- Briefcase: "Briefcase";
1885
- Certified: "Certified";
1886
- Close: "Close";
1887
- Collapse: "Collapse";
1888
- Draft: "Draft";
1889
- DuplicateYellow: "DuplicateYellow";
1890
- Expand: "Expand";
1891
- ExternalValidate: "ExternalValidate";
1892
- FilledCheck: "FilledCheck";
1893
- InReview: "InReview";
1894
- Offline: "Offline";
1895
- Registered: "Registered";
1896
- RequiresUpdates: "RequiresUpdates";
1897
- Sent: "Sent";
1898
- Validated: "Validated";
1899
- WaitingApproval: "WaitingApproval";
1900
- ChartActivity: "ChartActivity";
1901
- Activity: "Activity";
1902
- Archive: "Archive";
1903
- ArchiveTray: "ArchiveTray";
1904
- ArrowLeft: "ArrowLeft";
1905
- ArrowRight: "ArrowRight";
1906
- Buildings: "Buildings";
1907
- Circle: "Circle";
1908
- CaretDown: "CaretDown";
1909
- CaretLeft: "CaretLeft";
1910
- CaretRight: "CaretRight";
1911
- ChartBar: "ChartBar";
1912
- ChartLine: "ChartLine";
1913
- ChatCircle: "ChatCircle";
1914
- CheckSquare: "CheckSquare";
1915
- Compass: "Compass";
1916
- Check: "Check";
1917
- Copy: "Copy";
1918
- Database: "Database";
1919
- DotsThreeVertical: "DotsThreeVertical";
1920
- ArrowCounterClockwise: "ArrowCounterClockwise";
1921
- MagnifyingGlassMinus: "MagnifyingGlassMinus";
1922
- MagnifyingGlassPlus: "MagnifyingGlassPlus";
1923
- Export: "Export";
1924
- Eye: "Eye";
1925
- EyeSlash: "EyeSlash";
1926
- Envelope: "Envelope";
1927
- File: "File";
1928
- FileSearch: "FileSearch";
1929
- FileMinus: "FileMinus";
1930
- FilePlus: "FilePlus";
1931
- FileText: "FileText";
1932
- FileX: "FileX";
1933
- Handshake: "Handshake";
1934
- Gear: "Gear";
1935
- GitBranch: "GitBranch";
1936
- IdentificationCard: "IdentificationCard";
1937
- List: "List";
1938
- ListBullets: "ListBullets";
1939
- Lock: "Lock";
1940
- MagnifyingGlass: "MagnifyingGlass";
1941
- MapPin: "MapPin";
1942
- Medal: "Medal";
1943
- NotePencil: "NotePencil";
1944
- Paperclip: "Paperclip";
1945
- PaperPlaneTilt: "PaperPlaneTilt";
1946
- Pen: "Pen";
1947
- PenNib: "PenNib";
1948
- Pencil: "Pencil";
1949
- PencilSimpleLine: "PencilSimpleLine";
1950
- Phone: "Phone";
1951
- Plus: "Plus";
1952
- Printer: "Printer";
1953
- SignOut: "SignOut";
1954
- Stamp: "Stamp";
1955
- Star: "Star";
1956
- Target: "Target";
1957
- TextT: "TextT";
1958
- Trash: "Trash";
1959
- UploadSimple: "UploadSimple";
1960
- User: "User";
1961
- UserPlus: "UserPlus";
1962
- Users: "Users";
1963
- WarningCircle: "WarningCircle";
1964
- X: "X";
1965
- ChatText: "ChatText";
1966
- CircleWavyCheck: "CircleWavyCheck";
1967
- CircleWavyQuestion: "CircleWavyQuestion";
1968
- ArchiveBox: "ArchiveBox";
1969
- ArrowCircleDown: "ArrowCircleDown";
1970
- FileArrowUp: "FileArrowUp";
1971
- FileDotted: "FileDotted";
1972
- Files: "Files";
1973
- PencilLine: "PencilLine";
1974
- PencilCircle: "PencilCircle";
1975
- UserCircle: "UserCircle";
1976
- Clock: "Clock";
1977
- QrCode: "QrCode";
1978
- Webcam: "Webcam";
1979
- Sun: "Sun";
1980
- DeviceTabletCamera: "DeviceTabletCamera";
1981
- Globe: "Globe";
1982
- Fingerprint: "Fingerprint";
1983
- PushPin: "PushPin";
1984
- Timer: "Timer";
1985
- }>;
1986
- emptyMessage: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>>;
1987
1987
  }, z.core.$strip>;
1988
1988
  export type WorkqueueConfig = z.infer<typeof WorkqueueConfig>;
1989
1989
  export type WorkqueueConfigWithoutQuery = z.infer<typeof WorkqueueConfigWithoutQuery>;
@@ -365,7 +365,9 @@ var ScopeType2 = z6.enum([
365
365
  var EncodedScope2 = z6.string().brand("EncodedScope");
366
366
  var DEFAULT_SCOPE_OPTIONS = {
367
367
  placeOfEvent: JurisdictionFilter.enum.all,
368
- accessLevel: JurisdictionFilter.enum.all
368
+ accessLevel: JurisdictionFilter.enum.all,
369
+ registeredIn: JurisdictionFilter.enum.all,
370
+ declaredIn: JurisdictionFilter.enum.all
369
371
  };
370
372
 
371
373
  // ../commons/src/users/userReferences.ts
@@ -704,7 +704,9 @@ var decodeScope = (query) => {
704
704
  };
705
705
  var DEFAULT_SCOPE_OPTIONS = {
706
706
  placeOfEvent: JurisdictionFilter.enum.all,
707
- accessLevel: JurisdictionFilter.enum.all
707
+ accessLevel: JurisdictionFilter.enum.all,
708
+ registeredIn: JurisdictionFilter.enum.all,
709
+ declaredIn: JurisdictionFilter.enum.all
708
710
  };
709
711
  function getAcceptedScopesByType({
710
712
  acceptedScopes,
@@ -1077,7 +1079,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
1077
1079
  ShowConditional,
1078
1080
  // Action can be shown to the user in the list but as disabled
1079
1081
  EnableConditional
1080
- ]);
1082
+ ]).meta({
1083
+ description: "Action conditional configuration",
1084
+ id: "ActionConditional"
1085
+ });
1081
1086
  var DisplayOnReviewConditional = z7.object({
1082
1087
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
1083
1088
  conditional: Conditional
@@ -1736,6 +1741,9 @@ var FlagConfig = z15.object({
1736
1741
  "Indicates if this flag expects an action to be performed to be cleared."
1737
1742
  ),
1738
1743
  label: TranslationConfig.describe("Human readable label of the flag.")
1744
+ }).meta({
1745
+ description: "Flag configuration",
1746
+ id: "FlagConfig"
1739
1747
  });
1740
1748
  var ActionFlagConfig = z15.object({
1741
1749
  id: Flag,
@@ -1743,6 +1751,9 @@ var ActionFlagConfig = z15.object({
1743
1751
  conditional: Conditional.optional().describe(
1744
1752
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1745
1753
  )
1754
+ }).meta({
1755
+ description: "Action flag configuration",
1756
+ id: "ActionFlagConfig"
1746
1757
  });
1747
1758
 
1748
1759
  // ../commons/src/events/EventMetadata.ts
@@ -2166,7 +2177,7 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
2166
2177
  }
2167
2178
  }).describe("Unique identifier for the field");
2168
2179
  var FieldReference = import_v43.default.object({
2169
- $$field: FieldId,
2180
+ $$field: FieldId.describe("Id of the field to reference"),
2170
2181
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
2171
2182
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
2172
2183
  )
@@ -2879,10 +2890,10 @@ var VerificationPageConfig = FormPageConfig.extend({
2879
2890
  type: z21.literal(PageTypes.enum.VERIFICATION),
2880
2891
  actions: VerificationActionConfig
2881
2892
  });
2882
- var PageConfig = z21.discriminatedUnion("type", [
2883
- FormPageConfig,
2884
- VerificationPageConfig
2885
- ]);
2893
+ var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
2894
+ description: "Page configuration",
2895
+ id: "PageConfig"
2896
+ });
2886
2897
 
2887
2898
  // ../commons/src/events/FormConfig.ts
2888
2899
  var DeclarationFormConfig = z22.object({
@@ -5363,7 +5374,7 @@ var _EventConfigBase = z33.object({
5363
5374
  ),
5364
5375
  label: TranslationConfig.describe("Human-readable label for the event type."),
5365
5376
  actions: z33.array(ActionConfig).describe(
5366
- "Configuration of system-defined actions associated with the event."
5377
+ "Configuration of core and custom actions associated with the event."
5367
5378
  ),
5368
5379
  actionOrder: z33.array(z33.string()).optional().describe(
5369
5380
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -5375,7 +5386,7 @@ var _EventConfigBase = z33.object({
5375
5386
  "Configuration of fields available in the advanced search feature."
5376
5387
  ),
5377
5388
  flags: z33.array(FlagConfig).optional().default([]).describe(
5378
- "Configuration of flags associated with the actions of this event type."
5389
+ "Configuration of custom flags associated with the actions of this event type."
5379
5390
  ),
5380
5391
  analytics: z33.boolean().optional().default(true).describe(
5381
5392
  "Indicates whether the records of this event type are included in analytics"
@@ -5814,18 +5825,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
5814
5825
  query: true,
5815
5826
  columns: true
5816
5827
  });
5817
- var WorkqueueConfigInput = z37.object({
5818
- slug: z37.string().describe("Determines the url of the workqueue."),
5819
- name: TranslationConfig.describe(
5820
- "Title of the workflow (both in navigation and on the page)"
5821
- ),
5822
- query: CountryConfigQueryInputType,
5823
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
5824
- "Workqueue call-to-action button configuration. This determines the quick action button shown on each event card and the action taken when the button is clicked."
5825
- ),
5826
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
5827
- icon: AvailableIcons,
5828
- emptyMessage: TranslationConfig.optional()
5828
+ var WorkqueueConfigInput = WorkqueueConfig.extend({
5829
+ query: CountryConfigQueryInputType
5830
+ }).meta({
5831
+ description: "Workqueue configuration",
5832
+ id: "WorkqueueConfig"
5829
5833
  });
5830
5834
  function defineWorkqueue(workqueueInput) {
5831
5835
  const queryInput = workqueueInput.query;
@@ -2405,7 +2405,9 @@ var decodeScope = (query) => {
2405
2405
  };
2406
2406
  var DEFAULT_SCOPE_OPTIONS = {
2407
2407
  placeOfEvent: JurisdictionFilter.enum.all,
2408
- accessLevel: JurisdictionFilter.enum.all
2408
+ accessLevel: JurisdictionFilter.enum.all,
2409
+ registeredIn: JurisdictionFilter.enum.all,
2410
+ declaredIn: JurisdictionFilter.enum.all
2409
2411
  };
2410
2412
 
2411
2413
  // ../commons/src/scopes.deprecated.do-not-use.ts
@@ -293,7 +293,9 @@ var ScopeType = z2.enum([
293
293
  var EncodedScope = z2.string().brand("EncodedScope");
294
294
  var DEFAULT_SCOPE_OPTIONS = {
295
295
  placeOfEvent: JurisdictionFilter.enum.all,
296
- accessLevel: JurisdictionFilter.enum.all
296
+ accessLevel: JurisdictionFilter.enum.all,
297
+ registeredIn: JurisdictionFilter.enum.all,
298
+ declaredIn: JurisdictionFilter.enum.all
297
299
  };
298
300
 
299
301
  // ../commons/src/authentication.ts
@@ -652,7 +654,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
652
654
  ShowConditional,
653
655
  // Action can be shown to the user in the list but as disabled
654
656
  EnableConditional
655
- ]);
657
+ ]).meta({
658
+ description: "Action conditional configuration",
659
+ id: "ActionConditional"
660
+ });
656
661
  var DisplayOnReviewConditional = z7.object({
657
662
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
658
663
  conditional: Conditional
@@ -1303,6 +1308,9 @@ var FlagConfig = z15.object({
1303
1308
  "Indicates if this flag expects an action to be performed to be cleared."
1304
1309
  ),
1305
1310
  label: TranslationConfig.describe("Human readable label of the flag.")
1311
+ }).meta({
1312
+ description: "Flag configuration",
1313
+ id: "FlagConfig"
1306
1314
  });
1307
1315
  var ActionFlagConfig = z15.object({
1308
1316
  id: Flag,
@@ -1310,6 +1318,9 @@ var ActionFlagConfig = z15.object({
1310
1318
  conditional: Conditional.optional().describe(
1311
1319
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1312
1320
  )
1321
+ }).meta({
1322
+ description: "Action flag configuration",
1323
+ id: "ActionFlagConfig"
1313
1324
  });
1314
1325
 
1315
1326
  // ../commons/src/events/EventMetadata.ts
@@ -1651,7 +1662,7 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1651
1662
  }
1652
1663
  }).describe("Unique identifier for the field");
1653
1664
  var FieldReference = import_v43.default.object({
1654
- $$field: FieldId,
1665
+ $$field: FieldId.describe("Id of the field to reference"),
1655
1666
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1656
1667
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1657
1668
  )
@@ -2364,10 +2375,10 @@ var VerificationPageConfig = FormPageConfig.extend({
2364
2375
  type: z21.literal(PageTypes.enum.VERIFICATION),
2365
2376
  actions: VerificationActionConfig
2366
2377
  });
2367
- var PageConfig = z21.discriminatedUnion("type", [
2368
- FormPageConfig,
2369
- VerificationPageConfig
2370
- ]);
2378
+ var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
2379
+ description: "Page configuration",
2380
+ id: "PageConfig"
2381
+ });
2371
2382
 
2372
2383
  // ../commons/src/events/FormConfig.ts
2373
2384
  var DeclarationFormConfig = z22.object({
@@ -3667,7 +3678,7 @@ var _EventConfigBase = z33.object({
3667
3678
  ),
3668
3679
  label: TranslationConfig.describe("Human-readable label for the event type."),
3669
3680
  actions: z33.array(ActionConfig).describe(
3670
- "Configuration of system-defined actions associated with the event."
3681
+ "Configuration of core and custom actions associated with the event."
3671
3682
  ),
3672
3683
  actionOrder: z33.array(z33.string()).optional().describe(
3673
3684
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -3679,7 +3690,7 @@ var _EventConfigBase = z33.object({
3679
3690
  "Configuration of fields available in the advanced search feature."
3680
3691
  ),
3681
3692
  flags: z33.array(FlagConfig).optional().default([]).describe(
3682
- "Configuration of flags associated with the actions of this event type."
3693
+ "Configuration of custom flags associated with the actions of this event type."
3683
3694
  ),
3684
3695
  analytics: z33.boolean().optional().default(true).describe(
3685
3696
  "Indicates whether the records of this event type are included in analytics"
@@ -4117,18 +4128,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
4117
4128
  query: true,
4118
4129
  columns: true
4119
4130
  });
4120
- var WorkqueueConfigInput = z37.object({
4121
- slug: z37.string().describe("Determines the url of the workqueue."),
4122
- name: TranslationConfig.describe(
4123
- "Title of the workflow (both in navigation and on the page)"
4124
- ),
4125
- query: CountryConfigQueryInputType,
4126
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
4127
- "Workqueue call-to-action button configuration. This determines the quick action button shown on each event card and the action taken when the button is clicked."
4128
- ),
4129
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
4130
- icon: AvailableIcons,
4131
- emptyMessage: TranslationConfig.optional()
4131
+ var WorkqueueConfigInput = WorkqueueConfig.extend({
4132
+ query: CountryConfigQueryInputType
4133
+ }).meta({
4134
+ description: "Workqueue configuration",
4135
+ id: "WorkqueueConfig"
4132
4136
  });
4133
4137
  var WorkqueueCountInput = z37.array(
4134
4138
  z37.object({ slug: z37.string(), query: QueryType })
@@ -365,7 +365,9 @@ var decodeScope = (query) => {
365
365
  };
366
366
  var DEFAULT_SCOPE_OPTIONS = {
367
367
  placeOfEvent: JurisdictionFilter.enum.all,
368
- accessLevel: JurisdictionFilter.enum.all
368
+ accessLevel: JurisdictionFilter.enum.all,
369
+ registeredIn: JurisdictionFilter.enum.all,
370
+ declaredIn: JurisdictionFilter.enum.all
369
371
  };
370
372
  function getScopeOptionValue(scope, option) {
371
373
  const options = "options" in scope ? scope.options : void 0;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "2.0.0-rc.0cacf8f",
3
+ "version": "2.0.0-rc.0cc38f9",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
6
  "bin": {