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

package/dist/testing.d.ts

@@ -7,6 +7,8 @@
 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, ConfigVarResultCollection, ConfigPages, ComponentSelector } from "./types";
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>, tokenValues?: Record<string, unknown> | undefined) => ConnectionValue;
+export declare const defaultConnectionValueEnvironmentVariable = "PRISMATIC_CONNECTION_VALUE";
+export declare const connectionValue: (envVarKey?: string) => ConnectionValue;
 /**
  * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected.
  * See https://prismatic.io/docs/custom-components/writing-custom-components/#verifying-correct-logging-in-action-tests for information on testing correct logging behavior in your custom component.
@@ -63,7 +65,11 @@ declare type ToTestValues<TConfigVars extends ConfigVarResultCollection> = {
  * 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: <TConfigPages extends ConfigPages<any>, TConfigVars extends ConfigVarResultCollection = import("./types/utils").Prettify<{ [Key in keyof import("./types").GetElements<TConfigPages> as Key extends string ? Key : never]: import("./types").ElementToRuntimeType<import("./types").GetElements<TConfigPages>[Key]>; }>, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow<TConfigPages, ComponentSelector<any>, import("./types").TriggerPayload>, configVars: TConfigVarValues, context?: Partial<ActionContext<TConfigVars>> | undefined, payload?: TriggerPayload | undefined) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
+export declare const invokeFlow: <TConfigPages extends ConfigPages<any>, TConfigVars extends ConfigVarResultCollection = import("./types/utils").Prettify<{ [Key in keyof import("./types").GetElements<TConfigPages> as Key extends string ? Key : never]: import("./types").ElementToRuntimeType<import("./types").GetElements<TConfigPages>[Key]>; }>, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow<TConfigPages, ComponentSelector<any>, import("./types").TriggerPayload>, { configVars, context, payload, }?: {
+    configVars?: TConfigVarValues | undefined;
+    context?: Partial<ActionContext<TConfigVars>> | undefined;
+    payload?: Partial<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.invokeFlow = 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.connectionValue = exports.defaultConnectionValueEnvironmentVariable = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
 const createConnection = ({ key }, values, tokenValues) => ({
     configVarKey: "",
@@ -24,6 +24,16 @@ const createConnection = ({ key }, values, tokenValues) => ({
     token: tokenValues,
 });
 exports.createConnection = createConnection;
+exports.defaultConnectionValueEnvironmentVariable = "PRISMATIC_CONNECTION_VALUE";
+const connectionValue = (envVarKey = exports.defaultConnectionValueEnvironmentVariable) => {
+    const value = process.env[envVarKey];
+    if (!value) {
+        throw new Error("Unable to find connection value.");
+    }
+    const result = Object.assign(Object.assign({}, JSON.parse(value)), { key: "" });
+    return result;
+};
+exports.connectionValue = connectionValue;
 /**
  * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected.
  * See https://prismatic.io/docs/custom-components/writing-custom-components/#verifying-correct-logging-in-action-tests for information on testing correct logging behavior in your custom component.
@@ -178,7 +188,7 @@ const invokeDataSource = ({ perform }, params, context) => __awaiter(void 0, voi
 });
 exports.invokeDataSource = invokeDataSource;
 const createConfigVars = (values) => {
-    return Object.entries(values).reduce((result, [key, value]) => {
+    return Object.entries(values !== null && values !== void 0 ? values : {}).reduce((result, [key, value]) => {
         // Connection
         if (typeof value === "object" && "fields" in value) {
             return Object.assign(Object.assign({}, result), { [key]: Object.assign(Object.assign({}, value), { key, configVarKey: "" }) });
@@ -190,12 +200,12 @@ const createConfigVars = (values) => {
  * 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 = (flow, configVars, context, payload) => __awaiter(void 0, void 0, void 0, function* () {
+const invokeFlow = (flow, { configVars, context, payload, } = {}) => __awaiter(void 0, void 0, void 0, function* () {
     const realizedConfigVars = createConfigVars(configVars);
     const realizedContext = createActionContext(Object.assign(Object.assign({}, context), { configVars: realizedConfigVars }));
     const realizedPayload = Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload);
     const params = {
-        onTrigger: { results: null },
+        onTrigger: { results: realizedPayload },
     };
     if ("onTrigger" in flow && typeof flow.onTrigger === "function") {
         const triggerResult = yield flow.onTrigger(realizedContext, realizedPayload, params);

package/package.json

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