@epilot/sdk 2.20.7 → 2.20.8

package/dist/{validation-rules.d-D8X9MYTc.d.ts → validation-rules.d-Bbo90IYn.d.ts}

@@ -216,7 +216,20 @@ declare namespace Components {
              * external (app-provided) comparison values.
              *
              */
-            ComparisonRuleType;
+            ComparisonRuleType | /**
+             * Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
+             * the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
+             * (file type, size, page count, image resolution, blank and password-protected detection) are
+             * deterministic and available at every level; the `meetsCriteria` condition judges a free-text
+             * requirement against the document's extracted content and is available from level `standard`.
+             *
+             * Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
+             * pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
+             * result is always reported as advisory and never fails the input, regardless of `allow_failure`.
+             * Document rules carry no `contexts` yet.
+             *
+             */
+            DocumentRuleType;
             /**
              * Declares the dynamic context a v2 rule needs at evaluation time.
              * `context` condition values reference these sources by using the schema slug
@@ -233,6 +246,108 @@ declare namespace Components {
              */
             ContextRequirement[];
         }
+        /**
+         * A free-text requirement judged against the document's extracted content, e.g. "The photo shows
+         * an electricity meter with the meter number and the current reading fully legible." One requirement
+         * per condition keeps results specific and lets each requirement be graded separately.
+         *
+         */
+        export interface CriteriaValue {
+            source: "criteria";
+            text: string;
+        }
+        /**
+         * How deep the document check goes. Levels are cumulative.
+         */
+        export interface DocumentCheck {
+            /**
+             * - `basic`: file properties only (type, size, page count, resolution, blank, password). Instant, no extraction.
+             * - `standard`: basic checks plus a quick scan of the content. A few seconds.
+             * - `advanced`: basic checks plus a thorough reading of the fully extracted content. Roughly 5 to 10 seconds.
+             *
+             */
+            level: "basic" | "standard" | "advanced";
+        }
+        /**
+         * A single check the uploaded file must satisfy.
+         */
+        export interface DocumentCondition {
+            /**
+             * Stable identifier of the condition within the rule, used for editing and error reporting.
+             */
+            id: string;
+            operator: /**
+             * Predefined document check. Value compatibility (enforced at write time):
+             * - fileTypeIn: `file_types` value listing the accepted file categories.
+             * - sizeBelow: static integer, maximum file size in bytes.
+             * - pageCountBetween: `range` of static non-negative integers (inclusive).
+             * - resolutionAtLeast / resolutionAtMost: static positive integer, the image's longer edge in pixels.
+             * - isNotBlank / isNotPasswordProtected: `none` value (unary).
+             * - meetsCriteria: `criteria` value with the free-text requirement. Requires check level `standard` or `advanced`.
+             *
+             */
+            DocumentOperator;
+            value: /* The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion. */ DocumentConditionValue;
+            /**
+             * Message shown to the end user when this condition fails.
+             */
+            error_message: string;
+            /**
+             * When true, the condition is advisory: a failure is reported but never takes part in the
+             * validity verdict. Recommended for `meetsCriteria` until the organisation has reviewed
+             * results on real files.
+             *
+             */
+            allow_failure?: boolean;
+        }
+        /**
+         * The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion.
+         */
+        export type DocumentConditionValue = /* The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion. */ /* A fixed comparison value. */ StaticValue | /* A lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive. */ RangeValue | /* No comparison value - used by unary operators such as notInFuture / notInPast. */ NoValue | /* Accepted file categories; each category expands to a mime list at check time. */ FileTypesValue | /**
+         * A free-text requirement judged against the document's extracted content, e.g. "The photo shows
+         * an electricity meter with the meter number and the current reading fully legible." One requirement
+         * per condition keeps results specific and lets each requirement be graded separately.
+         *
+         */
+        CriteriaValue;
+        /**
+         * Predefined document check. Value compatibility (enforced at write time):
+         * - fileTypeIn: `file_types` value listing the accepted file categories.
+         * - sizeBelow: static integer, maximum file size in bytes.
+         * - pageCountBetween: `range` of static non-negative integers (inclusive).
+         * - resolutionAtLeast / resolutionAtMost: static positive integer, the image's longer edge in pixels.
+         * - isNotBlank / isNotPasswordProtected: `none` value (unary).
+         * - meetsCriteria: `criteria` value with the free-text requirement. Requires check level `standard` or `advanced`.
+         *
+         */
+        export type DocumentOperator = "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria";
+        /**
+         * Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
+         * the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
+         * (file type, size, page count, image resolution, blank and password-protected detection) are
+         * deterministic and available at every level; the `meetsCriteria` condition judges a free-text
+         * requirement against the document's extracted content and is available from level `standard`.
+         *
+         * Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
+         * pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
+         * result is always reported as advisory and never fails the input, regardless of `allow_failure`.
+         * Document rules carry no `contexts` yet.
+         *
+         */
+        export interface DocumentRuleType {
+            /**
+             * Identifies the rule as a document rule. Determines which operators are allowed.
+             */
+            input_type: "document";
+            check: /* How deep the document check goes. Levels are cumulative. */ DocumentCheck;
+            /**
+             * The checks the uploaded file must satisfy. All blocking conditions must pass for the
+             * file to be valid; `allow_failure` conditions are advisory. Must contain at least one
+             * condition (enforced at write time).
+             *
+             */
+            conditions: /* A single check the uploaded file must satisfy. */ DocumentCondition[];
+        }
         /**
          * A comparison value resolved at evaluation time from an organisation environment variable
          * (environments-api). The rule stores the key, never the value, so one change to the variable
@@ -293,6 +408,16 @@ declare namespace Components {
              */
             ValueAdjustment;
         }
