@opencrvs/toolkit 2.0.0-rc.1b5d54a → 2.0.0-rc.1ddd150
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/create-countryconfig/index.js +50 -20
- package/create-countryconfig/package.json +12 -2
- package/dist/application-config/index.js +200 -64
- package/dist/cli.js +3 -1
- package/dist/commons/api/router.d.ts +15 -4
- package/dist/commons/events/ActionInput.d.ts +36 -36
- package/dist/commons/events/Draft.d.ts +2 -3
- package/dist/commons/events/WorkqueueConfig.d.ts +5 -5
- package/dist/conditionals/index.js +3 -1
- package/dist/events/index.js +262 -83
- package/dist/migrations/v2.0/index.js +3 -1
- package/dist/notification/index.js +262 -83
- package/dist/scopes/index.js +3 -1
- package/opencrvs-toolkit-2.0.0-rc.1ddd150.tgz +0 -0
- package/package.json +5 -1
- package/opencrvs-toolkit-2.0.0-rc.1b5d54a.tgz +0 -0
|
@@ -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
|
|
@@ -653,8 +655,8 @@ var ActionConditional = z7.discriminatedUnion("type", [
|
|
|
653
655
|
// Action can be shown to the user in the list but as disabled
|
|
654
656
|
EnableConditional
|
|
655
657
|
]).meta({
|
|
656
|
-
|
|
657
|
-
|
|
658
|
+
id: "ActionConditional",
|
|
659
|
+
description: "Conditional gating whether an action is shown (SHOW) or enabled (ENABLE). When omitted from an action, the action is shown and enabled for everyone."
|
|
658
660
|
});
|
|
659
661
|
var DisplayOnReviewConditional = z7.object({
|
|
660
662
|
type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
@@ -670,8 +672,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
|
|
|
670
672
|
// Field output can be shown / hidden on the review page
|
|
671
673
|
DisplayOnReviewConditional
|
|
672
674
|
]).meta({
|
|
673
|
-
|
|
674
|
-
|
|
675
|
+
id: "FieldConditional",
|
|
676
|
+
description: "Conditional gating whether a form field is shown (SHOW), enabled (ENABLE), or displayed on the review page (DISPLAY_ON_REVIEW). When omitted, the field is shown and enabled for everyone, and is displayed on review whenever it has a value."
|
|
675
677
|
});
|
|
676
678
|
|
|
677
679
|
// ../commons/src/events/FieldType.ts
|
|
@@ -1307,8 +1309,8 @@ var FlagConfig = z15.object({
|
|
|
1307
1309
|
),
|
|
1308
1310
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1309
1311
|
}).meta({
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
+
id: "FlagConfig",
|
|
1313
|
+
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
1312
1314
|
});
|
|
1313
1315
|
var ActionFlagConfig = z15.object({
|
|
1314
1316
|
id: Flag,
|
|
@@ -1317,8 +1319,8 @@ var ActionFlagConfig = z15.object({
|
|
|
1317
1319
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1318
1320
|
)
|
|
1319
1321
|
}).meta({
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
+
id: "ActionFlagConfig",
|
|
1323
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1322
1324
|
});
|
|
1323
1325
|
|
|
1324
1326
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1666,8 +1668,15 @@ var FieldReference = import_v43.default.object({
|
|
|
1666
1668
|
)
|
|
1667
1669
|
}).describe("Reference to a field by its ID");
|
|
1668
1670
|
var ValidationConfig = import_v43.default.object({
|
|
1669
|
-
validator: Conditional
|
|
1670
|
-
|
|
1671
|
+
validator: Conditional.describe(
|
|
1672
|
+
"Conditional expression that must hold for the field value to be considered valid."
|
|
1673
|
+
),
|
|
1674
|
+
message: TranslationConfig.describe(
|
|
1675
|
+
"Error message displayed when the validator does not hold."
|
|
1676
|
+
)
|
|
1677
|
+
}).meta({
|
|
1678
|
+
id: "ValidationConfig",
|
|
1679
|
+
description: "Validation rule applied to a form field. The validator is a conditional expression that must hold for the field value to be considered valid."
|
|
1671
1680
|
});
|
|
1672
1681
|
var requiredSchema = import_v43.default.union([
|
|
1673
1682
|
import_v43.default.boolean(),
|
|
@@ -1706,6 +1715,9 @@ var BaseField = import_v43.default.object({
|
|
|
1706
1715
|
}).describe("Common properties shared across all field types.");
|
|
1707
1716
|
var Divider = BaseField.extend({
|
|
1708
1717
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
1718
|
+
}).meta({
|
|
1719
|
+
description: "A horizontal line divider",
|
|
1720
|
+
id: "Divider"
|
|
1709
1721
|
});
|
|
1710
1722
|
var TextField = BaseField.extend({
|
|
1711
1723
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
@@ -1716,7 +1728,10 @@ var TextField = BaseField.extend({
|
|
|
1716
1728
|
prefix: TranslationConfig.optional(),
|
|
1717
1729
|
postfix: TranslationConfig.optional()
|
|
1718
1730
|
}).default({ type: "text" }).optional()
|
|
1719
|
-
}).
|
|
1731
|
+
}).meta({
|
|
1732
|
+
description: "A text input field",
|
|
1733
|
+
id: "TextField"
|
|
1734
|
+
});
|
|
1720
1735
|
var NumberField = BaseField.extend({
|
|
1721
1736
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
1722
1737
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -1726,7 +1741,10 @@ var NumberField = BaseField.extend({
|
|
|
1726
1741
|
prefix: TranslationConfig.optional(),
|
|
1727
1742
|
postfix: TranslationConfig.optional()
|
|
1728
1743
|
}).optional()
|
|
1729
|
-
}).
|
|
1744
|
+
}).meta({
|
|
1745
|
+
description: "A number input field",
|
|
1746
|
+
id: "NumberField"
|
|
1747
|
+
});
|
|
1730
1748
|
var TextAreaField = BaseField.extend({
|
|
1731
1749
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
1732
1750
|
defaultValue: NonEmptyTextValue.optional(),
|
|
@@ -1737,7 +1755,10 @@ var TextAreaField = BaseField.extend({
|
|
|
1737
1755
|
prefix: TranslationConfig.optional(),
|
|
1738
1756
|
postfix: TranslationConfig.optional()
|
|
1739
1757
|
}).default({ rows: 4 }).optional()
|
|
1740
|
-
}).
|
|
1758
|
+
}).meta({
|
|
1759
|
+
description: "A multiline text input",
|
|
1760
|
+
id: "TextAreaField"
|
|
1761
|
+
});
|
|
1741
1762
|
var ImageMimeType = import_v43.default.enum([
|
|
1742
1763
|
"image/png",
|
|
1743
1764
|
"image/jpg",
|
|
@@ -1767,13 +1788,19 @@ var SignatureField = BaseField.extend({
|
|
|
1767
1788
|
}).default({
|
|
1768
1789
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1769
1790
|
})
|
|
1770
|
-
}).
|
|
1791
|
+
}).meta({
|
|
1792
|
+
description: "A signature input field",
|
|
1793
|
+
id: "SignatureField"
|
|
1794
|
+
});
|
|
1771
1795
|
var EmailField = BaseField.extend({
|
|
1772
1796
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
1773
1797
|
configuration: import_v43.default.object({
|
|
1774
1798
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
1775
1799
|
}).default({ maxLength: 255 }).optional(),
|
|
1776
1800
|
defaultValue: NonEmptyTextValue.optional()
|
|
1801
|
+
}).meta({
|
|
1802
|
+
description: "An email input field",
|
|
1803
|
+
id: "EmailField"
|
|
1777
1804
|
});
|
|
1778
1805
|
var DateField = BaseField.extend({
|
|
1779
1806
|
type: import_v43.default.literal(FieldType.DATE),
|
|
@@ -1783,7 +1810,10 @@ var DateField = BaseField.extend({
|
|
|
1783
1810
|
"Text to display above the date input"
|
|
1784
1811
|
).optional()
|
|
1785
1812
|
}).optional()
|
|
1786
|
-
}).
|
|
1813
|
+
}).meta({
|
|
1814
|
+
description: "A date input (yyyy-MM-dd)",
|
|
1815
|
+
id: "DateField"
|
|
1816
|
+
});
|
|
1787
1817
|
var AgeField = BaseField.extend({
|
|
1788
1818
|
type: import_v43.default.literal(FieldType.AGE),
|
|
1789
1819
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -1792,7 +1822,10 @@ var AgeField = BaseField.extend({
|
|
|
1792
1822
|
prefix: TranslationConfig.optional(),
|
|
1793
1823
|
postfix: TranslationConfig.optional()
|
|
1794
1824
|
})
|
|
1795
|
-
}).
|
|
1825
|
+
}).meta({
|
|
1826
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
1827
|
+
id: "AgeField"
|
|
1828
|
+
});
|
|
1796
1829
|
var TimeField = BaseField.extend({
|
|
1797
1830
|
type: import_v43.default.literal(FieldType.TIME),
|
|
1798
1831
|
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
@@ -1802,7 +1835,10 @@ var TimeField = BaseField.extend({
|
|
|
1802
1835
|
"Text to display above the time input"
|
|
1803
1836
|
).optional()
|
|
1804
1837
|
}).optional()
|
|
1805
|
-
}).
|
|
1838
|
+
}).meta({
|
|
1839
|
+
description: "A single time input (HH-mm)",
|
|
1840
|
+
id: "TimeField"
|
|
1841
|
+
});
|
|
1806
1842
|
var DateRangeField = BaseField.extend({
|
|
1807
1843
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
1808
1844
|
defaultValue: DateRangeFieldValue.optional(),
|
|
@@ -1811,7 +1847,10 @@ var DateRangeField = BaseField.extend({
|
|
|
1811
1847
|
"Text to display above the date input"
|
|
1812
1848
|
).optional()
|
|
1813
1849
|
}).optional()
|
|
1814
|
-
}).
|
|
1850
|
+
}).meta({
|
|
1851
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
1852
|
+
id: "DateRangeField"
|
|
1853
|
+
});
|
|
1815
1854
|
var HtmlFontVariant = import_v43.default.enum([
|
|
1816
1855
|
"reg12",
|
|
1817
1856
|
"reg14",
|
|
@@ -1855,18 +1894,30 @@ var ImageViewField = BaseField.extend({
|
|
|
1855
1894
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
1856
1895
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1857
1896
|
configuration: ImageConfiguration
|
|
1858
|
-
}).
|
|
1897
|
+
}).meta({
|
|
1898
|
+
description: "A read-only image component for form pages",
|
|
1899
|
+
id: "ImageViewField"
|
|
1900
|
+
});
|
|
1859
1901
|
var Paragraph = BaseField.extend({
|
|
1860
1902
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
1861
1903
|
configuration: ParagraphConfiguration
|
|
1862
|
-
}).
|
|
1904
|
+
}).meta({
|
|
1905
|
+
description: "A read-only HTML <p> paragraph",
|
|
1906
|
+
id: "Paragraph"
|
|
1907
|
+
});
|
|
1863
1908
|
var Heading = BaseField.extend({
|
|
1864
1909
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
1865
1910
|
configuration: HeadingConfiguration
|
|
1866
|
-
}).
|
|
1911
|
+
}).meta({
|
|
1912
|
+
description: "A read-only heading component for form pages",
|
|
1913
|
+
id: "Heading"
|
|
1914
|
+
});
|
|
1867
1915
|
var PageHeader = BaseField.extend({
|
|
1868
1916
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
1869
|
-
}).
|
|
1917
|
+
}).meta({
|
|
1918
|
+
description: "A read-only header component for form pages",
|
|
1919
|
+
id: "PageHeader"
|
|
1920
|
+
});
|
|
1870
1921
|
var File = BaseField.extend({
|
|
1871
1922
|
type: import_v43.default.literal(FieldType.FILE),
|
|
1872
1923
|
defaultValue: FileFieldValue.optional(),
|
|
@@ -1885,7 +1936,10 @@ var File = BaseField.extend({
|
|
|
1885
1936
|
}).default({
|
|
1886
1937
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1887
1938
|
})
|
|
1888
|
-
}).
|
|
1939
|
+
}).meta({
|
|
1940
|
+
description: "A file upload field",
|
|
1941
|
+
id: "File"
|
|
1942
|
+
});
|
|
1889
1943
|
var SelectOption = import_v43.default.object({
|
|
1890
1944
|
value: import_v43.default.string().describe("The value of the option"),
|
|
1891
1945
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -1902,7 +1956,10 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
1902
1956
|
"Placeholder for the number field"
|
|
1903
1957
|
)
|
|
1904
1958
|
}).optional()
|
|
1905
|
-
}).
|
|
1959
|
+
}).meta({
|
|
1960
|
+
description: "A number with unit input field",
|
|
1961
|
+
id: "NumberWithUnitField"
|
|
1962
|
+
});
|
|
1906
1963
|
var RadioGroup = BaseField.extend({
|
|
1907
1964
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
1908
1965
|
defaultValue: TextValue.optional(),
|
|
@@ -1912,7 +1969,10 @@ var RadioGroup = BaseField.extend({
|
|
|
1912
1969
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
1913
1970
|
}).optional()
|
|
1914
1971
|
}).optional()
|
|
1915
|
-
}).
|
|
1972
|
+
}).meta({
|
|
1973
|
+
description: "A grouped radio button field",
|
|
1974
|
+
id: "RadioGroup"
|
|
1975
|
+
});
|
|
1916
1976
|
var BulletList = BaseField.extend({
|
|
1917
1977
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
1918
1978
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -1921,7 +1981,10 @@ var BulletList = BaseField.extend({
|
|
|
1921
1981
|
fontVariant: HtmlFontVariant.optional()
|
|
1922
1982
|
}).optional()
|
|
1923
1983
|
}).default({})
|
|
1924
|
-
}).
|
|
1984
|
+
}).meta({
|
|
1985
|
+
description: "A list of bullet points",
|
|
1986
|
+
id: "BulletList"
|
|
1987
|
+
});
|
|
1925
1988
|
var Select = BaseField.extend({
|
|
1926
1989
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
1927
1990
|
defaultValue: TextValue.optional(),
|
|
@@ -1936,7 +1999,10 @@ var Select = BaseField.extend({
|
|
|
1936
1999
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
1937
2000
|
`
|
|
1938
2001
|
)
|
|
1939
|
-
}).
|
|
2002
|
+
}).meta({
|
|
2003
|
+
description: "A select input field",
|
|
2004
|
+
id: "Select"
|
|
2005
|
+
});
|
|
1940
2006
|
var SelectDateRangeOption = import_v43.default.object({
|
|
1941
2007
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
1942
2008
|
label: TranslationConfig.describe("The label of the option")
|
|
@@ -1945,7 +2011,10 @@ var SelectDateRangeField = BaseField.extend({
|
|
|
1945
2011
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
1946
2012
|
defaultValue: SelectDateRangeValue.optional(),
|
|
1947
2013
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
1948
|
-
}).
|
|
2014
|
+
}).meta({
|
|
2015
|
+
description: "A date range selection field",
|
|
2016
|
+
id: "SelectDateRangeField"
|
|
2017
|
+
});
|
|
1949
2018
|
var NameConfig = import_v43.default.object({
|
|
1950
2019
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
1951
2020
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -1976,26 +2045,41 @@ var NameField = BaseField.extend({
|
|
|
1976
2045
|
surname: { required: true }
|
|
1977
2046
|
}
|
|
1978
2047
|
}).optional()
|
|
1979
|
-
}).
|
|
2048
|
+
}).meta({
|
|
2049
|
+
description: "A field for entering a persons name",
|
|
2050
|
+
id: "NameField"
|
|
2051
|
+
});
|
|
1980
2052
|
var PhoneField = BaseField.extend({
|
|
1981
2053
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1982
2054
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
1983
|
-
}).
|
|
2055
|
+
}).meta({
|
|
2056
|
+
description: "A field for entering a phone number",
|
|
2057
|
+
id: "PhoneField"
|
|
2058
|
+
});
|
|
1984
2059
|
var IdField = BaseField.extend({
|
|
1985
2060
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1986
2061
|
type: import_v43.default.literal(FieldType.ID)
|
|
1987
|
-
}).
|
|
2062
|
+
}).meta({
|
|
2063
|
+
description: "A field for entering an ID",
|
|
2064
|
+
id: "IdField"
|
|
2065
|
+
});
|
|
1988
2066
|
var Checkbox = BaseField.extend({
|
|
1989
2067
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
1990
2068
|
defaultValue: CheckboxFieldValue.default(false)
|
|
1991
|
-
}).
|
|
2069
|
+
}).meta({
|
|
2070
|
+
description: "A boolean checkbox field",
|
|
2071
|
+
id: "Checkbox"
|
|
2072
|
+
});
|
|
1992
2073
|
var Country = BaseField.extend({
|
|
1993
2074
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
1994
2075
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1995
2076
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
1996
2077
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
1997
2078
|
)
|
|
1998
|
-
}).
|
|
2079
|
+
}).meta({
|
|
2080
|
+
description: "A field for selecting a country",
|
|
2081
|
+
id: "Country"
|
|
2082
|
+
});
|
|
1999
2083
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
2000
2084
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
2001
2085
|
);
|
|
@@ -2004,16 +2088,18 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
2004
2088
|
"HEALTH_FACILITY",
|
|
2005
2089
|
"CRVS_OFFICE"
|
|
2006
2090
|
]);
|
|
2007
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
2008
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
2009
|
-
type: AdministrativeAreas,
|
|
2010
|
-
allowedLocations: AllowedLocations
|
|
2011
|
-
}).describe("Administrative area options");
|
|
2012
2091
|
var AdministrativeAreaField = BaseField.extend({
|
|
2013
2092
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
2014
2093
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
2015
|
-
configuration:
|
|
2016
|
-
|
|
2094
|
+
configuration: import_v43.default.object({
|
|
2095
|
+
partOf: FieldReference.optional().describe("Parent location"),
|
|
2096
|
+
type: AdministrativeAreas,
|
|
2097
|
+
allowedLocations: AllowedLocations
|
|
2098
|
+
}).describe("Administrative area options")
|
|
2099
|
+
}).meta({
|
|
2100
|
+
description: "Administrative area input field",
|
|
2101
|
+
id: "AdministrativeAreaField"
|
|
2102
|
+
});
|
|
2017
2103
|
var LocationInput = BaseField.extend({
|
|
2018
2104
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
2019
2105
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
@@ -2021,7 +2107,10 @@ var LocationInput = BaseField.extend({
|
|
|
2021
2107
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
2022
2108
|
allowedLocations: AllowedLocations
|
|
2023
2109
|
}).optional()
|
|
2024
|
-
}).
|
|
2110
|
+
}).meta({
|
|
2111
|
+
description: "A field for selecting a location",
|
|
2112
|
+
id: "LocationInput"
|
|
2113
|
+
});
|
|
2025
2114
|
var FileUploadWithOptions = BaseField.extend({
|
|
2026
2115
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
2027
2116
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
@@ -2035,6 +2124,9 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
2035
2124
|
}).default({
|
|
2036
2125
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2037
2126
|
})
|
|
2127
|
+
}).meta({
|
|
2128
|
+
description: "A field for uploading files with file type options",
|
|
2129
|
+
id: "FileUploadWithOptions"
|
|
2038
2130
|
});
|
|
2039
2131
|
var Facility = BaseField.extend({
|
|
2040
2132
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
@@ -2080,7 +2172,10 @@ var Address = BaseField.extend({
|
|
|
2080
2172
|
allowedLocations: AllowedLocations
|
|
2081
2173
|
}).optional(),
|
|
2082
2174
|
defaultValue: DefaultAddressFieldValue.optional()
|
|
2083
|
-
}).
|
|
2175
|
+
}).meta({
|
|
2176
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
2177
|
+
id: "Address"
|
|
2178
|
+
});
|
|
2084
2179
|
var StaticDataEntry = import_v43.default.object({
|
|
2085
2180
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
2086
2181
|
label: TranslationConfig,
|
|
@@ -2095,7 +2190,10 @@ var DataField = BaseField.extend({
|
|
|
2095
2190
|
subtitle: TranslationConfig.optional(),
|
|
2096
2191
|
data: import_v43.default.array(DataEntry)
|
|
2097
2192
|
})
|
|
2098
|
-
}).
|
|
2193
|
+
}).meta({
|
|
2194
|
+
description: "A field for displaying a table of read-only data",
|
|
2195
|
+
id: "DataField"
|
|
2196
|
+
});
|
|
2099
2197
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
2100
2198
|
var ButtonType = import_v43.default.enum([
|
|
2101
2199
|
"primary",
|
|
@@ -2122,11 +2220,17 @@ var ButtonField = BaseField.extend({
|
|
|
2122
2220
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
2123
2221
|
defaultValue: ButtonFieldValue.optional(),
|
|
2124
2222
|
configuration: ButtonConfiguration
|
|
2125
|
-
}).
|
|
2223
|
+
}).meta({
|
|
2224
|
+
description: "A generic button that can be used to trigger an action",
|
|
2225
|
+
id: "ButtonField"
|
|
2226
|
+
});
|
|
2126
2227
|
var FieldGroup = BaseField.extend({
|
|
2127
2228
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
2128
2229
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
2129
2230
|
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
|
|
2231
|
+
}).meta({
|
|
2232
|
+
description: "A group of fields that are displayed together",
|
|
2233
|
+
id: "FieldGroup"
|
|
2130
2234
|
});
|
|
2131
2235
|
var AlphaPrintButton = BaseField.extend({
|
|
2132
2236
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -2136,7 +2240,10 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
2136
2240
|
"Label for the print button"
|
|
2137
2241
|
)
|
|
2138
2242
|
})
|
|
2139
|
-
}).
|
|
2243
|
+
}).meta({
|
|
2244
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
2245
|
+
id: "AlphaPrintButton"
|
|
2246
|
+
});
|
|
2140
2247
|
var HttpField = BaseField.extend({
|
|
2141
2248
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
2142
2249
|
defaultValue: HttpFieldValue.optional(),
|
|
@@ -2152,20 +2259,30 @@ var HttpField = BaseField.extend({
|
|
|
2152
2259
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
2153
2260
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
2154
2261
|
})
|
|
2155
|
-
}).
|
|
2262
|
+
}).meta({
|
|
2263
|
+
description: "Makes a background HTTP request to an external service and stores the response so other fields can use it. Has no visible UI \u2014 pair with LOADER to show request status.",
|
|
2264
|
+
id: "HttpField"
|
|
2265
|
+
});
|
|
2156
2266
|
var AutocompleteField = BaseField.extend({
|
|
2157
2267
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
2158
2268
|
configuration: import_v43.default.object({
|
|
2159
|
-
url: import_v43.default.string().describe(
|
|
2269
|
+
url: import_v43.default.string().describe(
|
|
2270
|
+
"URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
|
|
2271
|
+
).optional(),
|
|
2160
2272
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
2161
2273
|
defaultOptions: import_v43.default.array(
|
|
2162
2274
|
import_v43.default.object({
|
|
2163
2275
|
label: import_v43.default.string(),
|
|
2164
2276
|
value: import_v43.default.string()
|
|
2165
2277
|
})
|
|
2166
|
-
).optional()
|
|
2278
|
+
).optional().describe(
|
|
2279
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2280
|
+
)
|
|
2167
2281
|
})
|
|
2168
|
-
}).
|
|
2282
|
+
}).meta({
|
|
2283
|
+
description: "Generic autocomplete component designed for use with large dictionary-based datasets. The component supports dynamic retrieval of options from configurable data sources and is intended for datasets that may contain tens or hundreds of thousands of records.",
|
|
2284
|
+
id: "AutocompleteField"
|
|
2285
|
+
});
|
|
2169
2286
|
var SearchField = HttpField.extend({
|
|
2170
2287
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
2171
2288
|
configuration: SearchQuery.pick({
|
|
@@ -2198,6 +2315,9 @@ var SearchField = HttpField.extend({
|
|
|
2198
2315
|
ok: TranslationConfig.optional()
|
|
2199
2316
|
}).optional()
|
|
2200
2317
|
})
|
|
2318
|
+
}).meta({
|
|
2319
|
+
description: "A search input field",
|
|
2320
|
+
id: "SearchField"
|
|
2201
2321
|
});
|
|
2202
2322
|
var LinkButtonField = BaseField.extend({
|
|
2203
2323
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -2206,7 +2326,10 @@ var LinkButtonField = BaseField.extend({
|
|
|
2206
2326
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
2207
2327
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
2208
2328
|
})
|
|
2209
|
-
}).
|
|
2329
|
+
}).meta({
|
|
2330
|
+
description: "A button that opens a URL link",
|
|
2331
|
+
id: "LinkButtonField"
|
|
2332
|
+
});
|
|
2210
2333
|
var VerificationStatus = BaseField.extend({
|
|
2211
2334
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
2212
2335
|
defaultValue: VerificationStatusValue.optional(),
|
|
@@ -2216,15 +2339,19 @@ var VerificationStatus = BaseField.extend({
|
|
|
2216
2339
|
"Explaining text on the banner in form."
|
|
2217
2340
|
)
|
|
2218
2341
|
})
|
|
2342
|
+
}).meta({
|
|
2343
|
+
description: "Displays a verification state (e.g. ID verified / pending). Often paired with ID_READER \u2014 it can read its value off an ID_READER rather than holding its own.",
|
|
2344
|
+
id: "VerificationStatus"
|
|
2219
2345
|
});
|
|
2220
2346
|
var QueryParamReaderField = BaseField.extend({
|
|
2221
2347
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
2222
2348
|
configuration: import_v43.default.object({
|
|
2223
2349
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
2224
2350
|
})
|
|
2225
|
-
}).
|
|
2226
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
2227
|
-
|
|
2351
|
+
}).meta({
|
|
2352
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2353
|
+
id: "QueryParamReaderField"
|
|
2354
|
+
});
|
|
2228
2355
|
var QrReaderField = BaseField.extend({
|
|
2229
2356
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
2230
2357
|
defaultValue: QrReaderFieldValue.optional(),
|
|
@@ -2235,7 +2362,7 @@ var QrReaderField = BaseField.extend({
|
|
|
2235
2362
|
})
|
|
2236
2363
|
}).optional()
|
|
2237
2364
|
}).meta({
|
|
2238
|
-
description: "
|
|
2365
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
2239
2366
|
id: "QrReaderField"
|
|
2240
2367
|
});
|
|
2241
2368
|
var IdReaderField = BaseField.extend({
|
|
@@ -2244,12 +2371,18 @@ var IdReaderField = BaseField.extend({
|
|
|
2244
2371
|
methods: import_v43.default.array(
|
|
2245
2372
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
2246
2373
|
)
|
|
2374
|
+
}).meta({
|
|
2375
|
+
description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
|
|
2376
|
+
id: "IdReaderField"
|
|
2247
2377
|
});
|
|
2248
2378
|
var CustomField = BaseField.extend({
|
|
2249
2379
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
2250
2380
|
defaultValue: CustomFieldValue.optional(),
|
|
2251
2381
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
2252
2382
|
configuration: import_v43.default.unknown().optional()
|
|
2383
|
+
}).meta({
|
|
2384
|
+
description: "An expiremental custom field that is defined by a module source path",
|
|
2385
|
+
id: "CustomField"
|
|
2253
2386
|
});
|
|
2254
2387
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2255
2388
|
var LoaderField = BaseField.extend({
|
|
@@ -2259,22 +2392,25 @@ var LoaderField = BaseField.extend({
|
|
|
2259
2392
|
configuration: import_v43.default.object({
|
|
2260
2393
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2261
2394
|
})
|
|
2262
|
-
}).
|
|
2263
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2264
|
-
|
|
2395
|
+
}).meta({
|
|
2396
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2397
|
+
id: "LoaderField"
|
|
2398
|
+
});
|
|
2265
2399
|
var HiddenField = BaseField.extend({
|
|
2266
2400
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2267
2401
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2268
2402
|
defaultValue: TextValue.optional()
|
|
2269
|
-
}).
|
|
2270
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2271
|
-
|
|
2403
|
+
}).meta({
|
|
2404
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2405
|
+
id: "HiddenField"
|
|
2406
|
+
});
|
|
2272
2407
|
var UserRoleField = BaseField.extend({
|
|
2273
2408
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2274
2409
|
defaultValue: TextValue.optional()
|
|
2275
|
-
}).
|
|
2276
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2277
|
-
|
|
2410
|
+
}).meta({
|
|
2411
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2412
|
+
id: "UserRoleField"
|
|
2413
|
+
});
|
|
2278
2414
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2279
2415
|
FieldGroup,
|
|
2280
2416
|
Address,
|
|
@@ -2374,15 +2510,18 @@ var VerificationPageConfig = FormPageConfig.extend({
|
|
|
2374
2510
|
actions: VerificationActionConfig
|
|
2375
2511
|
});
|
|
2376
2512
|
var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
|
|
2377
|
-
|
|
2378
|
-
|
|
2513
|
+
id: "PageConfig",
|
|
2514
|
+
description: "Configuration for a single page in a form. Either a form page with fields and a continue button, or a verification page with verify/cancel options."
|
|
2379
2515
|
});
|
|
2380
2516
|
|
|
2381
2517
|
// ../commons/src/events/FormConfig.ts
|
|
2382
2518
|
var DeclarationFormConfig = z22.object({
|
|
2383
2519
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2384
2520
|
pages: z22.array(FormPageConfig)
|
|
2385
|
-
}).
|
|
2521
|
+
}).meta({
|
|
2522
|
+
id: "DeclarationFormConfig",
|
|
2523
|
+
description: "Configuration of the declaration form."
|
|
2524
|
+
});
|
|
2386
2525
|
var ActionFormConfig = z22.object({
|
|
2387
2526
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2388
2527
|
pages: z22.array(PageConfig)
|
|
@@ -2482,6 +2621,9 @@ var DeduplicationConfig = z23.object({
|
|
|
2482
2621
|
id: z23.string(),
|
|
2483
2622
|
label: TranslationConfig,
|
|
2484
2623
|
query: Clause
|
|
2624
|
+
}).meta({
|
|
2625
|
+
id: "DeduplicationConfig",
|
|
2626
|
+
description: "Configuration for duplicate detection on a declare or register action. The query is built from fuzzy / strict / date-range matchers combined with and/or/not."
|
|
2485
2627
|
});
|
|
2486
2628
|
|
|
2487
2629
|
// ../commons/src/events/ActionConfig.ts
|
|
@@ -2599,17 +2741,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
|
|
|
2599
2741
|
* OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
|
|
2600
2742
|
* and treat them as "models" instead of duplicating the data structure in each endpoint.
|
|
2601
2743
|
*/
|
|
2602
|
-
ReadActionConfig.meta({
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2744
|
+
ReadActionConfig.meta({
|
|
2745
|
+
id: "ReadActionConfig",
|
|
2746
|
+
description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
|
|
2747
|
+
}),
|
|
2748
|
+
DeclareConfig.meta({
|
|
2749
|
+
id: "DeclareActionConfig",
|
|
2750
|
+
description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
|
|
2751
|
+
}),
|
|
2752
|
+
RejectConfig.meta({
|
|
2753
|
+
id: "RejectActionConfig",
|
|
2754
|
+
description: "Configuration for rejecting a record before registration."
|
|
2755
|
+
}),
|
|
2756
|
+
RegisterConfig.meta({
|
|
2757
|
+
id: "RegisterActionConfig",
|
|
2758
|
+
description: "Configuration for registering a record."
|
|
2759
|
+
}),
|
|
2606
2760
|
PrintCertificateActionConfig.meta({
|
|
2607
|
-
id: "PrintCertificateActionConfig"
|
|
2761
|
+
id: "PrintCertificateActionConfig",
|
|
2762
|
+
description: "Configuration for printing a certificate of a registered record."
|
|
2763
|
+
}),
|
|
2764
|
+
RequestCorrectionConfig.meta({
|
|
2765
|
+
id: "RequestCorrectionActionConfig",
|
|
2766
|
+
description: "Configuration for requesting a correction on a registered record."
|
|
2767
|
+
}),
|
|
2768
|
+
EditActionConfig.meta({
|
|
2769
|
+
id: "EditActionConfig",
|
|
2770
|
+
description: "Configuration for editing a record before registration."
|
|
2771
|
+
}),
|
|
2772
|
+
ArchiveConfig.meta({
|
|
2773
|
+
id: "ArchiveActionConfig",
|
|
2774
|
+
description: "Configuration for archiving a record."
|
|
2608
2775
|
}),
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
|
|
2776
|
+
CustomActionConfig.meta({
|
|
2777
|
+
id: "CustomActionConfig",
|
|
2778
|
+
description: "Configuration for a country-defined custom action. An event may include any number of these."
|
|
2779
|
+
})
|
|
2613
2780
|
]).describe(
|
|
2614
2781
|
"Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
|
|
2615
2782
|
).meta({ id: "ActionConfig" });
|
|
@@ -2685,7 +2852,10 @@ var Field = BaseField2.extend({
|
|
|
2685
2852
|
}).describe("Custom field defined for the summary view.");
|
|
2686
2853
|
var SummaryConfig = z27.object({
|
|
2687
2854
|
fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
|
|
2688
|
-
}).
|
|
2855
|
+
}).meta({
|
|
2856
|
+
id: "SummaryConfig",
|
|
2857
|
+
description: "Configuration of the event overview page. Defines which declaration fields appear in the record summary, optionally with custom labels, empty-value messages, and templated values."
|
|
2858
|
+
});
|
|
2689
2859
|
|
|
2690
2860
|
// ../commons/src/events/AdvancedSearchConfig.ts
|
|
2691
2861
|
var z28 = __toESM(require("zod/v4"));
|
|
@@ -2809,6 +2979,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
|
|
|
2809
2979
|
var AdvancedSearchConfig = z28.object({
|
|
2810
2980
|
title: TranslationConfig.describe("Advanced search tab title"),
|
|
2811
2981
|
fields: z28.array(AdvancedSearchField).describe("Advanced search fields within the tab.")
|
|
2982
|
+
}).meta({
|
|
2983
|
+
id: "AdvancedSearchConfig",
|
|
2984
|
+
description: "Configuration of one advanced search tab. Each tab has a title and a list of searchable fields \u2014 either declaration fields (via `field()`) or event metadata (via `event()`)."
|
|
2812
2985
|
});
|
|
2813
2986
|
|
|
2814
2987
|
// ../commons/src/events/utils.ts
|
|
@@ -3701,8 +3874,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
|
|
|
3701
3874
|
validateActionFlags(event2, ctx);
|
|
3702
3875
|
validateActionOrder(event2, ctx);
|
|
3703
3876
|
}).meta({
|
|
3704
|
-
id: "EventConfig"
|
|
3705
|
-
|
|
3877
|
+
id: "EventConfig",
|
|
3878
|
+
description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
|
|
3879
|
+
});
|
|
3706
3880
|
|
|
3707
3881
|
// ../commons/src/events/EventConfigInput.ts
|
|
3708
3882
|
var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
|
|
@@ -3924,6 +4098,9 @@ var WorkqueueColumnValue = z34.object({
|
|
|
3924
4098
|
var WorkqueueColumn = z34.object({
|
|
3925
4099
|
label: TranslationConfig,
|
|
3926
4100
|
value: WorkqueueColumnValue
|
|
4101
|
+
}).meta({
|
|
4102
|
+
id: "WorkqueueColumn",
|
|
4103
|
+
description: "Configuration for a single workqueue column. The value references an event metadata key (e.g. `dateOfEvent`, `status`, `trackingId`)."
|
|
3927
4104
|
});
|
|
3928
4105
|
function defineWorkqueuesColumns(workqueueColumns) {
|
|
3929
4106
|
return workqueueColumns.map(
|
|
@@ -4129,8 +4306,8 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
|
|
|
4129
4306
|
var WorkqueueConfigInput = WorkqueueConfig.extend({
|
|
4130
4307
|
query: CountryConfigQueryInputType
|
|
4131
4308
|
}).meta({
|
|
4132
|
-
|
|
4133
|
-
|
|
4309
|
+
id: "WorkqueueConfig",
|
|
4310
|
+
description: "Configuration for a single workqueue. Defines the filter applied to the event index, the quick-action button, the columns shown on each row, and the message rendered when the queue is empty."
|
|
4134
4311
|
});
|
|
4135
4312
|
var WorkqueueCountInput = z37.array(
|
|
4136
4313
|
z37.object({ slug: z37.string(), query: QueryType })
|
|
@@ -4172,7 +4349,9 @@ var BaseActionInput = z38.object({
|
|
|
4172
4349
|
keepAssignment: z38.boolean().optional(),
|
|
4173
4350
|
keepAssignmentIfAccepted: z38.boolean().optional(),
|
|
4174
4351
|
keepAssignmentIfRejected: z38.boolean().optional(),
|
|
4175
|
-
waitFor: z38.boolean().
|
|
4352
|
+
waitFor: z38.boolean().default(true).describe(
|
|
4353
|
+
"Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care."
|
|
4354
|
+
),
|
|
4176
4355
|
// For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
|
|
4177
4356
|
// @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
|
|
4178
4357
|
createdAtLocation: UUID.nullish().describe(
|
|
@@ -4352,7 +4531,7 @@ var Draft = z39.object({
|
|
|
4352
4531
|
}).describe(
|
|
4353
4532
|
"A temporary storage for an action. Stored with details of the event, creator and creation time."
|
|
4354
4533
|
);
|
|
4355
|
-
var DraftInput = BaseActionInput.extend({
|
|
4534
|
+
var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
|
|
4356
4535
|
type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
|
|
4357
4536
|
status: z39.enum([
|
|
4358
4537
|
ActionStatus.Requested,
|