@epilot/sdk 2.12.0 → 2.12.1

package/dist/{event-catalog.d-CXbUn8T1.d.ts → event-catalog.d-QIhhewVH.d.ts}

@@ -202,6 +202,10 @@ declare namespace Components {
              *
              */
             _ack_id?: string;
+            /**
+             * Inline downgrade chain stamped by Event Catalog at publish time, ordered newest-to-oldest. Present ONLY on multi-version events. Internal versioning transport: consumers (e.g. svc-webhooks) walk the payload back to a pinned version using these JSONata steps, then strip the field before delivery -- end customers never receive it.
+             */
+            _downgrades?: /* One step of an event's inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself. */ InlineDowngradeStep[];
         }
         /**
          * A file attachment associated with an event
@@ -394,6 +398,41 @@ declare namespace Components {
              * true
              */
             automation_trigger?: boolean;
+            /**
+             * Org-defined success criteria for this event: the entity attributes that an
+             * organization considers must be captured for an event change request to be
+             * treated as complete (e.g. for telephony / self-service flows).
+             *
+             * Advisory metadata — event-catalog does NOT require an org to define any and
+             * does NOT enforce them when an event is triggered or published. The org may
+             * define none (empty array or omitted). When provided, each entry is validated
+             * for well-formedness on write (see SuccessCriterion).
+             *
+             * example:
+             * [
+             *   {
+             *     "entity_schema": "contract",
+             *     "attribute": "installment_amount"
+             *   },
+             *   {
+             *     "entity_schema": "billing_account",
+             *     "attribute": "due_date"
+             *   }
+             * ]
+             */
+            success_criteria?: /**
+             * A single org-defined success criterion: an entity attribute that must be captured
+             * for this event's change request to be considered complete.
+             *
+             * Identity is the entity schema plus the attribute name — mirroring the
+             * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+             * `attribute` and `entity_schema` are required and `entity_schema` must match the
+             * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+             * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+             * never enforced when an event is triggered or published.
+             *
+             */
+            SuccessCriterion[];
         }
         /**
          * Base properties shared between EventConfig and UpdateEventPayload
@@ -544,6 +583,41 @@ declare namespace Components {
              * true
              */
             automation_trigger?: boolean;
+            /**
+             * Org-defined success criteria for this event: the entity attributes that an
+             * organization considers must be captured for an event change request to be
+             * treated as complete (e.g. for telephony / self-service flows).
+             *
+             * Advisory metadata — event-catalog does NOT require an org to define any and
+             * does NOT enforce them when an event is triggered or published. The org may
+             * define none (empty array or omitted). When provided, each entry is validated
+             * for well-formedness on write (see SuccessCriterion).
+             *
+             * example:
+             * [
+             *   {
+             *     "entity_schema": "contract",
+             *     "attribute": "installment_amount"
+             *   },
+             *   {
+             *     "entity_schema": "billing_account",
+             *     "attribute": "due_date"
+             *   }
+             * ]
+             */
+            success_criteria?: /**
+             * A single org-defined success criterion: an entity attribute that must be captured
+             * for this event's change request to be considered complete.
+             *
+             * Identity is the entity schema plus the attribute name — mirroring the
+             * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+             * `attribute` and `entity_schema` are required and `entity_schema` must match the
+             * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+             * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+             * never enforced when an event is triggered or published.
+             *
+             */
+            SuccessCriterion[];
         }
         /**
          * JSON Schema declaring the event payload structure
@@ -887,6 +961,19 @@ declare namespace Components {
              */
             fields?: string[];
         }
+        /**
+         * One step of an event's inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.
+         */
+        export interface InlineDowngradeStep {
+            /**
+             * Version label this step downgrades to (the previous version).
+             */
+            to: string;
+            /**
+             * JSONata expression mapping the current-shape payload to the previous-shape payload.
+             */
+            jsonata: string;
+        }
         /**
          * A primitive JSON Schema field definition
          */
@@ -1051,6 +1138,32 @@ declare namespace Components {
              */
             FieldsParam;
         }
+        /**
+         * A single org-defined success criterion: an entity attribute that must be captured
+         * for this event's change request to be considered complete.
+         *
+         * Identity is the entity schema plus the attribute name — mirroring the
+         * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+         * `attribute` and `entity_schema` are required and `entity_schema` must match the
+         * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+         * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+         * never enforced when an event is triggered or published.
+         *
+         */
+        export interface SuccessCriterion {
+            /**
+             * Entity schema slug the attribute belongs to (matches a node schema in the event's entity_graph).
+             * example:
+             * contract
+             */
+            entity_schema: string;
+            /**
+             * Attribute name on the entity schema.
+             * example:
+             * installment_amount
+             */
+            attribute: string;
+        }
         /**
          * Payload for explicitly triggering an event via API
          */
