@makehq/forman-schema 1.2.5 → 1.3.0

package/dist/index.d.cts

@@ -3,13 +3,15 @@ import { JSONSchema7 } from 'json-schema';
 /**
  * Valid Forman Schema field types
  */
-type FormanSchemaFieldType = 'account' | 'hook' | 'keychain' | 'datastore' | 'aiagent' | '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}` | string;
+type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'keychain' | 'datastore' | 'udt' | '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;
 /**
  * Validation configuration for Forman Schema fields
  */
 interface FormanSchemaValidation {
     /** Pattern for string validation */
-    pattern?: string;
+    pattern?: string | {
+        regexp: string;
+    };
     /** Minimum value */
     min?: number;
     /** Maximum value */
@@ -53,6 +55,8 @@ type FormanSchemaField = {
     mappable?: boolean;
     /** Whether the user will be able to insert new lines in GUI (a textarea will be displayed instead of the text field) */
     multiline?: boolean;
+    /** Whether the select field allows multiple values */
+    multiple?: boolean;
     /** Specifies how to treat HTML tags in the field (text only) */
     tags?: 'strip' | 'stripall' | 'escape';
     /** Allowed extension or array of allowed extensions. (filename only) */
@@ -121,6 +125,15 @@ type FormanSchemaExtendedOptions = {
     store: FormanSchemaOption[] | FormanSchemaOptionGroup[] | string;
     /** Nested fields for every option */
     nested?: FormanSchemaNested;
+    /** Name of the property as the label of an option */
+    label?: string;
+    /** Name of the property as the value of an option */
+    value?: string;
+    /** Label to display when no value is selected */
+    placeholder?: string | {
+        label: string;
+        nested?: FormanSchemaNested;
+    };
 };
 /**
  * Nested fields
@@ -135,6 +148,28 @@ type FormanSchemaExtendedNested = {
     /** Domain for the nested fields */
     domain?: string;
 };
+/**
+ * Validation result
+ */
+type FormanValidationResult = {
+    /** Whether the object is valid */
+    valid: boolean;
+    /** Errors */
+    errors: {
+        /** Field domain */
+        domain: string;
+        /** Field path */
+        path: string;
+        /** Error message */
+        message: string;
+    }[];
+};
+type FormanValidationOptions = {
+    /** Unknown fields are not allowed when strict is true */
+    strict?: boolean;
+    /** Remote resource resolver */
+    resolveRemote?(path: string, data: Record<string, unknown>): Promise<unknown>;
+};
 
 /**
  * Converts a JSON Schema field to its Forman Schema equivalent.
@@ -149,5 +184,23 @@ declare function toFormanSchema(field: JSONSchema7): FormanSchemaField;
  * @returns The equivalent JSON Schema field
  */
 declare function toJSONSchema(field: FormanSchemaField): JSONSchema7;
+/**
+ * Validates a Forman domains against schemas
+ * @param domains The domains to validate
+ * @param options The validation options
+ * @returns The validation result
+ */
+declare function validateFormanWithDomains(domains: Record<string, {
+    values: Record<string, unknown>;
+    schema: FormanSchemaField[];
+}>, options?: FormanValidationOptions): Promise<FormanValidationResult>;
+/**
+ * Validates a simple Forman values against a schema
+ * @param values The values to validate
+ * @param schema The schema to validate against
+ * @param options The validation options
+ * @returns The validation result
+ */
+declare function validateForman(values: Record<string, unknown>, schema: FormanSchemaField[], options?: FormanValidationOptions): Promise<FormanValidationResult>;
 
-export { type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaRPCButton, type FormanSchemaValue, toFormanSchema, toJSONSchema };
+export { type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaRPCButton, type FormanSchemaValue, toFormanSchema, toJSONSchema, validateForman, validateFormanWithDomains };

package/dist/index.d.ts

@@ -3,13 +3,15 @@ import { JSONSchema7 } from 'json-schema';
 /**
  * Valid Forman Schema field types
  */
-type FormanSchemaFieldType = 'account' | 'hook' | 'keychain' | 'datastore' | 'aiagent' | '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}` | string;
+type FormanSchemaFieldType = 'aiagent' | 'account' | 'hook' | 'keychain' | 'datastore' | 'udt' | '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;
 /**
  * Validation configuration for Forman Schema fields
  */
 interface FormanSchemaValidation {
     /** Pattern for string validation */
-    pattern?: string;
+    pattern?: string | {
+        regexp: string;
+    };
     /** Minimum value */
     min?: number;
     /** Maximum value */
@@ -53,6 +55,8 @@ type FormanSchemaField = {
     mappable?: boolean;
     /** Whether the user will be able to insert new lines in GUI (a textarea will be displayed instead of the text field) */
     multiline?: boolean;
+    /** Whether the select field allows multiple values */
+    multiple?: boolean;
     /** Specifies how to treat HTML tags in the field (text only) */
     tags?: 'strip' | 'stripall' | 'escape';
     /** Allowed extension or array of allowed extensions. (filename only) */
@@ -121,6 +125,15 @@ type FormanSchemaExtendedOptions = {
     store: FormanSchemaOption[] | FormanSchemaOptionGroup[] | string;
     /** Nested fields for every option */
     nested?: FormanSchemaNested;
+    /** Name of the property as the label of an option */
+    label?: string;
+    /** Name of the property as the value of an option */
+    value?: string;
+    /** Label to display when no value is selected */
+    placeholder?: string | {
+        label: string;
+        nested?: FormanSchemaNested;
+    };
 };
 /**
  * Nested fields
@@ -135,6 +148,28 @@ type FormanSchemaExtendedNested = {
     /** Domain for the nested fields */
     domain?: string;
 };
+/**
+ * Validation result
+ */
+type FormanValidationResult = {
+    /** Whether the object is valid */
+    valid: boolean;
+    /** Errors */
+    errors: {
+        /** Field domain */
+        domain: string;
+        /** Field path */
+        path: string;
+        /** Error message */
+        message: string;
+    }[];
+};
+type FormanValidationOptions = {
+    /** Unknown fields are not allowed when strict is true */
+    strict?: boolean;
+    /** Remote resource resolver */
+    resolveRemote?(path: string, data: Record<string, unknown>): Promise<unknown>;
+};
 
 /**
  * Converts a JSON Schema field to its Forman Schema equivalent.
@@ -149,5 +184,23 @@ declare function toFormanSchema(field: JSONSchema7): FormanSchemaField;
  * @returns The equivalent JSON Schema field
  */
 declare function toJSONSchema(field: FormanSchemaField): JSONSchema7;
+/**
+ * Validates a Forman domains against schemas
+ * @param domains The domains to validate
+ * @param options The validation options
+ * @returns The validation result
+ */
+declare function validateFormanWithDomains(domains: Record<string, {
+    values: Record<string, unknown>;
+    schema: FormanSchemaField[];
+}>, options?: FormanValidationOptions): Promise<FormanValidationResult>;
+/**
+ * Validates a simple Forman values against a schema
+ * @param values The values to validate
+ * @param schema The schema to validate against
+ * @param options The validation options
+ * @returns The validation result
+ */
+declare function validateForman(values: Record<string, unknown>, schema: FormanSchemaField[], options?: FormanValidationOptions): Promise<FormanValidationResult>;
 
-export { type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaRPCButton, type FormanSchemaValue, toFormanSchema, toJSONSchema };
+export { type FormanSchemaExtendedNested, type FormanSchemaExtendedOptions, type FormanSchemaField, type FormanSchemaFieldType, type FormanSchemaNested, type FormanSchemaOption, type FormanSchemaOptionGroup, type FormanSchemaRPCButton, type FormanSchemaValue, toFormanSchema, toJSONSchema, validateForman, validateFormanWithDomains };