@opencrvs/toolkit 1.9.2-rc.f1d7235 → 1.9.2-rc.f5e3efd

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/commons/api/router.d.ts +220 -482
  2. package/dist/commons/events/ActionConfig.d.ts +13 -390
  3. package/dist/commons/events/ActionDocument.d.ts +44 -0
  4. package/dist/commons/events/ActionInput.d.ts +20 -0
  5. package/dist/commons/events/ActionType.d.ts +7 -1
  6. package/dist/commons/events/AdvancedSearchConfig.d.ts +0 -6
  7. package/dist/commons/events/CountryConfigQueryInput.d.ts +12 -0
  8. package/dist/commons/events/Draft.d.ts +2 -0
  9. package/dist/commons/events/EventConfig.d.ts +8 -318
  10. package/dist/commons/events/EventDocument.d.ts +22 -0
  11. package/dist/commons/events/EventIndex.d.ts +5 -1
  12. package/dist/commons/events/EventMetadata.d.ts +2 -3
  13. package/dist/commons/events/FieldConfig.d.ts +0 -80
  14. package/dist/commons/events/FieldType.d.ts +1 -2
  15. package/dist/commons/events/FieldTypeMapping.d.ts +1 -8
  16. package/dist/commons/events/FieldValue.d.ts +1 -2
  17. package/dist/commons/events/Flag.d.ts +3 -0
  18. package/dist/commons/events/FormConfig.d.ts +0 -234
  19. package/dist/commons/events/PageConfig.d.ts +0 -156
  20. package/dist/commons/events/WorkqueueColumnConfig.d.ts +2 -5
  21. package/dist/commons/events/WorkqueueConfig.d.ts +19 -7
  22. package/dist/commons/events/defineConfig.d.ts +2 -446
  23. package/dist/commons/events/scopes.d.ts +1 -0
  24. package/dist/commons/events/state/index.d.ts +0 -6
  25. package/dist/commons/events/state/utils.d.ts +15 -1
  26. package/dist/commons/events/test.utils.d.ts +9 -1
  27. package/dist/commons/events/utils.d.ts +17 -887
  28. package/dist/events/index.js +73 -115
  29. package/dist/notification/index.js +27 -35
  30. package/dist/scopes/index.d.ts +6 -2
  31. package/dist/scopes/index.js +1 -0
  32. package/package.json +1 -1
