@makehq/forman-schema 1.8.2 → 1.8.3

package/dist/index.cjs

@@ -412,31 +412,92 @@ function handleArrayType(field, result, context) {
   return result;
 }
 function handleFilterType(field, result, context) {
-  const filterItems = {
+  const operandOptions = isObject(field.options) ? field.options.store : field.options;
+  const operandSchema = {
+    title: "Operand A",
+    description: "The first operand of the filter."
+  };
+  if (Array.isArray(operandOptions)) {
+    operandSchema.type = "string";
+    operandSchema.oneOf = operandOptions.flatMap((optionOrGroup) => {
+      if (isOptionGroup(optionOrGroup)) {
+        return optionOrGroup.options.map((option) => ({
+          title: `${optionOrGroup.label}: ${option.label || option.value}`,
+          const: option.value
+        }));
+      }
+      return {
+        title: optionOrGroup.label || String(optionOrGroup.value),
+        const: optionOrGroup.value
+      };
+    });
+  } else if (typeof operandOptions === "string") {
+    operandSchema.type = "string";
+    Object.defineProperty(operandSchema, "x-fetch", {
+      configurable: true,
+      enumerable: true,
+      writable: true,
+      value: appendQueryString(operandOptions, context.domain, context.tail)
+    });
+  } else {
+    operandSchema.type = IML_FILTER_ENTRY_TYPES;
+  }
+  const operatorOptions = isObject(field.options) ? field.options.operators : void 0;
+  const operatorSchema = {
+    title: "Operator",
+    description: "The operator of the filter."
+  };
+  if (Array.isArray(operatorOptions)) {
+    operatorSchema.type = "string";
+    operatorSchema.oneOf = operatorOptions.flatMap((optionOrGroup) => {
+      if (isOptionGroup(optionOrGroup)) {
+        return optionOrGroup.options.map((option) => ({
+          title: `${optionOrGroup.label}: ${option.label || option.value}`,
+          const: option.value
+        }));
+      }
+      return {
+        title: optionOrGroup.label || String(optionOrGroup.value),
+        const: optionOrGroup.value
+      };
+    });
+  } else {
+    operatorSchema.enum = IML_BINARY_FILTER_OPERATORS;
+  }
+  const filterDefinition = {
     oneOf: [
       {
         type: "object",
         properties: {
-          a: { type: IML_FILTER_ENTRY_TYPES },
-          o: { enum: IML_UNARY_FILTER_OPERATORS }
-        },
-        required: ["a", "o"]
-      },
-      {
-        type: "object",
-        properties: {
-          a: { type: IML_FILTER_ENTRY_TYPES },
-          b: { type: IML_FILTER_ENTRY_TYPES },
-          o: { enum: IML_BINARY_FILTER_OPERATORS }
+          a: operandSchema,
+          o: operatorSchema,
+          b: {
+            title: "Operand B",
+            description: "The second operand of the filter.",
+            type: IML_FILTER_ENTRY_TYPES
+          }
         },
         required: ["a", "b", "o"]
       }
     ]
   };
+  if (!operatorOptions) {
+    filterDefinition.oneOf?.push({
+      type: "object",
+      properties: {
+        a: operandSchema,
+        o: {
+          ...operatorSchema,
+          enum: IML_UNARY_FILTER_OPERATORS
+        }
+      },
+      required: ["a", "o"]
+    });
+  }
   const logic = field.logic ?? "default";
-  result.items = ["and", "or"].includes(logic) ? filterItems : {
+  result.items = ["and", "or"].includes(logic) ? filterDefinition : {
     type: "array",
-    items: filterItems
+    items: filterDefinition
   };
   Object.defineProperty(result, "x-filter", {
     configurable: true,
@@ -462,9 +523,7 @@ function handleSelectOrPathType(field, result, context) {
       }
     });
   }
-  const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : void 0;
-  const nestedContainsStrings = Array.isArray(nested) && nested.some((item) => typeof item === "string");
-  const domain = isObject(field.options) ? isObject(field.options.nested) && field.options.nested.domain ? field.options.nested.domain : void 0 : void 0;
+  const { nested, domain } = extractNestedAndDomain(field);
   if (typeof optionsOrGroups === "string") {
     Object.defineProperty(result, "x-fetch", {
       configurable: true,
@@ -533,46 +592,7 @@ function handleSelectOrPathType(field, result, context) {
       result.enum = (options || []).map((option) => option.value);
     }
   }
-  if (nested && domain && domain !== context.domain) {
-    const normalizedNested = typeof nested === "string" ? [nested] : nested;
-    let root = context.roots[domain];
-    if (!root) {
-      const buffer = [];
-      root = context.roots[domain] = {
-        buffer,
-        addFields: (nested2, tail) => {
-          buffer.push(...nested2.map((field2) => ({ field: field2, tail })));
-        }
-      };
-    }
-    root.addFields(normalizedNested, [...context.tail, field.name]);
-  } else if (nested) {
-    Object.defineProperty(result, "x-nested", {
-      configurable: true,
-      enumerable: true,
-      writable: true,
-      value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : nestedContainsStrings ? {
-        type: "object",
-        allOf: nested.map(
-          (item) => typeof item === "string" ? { $ref: appendQueryString(item, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
-            { type: "collection", spec: [item] },
-            {
-              ...context,
-              domain: domain || context.domain,
-              tail: [...context.tail, field.name]
-            }
-          )
-        )
-      } : toJSONSchemaInternal(
-        { type: "collection", spec: nested },
-        {
-          ...context,
-          domain: domain || context.domain,
-          tail: [...context.tail, field.name]
-        }
-      )
-    });
-  }
+  result = handleNestedWithDomain(field, nested, domain, result, context);
   if (field.rpc) result = processRpcDirective(field, result, context);
   return result;
 }
@@ -595,6 +615,10 @@ function handlePrimitiveType(field, result, context) {
     }
   }
   if (field.rpc) result = processRpcDirective(field, result, context);
+  if (field.nested) {
+    const { nested, domain } = extractNestedAndDomain(field);
+    result = handleNestedWithDomain(field, nested, domain, result, context);
+  }
   return result;
 }
 function processRpcDirective(field, result, context) {
@@ -611,6 +635,60 @@ 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 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 };
+}
+function handleNestedWithDomain(field, nested, domain, result, context) {
+  if (!nested) return result;
+  if (domain && domain !== context.domain) {
+    const normalizedNested = typeof nested === "string" ? [nested] : nested;
+    let root = context.roots[domain];
+    if (!root) {
+      const buffer = [];
+      root = context.roots[domain] = {
+        buffer,
+        addFields: (nested2, tail) => {
+          buffer.push(...nested2.map((field2) => ({ field: field2, tail })));
+        }
+      };
+    }
+    root.addFields(normalizedNested, [...context.tail, field.name]);
+    return result;
+  }
+  return processNestedDirective(field, nested, domain, result, context);
+}
+function processNestedDirective(field, nested, domain, result, context) {
+  if (!nested) return result;
+  const nestedContainsStrings = Array.isArray(nested) && nested.some((item) => typeof item === "string");
+  Object.defineProperty(result, "x-nested", {
+    configurable: true,
+    enumerable: true,
+    writable: true,
+    value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : nestedContainsStrings ? {
+      type: "object",
+      allOf: nested.map(
+        (item) => typeof item === "string" ? { $ref: appendQueryString(item, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
+          { type: "collection", spec: [item] },
+          {
+            ...context,
+            domain: domain || context.domain,
+            tail: [...context.tail, field.name]
+          }
+        )
+      )
+    } : toJSONSchemaInternal(
+      { type: "collection", spec: nested },
+      {
+        ...context,
+        domain: domain || context.domain,
+        tail: [...context.tail, field.name]
+      }
+    )
+  });
+  return result;
+}
 
 // src/validator.ts
 var FORMAN_TYPE_MAP2 = {
@@ -932,24 +1010,40 @@ async function handleArrayType2(value, field, context) {
   };
 }
 async function handleFilterType2(value, field, context) {
+  const operandOptions = isObject(field.options) ? field.options.store : field.options;
+  const operandSpec = {
+    name: "a",
+    type: "any",
+    required: true
+  };
+  if (Array.isArray(operandOptions)) {
+    operandSpec.type = "select";
+    operandSpec.options = operandOptions;
+  }
+  const operatorOptions = isObject(field.options) ? field.options.operators : void 0;
+  const operatorSpec = {
+    name: "o",
+    type: "any",
+    required: true
+  };
+  if (Array.isArray(operatorOptions)) {
+    operatorSpec.type = "select";
+    operatorSpec.grouped = true;
+    operatorSpec.options = operatorOptions;
+  } else {
+    operatorSpec.type = "text";
+    operatorSpec.validate = {
+      enum: IML_FILTER_OPERATORS
+    };
+  }
   const filterEntry = {
     type: "collection",
     spec: [
-      {
-        name: "a",
-        type: "any",
-        required: true
-      },
+      operandSpec,
+      operatorSpec,
       {
         name: "b",
         type: "any"
-      },
-      {
-        name: "o",
-        type: "text",
-        validate: {
-          enum: IML_FILTER_OPERATORS
-        }
       }
     ]
   };

package/dist/index.d.cts

@@ -145,6 +145,10 @@ type FormanSchemaOptionGroup = {
     /** Group options */
     options: FormanSchemaOption[];
 };
+/**
+ * Helper type for store of select, where options can be either plain options, or groups
+ */
+type FormanSchemaSelectOptionsStore = (FormanSchemaOption | FormanSchemaOptionGroup)[];
 /**
  * Extended options for a select field
  */
@@ -162,6 +166,8 @@ type FormanSchemaExtendedOptions = {
         label: string;
         nested?: FormanSchemaNested;
     };
+    /** Definition of field operators, applicable on Filter fields. */
+    operators?: FormanSchemaSelectOptionsStore;
 };
 /**
  * Nested fields

package/dist/index.d.ts

@@ -145,6 +145,10 @@ type FormanSchemaOptionGroup = {
     /** Group options */
     options: FormanSchemaOption[];
 };
+/**
+ * Helper type for store of select, where options can be either plain options, or groups
+ */
+type FormanSchemaSelectOptionsStore = (FormanSchemaOption | FormanSchemaOptionGroup)[];
 /**
  * Extended options for a select field
  */
@@ -162,6 +166,8 @@ type FormanSchemaExtendedOptions = {
         label: string;
         nested?: FormanSchemaNested;
     };
+    /** Definition of field operators, applicable on Filter fields. */
+    operators?: FormanSchemaSelectOptionsStore;
 };
 /**
  * Nested fields

package/dist/index.js

@@ -383,31 +383,92 @@ function handleArrayType(field, result, context) {
   return result;
 }
 function handleFilterType(field, result, context) {
-  const filterItems = {
+  const operandOptions = isObject(field.options) ? field.options.store : field.options;
+  const operandSchema = {
+    title: "Operand A",
+    description: "The first operand of the filter."
+  };
+  if (Array.isArray(operandOptions)) {
+    operandSchema.type = "string";
+    operandSchema.oneOf = operandOptions.flatMap((optionOrGroup) => {
+      if (isOptionGroup(optionOrGroup)) {
+        return optionOrGroup.options.map((option) => ({
+          title: `${optionOrGroup.label}: ${option.label || option.value}`,
+          const: option.value
+        }));
+      }
+      return {
+        title: optionOrGroup.label || String(optionOrGroup.value),
+        const: optionOrGroup.value
+      };
+    });
+  } else if (typeof operandOptions === "string") {
+    operandSchema.type = "string";
+    Object.defineProperty(operandSchema, "x-fetch", {
+      configurable: true,
+      enumerable: true,
+      writable: true,
+      value: appendQueryString(operandOptions, context.domain, context.tail)
+    });
+  } else {
+    operandSchema.type = IML_FILTER_ENTRY_TYPES;
+  }
+  const operatorOptions = isObject(field.options) ? field.options.operators : void 0;
+  const operatorSchema = {
+    title: "Operator",
+    description: "The operator of the filter."
+  };
+  if (Array.isArray(operatorOptions)) {
+    operatorSchema.type = "string";
+    operatorSchema.oneOf = operatorOptions.flatMap((optionOrGroup) => {
+      if (isOptionGroup(optionOrGroup)) {
+        return optionOrGroup.options.map((option) => ({
+          title: `${optionOrGroup.label}: ${option.label || option.value}`,
+          const: option.value
+        }));
+      }
+      return {
+        title: optionOrGroup.label || String(optionOrGroup.value),
+        const: optionOrGroup.value
+      };
+    });
+  } else {
+    operatorSchema.enum = IML_BINARY_FILTER_OPERATORS;
+  }
+  const filterDefinition = {
     oneOf: [
       {
         type: "object",
         properties: {
-          a: { type: IML_FILTER_ENTRY_TYPES },
-          o: { enum: IML_UNARY_FILTER_OPERATORS }
-        },
-        required: ["a", "o"]
-      },
-      {
-        type: "object",
-        properties: {
-          a: { type: IML_FILTER_ENTRY_TYPES },
-          b: { type: IML_FILTER_ENTRY_TYPES },
-          o: { enum: IML_BINARY_FILTER_OPERATORS }
+          a: operandSchema,
+          o: operatorSchema,
+          b: {
+            title: "Operand B",
+            description: "The second operand of the filter.",
+            type: IML_FILTER_ENTRY_TYPES
+          }
         },
         required: ["a", "b", "o"]
       }
     ]
   };
+  if (!operatorOptions) {
+    filterDefinition.oneOf?.push({
+      type: "object",
+      properties: {
+        a: operandSchema,
+        o: {
+          ...operatorSchema,
+          enum: IML_UNARY_FILTER_OPERATORS
+        }
+      },
+      required: ["a", "o"]
+    });
+  }
   const logic = field.logic ?? "default";
-  result.items = ["and", "or"].includes(logic) ? filterItems : {
+  result.items = ["and", "or"].includes(logic) ? filterDefinition : {
     type: "array",
-    items: filterItems
+    items: filterDefinition
   };
   Object.defineProperty(result, "x-filter", {
     configurable: true,
@@ -433,9 +494,7 @@ function handleSelectOrPathType(field, result, context) {
       }
     });
   }
-  const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : void 0;
-  const nestedContainsStrings = Array.isArray(nested) && nested.some((item) => typeof item === "string");
-  const domain = isObject(field.options) ? isObject(field.options.nested) && field.options.nested.domain ? field.options.nested.domain : void 0 : void 0;
+  const { nested, domain } = extractNestedAndDomain(field);
   if (typeof optionsOrGroups === "string") {
     Object.defineProperty(result, "x-fetch", {
       configurable: true,
@@ -504,46 +563,7 @@ function handleSelectOrPathType(field, result, context) {
       result.enum = (options || []).map((option) => option.value);
     }
   }
-  if (nested && domain && domain !== context.domain) {
-    const normalizedNested = typeof nested === "string" ? [nested] : nested;
-    let root = context.roots[domain];
-    if (!root) {
-      const buffer = [];
-      root = context.roots[domain] = {
-        buffer,
-        addFields: (nested2, tail) => {
-          buffer.push(...nested2.map((field2) => ({ field: field2, tail })));
-        }
-      };
-    }
-    root.addFields(normalizedNested, [...context.tail, field.name]);
-  } else if (nested) {
-    Object.defineProperty(result, "x-nested", {
-      configurable: true,
-      enumerable: true,
-      writable: true,
-      value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : nestedContainsStrings ? {
-        type: "object",
-        allOf: nested.map(
-          (item) => typeof item === "string" ? { $ref: appendQueryString(item, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
-            { type: "collection", spec: [item] },
-            {
-              ...context,
-              domain: domain || context.domain,
-              tail: [...context.tail, field.name]
-            }
-          )
-        )
-      } : toJSONSchemaInternal(
-        { type: "collection", spec: nested },
-        {
-          ...context,
-          domain: domain || context.domain,
-          tail: [...context.tail, field.name]
-        }
-      )
-    });
-  }
+  result = handleNestedWithDomain(field, nested, domain, result, context);
   if (field.rpc) result = processRpcDirective(field, result, context);
   return result;
 }
@@ -566,6 +586,10 @@ function handlePrimitiveType(field, result, context) {
     }
   }
   if (field.rpc) result = processRpcDirective(field, result, context);
+  if (field.nested) {
+    const { nested, domain } = extractNestedAndDomain(field);
+    result = handleNestedWithDomain(field, nested, domain, result, context);
+  }
   return result;
 }
 function processRpcDirective(field, result, context) {
@@ -582,6 +606,60 @@ 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 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 };
+}
+function handleNestedWithDomain(field, nested, domain, result, context) {
+  if (!nested) return result;
+  if (domain && domain !== context.domain) {
+    const normalizedNested = typeof nested === "string" ? [nested] : nested;
+    let root = context.roots[domain];
+    if (!root) {
+      const buffer = [];
+      root = context.roots[domain] = {
+        buffer,
+        addFields: (nested2, tail) => {
+          buffer.push(...nested2.map((field2) => ({ field: field2, tail })));
+        }
+      };
+    }
+    root.addFields(normalizedNested, [...context.tail, field.name]);
+    return result;
+  }
+  return processNestedDirective(field, nested, domain, result, context);
+}
+function processNestedDirective(field, nested, domain, result, context) {
+  if (!nested) return result;
+  const nestedContainsStrings = Array.isArray(nested) && nested.some((item) => typeof item === "string");
+  Object.defineProperty(result, "x-nested", {
+    configurable: true,
+    enumerable: true,
+    writable: true,
+    value: typeof nested === "string" ? { $ref: appendQueryString(nested, context.domain, [...context.tail, field.name]) } : nestedContainsStrings ? {
+      type: "object",
+      allOf: nested.map(
+        (item) => typeof item === "string" ? { $ref: appendQueryString(item, context.domain, [...context.tail, field.name]) } : toJSONSchemaInternal(
+          { type: "collection", spec: [item] },
+          {
+            ...context,
+            domain: domain || context.domain,
+            tail: [...context.tail, field.name]
+          }
+        )
+      )
+    } : toJSONSchemaInternal(
+      { type: "collection", spec: nested },
+      {
+        ...context,
+        domain: domain || context.domain,
+        tail: [...context.tail, field.name]
+      }
+    )
+  });
+  return result;
+}
 
 // src/validator.ts
 var FORMAN_TYPE_MAP2 = {
@@ -903,24 +981,40 @@ async function handleArrayType2(value, field, context) {
   };
 }
 async function handleFilterType2(value, field, context) {
+  const operandOptions = isObject(field.options) ? field.options.store : field.options;
+  const operandSpec = {
+    name: "a",
+    type: "any",
+    required: true
+  };
+  if (Array.isArray(operandOptions)) {
+    operandSpec.type = "select";
+    operandSpec.options = operandOptions;
+  }
+  const operatorOptions = isObject(field.options) ? field.options.operators : void 0;
+  const operatorSpec = {
+    name: "o",
+    type: "any",
+    required: true
+  };
+  if (Array.isArray(operatorOptions)) {
+    operatorSpec.type = "select";
+    operatorSpec.grouped = true;
+    operatorSpec.options = operatorOptions;
+  } else {
+    operatorSpec.type = "text";
+    operatorSpec.validate = {
+      enum: IML_FILTER_OPERATORS
+    };
+  }
   const filterEntry = {
     type: "collection",
     spec: [
-      {
-        name: "a",
-        type: "any",
-        required: true
-      },
+      operandSpec,
+      operatorSpec,
       {
         name: "b",
         type: "any"
-      },
-      {
-        name: "o",
-        type: "text",
-        validate: {
-          enum: IML_FILTER_OPERATORS
-        }
       }
     ]
   };

package/package.json

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