@prismatic-io/spectral 7.7.0 → 7.8.0-preview2

package/dist/clients/http/inputs.js

@@ -88,7 +88,7 @@ exports.maxRetries = (0, __1.input)({
     placeholder: "Max Retries",
     type: "string",
     required: false,
-    comments: "The maximum number of retries to attempt.",
+    comments: "The maximum number of retries to attempt. Specify 0 for no retries.",
     default: "0",
     clean: (value) => __1.util.types.toNumber(value),
 });
@@ -97,7 +97,7 @@ exports.retryDelayMS = (0, __1.input)({
     placeholder: "Retry Delay",
     type: "string",
     required: false,
-    comments: "The delay in milliseconds between retries.",
+    comments: "The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.",
     default: "0",
     clean: (value) => __1.util.types.toNumber(value, 0),
 });
@@ -106,7 +106,7 @@ exports.useExponentialBackoff = (0, __1.input)({
     type: "boolean",
     default: "false",
     required: false,
-    comments: "Specifies whether to use a pre-defined exponential backoff strategy for retries.",
+    comments: "Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.",
     clean: (value) => __1.util.types.toBool(value),
 });
 exports.retryAllErrors = (0, __1.input)({
@@ -114,7 +114,7 @@ exports.retryAllErrors = (0, __1.input)({
     type: "boolean",
     default: "false",
     required: false,
-    comments: "If true, retries on all erroneous responses regardless of type.",
+    comments: "If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.",
     clean: (value) => __1.util.types.toBool(value),
 });
 exports.formData = (0, __1.input)({

package/dist/serverTypes/convert.js

@@ -32,13 +32,26 @@ const convertAction = (actionKey, _a, hooks) => {
         }) });
 };
 const convertTrigger = (triggerKey, _a, hooks) => {
-    var { inputs = {}, perform } = _a, trigger = __rest(_a, ["inputs", "perform"]);
+    var { inputs = {}, perform, onInstanceDeploy, onInstanceDelete } = _a, trigger = __rest(_a, ["inputs", "perform", "onInstanceDeploy", "onInstanceDelete"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
     const inputCleaners = Object.entries(inputs).reduce((result, [key, { clean }]) => (Object.assign(Object.assign({}, result), { [key]: clean })), {});
-    return Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
+    const result = Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
             inputCleaners,
             errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
         }) });
