@epilot/sdk 2.20.57 → 2.20.59

package/docs/validation-rules.md

@@ -1,6 +1,5 @@
 # Validation Rules API
 
-- **Base URL:** `https://validation-rules.sls.epilot.io`
 - **Full API Docs:** [https://docs.epilot.io/api/validation-rules](https://docs.epilot.io/api/validation-rules)
 
 ## Usage
@@ -57,6 +56,7 @@ const { data } = await validationRulesClient.getValidationRules(...)
 - [`Operator`](#operator)
 - [`ConditionValue`](#conditionvalue)
 - [`ScalarValue`](#scalarvalue)
+- [`ValueReference`](#valuereference)
 - [`EnvironmentValue`](#environmentvalue)
 - [`ExternalValue`](#externalvalue)
 - [`StaticValue`](#staticvalue)
@@ -1775,7 +1775,21 @@ type Condition = {
     }
   } | {
     source: "relative_date"
-    offset: number
+    offset: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
     unit: "days" | "months" | "years"
     anchor?: "today"
   } | {
@@ -1844,20 +1858,6 @@ type Condition = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
-      adjust?: { ... }
-    }
-  } | {
-    source: "none"
-  }
-  error_message: string
-  applies_when?: {
-    path: string
-    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"
-    value?: number | string | boolean | {
-      source: { ... }
-      key: { ... }
-      adjust?: { ... }
-    }
   // ...
 }
 ```
@@ -1894,13 +1894,48 @@ type ConditionValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
   }
 } | {
   source: "relative_date"
-  offset: number
+  offset: number | {
+    source: "context"
+    path: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
+    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?: { ... }
+    }
+  }
   unit: "days" | "months" | "years"
   anchor?: "today"
 } | {
@@ -1916,6 +1951,12 @@ type ConditionValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
@@ -1935,16 +1976,46 @@ type ConditionValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+  // ...
+}
+```
+
+### `ScalarValue`
+
+A single comparison value - static, resolved from context, a relative date, an organisation environment variable, or an external value.
+
+```ts
+type ScalarValue = {
+  source: "static"
+  data: number | string | boolean
+} | {
+  source: "context"
+  path: string
+  adjust?: {
+    type: "percent" | "absolute"
+    value: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
   }
 } | {
-  source: "range"
-  min: {
-    source: "static"
-    data: number | string | boolean
-  } | {
+  source: "relative_date"
+  offset: number | {
     source: "context"
     path: string
     adjust?: {
@@ -1953,11 +2024,6 @@ type ConditionValue = {
       direction: { ... }
       rounding?: { ... }
     }
-  } | {
-    source: "relative_date"
-    offset: number
-    unit: "days" | "months" | "years"
-    anchor?: "today"
   } | {
     source: "environment"
     key: string
@@ -1978,19 +2044,62 @@ type ConditionValue = {
       direction: { ... }
       rounding?: { ... }
     }
+  }
+  unit: "days" | "months" | "years"
+  anchor?: "today"
+} | {
+  source: "environment"
+  key: string
+  adjust?: {
+    type: "percent" | "absolute"
+    value: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
+    direction: "increase" | "decrease"
+    rounding?: "up" | "down"
+  }
+} | {
+  source: "external"
+  app_id: string
+  hook_id: string
+  result_id: string
+  adjust?: {
+    type: "percent" | "absolute"
+    value: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
   // ...
 }
 ```
 
-### `ScalarValue`
+### `ValueReference`
+
+A value resolved at evaluation time instead of written into the rule, identified by
+`source`. Each field that accepts a reference lists the sources it allows; a rule using
+any other source is rejected when it is saved.
 
-A single comparison value - static, resolved from context, a relative date, an organisation environment variable, or an external value.
 
 ```ts
-type ScalarValue = {
-  source: "static"
-  data: number | string | boolean
-} | {
+type ValueReference = {
   source: "context"
   path: string
   adjust?: {
@@ -2003,15 +2112,16 @@ type ScalarValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
   }
-} | {
-  source: "relative_date"
-  offset: number
-  unit: "days" | "months" | "years"
-  anchor?: "today"
 } | {
   source: "environment"
   key: string
@@ -2025,6 +2135,12 @@ type ScalarValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
@@ -2044,6 +2160,12 @@ type ScalarValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
@@ -2074,6 +2196,12 @@ type EnvironmentValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
@@ -2104,6 +2232,12 @@ type ExternalValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
@@ -2143,6 +2277,12 @@ type ContextValue = {
       source: { ... }
       key: { ... }
       adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
     }
     direction: "increase" | "decrease"
     rounding?: "up" | "down"
@@ -2177,6 +2317,17 @@ type ValueAdjustment = {
       direction: { ... }
       rounding?: { ... }
     }
+  } | {
+    source: "external"
+    app_id: string
+    hook_id: string
+    result_id: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
   }
   direction: "increase" | "decrease"
   rounding?: "up" | "down"
@@ -2190,7 +2341,36 @@ A date relative to the evaluation moment, e.g. "today minus 30 days". Only valid
 ```ts
 type RelativeDateValue = {
   source: "relative_date"
-  offset: number
+  offset: number | {
+    source: "context"
+    path: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
+    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?: { ... }
+    }
+  }
   unit: "days" | "months" | "years"
   anchor?: "today"
 }
@@ -2217,7 +2397,21 @@ type RangeValue = {
     }
   } | {
     source: "relative_date"
-    offset: number
+    offset: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
     unit: "days" | "months" | "years"
     anchor?: "today"
   } | {
@@ -2255,7 +2449,21 @@ type RangeValue = {
     }
   } | {
     source: "relative_date"
-    offset: number
+    offset: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
     unit: "days" | "months" | "years"
     anchor?: "today"
   } | {
@@ -2273,12 +2481,7 @@ type RangeValue = {
     hook_id: string
     result_id: string
     adjust?: {
-      type: { ... }
-      value: { ... }
-      direction: { ... }
-      rounding?: { ... }
-    }
-  }
+  // ...
 }
 ```
 
@@ -2449,7 +2652,21 @@ type DocumentConditionValue = {
     }
   } | {
     source: "relative_date"
-    offset: number
+    offset: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
     unit: "days" | "months" | "years"
     anchor?: "today"
   } | {
@@ -2487,7 +2704,21 @@ type DocumentConditionValue = {
     }
   } | {
     source: "relative_date"
-    offset: number
+    offset: number | {
+      source: { ... }
+      path: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      key: { ... }
+      adjust?: { ... }
+    } | {
+      source: { ... }
+      app_id: { ... }
+      hook_id: { ... }
+      result_id: { ... }
+      adjust?: { ... }
+    }
     unit: "days" | "months" | "years"
     anchor?: "today"
   } | {
@@ -2502,23 +2733,7 @@ type DocumentConditionValue = {
   } | {
     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
+  // ...
 }
 ```
 
@@ -2560,6 +2775,15 @@ type AppliesWhen = {
   path: string
   operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty"
   value?: number | string | boolean | {
+    source: "context"
+    path: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  } | {
     source: "environment"
     key: string
     adjust?: {
@@ -2568,6 +2792,17 @@ type AppliesWhen = {
       direction: { ... }
       rounding?: { ... }
     }
+  } | {
+    source: "external"
+    app_id: string
+    hook_id: string
+    result_id: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
   }
 }
 ```

package/package.json

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

package/dist/chunk-7IKQIVUS.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/validation-rules-runtime.json
-var require_validation_rules_runtime = __commonJS({
-  "src/definitions/validation-rules-runtime.json"(exports, module) {
-    module.exports = { s: "https://validation-rules.sls.epilot.io", o: [["getValidationRules", "get", "/v1/validation-rules"], ["createValidationRule", "post", "/v1/validation-rules", null, 1], ["getValidationRuleById", "get", "/v1/validation-rules/{ruleId}", [["ruleId", "p", true]]], ["updateValidationRule", "patch", "/v1/validation-rules/{ruleId}", [["ruleId", "p", true]], 1], ["deleteValidationRule", "delete", "/v1/validation-rules/{ruleId}", [["ruleId", "p", true]]], ["addUsedByReference", "post", "/v1/validation-rules/{ruleId}/used-by", [["ruleId", "p", true]], 1], ["removeUsedByReference", "delete", "/v1/validation-rules/{ruleId}/used-by", [["ruleId", "p", true]], 1]], v: "3.0.3" };
-  }
-});
-
-export {
-  require_validation_rules_runtime
-};

package/dist/chunk-JIUTCNTB.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/validation-rules-runtime.json
-var require_validation_rules_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/validation-rules-runtime.json"(exports, module) {
-    module.exports = { s: "https://validation-rules.sls.epilot.io", o: [["getValidationRules", "get", "/v1/validation-rules"], ["createValidationRule", "post", "/v1/validation-rules", null, 1], ["getValidationRuleById", "get", "/v1/validation-rules/{ruleId}", [["ruleId", "p", true]]], ["updateValidationRule", "patch", "/v1/validation-rules/{ruleId}", [["ruleId", "p", true]], 1], ["deleteValidationRule", "delete", "/v1/validation-rules/{ruleId}", [["ruleId", "p", true]]], ["addUsedByReference", "post", "/v1/validation-rules/{ruleId}/used-by", [["ruleId", "p", true]], 1], ["removeUsedByReference", "delete", "/v1/validation-rules/{ruleId}/used-by", [["ruleId", "p", true]], 1]], v: "3.0.3" };
-  }
-});
-
-
-
-exports.require_validation_rules_runtime = require_validation_rules_runtime;