@prismatic-io/spectral 10.3.0 → 10.3.1

package/dist/serverTypes/convertIntegration.js

@@ -20,6 +20,7 @@ const types_1 = require("../types");
 const convertComponent_1 = require("./convertComponent");
 const integration_1 = require("./integration");
 const lodash_2 = require("lodash");
+const perform_1 = require("./perform");
 const convertIntegration = (definition) => {
     var _a, _b, _c;
     // Generate a unique reference key that will be used to reference the
@@ -546,7 +547,7 @@ const convertOnExecution = (onExecution, componentRegistry) => (context, params)
         }, {});
         return Object.assign(Object.assign({}, accumulator), { [registryComponentKey]: componentActions });
     }, {});
-    return onExecution(Object.assign(Object.assign({}, context), { components: componentMethods }), params);
+    return onExecution(Object.assign(Object.assign({}, context), { components: componentMethods, invokeFlow: (0, perform_1.createInvokeFlow)(context, { isCNI: true }) }), params);
 };
 /** Creates the structure necessary to import a Component as part of a
  *  Code Native integration. */

package/dist/serverTypes/index.d.ts

@@ -1,4 +1,4 @@
-import { InstanceAttributes, CustomerAttributes, DataSourceType, DataSourceResultType, UserAttributes, TriggerEventFunctionReturn, IntegrationAttributes, FlowAttributes, ConfigVarResultCollection, ComponentManifest } from "../types";
+import { InstanceAttributes, CustomerAttributes, DataSourceType, DataSourceResultType, UserAttributes, TriggerEventFunctionReturn, IntegrationAttributes, FlowAttributes, ConfigVarResultCollection, ComponentManifest, FlowInvoker, ExecutionFrame } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
@@ -47,7 +47,7 @@ export interface ActionLogger {
     warn: ActionLoggerFunction;
     error: ActionLoggerFunction;
 }