@@ -1122,7 +1235,7 @@ declare namespace Components {
         /**
          * Payload for updating an event configuration.
          * Accepts the same fields as EventConfig (all optional for PATCH).
-         * Currently `enabled` and `auto_trigger` fields are processed.
+         * Currently `enabled`, `auto_trigger` and `success_criteria` fields are processed.
          *
          */
         export interface UpdateEventPayload {
@@ -1271,6 +1384,41 @@ declare namespace Components {
              * true
              */
             automation_trigger?: boolean;
+            /**
+             * Org-defined success criteria for this event: the entity attributes that an
+             * organization considers must be captured for an event change request to be
+             * treated as complete (e.g. for telephony / self-service flows).
+             *
+             * Advisory metadata — event-catalog does NOT require an org to define any and
+             * does NOT enforce them when an event is triggered or published. The org may
+             * define none (empty array or omitted). When provided, each entry is validated
+             * for well-formedness on write (see SuccessCriterion).
+             *
+             * example:
+             * [
+             *   {
+             *     "entity_schema": "contract",
+             *     "attribute": "installment_amount"
+             *   },
+             *   {
+             *     "entity_schema": "billing_account",
+             *     "attribute": "due_date"
+             *   }
+             * ]
+             */
+            success_criteria?: /**
+             * A single org-defined success criterion: an entity attribute that must be captured
+             * for this event's change request to be considered complete.
+             *
+             * Identity is the entity schema plus the attribute name — mirroring the
+             * EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+             * `attribute` and `entity_schema` are required and `entity_schema` must match the
+             * `schema` of a node in the event's `entity_graph` (else the request is rejected) —
+             * this prevents unsatisfiable criteria. The criteria themselves are advisory and are
+             * never enforced when an event is triggered or published.
+             *
+             */
+            SuccessCriterion[];
         }
         /**
          * One entry of an event's version timeline.
@@ -1574,7 +1722,7 @@ declare namespace Paths {
         export type RequestBody = /**
          * Payload for updating an event configuration.
          * Accepts the same fields as EventConfig (all optional for PATCH).
-         * Currently `enabled` and `auto_trigger` fields are processed.
+         * Currently `enabled`, `auto_trigger` and `success_criteria` fields are processed.
          *
          */
         Components.Schemas.UpdateEventPayload;
@@ -2007,13 +2155,15 @@ type FieldsParam = Components.Schemas.FieldsParam;
 type GraphDefinition = Components.Schemas.GraphDefinition;
 type GraphEdge = Components.Schemas.GraphEdge;
 type GraphNode = Components.Schemas.GraphNode;
+type InlineDowngradeStep = Components.Schemas.InlineDowngradeStep;
 type PrimitiveField = Components.Schemas.PrimitiveField;
 type SchemaField = Components.Schemas.SchemaField;
 type SearchOptions = Components.Schemas.SearchOptions;
 type SearchOptionsV2 = Components.Schemas.SearchOptionsV2;
+type SuccessCriterion = Components.Schemas.SuccessCriterion;
 type TriggerEventPayload = Components.Schemas.TriggerEventPayload;
 type TriggerEventResponse = Components.Schemas.TriggerEventResponse;
 type UpdateEventPayload = Components.Schemas.UpdateEventPayload;
 type VersionMeta = Components.Schemas.VersionMeta;
 
-export { type AttachmentField as A, type Client as C, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type VersionMeta as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventAttachment as f, type EventConfig as g, type EventConfigBase as h, type EventJsonSchema as i, type EventSummary as j, type EventVersionRegistrySummary as k, type FieldsParam as l, type GraphEdge as m, type GraphNode as n, type PrimitiveField as o, type SearchOptions as p, type SearchOptionsV2 as q, type TriggerEventResponse as r };
+export { type AttachmentField as A, type Client as C, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type InlineDowngradeStep as I, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type VersionMeta as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type Event as e, type EventAttachment as f, type EventConfig as g, type EventConfigBase as h, type EventJsonSchema as i, type EventSummary as j, type EventVersionRegistrySummary as k, type FieldsParam as l, type GraphEdge as m, type GraphNode as n, type PrimitiveField as o, type SearchOptions as p, type SearchOptionsV2 as q, type SuccessCriterion as r, type TriggerEventResponse as s };

package/dist/index.cjs

@@ -158,7 +158,7 @@ var _chunkDVM27A7Ecjs = require('./chunk-DVM27A7E.cjs');
 
 
 
-var _chunkXGCTJYBWcjs = require('./chunk-XGCTJYBW.cjs');
+var _chunkAJDY36Y6cjs = require('./chunk-AJDY36Y6.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkXGCTJYBWcjs.createApiClient.call(void 0, {
+    entry.instance = _chunkAJDY36Y6cjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunkXGCTJYBWcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkAJDY36Y6cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -601,9 +601,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkXGCTJYBWcjs.createApiHandle.call(void 0, {
+    return _chunkAJDY36Y6cjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkXGCTJYBWcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkAJDY36Y6cjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -651,9 +651,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkXGCTJYBWcjs.help.call(void 0, apiName);
+          return (apiName) => _chunkAJDY36Y6cjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkXGCTJYBWcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkAJDY36Y6cjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -683,4 +683,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkXGCTJYBWcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkXGCTJYBWcjs.help; exports.openapi = _chunkXGCTJYBWcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkAJDY36Y6cjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkAJDY36Y6cjs.help; exports.openapi = _chunkAJDY36Y6cjs.openapi;

package/dist/index.d.cts

@@ -26,7 +26,7 @@ import { C as Client$j } from './email-template.d-gtQkdaXM.cjs';
 import { C as Client$k } from './entity.d-fospShiN.cjs';
 import { C as Client$l } from './entity-mapping.d-DKSW3sfy.cjs';
 import { C as Client$m } from './environments.d-BvqvN-PD.cjs';
-import { C as Client$n } from './event-catalog.d-CXbUn8T1.cjs';
+import { C as Client$n } from './event-catalog.d-QIhhewVH.cjs';
 import { C as Client$o } from './file.d-BN417xok.cjs';
 import { C as Client$p } from './iban.d-BwdiGbxi.cjs';
 import { C as Client$q } from './integration-toolkit.d-7q19qDTD.cjs';

package/dist/index.d.ts

@@ -26,7 +26,7 @@ import { C as Client$j } from './email-template.d-gtQkdaXM.js';
 import { C as Client$k } from './entity.d-fospShiN.js';
 import { C as Client$l } from './entity-mapping.d-DKSW3sfy.js';
 import { C as Client$m } from './environments.d-BvqvN-PD.js';
-import { C as Client$n } from './event-catalog.d-CXbUn8T1.js';
+import { C as Client$n } from './event-catalog.d-QIhhewVH.js';
 import { C as Client$o } from './file.d-BN417xok.js';
 import { C as Client$p } from './iban.d-BwdiGbxi.js';
 import { C as Client$q } from './integration-toolkit.d-7q19qDTD.js';

package/dist/index.js

@@ -158,7 +158,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-FOGUF2AK.js";
+} from "./chunk-L3UZLJPQ.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/docs/event-catalog.md

@@ -44,8 +44,10 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`ContextEntity`](#contextentity)
 - [`AttachmentField`](#attachmentfield)
 - [`SchemaField`](#schemafield)
+- [`SuccessCriterion`](#successcriterion)
 - [`CommonEventMetadata`](#commoneventmetadata)
 - [`EventJsonSchema`](#eventjsonschema)
+- [`InlineDowngradeStep`](#inlinedowngradestep)
 - [`Event`](#event)
 - [`EventSummary`](#eventsummary)
 - [`GraphDefinition`](#graphdefinition)
@@ -110,7 +112,17 @@ const { data } = await client.listEvents()
       },
       "enabled": true,
       "auto_trigger": true,
-      "automation_trigger": true
+      "automation_trigger": true,
+      "success_criteria": [
+        {
+          "entity_schema": "contract",
+          "attribute": "installment_amount"
+        },
+        {
+          "entity_schema": "billing_account",
+          "attribute": "due_date"
+        }
+      ]
     }
   ]
 }
@@ -168,7 +180,17 @@ const { data } = await client.getEvent({
   },
   "enabled": true,
   "auto_trigger": true,
-  "automation_trigger": true
+  "automation_trigger": true,
+  "success_criteria": [
+    {
+      "entity_schema": "contract",
+      "attribute": "installment_amount"
+    },
+    {
+      "entity_schema": "billing_account",
+      "attribute": "due_date"
+    }
+  ]
 }
 ```
 
@@ -219,7 +241,17 @@ const { data } = await client.patchEvent(
     },
     enabled: true,
     auto_trigger: true,
-    automation_trigger: true
+    automation_trigger: true,
+    success_criteria: [
+      {
+        entity_schema: 'contract',
+        attribute: 'installment_amount'
+      },
+      {
+        entity_schema: 'billing_account',
+        attribute: 'due_date'
+      }
+    ]
   },
 )
 ```
@@ -260,7 +292,17 @@ const { data } = await client.patchEvent(
   },
   "enabled": true,
   "auto_trigger": true,
-  "automation_trigger": true
+  "automation_trigger": true,
+  "success_criteria": [
+    {
+      "entity_schema": "contract",
+      "attribute": "installment_amount"
+    },
+    {
+      "entity_schema": "billing_account",
+      "attribute": "due_date"
+    }
+  ]
 }
 ```
 
@@ -726,6 +768,10 @@ type EventConfigBase = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  success_criteria?: Array<{
+    entity_schema: string
+    attribute: string
+  }>
 }
 ```
 
@@ -781,6 +827,10 @@ type EventConfig = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  success_criteria?: Array<{
+    entity_schema: string
+    attribute: string
+  }>
 }
 ```
 
@@ -788,7 +838,7 @@ type EventConfig = {
 
 Payload for updating an event configuration.
 Accepts the same fields as EventConfig (all optional for PATCH).
-Currently `enabled` and `auto_trigger` fields are processed.
+Currently `enabled`, `auto_trigger` and `success_criteria` fields are processed.
 
 
 ```ts
@@ -839,6 +889,10 @@ type UpdateEventPayload = {
   enabled?: boolean
   auto_trigger?: boolean
   automation_trigger?: boolean
+  success_criteria?: Array<{
+    entity_schema: string
+    attribute: string
+  }>
 }
 ```
 
@@ -914,6 +968,22 @@ type SchemaField = {
 }
 ```
 
+### `SuccessCriterion`
+
+A single org-defined success criterion: an entity attribute that must be captured
+for this event's change request to be considered complete.
+
+Identity is the entity schema plus the attribute name — mirroring the
+EntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both
+`attribut
+
+```ts
+type SuccessCriterion = {
+  entity_schema: string
+  attribute: string
+}
+```
+
 ### `CommonEventMetadata`
 
 Common metadata fields present in all event payloads
@@ -930,6 +1000,17 @@ JSON Schema declaring the event payload structure
 type EventJsonSchema = object
 ```
 
+### `InlineDowngradeStep`
+
+One step of an event's inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.
+
+```ts
+type InlineDowngradeStep = {
+  to: string
+  jsonata: string
+}
+```
+
 ### `Event`
 
 An event instance in the event history
@@ -945,6 +1026,10 @@ type Event = {
   _trigger_source_type?: string
   _trigger_source?: string
   _ack_id?: string
+  _downgrades?: Array<{
+    to: string
+    jsonata: string
+  }>
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.12.0",
+  "version": "2.12.1",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -322,16 +322,6 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix",
-    "prepublishOnly": "npm run build"
-  },
   "keywords": [
     "epilot",
     "sdk",
@@ -525,5 +515,14 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
+  },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix"
   }
-}
+}

package/definitions/focus-pocus-runtime.json

@@ -1 +0,0 @@
-{"s":"https://focus-pocus.dev.sls.epilot.io","o":[["getHealth","get","/v1/health"],["listAchievements","get","/v1/achievements"],["getAchievement","get","/v1/achievements/{id}",[["AchievementOrChallengeId"]]],["getSuggestedChallenge","get","/v1/challenges/suggest",[["route","q"],["entity_type","q"],["category_hint","q"]]],["acceptChallenge","post","/v1/challenges/{id}/accept",[["ChallengeId"]]],["dismissChallenge","post","/v1/challenges/{id}/dismiss",[["ChallengeId"]]],["listActiveChallenges","get","/v1/challenges/active"],["postEvent","post","/v1/events",null,1]],"v":"3.0.3","cp":{"AchievementId":["id","p",true],"AchievementOrChallengeId":["id","p",true],"ChallengeId":["id","p",true],"Cursor":["cursor","q"],"Size":["size","q"]}}