@opencrvs/toolkit 1.8.0-rc.ffe8c17 → 1.8.1-rc.0c972dc

package/dist/commons/events/event.d.ts

@@ -0,0 +1,108 @@
+import { ActionType } from './ActionType';
+import { EventFieldIdInput } from './AdvancedSearchConfig';
+import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
+/**
+ * Creates a function that acts like a callable + static method container.
+ *
+ * @example
+ * event('status') // → returns search config
+ * event.hasAction('CLICKED') // → returns conditional
+ */
+declare function eventFn(fieldId: EventFieldIdInput): {
+    range: () => {
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
+    } & {
+        config: {
+            type: "range";
+        };
+    };
+    exact: () => {
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
+    } & {
+        config: {
+            type: "exact";
+        };
+    };
+    fuzzy: () => {
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
+    } & {
+        config: {
+            type: "fuzzy";
+        };
+    };
+    within: () => {
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
+    } & {
+        config: {
+            type: "within";
+        };
+    };
+};
+declare const event: typeof eventFn & {
+    /**
+     * Checks if the event contains a specific action type.
+     * Can be used directly as a conditional or chained with additional methods.
+     * @param action - The action type to check for.
+     */
+    hasAction: (action: ActionType) => {
+        /**
+         * Creates a conditional that checks if the event contains a specific action type
+         * with a minimum count of occurrences.
+         *
+         * @param minCount - The minimum number of actions required.
+         */
+        minCount: (minCount: number) => import("../conditionals/conditionals").JSONSchema;
+        /**
+         * Builds a conditional that sets a maximum count for the number of actions.
+         * This is useful for limiting the number of actions of a specific type in a single event.
+         */
+        maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
+        /**
+         * Adds additional field constraints to the action matching.
+         *
+         * @param fields - Object containing additional fields to match on the action.
+         */
+        withFields: (fields: Record<string, unknown>) => {
+            /**
+             * Creates a conditional that checks if the event contains a specific action type
+             * with a minimum count of occurrences.
+             *
+             * @param minCount - The minimum number of actions required.
+             */
+            minCount: (minCount: number) => import("../conditionals/conditionals").JSONSchema;
+            /**
+             * Builds a conditional that sets a maximum count for the number of actions.
+             * This is useful for limiting the number of actions of a specific type in a single event.
+             */
+            maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
+        };
+        /**
+         * Adds template ID constraint to the action matching.
+         * This is a convenience method that adds content.templateId to the fields.
+         *
+         * @param id - The template ID to match against.
+         */
+        withTemplate: (id: string) => {
+            /**
+             * Creates a conditional that checks if the event contains a specific action type
+             * with a minimum count of occurrences.
+             *
+             * @param minCount - The minimum number of actions required.
+             */
+            minCount: (minCount: number) => import("../conditionals/conditionals").JSONSchema;
+            /**
+             * Builds a conditional that sets a maximum count for the number of actions.
+             * This is useful for limiting the number of actions of a specific type in a single event.
+             */
+            maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
+        };
+        __nominal__type: "JSONSchema";
+    };
+    field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
+};
+export { event };
+//# sourceMappingURL=event.d.ts.map

package/dist/commons/events/field.d.ts

@@ -0,0 +1,108 @@
+import { FieldConditional } from './Conditional';
+import { TranslationConfig } from './TranslationConfig';
+import { SelectOption, ValidationConfig } from './FieldConfig';
+/**
+ * Entry point for defining conditional logic or configuration for a form field.
+ * @param fieldId - The ID of the field to define rules or config for.
+ * @returns An object combining conditional methods and configuration builders.
+ */
+export declare function field(fieldId: string, options?: {
+    options?: SelectOption[];
+    excludeInSearchQuery?: boolean;
+    alternateFieldIds?: string[];
+    conditionals?: FieldConditional[];
+    validations?: ValidationConfig[];
+    searchCriteriaLabelPrefix?: TranslationConfig;
+}): {
+    range: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "range";
+        };
+    };
+    exact: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "exact";
+        };
+    };
+    fuzzy: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "fuzzy";
+        };
+    };
+    within: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "within";
+        };
+    };
+    $$field: string;
+    isAfter: () => {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: string | {
+            $$field: string;
+        }) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isBefore: () => {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: string | {
+            $$field: string;
+        }) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isEqualTo: (value: string | boolean | {
+        $$field: string;
+    }) => import("../conditionals/conditionals").JSONSchema;
+    isFalsy: () => import("../conditionals/conditionals").JSONSchema;
+    isUndefined: () => import("../conditionals/conditionals").JSONSchema;
+    inArray: (values: string[]) => import("../conditionals/conditionals").JSONSchema;
+    isValidEnglishName: () => import("../conditionals/conditionals").JSONSchema;
+    matches: (pattern: string) => import("../conditionals/conditionals").JSONSchema;
+    isBetween: (min: number, max: number) => import("../conditionals/conditionals").JSONSchema;
+    getId: () => {
+        fieldId: string;
+    };
+    object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+};
+//# sourceMappingURL=field.d.ts.map