+        /**
+         * Accepted file categories; each category expands to a mime list at check time.
+         */
+        export interface FileTypesValue {
+            source: "file_types";
+            types: [
+                ("image" | "pdf" | "document" | "spreadsheet"),
+                ...("image" | "pdf" | "document" | "spreadsheet")[]
+            ];
+        }
         /**
          * Response envelope for listing all validation rules within an organization.
          */
@@ -765,7 +890,20 @@ declare namespace Components {
              * external (app-provided) comparison values.
              *
              */
-            ComparisonRuleType;
+            ComparisonRuleType | /**
+             * Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
+             * the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
+             * (file type, size, page count, image resolution, blank and password-protected detection) are
+             * deterministic and available at every level; the `meetsCriteria` condition judges a free-text
+             * requirement against the document's extracted content and is available from level `standard`.
+             *
+             * Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
+             * pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
+             * result is always reported as advisory and never fails the input, regardless of `allow_failure`.
+             * Document rules carry no `contexts` yet.
+             *
+             */
+            DocumentRuleType;
             /**
              * Declares the dynamic context a v2 rule needs at evaluation time.
              * `context` condition values reference these sources by using the schema slug
@@ -840,7 +978,20 @@ declare namespace Components {
              * external (app-provided) comparison values.
              *
              */
-            ComparisonRuleType;
+            ComparisonRuleType | /**
+             * Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
+             * the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
+             * (file type, size, page count, image resolution, blank and password-protected detection) are
+             * deterministic and available at every level; the `meetsCriteria` condition judges a free-text
+             * requirement against the document's extracted content and is available from level `standard`.
+             *
+             * Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
+             * pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
+             * result is always reported as advisory and never fails the input, regardless of `allow_failure`.
+             * Document rules carry no `contexts` yet.
+             *
+             */
+            DocumentRuleType;
             /**
              * Declares the dynamic context a v2 rule needs at evaluation time.
              * `context` condition values reference these sources by using the schema slug
@@ -912,7 +1063,20 @@ declare namespace Components {
              * external (app-provided) comparison values.
              *
              */
-            ComparisonRuleType;
+            ComparisonRuleType | /**
+             * Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
+             * the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
+             * (file type, size, page count, image resolution, blank and password-protected detection) are
+             * deterministic and available at every level; the `meetsCriteria` condition judges a free-text
+             * requirement against the document's extracted content and is available from level `standard`.
+             *
+             * Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
+             * pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
+             * result is always reported as advisory and never fails the input, regardless of `allow_failure`.
+             * Document rules carry no `contexts` yet.
+             *
+             */
+            DocumentRuleType;
             /**
              * Declares the dynamic context a v2 rule needs at evaluation time.
              * `context` condition values reference these sources by using the schema slug
@@ -1044,7 +1208,7 @@ declare namespace Paths {
                  * Invalid request body
                  */
                 message?: string;
-                code?: "external_value_not_found" | "external_value_incompatible";
+                code?: "external_value_not_found" | "external_value_incompatible" | "environment_variable_not_found" | "environment_variable_incompatible";
             }
             export interface $401 {
                 /**
@@ -1252,7 +1416,7 @@ declare namespace Paths {
                  * Invalid request body
                  */
                 message?: string;
-                code?: "external_value_not_found" | "external_value_incompatible";
+                code?: "external_value_not_found" | "external_value_incompatible" | "environment_variable_not_found" | "environment_variable_incompatible";
             }
             export interface $401 {
                 /**
@@ -1467,8 +1631,15 @@ type ConditionValue = Components.Schemas.ConditionValue;
 type ContextRequirement = Components.Schemas.ContextRequirement;
 type ContextValue = Components.Schemas.ContextValue;
 type CreateValidationRuleRequest = Components.Schemas.CreateValidationRuleRequest;
+type CriteriaValue = Components.Schemas.CriteriaValue;
+type DocumentCheck = Components.Schemas.DocumentCheck;
+type DocumentCondition = Components.Schemas.DocumentCondition;
+type DocumentConditionValue = Components.Schemas.DocumentConditionValue;
+type DocumentOperator = Components.Schemas.DocumentOperator;
+type DocumentRuleType = Components.Schemas.DocumentRuleType;
 type EnvironmentValue = Components.Schemas.EnvironmentValue;
 type ExternalValue = Components.Schemas.ExternalValue;
+type FileTypesValue = Components.Schemas.FileTypesValue;
 type GetValidationRulesResponse = Components.Schemas.GetValidationRulesResponse;
 type NoValue = Components.Schemas.NoValue;
 type NumericCondition = Components.Schemas.NumericCondition;
@@ -1494,4 +1665,4 @@ type ValidationRule = Components.Schemas.ValidationRule;
 type ValidationRuleBase = Components.Schemas.ValidationRuleBase;
 type ValueAdjustment = Components.Schemas.ValueAdjustment;
 
-export { type AppliesWhen as A, type ValueAdjustment as B, type Client as C, type EnvironmentValue as E, type GetValidationRulesResponse as G, type NoValue as N, type OperationMethods as O, Paths as P, type RangeValue as R, type ScalarValue as S, type UpdateValidationRuleRequest as U, type ValidationRule as V, Components as a, type PathsDictionary as b, type ComparisonRuleType as c, type Condition as d, type ConditionValue as e, type ContextRequirement as f, type ContextValue as g, type CreateValidationRuleRequest as h, type ExternalValue as i, type NumericCondition as j, type NumericFactCondition as k, type NumericNestedCondition as l, type NumericRuleType as m, type Operator as n, type PatternCondition as o, type PatternFactCondition as p, type PatternNestedCondition as q, type PatternRuleType as r, type RegexCondition as s, type RegexFactCondition as t, type RegexNestedCondition as u, type RegexRuleType as v, type RelativeDateValue as w, type StaticValue as x, type UsedBy as y, type ValidationRuleBase as z };
+export { type AppliesWhen as A, type RegexRuleType as B, type Client as C, type DocumentCheck as D, type EnvironmentValue as E, type FileTypesValue as F, type GetValidationRulesResponse as G, type RelativeDateValue as H, type StaticValue as I, type UsedBy as J, type ValidationRuleBase as K, type ValueAdjustment as L, type NoValue as N, type OperationMethods as O, Paths as P, type RangeValue as R, type ScalarValue as S, type UpdateValidationRuleRequest as U, type ValidationRule as V, Components as a, type PathsDictionary as b, type ComparisonRuleType as c, type Condition as d, type ConditionValue as e, type ContextRequirement as f, type ContextValue as g, type CreateValidationRuleRequest as h, type CriteriaValue as i, type DocumentCondition as j, type DocumentConditionValue as k, type DocumentOperator as l, type DocumentRuleType as m, type ExternalValue as n, type NumericCondition as o, type NumericFactCondition as p, type NumericNestedCondition as q, type NumericRuleType as r, type Operator as s, type PatternCondition as t, type PatternFactCondition as u, type PatternNestedCondition as v, type PatternRuleType as w, type RegexCondition as x, type RegexFactCondition as y, type RegexNestedCondition as z };

package/docs/validation-rules.md

@@ -65,6 +65,13 @@ const { data } = await validationRulesClient.getValidationRules(...)
 - [`RelativeDateValue`](#relativedatevalue)
 - [`RangeValue`](#rangevalue)
 - [`NoValue`](#novalue)
+- [`DocumentRuleType`](#documentruletype)
+- [`DocumentCheck`](#documentcheck)
+- [`DocumentCondition`](#documentcondition)
+- [`DocumentOperator`](#documentoperator)
+- [`DocumentConditionValue`](#documentconditionvalue)
+- [`FileTypesValue`](#filetypesvalue)
+- [`CriteriaValue`](#criteriavalue)
 - [`AppliesWhen`](#applieswhen)
 - [`ContextRequirement`](#contextrequirement)
 
@@ -682,6 +689,18 @@ type UpdateValidationRuleRequest = {
       applies_when?: { ... }
       allow_failure?: { ... }
     }>
+  } | {
+    input_type: "document"
+    check: {
+      level: { ... }
+    }
+    conditions: Array<{
+      id: { ... }
+      operator: { ... }
+      value: { ... }
+      error_message: { ... }
+      allow_failure?: { ... }
+    }>
   }
   contexts?: Array<{
     schema: string
@@ -737,6 +756,18 @@ type ValidationRuleBase = {
       applies_when?: { ... }
       allow_failure?: { ... }
     }>
+  } | {
+    input_type: "document"
+    check: {
+      level: { ... }
+    }
+    conditions: Array<{
+      id: { ... }
+      operator: { ... }
+      value: { ... }
+      error_message: { ... }
+      allow_failure?: { ... }
+    }>
   }
   contexts?: Array<{
     schema: string
@@ -2261,6 +2292,261 @@ type NoValue = {
 }
 ```
 
+### `DocumentRuleType`
+
+Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
+the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
+(file type, size, page count, image resolution, blank and password-protected detection) are
+deterministic and av
+
+```ts
+type DocumentRuleType = {
+  input_type: "document"
+  check: {
+    level: "basic" | "standard" | "advanced"
+  }
+  conditions: Array<{
+    id: string
+    operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"
+    value: {
+      source: { ... }
+      data: { ... }
+    } | {
+      source: { ... }
+      min: { ... }
+      max: { ... }
+    } | {
+      source: { ... }
+    } | {
+      source: { ... }
+      types: { ... }
+    } | {
+      source: { ... }
+      text: { ... }
+    }
+    error_message: string
+    allow_failure?: boolean
+  }>
+}
+```
+
+### `DocumentCheck`
+
+How deep the document check goes. Levels are cumulative.
+
+```ts
+type DocumentCheck = {
+  level: "basic" | "standard" | "advanced"
+}
+```
+
+### `DocumentCondition`
+
+A single check the uploaded file must satisfy.
+
+```ts
+type DocumentCondition = {
+  id: string
+  operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"
+  value: {
+    source: "static"
+    data: number | string | boolean
+  } | {
+    source: "range"
+    min: {
+      source: { ... }
+      data: { ... }
+    } | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      offset: { ... }
+      unit: { ... }
+      anchor?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
+    max: {
+      source: { ... }
+      data: { ... }
+    } | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      offset: { ... }
+      unit: { ... }
+      anchor?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
+  } | {
+    source: "none"
+  } | {
+    source: "file_types"
+    types: "image" | "pdf" | "document" | "spreadsheet"[]
+  } | {
+    source: "criteria"
+    text: string
+  }
+  error_message: string
+  allow_failure?: boolean
+}
+```
+
+### `DocumentOperator`
+
+Predefined document check. Value compatibility (enforced at write time):
+- fileTypeIn: `file_types` value listing the accepted file categories.
+- sizeBelow: static integer, maximum file size in bytes.
+- pageCountBetween: `range` of static non-negative integers (inclusive).
+- resolutionAtLeast / reso
+
+```ts
+type DocumentOperator = "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"
+```
+
+### `DocumentConditionValue`
+
+The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion.
+
+```ts
+type DocumentConditionValue = {
+  source: "static"
+  data: number | string | boolean
+} | {
+  source: "range"
+  min: {
+    source: "static"
+    data: number | string | boolean
+  } | {
+    source: "context"
+    path: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
+    source: "relative_date"
+    offset: number
+    unit: "days" | "months" | "years"
+    anchor?: "today"
+  } | {
+    source: "environment"
+    key: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
+    source: "external"
+    app_id: string
+    hook_id: string
+    result_id: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  }
+  max: {
+    source: "static"
+    data: number | string | boolean
+  } | {
+    source: "context"
+    path: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
+    source: "relative_date"
+    offset: number
+    unit: "days" | "months" | "years"
+    anchor?: "today"
+  } | {
+    source: "environment"
+    key: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
+    source: "external"
+    app_id: string
+    hook_id: string
+    result_id: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  }
+} | {
+  source: "none"
+} | {
+  source: "file_types"
+  types: "image" | "pdf" | "document" | "spreadsheet"[]
+} | {
+  source: "criteria"
+  text: string
+}
+```
+
+### `FileTypesValue`
+
+Accepted file categories; each category expands to a mime list at check time.
+
+```ts
+type FileTypesValue = {
+  source: "file_types"
+  types: "image" | "pdf" | "document" | "spreadsheet"[]
+}
+```
+
+### `CriteriaValue`
+
+A free-text requirement judged against the document's extracted content, e.g. "The photo shows
+an electricity meter with the meter number and the current reading fully legible." One requirement
+per condition keeps results specific and lets each requirement be graded separately.
+
+
+```ts
+type CriteriaValue = {
+  source: "criteria"
+  text: string
+}
+```
+
 ### `AppliesWhen`
 
 Optional precondition on a condition: the condition only takes part in the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.7",
+  "version": "2.20.8",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",