@prismatic-io/spectral 8.0.0-preview7 → 8.0.0

package/dist/clients/http/index.d.ts

@@ -162,7 +162,7 @@ export declare const buildRawRequestAction: (baseUrl: string, label?: string, de
         type: "connection";
         required: true;
     };
-}, boolean, {
+}, import("../..").ConfigVarResultCollection, boolean, {
     data: any;
 }>;
 export { inputs };

package/dist/index.d.ts

@@ -3,7 +3,7 @@
  * authors create inputs, actions, and components that can
  * be processed by the Prismatic API.
  */
-import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVar, ConfigVarResultCollection, ConfigVarCollection, TriggerPayload } from "./types";
 import { convertComponent, convertIntegration } from "./serverTypes/convert";
 /**
  * This function creates a Integration object that can be
@@ -13,21 +13,35 @@ import { convertComponent, convertIntegration } from "./serverTypes/convert";
  * @param definition An IntegrationDefinition type object.
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
-export declare const integration: (definition: IntegrationDefinition) => ReturnType<typeof convertIntegration>;
+export declare const integration: <TConfigVar extends Record<string, ConfigVar> = Record<string, ConfigVar>>(definition: IntegrationDefinition<TConfigVar>) => ReturnType<typeof convertIntegration>;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-flows.
  * @param definition A Flow type object.
  * @returns This function returns a flow object that has the shape the Prismatic API expects.
  */
-export declare const flow: <T extends Flow>(definition: T) => T;
+export declare const flow: <TConfigVars extends ConfigVarCollection = ConfigVarCollection, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigVars, TTriggerPayload> = Flow<TConfigVars, TTriggerPayload>>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-pages.
  * @param definition A Config Page type object.
  * @returns This function returns a config page object that has the shape the Prismatic API expects.
  */
-export declare const configPage: <T extends ConfigPage>(definition: T) => T;
+export declare const configPage: <T extends ConfigPage<ConfigVarCollection>>(definition: T) => T;
+/**
+ * For information on writing Code Native Integrations, see
+ * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * @param definition A Config Var type object.
+ * @returns This function returns a standard config var object that has the shape the Prismatic API expects.
+ */
+export declare const configVar: <T extends StandardConfigVar>(definition: T) => T;
+/**
+ * For information on writing Code Native Integrations, see
+ * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * @param definition A Connection Config Var type object.
+ * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
+ */
+export declare const connectionConfigVar: <T extends ConnectionConfigVar>(definition: T) => T;
 /**
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using
@@ -46,7 +60,7 @@ export declare const component: <TPublic extends boolean, TKey extends string>(d
  * @param definition An ActionDefinition type object that includes UI display information, a function to perform when the action is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same action object.
  */
-export declare const action: <TInputs extends Inputs, TAllowsBranching extends boolean, TReturn extends ActionPerformReturn<TAllowsBranching, unknown>>(definition: ActionDefinition<TInputs, TAllowsBranching, TReturn>) => ActionDefinition<TInputs, TAllowsBranching, TReturn>;
+export declare const action: <TInputs extends Inputs, TConfigVar extends ConfigVarResultCollection, TAllowsBranching extends boolean, TReturn extends ActionPerformReturn<TAllowsBranching, unknown>>(definition: ActionDefinition<TInputs, TConfigVar, TAllowsBranching, TReturn>) => ActionDefinition<TInputs, TConfigVar, TAllowsBranching, TReturn>;
 /**
  * This function creates a trigger object that can be referenced
  * by a custom component. It helps ensure that the shape of the
@@ -56,7 +70,7 @@ export declare const action: <TInputs extends Inputs, TAllowsBranching extends b
  * @param definition A TriggerDefinition type object that includes UI display information, a function to perform when the trigger is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same trigger object.
  */
