@prismatic-io/spectral 8.0.0-preview6 → 8.0.0-preview7

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 } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage } from "./types";
 import { convertComponent, convertIntegration } from "./serverTypes/convert";
 /**
  * This function creates a Integration object that can be
@@ -14,6 +14,20 @@ import { convertComponent, convertIntegration } from "./serverTypes/convert";
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
 export declare const integration: (definition: IntegrationDefinition) => 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;
+/**
+ * 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;
 /**
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using

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.integration = void 0;
+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;
 const convert_1 = require("./serverTypes/convert");
 /**
  * This function creates a Integration object that can be
@@ -34,6 +34,22 @@ const convert_1 = require("./serverTypes/convert");
  */
 const integration = (definition) => (0, convert_1.convertIntegration)(definition);
 exports.integration = integration;
+/**
+ * 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.
+ */
+const flow = (definition) => definition;
+exports.flow = flow;
+/**
+ * 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.
+ */
+const configPage = (definition) => definition;
+exports.configPage = configPage;
 /**
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using

package/dist/serverTypes/convert.js

@@ -90,8 +90,25 @@ const convertIntegration = (definition) => {
     return Object.assign(Object.assign({}, codeNativeIntegrationComponent(definition, referenceKey)), { codeNativeIntegrationYAML: codeNativeIntegrationYaml(definition, referenceKey) });
 };
 exports.convertIntegration = convertIntegration;
-const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, configVars, endpointType, preprocessFlowName, externalCustomerIdField, externalCustomerUserIdField, flowNameField, flows, configPages, }, referenceKey) => {
+const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, configVars, endpointType, triggerPreprocessFlowConfig, flows, configPages, }, referenceKey) => {
     const DEFINITION_VERSION = 7;
+    // Find the preprocess flow config on the flow, if one exists.
+    const preprocessFlows = flows.filter((flow) => flow.preprocessFlowConfig);
+    // Do some validation of preprocess flow configs.
+    if (preprocessFlows.length > 1) {
+        throw new Error("Only one flow may define a Preprocess Flow Config.");
+    }
+    if (preprocessFlows.length && triggerPreprocessFlowConfig) {
+        throw new Error("Integration must not define both a Trigger Preprocess Flow Config and a Preprocess Flow.");
+    }
+    const hasPreprocessFlow = preprocessFlows.length > 0;
+    const preprocessFlowConfig = hasPreprocessFlow
+        ? preprocessFlows[0].preprocessFlowConfig
+        : triggerPreprocessFlowConfig;
+    if ([types_1.EndpointType.InstanceSpecific, types_1.EndpointType.SharedInstance].includes(endpointType || types_1.EndpointType.FlowSpecific) &&
+        !preprocessFlowConfig) {
+        throw new Error("Integration with specified EndpointType must define either a Trigger Preprocess Flow Config or a Preprocess Flow.");
+    }
     // Transform the IntegrationDefinition into the structure that is appropriate
     // for generating YAML, which will then be used by the Prismatic API to import
     // the integration as a Code Native Integration.
@@ -106,10 +123,10 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
         labels,
         requiredConfigVars: configVars === null || configVars === void 0 ? void 0 : configVars.map((configVar) => convertConfigVar(configVar, referenceKey)),
         endpointType,
-        preprocessFlowName,
-        externalCustomerIdField: fieldNameToReferenceInput("action", externalCustomerIdField),
-        externalCustomerUserIdField: fieldNameToReferenceInput("action", externalCustomerUserIdField),
-        flowNameField: fieldNameToReferenceInput("payload", flowNameField),
+        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),
         flows: flows.map((flow) => convertFlow(flow, referenceKey)),
         configPages,
     };
@@ -120,6 +137,7 @@ const convertFlow = (flow, referenceKey) => {
     const result = Object.assign({}, flow);
     delete result.trigger;
     delete result.action;
+    delete result.preprocessFlowConfig;
     const triggerStep = {
         name: "trigger",
         isTrigger: true,

package/dist/serverTypes/index.d.ts

@@ -50,6 +50,7 @@ export interface ActionLogger {
 }
 export interface ActionContext {
     logger: ActionLogger;
+    configVars?: Record<string, unknown>;
     instanceState: Record<string, unknown>;
     crossFlowState: Record<string, unknown>;
     executionState: Record<string, unknown>;

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 } from "./types";
+import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow } 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.
@@ -56,6 +56,11 @@ export declare const invokeDataSource: <TInputs extends Inputs, TDataSourceType
     objectFieldMap: import("./types").ObjectFieldMap;
     jsonForm: import("./types").JSONForm;
 }>({ perform }: DataSourceDefinition<TInputs, TDataSourceType>, params: ActionInputParameters<TInputs>, context?: Partial<DataSourceContext> | undefined) => Promise<InvokeDataSourceResult<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 class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);

package/dist/testing.js

@@ -15,7 +15,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHarness = exports.ComponentTestHarness = exports.invokeDataSource = exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
+exports.createHarness = exports.ComponentTestHarness = exports.invokeFlow = exports.invokeDataSource = exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
 const createConnection = ({ key }, values, tokenValues) => ({
     configVarKey: "",
@@ -195,6 +195,25 @@ const invokeDataSource = ({ perform }, params, context) => __awaiter(void 0, voi
     return result;
 });
 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 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 result = yield action.perform(realizedContext, params);
+    return {
+        result,
+        loggerMock: realizedContext.logger,
+    };
+});
+exports.invokeFlow = invokeFlow;
 class ComponentTestHarness {
     constructor(component) {
         this.component = component;

package/dist/types/ActionPerformFunction.d.ts

@@ -5,6 +5,8 @@ export declare type ActionPerformFunction<TInputs extends Inputs, TAllowsBranchi
 export interface ActionContext {
     /** Logger for permanent logging; console calls are also captured */
     logger: ActionLogger;
