@opencrvs/toolkit 1.8.0-rc.f89fbcb → 1.8.0-rc.f8aa0c5

package/dist/events/index.js

@@ -155,6 +155,7 @@ __export(events_exports, {
   RuralAddressValue: () => RuralAddressValue,
   SearchField: () => SearchField,
   SearchQueryParams: () => SearchQueryParams,
+  SearchScopeAccessLevels: () => SearchScopeAccessLevels,
   SelectOption: () => SelectOption,
   ShowConditional: () => ShowConditional,
   SignatureFieldValue: () => SignatureFieldValue,
@@ -187,6 +188,7 @@ __export(events_exports, {
   alwaysTrue: () => alwaysTrue,
   and: () => and,
   annotationActions: () => annotationActions,
+  applyDeclarationToEventIndex: () => applyDeclarationToEventIndex,
   applyDraftsToEventIndex: () => applyDraftsToEventIndex,
   areConditionsMet: () => areConditionsMet,
   compositeFieldTypes: () => compositeFieldTypes,
@@ -306,6 +308,7 @@ __export(events_exports, {
   omitHiddenFields: () => omitHiddenFields,
   omitHiddenPaginatedFields: () => omitHiddenPaginatedFields,
   or: () => or,
+  resolveDateOfEvent: () => resolveDateOfEvent,
   runFieldValidations: () => runFieldValidations,
   user: () => user,
   validate: () => validate,
@@ -481,8 +484,8 @@ var NameFieldValue = import_zod3.z.object({
   middlename: import_zod3.z.string().optional()
 });
 var NameFieldUpdateValue = import_zod3.z.object({
-  firstname: import_zod3.z.string(),
-  surname: import_zod3.z.string(),
+  firstname: import_zod3.z.string().nullish(),
+  surname: import_zod3.z.string().nullish(),
   middlename: import_zod3.z.string().nullish()
 }).or(import_zod3.z.null()).or(import_zod3.z.undefined());
 var RuralAddressUpdateValue = AdminStructure.extend({
@@ -748,7 +751,9 @@ var NameField = BaseField.extend({
   configuration: import_zod5.z.object({
     maxLength: import_zod5.z.number().optional().describe("Maximum length of the text"),
     prefix: TranslationConfig.optional(),
-    postfix: TranslationConfig.optional()
+    postfix: TranslationConfig.optional(),
+    includeMiddlename: import_zod5.z.boolean().default(false).optional().describe("To make middle name visible in Name form field"),
+    searchMode: import_zod5.z.boolean().optional()
   }).optional()
 }).describe("Name input field");
 var PhoneField = BaseField.extend({
@@ -1305,17 +1310,7 @@ var SearchQueryParams = import_zod14.z.object({
 }).catchall(FieldValue);
 var FieldConfigSchema = BaseField3.extend({
   fieldId: import_zod14.z.string(),
-  fieldType: import_zod14.z.literal("field"),
-  alternateFieldIds: import_zod14.z.array(import_zod14.z.string()).optional().describe(
-    `Sometimes there might be need to search a value against multiple field of same FormField type. For example
-      search Country, Province, District against child.address.private and child.address.other. In such case, we 
-      add a one field as fieldId, and accomodate others in alternateFieldIds`
-  ),
-  excludeInSearchQuery: import_zod14.z.boolean().default(false).optional().describe(`Sometimes there will be search fields which are used to 
-    conditionally display another search field, but its not needed in search query. For example, child.placeOfBirth 
-    is select field, which has 3 options, FACILITY, PRIVATE_HOME, OTHER. Upon selecting any of the option, pops up another field
-    related to the selected option, whose value is required in the search query. But child.placeOfBirth itself is not needed in the query.
-    In such case, populate this field (excludeInSearchQuery) with boolean true`)
+  fieldType: import_zod14.z.literal("field")
 });
 var EventFieldId = import_zod14.z.enum([
   "trackingId",
@@ -1618,7 +1613,15 @@ var NotifyRecordScope = import_zod16.z.object({
     event: import_zod16.z.array(import_zod16.z.string())
   })
 });
-var ConfigurableScopes = import_zod16.z.discriminatedUnion("type", [
+var SearchScope = import_zod16.z.object({
+  type: import_zod16.z.literal("search"),
+  options: import_zod16.z.object({
+    event: import_zod16.z.array(import_zod16.z.string()).length(1),
+    access: import_zod16.z.array(import_zod16.z.enum(["my-jurisdiction", "all"])).length(1)
+  })
+});
+var ConfigurableRawScopes = import_zod16.z.discriminatedUnion("type", [
+  SearchScope,
   CreateUserScope,
   EditUserScope,
   WorkqueueScope,
@@ -2638,28 +2641,6 @@ var EventConfig = import_zod20.z.object({
       path: ["advancedSearch"]
     });
   }
-  event2.advancedSearch.forEach((section, sectionIndex) => {
-    section.fields.forEach((field2, fieldIndex) => {
-      if ("alternateFieldIds" in field2 && Array.isArray(field2.alternateFieldIds)) {
-        const invalidAltIds = field2.alternateFieldIds.filter(
-          (id) => !fieldIds.includes(id)
-        );
-        if (invalidAltIds.length > 0) {
-          ctx.addIssue({
-            code: "custom",
-            message: `Invalid alternateFieldIds: ${invalidAltIds.join(", ")}`,
-            path: [
-              "advancedSearch",
-              sectionIndex,
-              "fields",
-              fieldIndex,
-              "alternateFieldIds"
-            ]
-          });
-        }
-      }
-    });
-  });
   if (event2.dateOfEvent) {
     const eventDateFieldId = getDeclarationFields(event2).find(
       ({ id }) => id === event2.dateOfEvent?.$$field
@@ -3436,6 +3417,10 @@ var QueryType = import_zod24.z.object({
 }).openapi({
   ref: "QueryType"
 });
+var SearchScopeAccessLevels = {
+  MY_JURISDICTION: "my-jurisdiction",
+  ALL: "all"
+};
 
 // ../commons/src/events/CountryConfigQueryInput.ts
 var SerializableExact = import_zod25.z.object({
@@ -4101,6 +4086,13 @@ function getAcceptedActions(event2) {
   );
 }
 var DEFAULT_DATE_OF_EVENT_PROPERTY = "createdAt";
+function resolveDateOfEvent(eventMetadata, declaration, config) {
+  if (!config.dateOfEvent) {
+    return eventMetadata[DEFAULT_DATE_OF_EVENT_PROPERTY].split("T")[0];
+  }
+  const parsedDate = ZodDate.safeParse(declaration[config.dateOfEvent.$$field]);
+  return parsedDate.success ? parsedDate.data : void 0;
+}
 function getCurrentEventState(event2, config) {
   const creationAction = event2.actions.find(
     (action) => action.type === ActionType.CREATE
@@ -4114,17 +4106,6 @@ function getCurrentEventState(event2, config) {
   const requestActionMetadata = getActionUpdateMetadata(event2.actions);
   const acceptedActionMetadata = getActionUpdateMetadata(acceptedActions);
   const declaration = aggregateActionDeclarations(acceptedActions);
-  let dateOfEvent;
-  if (config.dateOfEvent) {
-    const parsedDate = ZodDate.safeParse(
-      declaration[config.dateOfEvent.$$field]
-    );
-    if (parsedDate.success) {
-      dateOfEvent = parsedDate.data;
-    }
-  } else {
-    dateOfEvent = event2[DEFAULT_DATE_OF_EVENT_PROPERTY].split("T")[0];
-  }
   return deepDropNulls({
     id: event2.id,
     type: event2.type,
@@ -4143,7 +4124,7 @@ function getCurrentEventState(event2, config) {
     declaration,
     trackingId: event2.trackingId,
     updatedByUserRole: requestActionMetadata.createdByRole,
-    dateOfEvent,
+    dateOfEvent: resolveDateOfEvent(event2, declaration, config),
     flags: getFlagsFromActions(event2.actions)
   });
 }
@@ -4172,19 +4153,29 @@ function getCurrentEventStateWithDrafts({
   };
   return getCurrentEventState(withDrafts, configuration);
 }
-function applyDraftsToEventIndex(eventIndex, drafts) {
+function applyDeclarationToEventIndex(eventIndex, declaration, eventConfiguration) {
+  const updatedDeclaration = deepMerge(eventIndex.declaration, declaration);
+  return {
+    ...eventIndex,
+    dateOfEvent: resolveDateOfEvent(
+      eventIndex,
+      updatedDeclaration,
+      eventConfiguration
+    ),
+    declaration: updatedDeclaration
+  };
+}
+function applyDraftsToEventIndex(eventIndex, drafts, eventConfiguration) {
   const indexedAt = eventIndex.updatedAt;
   const activeDrafts = drafts.filter(({ createdAt }) => new Date(createdAt) > new Date(indexedAt)).map((draft) => draft.action).sort();
   if (activeDrafts.length === 0) {
     return eventIndex;
   }
-  return {
-    ...eventIndex,
-    declaration: {
-      ...eventIndex.declaration,
-      ...activeDrafts[activeDrafts.length - 1].declaration
-    }
-  };
+  return applyDeclarationToEventIndex(
+    eventIndex,
+    activeDrafts[activeDrafts.length - 1].declaration,
+    eventConfiguration
+  );
 }
 function getAnnotationFromDrafts(drafts) {
   const actions = drafts.map((draft) => draft.action);

package/dist/scopes/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { SearchScopeAccessLevels } from './events';
 export declare const SCOPES: {
     readonly NATLSYSADMIN: "natlsysadmin";
     readonly BYPASSRATELIMIT: "bypassratelimit";
@@ -87,7 +88,77 @@ export declare const SCOPES: {
 };
 export declare const SearchScopes: z.ZodUnion<[z.ZodLiteral<"search.birth:my-jurisdiction">, z.ZodLiteral<"search.birth">, z.ZodLiteral<"search.death:my-jurisdiction">, z.ZodLiteral<"search.death">, z.ZodLiteral<"search.marriage:my-jurisdiction">, z.ZodLiteral<"search.marriage">]>;
 declare const LiteralScopes: z.ZodUnion<[z.ZodUnion<[z.ZodLiteral<"natlsysadmin">, z.ZodLiteral<"bypassratelimit">, z.ZodLiteral<"declare">, z.ZodLiteral<"register">, z.ZodLiteral<"validate">, z.ZodLiteral<"demo">, z.ZodLiteral<"certify">, z.ZodLiteral<"performance">, z.ZodLiteral<"sysadmin">, z.ZodLiteral<"teams">, z.ZodLiteral<"config">]>, z.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"nationalId">, z.ZodLiteral<"notification-api">, z.ZodLiteral<"recordsearch">]>, z.ZodLiteral<"record.unassign-others">, z.ZodUnion<[z.ZodLiteral<"record.declare-birth">, z.ZodLiteral<"record.import">, z.ZodLiteral<"record.declare-birth">, z.ZodLiteral<"record.declare-birth:my-jurisdiction">, z.ZodLiteral<"record.declare-death">, z.ZodLiteral<"record.declare-death:my-jurisdiction">, z.ZodLiteral<"record.declare-marriage">, z.ZodLiteral<"record.declare-marriage:my-jurisdiction">, z.ZodLiteral<"record.declaration-submit-incomplete">, z.ZodLiteral<"record.declaration-submit-for-review">]>, z.ZodUnion<[z.ZodLiteral<"record.declaration-submit-for-approval">, z.ZodLiteral<"record.declaration-submit-for-updates">, z.ZodLiteral<"record.declaration-edit">, z.ZodLiteral<"record.review-duplicates">, z.ZodLiteral<"record.declaration-archive">, z.ZodLiteral<"record.declaration-reinstate">]>, z.ZodLiteral<"record.register">, z.ZodUnion<[z.ZodLiteral<"record.export-records">, z.ZodLiteral<"record.declaration-print">, z.ZodLiteral<"record.declaration-print-supporting-documents">, z.ZodLiteral<"record.registration-print">, z.ZodLiteral<"record.registration-print&issue-certified-copies">, z.ZodLiteral<"record.registration-print-certified-copies">, z.ZodLiteral<"record.registration-bulk-print-certified-copies">, z.ZodLiteral<"record.registration-verify-certified-copies">]>, z.ZodUnion<[z.ZodLiteral<"record.registration-request-correction">, z.ZodLiteral<"record.registration-correct">, z.ZodLiteral<"record.registration-request-revocation">, z.ZodLiteral<"record.registration-revoke">, z.ZodLiteral<"record.registration-request-reinstatement">, z.ZodLiteral<"record.registration-reinstate">, z.ZodLiteral<"record.confirm-registration">, z.ZodLiteral<"record.reject-registration">]>, z.ZodUnion<[z.ZodLiteral<"search.birth:my-jurisdiction">, z.ZodLiteral<"search.birth">, z.ZodLiteral<"search.death:my-jurisdiction">, z.ZodLiteral<"search.death">, z.ZodLiteral<"search.marriage:my-jurisdiction">, z.ZodLiteral<"search.marriage">]>, z.ZodUnion<[z.ZodLiteral<"record.read">, z.ZodLiteral<"record.read-audit">, z.ZodLiteral<"record.read-comments">, z.ZodLiteral<"record.create-comments">]>, z.ZodUnion<[z.ZodLiteral<"profile.update">, z.ZodLiteral<"profile.electronic-signature">]>, z.ZodUnion<[z.ZodLiteral<"performance.read">, z.ZodLiteral<"performance.read-dashboards">, z.ZodLiteral<"performance.vital-statistics-export">]>, z.ZodUnion<[z.ZodLiteral<"organisation.read-locations:all">, z.ZodLiteral<"organisation.read-locations:my-office">, z.ZodLiteral<"organisation.read-locations:my-jurisdiction">]>, z.ZodUnion<[z.ZodLiteral<"user.read:all">, z.ZodLiteral<"user.read:my-office">, z.ZodLiteral<"user.read:my-jurisdiction">, z.ZodLiteral<"user.read:only-my-audit">, z.ZodLiteral<"user.create:all">, z.ZodLiteral<"user.create:my-jurisdiction">, z.ZodLiteral<"user.update:all">, z.ZodLiteral<"user.update:my-jurisdiction">]>, z.ZodLiteral<"config.update:all">, z.ZodLiteral<"user.data-seeding">]>;
-declare const ConfigurableScopes: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+declare const NotifyRecordScope: z.ZodObject<{
+    type: z.ZodLiteral<"record.notify">;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+    }, {
+        event: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "record.notify";
+    options: {
+        event: string[];
+    };
+}, {
+    type: "record.notify";
+    options: {
+        event: string[];
+    };
+}>;
+declare const SearchScope: z.ZodObject<{
+    type: z.ZodLiteral<"search">;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+        access: z.ZodArray<z.ZodEnum<["my-jurisdiction", "all"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}>;
+export type SearchScope = z.infer<typeof SearchScope>;
+declare const ConfigurableRawScopes: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"search">;
+    options: z.ZodObject<{
+        event: z.ZodArray<z.ZodString, "many">;
+        access: z.ZodArray<z.ZodEnum<["my-jurisdiction", "all"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }, {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}, {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+}>, z.ZodObject<{
     type: z.ZodLiteral<"user.create">;
     options: z.ZodObject<{
         role: z.ZodArray<z.ZodString, "many">;
@@ -164,8 +235,15 @@ declare const ConfigurableScopes: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
         event: string[];
     };
 }>]>;
-export type ConfigurableScopeType = ConfigurableScopes['type'];
-export type ConfigurableScopes = z.infer<typeof ConfigurableScopes>;
+type ConfigurableRawScopes = z.infer<typeof ConfigurableRawScopes>;
+export type ConfigurableScopeType = ConfigurableRawScopes['type'];
+type FlattenedSearchScope = {
+    type: 'search';
+    options: Record<string, SearchScopeAccessLevels>;
+};
+export type ConfigurableScopes = Exclude<ConfigurableRawScopes, {
+    type: 'search';
+}> | FlattenedSearchScope;
 export declare function findScope<T extends ConfigurableScopeType>(scopes: string[], scopeType: T): Extract<{
     type: "user.create";
     options: {
@@ -194,16 +272,24 @@ export declare function findScope<T extends ConfigurableScopeType>(scopes: strin
     };
 }, {
     type: T;
+}> | Extract<FlattenedSearchScope, {
+    type: T;
 }> | undefined;
 /**
- * Parses a configurable scope string into a ConfigurableScopes object.
+ * Parses a configurable scope string into a ConfigurableRawScopes object.
  * @param {string} scope - The scope string to parse
- * @returns {ConfigurableScopes | undefined} The parsed scope object if valid, undefined otherwise
+ * @returns {ConfigurableRawScopes | undefined} The parsed scope object if valid, undefined otherwise
  * @example
  * parseScope("user.create[role=field-agent|registration-agent]")
  * // Returns: { type: "user.create", options: { role: ["field-agent", "registration-agent"] } }
  */
 export declare function parseScope(scope: string): {
+    type: "search";
+    options: {
+        event: string[];
+        access: ("my-jurisdiction" | "all")[];
+    };
+} | {
     type: "user.create";
     options: {
         role: string[];
@@ -237,7 +323,7 @@ export declare function parseScope(scope: string): {
  * })
  * // Returns: "record.notify[event=v2.birth|tennis-club-membership]"
  */
-export declare function stringifyScope(scope: ConfigurableScopes): string;
+export declare function stringifyScope(scope: z.infer<typeof NotifyRecordScope>): string;
 export declare const scopes: Scope[];
 export type ParsedScopes = NonNullable<ReturnType<typeof parseScope>>;
 export type RawScopes = z.infer<typeof LiteralScopes> | (string & {});

package/dist/scopes/index.js

@@ -289,18 +289,51 @@ var NotifyRecordScope = import_zod.z.object({
     event: import_zod.z.array(import_zod.z.string())
   })
 });
-var ConfigurableScopes = import_zod.z.discriminatedUnion("type", [
+var SearchScope = import_zod.z.object({
+  type: import_zod.z.literal("search"),
+  options: import_zod.z.object({
+    event: import_zod.z.array(import_zod.z.string()).length(1),
+    access: import_zod.z.array(import_zod.z.enum(["my-jurisdiction", "all"])).length(1)
+  })
+});
+var ConfigurableRawScopes = import_zod.z.discriminatedUnion("type", [
+  SearchScope,
   CreateUserScope,
   EditUserScope,
   WorkqueueScope,
   NotifyRecordScope
 ]);
+function flattenAndMergeScopes(scopes2) {
+  if (scopes2.length === 0) return null;
+  const type = scopes2[0].type;
+  const mergedOptions = {};
+  for (const scope of scopes2) {
+    const entries = Object.entries(scope.options);
+    if (entries.length < 2) continue;
+    const sourceValues = entries[0][1];
+    const targetValues = entries[1][1];
+    for (let i = 0; i < sourceValues.length; i++) {
+      mergedOptions[sourceValues[i]] = targetValues[i];
+    }
+  }
+  return { type, options: mergedOptions };
+}
 function findScope(scopes2, scopeType) {
   const parsedScopes = scopes2.map((rawScope) => parseScope(rawScope));
-  return parsedScopes.find(
-    (parsedScope) => parsedScope?.type === scopeType
+  const searchScopes = parsedScopes.filter((scope) => scope?.type === "search");
+  const otherScopes = parsedScopes.filter((scope) => scope?.type !== "search");
+  const mergedSearchScope = flattenAndMergeScopes(searchScopes);
+  return [...otherScopes, mergedSearchScope].find(
+    (scope) => scope?.type === scopeType
   );
 }
+function getScopeOptions(rawOptions) {
+  return rawOptions.split(",").reduce((acc, option) => {
+    const [key, value] = option.split("=");
+    acc[key] = value.split("|");
+    return acc;
+  }, {});
+}
 function parseScope(scope) {
   const maybeLiteralScope = LiteralScopes.safeParse(scope);
   if (maybeLiteralScope.success) {
@@ -314,16 +347,12 @@ function parseScope(scope) {
   }
   const rawScope = maybeConfigurableScope.data;
   const [, type, rawOptions] = rawScope.match(rawConfigurableScopeRegex) ?? [];
-  const options = rawOptions.split(",").reduce((acc, option) => {
-    const [key, value] = option.split("=");
-    acc[key] = value.split("|");
-    return acc;
-  }, {});
+  const options = getScopeOptions(rawOptions);
   const parsedScope = {
     type,
     options
   };
-  const result = ConfigurableScopes.safeParse(parsedScope);
+  const result = ConfigurableRawScopes.safeParse(parsedScope);
   return result.success ? result.data : void 0;
 }
 function stringifyScope(scope) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/toolkit",
-  "version": "1.8.0-rc.f89fbcb",
+  "version": "1.8.0-rc.f8aa0c5",
   "description": "OpenCRVS toolkit for building country configurations",
   "license": "MPL-2.0",
   "exports": {