@opencrvs/toolkit 1.8.0-rc.f876361 → 1.8.0-rc.f8e4107

package/dist/conditionals/index.js

@@ -23,8 +23,11 @@ __export(conditionals_exports, {
   alwaysTrue: () => alwaysTrue,
   and: () => and,
   defineConditional: () => defineConditional,
+  defineFormConditional: () => defineFormConditional,
   event: () => event,
+  eventField: () => eventField,
   field: () => field,
+  never: () => never,
   not: () => not,
   or: () => or,
   user: () => user
@@ -35,6 +38,16 @@ module.exports = __toCommonJS(conditionals_exports);
 function defineConditional(schema) {
   return schema;
 }
+function defineFormConditional(schema) {
+  const schemaWithForm = {
+    type: "object",
+    properties: {
+      $form: schema
+    },
+    required: ["$form"]
+  };
+  return defineConditional(schemaWithForm);
+}
 function alwaysTrue() {
   return {};
 }
@@ -59,6 +72,9 @@ function not(condition) {
     required: []
   });
 }
+function never() {
+  return not(alwaysTrue());
+}
 var user = {
   hasScope: (scope) => defineConditional({
     type: "object",
@@ -106,100 +122,118 @@ var event = {
     required: ["$event"]
   })
 };
+function getDateFromNow(days) {
+  return new Date(Date.now() - days * 24 * 60 * 60 * 1e3).toISOString().split("T")[0];
+}
+function getDateRangeToFieldReference(fieldId, comparedFieldId, clause) {
+  return {
+    type: "object",
+    properties: {
+      [fieldId]: {
+        type: "string",
+        format: "date",
+        [clause]: { $data: `1/${comparedFieldId}` }
+      },
+      [comparedFieldId]: { type: "string", format: "date" }
+    },
+    required: [fieldId]
+  };
+}
+function isFieldReference(value) {
+  return typeof value === "object" && value !== null && "_fieldId" in value;
+}
 function field(fieldId) {
-  const getDateFromNow = (days) => new Date(Date.now() - days * 24 * 60 * 60 * 1e3).toISOString().split("T")[0];
   const getDateRange = (date, clause) => ({
     type: "object",
     properties: {
-      $form: {
-        type: "object",
-        properties: {
-          [fieldId]: {
-            type: "string",
-            format: "date",
-            [clause]: date
-          }
-        },
-        required: [fieldId]
+      [fieldId]: {
+        type: "string",
+        format: "date",
+        [clause]: date
       }
     },
-    required: ["$form"]
+    required: [fieldId]
   });
   return {
     /**
      * @private Internal property used for field reference tracking.
      */
-    _returning: fieldId,
+    _fieldId: fieldId,
     isAfter: () => ({
       days: (days) => ({
-        inPast: () => defineConditional(
+        inPast: () => defineFormConditional(
           getDateRange(getDateFromNow(days), "formatMinimum")
         ),
-        inFuture: () => defineConditional(
+        inFuture: () => defineFormConditional(
           getDateRange(getDateFromNow(-days), "formatMinimum")
         )
       }),
-      date: (date) => defineConditional(getDateRange(date, "formatMinimum")),
-      now: () => defineConditional(getDateRange(getDateFromNow(0), "formatMinimum"))
+      date: (date) => {
+        if (isFieldReference(date)) {
+          const comparedFieldId = date._fieldId;
+          return defineFormConditional(
+            getDateRangeToFieldReference(
+              fieldId,
+              comparedFieldId,
+              "formatMinimum"
+            )
+          );
+        }
+        return defineFormConditional(getDateRange(date, "formatMinimum"));
+      },
+      now: () => defineFormConditional(getDateRange(getDateFromNow(0), "formatMinimum"))
     }),
     isBefore: () => ({
       days: (days) => ({
-        inPast: () => defineConditional(
+        inPast: () => defineFormConditional(
           getDateRange(getDateFromNow(days), "formatMaximum")
         ),
-        inFuture: () => defineConditional(
+        inFuture: () => defineFormConditional(
           getDateRange(getDateFromNow(-days), "formatMaximum")
         )
       }),
-      date: (date) => defineConditional(getDateRange(date, "formatMaximum")),
-      now: () => defineConditional(getDateRange(getDateFromNow(0), "formatMaximum"))
+      date: (date) => {
+        if (isFieldReference(date)) {
+          const comparedFieldId = date._fieldId;
+          return defineFormConditional(
+            getDateRangeToFieldReference(
+              fieldId,
+              comparedFieldId,
+              "formatMaximum"
+            )
+          );
+        }
+        return defineFormConditional(getDateRange(date, "formatMaximum"));
+      },
+      now: () => defineFormConditional(getDateRange(getDateFromNow(0), "formatMaximum"))
     }),
-    // TODO CIHAN: typing
     isEqualTo: (value) => {
-      if (typeof value === "object" && value._returning) {
-        const comparedFieldId = value._returning;
-        return defineConditional({
+      if (isFieldReference(value)) {
+        const comparedFieldId = value._fieldId;
+        return defineFormConditional({
           type: "object",
           properties: {
-            $form: {
-              type: "object",
-              properties: {
-                [fieldId]: { type: ["string", "boolean"] },
-                [comparedFieldId]: { type: ["string", "boolean"] }
-              },
-              required: [fieldId, comparedFieldId],
-              allOf: [
-                {
-                  properties: {
-                    [fieldId]: {
-                      const: { $data: `1/${comparedFieldId}` }
-                    }
-                  }
-                }
-              ]
-            }
+            [fieldId]: {
+              type: ["string", "boolean"],
+              const: { $data: `1/${comparedFieldId}` }
+            },
+            [comparedFieldId]: { type: ["string", "boolean"] }
           },
-          required: ["$form"]
+          required: [fieldId, comparedFieldId]
         });
       }
-      return defineConditional({
+      return defineFormConditional({
         type: "object",
         properties: {
-          $form: {
-            type: "object",
-            properties: {
-              [fieldId]: {
-                oneOf: [
-                  { type: "string", const: value },
-                  { type: "boolean", const: value }
-                ],
-                const: value
-              }
-            },
-            required: [fieldId]
+          [fieldId]: {
+            oneOf: [
+              { type: "string", const: value },
+              { type: "boolean", const: value }
+            ],
+            const: value
           }
         },
-        required: ["$form"]
+        required: [fieldId]
       });
     },
     /**
@@ -210,140 +244,135 @@ function field(fieldId) {
      * NOTE: For now, this only works with string, boolean, and null types. 0 is still allowed.
      *
      */
-    isFalsy: () => defineConditional({
+    isFalsy: () => defineFormConditional({
       type: "object",
       properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              anyOf: [
-                { const: "undefined" },
-                { const: false },
-                { const: null },
-                { const: "" }
-              ]
-            }
-          },
+        [fieldId]: {
           anyOf: [
-            {
-              required: [fieldId]
-            },
-            {
-              not: {
-                required: [fieldId]
-              }
-            }
+            { const: "undefined" },
+            { const: false },
+            { const: null },
+            { const: "" }
           ]
         }
       },
-      required: ["$form"]
-    }),
-    isUndefined: () => defineConditional({
-      type: "object",
-      properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              type: "string",
-              enum: ["undefined"]
-            }
-          },
+      anyOf: [
+        {
+          required: [fieldId]
+        },
+        {
           not: {
             required: [fieldId]
           }
         }
-      },
-      required: ["$form"]
+      ]
     }),
-    inArray: (values) => defineConditional({
+    isUndefined: () => defineFormConditional({
       type: "object",
       properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              type: "string",
-              enum: values
-            }
-          },
-          required: [fieldId]
+        [fieldId]: {
+          type: "string",
+          enum: ["undefined"]
         }
       },
-      required: ["$form"]
+      not: {
+        required: [fieldId]
+      }
     }),
-    isValidEnglishName: () => defineConditional({
+    inArray: (values) => defineFormConditional({
       type: "object",
       properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              type: "string",
-              pattern: "^[\\p{Script=Latin}0-9'._-]*(\\([\\p{Script=Latin}0-9'._-]+\\))?[\\p{Script=Latin}0-9'._-]*( [\\p{Script=Latin}0-9'._-]*(\\([\\p{Script=Latin}0-9'._-]+\\))?[\\p{Script=Latin}0-9'._-]*)*$",
-              description: "Name must contain only letters, numbers, and allowed special characters ('._-). No double spaces."
-            }
-          },
-          required: [fieldId]
+        [fieldId]: {
+          type: "string",
+          enum: values
         }
       },
-      required: ["$form"]
+      required: [fieldId]
     }),
-    isValidNationalId: () => defineConditional({
+    isValidEnglishName: () => defineFormConditional({
       type: "object",
       properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              type: "string",
-              pattern: "^[0-9]{9}$",
-              description: "The National ID can only be numeric and must be 9 digits long."
-            }
-          },
-          required: [fieldId]
+        [fieldId]: {
+          type: "string",
+          pattern: "^[\\p{Script=Latin}0-9'._-]*(\\([\\p{Script=Latin}0-9'._-]+\\))?[\\p{Script=Latin}0-9'._-]*( [\\p{Script=Latin}0-9'._-]*(\\([\\p{Script=Latin}0-9'._-]+\\))?[\\p{Script=Latin}0-9'._-]*)*$",
+          description: "Name must contain only letters, numbers, and allowed special characters ('._-). No double spaces."
         }
       },
-      required: ["$form"]
+      required: [fieldId]
     }),
     /**
      * Checks if the field value matches a given regular expression pattern.
      * @param pattern - The regular expression pattern to match the field value against.
      * @returns A JSONSchema conditional that validates the field value against the pattern.
      */
-    matches: (pattern) => defineConditional({
+    matches: (pattern) => defineFormConditional({
       type: "object",
       properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              type: "string",
-              pattern
-            }
-          },
-          required: [fieldId]
+        [fieldId]: {
+          type: "string",
+          pattern
         }
       },
-      required: ["$form"]
+      required: [fieldId]
     }),
-    isBetween: (min, max) => defineConditional({
+    isBetween: (min, max) => defineFormConditional({
       type: "object",
       properties: {
-        $form: {
-          type: "object",
-          properties: {
-            [fieldId]: {
-              type: "number",
-              minimum: min,
-              maximum: max
-            }
-          },
-          required: [fieldId]
+        [fieldId]: {
+          type: "number",
+          minimum: min,
+          maximum: max
         }
       },
-      required: ["$form"]
+      required: [fieldId]
+    }),
+    /**
+     * Creates a range configuration for the specified field.
+     *
+     * @returns An object containing the field ID and a configuration object with a type of 'RANGE'.
+     *
+     * @example field('age').range()
+     * // {
+     * //   fieldId: 'age',
+     * //   config: { type: 'RANGE' }
+     * // }
+     */
+    range: () => ({
+      fieldId,
+      config: { type: "RANGE" }
+    }),
+    /**
+     * Creates a configuration for exact matching of the specified field.
+     * @returns  An object containing the field ID and a configuration object with a type of 'EXACT'.
+     * @example field('dob').exact()
+     * // {
+     * //   fieldId: 'dob',
+     * //   config: { type: 'EXACT' }
+     * // }
+     */
+    exact: () => ({
+      fieldId,
+      config: { type: "EXACT" }
+    }),
+    /**
+     * Creates a configuration for fuzzy matching of the specified field.
+     * @returns  An object containing the field ID and a configuration object with a type of 'EXACT'.
+     * @example field('name').fuzzy()
+     * // {
+     * //   fieldId: 'name',
+     * //   config: { type: 'FUZZY' }
+     * // }
+     */
+    fuzzy: () => ({
+      fieldId,
+      config: { type: "FUZZY" }
     })
   };
 }
+function eventField(fieldId, options) {
+  return {
+    fieldId,
+    options,
+    config: { type: "EXACT" }
+  };
+}