@opencrvs/toolkit 2.0.0-rc.fef9d21 → 2.0.0-rc.ff04b30

package/dist/events/index.js

@@ -243,6 +243,8 @@ __export(events_exports, {
   areConditionsMet: () => areConditionsMet,
   buildFormState: () => buildFormState,
   canAccessEventWithScope: () => canAccessEventWithScope,
+  canAccessOtherUserWithScopes: () => canAccessOtherUserWithScopes,
+  canAccessUserWithScope: () => canAccessUserWithScope,
   compositeFieldTypes: () => compositeFieldTypes,
   createEmptyDraft: () => createEmptyDraft,
   createFieldConditionals: () => createFieldConditionals,
@@ -300,12 +302,13 @@ __export(events_exports, {
   getActionConfig: () => getActionConfig,
   getActionReview: () => getActionReview,
   getActionReviewFields: () => getActionReviewFields,
+  getAdministrativeAreaHierarchy: () => getAdministrativeAreaHierarchy,
   getAllUniqueFields: () => getAllUniqueFields,
   getAnnotationFromDrafts: () => getAnnotationFromDrafts,
   getAssignedUserFromActions: () => getAssignedUserFromActions,
-  getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
   getAssignmentStatus: () => getAssignmentStatus,
   getAvailableActionsForEvent: () => getAvailableActionsForEvent,
+  getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
   getCompleteActionAnnotation: () => getCompleteActionAnnotation,
   getCompleteActionDeclaration: () => getCompleteActionDeclaration,
   getCurrentEventState: () => getCurrentEventState,
@@ -316,6 +319,7 @@ __export(events_exports, {
   getDeclarationPages: () => getDeclarationPages,
   getEventConfigById: () => getEventConfigById,
   getFilePathsFromEvent: () => getFilePathsFromEvent,
+  getLocationHierarchy: () => getLocationHierarchy,
   getMixedPath: () => getMixedPath,
   getPendingAction: () => getPendingAction,
   getPrintCertificatePages: () => getPrintCertificatePages,
@@ -489,6 +493,10 @@ var scopeByEvent = z2.preprocess(
   (val) => val === void 0 ? void 0 : [val].flat(),
   z2.array(z2.string()).optional()
 ).describe("Event type, e.g. birth, death");
+var userRole = z2.preprocess(
+  (val) => val === void 0 ? void 0 : [val].flat(),
+  z2.array(z2.string()).optional()
+).describe("User role, e.g. admin, field agent");
 var scopeOptionsPlaceEvent = z2.object({
   event: scopeByEvent,
   placeOfEvent: JurisdictionFilter.optional()
@@ -512,6 +520,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
 var AccessLevelOptions = z2.object({
   accessLevel: JurisdictionFilter.optional()
 });
+var AllUserScopeOptions = AccessLevelOptions.extend({
+  role: userRole.optional()
+});
 var WorkqueueOrDashboardOptions = z2.object({
   ids: z2.preprocess(
     (val) => val === void 0 ? void 0 : [val].flat(),
@@ -521,6 +532,7 @@ var WorkqueueOrDashboardOptions = z2.object({
 var AllScopeOptions = z2.object({
   ...AllRecordScopeOptions.shape,
   ...AccessLevelOptions.shape,
+  ...AllUserScopeOptions.shape,
   ...WorkqueueOrDashboardOptions.shape
 });
 var ScopeOptionKey = AllScopeOptions.keyof();
@@ -593,6 +605,33 @@ var RecordScopeV2 = z2.discriminatedUnion("type", [
 ]).describe(
   "Scopes used to check user's permission to perform actions on a record."
 );
+var SystemScopeType = z2.enum([
+  "organisation.read-locations",
+  "user.read",
+  "user.create",
+  "user.edit",
+  "user.search"
+]);
+var UserScopeType = SystemScopeType.extract([
+  "user.read",
+  "user.create",
+  "user.edit",
+  "user.search"
+]);
+var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
+var UserScopeV2 = z2.discriminatedUnion("type", [
+  z2.object({
+    type: ScopesWithRoleOption,
+    options: AllUserScopeOptions.optional()
+  }),
+  z2.object({
+    type: UserScopeType.extract(["user.read", "user.search"]),
+    options: AccessLevelOptions.optional()
+  })
+]);
+function scopeUsesRoleOptions(scope) {
+  return ScopesWithRoleOption?.options.some((opt) => opt === scope.type);
+}
 function scopeUsesDeclaredOptions(scope) {
   return !ScopesWithPlaceEventOptions.options.some((opt) => opt === scope.type);
 }
@@ -625,16 +664,14 @@ var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
     }).optional()
   })
 ]).describe("Resolved scope with location/user IDs instead of filters.");
-var SystemScopeType = z2.enum([
-  "organisation.read-locations",
-  "user.read",
-  "user.create",
-  "user.edit"
-]);
 var Scope = z2.discriminatedUnion("type", [
   z2.object({ type: PlainScopeType }),
   ...RecordScopeV2.options,
-  z2.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
+  ...UserScopeV2.options,
+  z2.object({
+    type: z2.literal("organisation.read-locations"),
+    options: AccessLevelOptions.optional()
+  }),
   z2.object({
     type: z2.literal("workqueue"),
     options: WorkqueueOrDashboardOptions
@@ -667,7 +704,9 @@ var decodeScope = (query) => {
 };
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,
-  accessLevel: JurisdictionFilter.enum.all
+  accessLevel: JurisdictionFilter.enum.all,
+  registeredIn: JurisdictionFilter.enum.all,
+  declaredIn: JurisdictionFilter.enum.all
 };
 function getAcceptedScopesByType({
   acceptedScopes,
@@ -1040,7 +1079,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
   ShowConditional,
   // Action can be shown to the user in the list but as disabled
   EnableConditional
-]);
+]).meta({
+  description: "Action conditional configuration",
+  id: "ActionConditional"
+});
 var DisplayOnReviewConditional = z7.object({
   type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
   conditional: Conditional
@@ -1376,28 +1418,20 @@ function schemaPriority(schema) {
   return idx === -1 ? 9999 : idx;
 }
 function safeUnion(schemas) {
+  const sortedSchemas = [...schemas].sort(
+    (a, b) => schemaPriority(a) - schemaPriority(b)
+  );
   return z12.any().superRefine((val, ctx) => {
-    const successful = schemas.filter((s) => s.safeParse(val).success);
-    if (successful.length === 1) {
-      return;
-    }
-    if (successful.length === 0) {
-      ctx.addIssue({
-        code: "invalid_type",
-        expected: "custom",
-        message: "Value does not match any schema"
-      });
-      return;
-    }
-    successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
-    const best = successful[0];
-    if (!best.safeParse(val).success) {
-      ctx.addIssue({
-        expected: "custom",
-        code: "invalid_type",
-        message: "Value did not match the best schema"
-      });
+    for (const schema of sortedSchemas) {
+      if (schema.safeParse(val).success) {
+        return;
+      }
     }
+    ctx.addIssue({
+      code: "invalid_type",
+      expected: "custom",
+      message: "Value does not match any schema"
+    });
   }).meta({
     description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
   });
@@ -1707,6 +1741,9 @@ var FlagConfig = z15.object({
     "Indicates if this flag expects an action to be performed to be cleared."
   ),
   label: TranslationConfig.describe("Human readable label of the flag.")
+}).meta({
+  description: "Flag configuration",
+  id: "FlagConfig"
 });
 var ActionFlagConfig = z15.object({
   id: Flag,
@@ -1714,6 +1751,9 @@ var ActionFlagConfig = z15.object({
   conditional: Conditional.optional().describe(
     "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
   )
+}).meta({
+  description: "Action flag configuration",
+  id: "ActionFlagConfig"
 });
 
 // ../commons/src/events/EventMetadata.ts
@@ -1735,8 +1775,7 @@ var ActionCreationMetadata = z16.object({
   ),
   createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
   acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
-  createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation."),
-  createdBySignature: z16.string().nullish().describe("Signature of the user who created the action request.")
+  createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
 });
 var RegistrationCreationMetadata = ActionCreationMetadata.extend({
   registrationNumber: z16.string().describe(
@@ -1764,9 +1803,6 @@ var EventMetadata = z16.object({
   createdAtLocation: UUID.nullish().describe(
     "Location of the user who created the event."
   ),
-  createdBySignature: DocumentPath.nullish().describe(
-    "Signature of the user who created the event."
-  ),
   updatedAtLocation: UUID.nullish().describe(
     "Location of the user who last changed the status."
   ),
@@ -2141,7 +2177,7 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
   }
 }).describe("Unique identifier for the field");
 var FieldReference = import_v43.default.object({
-  $$field: FieldId,
+  $$field: FieldId.describe("Id of the field to reference"),
   $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
     'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
   )
@@ -2854,10 +2890,10 @@ var VerificationPageConfig = FormPageConfig.extend({
   type: z21.literal(PageTypes.enum.VERIFICATION),
   actions: VerificationActionConfig
 });
-var PageConfig = z21.discriminatedUnion("type", [
-  FormPageConfig,
-  VerificationPageConfig
-]);
+var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
+  description: "Page configuration",
+  id: "PageConfig"
+});
 
 // ../commons/src/events/FormConfig.ts
 var DeclarationFormConfig = z22.object({
@@ -3766,6 +3802,9 @@ function precompileActionSchemas(eventConfigurations) {
 function isAgeValue(value) {
   return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
 }
+function mergeWithBaseFormState(values, context) {
+  return { ...context.baseFormState, ...values };
+}
 function validate(schema, data) {
   const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
   if ("$form" in data) {
@@ -3804,7 +3843,7 @@ function isOnline() {
 }
 function isConditionMet(conditional, values, context, eventIndex) {
   return validate(conditional, {
-    $form: values,
+    $form: mergeWithBaseFormState(values, context),
     $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
     $online: isOnline(),
     $user: context.user,
@@ -3833,7 +3872,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
     return true;
   }
   const validConditionals = getConditionalActionsForField(field3, {
-    $form: form,
+    $form: mergeWithBaseFormState(form, context),
     $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
     $online: isOnline(),
     $user: context.user,
@@ -4025,7 +4064,7 @@ function runFieldValidations({
     return [];
   }
   const conditionalParameters = {
-    $form: form,
+    $form: mergeWithBaseFormState(form, context),
     $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
     /**
      * In real use cases, there can be hundreds of thousands of locations.
@@ -4269,17 +4308,16 @@ function isPageVisible(page, formValues, context) {
   }
   return isConditionMet(page.conditional, formValues, context);
 }
-function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false, declarationContext) {
+function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
   const base = (0, import_lodash.cloneDeep)(formValues);
   function fn(prevVisibilityContext) {
-    const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
     const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
       const fieldConfig = fields.filter((f) => f.id === fieldId);
       if (!fieldConfig.length) {
         return false;
       }
       const isHidden = fieldConfig.every(
-        (f) => !isFieldVisible(f, visibilityForm, validatorContext)
+        (f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
       );
       if (!isHidden) {
         return false;
@@ -4297,7 +4335,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
   const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
   const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
   const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
-    return hiddenFields.some((f) => f.id === fieldId);
+    return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
   });
   return omitHiddenFields(
     visibleFields,
@@ -4344,13 +4382,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
 }
 function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
   const annotationFields = getActionAnnotationFields(actionConfig);
-  return omitHiddenFields(
-    annotationFields,
-    annotation,
-    context,
-    false,
-    declaration
-  );
+  return omitHiddenFields(annotationFields, annotation, {
+    ...context,
+    baseFormState: declaration
+  });
 }
 function deepMerge(currentDocument, actionDocument) {
   const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
@@ -5339,7 +5374,7 @@ var _EventConfigBase = z33.object({
   ),
   label: TranslationConfig.describe("Human-readable label for the event type."),
   actions: z33.array(ActionConfig).describe(
-    "Configuration of system-defined actions associated with the event."
+    "Configuration of core and custom actions associated with the event."
   ),
   actionOrder: z33.array(z33.string()).optional().describe(
     "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -5351,7 +5386,7 @@ var _EventConfigBase = z33.object({
     "Configuration of fields available in the advanced search feature."
   ),
   flags: z33.array(FlagConfig).optional().default([]).describe(
-    "Configuration of flags associated with the actions of this event type."
+    "Configuration of custom flags associated with the actions of this event type."
   ),
   analytics: z33.boolean().optional().default(true).describe(
     "Indicates whether the records of this event type are included in analytics"
@@ -5790,18 +5825,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
   query: true,
   columns: true
 });
-var WorkqueueConfigInput = z37.object({
-  slug: z37.string().describe("Determines the url of the workqueue."),
-  name: TranslationConfig.describe(
-    "Title of the workflow (both in navigation and on the page)"
-  ),
-  query: CountryConfigQueryInputType,
-  action: z37.object({ type: WorkqueueActionType }).optional().describe(
-    "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."
-  ),
-  columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
-  icon: AvailableIcons,
-  emptyMessage: TranslationConfig.optional()
+var WorkqueueConfigInput = WorkqueueConfig.extend({
+  query: CountryConfigQueryInputType
+}).meta({
+  description: "Workqueue configuration",
+  id: "WorkqueueConfig"
 });
 function defineWorkqueue(workqueueInput) {
   const queryInput = workqueueInput.query;
@@ -5862,6 +5890,9 @@ var BaseActionInput = z38.object({
   originalActionId: UUID.optional(),
   // should not be part of base action.
   keepAssignment: z38.boolean().optional(),
+  keepAssignmentIfAccepted: z38.boolean().optional(),
+  keepAssignmentIfRejected: z38.boolean().optional(),
+  waitFor: z38.boolean().optional(),
   // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
   // @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
   createdAtLocation: UUID.nullish().describe(
@@ -6115,7 +6146,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
     createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
     acceptedAt: acceptAction.createdAt,
     createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
-    createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
     registrationNumber
   };
 }
@@ -6329,17 +6359,6 @@ function getAssignedUserFromActions(actions) {
     return user2;
   }, null);
 }
-function getAssignedUserSignatureFromActions(actions) {
-  return actions.reduce((signature, action) => {
-    if (action.type === ActionType.ASSIGN) {
-      return action.createdBySignature || null;
-    }
-    if (action.type === ActionType.UNASSIGN) {
-      return null;
-    }
-    return signature;
-  }, null);
-}
 function deepDropNulls(obj) {
   if (Array.isArray(obj)) {
     return obj.map(deepDropNulls);
@@ -6435,10 +6454,8 @@ function getCurrentEventState(event2, config) {
     createdBy: creationAction.createdBy,
     createdByUserType: creationAction.createdByUserType,
     createdAtLocation: creationAction.createdAtLocation,
-    createdBySignature: creationAction.createdBySignature,
     updatedAt: acceptedActionMetadata.createdAt,
     assignedTo: getAssignedUserFromActions(acceptedActions),
-    assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
     updatedBy: requestActionMetadata.createdBy,
     updatedAtLocation: requestActionMetadata.createdAtLocation,
     declaration,
@@ -9697,7 +9714,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
     createdBy: overrides.createdBy ?? generateUuid(rng),
     createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
     updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
-    createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
     updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
     assignedTo: overrides.assignedTo ?? null,
     updatedBy: overrides.updatedBy ?? generateUuid(rng),
@@ -9930,11 +9946,77 @@ function canAccessEventWithScope(event2, scope, user2, customActionType) {
   }
   return true;
 }
+function canAccessUserWithScope({
+  userToAccess,
+  scope,
+  user: user2
+}) {
+  const opts = scope.options;
+  const hasSameOffice = user2.primaryOfficeId === userToAccess.primaryOfficeId;
+  if (opts?.accessLevel === JurisdictionFilter.enum.location && !hasSameOffice) {
+    return false;
+  }
+  const hasAdministrativeAreaInHierarchy = userToAccess.administrativeHierarchy.some(
+    (id) => user2.administrativeAreaId === id
+  ) || user2.administrativeAreaId === null;
+  if (opts?.accessLevel === JurisdictionFilter.enum.administrativeArea && !hasAdministrativeAreaInHierarchy) {
+    return false;
+  }
+  if (scopeUsesRoleOptions(scope)) {
+    const { options } = scope;
+    if (options?.role && !options.role.includes(userToAccess.role)) {
+      return false;
+    }
+  }
+  return true;
+}
+function canAccessOtherUserWithScopes({
+  scopes,
+  userToAccess,
+  user: user2
+}) {
+  return scopes.some(
+    (scope) => canAccessUserWithScope({ userToAccess, scope, user: user2 })
+  );
+}
 function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
   return scopes.some(
     (scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
   );
 }
+function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
+  const collectedLocations = [];
+  const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
+  let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
+  while (current) {
+    collectedLocations.push(current);
+    if (!current.parentId) {
+      break;
+    }
+    const parentId = current.parentId;
+    current = administrativeAreas.get(parentId);
+  }
+  return collectedLocations;
+}
+function getLocationHierarchy(selectedId, context) {
+  const { administrativeAreas, locations } = context;
+  const loc = locations.get(selectedId);
+  if (loc) {
+    if (loc.administrativeAreaId) {
+      const hierarchy2 = getAdministrativeAreaHierarchy(
+        loc.administrativeAreaId,
+        administrativeAreas
+      );
+      return [...hierarchy2.reverse().map((area) => area.id), loc.id];
+    }
+    return [loc.id];
+  }
+  const hierarchy = getAdministrativeAreaHierarchy(
+    selectedId,
+    administrativeAreas
+  );
+  return hierarchy.reverse().map((area) => area.id);
+}
 
 // ../commons/src/events/scopes.ts
 var ACTION_SCOPE_MAP = {
@@ -10009,6 +10091,25 @@ function isActionInScope({
   );
   return canAccess;
 }
+function getAvailableRolesForUserUpdatePayload({
+  allRoles,
+  userLocation,
+  acceptedScopes,
+  userRequesting
+}) {
+  const availableRoles = allRoles.filter((role) => {
+    const canAccess = canAccessOtherUserWithScopes({
+      userToAccess: {
+        ...userLocation,
+        role
+      },
+      user: userRequesting,
+      scopes: acceptedScopes
+    });
+    return canAccess;
+  });
+  return availableRoles;
+}
 
 // ../commons/src/events/serializers/user/deserializer.ts
 function userDeserializer(serializedUserField, user2) {

package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-birth-certificate-issuance-flag.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/add-birth-certificate-issuance-flag.ts"],"names":[],"mappings":"AA2aA,iBAAe,IAAI,kBAiDlB;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"add-birth-certificate-issuance-flag.d.ts","sourceRoot":"","sources":["../../../src/migrations/v2.0/add-birth-certificate-issuance-flag.ts"],"names":[],"mappings":"AAycA,iBAAe,IAAI,kBAiDlB;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}