+    if (onInstanceDeploy) {
+        result.onInstanceDeploy = (0, perform_1.createPerform)(onInstanceDeploy, {
+            inputCleaners,
+            errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
+        });
+    }
+    if (onInstanceDelete) {
+        result.onInstanceDelete = (0, perform_1.createPerform)(onInstanceDelete, {
+            inputCleaners,
+            errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
+        });
+    }
+    return result;
 };
 const convertDataSource = (dataSourceKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, dataSource = __rest(_a, ["inputs", "perform"]);

package/dist/serverTypes/index.d.ts

@@ -102,6 +102,13 @@ interface TriggerBranchingResult extends TriggerBaseResult {
 }
 export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
 export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
+export interface TriggerEventFunctionContext {
+    logger: ActionLogger;
+    customer: Customer;
+    instance: Instance;
+    user: User;
+}
+export declare type TriggerEventFunction = (context: TriggerEventFunctionContext, params: Record<string, unknown>) => Promise<void>;
 export interface Trigger {
     key: string;
     display: DisplayDefinition & {
@@ -115,6 +122,8 @@ export interface Trigger {
     staticBranchNames?: string[];
     dynamicBranchInput?: string;
     perform: TriggerPerformFunction;
+    onInstanceDeploy?: TriggerEventFunction;
+    onInstanceDelete?: TriggerEventFunction;
     scheduleSupport: TriggerOptionChoice;
     synchronousResponseSupport: TriggerOptionChoice;
     examplePayload?: unknown;

package/dist/types/TriggerDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ActionDisplayDefinition, TriggerPerformFunction, Inputs, TriggerResult } from ".";
+import { ActionDisplayDefinition, TriggerPerformFunction, TriggerEventFunction, Inputs, TriggerResult } from ".";
 declare const optionChoices: readonly ["invalid", "valid", "required"];
 export declare type TriggerOptionChoice = typeof optionChoices[number];
 export declare const TriggerOptionChoices: TriggerOptionChoice[];
@@ -11,6 +11,10 @@ export interface TriggerDefinition<TInputs extends Inputs, TAllowsBranching exte
     display: ActionDisplayDefinition;
     /** Function to perform when this Trigger is invoked. */
     perform: TriggerPerformFunction<TInputs, TAllowsBranching, TResult>;
+    /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
+    onInstanceDeploy?: TriggerEventFunction<TInputs>;
+    /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
+    onInstanceDelete?: TriggerEventFunction<TInputs>;
     /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
     inputs: TInputs;
     /** Specifies whether this Trigger supports executing the Integration on a recurring schedule. */

package/dist/types/TriggerEventFunction.d.ts

@@ -0,0 +1,10 @@
+import { Inputs, ActionInputParameters, ActionLogger, Customer, Instance, User } from ".";
+/** Context provided to the event function containing helpers and contextual data */
+export interface TriggerEventFunctionContext {
+    logger: ActionLogger;
+    customer: Customer;
+    instance: Instance;
+    user: User;
+}
+/** Definition of the function to execute when a Trigger Event occurs. */
+export declare type TriggerEventFunction<TInputs extends Inputs> = (context: TriggerEventFunctionContext, params: ActionInputParameters<TInputs>) => Promise<void>;

package/dist/types/TriggerEventFunction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -13,6 +13,7 @@ export * from "./ActionInputParameters";
 export * from "./ActionLogger";
 export * from "./ActionPerformFunction";
 export * from "./conditional-logic";
+export * from "./TriggerEventFunction";
 export * from "./TriggerResult";
 export * from "./TriggerPerformFunction";
 export * from "./TriggerDefinition";

package/dist/types/index.js

@@ -42,6 +42,7 @@ __exportStar(require("./ActionInputParameters"), exports);
 __exportStar(require("./ActionLogger"), exports);
 __exportStar(require("./ActionPerformFunction"), exports);
 __exportStar(require("./conditional-logic"), exports);
+__exportStar(require("./TriggerEventFunction"), exports);
 __exportStar(require("./TriggerResult"), exports);
 __exportStar(require("./TriggerPerformFunction"), exports);
 __exportStar(require("./TriggerDefinition"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.7.0",
+  "version": "7.8.0-preview2",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -43,19 +43,19 @@
     "date-fns": "2.30.0",
     "form-data": "4.0.0",
     "jest-mock": "27.0.3",
+    "safe-stable-stringify": "2.3.1",
+    "serialize-error": "8.1.0",
     "soap": "1.0.0",
-    "uuid": "8.3.2",
-    "valid-url": "1.0.9",
     "url-join": "5.0.0",
-    "safe-stable-stringify": "2.3.1",
-    "serialize-error": "8.1.0"
+    "uuid": "8.3.2",
+    "valid-url": "1.0.9"
   },
   "devDependencies": {
     "@types/jest": "27.4.1",
     "@types/node": "14.14.35",
     "@types/sax": "1.2.4",
-    "@types/uuid": "8.3.4",
     "@types/url-join": "4.0.1",
+    "@types/uuid": "8.3.4",
     "@types/valid-url": "1.0.3",
     "@typescript-eslint/eslint-plugin": "5.18.0",
     "@typescript-eslint/parser": "5.18.0",
@@ -67,11 +67,11 @@
     "jest": "27.5.1",
     "prettier": "2.6.2",
     "ts-jest": "27.0.3",
+    "tsd": "0.20.0",
     "typedoc": "0.17.7",
     "typedoc-plugin-markdown": "2.4.2",
     "typedoc-plugin-remove-references": "0.0.5",
-    "typescript": "4.6.3",
-    "tsd": "0.20.0"
+    "typescript": "4.6.3"
   },
   "tsd": {
     "directory": "./src/types-tests"