@makehq/forman-schema 1.9.3 → 1.9.5

package/dist/index.cjs

@@ -524,6 +524,7 @@ function udtspecCollapse(field) {
 }
 
 // src/forman.ts
+var EMPTY_OPTION_DESCRIPTION = "Optional field, can be left empty.";
 var SchemaConversionError = class extends Error {
   /** Field that caused the error */
   field;
@@ -886,11 +887,10 @@ function handleSelectOrPathType(field, result, context) {
       const placeholder = field.options.placeholder;
       if (isObject(placeholder) && placeholder.nested) {
         (options ||= []).push({
-          value: null,
+          value: "",
           label: placeholder.label,
           nested: placeholder.nested
         });
-        result.type = [result.type, "null"];
       }
     }
     if (options?.some((option) => {
@@ -944,6 +944,19 @@ function handleSelectOrPathType(field, result, context) {
       result.enum = (options || []).map((option) => option.value);
     }
   }
+  if (!field.required) {
+    if (result.enum && !result.enum.includes("")) {
+      result.enum = ["", ...result.enum];
+    } else if (result.oneOf && !result.oneOf.some((entry) => isObject(entry) && entry.const === "")) {
+      result.oneOf = [{ title: "Empty", const: "" }, ...result.oneOf];
+    }
+    if (result.default === void 0) {
+      result.default = "";
+    }
+    if (!result.description) {
+      result.description = EMPTY_OPTION_DESCRIPTION;
+    }
+  }
   result = handleNestedWithDomain(field, nested, domain, result, context);
   if (field.rpc) result = processRpcDirective(field, result, context);
   return result;
@@ -1048,6 +1061,11 @@ function hasPlaceholderNested(field) {
   const placeholder = field.options.placeholder;
   return isObject(placeholder) && placeholder.nested != null;
 }
+function extractNestedFromField(field) {
+  if (field.nested) return field.nested;
+  if (isObject(field.options) && field.options.nested) return field.options.nested;
+  return void 0;
+}
 var FORMAN_TYPE_MAP2 = {
   account: "number",
   hook: "number",
@@ -1202,7 +1220,7 @@ async function validateFormanValue(value, field, context) {
       ]
     };
   }
-  if (value == null) {
+  if (value == null || value === "") {
     if (normalizedField.type === "select" && hasPlaceholderNested(normalizedField)) {
       return handleSelectType(value, normalizedField, context);
     }
@@ -1245,6 +1263,10 @@ async function validateFormanValue(value, field, context) {
         state: { mode: "edit" }
       });
     }
+    const nested = extractNestedFromField(normalizedField);
+    if (nested) {
+      return handleNestedFields(nested, value, normalizedField, context);
+    }
     return {
       valid: true,
       errors: []
@@ -1602,7 +1624,7 @@ async function handlePathType(value, field, context) {
 async function handleSelectType(value, field, context) {
   const errors = [];
   let optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
-  let nested = field.nested ? field.nested : isObject(field.options) ? field.options.nested : void 0;
+  let nested = extractNestedFromField(field);
   if (typeof optionsOrGroups === "string") {
     try {
       const resolved = await context.resolveRemote(optionsOrGroups, context);
@@ -1678,7 +1700,7 @@ async function handleSelectType(value, field, context) {
         });
       }
     }
-  } else if (value == null && hasPlaceholderNested(field)) {
+  } else if ((value == null || value === "") && hasPlaceholderNested(field)) {
     const placeholder = field.options.placeholder;
     if (placeholder.label) {
       context.roots[context.domain].fieldStates.push({
@@ -1836,8 +1858,9 @@ async function handlePrimitiveType2(value, field, context) {
       }
     }
   }
-  if (field.nested) {
-    const result = await handleNestedFields(field.nested, value, field, context);
+  const nested = extractNestedFromField(field);
+  if (nested) {
+    const result = await handleNestedFields(nested, value, field, context);
     errors.push(...result.errors);
   }
   return {
@@ -1909,10 +1932,11 @@ function toFormanSchema(field) {
     case "string":
       const pathInfo = Object.getOwnPropertyDescriptor(field, "x-path");
       if (pathInfo) {
+        const help = field.description === EMPTY_OPTION_DESCRIPTION ? void 0 : noEmpty(field.description);
         return {
           type: pathInfo.value.type,
           label: noEmpty(field.title),
-          help: noEmpty(field.description),
+          help,
           options: {
             store: Object.getOwnPropertyDescriptor(field, "x-fetch")?.value,
             showRoot: pathInfo.value.showRoot,
@@ -1921,18 +1945,20 @@ function toFormanSchema(field) {
         };
       }
       if (field.enum) {
+        const help = field.description === EMPTY_OPTION_DESCRIPTION ? void 0 : noEmpty(field.description);
         return {
           type: "select",
           label: noEmpty(field.title),
-          help: noEmpty(field.description),
-          options: field.enum.map((value) => ({ value }))
+          help,
+          options: field.enum.filter((value) => value !== "").map((value) => ({ value }))
         };
       } else if (field.oneOf) {
+        const help = field.description === EMPTY_OPTION_DESCRIPTION ? void 0 : noEmpty(field.description);
         return {
           type: "select",
           label: noEmpty(field.title),
-          help: noEmpty(field.description),
-          options: field.oneOf.filter((value) => value).map((value) => ({ value: value.const }))
+          help,
+          options: field.oneOf.filter((value) => value && value.const !== "").map((value) => ({ value: value.const }))
         };
       }
       let textField = {

package/dist/index.js

@@ -495,6 +495,7 @@ function udtspecCollapse(field) {
 }
 
 // src/forman.ts
+var EMPTY_OPTION_DESCRIPTION = "Optional field, can be left empty.";
 var SchemaConversionError = class extends Error {
   /** Field that caused the error */
   field;
@@ -857,11 +858,10 @@ function handleSelectOrPathType(field, result, context) {
       const placeholder = field.options.placeholder;
       if (isObject(placeholder) && placeholder.nested) {
         (options ||= []).push({
-          value: null,
+          value: "",
           label: placeholder.label,
           nested: placeholder.nested
         });
-        result.type = [result.type, "null"];
       }
     }
     if (options?.some((option) => {
@@ -915,6 +915,19 @@ function handleSelectOrPathType(field, result, context) {
       result.enum = (options || []).map((option) => option.value);
     }
   }
+  if (!field.required) {
+    if (result.enum && !result.enum.includes("")) {
+      result.enum = ["", ...result.enum];
+    } else if (result.oneOf && !result.oneOf.some((entry) => isObject(entry) && entry.const === "")) {
+      result.oneOf = [{ title: "Empty", const: "" }, ...result.oneOf];
+    }
+    if (result.default === void 0) {
+      result.default = "";
+    }
+    if (!result.description) {
+      result.description = EMPTY_OPTION_DESCRIPTION;
+    }
+  }
   result = handleNestedWithDomain(field, nested, domain, result, context);
   if (field.rpc) result = processRpcDirective(field, result, context);
   return result;
@@ -1019,6 +1032,11 @@ function hasPlaceholderNested(field) {
   const placeholder = field.options.placeholder;
   return isObject(placeholder) && placeholder.nested != null;
 }
+function extractNestedFromField(field) {
+  if (field.nested) return field.nested;
+  if (isObject(field.options) && field.options.nested) return field.options.nested;
+  return void 0;
+}
 var FORMAN_TYPE_MAP2 = {
   account: "number",
   hook: "number",
@@ -1173,7 +1191,7 @@ async function validateFormanValue(value, field, context) {
       ]
     };
   }
-  if (value == null) {
+  if (value == null || value === "") {
     if (normalizedField.type === "select" && hasPlaceholderNested(normalizedField)) {
       return handleSelectType(value, normalizedField, context);
     }
@@ -1216,6 +1234,10 @@ async function validateFormanValue(value, field, context) {
         state: { mode: "edit" }
       });
     }
+    const nested = extractNestedFromField(normalizedField);
+    if (nested) {
+      return handleNestedFields(nested, value, normalizedField, context);
+    }
     return {
       valid: true,
       errors: []
@@ -1573,7 +1595,7 @@ async function handlePathType(value, field, context) {
 async function handleSelectType(value, field, context) {
   const errors = [];
   let optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
-  let nested = field.nested ? field.nested : isObject(field.options) ? field.options.nested : void 0;
+  let nested = extractNestedFromField(field);
   if (typeof optionsOrGroups === "string") {
     try {
       const resolved = await context.resolveRemote(optionsOrGroups, context);
@@ -1649,7 +1671,7 @@ async function handleSelectType(value, field, context) {
         });
       }
     }
-  } else if (value == null && hasPlaceholderNested(field)) {
+  } else if ((value == null || value === "") && hasPlaceholderNested(field)) {
     const placeholder = field.options.placeholder;
     if (placeholder.label) {
       context.roots[context.domain].fieldStates.push({
@@ -1807,8 +1829,9 @@ async function handlePrimitiveType2(value, field, context) {
       }
     }
   }
-  if (field.nested) {
-    const result = await handleNestedFields(field.nested, value, field, context);
+  const nested = extractNestedFromField(field);
+  if (nested) {
+    const result = await handleNestedFields(nested, value, field, context);
     errors.push(...result.errors);
   }
   return {
@@ -1880,10 +1903,11 @@ function toFormanSchema(field) {
     case "string":
       const pathInfo = Object.getOwnPropertyDescriptor(field, "x-path");
       if (pathInfo) {
+        const help = field.description === EMPTY_OPTION_DESCRIPTION ? void 0 : noEmpty(field.description);
         return {
           type: pathInfo.value.type,
           label: noEmpty(field.title),
-          help: noEmpty(field.description),
+          help,
           options: {
             store: Object.getOwnPropertyDescriptor(field, "x-fetch")?.value,
             showRoot: pathInfo.value.showRoot,
@@ -1892,18 +1916,20 @@ function toFormanSchema(field) {
         };
       }
       if (field.enum) {
+        const help = field.description === EMPTY_OPTION_DESCRIPTION ? void 0 : noEmpty(field.description);
         return {
           type: "select",
           label: noEmpty(field.title),
-          help: noEmpty(field.description),
-          options: field.enum.map((value) => ({ value }))
+          help,
+          options: field.enum.filter((value) => value !== "").map((value) => ({ value }))
         };
       } else if (field.oneOf) {
+        const help = field.description === EMPTY_OPTION_DESCRIPTION ? void 0 : noEmpty(field.description);
         return {
           type: "select",
           label: noEmpty(field.title),
-          help: noEmpty(field.description),
-          options: field.oneOf.filter((value) => value).map((value) => ({ value: value.const }))
+          help,
+          options: field.oneOf.filter((value) => value && value.const !== "").map((value) => ({ value: value.const }))
         };
       }
       let textField = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makehq/forman-schema",
-    "version": "1.9.3",
+    "version": "1.9.5",
     "description": "Forman Schema Tools",
     "license": "MIT",
     "author": "Make",