@epilot/sdk 2.20.8-alpha.0 → 2.20.8

package/docs/environments.md

@@ -41,14 +41,6 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
 - [`MapValue`](#mapvalue)
 - [`JsonValue`](#jsonvalue)
 - [`LinkValue`](#linkvalue)
-- [`LinkFields`](#linkfields)
-- [`ListItemType`](#listitemtype)
-- [`ListOfText`](#listoftext)
-- [`ListOfNumber`](#listofnumber)
-- [`ListOfBoolean`](#listofboolean)
-- [`ListOfJson`](#listofjson)
-- [`ListOfLink`](#listoflink)
-- [`ListValue`](#listvalue)
 - [`EnvironmentValue`](#environmentvalue)
 - [`EnvironmentVariable`](#environmentvariable)
 - [`EnvironmentVariableListItem`](#environmentvariablelistitem)
@@ -302,12 +294,12 @@ const { data } = await client.deleteEnvironmentVariable({
 ### `EnvironmentValueType`
 
 The structure a variable's value holds. `SecretString` is encrypted at rest and
-its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON`, `Link` and
-`List` may be served to browser-facing consumers; `String` and `SecretString` may not.
+its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
+may be served to browser-facing consumers; `String` and `SecretString` may not.
 
 
 ```ts
-type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
 ```
 
 ### `StringTranslations`
@@ -377,130 +369,13 @@ type LinkValue = {
 }
 ```
 
-### `LinkFields`
-
-The fields of a link, without a fallback language — the shape a `List`
-item carries. Inside a list the fallback belongs to the wrapper, which
-owns the language tabs for every row.
-
-Restated rather than composed with `LinkValue`: `allOf` plus
-`additionalProperties: false` is rejected by most validato
-
-```ts
-type LinkFields = {
-  url: string
-  label: string | Record<string, string>
-  description?: string | Record<string, string>
-}
-```
-
-### `ListItemType`
-
-The element type a `List` holds. `String` and `SecretString` are absent
-deliberately: they are the two types never served to browser-facing
-consumers, and a `List` is. `Map` is already a keyed collection, and a
-list of lists has no consumer.
-
-
-```ts
-type ListItemType = "Text" | "Number" | "Boolean" | "JSON" | "Link"
-```
-
-### `ListOfText`
-
-```ts
-type ListOfText = {
-  itemType: "Text"
-  items: string[]
-}
-```
-
-### `ListOfNumber`
-
-```ts
-type ListOfNumber = {
-  itemType: "Number"
-  items: number[]
-}
-```
-
-### `ListOfBoolean`
-
-```ts
-type ListOfBoolean = {
-  itemType: "Boolean"
-  items: boolean[]
-}
-```
-
-### `ListOfJson`
-
-```ts
-type ListOfJson = {
-  itemType: "JSON"
-  items: Record<string, unknown>[]
-}
-```
-
-### `ListOfLink`
-
-A list of links. `fallbackLanguage` applies to every item's translated
-`label` and `description`; items may mix plain and translated fields
-freely, since a plain string is a complete answer for any language.
-
-
-```ts
-type ListOfLink = {
-  itemType: "Link"
-  fallbackLanguage?: string
-  items: Array<{
-    url: string
-    label: string | Record<string, string>
-    description?: string | Record<string, string>
-  }>
-}
-```
-
-### `ListValue`
-
-An ordered collection of one declared element type. Items round-trip in
-the order written; nothing sorts them. Holds at most 100 items.
-
-The whole value is limited to 32768 characters when serialised — the
-server enforces this, and it is not expressible per-property here.
-
-
-```ts
-type ListValue = {
-  itemType: "Text"
-  items: string[]
-} | {
-  itemType: "Number"
-  items: number[]
-} | {
-  itemType: "Boolean"
-  items: boolean[]
-} | {
-  itemType: "JSON"
-  items: Record<string, unknown>[]
-} | {
-  itemType: "Link"
-  fallbackLanguage?: string
-  items: Array<{
-    url: string
-    label: string | Record<string, string>
-    description?: string | Record<string, string>
-  }>
-}
-```
-
 ### `EnvironmentValue`
 
 A variable's value. The JSON type corresponds to the variable's `type`:
 `String`, `SecretString` and `Text` are strings, `Number` is a number,
-`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
-Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
-round-trip.
+`Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
+IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
+
 
 ```ts
 type EnvironmentValue = string | number | boolean | {
@@ -514,26 +389,6 @@ type EnvironmentValue = string | number | boolean | {
   label: string | Record<string, string>
   description?: string | Record<string, string>
   fallbackLanguage?: string
-} | {
-  itemType: "Text"
-  items: string[]
-} | {
-  itemType: "Number"
-  items: number[]
-} | {
-  itemType: "Boolean"
-  items: boolean[]
-} | {
-  itemType: "JSON"
-  items: Record<string, unknown>[]
-} | {
-  itemType: "Link"
-  fallbackLanguage?: string
-  items: Array<{
-    url: string
-    label: string | Record<string, string>
-    description?: string | Record<string, string>
-  }>
 }
 ```
 
@@ -542,7 +397,7 @@ type EnvironmentValue = string | number | boolean | {
 ```ts
 type EnvironmentVariable = {
   key: string
-  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
   description?: string
   group?: string
   value?: string | number | boolean | {
@@ -556,26 +411,6 @@ type EnvironmentVariable = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
-  } | {
-    itemType: "Text"
-    items: string[]
-  } | {
-    itemType: "Number"
-    items: number[]
-  } | {
-    itemType: "Boolean"
-    items: boolean[]
-  } | {
-    itemType: "JSON"
-    items: Record<string, unknown>[]
-  } | {
-    itemType: "Link"
-    fallbackLanguage?: string
-    items: Array<{
-      url: { ... }
-      label: { ... }
-      description?: { ... }
-    }>
   }
   protected?: boolean
   created_at: string // date-time
@@ -588,7 +423,7 @@ type EnvironmentVariable = {
 ```ts
 type EnvironmentVariableListItem = {
   key: string
-  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
   description?: string
   group?: string
   value?: string | number | boolean | {
@@ -602,26 +437,6 @@ type EnvironmentVariableListItem = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
-  } | {
-    itemType: "Text"
-    items: string[]
-  } | {
-    itemType: "Number"
-    items: number[]
-  } | {
-    itemType: "Boolean"
-    items: boolean[]
-  } | {
-    itemType: "JSON"
-    items: Record<string, unknown>[]
-  } | {
-    itemType: "Link"
-    fallbackLanguage?: string
-    items: Array<{
-      url: { ... }
-      label: { ... }
-      description?: { ... }
-    }>
   }
   protected?: boolean
   created_at: string // date-time
@@ -635,7 +450,7 @@ type EnvironmentVariableListItem = {
 type EnvironmentVariableList = {
   items: Array<{
     key: string
-    type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+    type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
     description?: string
     group?: string
     value?: string | number | boolean | {
@@ -646,22 +461,6 @@ type EnvironmentVariableList = {
       label: { ... }
       description?: { ... }
       fallbackLanguage?: { ... }
-    } | {
-      itemType: { ... }
-      items: { ... }
-    } | {
-      itemType: { ... }
-      items: { ... }
-    } | {
-      itemType: { ... }
-      items: { ... }
-    } | {
-      itemType: { ... }
-      items: { ... }
-    } | {
-      itemType: { ... }
-      fallbackLanguage?: { ... }
-      items: { ... }
     }
     protected?: boolean
     created_at: string // date-time
@@ -675,7 +474,7 @@ type EnvironmentVariableList = {
 ```ts
 type EnvironmentVariableCreateRequest = {
   key: string
-  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
   description?: string
   group?: string
   value?: string | number | boolean | {
@@ -689,26 +488,6 @@ type EnvironmentVariableCreateRequest = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
-  } | {
-    itemType: "Text"
-    items: string[]
-  } | {
-    itemType: "Number"
-    items: number[]
-  } | {
-    itemType: "Boolean"
-    items: boolean[]
-  } | {
-    itemType: "JSON"
-    items: Record<string, unknown>[]
-  } | {
-    itemType: "Link"
-    fallbackLanguage?: string
-    items: Array<{
-      url: { ... }
-      label: { ... }
-      description?: { ... }
-    }>
   }
   protected?: boolean
 }
@@ -718,7 +497,7 @@ type EnvironmentVariableCreateRequest = {
 
 ```ts
 type EnvironmentVariableUpdateRequest = {
-  type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
+  type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
   value?: string | number | boolean | {
     fallbackLanguage?: string
     options: Array<{
@@ -730,26 +509,6 @@ type EnvironmentVariableUpdateRequest = {
     label: string | Record<string, string>
     description?: string | Record<string, string>
     fallbackLanguage?: string
-  } | {
-    itemType: "Text"
-    items: string[]
-  } | {
-    itemType: "Number"
-    items: number[]
-  } | {
-    itemType: "Boolean"
-    items: boolean[]
-  } | {
-    itemType: "JSON"
-    items: Record<string, unknown>[]
-  } | {
-    itemType: "Link"
-    fallbackLanguage?: string
-    items: Array<{
-      url: { ... }
-      label: { ... }
-      description?: { ... }
-    }>
   }
   description?: string
   group?: string

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.8-alpha.0",
+  "version": "2.20.8",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",