@prismatic-io/spectral 7.8.0-preview2 → 7.8.0-preview4

package/dist/serverTypes/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Instance, Customer, DataSourceType, DataSourceResultType, User } from "../types";
+import { Instance, Customer, DataSourceType, DataSourceResultType, User, TriggerEventFunctionReturn } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
@@ -102,13 +102,7 @@ interface TriggerBranchingResult extends TriggerBaseResult {
 }
 export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
 export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
-export interface TriggerEventFunctionContext {
-    logger: ActionLogger;
-    customer: Customer;
-    instance: Instance;
-    user: User;
-}
-export declare type TriggerEventFunction = (context: TriggerEventFunctionContext, params: Record<string, unknown>) => Promise<void>;
+export declare type TriggerEventFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<void | TriggerEventFunctionReturn>;
 export interface Trigger {
     key: string;
     display: DisplayDefinition & {

package/dist/types/TriggerEventFunction.d.ts

@@ -1,10 +1,13 @@
-import { Inputs, ActionInputParameters, ActionLogger, Customer, Instance, User } from ".";
-/** Context provided to the event function containing helpers and contextual data */
-export interface TriggerEventFunctionContext {
-    logger: ActionLogger;
-    customer: Customer;
-    instance: Instance;
-    user: User;
-}
+import { Inputs, ActionContext, ActionInputParameters } from ".";
+export declare type TriggerEventFunctionReturn = {
+    /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
+    instanceState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
+    crossFlowState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    executionState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions */
+    integrationState?: Record<string, unknown>;
+};
 /** Definition of the function to execute when a Trigger Event occurs. */
-export declare type TriggerEventFunction<TInputs extends Inputs> = (context: TriggerEventFunctionContext, params: ActionInputParameters<TInputs>) => Promise<void>;
+export declare type TriggerEventFunction<TInputs extends Inputs> = (context: ActionContext, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.8.0-preview2",
+  "version": "7.8.0-preview4",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"