package/dist/commons/events/index.d.ts

@@ -1,11 +1,14 @@
+export * from './Constants';
 export * from './ActionConfig';
 export * from './offline';
 export * from './EventConfig';
 export * from './EventConfigInput';
 export * from './FieldConfig';
-export * from './FormConfig';
+export * from './PageConfig';
 export * from './SummaryConfig';
 export * from './WorkqueueConfig';
+export * from './WorkqueueColumnConfig';
+export * from './workqueueDefaultColumns';
 export * from './Draft';
 export * from './EventMetadata';
 export * from './EventInput';
@@ -15,6 +18,7 @@ export * from './ActionDocument';
 export * from './EventIndex';
 export * from './TranslationConfig';
 export * from './FieldValue';
+export * from './FormConfig';
 export * from './CompositeFieldValue';
 export * from './state';
 export * from './utils';
@@ -29,6 +33,11 @@ export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
 export * from './TemplateConfig';
+export * from './scopes';
+export * from './serializer';
+export * from './state/availableActions';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
+export * from './field';
+export * from './event';
 //# sourceMappingURL=index.d.ts.map

package/dist/commons/events/scopes.d.ts

@@ -0,0 +1,45 @@
+import { Scope } from '../scopes';
+export declare const CONFIG_GET_ALLOWED_SCOPES: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records", "config", "config.update:all"];
+export declare const CONFIG_SEARCH_ALLOWED_SCOPES: ("search.birth:my-jurisdiction" | "search.birth" | "search.death:my-jurisdiction" | "search.death" | "search.marriage:my-jurisdiction" | "search.marriage")[];
+export declare const ACTION_ALLOWED_SCOPES: {
+    READ: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records"];
+    CREATE: ["record.declare-birth", "record.declaration-submit-incomplete", "record.declaration-submit-for-review"];
+    NOTIFY: ["record.declaration-submit-incomplete"];
+    DECLARE: ["record.declare-birth", "record.declaration-submit-for-approval", "record.register"];
+    DELETE: ["record.declare-birth"];
+    VALIDATE: ["record.declaration-submit-for-approval", "record.register"];
+    REGISTER: ["record.register"];
+    PRINT_CERTIFICATE: ["record.registration-print&issue-certified-copies"];
+    REQUEST_CORRECTION: ["record.registration-request-correction", "record.registration-correct"];
+    REVIEW_CORRECTION_REQUEST: ["record.registration-correct"];
+    REJECT_CORRECTION: ["record.registration-correct"];
+    APPROVE_CORRECTION: ["record.registration-correct"];
+    MARKED_AS_DUPLICATE: ["record.declaration-archive"];
+    ARCHIVE: ["record.declaration-archive"];
+    REJECT: ["record.declaration-submit-for-updates"];
+    ASSIGN: null;
+    UNASSIGN: null;
+    DETECT_DUPLICATE: [];
+};
+export declare const ACTION_ALLOWED_CONFIGURABLE_SCOPES: {
+    READ: never[];
+    CREATE: "record.notify"[];
+    NOTIFY: "record.notify"[];
+    DECLARE: never[];
+    DELETE: never[];
+    VALIDATE: never[];
+    REGISTER: never[];
+    PRINT_CERTIFICATE: never[];
+    REQUEST_CORRECTION: never[];
+    REJECT_CORRECTION: never[];
+    APPROVE_CORRECTION: never[];
+    MARKED_AS_DUPLICATE: never[];
+    ARCHIVE: never[];
+    REJECT: never[];
+    ASSIGN: never[];
+    UNASSIGN: never[];
+    DETECT_DUPLICATE: never[];
+};
+export declare const WRITE_ACTION_SCOPES: ("record.declare-birth" | "record.declaration-submit-for-approval" | "record.register" | "record.registration-print&issue-certified-copies")[];
+export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
+//# sourceMappingURL=scopes.d.ts.map

package/dist/commons/events/serializer.d.ts

@@ -0,0 +1,2 @@
+export { deserializeQuery } from './serializers/user/deserializer';
+//# sourceMappingURL=serializer.d.ts.map