@makehq/forman-schema 1.5.0 → 1.6.0

package/README.md

@@ -185,6 +185,7 @@ const result = await validateFormanWithDomains(
 - email → string
 - file → string
 - filename → string
+- filter → array
 - folder → string
 - hidden → string
 - hook → number

package/dist/index.cjs

@@ -152,6 +152,67 @@ function buildRestoreStructure(items) {
   }
   return result;
 }
+var IML_FILTER_ENTRY_TYPES = ["null", "boolean", "number", "string"];
+var IML_UNARY_FILTER_OPERATORS = ["exist", "notexist"];
+var IML_BINARY_FILTER_OPERATORS = [
+  "text:equal",
+  "text:equal:ci",
+  "text:notequal",
+  "text:notequal:ci",
+  "text:contain",
+  "text:contain:ci",
+  "text:notcontain",
+  "text:notcontain:ci",
+  "text:startwith",
+  "text:startwith:ci",
+  "text:notstartwith",
+  "text:notstartwith:ci",
+  "text:endwith",
+  "text:endwith:ci",
+  "text:notendwith",
+  "text:notendwith:ci",
+  "text:pattern",
+  "text:pattern:ci",
+  "text:notpattern",
+  "text:notpattern:ci",
+  "number:equal",
+  "number:notequal",
+  "number:greater",
+  "number:less",
+  "number:greaterorequal",
+  "number:lessorequal",
+  "date:equal",
+  "date:notequal",
+  "date:greater",
+  "date:less",
+  "date:greaterorequal",
+  "date:lessorequal",
+  "time:equal",
+  "time:notequal",
+  "time:greater",
+  "time:less",
+  "time:greaterorequal",
+  "time:lessorequal",
+  "semver:equal",
+  "semver:notequal",
+  "semver:greater",
+  "semver:less",
+  "semver:greaterorequal",
+  "semver:lessorequal",
+  "array:contain",
+  "array:contain:ci",
+  "array:notcontain",
+  "array:notcontain:ci",
+  "array:equal",
+  "array:notequal",
+  "array:greater",
+  "array:less",
+  "array:greaterorequal",
+  "array:lessorequal",
+  "boolean:equal",
+  "boolean:notequal"
+];
+var IML_FILTER_OPERATORS = [...IML_UNARY_FILTER_OPERATORS, ...IML_BINARY_FILTER_OPERATORS];
 
 // src/forman.ts
 var SchemaConversionError = class extends Error {
@@ -187,6 +248,7 @@ var FORMAN_TYPE_MAP = {
   email: "string",
   filename: "string",
   file: "string",
+  filter: "array",
   folder: "string",
   hidden: void 0,
   integer: "number",
@@ -253,6 +315,8 @@ function toJSONSchemaInternal(field, context = createDefaultContext()) {
     case "file":
     case "folder":
       return handleSelectType(normalizedField, result, context);
+    case "filter":
+      return handleFilterType(normalizedField, result, context);
     default:
       return handlePrimitiveType(normalizedField, result);
   }
@@ -329,6 +393,41 @@ function handleArrayType(field, result, context) {
   }
   return result;
 }
+function handleFilterType(field, result, context) {
+  const filterItems = {
+    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 }
+        },
+        required: ["a", "b", "o"]
+      }
+    ]
+  };
+  const logic = field.logic ?? "default";
+  result.items = ["and", "or"].includes(logic) ? filterItems : {
+    type: "array",
+    items: filterItems
+  };
+  Object.defineProperty(result, "x-filter", {
+    configurable: true,
+    enumerable: true,
+    writable: true,
+    value: logic
+  });
+  return result;
+}
 function handleSelectType(field, result, context) {
   const optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
   const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : void 0;
@@ -485,6 +584,7 @@ var FORMAN_TYPE_MAP2 = {
   email: "string",
   filename: "string",
   file: "string",
+  filter: "array",
   folder: "string",
   hidden: void 0,
   integer: "number",
@@ -648,6 +748,8 @@ async function validateFormanValue(value, field, context) {
     case "file":
     case "folder":
       return handleSelectType2(value, normalizedField, context);
+    case "filter":
+      return handleFilterType2(value, normalizedField, context);
     default:
       return handlePrimitiveType2(value, normalizedField, context);
   }
@@ -774,6 +876,42 @@ async function handleArrayType2(value, field, context) {
     errors
   };
 }
+async function handleFilterType2(value, field, context) {
+  const filterEntry = {
+    type: "collection",
+    spec: [
+      {
+        name: "a",
+        type: "any",
+        required: true
+      },
+      {
+        name: "b",
+        type: "any"
+      },
+      {
+        name: "o",
+        type: "text",
+        validate: {
+          enum: IML_FILTER_OPERATORS
+        }
+      }
+    ]
+  };
+  const inlineSchema = ["and", "or"].includes(field.logic ?? "default") ? {
+    name: field.name,
+    type: "array",
+    spec: filterEntry
+  } : {
+    name: field.name,
+    type: "array",
+    spec: {
+      type: "array",
+      spec: filterEntry
+    }
+  };
+  return handleArrayType2(value, inlineSchema, context);
+}
 async function handleSelectType2(value, field, context) {
   const errors = [];
   let optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
@@ -1018,6 +1156,15 @@ function toFormanSchema(field) {
         spec
       };
     case "array":
+      const filterLogic = Object.getOwnPropertyDescriptor(field, "x-filter");
+      if (filterLogic) {
+        return {
+          type: "filter",
+          label: noEmpty(field.title),
+          help: noEmpty(field.description),
+          logic: filterLogic.value === "default" ? void 0 : filterLogic.value
+        };
+      }
       const items = field.items && isObject(field.items) ? field.items : void 0;
       const formanSchema = {
         type: "array",

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' | 'date' | 'json' | 'buffer' | 'cert' | 'color' | 'email' | 'filename' | 'file' | 'folder' | 'hidden' | 'integer' | 'uinteger' | 'path' | 'pkey' | 'port' | 'select' | 'time' | 'timestamp' | 'timezone' | 'url' | 'uuid' | `account:${string}` | `hook:${string}` | `keychain:${string}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
+type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'device' | 'keychain' | 'datastore' | 'udt' | 'scenario' | 'array' | 'collection' | 'text' | 'number' | 'boolean' | '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}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
 /**
  * Validation configuration for Forman Schema fields
  */
@@ -79,6 +79,8 @@ type FormanSchemaField = {
     sort?: string;
     /** Adds an extra button to the field which opens an extra form. When the form is submitted, a specified RPC is called and the result is set as a new value of the parameter. */
     rpc?: FormanSchemaRPCButton;
+    /** Definition of boolean logic to apply (filter only) */
+    logic?: 'and' | 'or' | 'reverse';
 } & Record<`x-${string}`, unknown>;
 /**
  * RPC button allows for dynamic value retrieval from an external source

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' | 'date' | 'json' | 'buffer' | 'cert' | 'color' | 'email' | 'filename' | 'file' | 'folder' | 'hidden' | 'integer' | 'uinteger' | 'path' | 'pkey' | 'port' | 'select' | 'time' | 'timestamp' | 'timezone' | 'url' | 'uuid' | `account:${string}` | `hook:${string}` | `keychain:${string}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
+type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'device' | 'keychain' | 'datastore' | 'udt' | 'scenario' | 'array' | 'collection' | 'text' | 'number' | 'boolean' | '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}` | 'banner' | 'markdown' | 'html' | 'separator' | string;
 /**
  * Validation configuration for Forman Schema fields
  */
@@ -79,6 +79,8 @@ type FormanSchemaField = {
     sort?: string;
     /** Adds an extra button to the field which opens an extra form. When the form is submitted, a specified RPC is called and the result is set as a new value of the parameter. */
     rpc?: FormanSchemaRPCButton;
+    /** Definition of boolean logic to apply (filter only) */
+    logic?: 'and' | 'or' | 'reverse';
 } & Record<`x-${string}`, unknown>;
 /**
  * RPC button allows for dynamic value retrieval from an external source

package/dist/index.js

@@ -123,6 +123,67 @@ function buildRestoreStructure(items) {
   }
   return result;
 }
+var IML_FILTER_ENTRY_TYPES = ["null", "boolean", "number", "string"];
+var IML_UNARY_FILTER_OPERATORS = ["exist", "notexist"];
+var IML_BINARY_FILTER_OPERATORS = [
+  "text:equal",
+  "text:equal:ci",
+  "text:notequal",
+  "text:notequal:ci",
+  "text:contain",
+  "text:contain:ci",
+  "text:notcontain",
+  "text:notcontain:ci",
+  "text:startwith",
+  "text:startwith:ci",
+  "text:notstartwith",
+  "text:notstartwith:ci",
+  "text:endwith",
+  "text:endwith:ci",
+  "text:notendwith",
+  "text:notendwith:ci",
+  "text:pattern",
+  "text:pattern:ci",
+  "text:notpattern",
+  "text:notpattern:ci",
+  "number:equal",
+  "number:notequal",
+  "number:greater",
+  "number:less",
+  "number:greaterorequal",
+  "number:lessorequal",
+  "date:equal",
+  "date:notequal",
+  "date:greater",
+  "date:less",
+  "date:greaterorequal",
+  "date:lessorequal",
+  "time:equal",
+  "time:notequal",
+  "time:greater",
+  "time:less",
+  "time:greaterorequal",
+  "time:lessorequal",
+  "semver:equal",
+  "semver:notequal",
+  "semver:greater",
+  "semver:less",
+  "semver:greaterorequal",
+  "semver:lessorequal",
+  "array:contain",
+  "array:contain:ci",
+  "array:notcontain",
+  "array:notcontain:ci",
+  "array:equal",
+  "array:notequal",
+  "array:greater",
+  "array:less",
+  "array:greaterorequal",
+  "array:lessorequal",
+  "boolean:equal",
+  "boolean:notequal"
+];
+var IML_FILTER_OPERATORS = [...IML_UNARY_FILTER_OPERATORS, ...IML_BINARY_FILTER_OPERATORS];
 
 // src/forman.ts
 var SchemaConversionError = class extends Error {
@@ -158,6 +219,7 @@ var FORMAN_TYPE_MAP = {
   email: "string",
   filename: "string",
   file: "string",
+  filter: "array",
   folder: "string",
   hidden: void 0,
   integer: "number",
@@ -224,6 +286,8 @@ function toJSONSchemaInternal(field, context = createDefaultContext()) {
     case "file":
     case "folder":
       return handleSelectType(normalizedField, result, context);
+    case "filter":
+      return handleFilterType(normalizedField, result, context);
     default:
       return handlePrimitiveType(normalizedField, result);
   }
@@ -300,6 +364,41 @@ function handleArrayType(field, result, context) {
   }
   return result;
 }
+function handleFilterType(field, result, context) {
+  const filterItems = {
+    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 }
+        },
+        required: ["a", "b", "o"]
+      }
+    ]
+  };
+  const logic = field.logic ?? "default";
+  result.items = ["and", "or"].includes(logic) ? filterItems : {
+    type: "array",
+    items: filterItems
+  };
+  Object.defineProperty(result, "x-filter", {
+    configurable: true,
+    enumerable: true,
+    writable: true,
+    value: logic
+  });
+  return result;
+}
 function handleSelectType(field, result, context) {
   const optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
   const nested = isObject(field.options) ? isObject(field.options.nested) ? field.options.nested.store : field.options.nested : void 0;
@@ -456,6 +555,7 @@ var FORMAN_TYPE_MAP2 = {
   email: "string",
   filename: "string",
   file: "string",
+  filter: "array",
   folder: "string",
   hidden: void 0,
   integer: "number",
@@ -619,6 +719,8 @@ async function validateFormanValue(value, field, context) {
     case "file":
     case "folder":
       return handleSelectType2(value, normalizedField, context);
+    case "filter":
+      return handleFilterType2(value, normalizedField, context);
     default:
       return handlePrimitiveType2(value, normalizedField, context);
   }
@@ -745,6 +847,42 @@ async function handleArrayType2(value, field, context) {
     errors
   };
 }
+async function handleFilterType2(value, field, context) {
+  const filterEntry = {
+    type: "collection",
+    spec: [
+      {
+        name: "a",
+        type: "any",
+        required: true
+      },
+      {
+        name: "b",
+        type: "any"
+      },
+      {
+        name: "o",
+        type: "text",
+        validate: {
+          enum: IML_FILTER_OPERATORS
+        }
+      }
+    ]
+  };
+  const inlineSchema = ["and", "or"].includes(field.logic ?? "default") ? {
+    name: field.name,
+    type: "array",
+    spec: filterEntry
+  } : {
+    name: field.name,
+    type: "array",
+    spec: {
+      type: "array",
+      spec: filterEntry
+    }
+  };
+  return handleArrayType2(value, inlineSchema, context);
+}
 async function handleSelectType2(value, field, context) {
   const errors = [];
   let optionsOrGroups = isObject(field.options) ? field.options.store : field.options;
@@ -989,6 +1127,15 @@ function toFormanSchema(field) {
         spec
       };
     case "array":
+      const filterLogic = Object.getOwnPropertyDescriptor(field, "x-filter");
+      if (filterLogic) {
+        return {
+          type: "filter",
+          label: noEmpty(field.title),
+          help: noEmpty(field.description),
+          logic: filterLogic.value === "default" ? void 0 : filterLogic.value
+        };
+      }
       const items = field.items && isObject(field.items) ? field.items : void 0;
       const formanSchema = {
         type: "array",

package/package.json

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