@epilot/sdk 2.20.77 → 2.20.78

package/dist/{validation-rules.d-C1OtLama.d.ts → validation-rules.d-Dw7Qn8_e.d.ts}

@@ -152,19 +152,24 @@ declare namespace Components {
          * are resolved only for authenticated consumers (epilot 360 users and portal end customers);
          * in public journeys the dependent conditions are skipped.
          *
+         * A hook may declare value inputs (`contexts` entries `{ "type": "value", "name", "value_type" }`)
+         * besides the entities it receives. `inputs` supplies them from rule parameters, which the
+         * consumer binds like any other parameter and sends to the hook as `Context.<name>`.
+         *
          */
         ExternalValue | /**
-         * A comparison value supplied by the surface that evaluates the rule, identified by a name
-         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
-         * binds the name to a source of its own - a journey binds it to the value of another block -
-         * and resolves it at evaluation time, so the rule never references the surface's objects
-         * and stays reusable across journeys and forms.
+         * A comparison value supplied by the consumer that evaluates the rule, identified by a name
+         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consumer binds the
+         * name to a source of its own - a journey binds it to the value of another block - and
+         * resolves it at evaluation time, so the rule never references the consumer's objects and
+         * stays reusable across journeys and forms.
          *
-         * The kind a parameter is compared as follows from the field it sits in: `number`, `text`
-         * or `date` for comparison values, range bounds, adjustment amounts and relative date
-         * offsets, or a number, string or boolean as an `applies_when` value. One name is compared
-         * as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
-         * A parameter the surface leaves unbound or empty leaves the comparison unresolved.
+         * A parameter's kind is determined by the field it is used in: `number`, `text` or `date`
+         * for comparison values, range bounds, adjustment amounts and relative date offsets, or a
+         * number, string or boolean as an `applies_when` value, or the `value_type` of the External
+         * Values hook input it supplies (`ExternalValue.inputs`). One name is compared as one kind
+         * throughout a rule; a rule using a name as two kinds is rejected at write time. A parameter
+         * the consumer leaves unbound or empty leaves the comparison unresolved.
          *
          */
         ParameterValue | /* 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;
@@ -401,6 +406,10 @@ declare namespace Components {
          * are resolved only for authenticated consumers (epilot 360 users and portal end customers);
          * in public journeys the dependent conditions are skipped.
          *
+         * A hook may declare value inputs (`contexts` entries `{ "type": "value", "name", "value_type" }`)
+         * besides the entities it receives. `inputs` supplies them from rule parameters, which the
+         * consumer binds like any other parameter and sends to the hook as `Context.<name>`.
+         *
          */
         export interface ExternalValue {
             source: "external";
@@ -416,6 +425,34 @@ declare namespace Components {
              * ID of the result entry within the hook whose value is compared.
              */
             result_id: string; // ^[a-zA-Z0-9_-]+$
+            /**
+             * Values for the hook's value inputs, keyed by the input name the hook declares
+             * (`contexts` entry of type `value`), e.g. `{ "reading_date": { "source": "parameter", "name": "reading_date" } }`.
+             * Only parameters are supported. Write-time validation checks that every key is a value input the
+             * hook declares and uses the input's `value_type` (`number`, `text`, `date` or `boolean`) as the
+             * parameter's kind, so the parameter must not be compared as another kind elsewhere in the rule.
+             * An input parameter must not carry an adjustment. Declared inputs without an entry are allowed;
+             * the consumer omits an input that has no value.
+             *
+             */
+            inputs?: {
+                [name: string]: /**
+                 * A comparison value supplied by the consumer that evaluates the rule, identified by a name
+                 * the rule chooses (e.g. `start_date`). The rule stores the name only. The consumer binds the
+                 * name to a source of its own - a journey binds it to the value of another block - and
+                 * resolves it at evaluation time, so the rule never references the consumer's objects and
+                 * stays reusable across journeys and forms.
+                 *
+                 * A parameter's kind is determined by the field it is used in: `number`, `text` or `date`
+                 * for comparison values, range bounds, adjustment amounts and relative date offsets, or a
+                 * number, string or boolean as an `applies_when` value, or the `value_type` of the External
+                 * Values hook input it supplies (`ExternalValue.inputs`). One name is compared as one kind
+                 * throughout a rule; a rule using a name as two kinds is rejected at write time. A parameter
+                 * the consumer leaves unbound or empty leaves the comparison unresolved.
+                 *
+                 */
+                ParameterValue;
+            };
             adjust?: /**
              * Adjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".
              * Used to express tolerance bands such as "at most 10% above the current instalment amount".
@@ -597,17 +634,18 @@ declare namespace Components {
          */
         export type Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals";
         /**
-         * A comparison value supplied by the surface that evaluates the rule, identified by a name
-         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
-         * binds the name to a source of its own - a journey binds it to the value of another block -
-         * and resolves it at evaluation time, so the rule never references the surface's objects
-         * and stays reusable across journeys and forms.
+         * A comparison value supplied by the consumer that evaluates the rule, identified by a name
+         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consumer binds the
+         * name to a source of its own - a journey binds it to the value of another block - and
+         * resolves it at evaluation time, so the rule never references the consumer's objects and
+         * stays reusable across journeys and forms.
          *
-         * The kind a parameter is compared as follows from the field it sits in: `number`, `text`
-         * or `date` for comparison values, range bounds, adjustment amounts and relative date
-         * offsets, or a number, string or boolean as an `applies_when` value. One name is compared
-         * as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
-         * A parameter the surface leaves unbound or empty leaves the comparison unresolved.
+         * A parameter's kind is determined by the field it is used in: `number`, `text` or `date`
+         * for comparison values, range bounds, adjustment amounts and relative date offsets, or a
+         * number, string or boolean as an `applies_when` value, or the `value_type` of the External
+         * Values hook input it supplies (`ExternalValue.inputs`). One name is compared as one kind
+         * throughout a rule; a rule using a name as two kinds is rejected at write time. A parameter
+         * the consumer leaves unbound or empty leaves the comparison unresolved.
          *
          */
         export interface ParameterValue {
@@ -941,19 +979,24 @@ declare namespace Components {
          * are resolved only for authenticated consumers (epilot 360 users and portal end customers);
          * in public journeys the dependent conditions are skipped.
          *
+         * A hook may declare value inputs (`contexts` entries `{ "type": "value", "name", "value_type" }`)
+         * besides the entities it receives. `inputs` supplies them from rule parameters, which the
+         * consumer binds like any other parameter and sends to the hook as `Context.<name>`.
+         *
          */
         ExternalValue | /**
-         * A comparison value supplied by the surface that evaluates the rule, identified by a name
-         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
-         * binds the name to a source of its own - a journey binds it to the value of another block -
-         * and resolves it at evaluation time, so the rule never references the surface's objects
-         * and stays reusable across journeys and forms.
+         * A comparison value supplied by the consumer that evaluates the rule, identified by a name
+         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consumer binds the
+         * name to a source of its own - a journey binds it to the value of another block - and
+         * resolves it at evaluation time, so the rule never references the consumer's objects and
+         * stays reusable across journeys and forms.
          *
-         * The kind a parameter is compared as follows from the field it sits in: `number`, `text`
-         * or `date` for comparison values, range bounds, adjustment amounts and relative date
-         * offsets, or a number, string or boolean as an `applies_when` value. One name is compared
-         * as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
-         * A parameter the surface leaves unbound or empty leaves the comparison unresolved.
+         * A parameter's kind is determined by the field it is used in: `number`, `text` or `date`
+         * for comparison values, range bounds, adjustment amounts and relative date offsets, or a
+         * number, string or boolean as an `applies_when` value, or the `value_type` of the External
+         * Values hook input it supplies (`ExternalValue.inputs`). One name is compared as one kind
+         * throughout a rule; a rule using a name as two kinds is rejected at write time. A parameter
+         * the consumer leaves unbound or empty leaves the comparison unresolved.
          *
          */
         ParameterValue;
@@ -1279,19 +1322,24 @@ declare namespace Components {
          * are resolved only for authenticated consumers (epilot 360 users and portal end customers);
          * in public journeys the dependent conditions are skipped.
          *
+         * A hook may declare value inputs (`contexts` entries `{ "type": "value", "name", "value_type" }`)
+         * besides the entities it receives. `inputs` supplies them from rule parameters, which the
+         * consumer binds like any other parameter and sends to the hook as `Context.<name>`.
+         *
          */
         ExternalValue | /**
-         * A comparison value supplied by the surface that evaluates the rule, identified by a name
-         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
-         * binds the name to a source of its own - a journey binds it to the value of another block -
-         * and resolves it at evaluation time, so the rule never references the surface's objects
-         * and stays reusable across journeys and forms.
+         * A comparison value supplied by the consumer that evaluates the rule, identified by a name
+         * the rule chooses (e.g. `start_date`). The rule stores the name only. The consumer binds the
+         * name to a source of its own - a journey binds it to the value of another block - and
+         * resolves it at evaluation time, so the rule never references the consumer's objects and
+         * stays reusable across journeys and forms.
          *
-         * The kind a parameter is compared as follows from the field it sits in: `number`, `text`
-         * or `date` for comparison values, range bounds, adjustment amounts and relative date
-         * offsets, or a number, string or boolean as an `applies_when` value. One name is compared
-         * as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
-         * A parameter the surface leaves unbound or empty leaves the comparison unresolved.
+         * A parameter's kind is determined by the field it is used in: `number`, `text` or `date`
+         * for comparison values, range bounds, adjustment amounts and relative date offsets, or a
+         * number, string or boolean as an `applies_when` value, or the `value_type` of the External
+         * Values hook input it supplies (`ExternalValue.inputs`). One name is compared as one kind
+         * throughout a rule; a rule using a name as two kinds is rejected at write time. A parameter
+         * the consumer leaves unbound or empty leaves the comparison unresolved.
          *
          */
         ParameterValue;

package/docs/validation-rules.md

@@ -1736,6 +1736,7 @@ type ComparisonRuleType = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -1794,6 +1795,7 @@ type Condition = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -1814,6 +1816,7 @@ type Condition = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -1834,6 +1837,11 @@ type Condition = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -1857,13 +1865,6 @@ type Condition = {
     } | {
       source: { ... }
       path: { ... }
-      adjust?: { ... }
-    } | {
-      source: { ... }
-      offset: { ... }
-      unit: { ... }
-      anchor?: { ... }
-    } | {
   // ...
 }
 ```
@@ -1905,6 +1906,7 @@ type ConditionValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -1939,6 +1941,11 @@ type ConditionValue = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -1978,12 +1985,6 @@ type ConditionValue = {
     source: "external"
     app_id: string
     hook_id: string
-    result_id: string
-    adjust?: {
-      type: { ... }
-      value: { ... }
-      direction: { ... }
-      rounding?: { ... }
   // ...
 }
 ```
@@ -2014,6 +2015,7 @@ type ScalarValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2048,6 +2050,11 @@ type ScalarValue = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -2087,12 +2094,6 @@ type ScalarValue = {
     source: "external"
     app_id: string
     hook_id: string
-    result_id: string
-    adjust?: {
-      type: { ... }
-      value: { ... }
-      direction: { ... }
-      rounding?: { ... }
   // ...
 }
 ```
@@ -2123,6 +2124,7 @@ type ValueReference = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2150,6 +2152,7 @@ type ValueReference = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2164,6 +2167,16 @@ type ValueReference = {
   app_id: string
   hook_id: string
   result_id: string
+  inputs?: Record<string, {
+    source: "parameter"
+    name: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  }>
   adjust?: {
     type: "percent" | "absolute"
     value: number | {
@@ -2179,6 +2192,7 @@ type ValueReference = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2192,19 +2206,6 @@ type ValueReference = {
   source: "parameter"
   name: string
   adjust?: {
-    type: "percent" | "absolute"
-    value: number | {
-      source: { ... }
-      path: { ... }
-      adjust?: { ... }
-    } | {
-      source: { ... }
-      key: { ... }
-      adjust?: { ... }
-    } | {
-      source: { ... }
-      app_id: { ... }
-      hook_id: { ... }
   // ...
 }
 ```
@@ -2237,6 +2238,7 @@ type EnvironmentValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2262,6 +2264,16 @@ type ExternalValue = {
   app_id: string
   hook_id: string
   result_id: string
+  inputs?: Record<string, {
+    source: "parameter"
+    name: string
+    adjust?: {
+      type: { ... }
+      value: { ... }
+      direction: { ... }
+      rounding?: { ... }
+    }
+  }>
   adjust?: {
     type: "percent" | "absolute"
     value: number | {
@@ -2277,6 +2289,7 @@ type ExternalValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2291,10 +2304,10 @@ type ExternalValue = {
 
 ### `ParameterValue`
 
-A comparison value supplied by the surface that evaluates the rule, identified by a name
-the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
-binds the name to a source of its own - a journey binds it to the value of another block -
-and resolves it at evaluation
+A comparison value supplied by the consumer that evaluates the rule, identified by a name
+the rule chooses (e.g. `start_date`). The rule stores the name only. The consumer binds the
+name to a source of its own - a journey binds it to the value of another block - and
+resolves it at evaluation time, s
 
 ```ts
 type ParameterValue = {
@@ -2315,6 +2328,7 @@ type ParameterValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2364,6 +2378,7 @@ type ContextValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2408,6 +2423,11 @@ type ValueAdjustment = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -2459,6 +2479,11 @@ type RelativeDateValue = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -2499,6 +2524,11 @@ type RelativeDateValue = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -2552,6 +2582,7 @@ type RangeValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2572,6 +2603,7 @@ type RangeValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2592,6 +2624,11 @@ type RangeValue = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -2616,13 +2653,6 @@ type RangeValue = {
     path: string
     adjust?: {
       type: { ... }
-      value: { ... }
-      direction: { ... }
-      rounding?: { ... }
-    }
-  } | {
-    source: "relative_date"
-    offset: number | {
   // ...
 }
 ```
@@ -2719,6 +2749,7 @@ type DocumentCondition = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2746,6 +2777,7 @@ type DocumentCondition = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2815,6 +2847,7 @@ type DocumentConditionValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2835,6 +2868,7 @@ type DocumentConditionValue = {
       app_id: { ... }
       hook_id: { ... }
       result_id: { ... }
+      inputs?: { ... }
       adjust?: { ... }
     } | {
       source: { ... }
@@ -2855,6 +2889,11 @@ type DocumentConditionValue = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }
@@ -2876,13 +2915,6 @@ type DocumentConditionValue = {
     data: number | string | boolean
   } | {
     source: "context"
-    path: string
-    adjust?: {
-      type: { ... }
-      value: { ... }
-      direction: { ... }
-      rounding?: { ... }
-    }
   // ...
 }
 ```
@@ -2947,6 +2979,11 @@ type AppliesWhen = {
     app_id: string
     hook_id: string
     result_id: string
+    inputs?: Record<string, {
+      source: { ... }
+      name: { ... }
+      adjust?: { ... }
+    }>
     adjust?: {
       type: { ... }
       value: { ... }

package/package.json

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