-export type ActionContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]> = Record<string, ComponentManifest["actions"]>> = {
+export type ActionContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]> = Record<string, ComponentManifest["actions"]>, TFlows extends string[] = string[]> = {
     logger: ActionLogger;
     instanceState: Record<string, unknown>;
     crossFlowState: Record<string, unknown>;
@@ -70,6 +70,8 @@ export type ActionContext<TConfigVars extends ConfigVarResultCollection = Config
     integration: IntegrationAttributes;
     flow: FlowAttributes;
     startedAt: string;
+    invokeFlow: FlowInvoker<TFlows>;
+    executionFrame: ExecutionFrame;
 };
 type TriggerOptionChoice = "invalid" | "valid" | "required";
 export interface TriggerPayload {

package/dist/serverTypes/index.js

@@ -1,4 +1,6 @@
 "use strict";
+/* Types used to describe the format the platform expects for
+ * component and integration definitions. */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OAuth2Type = void 0;
 var OAuth2Type;

package/dist/serverTypes/perform.d.ts

@@ -1,4 +1,4 @@
-import type { ErrorHandler, Inputs, PollingTriggerPerformFunction } from "../types";
+import type { ActionContext, ErrorHandler, FlowInvoker, Inputs, PollingTriggerPerformFunction } from "../types";
 import { type PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
 export type PerformFn = (...args: any[]) => Promise<any>;
 export type CleanFn = (...args: any[]) => any;
@@ -8,6 +8,9 @@ interface CreatePerformProps {
     errorHandler?: ErrorHandler;
 }
 export declare const cleanParams: (params: Record<string, unknown>, cleaners: InputCleaners) => Record<string, any>;
+export declare const createInvokeFlow: <const TFlows extends Readonly<string[]>>(context: ActionContext, options?: {
+    isCNI?: boolean;
+}) => FlowInvoker<TFlows>;
 export declare const createPerform: (performFn: PerformFn, { inputCleaners, errorHandler }: CreatePerformProps) => PerformFn;
 export declare const createPollingPerform: (trigger: PollingTriggerDefinition, { inputCleaners, errorHandler }: CreatePerformProps) => PollingTriggerPerformFunction<Inputs, Inputs>;
 export {};

package/dist/serverTypes/perform.js

@@ -19,8 +19,12 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPollingPerform = exports.createPerform = exports.cleanParams = void 0;
+exports.createPollingPerform = exports.createPerform = exports.createInvokeFlow = exports.cleanParams = void 0;
+const axios_1 = __importDefault(require("axios"));
 const lodash_1 = require("lodash");
 const cleanParams = (params, cleaners) => {
     const keys = (0, lodash_1.uniq)([...Object.keys(params), ...Object.keys(cleaners)]);
@@ -31,6 +35,21 @@ const cleanParams = (params, cleaners) => {
     }, {});
 };
 exports.cleanParams = cleanParams;
+function formatExecutionFrameHeaders(frame, source) {
+    let frameToUse = frame;
+    if (source) {
+        frameToUse = Object.assign(Object.assign({}, frame), { customSource: source });
+    }
+    return JSON.stringify(frameToUse);
+}
+const createInvokeFlow = (context, options = {}) => {
+    return (flowName, data, config, source) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const sourceToUse = options.isCNI ? source : undefined;
+        return yield axios_1.default.post(context.webhookUrls[flowName], data, Object.assign(Object.assign({}, config), { headers: Object.assign(Object.assign({}, ((_a = config === null || config === void 0 ? void 0 : config.headers) !== null && _a !== void 0 ? _a : {})), { "prismatic-invoked-by": formatExecutionFrameHeaders(context.executionFrame, sourceToUse) }) }));
+    });
+};
+exports.createInvokeFlow = createInvokeFlow;
 const createPerform = (performFn, { inputCleaners, errorHandler }) => {
     return (...args) => __awaiter(void 0, void 0, void 0, function* () {
         try {
@@ -40,10 +59,10 @@ const createPerform = (performFn, { inputCleaners, errorHandler }) => {
             }
             if (args.length === 2) {
                 const [context, params] = args;
-                return yield performFn(context, (0, exports.cleanParams)(params, inputCleaners));
+                return yield performFn(Object.assign(Object.assign({}, context), { invokeFlow: (0, exports.createInvokeFlow)(context) }), (0, exports.cleanParams)(params, inputCleaners));
             }
             const [context, payload, params] = args;
-            return yield performFn(context, payload, (0, exports.cleanParams)(params, inputCleaners));
+            return yield performFn(Object.assign(Object.assign({}, context), { invokeFlow: (0, exports.createInvokeFlow)(context) }), payload, (0, exports.cleanParams)(params, inputCleaners));
         }
         catch (error) {
             throw errorHandler ? errorHandler(error) : error;
@@ -69,6 +88,7 @@ const createPollingPerform = (trigger, { inputCleaners, errorHandler }) => {
         try {
             const { pollAction } = trigger;
             const pollingContext = {
+                invokeFlow: (0, exports.createInvokeFlow)(context),
                 polling: {
                     invokeAction: createInvokePollAction(context, pollAction, {
                         inputCleaners,

package/dist/testing.d.ts

@@ -4,8 +4,8 @@
  * information on unit testing, check out our docs:
  * 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, DataSourceType, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow, ConfigVarResultCollection } from "./types";
+import { TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, ActionPerformReturn, DataSourceResult, DataSourceContext } from "./serverTypes";
+import { ActionContext, ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceType, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow, ConfigVarResultCollection } from "./types";
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>, tokenValues?: Record<string, unknown>) => ConnectionValue;
 export declare const defaultConnectionValueEnvironmentVariable = "PRISMATIC_CONNECTION_VALUE";
 export declare const connectionValue: (envVarKey?: string) => ConnectionValue;

package/dist/testing.js

@@ -48,6 +48,11 @@ const loggerMock = () => ({
     error: (0, jest_mock_1.spyOn)(console, "error"),
 });
 exports.loggerMock = loggerMock;
+function invokeFlowTest(flowName, data, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return Promise.resolve({});
+    });
+}
 const createActionContext = (context) => {
     return Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, integrationState: {}, configVars: {}, components: {}, stepId: "mockStepId", executionId: "mockExecutionId", webhookUrls: {
             "Flow 1": "https://example.com",
@@ -73,7 +78,15 @@ const createActionContext = (context) => {
         }, flow: {
             id: "flowId",
             name: "Flow 1",
-        }, startedAt: new Date().toISOString() }, context);
+        }, startedAt: new Date().toISOString(), invokeFlow: invokeFlowTest, executionFrame: {
+            invokedByExecutionJWT: "some-jwt",
+            invokedByExecutionStartedAt: "00-00-0000",
+            componentActionKey: "my-component-action-key",
+            executionId: "abc-123",
+            executionStartedAt: "",
+            stepName: "some-step",
+            loopPath: "",
+        } }, context);
 };
 const createDataSourceContext = (context) => {
     return Object.assign({ logger: (0, exports.loggerMock)(), configVars: {}, customer: {

package/dist/types/ActionPerformFunction.d.ts

@@ -1,8 +1,27 @@
+import { AxiosRequestConfig, AxiosResponse } from "axios";
 import { Inputs, ConfigVarResultCollection, ActionPerformReturn, ActionInputParameters, ActionLogger, InstanceAttributes, CustomerAttributes, UserAttributes, IntegrationAttributes, FlowAttributes, ComponentManifest } from ".";
+interface StandardLineage {
+    componentActionKey: string;
+    executionId: string;
+    executionStartedAt: string;
+    stepName: string;
+    loopPath: string;
+}
+interface CustomLineage {
+    customSource: string;
+}
+export type ExecutionFrame = ({
+    invokedByExecutionJWT: string;
+    invokedByExecutionStartedAt: string;
+} & StandardLineage) | ({
+    invokedByExecutionJWT: string;
+    invokedByExecutionStartedAt: string;
+} & CustomLineage);
+export type FlowInvoker<TFlows extends Readonly<string[]> | undefined> = (flowName: TFlows extends Readonly<string[]> ? TFlows[number] : string, data?: Record<string, unknown>, config?: AxiosRequestConfig<any>, source?: string) => Promise<AxiosResponse<any, any>>;
 /** Definition of the function to perform when an Action is invoked. */
 export type ActionPerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]>, TAllowsBranching extends boolean | undefined, TReturn extends ActionPerformReturn<TAllowsBranching, unknown>> = (context: ActionContext<TConfigVars, TComponentActions>, params: ActionInputParameters<TInputs>) => Promise<TReturn>;
 /** Context provided to perform method containing helpers and contextual data */
-export type ActionContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]> = Record<string, ComponentManifest["actions"]>> = {
+export type ActionContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]> = Record<string, ComponentManifest["actions"]>, TFlows extends string[] = string[]> = {
     /** Logger for permanent logging; console calls are also captured */
     logger: ActionLogger;
     /** A a flow-specific key/value store that may be used to store small amounts of data that is persisted between Instance executions */
@@ -43,4 +62,9 @@ export type ActionContext<TConfigVars extends ConfigVarResultCollection = Config
     flow: FlowAttributes;
     /** The time in UTC that execution started. */
     startedAt: string;
+    /** Function to invoke an execution of another flow.. */
+    invokeFlow: FlowInvoker<TFlows>;
+    /** Reference to the current execution and, when applicable, the current step. */
+    executionFrame: ExecutionFrame;
 };
+export {};

package/dist/types/PollingTriggerDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { ActionDisplayDefinition, TriggerEventFunction, Inputs, ConfigVarResultCollection, TriggerPayload, ActionDefinition, ActionContext, ActionInputParameters, ActionPerformReturn, TriggerResult } from ".";
+import type { ActionDisplayDefinition, TriggerEventFunction, Inputs, ConfigVarResultCollection, TriggerPayload, ActionDefinition, ActionInputParameters, ActionPerformReturn, TriggerResult, ActionContext } from ".";
 export interface PollingContext<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection> extends ActionContext<TConfigVars> {
     polling: {
         invokeAction: (params: ActionInputParameters<TInputs>) => Promise<ActionPerformReturn<boolean, any>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.3.0",
+  "version": "10.3.1",
   "description": "Utility library for building Prismatic components and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",