@makehq/forman-schema 1.17.0 → 1.19.0

package/dist/index.cjs

@@ -58,6 +58,9 @@ function noEmpty(text) {
 function isObject(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+function isBooleanBranchNested(nested) {
+  return isObject(nested) && !("store" in nested) && ("true" in nested || "false" in nested);
+}
 function isOptionGroup(value) {
   return "options" in value && Array.isArray(value.options);
 }
@@ -1124,7 +1127,7 @@ function processRpcDirective(field, result, context) {
   return result;
 }
 function extractNestedAndDomain(field) {
-  const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : isObject(field.nested) ? field.nested.store : field.nested;
+  const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : isBooleanBranchNested(field.nested) ? void 0 : isObject(field.nested) ? field.nested.store : field.nested;
   const domain = isObject(field.options) ? isObject(field.options.nested) && field.options.nested.domain ? field.options.nested.domain : void 0 : isObject(field.nested) && field.nested.domain ? field.nested.domain : void 0;
   return { nested, domain };
 }
@@ -1389,10 +1392,22 @@ async function validateFormanWithDomainsInternal(domains, options) {
     states: errors.length === 0 && options?.states ? buildRestoreStructure(
       Object.keys(domains).map((domain) => roots[domain].fieldStates.map((state) => ({ domain, ...state }))).flat()
     ) : void 0,
-    schemas: errors.length === 0 && options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0
+    schemas: errors.length === 0 && options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0,
+    // Same spec as `schemas`, but also on the failure path. Remote-resolved fields are
+    // built before the verdict, so a rejection can name the fields it rejected instead of
+    // leaving the caller to guess at a sub-form it never saw. `schemas` stays success-only:
+    // callers read its presence as a success signal.
+    resolvedSchemas: options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0
   };
 }
 async function validateFormanValue(value, field, context) {
+  if (context.registerOnly) {
+    return {
+      valid: true,
+      errors: [],
+      warnings: []
+    };
+  }
   if (isVisualType(field.type)) {
     return {
       valid: true,
@@ -1414,7 +1429,7 @@ async function validateFormanValue(value, field, context) {
     };
   }
   const normalizedField = normalizeFormanFieldType(field);
-  if (normalizedField.required && (value == null || value === "")) {
+  if (normalizedField.required && !context.suppressRequired && (value == null || value === "")) {
     return {
       valid: false,
       errors: [
@@ -1584,7 +1599,7 @@ async function handleCollectionType2(value, field, context) {
               continue;
             }
             if (context2.strict && !seen.has(subField2.name)) seen.add(subField2.name);
-            if (path.length === 0) {
+            if (path.length === 0 && !context2.registerOnly) {
               context2.roots[context2.domain].schemaFields.push(clampFieldForSchema(subField2));
             }
             const result2 = await validateFormanValue(value[subField2.name], subField2, {
@@ -2177,7 +2192,7 @@ async function handlePrimitiveType2(value, field, context) {
   }
   const nested = extractNestedFromField(field);
   if (nested) {
-    const result = await handleNestedFields(nested, value, field, context);
+    const result = FORMAN_TYPE_MAP2[field.type] === "boolean" ? await handleBooleanNestedFields(nested, value, field, context) : await handleNestedFields(nested, value, field, context);
     errors.push(...result.errors);
     warnings.push(...result.warnings);
   }
@@ -2187,6 +2202,19 @@ async function handlePrimitiveType2(value, field, context) {
     warnings
   };
 }
+async function handleBooleanNestedFields(nested, value, field, context) {
+  if (isBooleanBranchNested(nested)) {
+    const active2 = value === false ? nested.false : nested.true;
+    const inactive = value === false ? nested.true : nested.false;
+    const result = active2 ? await handleNestedFields(active2, value, field, context) : { valid: true, errors: [], warnings: [] };
+    if (context.strict && inactive) {
+      await handleNestedFields(inactive, value, field, { ...context, registerOnly: true });
+    }
+    return result;
+  }
+  const active = field.reversedNested === true ? value === false : value === true;
+  return handleNestedFields(nested, value, field, active ? context : { ...context, suppressRequired: true });
+}
 
 // src/json.ts
 var JSON_PRIMITIVE_TYPE_MAP = {

package/dist/index.d.cts

@@ -47,8 +47,8 @@ type FormanSchemaField = {
     advanced?: boolean;
     /** Human readable label for the field */
     label?: string;
-    /** Nested fields */
-    nested?: FormanSchemaNested;
+    nested?: FormanSchemaNested | FormanSchemaBooleanNested;
+    reversedNested?: boolean;
     /** Validation rules */
     validate?: FormanSchemaValidation;
     /** Whether the field is disabled (`false` by default) */
@@ -186,6 +186,10 @@ type FormanSchemaExtendedNested = {
     /** Domain for the nested fields */
     domain?: string;
 };
+type FormanSchemaBooleanNested = {
+    true?: (FormanSchemaField | string)[] | string;
+    false?: (FormanSchemaField | string)[] | string;
+};
 /**
  * Validation result
  */
@@ -212,8 +216,15 @@ type FormanValidationResult = {
     }[];
     /** States of fields grouped by domain */
     states?: Record<string, FormanSchemaFieldState>;
-    /** Resolved schema fields per domain */
+    /** Resolved schema fields per domain. Requires `options.schemas`; only present when validation succeeded. */
     schemas?: Record<string, FormanSchemaField[]>;
+    /**
+     * Resolved schema fields per domain. Requires `options.schemas`, and unlike {@link schemas} is
+     * present whether or not validation succeeded — including fields revealed by a remote-resolved
+     * (`rpc://`) sub-form, which cannot be known from the static schema alone. Lets a caller report
+     * which fields it rejected.
+     */
+    resolvedSchemas?: Record<string, FormanSchemaField[]>;
 };
 type FormanSchemaFieldState = {
     mode?: 'chose' | 'edit';
@@ -402,4 +413,4 @@ declare function validateFormanWithDomains(domains: Record<string, {
  */
 declare function validateForman(values: Record<string, unknown>, schema: FormanSchemaField[], options?: FormanValidationOptions, restoreExtras?: Record<string, Record<string, unknown>>): Promise<FormanValidationResult>;
 
-export { type FormanExternalValidationResult, type FormanJsonSchemaOptions, type FormanJsonSchemaResult, type FormanSchemaDirectoryOption, type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaPathExtendedOptions, type FormanSchemaRPCButton, type FormanSchemaValue, type FormanValidationOptions, type FormanValidationResult, SchemaConversionError, resolveFormanFieldType, toFormanSchema, toJSONSchema, toJSONSchemaAdvanced, validateForman, validateFormanWithDomains };
+export { type FormanExternalValidationResult, type FormanJsonSchemaOptions, type FormanJsonSchemaResult, type FormanSchemaBooleanNested, type FormanSchemaDirectoryOption, type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaPathExtendedOptions, type FormanSchemaRPCButton, type FormanSchemaValue, type FormanValidationOptions, type FormanValidationResult, SchemaConversionError, resolveFormanFieldType, toFormanSchema, toJSONSchema, toJSONSchemaAdvanced, validateForman, validateFormanWithDomains };

package/dist/index.d.ts

@@ -47,8 +47,8 @@ type FormanSchemaField = {
     advanced?: boolean;
     /** Human readable label for the field */
     label?: string;
-    /** Nested fields */
-    nested?: FormanSchemaNested;
+    nested?: FormanSchemaNested | FormanSchemaBooleanNested;
+    reversedNested?: boolean;
     /** Validation rules */
     validate?: FormanSchemaValidation;
     /** Whether the field is disabled (`false` by default) */
@@ -186,6 +186,10 @@ type FormanSchemaExtendedNested = {
     /** Domain for the nested fields */
     domain?: string;
 };
+type FormanSchemaBooleanNested = {
+    true?: (FormanSchemaField | string)[] | string;
+    false?: (FormanSchemaField | string)[] | string;
+};
 /**
  * Validation result
  */
@@ -212,8 +216,15 @@ type FormanValidationResult = {
     }[];
     /** States of fields grouped by domain */
     states?: Record<string, FormanSchemaFieldState>;
-    /** Resolved schema fields per domain */
+    /** Resolved schema fields per domain. Requires `options.schemas`; only present when validation succeeded. */
     schemas?: Record<string, FormanSchemaField[]>;
+    /**
+     * Resolved schema fields per domain. Requires `options.schemas`, and unlike {@link schemas} is
+     * present whether or not validation succeeded — including fields revealed by a remote-resolved
+     * (`rpc://`) sub-form, which cannot be known from the static schema alone. Lets a caller report
+     * which fields it rejected.
+     */
+    resolvedSchemas?: Record<string, FormanSchemaField[]>;
 };
 type FormanSchemaFieldState = {
     mode?: 'chose' | 'edit';
@@ -402,4 +413,4 @@ declare function validateFormanWithDomains(domains: Record<string, {
  */
 declare function validateForman(values: Record<string, unknown>, schema: FormanSchemaField[], options?: FormanValidationOptions, restoreExtras?: Record<string, Record<string, unknown>>): Promise<FormanValidationResult>;
 
-export { type FormanExternalValidationResult, type FormanJsonSchemaOptions, type FormanJsonSchemaResult, type FormanSchemaDirectoryOption, type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaPathExtendedOptions, type FormanSchemaRPCButton, type FormanSchemaValue, type FormanValidationOptions, type FormanValidationResult, SchemaConversionError, resolveFormanFieldType, toFormanSchema, toJSONSchema, toJSONSchemaAdvanced, validateForman, validateFormanWithDomains };
+export { type FormanExternalValidationResult, type FormanJsonSchemaOptions, type FormanJsonSchemaResult, type FormanSchemaBooleanNested, type FormanSchemaDirectoryOption, type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaPathExtendedOptions, type FormanSchemaRPCButton, type FormanSchemaValue, type FormanValidationOptions, type FormanValidationResult, SchemaConversionError, resolveFormanFieldType, toFormanSchema, toJSONSchema, toJSONSchemaAdvanced, validateForman, validateFormanWithDomains };

package/dist/index.js

@@ -26,6 +26,9 @@ function noEmpty(text) {
 function isObject(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+function isBooleanBranchNested(nested) {
+  return isObject(nested) && !("store" in nested) && ("true" in nested || "false" in nested);
+}
 function isOptionGroup(value) {
   return "options" in value && Array.isArray(value.options);
 }
@@ -1092,7 +1095,7 @@ function processRpcDirective(field, result, context) {
   return result;
 }
 function extractNestedAndDomain(field) {
-  const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : isObject(field.nested) ? field.nested.store : field.nested;
+  const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : isBooleanBranchNested(field.nested) ? void 0 : isObject(field.nested) ? field.nested.store : field.nested;
   const domain = isObject(field.options) ? isObject(field.options.nested) && field.options.nested.domain ? field.options.nested.domain : void 0 : isObject(field.nested) && field.nested.domain ? field.nested.domain : void 0;
   return { nested, domain };
 }
@@ -1357,10 +1360,22 @@ async function validateFormanWithDomainsInternal(domains, options) {
     states: errors.length === 0 && options?.states ? buildRestoreStructure(
       Object.keys(domains).map((domain) => roots[domain].fieldStates.map((state) => ({ domain, ...state }))).flat()
     ) : void 0,
-    schemas: errors.length === 0 && options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0
+    schemas: errors.length === 0 && options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0,
+    // Same spec as `schemas`, but also on the failure path. Remote-resolved fields are
+    // built before the verdict, so a rejection can name the fields it rejected instead of
+    // leaving the caller to guess at a sub-form it never saw. `schemas` stays success-only:
+    // callers read its presence as a success signal.
+    resolvedSchemas: options?.schemas ? Object.fromEntries(Object.keys(domains).map((domain) => [domain, roots[domain].schemaFields])) : void 0
   };
 }
 async function validateFormanValue(value, field, context) {
+  if (context.registerOnly) {
+    return {
+      valid: true,
+      errors: [],
+      warnings: []
+    };
+  }
   if (isVisualType(field.type)) {
     return {
       valid: true,
@@ -1382,7 +1397,7 @@ async function validateFormanValue(value, field, context) {
     };
   }
   const normalizedField = normalizeFormanFieldType(field);
-  if (normalizedField.required && (value == null || value === "")) {
+  if (normalizedField.required && !context.suppressRequired && (value == null || value === "")) {
     return {
       valid: false,
       errors: [
@@ -1552,7 +1567,7 @@ async function handleCollectionType2(value, field, context) {
               continue;
             }
             if (context2.strict && !seen.has(subField2.name)) seen.add(subField2.name);
-            if (path.length === 0) {
+            if (path.length === 0 && !context2.registerOnly) {
               context2.roots[context2.domain].schemaFields.push(clampFieldForSchema(subField2));
             }
             const result2 = await validateFormanValue(value[subField2.name], subField2, {
@@ -2145,7 +2160,7 @@ async function handlePrimitiveType2(value, field, context) {
   }
   const nested = extractNestedFromField(field);
   if (nested) {
-    const result = await handleNestedFields(nested, value, field, context);
+    const result = FORMAN_TYPE_MAP2[field.type] === "boolean" ? await handleBooleanNestedFields(nested, value, field, context) : await handleNestedFields(nested, value, field, context);
     errors.push(...result.errors);
     warnings.push(...result.warnings);
   }
@@ -2155,6 +2170,19 @@ async function handlePrimitiveType2(value, field, context) {
     warnings
   };
 }
+async function handleBooleanNestedFields(nested, value, field, context) {
+  if (isBooleanBranchNested(nested)) {
+    const active2 = value === false ? nested.false : nested.true;
+    const inactive = value === false ? nested.true : nested.false;
+    const result = active2 ? await handleNestedFields(active2, value, field, context) : { valid: true, errors: [], warnings: [] };
+    if (context.strict && inactive) {
+      await handleNestedFields(inactive, value, field, { ...context, registerOnly: true });
+    }
+    return result;
+  }
+  const active = field.reversedNested === true ? value === false : value === true;
+  return handleNestedFields(nested, value, field, active ? context : { ...context, suppressRequired: true });
+}
 
 // src/json.ts
 var JSON_PRIMITIVE_TYPE_MAP = {

package/package.json

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