+    /** Code Components and Code Native Integration Actions will have access to all Config Vars, otherwise this will be undefined. */
+    configVars?: Record<string, unknown>;
     /** A a flow-specific key/value store that may be used to store small amounts of data that is persisted between Instance executions */
     instanceState: Record<string, unknown>;
     /** A key/value store that is shared between flows on an Instance that may be used to store small amounts of data that is persisted between Instance executions */

package/dist/types/IntegrationDefinition.d.ts

@@ -15,19 +15,13 @@ export declare type IntegrationDefinition = {
     version?: string;
     /** Optional labels for this Integration. */
     labels?: string[];
-    /** Optional endpoint type used by Instances of this Integration. @default EndpointType.FlowSpecific. */
+    /** Optional endpoint type used by Instances of this Integration.
+     *  A Preprocess Flow Config must be specified when using anything other than 'Flow Specific'.
+     *  @default EndpointType.FlowSpecific. */
     endpointType?: EndpointType;
-    /** Optional name of the Flow to use as a Preprocess Flow for 'Instance Specific' or 'Shared Instance' endpoint types. */
-    preprocessFlowName?: string;
-    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer Id,
-     *  or by the data payload returned by the Trigger if there is no Preprocess Flow specified. */
-    externalCustomerIdField?: string;
-    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer User Id,
-     *  or by the data payload returned by the Trigger if there is no Preprocess Flow specified. */
-    externalCustomerUserIdField?: string;
-    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for a Flow Name,
-     *  or by the data payload returned by the Trigger if there is no Preprocess Flow specified. */
-    flowNameField?: string;
+    /** Optional Preprocess Flow configuration for when the Trigger payload contains the flow routing attributes.
+     *  Cannot specify this if a Preprocess Flow is also configured. */
+    triggerPreprocessFlowConfig?: PreprocessFlowConfig;
     /** Flows for this Integration. */
     flows: Flow[];
     /** Config Vars used on this Integration. */
@@ -45,6 +39,8 @@ export declare type Flow = {
     name: string;
     /** Optional description for this Flow. */
     description?: string;
+    /** Optional Preprocess Flow configuration for when the result of this Flow contains the flow routing attributes. Only one Flow per Integration may define this. */
+    preprocessFlowConfig?: PreprocessFlowConfig;
     /** Optional value that specifies whether this Flow is synchronous. @default false */
     isSynchronous?: boolean;
     /** Optional Retry Configuration for this Flow. */
@@ -64,16 +60,11 @@ export declare type Flow = {
     action: CodeNativeAction;
 };
 /** Defines attributes of a Data Source that is defined as part of a Code Native Integration. */
-export declare type CodeNativeDataSource = Pick<DataSourceDefinition<Inputs, DataSourceType>, // TODO: Are these values correct?
-// TODO: Are these values correct?
-"display" | "perform" | "dataSourceType" | "detailDataSource">;
+export declare type CodeNativeDataSource = Pick<DataSourceDefinition<Inputs, DataSourceType>, "display" | "perform" | "dataSourceType" | "detailDataSource">;
 /** Defines attributes of a Trigger that is defined as part of a Code Native Integration. */
-export declare type CodeNativeTrigger = Pick<TriggerDefinition<Inputs, false, TriggerResult<false>>, // TODO: Are these values correct?
-// TODO: Are these values correct?
-"perform" | "onInstanceDeploy" | "onInstanceDelete">;
+export declare type CodeNativeTrigger = Pick<TriggerDefinition<Inputs, false, TriggerResult<false>>, "display" | "perform" | "onInstanceDeploy" | "onInstanceDelete">;
 /** Defines attributes of an CodeNativeAction, which is the main function that will be executed for a Flow of a Code Native Integration. */
-export declare type CodeNativeAction = Pick<ActionDefinition<Inputs, false, ActionPerformReturn<false, unknown>>, // TODO: Are these values correct?
-"perform"> & {
+export declare type CodeNativeAction = Pick<ActionDefinition<Inputs, false, ActionPerformReturn<false, unknown>>, "display" | "perform"> & {
     /** Optional error handling configuration. */
     errorConfig?: StepErrorConfig;
 };
@@ -193,6 +184,15 @@ export declare type ConfigPageElement = {
     /** Specifies the value of this Element. */
     value: string;
 };
+/** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
+export declare type PreprocessFlowConfig = {
+    /** Name of the field in the data payload returned by the Preprocess Flow to use for a Flow Name. */
+    flowNameField: string;
+    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer Id. */
+    externalCustomerIdField?: string;
+    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer User Id. */
+    externalCustomerUserIdField?: string;
+};
 /** Defines attributes of a Retry Configuration used by a Flow of an Integration. */
 export declare type RetryConfig = {
     /** The maximum number of retry attempts. Must be between 0 and 10. */

package/package.json

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