@fogpipe/forma-core 0.11.2 → 0.12.0-alpha.2

package/dist/engine/index.cjs

@@ -30,11 +30,13 @@ __export(engine_exports, {
   getFormattedValue: () => getFormattedValue,
   getOptionsVisibility: () => getOptionsVisibility,
   getPageVisibility: () => getPageVisibility,
+  getReadonly: () => getReadonly,
   getRequired: () => getRequired,
   getVisibility: () => getVisibility,
   getVisibleOptions: () => getVisibleOptions,
   isEnabled: () => isEnabled,
   isFieldVisible: () => isFieldVisible,
+  isReadonly: () => isReadonly,
   isRequired: () => isRequired,
   isValidFormat: () => isValidFormat,
   parseDecimalFormat: () => parseDecimalFormat,
@@ -315,6 +317,14 @@ function calculateField(fieldName, data, spec) {
   return computed[fieldName] ?? null;
 }
 
+// src/types.ts
+function isSelectionField(field) {
+  return field.type === "select" || field.type === "multiselect";
+}
+function isArrayField(field) {
+  return field.type === "array";
+}
+
 // src/engine/visibility.ts
 function filterOptionsByContext(options, context) {
   return options.filter((option) => {
@@ -336,7 +346,7 @@ function processArrayItemOptions(arrayPath, fieldDef, arrayData, baseContext, re
       itemIndex: i
     };
     for (const [itemFieldName, itemFieldDef] of Object.entries(fieldDef.itemFields)) {
-      if (itemFieldDef.options && itemFieldDef.options.length > 0) {
+      if (isSelectionField(itemFieldDef) && itemFieldDef.options && itemFieldDef.options.length > 0) {
         const itemFieldPath = `${arrayPath}[${i}].${itemFieldName}`;
         result[itemFieldPath] = filterOptionsByContext(itemFieldDef.options, itemContext);
       }
@@ -368,7 +378,7 @@ function evaluateFieldVisibility(path, fieldDef, data, context, result) {
   if (!result[path]) {
     return;
   }
-  if (fieldDef.itemFields) {
+  if (isArrayField(fieldDef) && fieldDef.itemFields) {
     const arrayData = data[path];
     if (Array.isArray(arrayData)) {
       evaluateArrayItemVisibility(path, fieldDef, arrayData, context, result);
@@ -441,10 +451,10 @@ function getOptionsVisibility(data, spec, options = {}) {
   for (const fieldPath of spec.fieldOrder) {
     const fieldDef = spec.fields[fieldPath];
     if (!fieldDef) continue;
-    if (fieldDef.options && fieldDef.options.length > 0) {
+    if (isSelectionField(fieldDef) && fieldDef.options && fieldDef.options.length > 0) {
       result[fieldPath] = filterOptionsByContext(fieldDef.options, baseContext);
     }
-    if (fieldDef.itemFields) {
+    if (isArrayField(fieldDef) && fieldDef.itemFields) {
       const arrayData = data[fieldPath];
       if (Array.isArray(arrayData)) {
         processArrayItemOptions(fieldPath, fieldDef, arrayData, baseContext, result);
@@ -482,7 +492,7 @@ function getRequired(data, spec, options = {}) {
     }
   }
   for (const [fieldPath, fieldDef] of Object.entries(spec.fields)) {
-    if (fieldDef.itemFields) {
+    if (fieldDef.type === "array" && fieldDef.itemFields) {
       const arrayData = data[fieldPath];
       if (Array.isArray(arrayData)) {
         for (let i = 0; i < arrayData.length; i++) {
@@ -547,23 +557,10 @@ function getEnabled(data, spec, options = {}) {
     }
   }
   for (const [fieldPath, fieldDef] of Object.entries(spec.fields)) {
-    if (fieldDef.itemFields) {
+    if (fieldDef.type === "array" && fieldDef.itemFields) {
       const arrayData = data[fieldPath];
       if (Array.isArray(arrayData)) {
-        for (let i = 0; i < arrayData.length; i++) {
-          const item = arrayData[i];
-          const itemContext = {
-            data,
-            computed,
-            referenceData: spec.referenceData,
-            item,
-            itemIndex: i
-          };
-          for (const [itemFieldName, itemFieldDef] of Object.entries(fieldDef.itemFields)) {
-            const itemFieldPath = `${fieldPath}[${i}].${itemFieldName}`;
-            result[itemFieldPath] = isFieldEnabled(itemFieldDef, itemContext);
-          }
-        }
+        evaluateArrayItemEnabled(fieldPath, fieldDef, arrayData, data, computed, spec, result);
       }
     }
   }
@@ -575,6 +572,23 @@ function isFieldEnabled(fieldDef, context) {
   }
   return true;
 }
+function evaluateArrayItemEnabled(arrayPath, fieldDef, arrayData, data, computed, spec, result) {
+  if (!fieldDef.itemFields) return;
+  for (let i = 0; i < arrayData.length; i++) {
+    const item = arrayData[i];
+    const itemContext = {
+      data,
+      computed,
+      referenceData: spec.referenceData,
+      item,
+      itemIndex: i
+    };
+    for (const [itemFieldName, itemFieldDef] of Object.entries(fieldDef.itemFields)) {
+      const itemFieldPath = `${arrayPath}[${i}].${itemFieldName}`;
+      result[itemFieldPath] = isFieldEnabled(itemFieldDef, itemContext);
+    }
+  }
+}
 function isEnabled(fieldPath, data, spec) {
   const fieldDef = spec.fields[fieldPath];
   if (!fieldDef) {
@@ -592,6 +606,71 @@ function isEnabled(fieldPath, data, spec) {
   return evaluateBoolean(fieldDef.enabledWhen, context);
 }
 
+// src/engine/readonly.ts
+function getReadonly(data, spec, options = {}) {
+  const computed = options.computed ?? calculate(data, spec);
+  const context = {
+    data,
+    computed,
+    referenceData: spec.referenceData
+  };
+  const result = {};
+  for (const fieldPath of spec.fieldOrder) {
+    const fieldDef = spec.fields[fieldPath];
+    if (fieldDef) {
+      result[fieldPath] = isFieldReadonly(fieldDef, context);
+    }
+  }
+  for (const [fieldPath, fieldDef] of Object.entries(spec.fields)) {
+    if (fieldDef.type === "array" && fieldDef.itemFields) {
+      const arrayData = data[fieldPath];
+      if (Array.isArray(arrayData)) {
+        evaluateArrayItemReadonly(fieldPath, fieldDef, arrayData, data, computed, spec, result);
+      }
+    }
+  }
+  return result;
+}
+function isFieldReadonly(fieldDef, context) {
+  if (fieldDef.readonlyWhen) {
+    return evaluateBoolean(fieldDef.readonlyWhen, context);
+  }
+  return false;
+}
+function evaluateArrayItemReadonly(arrayPath, fieldDef, arrayData, data, computed, spec, result) {
+  if (!fieldDef.itemFields) return;
+  for (let i = 0; i < arrayData.length; i++) {
+    const item = arrayData[i];
+    const itemContext = {
+      data,
+      computed,
+      referenceData: spec.referenceData,
+      item,
+      itemIndex: i
+    };
+    for (const [itemFieldName, itemFieldDef] of Object.entries(fieldDef.itemFields)) {
+      const itemFieldPath = `${arrayPath}[${i}].${itemFieldName}`;
+      result[itemFieldPath] = isFieldReadonly(itemFieldDef, itemContext);
+    }
+  }
+}
+function isReadonly(fieldPath, data, spec) {
+  const fieldDef = spec.fields[fieldPath];
+  if (!fieldDef) {
+    return false;
+  }
+  if (!fieldDef.readonlyWhen) {
+    return false;
+  }
+  const computed = calculate(data, spec);
+  const context = {
+    data,
+    computed,
+    referenceData: spec.referenceData
+  };
+  return evaluateBoolean(fieldDef.readonlyWhen, context);
+}
+
 // src/engine/validate.ts
 function validate(data, spec, options = {}) {
   const { onlyVisible = true } = options;
@@ -604,6 +683,9 @@ function validate(data, spec, options = {}) {
     if (onlyVisible && visibility[fieldPath] === false) {
       continue;
     }
+    if (fieldDef.type === "display") {
+      continue;
+    }
     const schemaProperty = spec.schema.properties[fieldPath];
     const fieldErrors = validateField(
       fieldPath,
@@ -649,7 +731,7 @@ function validateField(path, value, fieldDef, schemaProperty, spec, data, comput
     const customErrors = validateCustomRules(path, fieldDef.validations, context);
     errors.push(...customErrors);
   }
-  if (Array.isArray(value)) {
+  if (Array.isArray(value) && fieldDef.type === "array") {
     const arrayErrors = validateArray(
       path,
       value,
@@ -1032,11 +1114,13 @@ function validateSingleField(fieldPath, data, spec) {
   getFormattedValue,
   getOptionsVisibility,
   getPageVisibility,
+  getReadonly,
   getRequired,
   getVisibility,
   getVisibleOptions,
   isEnabled,
   isFieldVisible,
+  isReadonly,
   isRequired,
   isValidFormat,
   parseDecimalFormat,