@opencrvs/toolkit 1.9.6-rc.c43548b → 1.9.6-rc.ca537dc

package/dist/commons/conditionals/conditionals.d.ts

@@ -4,6 +4,8 @@ import { ITokenPayload as TokenPayload, Scope } from '../authentication';
 import { PartialSchema as AjvJSONSchemaType } from 'ajv/dist/types/json-schema';
 import { userSerializer } from '../events/serializers/user/serializer';
 import { UUID } from '../uuid';
+import { todayDateTimeValueSerializer } from '../events/serializers/date/serializer';
+import { EventStatus } from '../events/EventMetadata';
 /** @knipignore */
 export type JSONSchema = {
     $id: string;
@@ -27,7 +29,11 @@ export type FormConditionalParameters = CommonConditionalParameters & {
         id: UUID;
     }>;
 };
-export type ConditionalParameters = UserConditionalParameters | EventConditionalParameters | FormConditionalParameters;
+export type EventStateConditionalParameters = CommonConditionalParameters & {
+    $flags: string[];
+    $status: EventStatus;
+};
+export type ConditionalParameters = UserConditionalParameters | EventConditionalParameters | FormConditionalParameters | EventStateConditionalParameters;
 type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 type AjvJSONSchema = AjvJSONSchemaType<UnionToIntersection<ConditionalParameters>>;
 /**
@@ -64,6 +70,10 @@ type FieldReference = {
     $$field: string;
     $$subfield: string[];
 };
+/**
+ * Generate conditional rules for current date
+ */
+export declare const now: typeof todayDateTimeValueSerializer;
 /**
  *
  * Generate conditional rules for user.
@@ -79,6 +89,10 @@ export declare const user: typeof userSerializer & {
     };
 };
 export declare function isFieldReference(value: unknown): value is FieldReference;
+/** Check if an event flag is present */
+export declare function flag(flagvalue: string): JSONSchema;
+/** Check if an event flag is present */
+export declare function status(statusValue: EventStatus): JSONSchema;
 /**
  * Generate conditional rules for a form field.
  *

package/dist/commons/conditionals/validate.d.ts

@@ -6,12 +6,12 @@ import { FieldUpdateValue, FieldValue } from '../events/FieldValue';
 import { TranslationConfig } from '../events/TranslationConfig';
 import { ITokenPayload } from '../authentication';
 import { UUID } from '../uuid';
-import { ActionType, EventDocument } from '../client';
+import { ActionConfig, ActionType, EventIndex, EventDocument } from '../client';
 export declare function validate(schema: JSONSchema, data: ConditionalParameters): boolean;
 export declare function validateValue(schema: JSONSchema, data: unknown): boolean;
 export declare function isOnline(): boolean;
-export declare function isConditionMet(conditional: JSONSchema, values: EventState | ActionUpdate, context: ValidatorContext): boolean;
-export declare function areConditionsMet(conditions: FieldConditional[], values: Record<string, FieldValue>, context: ValidatorContext): boolean;
+export declare function isConditionMet(conditional: JSONSchema, values: EventState | ActionUpdate, context: ValidatorContext, eventIndex?: EventIndex): boolean;
+export declare function areConditionsMet(conditions: FieldConditional[], values: Record<string, FieldValue>, context: ValidatorContext, event: EventIndex): boolean;
 export type ValidatorContext = {
     user?: ITokenPayload;
     leafAdminStructureLocationIds?: Array<{
@@ -22,6 +22,9 @@ export type ValidatorContext = {
 export declare function isFieldVisible(field: FieldConfig, form: Partial<ActionUpdate | EventState>, context: ValidatorContext): boolean;
 export declare function isFieldEnabled(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
 export declare function isFieldDisplayedOnReview(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
+export declare function isActionEnabled(actionConfig: ActionConfig, event: EventIndex, context: ValidatorContext): boolean;
+export declare function isActionVisible(actionConfig: ActionConfig, event: EventIndex, context: ValidatorContext): boolean;
+export declare function isActionAvailable(actionConfig: ActionConfig, event: EventIndex, context: ValidatorContext): boolean;
 export declare const errorMessages: {
     hiddenField: {
         id: string;
@@ -94,7 +97,11 @@ export declare function runFieldValidations({ field, values, context }: {
     values: ActionUpdate;
     context: ValidatorContext;
 }): {
-    message: TranslationConfig;
+    message: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 }[];
 export declare function getValidatorsForField(fieldId: FieldConfig['id'], validations: NonNullable<FieldConfig['validation']>): NonNullable<FieldConfig['validation']>;
 export declare function areCertificateConditionsMet(conditions: FieldConditional[], values: ConditionalParameters): boolean;