@makehq/forman-schema 1.12.1 → 1.13.1

package/README.md

@@ -185,6 +185,7 @@ const result = await validateFormanWithDomains(
 - email → string
 - file → string
 - filename → string
+- filestorage → array (of UUID strings)
 - filter → array
 - folder → string
 - hidden → string
@@ -196,6 +197,7 @@ const result = await validateFormanWithDomains(
 - path → string
 - pkey → string
 - port → number
+- scenario → string
 - select → string with enum
 - text → string
 - time → string

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) {
@@ -560,6 +567,7 @@ var FORMAN_TYPE_MAP = {
   email: "string",
   filename: "string",
   file: "string",
+  filestorage: "array",
   filter: "array",
   folder: "string",
   hidden: void 0,
@@ -569,6 +577,9 @@ var FORMAN_TYPE_MAP = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: "string",
+  radio: "string",
+  scenario: "string",
   select: "string",
   udttype: "string",
   udtspec: "array",
@@ -658,7 +669,10 @@ function toJSONSchemaInternal(field, context) {
     case "dynamicCollection":
       return handleCollectionType(normalizedField, result, context);
     case "array":
+    case "filestorage":
       return handleArrayType(normalizedField, result, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -666,6 +680,7 @@ function toJSONSchemaInternal(field, context) {
     case "keychain":
     case "datastore":
     case "aiagent":
+    case "scenario":
     case "file":
     case "folder":
       return handleSelectOrPathType(normalizedField, result, context);
@@ -734,7 +749,15 @@ function handleCollectionType(field, result, context) {
   return result;
 }
 function handleArrayType(field, result, context) {
-  if (field.spec) {
+  if (field.type === "filestorage") {
+    result.items = { type: "string" };
+    Object.defineProperty(result, "x-filestorage", {
+      configurable: true,
+      enumerable: false,
+      writable: true,
+      value: true
+    });
+  } else if (field.spec) {
     result.items = toJSONSchemaInternal(
       Array.isArray(field.spec) ? { type: "collection", spec: field.spec } : field.spec,
       {
@@ -873,6 +896,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)) {
@@ -1141,6 +1190,8 @@ var FORMAN_TYPE_MAP2 = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: void 0,
+  radio: void 0,
   select: void 0,
   udttype: "string",
   udtspec: "array",
@@ -1148,6 +1199,8 @@ var FORMAN_TYPE_MAP2 = {
   timestamp: "string",
   timezone: "string",
   upload: "array",
+  filestorage: "array",
+  scenario: "string",
   url: "string",
   uuid: "string",
   any: void 0
@@ -1351,7 +1404,10 @@ async function validateFormanValue(value, field, context) {
     case "collection":
       return handleCollectionType2(value, normalizedField, context);
     case "array":
+    case "filestorage":
       return handleArrayType2(value, normalizedField, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -2043,6 +2099,14 @@ function toFormanSchema(field) {
         spec
       };
     case "array":
+      const filestorageMarker = Object.getOwnPropertyDescriptor(field, "x-filestorage");
+      if (filestorageMarker) {
+        return {
+          type: "filestorage",
+          label: noEmpty(field.title),
+          help: noEmpty(field.description)
+        };
+      }
       const filterLogic = Object.getOwnPropertyDescriptor(field, "x-filter");
       if (filterLogic) {
         return {

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' | 'filestorage' | '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
  */

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' | 'filestorage' | '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
  */

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) {
@@ -531,6 +538,7 @@ var FORMAN_TYPE_MAP = {
   email: "string",
   filename: "string",
   file: "string",
+  filestorage: "array",
   filter: "array",
   folder: "string",
   hidden: void 0,
@@ -540,6 +548,9 @@ var FORMAN_TYPE_MAP = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: "string",
+  radio: "string",
+  scenario: "string",
   select: "string",
   udttype: "string",
   udtspec: "array",
@@ -629,7 +640,10 @@ function toJSONSchemaInternal(field, context) {
     case "dynamicCollection":
       return handleCollectionType(normalizedField, result, context);
     case "array":
+    case "filestorage":
       return handleArrayType(normalizedField, result, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -637,6 +651,7 @@ function toJSONSchemaInternal(field, context) {
     case "keychain":
     case "datastore":
     case "aiagent":
+    case "scenario":
     case "file":
     case "folder":
       return handleSelectOrPathType(normalizedField, result, context);
@@ -705,7 +720,15 @@ function handleCollectionType(field, result, context) {
   return result;
 }
 function handleArrayType(field, result, context) {
-  if (field.spec) {
+  if (field.type === "filestorage") {
+    result.items = { type: "string" };
+    Object.defineProperty(result, "x-filestorage", {
+      configurable: true,
+      enumerable: false,
+      writable: true,
+      value: true
+    });
+  } else if (field.spec) {
     result.items = toJSONSchemaInternal(
       Array.isArray(field.spec) ? { type: "collection", spec: field.spec } : field.spec,
       {
@@ -844,6 +867,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)) {
@@ -1112,6 +1161,8 @@ var FORMAN_TYPE_MAP2 = {
   path: "string",
   pkey: "string",
   port: "number",
+  list: void 0,
+  radio: void 0,
   select: void 0,
   udttype: "string",
   udtspec: "array",
@@ -1119,6 +1170,8 @@ var FORMAN_TYPE_MAP2 = {
   timestamp: "string",
   timezone: "string",
   upload: "array",
+  filestorage: "array",
+  scenario: "string",
   url: "string",
   uuid: "string",
   any: void 0
@@ -1322,7 +1375,10 @@ async function validateFormanValue(value, field, context) {
     case "collection":
       return handleCollectionType2(value, normalizedField, context);
     case "array":
+    case "filestorage":
       return handleArrayType2(value, normalizedField, context);
+    case "list":
+    case "radio":
     case "select":
     case "account":
     case "hook":
@@ -2014,6 +2070,14 @@ function toFormanSchema(field) {
         spec
       };
     case "array":
+      const filestorageMarker = Object.getOwnPropertyDescriptor(field, "x-filestorage");
+      if (filestorageMarker) {
+        return {
+          type: "filestorage",
+          label: noEmpty(field.title),
+          help: noEmpty(field.description)
+        };
+      }
       const filterLogic = Object.getOwnPropertyDescriptor(field, "x-filter");
       if (filterLogic) {
         return {

package/package.json

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