@epilot/sdk 2.20.75 → 2.20.77

package/dist/{external-values.d-23q55J5P.d.ts → external-values.d-DeDtCu_V.d.ts}

@@ -14,13 +14,15 @@ declare namespace Components {
     }
     namespace Schemas {
         /**
-         * Something a hook needs the consumer to supply in `context`, discriminated by `type`.
-         * Today only `entity`; more types will follow. Consumers ignore types they do not know.
+         * Something a hook needs the consumer to supply in `context`, discriminated by `type`:
+         * bound entities (`entity`) or an optional scalar input (`value`). More types may follow;
+         * consumers ignore types they do not know.
          *
          */
         export type ContextRequirement = /**
-         * Something a hook needs the consumer to supply in `context`, discriminated by `type`.
-         * Today only `entity`; more types will follow. Consumers ignore types they do not know.
+         * Something a hook needs the consumer to supply in `context`, discriminated by `type`:
+         * bound entities (`entity`) or an optional scalar input (`value`). More types may follow;
+         * consumers ignore types they do not know.
          *
          */
         /**
@@ -29,7 +31,16 @@ declare namespace Components {
          * `{ type: entity, schema: contract }`.
          *
          */
-        EntityContextRequirement;
+        EntityContextRequirement | /**
+         * An optional scalar input. When the consumer has a value it supplies it under
+         * `Context.<name>` (dates as ISO 8601 strings, `YYYY-MM-DD` or a date-time); otherwise the
+         * key is absent, so the hook template must provide a fallback, e.g.
+         * `{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}` declares
+         * `{ type: value, name: reading_date, value_type: date }`. `name` is unique among the hook's
+         * `value` requirements and never equals the `schema` of one of its `entity` requirements.
+         *
+         */
+        ValueContextRequirement;
         /**
          * The consumer supplies the bound entities of `schema` under `Context.<schema>`, e.g. a hook
          * interpolating `{{ Context.contract[0].external_id }}` declares
@@ -83,13 +94,15 @@ declare namespace Components {
             /**
              * What the hook needs the consumer to supply in `context`, as declared in the hook
              * config. Omitted when the hook declares none. A rule builder must require these
-             * contexts on any rule that uses the hook, so the caller passes them in `context`.
-             * More requirement types will follow; consumers ignore types they do not know.
+             * contexts (and offer these value inputs) on any rule that uses the hook, so the
+             * caller passes them in `context`. More requirement types may follow; consumers
+             * ignore types they do not know.
              *
              */
             contexts?: /**
-             * Something a hook needs the consumer to supply in `context`, discriminated by `type`.
-             * Today only `entity`; more types will follow. Consumers ignore types they do not know.
+             * Something a hook needs the consumer to supply in `context`, discriminated by `type`:
+             * bound entities (`entity`) or an optional scalar input (`value`). More types may follow;
+             * consumers ignore types they do not know.
              *
              */
             ContextRequirement[];
@@ -126,8 +139,9 @@ declare namespace Components {
              *
              * One entry per context requirement the consumer bound (see
              * `ExternalValueHookSummary.contexts`): for an `entity` requirement, the bound
-             * entities of that schema under its schema slug. This API gives no name special
-             * treatment.
+             * entities of that schema under its schema slug; for a `value` requirement, the
+             * bound scalar under its `name` (e.g. `"reading_date": "2026-03-01"`), omitted when
+             * the consumer has no value. This API gives no name special treatment.
              *
              */
             context: {
@@ -194,6 +208,25 @@ declare namespace Components {
              */
             en?: string | null;
         }
+        /**
+         * An optional scalar input. When the consumer has a value it supplies it under
+         * `Context.<name>` (dates as ISO 8601 strings, `YYYY-MM-DD` or a date-time); otherwise the
+         * key is absent, so the hook template must provide a fallback, e.g.
+         * `{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}` declares
+         * `{ type: value, name: reading_date, value_type: date }`. `name` is unique among the hook's
+         * `value` requirements and never equals the `schema` of one of its `entity` requirements.
+         *
+         */
+        export interface ValueContextRequirement {
+            type: "value";
+            /**
+             * Key under `Context`, same pattern as validation rule parameter names.
+             * example:
+             * reading_date
+             */
+            name: string; // ^[a-z][a-z0-9_]{0,63}$
+            value_type: ExternalValueType;
+        }
     }
 }
 declare namespace Paths {
@@ -441,5 +474,6 @@ type ExternalValueType = Components.Schemas.ExternalValueType;
 type ResolveExternalValueRequest = Components.Schemas.ResolveExternalValueRequest;
 type ResolveExternalValueResponse = Components.Schemas.ResolveExternalValueResponse;
 type TranslatedString = Components.Schemas.TranslatedString;
+type ValueContextRequirement = Components.Schemas.ValueContextRequirement;
 
-export { type Client as C, type EntityContextRequirement as E, type OperationMethods as O, Paths as P, type ResolveExternalValueRequest as R, type TranslatedString as T, Components as a, type PathsDictionary as b, type ContextRequirement as c, type ExternalValueError as d, type ExternalValueErrorCode as e, type ExternalValueHookList as f, type ExternalValueHookSummary as g, type ExternalValueResultSummary as h, type ExternalValueType as i, type ResolveExternalValueResponse as j };
+export { type Client as C, type EntityContextRequirement as E, type OperationMethods as O, Paths as P, type ResolveExternalValueRequest as R, type TranslatedString as T, type ValueContextRequirement as V, Components as a, type PathsDictionary as b, type ContextRequirement as c, type ExternalValueError as d, type ExternalValueErrorCode as e, type ExternalValueHookList as f, type ExternalValueHookSummary as g, type ExternalValueResultSummary as h, type ExternalValueType as i, type ResolveExternalValueResponse as j };

package/dist/index.cjs

@@ -170,7 +170,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
 
 
 
-var _chunkJGPHZYSDcjs = require('./chunk-JGPHZYSD.cjs');
+var _chunkRZJMF6WEcjs = require('./chunk-RZJMF6WE.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -244,7 +244,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkJGPHZYSDcjs.createApiClient.call(void 0, {
+    entry.instance = _chunkRZJMF6WEcjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -277,7 +277,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunkJGPHZYSDcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkRZJMF6WEcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -640,9 +640,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkJGPHZYSDcjs.createApiHandle.call(void 0, {
+    return _chunkRZJMF6WEcjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkJGPHZYSDcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkRZJMF6WEcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -690,9 +690,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkJGPHZYSDcjs.help.call(void 0, apiName);
+          return (apiName) => _chunkRZJMF6WEcjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkJGPHZYSDcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkRZJMF6WEcjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -722,4 +722,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkJGPHZYSDcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkJGPHZYSDcjs.help; exports.openapi = _chunkJGPHZYSDcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkRZJMF6WEcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkRZJMF6WEcjs.help; exports.openapi = _chunkRZJMF6WEcjs.openapi;

package/dist/index.d.cts

@@ -7,7 +7,7 @@ import { C as Client } from './access-token.d-Yy-yrft_.cjs';
 import { C as Client$1 } from './address.d-CwAPOVxa.cjs';
 import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.cjs';
 import { C as Client$3 } from './ai-agents.d-BhnWCRxD.cjs';
-import { C as Client$4 } from './app.d-CZELwNO3.cjs';
+import { C as Client$4 } from './app.d-cnyQ-loP.cjs';
 import { C as Client$5 } from './audit-logs.d-BRToFqeX.cjs';
 import { C as Client$6 } from './automation.d-B8g3nYp-.cjs';
 import { C as Client$7 } from './billing.d-DA3sViEF.cjs';
@@ -26,9 +26,9 @@ import { C as Client$j } from './email-settings.d-dCUXyPAZ.cjs';
 import { C as Client$k } from './email-template.d-gtQkdaXM.cjs';
 import { C as Client$l } from './entity.d-DlI8zhXF.cjs';
 import { C as Client$m } from './entity-mapping.d-8MtWa2_L.cjs';
-import { C as Client$n } from './environments.d-qL1urwAq.cjs';
+import { C as Client$n } from './environments.d-BC2zAtBO.cjs';
 import { C as Client$o } from './event-catalog.d-BrAxYS9D.cjs';
-import { C as Client$p } from './external-values.d-23q55J5P.cjs';
+import { C as Client$p } from './external-values.d-DeDtCu_V.cjs';
 import { C as Client$q } from './file.d-DELNV63w.cjs';
 import { C as Client$r } from './iban.d-BwdiGbxi.cjs';
 import { C as Client$s } from './identity.d-DUcoy_-W.cjs';

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import { C as Client } from './access-token.d-Yy-yrft_.js';
 import { C as Client$1 } from './address.d-CwAPOVxa.js';
 import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.js';
 import { C as Client$3 } from './ai-agents.d-BhnWCRxD.js';
-import { C as Client$4 } from './app.d-CZELwNO3.js';
+import { C as Client$4 } from './app.d-cnyQ-loP.js';
 import { C as Client$5 } from './audit-logs.d-BRToFqeX.js';
 import { C as Client$6 } from './automation.d-B8g3nYp-.js';
 import { C as Client$7 } from './billing.d-DA3sViEF.js';
@@ -26,9 +26,9 @@ import { C as Client$j } from './email-settings.d-dCUXyPAZ.js';
 import { C as Client$k } from './email-template.d-gtQkdaXM.js';
 import { C as Client$l } from './entity.d-DlI8zhXF.js';
 import { C as Client$m } from './entity-mapping.d-8MtWa2_L.js';
-import { C as Client$n } from './environments.d-qL1urwAq.js';
+import { C as Client$n } from './environments.d-BC2zAtBO.js';
 import { C as Client$o } from './event-catalog.d-BrAxYS9D.js';
-import { C as Client$p } from './external-values.d-23q55J5P.js';
+import { C as Client$p } from './external-values.d-DeDtCu_V.js';
 import { C as Client$q } from './file.d-DELNV63w.js';
 import { C as Client$r } from './iban.d-BwdiGbxi.js';
 import { C as Client$s } from './identity.d-DUcoy_-W.js';

package/dist/index.js

@@ -170,7 +170,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-6B5HXASK.js";
+} from "./chunk-C6T52ZOY.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/docs/app.md

@@ -136,6 +136,9 @@ const { data } = await appClient.getPublicFacingComponent(...)
 - [`ApiProxyConfig`](#apiproxyconfig)
 - [`ExternalValuesConfig`](#externalvaluesconfig)
 - [`ExternalValuesHook`](#externalvalueshook)
+- [`ContextRequirement`](#contextrequirement)
+- [`EntityContextRequirement`](#entitycontextrequirement)
+- [`ValueContextRequirement`](#valuecontextrequirement)
 - [`ExternalValuesResult`](#externalvaluesresult)
 - [`Grants`](#grants)
 - [`BlueprintRef`](#blueprintref)
@@ -2268,6 +2271,7 @@ type ExternalValuesComponent = {
       result: { ... }
       timeout_ms?: { ... }
       on_unavailable?: { ... }
+      contexts?: { ... }
       cache?: { ... }
       secure_proxy?: { ... }
     }>
@@ -3797,6 +3801,14 @@ type ExternalValuesConfig = {
     }>
     timeout_ms?: number
     on_unavailable?: "skip" | "block"
+    contexts?: Array<{
+      type: { ... }
+      schema: { ... }
+    } | {
+      type: { ... }
+      name: { ... }
+      value_type: { ... }
+    }>
     cache?: {
       ttl_seconds: { ... }
       key?: { ... }
@@ -3811,9 +3823,9 @@ type ExternalValuesConfig = {
 
 ### `ExternalValuesHook`
 
-One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.input }}`).
+One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse` (each is also available snake_case, e.g. `{{ context.contract }}`).
 
-`Context` is the single name
+`Context` is the name → v
 
 ```ts
 type ExternalValuesHook = {
@@ -3860,6 +3872,14 @@ type ExternalValuesHook = {
   }>
   timeout_ms?: number
   on_unavailable?: "skip" | "block"
+  contexts?: Array<{
+    type: "entity"
+    schema: string
+  } | {
+    type: "value"
+    name: string
+    value_type: "number" | "text" | "date" | "boolean"
+  }>
   cache?: {
     ttl_seconds: number
     key?: string
@@ -3871,6 +3891,44 @@ type ExternalValuesHook = {
 }
 ```
 
+### `ContextRequirement`
+
+A requirement a hook reads from `Context`, discriminated by `type`. More types will be added later; consumers must ignore types they do not know.
+
+```ts
+type ContextRequirement = {
+  type: "entity"
+  schema: string
+} | {
+  type: "value"
+  name: string
+  value_type: "number" | "text" | "date" | "boolean"
+}
+```
+
+### `EntityContextRequirement`
+
+The consumer supplies the bound entities of `schema` under `Context.`<schema>``.
+
+```ts
+type EntityContextRequirement = {
+  type: "entity"
+  schema: string
+}
+```
+
+### `ValueContextRequirement`
+
+The consumer supplies one scalar value under `Context.`<name>``, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default
+
+```ts
+type ValueContextRequirement = {
+  type: "value"
+  name: string
+  value_type: "number" | "text" | "date" | "boolean"
+}
+```
+
 ### `ExternalValuesResult`
 
 A single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.

package/docs/environments.md

@@ -308,9 +308,10 @@ 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` and `Link`
-may be served to browser-facing consumers; `String` and `SecretString` may not. A
-`List` inherits this from its element type: a `List` is
+its value is never returned. Every other type
+may be served to browser-facing consumers. A `List` inherits this from its element
+type: a `List`<SecretString>`` is never served.
+
 
 ```ts
 type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"

package/docs/external-values.md

@@ -40,6 +40,7 @@ const { data } = await externalValuesClient.listExternalValues(...)
 - [`ExternalValueHookSummary`](#externalvaluehooksummary)
 - [`ContextRequirement`](#contextrequirement)
 - [`EntityContextRequirement`](#entitycontextrequirement)
+- [`ValueContextRequirement`](#valuecontextrequirement)
 - [`ExternalValueHookList`](#externalvaluehooklist)
 
 ### `listExternalValues`
@@ -316,20 +317,29 @@ type ExternalValueHookSummary = {
   contexts?: Array<{
     type: "entity"
     schema: string
+  } | {
+    type: "value"
+    name: string
+    value_type: "number" | "text" | "date" | "boolean"
   }>
 }
 ```
 
 ### `ContextRequirement`
 
-Something a hook needs the consumer to supply in `context`, discriminated by `type`.
-Today only `entity`; more types will follow. Consumers ignore types they do not know.
+Something a hook needs the consumer to supply in `context`, discriminated by `type`:
+bound entities (`entity`) or an optional scalar input (`value`). More types may follow;
+consumers ignore types they do not know.
 
 
 ```ts
 type ContextRequirement = {
   type: "entity"
   schema: string
+} | {
+  type: "value"
+  name: string
+  value_type: "number" | "text" | "date" | "boolean"
 }
 ```
 
@@ -347,6 +357,21 @@ type EntityContextRequirement = {
 }
 ```
 
+### `ValueContextRequirement`
+
+An optional scalar input. When the consumer has a value it supplies it under
+`Context.`<name>`` (dates as ISO 8601 strings, `YYYY-MM-DD` or a date-time); otherwise the
+key is absent, so the hook template must provide a fallback, e.g.
+`{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}` dec
+
+```ts
+type ValueContextRequirement = {
+  type: "value"
+  name: string
+  value_type: "number" | "text" | "date" | "boolean"
+}
+```
+
 ### `ExternalValueHookList`
 
 ```ts
@@ -371,6 +396,10 @@ type ExternalValueHookList = {
     contexts?: Array<{
       type: { ... }
       schema: { ... }
+    } | {
+      type: { ... }
+      name: { ... }
+      value_type: { ... }
     }>
   }>
 }

package/package.json

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