@@ -79,6 +79,7 @@ var ActionType = {
79
79
  DECLARE: "DECLARE",
80
80
  VALIDATE: "VALIDATE",
81
81
  REGISTER: "REGISTER",
82
+ EDIT: "EDIT",
82
83
  // Declaration system actions. Non-configurable.
83
84
  DUPLICATE_DETECTED: "DUPLICATE_DETECTED",
84
85
  REJECT: "REJECT",
@@ -101,6 +102,7 @@ var ActionType = {
101
102
  var ConfirmableActions = [
102
103
  ActionType.NOTIFY,
103
104
  ActionType.DECLARE,
105
+ ActionType.EDIT,
104
106
  ActionType.VALIDATE,
105
107
  ActionType.REGISTER,
106
108
  ActionType.REJECT,
@@ -116,6 +118,7 @@ var ActionTypes = z2.enum([
116
118
  "CREATE",
117
119
  "NOTIFY",
118
120
  "DECLARE",
121
+ "EDIT",
119
122
  "VALIDATE",
120
123
  "REGISTER",
121
124
  "DUPLICATE_DETECTED",
@@ -137,6 +140,7 @@ var ClientSpecificAction = {
137
140
  };
138
141
  var declarationActionValues = [
139
142
  ActionTypes.enum.DECLARE,
143
+ ActionTypes.enum.EDIT,
140
144
  ActionTypes.enum.VALIDATE,
141
145
  ActionTypes.enum.REGISTER,
142
146
  ActionTypes.enum.NOTIFY,
@@ -266,8 +270,7 @@ var FieldType = {
266
270
  QUERY_PARAM_READER: "QUERY_PARAM_READER",
267
271
  QR_READER: "QR_READER",
268
272
  ID_READER: "ID_READER",
269
- LOADER: "LOADER",
270
- HIDDEN: "HIDDEN"
273
+ LOADER: "LOADER"
271
274
  };
272
275
  var FileFieldType = z4.enum([
273
276
  FieldType.FILE,
@@ -397,7 +400,6 @@ var IdReaderFieldValue = ReadDataValue;
397
400
 
398
401
  // ../commons/src/events/FieldValue.ts
399
402
  var TextValue = z7.string();
400
- var HiddenFieldValue = z7.string();
401
403
  var NonEmptyTextValue = TextValue.min(1);
402
404
  var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
403
405
  var AgeValue = z7.object({
@@ -523,8 +525,7 @@ var FieldUpdateValue = safeUnion([
523
525
  DataFieldValue.describe("DataFieldValue"),
524
526
  NameFieldUpdateValue.describe("NameFieldUpdateValue"),
525
527
  HttpFieldUpdateValue.describe("HttpFieldUpdateValue"),
526
- QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue"),
527
- HiddenFieldValue.describe("HiddenFieldValue")
528
+ QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue")
528
529
  ]);
529
530
 
530
531
  // ../commons/src/uuid.ts
@@ -785,6 +786,7 @@ var RecordScopeType = z10.enum([
785
786
  "record.read",
786
787
  "record.declare",
787
788
  "record.notify",
789
+ "record.declared.edit",
788
790
  "record.declared.validate",
789
791
  "record.declared.reject",
790
792
  "record.declared.archive",
@@ -1088,6 +1090,11 @@ var NotifiedAction = ActionBase.extend(
1088
1090
  type: z12.literal(ActionType.NOTIFY)
1089
1091
  }).shape
1090
1092
  );
1093
+ var EditAction = ActionBase.extend(
1094
+ z12.object({
1095
+ type: z12.literal(ActionType.EDIT)
1096
+ }).shape
1097
+ );
1091
1098
  var PrintContent = z12.object({
1092
1099
  templateId: z12.string().optional()
1093
1100
  });
@@ -1146,6 +1153,7 @@ var ActionDocument = z12.discriminatedUnion("type", [
1146
1153
  UnassignedAction.meta({ id: "UnassignedAction" }),
1147
1154
  PrintCertificateAction.meta({ id: "PrintCertificateAction" }),
1148
1155
  ReadAction.meta({ id: "ReadAction" }),
1156
+ EditAction.meta({ id: "EditAction" }),
1149
1157
  CustomAction.meta({ id: "CustomAction" })
1150
1158
  ]).meta({
1151
1159
  id: "ActionDocument"
@@ -1168,7 +1176,8 @@ var InherentFlags = {
1168
1176
  INCOMPLETE: "incomplete",
1169
1177
  REJECTED: "rejected",
1170
1178
  CORRECTION_REQUESTED: "correction-requested",
1171
- POTENTIAL_DUPLICATE: "potential-duplicate"
1179
+ POTENTIAL_DUPLICATE: "potential-duplicate",
1180
+ EDIT_IN_PROGRESS: "edit-in-progress"
1172
1181
  };
1173
1182
  var ActionFlag = z13.string().regex(
1174
1183
  new RegExp(
@@ -1239,7 +1248,6 @@ var EventMetadata = z14.object({
1239
1248
  ),
1240
1249
  createdAt: z14.iso.datetime().describe("The timestamp when the event was first created and saved."),
1241
1250
  dateOfEvent: ZodDate.nullish(),
1242
- placeOfEvent: CreatedAtLocation,
1243
1251
  createdBy: z14.string().describe("ID of the user who created the event."),
1244
1252
  createdByUserType: z14.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1245
1253
  updatedByUserRole: z14.string().describe("Role of the user who last changed the status."),
@@ -1269,7 +1277,6 @@ var EventMetadataKeysArray = [
1269
1277
  "status",
1270
1278
  "createdAt",
1271
1279
  "dateOfEvent",
1272
- "placeOfEvent",
1273
1280
  "createdBy",
1274
1281
  "createdByUserType",
1275
1282
  "updatedByUserRole",
@@ -1963,13 +1970,6 @@ var LoaderField = BaseField.extend({
1963
1970
  }).describe(
1964
1971
  "A non-interactive field that indicates an in progress operation in form"
1965
1972
  );
1966
- var HiddenField = BaseField.extend({
1967
- type: z16.literal(FieldType.HIDDEN),
1968
- required: z16.literal(false).optional()
1969
- // Hidden fields cannot be required
1970
- }).describe(
1971
- "A non-interactive, hidden field that only hold a value in the form"
1972
- );
1973
1973
  var FieldConfig = z16.discriminatedUnion("type", [
1974
1974
  Address,
1975
1975
  TextField,
@@ -2009,8 +2009,7 @@ var FieldConfig = z16.discriminatedUnion("type", [
2009
2009
  IdReaderField,
2010
2010
  QueryParamReaderField,
2011
2011
  LoaderField,
2012
- SearchField,
2013
- HiddenField
2012
+ SearchField
2014
2013
  ]).meta({
2015
2014
  description: "Form field configuration",
2016
2015
  id: "FieldConfig"
@@ -2690,9 +2689,6 @@ var EventConfig = z29.object({
2690
2689
  dateOfEvent: FieldReference.optional().describe(
2691
2690
  "Reference to the field capturing the date of the event (e.g. date of birth). Defaults to the event creation date if unspecified."
2692
2691
  ),
2693
- placeOfEvent: FieldReference.optional().describe(
2694
- "Reference to the field capturing the place of the event (e.g. place of birth). Defaults to the meta.createdAtLocation if unspecified."
2695
- ),
2696
2692
  title: TranslationConfig.describe(
2697
2693
  'Title template for the singular event, supporting variables (e.g. "{applicant.name.firstname} {applicant.name.surname}").'
2698
2694
  ),
@@ -2767,19 +2763,6 @@ var EventConfig = z29.object({
2767
2763
  });
2768
2764
  }
2769
2765
  }
2770
- if (event2.placeOfEvent) {
2771
- const eventPlaceFieldId = getDeclarationFields(event2).find(
2772
- ({ id }) => id === event2.placeOfEvent?.$$field
2773
- );
2774
- if (!eventPlaceFieldId) {
2775
- ctx.addIssue({
2776
- code: "custom",
2777
- message: `Place of event field id must match a field id in the event.declaration fields.
2778
- Invalid place of event field ID for event ${event2.id}: ${event2.placeOfEvent.$$field}`,
2779
- path: ["placeOfEvent"]
2780
- });
2781
- }
2782
- }
2783
2766
  const isInherentFlag = (value) => Object.values(InherentFlags).includes(value);
2784
2767
  const configuredFlagIds = event2.flags.map((flag2) => flag2.id);
2785
2768
  const actionFlagIds = event2.actions.flatMap(
@@ -3715,6 +3698,11 @@ var DeclareActionInput = BaseActionInput.extend(
3715
3698
  type: z33.literal(ActionType.DECLARE).default(ActionType.DECLARE)
3716
3699
  }).shape
3717
3700
  );
3701
+ var EditActionInput = BaseActionInput.extend(
3702
+ z33.object({
3703
+ type: z33.literal(ActionType.EDIT).default(ActionType.EDIT)
3704
+ }).shape
3705
+ );
3718
3706
  var PrintCertificateActionInput = BaseActionInput.extend(
3719
3707
  z33.object({
3720
3708
  type: z33.literal(ActionType.PRINT_CERTIFICATE).default(ActionType.PRINT_CERTIFICATE),
@@ -3826,7 +3814,8 @@ var ActionInput = z33.discriminatedUnion("type", [
3826
3814
  id: "ApproveCorrectionActionInput"
3827
3815
  }),
3828
3816
  ReadActionInput.meta({ id: "ReadActionInput" }),
3829
- CustomActionInput.meta({ id: "CustomActionInput" })
3817
+ CustomActionInput.meta({ id: "CustomActionInput" }),
3818
+ EditActionInput.meta({ id: "EditActionInput" })
3830
3819
  ]).meta({
3831
3820
  id: "ActionInput"
3832
3821
  });
@@ -6085,6 +6074,7 @@ var ACTION_SCOPE_MAP = {
6085
6074
  "record.declared.validate",
6086
6075
  "record.register"
6087
6076
  ],
6077
+ [ActionType.EDIT]: ["record.declared.edit"],
6088
6078
  [ActionType.DELETE]: ["record.declare"],
6089
6079
  [ActionType.VALIDATE]: ["record.declared.validate", "record.register"],
6090
6080
  [ActionType.REGISTER]: ["record.register"],
@@ -6132,7 +6122,8 @@ var AVAILABLE_ACTIONS_BY_EVENT_STATUS = {
6132
6122
  ActionType.MARK_AS_DUPLICATE,
6133
6123
  ActionType.ARCHIVE,
6134
6124
  ActionType.REJECT,
6135
- ActionType.CUSTOM
6125
+ ActionType.CUSTOM,
6126
+ ActionType.EDIT
6136
6127
  ],
6137
6128
  [EventStatus.enum.REGISTERED]: [
6138
6129
  ActionType.READ,
@@ -6158,6 +6149,7 @@ var ACTION_FILTERS = {
6158
6149
  [ActionType.REJECT_CORRECTION]: (flags) => flags.includes(InherentFlags.CORRECTION_REQUESTED) && !flags.some((flag2) => flag2.endsWith(":requested")),
6159
6150
  [ActionType.MARK_AS_DUPLICATE]: (flags) => flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
6160
6151
  [ActionType.VALIDATE]: (flags) => !flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
6152
+ [ActionType.EDIT]: (flags) => !flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
6161
6153
  [ActionType.REGISTER]: (flags) => !flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
6162
6154
  [ActionType.REJECT]: (flags) => !flags.includes(InherentFlags.REJECTED) && !flags.some((flag2) => flag2.endsWith(":requested")),
6163
6155
  [ActionType.ARCHIVE]: (flags) => !flags.some((flag2) => flag2.endsWith(":requested"))
@@ -82,6 +82,7 @@ export declare const RecordScopeType: z.ZodEnum<{
82
82
  "record.create": "record.create";
83
83
  "record.declare": "record.declare";
84
84
  "record.notify": "record.notify";
85
+ "record.declared.edit": "record.declared.edit";
85
86
  "record.declared.validate": "record.declared.validate";
86
87
  "record.declared.reject": "record.declared.reject";
87
88
  "record.declared.archive": "record.declared.archive";
@@ -99,6 +100,7 @@ export declare const RecordScope: z.ZodObject<{
99
100
  "record.create": "record.create";
100
101
  "record.declare": "record.declare";
101
102
  "record.notify": "record.notify";
103
+ "record.declared.edit": "record.declared.edit";
102
104
  "record.declared.validate": "record.declared.validate";
103
105
  "record.declared.reject": "record.declared.reject";
104
106
  "record.declared.archive": "record.declared.archive";
@@ -152,6 +154,7 @@ declare const ConfigurableRawScopes: z.ZodDiscriminatedUnion<[z.ZodObject<{
152
154
  "record.create": "record.create";
153
155
  "record.declare": "record.declare";
154
156
  "record.notify": "record.notify";
157
+ "record.declared.edit": "record.declared.edit";
155
158
  "record.declared.validate": "record.declared.validate";
156
159
  "record.declared.reject": "record.declared.reject";
157
160
  "record.declared.archive": "record.declared.archive";
@@ -178,6 +181,7 @@ export declare const ConfigurableActionScopes: z.ZodDiscriminatedUnion<[z.ZodObj
178
181
  "record.create": "record.create";
179
182
  "record.declare": "record.declare";
180
183
  "record.notify": "record.notify";
184
+ "record.declared.edit": "record.declared.edit";
181
185
  "record.declared.validate": "record.declared.validate";
182
186
  "record.declared.reject": "record.declared.reject";
183
187
  "record.declared.archive": "record.declared.archive";
@@ -227,7 +231,7 @@ export declare function findScope<T extends ConfigurableScopeType>(scopes: strin
227
231
  }, {
228
232
  type: T;
229
233
  }> | Extract<{
230
- type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
234
+ type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.edit" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
231
235
  options: {
232
236
  event: string[];
233
237
  };
@@ -274,7 +278,7 @@ export declare function parseConfigurableScope(scope: string): {
274
278
  id: string[];
275
279
  };
276
280
  } | {
277
- type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
281
+ type: "record.unassign-others" | "record.register" | "record.read" | "record.create" | "record.declare" | "record.notify" | "record.declared.edit" | "record.declared.validate" | "record.declared.reject" | "record.declared.archive" | "record.declared.review-duplicates" | "record.registered.print-certified-copies" | "record.registered.request-correction" | "record.registered.correct";
278
282
  options: {
279
283
  event: string[];
280
284
  };
@@ -251,6 +251,7 @@ var RecordScopeType = z.enum([
251
251
  "record.read",
252
252
  "record.declare",
253
253
  "record.notify",
254
+ "record.declared.edit",
254
255
  "record.declared.validate",
255
256
  "record.declared.reject",
256
257
  "record.declared.archive",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "1.9.2-rc.f1d7235",
3
+ "version": "1.9.2-rc.f5e3efd",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
6
  "exports": {