@prismatic-io/spectral 10.0.1 → 10.1.0

package/dist/clients/http/index.js

@@ -90,7 +90,11 @@ const computeRetryDelay = (retryDelay, useExponentialBackoff) => {
 };
 const toAxiosRetryConfig = (_a) => {
     var { retryDelay, retryAllErrors, retryCondition, useExponentialBackoff } = _a, rest = __rest(_a, ["retryDelay", "retryAllErrors", "retryCondition", "useExponentialBackoff"]);
-    return (Object.assign(Object.assign({}, rest), { retryDelay: computeRetryDelay(retryDelay, useExponentialBackoff), retryCondition: retryAllErrors ? () => true : retryCondition }));
+    return (Object.assign(Object.assign({}, rest), { retryDelay: computeRetryDelay(retryDelay, useExponentialBackoff), retryCondition: retryAllErrors
+            ? () => true
+            : typeof retryCondition === "function"
+                ? retryCondition
+                : axios_retry_1.isNetworkOrIdempotentRequestError }));
 };
 const createClient = ({ baseUrl, responseType, headers, timeout, params, debug = false, retryConfig, }) => {
     const client = axios_1.default.create({

package/dist/index.d.ts

@@ -6,6 +6,7 @@
 import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, DataSourceType, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, OnPremConnectionDefinition, ComponentManifest, OrganizationActivatedConnectionConfigVar } from "./types";
 import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
+import { PollingTriggerDefinition } from "./types/PollingTriggerDefinition";
 /**
  * This function creates a Integration object that can be
  * imported into the Prismatic API. For information on using
@@ -93,6 +94,13 @@ export declare const action: <TInputs extends Inputs, TConfigVars extends Config
  * @returns This function validates the shape of the `definition` object provided, and returns the same trigger object.
  */
 export declare const trigger: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>>(definition: TriggerDefinition<TInputs, TConfigVars, TAllowsBranching, TResult>) => TriggerDefinition<TInputs, TConfigVars, TAllowsBranching, TResult>;
+/**
+ * This function creates a polling trigger object that can be referenced
+ * by a custom component.
+ * @param definition A PollingTriggerDefinition is similar to a TriggerDefinition, except it requires a pollAction instead of a perform. The pollAction, which can be any action defined in the component, will be polled on the defined schedule.
+ * @returns This function validates the shape of the `definition` object provided, and returns the same polling trigger object.
+ */
+export declare const pollingTrigger: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TPayload extends TriggerPayload, TResult extends TriggerResult<boolean, TPayload>, TActionInputs extends Inputs>(definition: PollingTriggerDefinition<TInputs, TConfigVars, TPayload, TResult, TActionInputs>) => PollingTriggerDefinition<TInputs, TConfigVars, TPayload, TResult, TActionInputs>;
 /**
  * This function creates a data source object that can be referenced
  * by a custom component. It helps ensure that the shape of the

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.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.pollingTrigger = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
 const convertComponent_1 = require("./serverTypes/convertComponent");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -130,6 +130,16 @@ exports.action = action;
  */
 const trigger = (definition) => definition;
 exports.trigger = trigger;
+/**
+ * This function creates a polling trigger object that can be referenced
+ * by a custom component.
+ * @param definition A PollingTriggerDefinition is similar to a TriggerDefinition, except it requires a pollAction instead of a perform. The pollAction, which can be any action defined in the component, will be polled on the defined schedule.
+ * @returns This function validates the shape of the `definition` object provided, and returns the same polling trigger object.
+ */
+const pollingTrigger = (definition) => {
+    return Object.assign(Object.assign({}, definition), { triggerType: "polling" });
+};
+exports.pollingTrigger = pollingTrigger;
 /**
  * This function creates a data source object that can be referenced
  * by a custom component. It helps ensure that the shape of the

package/dist/serverTypes/convertComponent.js

@@ -15,6 +15,7 @@ exports.convertComponent = exports.convertConnection = exports.convertInput = vo
 const types_1 = require("../types");
 const perform_1 = require("./perform");
 const lodash_1 = require("lodash");
+const PollingTriggerDefinition_1 = require("../types/PollingTriggerDefinition");
 const convertInput = (key, _a) => {
     var { default: defaultValue, type, label, collection } = _a, rest = __rest(_a, ["default", "type", "label", "collection"]);
     const keyLabel = collection === "keyvaluelist" && typeof label === "object" ? label.key : undefined;
@@ -36,29 +37,65 @@ const convertAction = (actionKey, _a, hooks) => {
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
         }) });
 };
-const convertTrigger = (triggerKey, _a, hooks) => {
-    var { inputs = {}, perform, onInstanceDeploy, onInstanceDelete } = _a, trigger = __rest(_a, ["inputs", "perform", "onInstanceDeploy", "onInstanceDelete"]);
-    const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
-    const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
-    const result = Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
-            inputCleaners,
+const convertTrigger = (triggerKey, trigger, hooks) => {
+    const { inputs = {}, onInstanceDeploy, onInstanceDelete } = trigger;
+    const isPollingTrigger = (0, PollingTriggerDefinition_1.isPollingTriggerDefinition)(trigger);
+    const triggerInputKeys = Object.keys(inputs);
+    const convertedTriggerInputs = Object.entries(inputs).map(([key, value]) => {
+        return (0, exports.convertInput)(key, value);
+    });
+    const triggerInputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
+    let scheduleSupport = "scheduleSupport" in trigger ? trigger.scheduleSupport : "invalid";
+    let convertedActionInputs = [];
+    let performToUse;
+    if (isPollingTrigger) {
+        // Pull inputs up from the action and make them available on the trigger
+        const { pollAction: action } = trigger;
+        let actionInputCleaners = {};
+        scheduleSupport = "required";
+        if (action) {
+            convertedActionInputs = Object.entries(action.inputs).reduce((accum, [key, value]) => {
+                if (triggerInputKeys.includes(key)) {
+                    throw new Error(`Error: The pollingTrigger "${trigger.display.label}" was defined with an input with the key: ${key}. This key duplicates an input on the associated "${action.display.label}" action. Please assign the trigger input a different key.`);
+                }
+                accum.push((0, exports.convertInput)(key, value));
+                return accum;
+            }, []);
+            actionInputCleaners = Object.entries(action.inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
+        }
+        const combinedCleaners = Object.assign({}, actionInputCleaners, triggerInputCleaners);
+        performToUse = (0, perform_1.createPollingPerform)(trigger, {
+            inputCleaners: combinedCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
-        }) });
+        });
+    }
+    else {
+        performToUse = (0, perform_1.createPerform)(trigger.perform, {
+            inputCleaners: triggerInputCleaners,
+            errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
+        });
+    }
+    const result = Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedTriggerInputs.concat(convertedActionInputs), perform: performToUse, scheduleSupport, synchronousResponseSupport: "synchronousResponseSupport" in trigger
+            ? trigger.synchronousResponseSupport
+            : scheduleSupport === "invalid"
+                ? "valid"
+                : "invalid" });
     if (onInstanceDeploy) {
         result.onInstanceDeploy = (0, perform_1.createPerform)(onInstanceDeploy, {
-            inputCleaners,
+            inputCleaners: triggerInputCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
         });
         result.hasOnInstanceDeploy = true;
     }
     if (onInstanceDelete) {
         result.onInstanceDelete = (0, perform_1.createPerform)(onInstanceDelete, {
-            inputCleaners,
+            inputCleaners: triggerInputCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
         });
         result.hasOnInstanceDelete = true;
     }
-    return result;
+    const { pollAction, triggerType } = result, resultTrigger = __rest(result, ["pollAction", "triggerType"]);
+    return resultTrigger;
 };
 const convertDataSource = (dataSourceKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, dataSource = __rest(_a, ["inputs", "perform"]);

package/dist/serverTypes/perform.d.ts

@@ -1,5 +1,6 @@
-import { ErrorHandler } from "../types";
-type PerformFn = (...args: any[]) => Promise<any>;
+import type { ErrorHandler, Inputs, PollingTriggerPerformFunction } from "../types";
+import { type PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
+export type PerformFn = (...args: any[]) => Promise<any>;
 export type CleanFn = (...args: any[]) => any;
 export type InputCleaners = Record<string, CleanFn | undefined>;
 interface CreatePerformProps {
@@ -7,4 +8,5 @@ interface CreatePerformProps {
     errorHandler?: ErrorHandler;
 }
 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

@@ -8,8 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPerform = void 0;
+exports.createPollingPerform = exports.createPerform = void 0;
+const axios_1 = __importDefault(require("axios"));
 const cleanParams = (params, cleaners) => Object.entries(params).reduce((result, [key, value]) => {
     const cleanFn = cleaners[key];
     return Object.assign(Object.assign({}, result), { [key]: cleanFn ? cleanFn(value) : value });
@@ -34,3 +38,55 @@ const createPerform = (performFn, { inputCleaners, errorHandler }) => {
     });
 };
 exports.createPerform = createPerform;
+const createInvokePollAction = (context, action, { inputCleaners, errorHandler }) => {
+    return (params) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            if (!action) {
+                throw "Error: Attempted to invoke an action for a trigger with no pollAction defined.";
+            }
+            return yield action.perform(context, cleanParams(params, inputCleaners));
+        }
+        catch (error) {
+            throw errorHandler ? errorHandler(error) : error;
+        }
+    });
+};
+const createPollingPerform = (trigger, { inputCleaners, errorHandler }) => {
+    return (context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const { pollAction } = trigger;
+            const pollingContext = {
+                polling: {
+                    reinvokeFlow: (data, config) => __awaiter(void 0, void 0, void 0, function* () {
+                        return yield axios_1.default.post(context.invokeUrl, data, config);
+                    }),
+                    invokeAction: createInvokePollAction(context, pollAction, {
+                        inputCleaners,
+                        errorHandler,
+                    }),
+                    getState: () => {
+                        var _a, _b;
+                        const castState = (_a = context.instanceState.__prismaticInternal) !== null && _a !== void 0 ? _a : {};
+                        return (_b = castState.polling) !== null && _b !== void 0 ? _b : {};
+                    },
+                    setState: (newState) => {
+                        var _a;
+                        const castState = (_a = context.instanceState.__prismaticInternal) !== null && _a !== void 0 ? _a : {};
+                        context.instanceState.__prismaticInternal = Object.assign(Object.assign({}, castState), { polling: newState });
+                    },
+                },
+            };
+            const triggerPerform = (0, exports.createPerform)(trigger.perform, {
+                inputCleaners,
+                errorHandler,
+            });
+            const combinedContext = Object.assign({}, context, pollingContext);
+            const triggerResponse = yield triggerPerform(combinedContext, payload, params);
+            return triggerResponse;
+        }
+        catch (error) {
+            throw errorHandler ? errorHandler(error) : error;
+        }
+    });
+};
+exports.createPollingPerform = createPollingPerform;

package/dist/types/ComponentDefinition.d.ts

@@ -1,4 +1,5 @@
 import { ActionDefinition, ConnectionDefinition, ComponentDisplayDefinition, TriggerDefinition, DataSourceDefinition } from ".";
+import { PollingTriggerDefinition } from "./PollingTriggerDefinition";
 export type ErrorHandler = (error: unknown) => unknown;
 export interface ComponentHooks {
     /** Defines a global error handler that automatically wraps the component's action/trigger perform functions. */
@@ -15,7 +16,7 @@ export type ComponentDefinition<TPublic extends boolean, TKey extends string> =
     /** Specifies the supported Actions of this Component. */
     actions?: Record<string, ActionDefinition<any, any, boolean, any>>;
     /** Specifies the supported Triggers of this Component. */
-    triggers?: Record<string, TriggerDefinition<any, any, boolean, any>>;
+    triggers?: Record<string, TriggerDefinition<any, any, boolean, any> | PollingTriggerDefinition<any, any, any, any, any, any>>;
     /** Specifies the supported Data Sources of this Component. */
     dataSources?: Record<string, DataSourceDefinition<any, any, any>>;
     /** Specifies the supported Connections of this Component. */

package/dist/types/PollingTriggerDefinition.d.ts

@@ -0,0 +1,31 @@
+import type { AxiosRequestConfig, AxiosResponse } from "axios";
+import type { ActionDisplayDefinition, TriggerEventFunction, Inputs, TriggerResult, ConfigVarResultCollection, TriggerPayload, ActionDefinition, ActionContext, ActionInputParameters } from ".";
+export interface PollingContext<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection> extends ActionContext<TConfigVars> {
+    polling: {
+        reinvokeFlow: (data?: Record<string, unknown>, config?: AxiosRequestConfig<any>) => Promise<AxiosResponse<any, any>>;
+        invokeAction: (params: ActionInputParameters<TInputs>) => Promise<any>;
+        getState: () => Record<string, unknown>;
+        setState: (newState: Record<string, unknown>) => void;
+    };
+}
+export type PollingTriggerPerformFunction<TInputs extends Inputs, TActionInputs extends Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TResult extends TriggerResult<boolean, TPayload> = TriggerResult<boolean, TPayload>> = (context: ActionContext<TConfigVars> & PollingContext<TActionInputs>, payload: TPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;
+/**
+ * PollingTriggerDefinition is the type of the object that is passed in to `pollingTrigger` function to
+ * define a component trigger.
+ */
+export type PollingTriggerDefinition<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TResult extends TriggerResult<boolean, TPayload> = TriggerResult<boolean, TPayload>, TActionInputs extends Inputs = Inputs, TAction extends ActionDefinition<TActionInputs> = ActionDefinition<TActionInputs>, TCombinedInputs extends TInputs & TActionInputs = TInputs & TActionInputs> = {
+    triggerType?: "polling";
+    /** Defines how the Action is displayed in the Prismatic interface. */
+    display: ActionDisplayDefinition;
+    /** Defines your trigger's polling behavior. */
+    pollAction?: TAction;
+    /** Function to perform when this Trigger is invoked. A default perform will be provided for most polling triggers but defining this allows for custom behavior. */
+    perform: PollingTriggerPerformFunction<TCombinedInputs, TActionInputs, TConfigVars, TPayload, TResult>;
+    /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
+    onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars>;
+    /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
+    onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars>;
+    /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
+    inputs?: TInputs;
+};
+export declare const isPollingTriggerDefinition: (ref: unknown) => ref is PollingTriggerDefinition;

package/dist/types/PollingTriggerDefinition.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPollingTriggerDefinition = void 0;
+const isPollingTriggerDefinition = (ref) => typeof ref === "object" && ref !== null && "triggerType" in ref && ref.triggerType === "polling";
+exports.isPollingTriggerDefinition = isPollingTriggerDefinition;

package/dist/types/index.d.ts

@@ -34,4 +34,5 @@ export * from "./FlowAttributes";
 export * from "./IntegrationDefinition";
 export * from "./ComponentManifest";
 export * from "./ScopedConfigVars";
+export * from "./PollingTriggerDefinition";
 export * as serverTypes from "../serverTypes";

package/dist/types/index.js

@@ -63,4 +63,5 @@ __exportStar(require("./FlowAttributes"), exports);
 __exportStar(require("./IntegrationDefinition"), exports);
 __exportStar(require("./ComponentManifest"), exports);
 __exportStar(require("./ScopedConfigVars"), exports);
+__exportStar(require("./PollingTriggerDefinition"), exports);
 exports.serverTypes = __importStar(require("../serverTypes"));

package/package.json

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