@prismatic-io/spectral 10.3.2 → 10.3.3

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, 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";
+import { ActionPerformReturn as ServerActionPerformReturn, TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, 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, ComponentManifest } 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;
@@ -14,6 +14,23 @@ export declare const connectionValue: (envVarKey?: string) => ConnectionValue;
  * 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.
  */
 export declare const loggerMock: () => ActionLogger;
+/**
+ * Creates basic component mocks based on the CNI's component registry.
+ * You may pass mock overrides in the second argument, e.g.:
+ *
+ * createMockContextComponents(myManifest, {
+ *   actions: {
+ *     myComponentName: {
+ *        myComponentAction: () => Promise.resolve({ data: "my test data "}),
+ *     }
+ *   },
+ * });
+ */
+export declare const createMockContextComponents: <TMockAction extends () => Promise<any>>(registry: Record<string, {
+    actions: ComponentManifest["actions"];
+}>, mocks?: {
+    actions: Record<string, Record<string, TMockAction>>;
+}) => Record<string, Record<string, TMockAction>>;
 /**
  * The type of data returned by an `invoke()` function used for unit testing component actions and triggers.
  */
@@ -64,7 +81,7 @@ export declare class ComponentTestHarness<TComponent extends Component> {
     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<TriggerEventFunctionReturn | void>;
     triggerOnInstanceDelete<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<TriggerEventFunctionReturn | void>;
-    action<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<ActionPerformReturn>;
+    action<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<ServerActionPerformReturn>;
     dataSource<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<DataSourceContext<TConfigVars>>): Promise<DataSourceResult>;
 }
 export declare const createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<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.connectionValue = exports.defaultConnectionValueEnvironmentVariable = exports.createConnection = void 0;
+exports.createHarness = exports.ComponentTestHarness = exports.invokeFlow = exports.invokeDataSource = exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.createMockContextComponents = exports.loggerMock = exports.connectionValue = exports.defaultConnectionValueEnvironmentVariable = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
 const createConnection = ({ key }, values, tokenValues) => ({
     configVarKey: "",
@@ -53,6 +53,33 @@ function invokeFlowTest(flowName, data, config) {
         return Promise.resolve({});
     });
 }
+/**
+ * Creates basic component mocks based on the CNI's component registry.
+ * You may pass mock overrides in the second argument, e.g.:
+ *
+ * createMockContextComponents(myManifest, {
+ *   actions: {
+ *     myComponentName: {
+ *        myComponentAction: () => Promise.resolve({ data: "my test data "}),
+ *     }
+ *   },
+ * });
+ */
+const createMockContextComponents = (registry, mocks = { actions: {} }) => {
+    const components = Object.keys(registry).reduce((accum, componentKey) => {
+        var _a;
+        const mockActions = Object.keys(registry[componentKey].actions).reduce((actionAccum, actionKey) => {
+            actionAccum[actionKey] = (() => {
+                return Promise.resolve({ data: null });
+            });
+            return actionAccum;
+        }, {});
+        accum[componentKey] = Object.assign(Object.assign({}, mockActions), ((_a = mocks.actions[componentKey]) !== null && _a !== void 0 ? _a : {}));
+        return accum;
+    }, {});
+    return components;
+};
+exports.createMockContextComponents = createMockContextComponents;
 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",

package/package.json

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