@prismatic-io/spectral 6.1.0 → 6.3.0

package/dist/serverTypes/convert.d.ts

@@ -1,3 +1,3 @@
 import { ComponentDefinition } from "../types";
 import { Component as ServerComponent } from ".";
-export declare const convertComponent: <TPublic extends boolean = false>({ connections, actions, triggers, hooks, ...definition }: ComponentDefinition<TPublic>) => ServerComponent;
+export declare const convertComponent: <TPublic extends boolean>({ connections, actions, triggers, hooks, ...definition }: ComponentDefinition<TPublic>) => ServerComponent;

package/dist/serverTypes/index.d.ts

@@ -3,7 +3,7 @@ interface DisplayDefinition {
     label: string;
     description: string;
 }
-interface Component {
+export interface Component {
     key: string;
     public?: boolean;
     documentationUrl?: string;
@@ -15,7 +15,7 @@ interface Component {
     triggers: Record<string, Trigger>;
     connections: Connection[];
 }
-interface Action {
+export interface Action {
     key: string;
     display: DisplayDefinition & {
         directions?: string;
@@ -30,8 +30,8 @@ interface Action {
     perform: ActionPerformFunction;
     examplePayload?: unknown;
 }
-declare type ActionLoggerFunction = (...args: unknown[]) => void;
-interface ActionLogger {
+export declare type ActionLoggerFunction = (...args: unknown[]) => void;
+export interface ActionLogger {
     metric: ActionLoggerFunction;
     trace: ActionLoggerFunction;
     debug: ActionLoggerFunction;
@@ -40,7 +40,7 @@ interface ActionLogger {
     warn: ActionLoggerFunction;
     error: ActionLoggerFunction;
 }
-interface ActionContext {
+export interface ActionContext {
     logger: ActionLogger;
     instanceState: Record<string, unknown>;
     crossFlowState: Record<string, unknown>;
@@ -49,7 +49,7 @@ interface ActionContext {
     executionId: string;
 }
 declare type TriggerOptionChoice = "invalid" | "valid" | "required";
-interface TriggerPayload {
+export interface TriggerPayload {
     headers: Record<string, string>;
     queryParameters: Record<string, string>;
     rawBody: {
@@ -60,6 +60,7 @@ interface TriggerPayload {
         data: unknown;
         contentType?: string;
     };
+    pathFragment: string;
     webhookUrls: Record<string, string>;
     webhookApiKeys: Record<string, string[]>;
     invokeUrl: string;
@@ -90,9 +91,9 @@ interface TriggerBaseResult {
 interface TriggerBranchingResult extends TriggerBaseResult {
     branch: string;
 }
-declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
-declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
-interface Trigger {
+export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
+export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
+export interface Trigger {
     key: string;
     display: DisplayDefinition & {
         directions?: string;
@@ -110,11 +111,11 @@ interface Trigger {
     examplePayload?: unknown;
     isCommonTrigger?: boolean;
 }
-declare enum OAuth2Type {
+export declare enum OAuth2Type {
     ClientCredentials = "client_credentials",
     AuthorizationCode = "authorization_code"
 }
-interface Connection {
+export interface Connection {
     key: string;
     label: string;
     comments?: string;
@@ -124,6 +125,15 @@ interface Connection {
         shown?: boolean;
     })[];
 }
+export interface ConnectionValue {
+    key: string;
+    configVarKey: string;
+    fields: {
+        [key: string]: unknown;
+    };
+    token?: Record<string, unknown>;
+    context?: Record<string, unknown>;
+}
 interface ServerPerformDataStructureReturn {
     data: boolean | number | string | Record<string, unknown> | unknown[] | unknown;
     contentType?: string;
@@ -146,13 +156,13 @@ interface ServerPerformBranchingDataStructureReturn extends ServerPerformDataStr
 interface ServerPerformBranchingDataReturn extends ServerPerformDataReturn {
     branch: string;
 }
-declare type ActionPerformReturn = ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn | ServerPerformDataReturn | ServerPerformBranchingDataReturn | undefined;
-declare type ActionPerformFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<ActionPerformReturn>;
+export declare type ActionPerformReturn = ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn | ServerPerformDataReturn | ServerPerformBranchingDataReturn | undefined;
+export declare type ActionPerformFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<ActionPerformReturn>;
 interface InputFieldChoice {
     label: string;
     value: string;
 }
-interface Input {
+export interface Input {
     key: string;
     label: string;
     keyLabel?: string;
@@ -166,4 +176,4 @@ interface Input {
     model?: InputFieldChoice[];
     language?: string;
 }
-export type { Component, Trigger, Action, Connection, Input };
+export {};

package/dist/serverTypes/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAuth2Type = void 0;
 var OAuth2Type;
 (function (OAuth2Type) {
     OAuth2Type["ClientCredentials"] = "client_credentials";
     OAuth2Type["AuthorizationCode"] = "authorization_code";
-})(OAuth2Type || (OAuth2Type = {}));
+})(OAuth2Type = exports.OAuth2Type || (exports.OAuth2Type = {}));

package/dist/testing.d.ts

@@ -4,9 +4,9 @@
  * information on unit testing, check out our docs:
  * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
  */
-/** */
-import { ActionContext, ActionLogger, ActionDefinition, ActionInputParameters, ConnectionDefinition, Connection, Inputs, TriggerDefinition, TriggerPayload } from "./types";
-export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>) => Connection;
+import { TriggerPayload, TriggerResult, Connection, ConnectionValue, ActionLogger, Component, ActionContext, ActionPerformReturn } from "./serverTypes";
+import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters } from "./types";
+export declare const createConnection: <T extends Connection>({ key }: T, values: Record<string, unknown>) => 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.
@@ -34,9 +34,18 @@ export declare const defaultTriggerPayload: () => TriggerPayload;
  * trigger result and a mock logger for asserting logging.
  */
 export declare const invokeTrigger: <T extends Inputs>({ perform }: TriggerDefinition<T>, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<T> | undefined) => Promise<InvokeReturn<import("./types").TriggerResult<boolean | undefined>>>;
+export declare class ComponentTestHarness<TComponent extends Component> {
+    component: TComponent;
+    constructor(component: TComponent);
+    connectionValue({ key }: ConnectionDefinition): ConnectionValue;
+    trigger(key: string, payload?: TriggerPayload, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<TriggerResult>;
+    action(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<ActionPerformReturn>;
+}
+export declare const createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
 declare const _default: {
+    loggerMock: () => ActionLogger;
     invoke: <T extends Inputs>({ perform }: ActionDefinition<T>, params: ActionInputParameters<T>, context?: Partial<ActionContext> | undefined) => Promise<InvokeReturn<import("./types").ActionPerformReturn<boolean | undefined, unknown>>>;
     invokeTrigger: <T_1 extends Inputs>({ perform }: TriggerDefinition<T_1>, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<T_1> | undefined) => Promise<InvokeReturn<import("./types").TriggerResult<boolean | undefined>>>;
-    loggerMock: () => ActionLogger;
+    createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
 };
 export default _default;

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.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
+exports.createHarness = exports.ComponentTestHarness = exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
 const createConnection = ({ key }, values) => ({
     configVarKey: "",
@@ -68,6 +68,7 @@ const defaultTriggerPayload = () => {
             data: JSON.stringify(payloadData),
             contentType,
         },
+        pathFragment: "",
         webhookUrls: {
             "Flow 1": "https://example.com",
         },
@@ -105,8 +106,41 @@ const invokeTrigger = ({ perform }, context, payload, params) => __awaiter(void
     };
 });
 exports.invokeTrigger = invokeTrigger;
+class ComponentTestHarness {
+    constructor(component) {
+        this.component = component;
+    }
+    connectionValue({ key }) {
+        const { PRISMATIC_CONNECTION_VALUE: value } = process.env;
+        if (!value) {
+            throw new Error("Unable to find connection value.");
+        }
+        const result = Object.assign(Object.assign({}, JSON.parse(value)), { key });
+        return result;
+    }
+    trigger(key, payload, params, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+            const trigger = this.component.triggers[key];
+            return trigger.perform(realizedContext, Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload), Object.assign({}, params));
+        });
+    }
+    action(key, params, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+            const action = this.component.actions[key];
+            return action.perform(realizedContext, Object.assign({}, params));
+        });
+    }
+}
+exports.ComponentTestHarness = ComponentTestHarness;
+const createHarness = (component) => {
+    return new ComponentTestHarness(component);
+};
+exports.createHarness = createHarness;
 exports.default = {
+    loggerMock: exports.loggerMock,
     invoke: exports.invoke,
     invokeTrigger: exports.invokeTrigger,
-    loggerMock: exports.loggerMock,
+    createHarness: exports.createHarness,
 };

package/dist/types/ActionPerformReturn.d.ts

@@ -9,7 +9,7 @@ export interface ActionPerformDataReturn<ReturnData> {
     /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
     instanceState?: Record<string, unknown>;
     /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
-    crossFlowState: Record<string, unknown>;
+    crossFlowState?: Record<string, unknown>;
     /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
     executionState?: Record<string, unknown>;
 }

package/dist/types/ComponentDefinition.d.ts

@@ -4,13 +4,12 @@ export interface ComponentHooks {
     /** Defines a global error handler that automatically wraps the component's action/trigger perform functions. */
     error?: ErrorHandler;
 }
-interface BaseComponentDefinition<TPublic extends boolean = false> {
+/** Defines attributes of a Component. */
+export declare type ComponentDefinition<TPublic extends boolean> = {
     /** Specifies unique key for this Component. */
     key: string;
     /** Specifies if this Component is available for all Organizations or only your own @default false */
     public?: TPublic;
-    /** Specified the URL for the Component Documentation. */
-    documentationUrl?: string;
     /** Defines how the Component is displayed in the Prismatic interface. */
     display: ComponentDisplayDefinition<TPublic>;
     /** Specifies the supported Actions of this Component. */
@@ -21,9 +20,7 @@ interface BaseComponentDefinition<TPublic extends boolean = false> {
     connections?: ConnectionDefinition[];
     /** Hooks */
     hooks?: ComponentHooks;
-}
-/** Defines attributes of a Component. */
-export declare type ComponentDefinition<TPublic extends boolean = false> = BaseComponentDefinition<TPublic> & (TPublic extends true ? {
+} & (TPublic extends true ? {
+    /** Specified the URL for the Component Documentation. */
     documentationUrl: string;
 } : unknown);
-export {};

package/dist/types/TriggerPayload.d.ts

@@ -14,6 +14,8 @@ export interface TriggerPayload {
         data: unknown;
         contentType?: string;
     };
+    /** Extended path information from the webhook trigger */
+    pathFragment: string;
     /** The webhook URLs assigned to this integration's flows upon instance deploy */
     webhookUrls: {
         [key: string]: string;

package/dist/types/TriggerResult.d.ts

@@ -9,7 +9,7 @@ export interface TriggerBaseResult {
     /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
     instanceState?: Record<string, unknown>;
     /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
-    crossFlowState: Record<string, unknown>;
+    crossFlowState?: Record<string, unknown>;
     /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
     executionState?: Record<string, unknown>;
 }

package/package.json

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