@prismatic-io/spectral 6.3.0 → 6.4.0

package/dist/clients/http/inputs.d.ts

@@ -6,6 +6,7 @@ export declare const url: {
     required: true;
     comments: string;
     example: string;
+    clean: (value: unknown) => string;
 };
 export declare const data: {
     label: string;
@@ -14,6 +15,7 @@ export declare const data: {
     required: false;
     comments: string;
     example: string;
+    clean: (value: unknown) => string;
 };
 export declare const timeout: {
     label: string;
@@ -21,6 +23,7 @@ export declare const timeout: {
     required: false;
     comments: string;
     example: string;
+    clean: (value: unknown) => number;
 };
 export declare const method: {
     label: string;
@@ -30,6 +33,7 @@ export declare const method: {
         value: Method;
     }[];
     comments: string;
+    clean: (value: unknown) => string;
 };
 export declare const responseType: {
     label: string;
@@ -42,6 +46,7 @@ export declare const responseType: {
         label: ResponseType;
         value: ResponseType;
     }[];
+    clean: (value: unknown) => string;
 };
 export declare const headers: {
     label: string;
@@ -67,6 +72,7 @@ export declare const maxRetries: {
     required: false;
     comments: string;
     default: string;
+    clean: (value: unknown) => number;
 };
 export declare const retryDelayMS: {
     label: string;
@@ -82,6 +88,7 @@ export declare const useExponentialBackoff: {
     default: string;
     required: false;
     comments: string;
+    clean: (value: unknown) => boolean;
 };
 export declare const retryOnAllErrors: {
     label: string;
@@ -89,6 +96,7 @@ export declare const retryOnAllErrors: {
     default: string;
     required: false;
     comments: string;
+    clean: (value: unknown) => boolean;
 };
 export declare const formData: {
     label: string;
@@ -113,4 +121,5 @@ export declare const debugRequest: {
     type: "boolean";
     required: false;
     comments: string;
+    clean: (value: unknown) => boolean;
 };

package/dist/clients/http/inputs.js

@@ -27,6 +27,7 @@ exports.url = (0, __1.input)({
     required: true,
     comments: "This is the URL to call.",
     example: "/sobjects/Account",
+    clean: (value) => __1.util.types.toString(value),
 });
 exports.data = (0, __1.input)({
     label: "Data",
@@ -35,6 +36,7 @@ exports.data = (0, __1.input)({
     required: false,
     comments: "The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.",
     example: '{"exampleKey": "Example Data"}',
+    clean: (value) => __1.util.types.toString(value),
 });
 exports.timeout = (0, __1.input)({
     label: "Timeout",
@@ -42,12 +44,14 @@ exports.timeout = (0, __1.input)({
     required: false,
     comments: "The maximum time that a client will await a response to its request",
     example: "2000",
+    clean: (value) => __1.util.types.toNumber(value),
 });
 exports.method = (0, __1.input)({
     label: "Method",
     type: "string",
     model: supportedMethods.map((method) => ({ label: method, value: method })),
     comments: "The HTTP method to use.",
+    clean: (value) => __1.util.types.toString(value),
 });
 exports.responseType = (0, __1.input)({
     label: "Response Type",
@@ -60,6 +64,7 @@ exports.responseType = (0, __1.input)({
         label: responseType,
         value: responseType,
     })),
+    clean: (value) => __1.util.types.toString(value),
 });
 exports.headers = (0, __1.input)({
     label: "Header",
@@ -85,6 +90,7 @@ exports.maxRetries = (0, __1.input)({
     required: false,
     comments: "The maximum number of retries to attempt.",
     default: "0",
+    clean: (value) => __1.util.types.toNumber(value),
 });
 exports.retryDelayMS = (0, __1.input)({
     label: "Retry Delay (ms)",
@@ -100,6 +106,7 @@ exports.useExponentialBackoff = (0, __1.input)({
     default: "false",
     required: false,
     comments: "Specifies whether to use a pre-defined exponential backoff strategy for retries.",
+    clean: (value) => __1.util.types.toBool(value),
 });
 exports.retryOnAllErrors = (0, __1.input)({
     label: "Retry On All Errors",
@@ -107,6 +114,7 @@ exports.retryOnAllErrors = (0, __1.input)({
     default: "false",
     required: false,
     comments: "If true, retries on all erroneous responses regardless of type.",
+    clean: (value) => __1.util.types.toBool(value),
 });
 exports.formData = (0, __1.input)({
     label: "Form Data",
@@ -131,4 +139,5 @@ exports.debugRequest = (0, __1.input)({
     type: "boolean",
     required: false,
     comments: "Enabling this flag will log out the current request.",
+    clean: (value) => __1.util.types.toBool(value),
 });

package/dist/serverTypes/convert.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -21,40 +12,42 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertComponent = void 0;
-const serialize_error_1 = require("serialize-error");
-const util_1 = require("../util");
 const types_1 = require("../types");
-const wrapPerform = (fn, errorHandler) => {
-    return (...args) => __awaiter(void 0, void 0, void 0, function* () {
-        try {
-            return yield fn(...args);
-        }
-        catch (error) {
-            throw new Error((0, util_1.toJSON)((0, serialize_error_1.serializeError)(errorHandler(error))));
-        }
-    });
-};
+const perform_1 = require("./perform");
 const convertInput = (key, _a) => {
     var { default: defaultValue, type, label, collection } = _a, rest = __rest(_a, ["default", "type", "label", "collection"]);
-    return (Object.assign(Object.assign({}, rest), { key,
-        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel: collection === "keyvaluelist" && typeof label === "object"
-            ? label.key
-            : undefined }));
+    const keyLabel = collection === "keyvaluelist" && typeof label === "object"
+        ? label.key
+        : undefined;
+    return Object.assign(Object.assign({}, rest), { key,
+        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel });
 };
 const convertAction = (actionKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, action = __rest(_a, ["inputs", "perform"]);
-    return (Object.assign(Object.assign({}, action), { key: actionKey, perform: (hooks === null || hooks === void 0 ? void 0 : hooks.error) ? wrapPerform(perform, hooks.error) : perform, inputs: Object.entries(inputs).map(([key, value]) => convertInput(key, value)) }));
+    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({}, action), { key: actionKey, inputs: convertedInputs, perform: (0, perform_1.createPerform)(perform, {
+            inputCleaners,
+            errorHandler: hooks === null || hooks === void 0 ? void 0 : hooks.error,
+        }) });
 };
 const convertTrigger = (triggerKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, trigger = __rest(_a, ["inputs", "perform"]);
-    return (Object.assign(Object.assign({}, trigger), { key: triggerKey, perform: (hooks === null || hooks === void 0 ? void 0 : hooks.error) ? wrapPerform(perform, hooks.error) : perform, inputs: Object.entries(inputs).map(([key, value]) => convertInput(key, value)) }));
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
+    return 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,
+        }) });
 };
-const convertConnection = (connection) => {
-    var _a;
-    return (Object.assign(Object.assign({}, connection), { inputs: Object.entries((_a = connection.inputs) !== null && _a !== void 0 ? _a : {}).map(([key, value]) => convertInput(key, value)) }));
+const convertConnection = (_a) => {
+    var { inputs = {} } = _a, connection = __rest(_a, ["inputs"]);
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => convertInput(key, value));
+    return Object.assign(Object.assign({}, connection), { inputs: convertedInputs });
 };
 const convertComponent = (_a) => {
     var { connections = [], actions = {}, triggers = {}, hooks } = _a, definition = __rest(_a, ["connections", "actions", "triggers", "hooks"]);
-    return (Object.assign(Object.assign({}, definition), { connections: connections.map(convertConnection), actions: Object.entries(actions).reduce((result, [actionKey, action]) => (Object.assign(Object.assign({}, result), { [actionKey]: convertAction(actionKey, action, hooks) })), {}), triggers: Object.entries(triggers).reduce((result, [triggerKey, trigger]) => (Object.assign(Object.assign({}, result), { [triggerKey]: convertTrigger(triggerKey, trigger, hooks) })), {}) }));
+    const convertedActions = Object.entries(actions).reduce((result, [actionKey, action]) => (Object.assign(Object.assign({}, result), { [actionKey]: convertAction(actionKey, action, hooks) })), {});
+    const convertedTriggers = Object.entries(triggers).reduce((result, [triggerKey, trigger]) => (Object.assign(Object.assign({}, result), { [triggerKey]: convertTrigger(triggerKey, trigger, hooks) })), {});
+    return Object.assign(Object.assign({}, definition), { connections: connections.map(convertConnection), actions: convertedActions, triggers: convertedTriggers });
 };
 exports.convertComponent = convertComponent;

package/dist/serverTypes/perform.d.ts

@@ -0,0 +1,10 @@
+import { ErrorHandler } from "../types";
+declare type PerformFn = (...args: any[]) => Promise<any>;
+export declare type CleanFn = (...args: any[]) => any;
+export declare type InputCleaners = Record<string, CleanFn | undefined>;
+interface CreatePerformProps {
+    inputCleaners: InputCleaners;
+    errorHandler?: ErrorHandler;
+}
+export declare const createPerform: (performFn: PerformFn, { inputCleaners, errorHandler }: CreatePerformProps) => PerformFn;
+export {};

package/dist/serverTypes/perform.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPerform = void 0;
+const serialize_error_1 = require("serialize-error");
+const util_1 = require("../util");
+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 });
+}, {});
+const createPerform = (performFn, { inputCleaners, errorHandler }) => {
+    return (...args) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            if (args.length === 2) {
+                const [context, params] = args;
+                return yield performFn(context, cleanParams(params, inputCleaners));
+            }
+            const [context, payload, params] = args;
+            return yield performFn(context, payload, cleanParams(params, inputCleaners));
+        }
+        catch (error) {
+            if (!errorHandler) {
+                throw error;
+            }
+            const handled = errorHandler(error);
+            const serialized = (0, util_1.toJSON)((0, serialize_error_1.serializeError)(handled));
+            throw new Error(serialized);
+        }
+    });
+};
+exports.createPerform = createPerform;

package/dist/types/ActionInputParameters.d.ts

@@ -1,14 +1,15 @@
-import { InputFieldDefinition, Inputs, InputFieldTypeMap } from ".";
+import { Inputs } from ".";
+import { ConditionalExpression } from "./conditional-logic";
+import { InputFieldCollection, InputCleanFunction, Connection } from "./Inputs";
 /**
  * Collection of input parameters.
  * Inputs can be static values, references to config variables, or
  * references to previous steps' outputs.
  */
 export declare type ActionInputParameters<TInputs extends Inputs> = {
-    [Property in keyof TInputs]: ExtractValue<TInputs[Property]>;
+    [Property in keyof TInputs]: TInputs[Property]["clean"] extends InputCleanFunction<any> ? ReturnType<TInputs[Property]["clean"]> : TInputs[Property]["type"] extends "connection" ? ExtractValue<Connection, TInputs[Property]["collection"]> : TInputs[Property]["type"] extends "conditional" ? ExtractValue<ConditionalExpression, TInputs[Property]["collection"]> : ExtractValue<TInputs[Property]["default"], TInputs[Property]["collection"]>;
 };
-export declare type ExtractValue<TValue extends InputFieldDefinition> = MapCollectionValues<InputFieldTypeMap[TValue["type"]], TValue["collection"]>;
-export declare type MapCollectionValues<TType, TCollection extends InputFieldDefinition["collection"]> = TCollection extends "keyvaluelist" ? KeyValuePair<TType>[] : TCollection extends "valuelist" ? TType[] : TType;
+export declare type ExtractValue<TType, TCollection extends InputFieldCollection | undefined> = TCollection extends "keyvaluelist" ? KeyValuePair<TType>[] : TCollection extends "valuelist" ? TType[] : TType;
 /**
  * KeyValuePair input parameter type.
  * This allows users to input multiple keys / values as an input.

package/dist/types/Inputs.d.ts

@@ -1,23 +1,21 @@
-import { InputFieldDefaultMap, InputFieldType } from ".";
+import { ConditionalExpression } from "./conditional-logic";
+/** InputField type enumeration. */
+export declare type InputFieldType = InputFieldDefinition["type"];
+export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;
 export declare type Inputs = Record<string, InputFieldDefinition>;
-export declare type ConnectionInput = DefaultInputFieldDefinition & {
+export declare type ConnectionInput = (StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField) & {
     shown?: boolean;
 };
-export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition | ConditionalInputField | ConnectionInputField;
-interface BaseInputFieldDefinition {
-    /** Data type the InputField will collect. */
-    type: InputFieldType;
+export declare type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField;
+export declare type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
+interface BaseInputField {
     /** Interface label of the InputField. */
     label: {
         key: string;
         value: string;
     } | string;
-    /** Collection type of the InputField */
-    collection?: InputFieldCollection;
     /** Text to show as the InputField placeholder. */
     placeholder?: string;
-    /** Default value for this field. */
-    default?: typeof InputFieldDefaultMap[this["type"]];
     /** Additional text to give guidance to the user configuring the InputField. */
     comments?: string;
     /** Example valid input for this InputField. */
@@ -25,27 +23,102 @@ interface BaseInputFieldDefinition {
     /** Indicate if this InputField is required. */
     required?: boolean;
 }
-/** Defines attributes of a InputField. */
-export interface DefaultInputFieldDefinition extends BaseInputFieldDefinition {
-    type: Exclude<InputFieldType, "code" | "conditional" | "connection">;
+export interface StringInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "string";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: unknown;
+    /** Dictates possible choices for the input. */
+    model?: InputFieldChoice[];
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
+}
+export interface DataInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "data";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: unknown;
+    /** Dictates possible choices for the input. */
+    model?: InputFieldChoice[];
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
+}
+export interface TextInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "text";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: unknown;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
+}
+export interface PasswordInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "password";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: unknown;
+    /** Dictates possible choices for the input. */
+    model?: InputFieldChoice[];
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
+}
+export interface BooleanInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "boolean";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: unknown;
+    /** Dictates possible choices for the input. */
+    model?: InputFieldChoice[];
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
 }
 /** Defines attributes of a CodeInputField. */
-export interface CodeInputFieldDefinition extends BaseInputFieldDefinition {
-    type: Extract<InputFieldType, "code">;
+export interface CodeInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "code";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: unknown;
     /** Code language of this field. */
     language?: string;
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
 }
 /** Defines attributes of a ConditionalInputField. */
-export interface ConditionalInputField extends BaseInputFieldDefinition {
-    type: Extract<InputFieldType, "conditional">;
+export interface ConditionalInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "conditional";
+    /** Collection type of the InputField */
+    collection: Extract<InputFieldCollection, "valuelist">;
+    /** Default value for this field. */
+    default?: ConditionalExpression;
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
 }
 /** Defines attributes of a ConnectionInputField. */
-export interface ConnectionInputField extends BaseInputFieldDefinition {
-    type: Extract<InputFieldType, "connection">;
+export interface ConnectionInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "connection";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: Connection;
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
 }
 export interface Connection {
     /** Key of the Connection type. */

package/dist/types/Inputs.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputFieldDefaultMap = void 0;
+exports.InputFieldDefaultMap = {
+    string: "",
+    data: "",
+    text: "",
+    password: "",
+    boolean: "false",
+    code: "",
+    conditional: undefined,
+    connection: undefined,
+};

package/dist/types/index.d.ts

@@ -12,7 +12,6 @@ export * from "./DisplayDefinition";
 export * from "./ActionInputParameters";
 export * from "./ActionLogger";
 export * from "./ActionPerformFunction";
-export * from "./InputFieldType";
 export * from "./conditional-logic";
 export * from "./TriggerResult";
 export * from "./TriggerPerformFunction";

package/dist/types/index.js

@@ -28,7 +28,6 @@ __exportStar(require("./DisplayDefinition"), exports);
 __exportStar(require("./ActionInputParameters"), exports);
 __exportStar(require("./ActionLogger"), exports);
 __exportStar(require("./ActionPerformFunction"), exports);
-__exportStar(require("./InputFieldType"), exports);
 __exportStar(require("./conditional-logic"), exports);
 __exportStar(require("./TriggerResult"), exports);
 __exportStar(require("./TriggerPerformFunction"), exports);

package/package.json

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

package/dist/types/InputFieldType.d.ts

@@ -1,15 +0,0 @@
-import { Connection } from ".";
-import { ConditionalExpression } from "./conditional-logic";
-/** InputField type enumeration. */
-export declare type InputFieldType = keyof InputFieldTypeMap;
-export declare type InputFieldTypeMap = {
-    string: unknown;
-    data: unknown;
-    text: unknown;
-    password: unknown;
-    boolean: unknown;
-    code: unknown;
-    conditional: ConditionalExpression;
-    connection: Connection;
-};
-export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;

package/dist/types/InputFieldType.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InputFieldDefaultMap = void 0;
-exports.InputFieldDefaultMap = {
-    string: "",
-    data: "",
-    text: "",
-    password: "",
-    boolean: "false",
-    code: "",
-    conditional: undefined,
-    connection: undefined,
-};