-export declare const trigger: <TInputs extends Inputs, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching>>(definition: TriggerDefinition<TInputs, TAllowsBranching, TResult>) => TriggerDefinition<TInputs, TAllowsBranching, TResult>;
+export declare const trigger: <TInputs extends Inputs, TConfigVar extends ConfigVarResultCollection, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>>(definition: TriggerDefinition<TInputs, TConfigVar, TAllowsBranching, TResult>) => TriggerDefinition<TInputs, TConfigVar, TAllowsBranching, TResult>;
 /**
  * This function creates a data source object that can be referenced
  * by a custom component. It helps ensure that the shape of the

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testing = exports.util = exports.oauth2Connection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.oauth2Connection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
 const convert_1 = require("./serverTypes/convert");
 /**
  * This function creates a Integration object that can be
@@ -50,6 +50,22 @@ exports.flow = flow;
  */
 const configPage = (definition) => definition;
 exports.configPage = configPage;
+/**
+ * For information on writing Code Native Integrations, see
+ * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * @param definition A Config Var type object.
+ * @returns This function returns a standard config var object that has the shape the Prismatic API expects.
+ */
+const configVar = (definition) => definition;
+exports.configVar = configVar;
+/**
+ * For information on writing Code Native Integrations, see
+ * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * @param definition A Connection Config Var type object.
+ * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
+ */
+const connectionConfigVar = (definition) => definition;
+exports.connectionConfigVar = connectionConfigVar;
 /**
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using

package/dist/serverTypes/convert.js

@@ -121,12 +121,12 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
         documentation,
         version,
         labels,
-        requiredConfigVars: configVars === null || configVars === void 0 ? void 0 : configVars.map((configVar) => convertConfigVar(configVar, referenceKey)),
+        requiredConfigVars: Object.entries(configVars || {}).map(([key, configVar]) => convertConfigVar(Object.assign(Object.assign({}, configVar), { key }), referenceKey)),
         endpointType,
         preprocessFlowName: hasPreprocessFlow ? preprocessFlows[0].name : undefined,
-        externalCustomerIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "action" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerIdField),
-        externalCustomerUserIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "action" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerUserIdField),
-        flowNameField: fieldNameToReferenceInput(hasPreprocessFlow ? "action" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.flowNameField),
+        externalCustomerIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerIdField),
+        externalCustomerUserIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerUserIdField),
+        flowNameField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.flowNameField),
         flows: flows.map((flow) => convertFlow(flow, referenceKey)),
         configPages,
     };
@@ -135,30 +135,24 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
 /** Converts a Flow into the structure necessary for YAML generation. */
 const convertFlow = (flow, referenceKey) => {
     const result = Object.assign({}, flow);
+    delete result.onTrigger;
     delete result.trigger;
-    delete result.action;
+    delete result.onInstanceDeploy;
+    delete result.onInstanceDelete;
+    delete result.onExecution;
     delete result.preprocessFlowConfig;
+    delete result.errorConfig;
     const triggerStep = {
-        name: "trigger",
+        name: "On Trigger",
+        stableKey: `${flow.stableKey}-onTrigger`,
+        description: "The function that will be executed by the flow to return an HTTP response.",
         isTrigger: true,
-        errorConfig: "errorConfig" in flow.trigger ? flow.trigger.errorConfig : undefined,
-    };
-    if ("perform" in flow.trigger) {
-        triggerStep.action = {
-            key: flowFunctionKey(flow.name, "trigger"),
+        errorConfig: "errorConfig" in flow ? Object.assign({}, flow.errorConfig) : undefined,
+        action: {
+            key: flowFunctionKey(flow.name, "onTrigger"),
             component: { key: referenceKey, version: "LATEST", isPublic: false },
-        };
-    }
-    else {
-        triggerStep.action = {
-            key: flow.trigger.key,
-            component: flow.trigger.component,
-        };
-    }
-    if ("inputs" in flow.trigger) {
-        triggerStep.inputs = flow.trigger.inputs;
-        delete result.inputs;
-    }
+        },
+    };
     if ("schedule" in flow && typeof flow.schedule === "object") {
         triggerStep.schedule = {
             type: "cronExpression" in flow.schedule
@@ -176,34 +170,72 @@ const convertFlow = (flow, referenceKey) => {
     }
     const actionStep = {
         action: {
-            key: flowFunctionKey(flow.name, "action"),
+            key: flowFunctionKey(flow.name, "onExecution"),
             component: { key: referenceKey, version: "LATEST", isPublic: false },
         },
-        name: "action",
-        errorConfig: "errorConfig" in flow.action ? flow.action.errorConfig : undefined,
+        name: "On Execution",
+        stableKey: `${flow.stableKey}-onExecution`,
+        description: "The function that will be executed by the flow.",
+        errorConfig: "errorConfig" in flow ? Object.assign({}, flow.errorConfig) : undefined,
     };
     result.steps = [triggerStep, actionStep];
     return result;
 };
 /** Converts a Config Var into the structure necessary for YAML generation. */
 const convertConfigVar = (configVar, referenceKey) => {
-    const result = Object.assign(Object.assign({}, configVar), { meta: {} });
+    // This is unfortunate but we need to strip out some fields that are not
+    // relevant to config vars.
+    const fields = [
+        "key",
+        "stableKey",
+        "description",
+        "orgOnly",
+        "inputs",
+        "defaultValue",
+        "dataType",
+        "pickList",
+        "scheduleType",
+        "timeZone",
+        "codeLanguage",
+        "collectionType",
+        "dataSource",
+    ];
+    const result = Object.entries(configVar).reduce((result, [key, value]) => {
+        if (!fields.includes(key)) {
+            return result;
+        }
+        return Object.assign(Object.assign({}, result), { [key]: value });
+    }, { meta: {} });
     // Handle some non-standard fields.
-    if ("visibleToOrgDeployer" in result) {
-        result.meta.visibleToOrgDeployer = result.visibleToOrgDeployer;
-        delete result.visibleToOrgDeployer;
+    if ("visibleToOrgDeployer" in configVar) {
+        result.meta.visibleToOrgDeployer = configVar.visibleToOrgDeployer;
     }
-    if ("visibleToCustomerDeployer" in result) {
-        result.meta.visibleToCustomerDeployer = result.visibleToCustomerDeployer;
-        delete result.visibleToCustomerDeployer;
+    if ("visibleToCustomerDeployer" in configVar) {
+        result.meta.visibleToCustomerDeployer = configVar.visibleToCustomerDeployer;
     }
-    if ("connection" in result && typeof result.connection === "string") {
+    // Handle connections.
+    if ("label" in configVar) {
+        result.dataType = "connection";
+        // This refers to a connection we are creating.
         result.connection = {
-            key: result.connection,
+            key: configVar.key,
             component: { key: referenceKey, version: "LATEST", isPublic: false },
         };
+        result.description = configVar.label;
+        // Convert connection inputs to the inputs expected in the YAML.
+        // FIXME: This is just a placeholder for now.
+        // TODO: It seems like using the default value as the value is probably correct?
+        result.inputs = Object.entries(configVar.inputs).reduce((result, [key, input]) => {
+            var _a;
+            return Object.assign(Object.assign({}, result), { [key]: {
+                    type: types_1.SimpleInputValueType.Value,
+                    value: (_a = input.default) !== null && _a !== void 0 ? _a : "",
+                } });
+        }, {});
     }
-    if ("dataSource" in result && typeof result.dataSource === "string") {
+    // Handle data source references.
+    if ("dataSource" in result) {
+        // This is a reference to a data source we are creating.
         result.dataSource = {
             key: result.dataSource,
             component: { key: referenceKey, version: "LATEST", isPublic: false },
@@ -233,24 +265,54 @@ const flowFunctionKey = (flowName, functionName) => {
         ? w.toLowerCase()
         : w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
         .join("");
-    // functionName is only going to be either 'action' or 'trigger'.
     return `${flowKey}_${functionName}`;
 };
 /** Creates the structure necessary to import a Component as part of a
  *  Code Native integration. */
-const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [], dataSources = {}, connections = [], }, referenceKey) => {
-    const convertedActions = flows.reduce((result, { name, action }) => {
-        const actionKey = flowFunctionKey(name, "action");
-        return Object.assign(Object.assign({}, result), { [actionKey]: convertAction(actionKey, Object.assign(Object.assign({}, action), { display: { label: "action", description: "" }, inputs: {} })) });
+const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [], dataSources = {}, configVars = {}, }, referenceKey) => {
+    const convertedActions = flows.reduce((result, { name, onExecution }) => {
+        const actionKey = flowFunctionKey(name, "onExecution");
+        return Object.assign(Object.assign({}, result), { [actionKey]: convertAction(actionKey, {
+                display: {
+                    label: `${name} - onExecution`,
+                    description: "The function that will be executed by the flow.",
+                },
+                perform: onExecution,
+                inputs: {},
+            }) });
     }, {});
-    const convertedTriggers = flows.reduce((result, { name, trigger }) => {
+    const convertedTriggers = flows.reduce((result, flow) => {
         // Filter out TriggerReferences.
-        if (typeof trigger !== "object" || !("perform" in trigger))
+        if ("trigger" in flow)
             return result;
-        const triggerKey = flowFunctionKey(name, "trigger");
-        return Object.assign(Object.assign({}, result), { [triggerKey]: convertTrigger(triggerKey, Object.assign(Object.assign({}, trigger), { display: { label: "trigger", description: "" }, inputs: {}, scheduleSupport: "valid", synchronousResponseSupport: "valid" })) });
+        const { name, onTrigger, onInstanceDeploy, onInstanceDelete } = flow;
+        const triggerKey = flowFunctionKey(name, "onTrigger");
+        return Object.assign(Object.assign({}, result), { [triggerKey]: convertTrigger(triggerKey, {
+                display: {
+                    label: `${name} - onTrigger`,
+                    description: "The function that will be executed by the flow to return an HTTP response.",
+                },
+                perform: onTrigger,
+                onInstanceDeploy: onInstanceDeploy,
+                onInstanceDelete: onInstanceDelete,
+                inputs: {},
+                scheduleSupport: "valid",
+                synchronousResponseSupport: "valid",
+            }) });
     }, {});
     const convertedDataSources = Object.entries(dataSources).reduce((result, [dataSourceKey, dataSource]) => (Object.assign(Object.assign({}, result), { [dataSourceKey]: convertDataSource(dataSourceKey, Object.assign(Object.assign({}, dataSource), { inputs: {} })) })), {});
+    const convertedConnections = Object.entries(configVars).reduce((result, [key, configVar]) => {
+        if (!("label" in configVar)) {
+            return result;
+        }
+        // Remove a few fields that are not relevant to connections.
+        const { 
+        /* eslint-disable @typescript-eslint/no-unused-vars */
+        orgOnly, visibleToOrgDeployer, visibleToCustomerDeployer, stableKey } = configVar, 
+        /* eslint-enable @typescript-eslint/no-unused-vars */
+        connection = __rest(configVar, ["orgOnly", "visibleToOrgDeployer", "visibleToCustomerDeployer", "stableKey"]);
+        return [...result, convertConnection(Object.assign(Object.assign({}, connection), { key }))];
+    }, []);
     return {
         key: referenceKey,
         display: {
@@ -258,7 +320,7 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
             iconPath,
             description: description || name,
         },
-        connections: connections.map(convertConnection),
+        connections: convertedConnections,
         actions: convertedActions,
         triggers: convertedTriggers,
         dataSources: convertedDataSources,

package/dist/serverTypes/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { InstanceAttributes, CustomerAttributes, DataSourceType, DataSourceResultType, UserAttributes, TriggerEventFunctionReturn, IntegrationAttributes, FlowAttributes } from "../types";
+import { InstanceAttributes, CustomerAttributes, DataSourceType, DataSourceResultType, UserAttributes, TriggerEventFunctionReturn, IntegrationAttributes, FlowAttributes, ConfigVarResultCollection } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
@@ -48,9 +48,8 @@ export interface ActionLogger {
     warn: ActionLoggerFunction;
     error: ActionLoggerFunction;
 }
-export interface ActionContext {
+export declare type ActionContext<TConfigVars extends ConfigVarResultCollection, THasConfigVars extends boolean = false> = {
     logger: ActionLogger;
-    configVars?: Record<string, unknown>;
     instanceState: Record<string, unknown>;
     crossFlowState: Record<string, unknown>;
     executionState: Record<string, unknown>;
@@ -66,7 +65,9 @@ export interface ActionContext {
     integration: IntegrationAttributes;
     flow: FlowAttributes;
     startedAt: string;
-}
+} & (THasConfigVars extends true ? {
+    configVars: TConfigVars;
+} : Record<string, never>);
 declare type TriggerOptionChoice = "invalid" | "valid" | "required";
 export interface TriggerPayload {
     headers: Record<string, string>;
@@ -111,9 +112,9 @@ interface TriggerBranchingResult extends TriggerBaseResult {
     branch: string;
 }
 export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
-export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
+export declare type TriggerPerformFunction = (context: ActionContext<any>, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
 export declare type TriggerEventFunctionResult = TriggerEventFunctionReturn | void;
-export declare type TriggerEventFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<TriggerEventFunctionResult>;
+export declare type TriggerEventFunction = (context: ActionContext<any>, params: Record<string, unknown>) => Promise<TriggerEventFunctionResult>;
 export interface Trigger {
     key: string;
     display: DisplayDefinition & {
@@ -213,7 +214,7 @@ interface ServerPerformBranchingDataReturn extends ServerPerformDataReturn {
     branch: string;
 }
 export declare type ActionPerformReturn = ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn | ServerPerformDataReturn | ServerPerformBranchingDataReturn | undefined;
-export declare type ActionPerformFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<ActionPerformReturn>;
+export declare type ActionPerformFunction = (context: ActionContext<any>, params: Record<string, unknown>) => Promise<ActionPerformReturn>;
 interface InputFieldChoice {
     label: string;
     value: string;

package/dist/testing.d.ts

@@ -5,7 +5,7 @@
  * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
  */
 import { TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, ActionContext, ActionPerformReturn, DataSourceResult, DataSourceContext } from "./serverTypes";
-import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow } from "./types";
+import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow, ConfigVarResultCollection, ConfigVarCollection, ConfigVarDefinitionsToResults } from "./types";
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>, tokenValues?: Record<string, unknown> | undefined) => ConnectionValue;
 /**
  * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected.
@@ -25,7 +25,7 @@ interface InvokeReturn<ReturnData> {
  * to avoid extra casting within test methods. Returns an InvokeResult containing both the
  * action result and a mock logger for asserting logging.
  */
-export declare const invoke: <TInputs extends Inputs, TAllowsBranching extends boolean, TReturn extends InvokeActionPerformReturn<TAllowsBranching, unknown>>({ perform }: ActionDefinition<TInputs, TAllowsBranching, TReturn>, params: ActionInputParameters<TInputs>, context?: Partial<ActionContext> | undefined) => Promise<InvokeReturn<TReturn>>;
+export declare const invoke: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TReturn extends InvokeActionPerformReturn<TAllowsBranching, unknown>>({ perform, }: ActionDefinition<TInputs, TConfigVars, TAllowsBranching, TReturn>, params: ActionInputParameters<TInputs>, context?: Partial<ActionContext<TConfigVars, false>> | undefined) => Promise<InvokeReturn<TReturn>>;
 export declare const defaultTriggerPayload: () => TriggerPayload;
 /**
  * Invokes specified TriggerDefinition perform function using supplied params
@@ -33,7 +33,7 @@ export declare const defaultTriggerPayload: () => TriggerPayload;
  * to avoid extra casting within test methods. Returns an InvokeResult containing both the
  * trigger result and a mock logger for asserting logging.
  */
-export declare const invokeTrigger: <TInputs extends Inputs, TAllowsBranching extends boolean, TResult extends InvokeTriggerResult<TAllowsBranching>>({ perform }: TriggerDefinition<TInputs, TAllowsBranching, TResult>, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<TInputs> | undefined) => Promise<InvokeReturn<TResult>>;
+export declare const invokeTrigger: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TResult extends InvokeTriggerResult<TAllowsBranching, TriggerPayload>>({ perform, }: TriggerDefinition<TInputs, TConfigVars, TAllowsBranching, TResult>, context?: Partial<ActionContext<TConfigVars, false>> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<TInputs> | undefined) => Promise<InvokeReturn<TResult>>;
 /**
  * Invokes specified DataSourceDefinition perform function using supplied params.
  * Accepts a generic type matching DataSourceResult as a convenience to avoid extra
@@ -60,24 +60,24 @@ export declare const invokeDataSource: <TInputs extends Inputs, TDataSourceType
  * Invokes specified Flow of a Code Native Integration using supplied params.
  * Runs the Trigger and then the Action function and returns the result of the Action.
  */
-export declare const invokeFlow: ({ trigger, action }: Flow, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
+export declare const invokeFlow: <TConfigVars extends ConfigVarCollection>(flow: Flow<TConfigVars, import("./types").TriggerPayload>, context?: Partial<ActionContext<ConfigVarDefinitionsToResults<TConfigVars>, true>> | undefined, payload?: TriggerPayload | undefined) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
 export declare class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);
     private buildContext;
     private buildParams;
     connectionValue({ key }: ConnectionDefinition): ConnectionValue;
-    trigger(key: string, payload?: TriggerPayload, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<TriggerResult>;
-    triggerOnInstanceDeploy(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<void | TriggerEventFunctionReturn>;
-    triggerOnInstanceDelete(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<void | TriggerEventFunctionReturn>;
-    action(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<ActionPerformReturn>;
+    trigger<TConfigVars extends ConfigVarResultCollection>(key: string, payload?: TriggerPayload, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<TriggerResult>;
+    triggerOnInstanceDeploy<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<void | TriggerEventFunctionReturn>;
+    triggerOnInstanceDelete<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<void | TriggerEventFunctionReturn>;
+    action<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<ActionPerformReturn>;
     dataSource(key: string, params?: Record<string, unknown>, context?: Partial<DataSourceContext>): Promise<DataSourceResult>;
 }
 export declare const createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
 declare const _default: {
     loggerMock: () => ActionLogger;
-    invoke: <TInputs extends Inputs, TAllowsBranching extends boolean, TReturn extends InvokeActionPerformReturn<TAllowsBranching, unknown>>({ perform }: ActionDefinition<TInputs, TAllowsBranching, TReturn>, params: ActionInputParameters<TInputs>, context?: Partial<ActionContext> | undefined) => Promise<InvokeReturn<TReturn>>;
-    invokeTrigger: <TInputs_1 extends Inputs, TAllowsBranching_1 extends boolean, TResult extends InvokeTriggerResult<TAllowsBranching_1>>({ perform }: TriggerDefinition<TInputs_1, TAllowsBranching_1, TResult>, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<TInputs_1> | undefined) => Promise<InvokeReturn<TResult>>;
+    invoke: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TReturn extends InvokeActionPerformReturn<TAllowsBranching, unknown>>({ perform, }: ActionDefinition<TInputs, TConfigVars, TAllowsBranching, TReturn>, params: ActionInputParameters<TInputs>, context?: Partial<ActionContext<TConfigVars, false>> | undefined) => Promise<InvokeReturn<TReturn>>;
+    invokeTrigger: <TInputs_1 extends Inputs, TConfigVars_1 extends ConfigVarResultCollection, TAllowsBranching_1 extends boolean, TResult extends InvokeTriggerResult<TAllowsBranching_1, TriggerPayload>>({ perform, }: TriggerDefinition<TInputs_1, TConfigVars_1, TAllowsBranching_1, TResult>, context?: Partial<ActionContext<TConfigVars_1, false>> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<TInputs_1> | undefined) => Promise<InvokeReturn<TResult>>;
     createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
     invokeDataSource: <TInputs_2 extends Inputs, TDataSourceType extends keyof {
         string: string;

package/dist/testing.js

@@ -38,47 +38,32 @@ const loggerMock = () => ({
     error: (0, jest_mock_1.spyOn)(console, "error"),
 });
 exports.loggerMock = loggerMock;
-const baseActionContext = {
-    logger: (0, exports.loggerMock)(),
-    instanceState: {},
-    crossFlowState: {},
-    executionState: {},
-    integrationState: {},
-    stepId: "mockStepId",
-    executionId: "mockExecutionId",
-    webhookUrls: {
-        "Flow 1": "https://example.com",
-    },
-    webhookApiKeys: {
-        "Flow 1": ["example-123", "example-456"],
-    },
-    invokeUrl: "https://example.com",
-    customer: {
-        id: "customerId",
-        name: "Customer 1",
-        externalId: "1234",
-    },
-    instance: {
-        id: "instanceId",
-        name: "Instance 1",
-    },
-    user: {
-        id: "userId",
-        email: "user@example.com",
-        name: "User 1",
-        externalId: "1234",
-    },
-    integration: {
-        id: "integrationId",
-        name: "Integration 1",
-        versionSequenceId: "1234",
-        externalVersion: "1.0.0",
-    },
-    flow: {
-        id: "flowId",
-        name: "Flow 1",
-    },
-    startedAt: new Date().toISOString(),
+const createActionContext = (context) => {
+    return Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, integrationState: {}, stepId: "mockStepId", executionId: "mockExecutionId", webhookUrls: {
+            "Flow 1": "https://example.com",
+        }, webhookApiKeys: {
+            "Flow 1": ["example-123", "example-456"],
+        }, invokeUrl: "https://example.com", customer: {
+            id: "customerId",
+            name: "Customer 1",
+            externalId: "1234",
+        }, instance: {
+            id: "instanceId",
+            name: "Instance 1",
+        }, user: {
+            id: "userId",
+            email: "user@example.com",
+            name: "User 1",
+            externalId: "1234",
+        }, integration: {
+            id: "integrationId",
+            name: "Integration 1",
+            versionSequenceId: "1234",
+            externalVersion: "1.0.0",
+        }, flow: {
+            id: "flowId",
+            name: "Flow 1",
+        }, startedAt: new Date().toISOString() }, context);
 };
 /**
  * Invokes specified ActionDefinition perform function using supplied params
@@ -86,8 +71,8 @@ const baseActionContext = {
  * to avoid extra casting within test methods. Returns an InvokeResult containing both the
  * action result and a mock logger for asserting logging.
  */
-const invoke = ({ perform }, params, context) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign(Object.assign({}, baseActionContext), context);
+const invoke = ({ perform, }, params, context) => __awaiter(void 0, void 0, void 0, function* () {
+    const realizedContext = createActionContext(context);
     const result = yield perform(realizedContext, params);
     return {
         result,
@@ -155,8 +140,8 @@ exports.defaultTriggerPayload = defaultTriggerPayload;
  * to avoid extra casting within test methods. Returns an InvokeResult containing both the
  * trigger result and a mock logger for asserting logging.
  */
-const invokeTrigger = ({ perform }, context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign(Object.assign({}, baseActionContext), context);
+const invokeTrigger = ({ perform, }, context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
+    const realizedContext = createActionContext(context);
     const realizedPayload = Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload);
     const realizedParams = params || {};
     const result = yield perform(realizedContext, realizedPayload, realizedParams);
@@ -199,15 +184,17 @@ exports.invokeDataSource = invokeDataSource;
  * Invokes specified Flow of a Code Native Integration using supplied params.
  * Runs the Trigger and then the Action function and returns the result of the Action.
  */
-const invokeFlow = ({ trigger, action }, context, payload) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign(Object.assign({}, baseActionContext), context);
+const invokeFlow = (flow, context, payload) => __awaiter(void 0, void 0, void 0, function* () {
+    const realizedContext = createActionContext(context);
     const realizedPayload = Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload);
-    const params = {};
-    if (typeof trigger === "object" && "perform" in trigger) {
-        const triggerResult = yield trigger.perform(realizedContext, realizedPayload, params);
-        params.trigger = triggerResult;
+    const params = {
+        onTrigger: { results: null },
+    };
+    if ("onTrigger" in flow) {
+        const triggerResult = yield flow.onTrigger(realizedContext, realizedPayload, params);
+        params.onTrigger = { results: triggerResult === null || triggerResult === void 0 ? void 0 : triggerResult.payload };
     }
-    const result = yield action.perform(realizedContext, params);
+    const result = yield flow.onExecution(realizedContext, params);
     return {
         result,
         loggerMock: realizedContext.logger,
@@ -236,7 +223,7 @@ class ComponentTestHarness {
     trigger(key, payload, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const trigger = this.component.triggers[key];
-            return trigger.perform(this.buildContext(baseActionContext, context), Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload), this.buildParams(trigger.inputs, params));
+            return trigger.perform(createActionContext(context), Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload), this.buildParams(trigger.inputs, params));
         });
     }
     triggerOnInstanceDeploy(key, params, context) {
@@ -245,7 +232,7 @@ class ComponentTestHarness {
             if (!trigger.onInstanceDeploy) {
                 throw new Error("Trigger does not support onInstanceDeploy");
             }
-            return trigger.onInstanceDeploy(this.buildContext(baseActionContext, context), this.buildParams(trigger.inputs, params));
+            return trigger.onInstanceDeploy(createActionContext(context), this.buildParams(trigger.inputs, params));
         });
     }
     triggerOnInstanceDelete(key, params, context) {
@@ -254,13 +241,13 @@ class ComponentTestHarness {
             if (!trigger.onInstanceDelete) {
                 throw new Error("Trigger does not support onInstanceDelete");
             }
-            return trigger.onInstanceDelete(this.buildContext(baseActionContext, context), this.buildParams(trigger.inputs, params));
+            return trigger.onInstanceDelete(createActionContext(context), this.buildParams(trigger.inputs, params));
         });
     }
     action(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const action = this.component.actions[key];
-            return action.perform(this.buildContext(baseActionContext, context), this.buildParams(action.inputs, params));
+            return action.perform(createActionContext(context), this.buildParams(action.inputs, params));
         });
     }
     dataSource(key, params, context) {

package/dist/types/ActionDefinition.d.ts

@@ -1,13 +1,13 @@
-import { ActionDisplayDefinition, ActionPerformFunction, ActionPerformReturn, Inputs } from ".";
+import { ActionDisplayDefinition, ActionPerformFunction, ActionPerformReturn, ConfigVarResultCollection, Inputs } from ".";
 /**
  * ActionDefinition is the type of the object that is passed in to `action` function to
  * define a component action.
  */
-export interface ActionDefinition<TInputs extends Inputs, TAllowsBranching extends boolean, TReturn extends ActionPerformReturn<TAllowsBranching, unknown>> {
+export interface ActionDefinition<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TAllowsBranching extends boolean = boolean, TReturn extends ActionPerformReturn<TAllowsBranching, unknown> = ActionPerformReturn<TAllowsBranching, unknown>> {
     /** Defines how the Action is displayed in the Prismatic interface. */
     display: ActionDisplayDefinition;
     /** Function to perform when this Action is invoked. */
-    perform: ActionPerformFunction<TInputs, TAllowsBranching, TReturn>;
+    perform: ActionPerformFunction<TInputs, TConfigVars, false, TAllowsBranching, TReturn>;
     /** InputFields to present in the Prismatic interface for configuration of this Action. */
     inputs: TInputs;
     /** Optional attribute that specifies whether an Action will terminate execution.*/