@makehq/forman-schema 1.12.0 → 1.13.0

package/dist/index.cjs

@@ -93,13 +93,20 @@ function normalizeFormanFieldType(field) {
     }
   };
 }
+function valuesMatch(a, b) {
+  if (a === b) return true;
+  if (isObject(a) && isObject(b)) return JSON.stringify(a) === JSON.stringify(b);
+  return false;
+}
 function findValueInSelectOptions(field, value, optionsAndGroups) {
   if (!optionsAndGroups) return void 0;
+  const valueKey = isObject(field.options) && field.options.value ? field.options.value : "value";
+  const matches = (option) => valuesMatch(option[valueKey], value);
   if (field.grouped) {
-    const found2 = optionsAndGroups.flatMap((group) => "options" in group ? group.options : []).find((option) => option.value === value);
+    const found2 = optionsAndGroups.flatMap((group) => "options" in group ? group.options : []).find(matches);
     if (found2) return found2;
   }
-  const found = optionsAndGroups.find((option) => "value" in option && option.value === value);
+  const found = optionsAndGroups.find((option) => valueKey in option && matches(option));
   return found;
 }
 function pathToString(path) {
@@ -569,6 +576,8 @@ var FORMAN_TYPE_MAP = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: "string",
+  radio: "string",
   select: "string",
   udttype: "string",
   udtspec: "array",
@@ -659,6 +668,8 @@ function toJSONSchemaInternal(field, context) {
       return handleCollectionType(normalizedField, result, context);
     case "array":
       return handleArrayType(normalizedField, result, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -873,6 +884,32 @@ function handleSelectOrPathType(field, result, context) {
       writable: true,
       value: appendQueryString(optionsOrGroups, context.domain, context.tail)
     });
+    const xFetchOptions = {};
+    if (isObject(field.options)) {
+      for (const transferKey of ["label", "value"]) {
+        const transferValue = field.options[transferKey];
+        if (transferValue) xFetchOptions[transferKey] = transferValue;
+      }
+    }
+    if (![
+      // Reference Types are distinguished by the Loader Tool Name directly
+      ...FORMAN_REFERENCE_TYPES,
+      // Select is default
+      "select",
+      // File and Folder are distinguished by the x-path metadata, so we don't need to append it here
+      "file",
+      "folder"
+    ].includes(field.type)) {
+      xFetchOptions["type"] = field.type;
+    }
+    if (Object.keys(xFetchOptions).length) {
+      Object.defineProperty(result, "x-fetch-options", {
+        configurable: true,
+        enumerable: true,
+        writable: true,
+        value: xFetchOptions
+      });
+    }
   } else {
     let options = optionsOrGroups?.flatMap((optionOrGroup) => {
       if (isOptionGroup(optionOrGroup)) {
@@ -1056,6 +1093,9 @@ function processNestedDirective(field, nested, domain, result, context) {
 }
 
 // src/validator.ts
+function fieldAllowsCustomValue(field) {
+  return field.mappable === true || field.editable === true;
+}
 function hasPlaceholderNested(field) {
   if (!isObject(field.options)) return false;
   const placeholder = field.options.placeholder;
@@ -1138,6 +1178,8 @@ var FORMAN_TYPE_MAP2 = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: void 0,
+  radio: void 0,
   select: void 0,
   udttype: "string",
   udtspec: "array",
@@ -1349,6 +1391,8 @@ async function validateFormanValue(value, field, context) {
       return handleCollectionType2(value, normalizedField, context);
     case "array":
       return handleArrayType2(value, normalizedField, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -1678,7 +1722,7 @@ async function handlePathType(value, field, context) {
     });
     const selectedOption = selectableOptions.find((candidate) => candidate.value === levelSelectedValue);
     if (!selectedOption) {
-      if (optionsFromRPC) {
+      if (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field))) {
         warnings.push({
           domain: context.domain,
           path: context.path.join("."),
@@ -1784,7 +1828,7 @@ async function handleSelectType(value, field, context) {
         optionsOrGroups
       );
       if (!found) {
-        (optionsFromRPC && context.roots[context.domain].allowDynamicValues ? warnings : errors).push({
+        (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field)) ? warnings : errors).push({
           domain: context.domain,
           path: context.path.join("."),
           message: `Value '${singleValue}' not found in options.`
@@ -1792,7 +1836,7 @@ async function handleSelectType(value, field, context) {
         hasUnresolvedValue = true;
       }
     }
-    if (optionsFromRPC && context.roots[context.domain].allowDynamicValues && hasUnresolvedValue) {
+    if (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field)) && hasUnresolvedValue) {
       context.roots[context.domain].fieldStates.push({
         path: context.path,
         state: { mode: "edit" }
@@ -1829,7 +1873,7 @@ async function handleSelectType(value, field, context) {
   } else {
     const item = findValueInSelectOptions(field, value, optionsOrGroups);
     if (!item) {
-      if (optionsFromRPC && context.roots[context.domain].allowDynamicValues) {
+      if (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field))) {
         warnings.push({
           domain: context.domain,
           path: context.path.join("."),

package/dist/index.d.cts

@@ -3,7 +3,7 @@ import { JSONSchema7 } from 'json-schema';
 /**
  * Valid Forman Schema field types
  */
-type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'device' | 'keychain' | 'datastore' | 'udt' | 'scenario' | 'array' | 'collection' | 'text' | 'number' | 'boolean' | 'checkbox' | 'date' | 'json' | 'buffer' | 'cert' | 'color' | 'email' | 'filename' | 'file' | 'filter' | 'folder' | 'hidden' | 'integer' | 'uinteger' | 'path' | 'pkey' | 'port' | 'select' | 'time' | 'timestamp' | 'timezone' | 'url' | 'uuid' | `account:${string}` | `hook:${string}` | `keychain:${string}` | `device:${string}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
+type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'device' | 'keychain' | 'datastore' | 'udt' | 'scenario' | 'array' | 'collection' | 'text' | 'number' | 'boolean' | 'checkbox' | 'date' | 'json' | 'buffer' | 'cert' | 'color' | 'email' | 'filename' | 'file' | 'filter' | 'folder' | 'hidden' | 'integer' | 'uinteger' | 'path' | 'pkey' | 'port' | 'list' | 'radio' | 'select' | 'time' | 'timestamp' | 'timezone' | 'url' | 'uuid' | `account:${string}` | `hook:${string}` | `keychain:${string}` | `device:${string}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
 /**
  * Validation configuration for Forman Schema fields
  */
@@ -53,6 +53,8 @@ type FormanSchemaField = {
     disabled?: boolean;
     /** Whether the field is mappable */
     mappable?: boolean;
+    /** Whether the field allows custom (typed-in) values even when dynamic values are not allowed in the domain */
+    editable?: boolean;
     /** Whether the user will be able to insert new lines in GUI (a textarea will be displayed instead of the text field) */
     multiline?: boolean;
     /** Whether the select field allows multiple values */

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { JSONSchema7 } from 'json-schema';
 /**
  * Valid Forman Schema field types
  */
-type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'device' | 'keychain' | 'datastore' | 'udt' | 'scenario' | 'array' | 'collection' | 'text' | 'number' | 'boolean' | 'checkbox' | 'date' | 'json' | 'buffer' | 'cert' | 'color' | 'email' | 'filename' | 'file' | 'filter' | 'folder' | 'hidden' | 'integer' | 'uinteger' | 'path' | 'pkey' | 'port' | 'select' | 'time' | 'timestamp' | 'timezone' | 'url' | 'uuid' | `account:${string}` | `hook:${string}` | `keychain:${string}` | `device:${string}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
+type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'device' | 'keychain' | 'datastore' | 'udt' | 'scenario' | 'array' | 'collection' | 'text' | 'number' | 'boolean' | 'checkbox' | 'date' | 'json' | 'buffer' | 'cert' | 'color' | 'email' | 'filename' | 'file' | 'filter' | 'folder' | 'hidden' | 'integer' | 'uinteger' | 'path' | 'pkey' | 'port' | 'list' | 'radio' | 'select' | 'time' | 'timestamp' | 'timezone' | 'url' | 'uuid' | `account:${string}` | `hook:${string}` | `keychain:${string}` | `device:${string}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
 /**
  * Validation configuration for Forman Schema fields
  */
@@ -53,6 +53,8 @@ type FormanSchemaField = {
     disabled?: boolean;
     /** Whether the field is mappable */
     mappable?: boolean;
+    /** Whether the field allows custom (typed-in) values even when dynamic values are not allowed in the domain */
+    editable?: boolean;
     /** Whether the user will be able to insert new lines in GUI (a textarea will be displayed instead of the text field) */
     multiline?: boolean;
     /** Whether the select field allows multiple values */

package/dist/index.js

@@ -64,13 +64,20 @@ function normalizeFormanFieldType(field) {
     }
   };
 }
+function valuesMatch(a, b) {
+  if (a === b) return true;
+  if (isObject(a) && isObject(b)) return JSON.stringify(a) === JSON.stringify(b);
+  return false;
+}
 function findValueInSelectOptions(field, value, optionsAndGroups) {
   if (!optionsAndGroups) return void 0;
+  const valueKey = isObject(field.options) && field.options.value ? field.options.value : "value";
+  const matches = (option) => valuesMatch(option[valueKey], value);
   if (field.grouped) {
-    const found2 = optionsAndGroups.flatMap((group) => "options" in group ? group.options : []).find((option) => option.value === value);
+    const found2 = optionsAndGroups.flatMap((group) => "options" in group ? group.options : []).find(matches);
     if (found2) return found2;
   }
-  const found = optionsAndGroups.find((option) => "value" in option && option.value === value);
+  const found = optionsAndGroups.find((option) => valueKey in option && matches(option));
   return found;
 }
 function pathToString(path) {
@@ -540,6 +547,8 @@ var FORMAN_TYPE_MAP = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: "string",
+  radio: "string",
   select: "string",
   udttype: "string",
   udtspec: "array",
@@ -630,6 +639,8 @@ function toJSONSchemaInternal(field, context) {
       return handleCollectionType(normalizedField, result, context);
     case "array":
       return handleArrayType(normalizedField, result, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -844,6 +855,32 @@ function handleSelectOrPathType(field, result, context) {
       writable: true,
       value: appendQueryString(optionsOrGroups, context.domain, context.tail)
     });
+    const xFetchOptions = {};
+    if (isObject(field.options)) {
+      for (const transferKey of ["label", "value"]) {
+        const transferValue = field.options[transferKey];
+        if (transferValue) xFetchOptions[transferKey] = transferValue;
+      }
+    }
+    if (![
+      // Reference Types are distinguished by the Loader Tool Name directly
+      ...FORMAN_REFERENCE_TYPES,
+      // Select is default
+      "select",
+      // File and Folder are distinguished by the x-path metadata, so we don't need to append it here
+      "file",
+      "folder"
+    ].includes(field.type)) {
+      xFetchOptions["type"] = field.type;
+    }
+    if (Object.keys(xFetchOptions).length) {
+      Object.defineProperty(result, "x-fetch-options", {
+        configurable: true,
+        enumerable: true,
+        writable: true,
+        value: xFetchOptions
+      });
+    }
   } else {
     let options = optionsOrGroups?.flatMap((optionOrGroup) => {
       if (isOptionGroup(optionOrGroup)) {
@@ -1027,6 +1064,9 @@ function processNestedDirective(field, nested, domain, result, context) {
 }
 
 // src/validator.ts
+function fieldAllowsCustomValue(field) {
+  return field.mappable === true || field.editable === true;
+}
 function hasPlaceholderNested(field) {
   if (!isObject(field.options)) return false;
   const placeholder = field.options.placeholder;
@@ -1109,6 +1149,8 @@ var FORMAN_TYPE_MAP2 = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: void 0,
+  radio: void 0,
   select: void 0,
   udttype: "string",
   udtspec: "array",
@@ -1320,6 +1362,8 @@ async function validateFormanValue(value, field, context) {
       return handleCollectionType2(value, normalizedField, context);
     case "array":
       return handleArrayType2(value, normalizedField, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -1649,7 +1693,7 @@ async function handlePathType(value, field, context) {
     });
     const selectedOption = selectableOptions.find((candidate) => candidate.value === levelSelectedValue);
     if (!selectedOption) {
-      if (optionsFromRPC) {
+      if (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field))) {
         warnings.push({
           domain: context.domain,
           path: context.path.join("."),
@@ -1755,7 +1799,7 @@ async function handleSelectType(value, field, context) {
         optionsOrGroups
       );
       if (!found) {
-        (optionsFromRPC && context.roots[context.domain].allowDynamicValues ? warnings : errors).push({
+        (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field)) ? warnings : errors).push({
           domain: context.domain,
           path: context.path.join("."),
           message: `Value '${singleValue}' not found in options.`
@@ -1763,7 +1807,7 @@ async function handleSelectType(value, field, context) {
         hasUnresolvedValue = true;
       }
     }
-    if (optionsFromRPC && context.roots[context.domain].allowDynamicValues && hasUnresolvedValue) {
+    if (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field)) && hasUnresolvedValue) {
       context.roots[context.domain].fieldStates.push({
         path: context.path,
         state: { mode: "edit" }
@@ -1800,7 +1844,7 @@ async function handleSelectType(value, field, context) {
   } else {
     const item = findValueInSelectOptions(field, value, optionsOrGroups);
     if (!item) {
-      if (optionsFromRPC && context.roots[context.domain].allowDynamicValues) {
+      if (optionsFromRPC && (context.roots[context.domain].allowDynamicValues || fieldAllowsCustomValue(field))) {
         warnings.push({
           domain: context.domain,
           path: context.path.join("."),

package/package.json

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