@makehq/forman-schema 1.9.5 → 1.10.0

package/dist/index.cjs

@@ -1066,6 +1066,47 @@ function extractNestedFromField(field) {
   if (isObject(field.options) && field.options.nested) return field.options.nested;
   return void 0;
 }
+var SCHEMA_STRIP_KEYS = [
+  "nested",
+  "options",
+  "help",
+  "rpc",
+  "sort",
+  "disabled",
+  "multiline",
+  "tags",
+  "extension",
+  "codepage",
+  "logic"
+];
+function clampFieldForSchema(field) {
+  const clamped = { ...field };
+  for (const key of SCHEMA_STRIP_KEYS) {
+    delete clamped[key];
+  }
+  if (field.spec != null) {
+    clamped.spec = Array.isArray(field.spec) ? field.spec.map(clampFieldForSchema) : clampFieldForSchema(field.spec);
+  }
+  if (field.type === "select" && !field.validate?.enum) {
+    const rawOptions = isObject(field.options) ? field.options.store : field.options;
+    if (Array.isArray(rawOptions)) {
+      const values = [];
+      for (const item of rawOptions) {
+        if ("options" in item) {
+          for (const opt of item.options) {
+            values.push(opt.value);
+          }
+        } else if ("value" in item) {
+          values.push(item.value);
+        }
+      }
+      if (values.length > 0) {
+        clamped.validate = { ...clamped.validate, enum: values.map(String) };
+      }
+    }
+  }
+  return clamped;
+}
 var FORMAN_TYPE_MAP2 = {
   account: "number",
   hook: "number",
@@ -1115,6 +1156,7 @@ async function validateFormanWithDomainsInternal(domains, options) {
       acc[domain] = {
         seenFields: /* @__PURE__ */ new Set(),
         fieldStates: [],
+        schemaFields: [],
         validateFields: (fields, context) => {
           return validateFormanValue(
             domains[domain].values,
@@ -1150,6 +1192,7 @@ async function validateFormanWithDomainsInternal(domains, options) {
         path: [],
         tail: [],
         strict: options?.strict === true,
+        domainAliases: options?.domainAliases ?? {},
         validateNestedFields: () => {
           throw new Error("Cannot validate nested fields without parent field.");
         },
@@ -1192,12 +1235,25 @@ async function validateFormanWithDomainsInternal(domains, options) {
       }
     }
   }
+  if (options?.strict) {
+    for (const domain of Object.keys(domains)) {
+      if (!domains[domain]) continue;
+      const root = roots[domain];
+      for (const key of Object.keys(domains[domain].values)) {
+        if (!root.seenFields.has(key)) {
+          root.seenFields.add(key);
+          errors.push({ domain, path: "", message: `Unknown field '${key}'.` });
+        }
+      }
+    }
+  }
   return {
     valid: errors.length === 0,
     errors,
     states: errors.length === 0 && options?.states ? buildRestoreStructure(
       Object.keys(domains).map((domain) => roots[domain].fieldStates.map((state) => ({ domain, ...state }))).flat()
-    ) : void 0
+    ) : void 0,
+    schemas: errors.length === 0 && options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0
   };
 }
 async function validateFormanValue(value, field, context) {
@@ -1346,6 +1402,9 @@ async function handleCollectionType2(value, field, context) {
         continue;
       }
       if (context.strict && !seen.has(subField.name)) seen.add(subField.name);
+      if (path.length === 0) {
+        context.roots[context.domain].schemaFields.push(clampFieldForSchema(subField));
+      }
       const result = await validateFormanValue(value[subField.name], subField, {
         ...context,
         path: [...path, subField.name],
@@ -1363,6 +1422,9 @@ async function handleCollectionType2(value, field, context) {
               continue;
             }
             if (context2.strict && !seen.has(subField2.name)) seen.add(subField2.name);
+            if (path.length === 0) {
+              context2.roots[context2.domain].schemaFields.push(clampFieldForSchema(subField2));
+            }
             const result2 = await validateFormanValue(value[subField2.name], subField2, {
               ...context2,
               path: [...path, subField2.name]
@@ -1374,7 +1436,7 @@ async function handleCollectionType2(value, field, context) {
       errors.push(...result.errors);
     }
   }
-  if (context.strict) {
+  if (context.strict && context.path.length > 0) {
     for (const key of Object.keys(value)) {
       if (!seen.has(key)) {
         seen.add(key);
@@ -1788,15 +1850,16 @@ async function handleNestedFields(nested, value, field, context) {
     }
     store = resolvedStore;
   }
-  if (store && domain && domain !== context.domain) {
-    if (!context.roots[domain]) {
+  const resolvedDomain = domain ? context.domainAliases[domain] ?? domain : domain;
+  if (store && resolvedDomain && resolvedDomain !== context.domain) {
+    if (!context.roots[resolvedDomain]) {
       errors.push({
         domain: context.domain,
         path: context.path.join("."),
-        message: `Unable to process nested fields: Domain '${domain}' not found.`
+        message: resolvedDomain !== domain ? `Unable to process nested fields: Resolved domain '${resolvedDomain}' (from alias '${domain}') not found.` : `Unable to process nested fields: Domain '${domain}' not found.`
       });
     } else {
-      const result = await context.roots[domain].validateFields(store, context);
+      const result = await context.roots[resolvedDomain].validateFields(store, context);
       errors.push(...result.errors);
     }
   } else if (store) {

package/dist/index.d.cts

@@ -199,6 +199,8 @@ type FormanValidationResult = {
     }[];
     /** States of fields grouped by domain */
     states?: Record<string, FormanSchemaFieldState>;
+    /** Resolved schema fields per domain */
+    schemas?: Record<string, FormanSchemaField[]>;
 };
 type FormanSchemaFieldState = {
     mode?: 'chose' | 'edit';
@@ -214,8 +216,12 @@ type FormanValidationOptions = {
     strict?: boolean;
     /** Whether to generate states for fields */
     states?: boolean;
+    /** Whether to collect resolved schema fields per domain */
+    schemas?: boolean;
     /** Remote resource resolver */
     resolveRemote?(path: string, data: Record<string, unknown>): Promise<unknown>;
+    /** Maps domain names used in nested.domain to actual domain keys passed to validateFormanWithDomains */
+    domainAliases?: Record<string, string>;
 };
 
 /**

package/dist/index.d.ts

@@ -199,6 +199,8 @@ type FormanValidationResult = {
     }[];
     /** States of fields grouped by domain */
     states?: Record<string, FormanSchemaFieldState>;
+    /** Resolved schema fields per domain */
+    schemas?: Record<string, FormanSchemaField[]>;
 };
 type FormanSchemaFieldState = {
     mode?: 'chose' | 'edit';
@@ -214,8 +216,12 @@ type FormanValidationOptions = {
     strict?: boolean;
     /** Whether to generate states for fields */
     states?: boolean;
+    /** Whether to collect resolved schema fields per domain */
+    schemas?: boolean;
     /** Remote resource resolver */
     resolveRemote?(path: string, data: Record<string, unknown>): Promise<unknown>;
+    /** Maps domain names used in nested.domain to actual domain keys passed to validateFormanWithDomains */
+    domainAliases?: Record<string, string>;
 };
 
 /**

package/dist/index.js

@@ -1037,6 +1037,47 @@ function extractNestedFromField(field) {
   if (isObject(field.options) && field.options.nested) return field.options.nested;
   return void 0;
 }
+var SCHEMA_STRIP_KEYS = [
+  "nested",
+  "options",
+  "help",
+  "rpc",
+  "sort",
+  "disabled",
+  "multiline",
+  "tags",
+  "extension",
+  "codepage",
+  "logic"
+];
+function clampFieldForSchema(field) {
+  const clamped = { ...field };
+  for (const key of SCHEMA_STRIP_KEYS) {
+    delete clamped[key];
+  }
+  if (field.spec != null) {
+    clamped.spec = Array.isArray(field.spec) ? field.spec.map(clampFieldForSchema) : clampFieldForSchema(field.spec);
+  }
+  if (field.type === "select" && !field.validate?.enum) {
+    const rawOptions = isObject(field.options) ? field.options.store : field.options;
+    if (Array.isArray(rawOptions)) {
+      const values = [];
+      for (const item of rawOptions) {
+        if ("options" in item) {
+          for (const opt of item.options) {
+            values.push(opt.value);
+          }
+        } else if ("value" in item) {
+          values.push(item.value);
+        }
+      }
+      if (values.length > 0) {
+        clamped.validate = { ...clamped.validate, enum: values.map(String) };
+      }
+    }
+  }
+  return clamped;
+}
 var FORMAN_TYPE_MAP2 = {
   account: "number",
   hook: "number",
@@ -1086,6 +1127,7 @@ async function validateFormanWithDomainsInternal(domains, options) {
       acc[domain] = {
         seenFields: /* @__PURE__ */ new Set(),
         fieldStates: [],
+        schemaFields: [],
         validateFields: (fields, context) => {
           return validateFormanValue(
             domains[domain].values,
@@ -1121,6 +1163,7 @@ async function validateFormanWithDomainsInternal(domains, options) {
         path: [],
         tail: [],
         strict: options?.strict === true,
+        domainAliases: options?.domainAliases ?? {},
         validateNestedFields: () => {
           throw new Error("Cannot validate nested fields without parent field.");
         },
@@ -1163,12 +1206,25 @@ async function validateFormanWithDomainsInternal(domains, options) {
       }
     }
   }
+  if (options?.strict) {
+    for (const domain of Object.keys(domains)) {
+      if (!domains[domain]) continue;
+      const root = roots[domain];
+      for (const key of Object.keys(domains[domain].values)) {
+        if (!root.seenFields.has(key)) {
+          root.seenFields.add(key);
+          errors.push({ domain, path: "", message: `Unknown field '${key}'.` });
+        }
+      }
+    }
+  }
   return {
     valid: errors.length === 0,
     errors,
     states: errors.length === 0 && options?.states ? buildRestoreStructure(
       Object.keys(domains).map((domain) => roots[domain].fieldStates.map((state) => ({ domain, ...state }))).flat()
-    ) : void 0
+    ) : void 0,
+    schemas: errors.length === 0 && options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0
   };
 }
 async function validateFormanValue(value, field, context) {
@@ -1317,6 +1373,9 @@ async function handleCollectionType2(value, field, context) {
         continue;
       }
       if (context.strict && !seen.has(subField.name)) seen.add(subField.name);
+      if (path.length === 0) {
+        context.roots[context.domain].schemaFields.push(clampFieldForSchema(subField));
+      }
       const result = await validateFormanValue(value[subField.name], subField, {
         ...context,
         path: [...path, subField.name],
@@ -1334,6 +1393,9 @@ async function handleCollectionType2(value, field, context) {
               continue;
             }
             if (context2.strict && !seen.has(subField2.name)) seen.add(subField2.name);
+            if (path.length === 0) {
+              context2.roots[context2.domain].schemaFields.push(clampFieldForSchema(subField2));
+            }
             const result2 = await validateFormanValue(value[subField2.name], subField2, {
               ...context2,
               path: [...path, subField2.name]
@@ -1345,7 +1407,7 @@ async function handleCollectionType2(value, field, context) {
       errors.push(...result.errors);
     }
   }
-  if (context.strict) {
+  if (context.strict && context.path.length > 0) {
     for (const key of Object.keys(value)) {
       if (!seen.has(key)) {
         seen.add(key);
@@ -1759,15 +1821,16 @@ async function handleNestedFields(nested, value, field, context) {
     }
     store = resolvedStore;
   }
-  if (store && domain && domain !== context.domain) {
-    if (!context.roots[domain]) {
+  const resolvedDomain = domain ? context.domainAliases[domain] ?? domain : domain;
+  if (store && resolvedDomain && resolvedDomain !== context.domain) {
+    if (!context.roots[resolvedDomain]) {
       errors.push({
         domain: context.domain,
         path: context.path.join("."),
-        message: `Unable to process nested fields: Domain '${domain}' not found.`
+        message: resolvedDomain !== domain ? `Unable to process nested fields: Resolved domain '${resolvedDomain}' (from alias '${domain}') not found.` : `Unable to process nested fields: Domain '${domain}' not found.`
       });
     } else {
-      const result = await context.roots[domain].validateFields(store, context);
+      const result = await context.roots[resolvedDomain].validateFields(store, context);
       errors.push(...result.errors);
     }
   } else if (store) {

package/package.json

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