@prismatic-io/spectral 4.0.6 → 4.1.0

package/README.md

@@ -14,22 +14,23 @@ Please see our [documentation](https://prismatic.io/docs/custom-components/writi
 
 ## What is Prismatic?
 
-Prismatic is the embedded integration platform for B2B software companies. It's the easiest way to build integrations and provide a first-class integration experience to your customers.
+Prismatic is the integration platform for B2B software companies. It's the quickest way to build integrations to the other apps your customers use and to add a native integration marketplace to your product.
 
-Prismatic reduces integration effort and empowers every role with exactly what they need, so you can spend less time on integrations and more time on core product innovation.
+Prismatic significantly reduces overall integration effort and enables non-dev teams to take on more of the integration workload, so that you can deliver integrations faster and spend more time on core product innovation.
 
 With Prismatic, you can:
 
-- Build reusable [integrations](https://prismatic.io/docs/integrations) in an intuitive low-code integration designer
+- Build reusable [integrations](https://prismatic.io/docs/integrations) in a low-code integration designer that's tailored for your product
+- Use [pre-built components](https://prismatic.io/docs/components/component-catalog) to handle most of your integrations' functionality, and write [custom components](https://prismatic.io/docs/custom-components/writing-custom-components) when needed
+- Quickly add an [integration marketplace](https://prismatic.io/docs/integration-marketplace) to your product so customers can explore, activate, and monitor integrations
 - Easily deploy customer-specific integration [instances](https://prismatic.io/docs/instances) with unique configurations and credentials
-- Run your integrations in a purpose-built environment
-- Provide better support with built-in [logging](https://prismatic.io/docs/logging) and [alerting](https://prismatic.io/docs/monitoring-and-alerting)
-- Embed a white-labeled customer integration portal with an [integration marketplace](https://prismatic.io/docs/integration-marketplace/) and customer self-service tools
-- Mold the platform to your product, industry, and the way you build software
+- Provide better support with tools like [logging](https://prismatic.io/docs/logging) and [alerting](https://prismatic.io/docs/monitoring-and-alerting)
+- Run your integrations in a purpose-built environment designed for security and scalability
+- Use powerful dev tools to mold the platform to your product, industry, and the way you build software
 
 ## Who uses Prismatic?
 
-Prismatic is for B2B (business-to-business) software companies, meaning software companies that provide applications used by businesses. It's a good fit for products/teams at any stage, including early stage SaaS, established SaaS, and legacy or on-prem systems.
+Prismatic is for B2B (business-to-business) software companies, meaning software companies that provide applications used by businesses. It's a good fit for products/teams ranging from early-stage and growing SaaS startups to large, established software companies looking to improve the way they do integrations.
 
 Many B2B software teams serve customers in niche vertical markets, and we designed Prismatic with that in mind. We provide powerful and flexible tools so you can build exactly the integrations your customers need, no matter who your customers are, no matter what systems you need to connect to, no matter how "non-standard" your integration scenario.
 

package/dist/testing.js

@@ -99,6 +99,8 @@ exports.credentials = {
  * 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.
  */
 const loggerMock = () => ({
+    metric: console.log,
+    trace: jest_mock_1.spyOn(console, "trace"),
     debug: jest_mock_1.spyOn(console, "debug"),
     info: jest_mock_1.spyOn(console, "info"),
     log: jest_mock_1.spyOn(console, "log"),
@@ -114,7 +116,7 @@ exports.loggerMock = loggerMock;
  */
 const invoke = (actionBase, params, context) => __awaiter(void 0, void 0, void 0, function* () {
     const action = (actionBase.perform ? actionBase : Object.values(actionBase)[0]);
-    const realizedContext = Object.assign({ credential: undefined, logger: exports.loggerMock(), instanceState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+    const realizedContext = Object.assign({ credential: undefined, logger: exports.loggerMock(), instanceState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
     const result = yield action.perform(realizedContext, params);
     return {
         result,
@@ -141,6 +143,9 @@ const defaultTriggerPayload = () => {
         webhookUrls: {
             "Flow 1": "https://example.com",
         },
+        webhookApiKeys: {
+            "Flow 1": ["example-123", "example-456"],
+        },
         customer: {
             name: "Customer 1",
             externalId: "1234",
@@ -156,7 +161,7 @@ exports.defaultTriggerPayload = defaultTriggerPayload;
  */
 const invokeTrigger = (triggerBase, context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
     const trigger = (triggerBase.perform ? triggerBase : Object.values(triggerBase)[0]);
-    const realizedContext = Object.assign({ credential: undefined, logger: exports.loggerMock(), instanceState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+    const realizedContext = Object.assign({ credential: undefined, logger: exports.loggerMock(), instanceState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
     const realizedPayload = Object.assign(Object.assign({}, exports.defaultTriggerPayload()), payload);
     const realizedParams = params || {};
     const result = yield trigger.perform(realizedContext, realizedPayload, realizedParams);

package/dist/types/ActionDefinition.d.ts

@@ -14,6 +14,8 @@ export interface ActionDefinition<T extends Inputs, AllowsBranching extends bool
     authorization?: AuthorizationDefinition;
     /** Optional attribute that specifies whether an Action will terminate execution.*/
     terminateExecution?: boolean;
+    /** Specifies whether an Action will break out of a loop. */
+    breakLoop?: boolean;
     /** Determines whether an Action will allow Conditional Branching.*/
     allowsBranching?: AllowsBranching;
     /** Static Branch names associated with an Action. */

package/dist/types/ActionLogger.d.ts

@@ -12,6 +12,8 @@ export declare type ActionLoggerFunction = (...args: unknown[]) => void;
  * An object containing logger functions.
  */
 export interface ActionLogger {
+    metric: ActionLoggerFunction;
+    trace: ActionLoggerFunction;
     debug: ActionLoggerFunction;
     info: ActionLoggerFunction;
     log: ActionLoggerFunction;

package/dist/types/ActionPerformFunction.d.ts

@@ -9,6 +9,8 @@ export interface ActionContext {
     logger: ActionLogger;
     /** A key/value store that may be used to store small amounts of data that is persisted between Instance executions */
     instanceState: Record<string, unknown>;
+    /** A key/value store that may be used to store small amounts of data for use later during the execution */
+    executionState: Record<string, unknown>;
     /** A unique id that corresponds to the step on the Integration */
     stepId: string;
     /** A unique id that corresponds to the specific execution of the Integration */

package/dist/types/ActionPerformReturn.d.ts

@@ -7,7 +7,9 @@ export interface ActionPerformDataReturn<ReturnData> {
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: 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>;
 }
 /** Used to represent a branching return of conventional data and does not require content type to be specified */
 /** Used to represent a binary or serialized data branching return as content type must be specified */

package/dist/types/TriggerDefinition.d.ts

@@ -21,6 +21,8 @@ export interface TriggerDefinition<T extends Inputs, AllowsBranching extends boo
     authorization?: AuthorizationDefinition;
     /** Optional attribute that specifies whether this Trigger will terminate execution. */
     terminateExecution?: boolean;
+    /** Specifies whether an Action will break out of a loop. */
+    breakLoop?: boolean;
     /** Determines whether this Trigger allows Conditional Branching. */
     allowsBranching?: AllowsBranching;
     /** Static Branch names associated with this Trigger. */

package/dist/types/TriggerPayload.d.ts

@@ -14,9 +14,14 @@ export interface TriggerPayload {
         data: unknown;
         contentType?: string;
     };
+    /** The webhook URLs assigned to this integration's flows upon instance deploy */
     webhookUrls: {
         [key: string]: string;
     };
+    /** The optional API keys assigned to the flows of this integration. These may be unique per integration instance and per flow. */
+    webhookApiKeys: {
+        [key: string]: string[];
+    };
     customer: {
         externalId: string | null;
         name: string | null;

package/dist/types/TriggerResult.d.ts

@@ -7,7 +7,9 @@ export interface TriggerBaseResult {
     /** Optional HTTP response to the request that invoked the integration. */
     response?: HttpResponse;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: 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>;
 }
 /** Represents the result of a Trigger action that uses branching. */
 export interface TriggerBranchingResult extends TriggerBaseResult {

package/dist/types/server-types.d.ts

@@ -47,6 +47,8 @@ interface BaseAction {
     authorization?: AuthorizationDefinition;
     /** Optional attribute that specifies whether an Action will terminate execution. */
     terminateExecution?: boolean;
+    /** Specifies whether an Action will break out of a loop. */
+    breakLoop?: boolean;
     /** Determines whether an Action will allow Conditional Branching. */
     allowsBranching?: boolean;
     /** Static Branch names associated with an Action. */
@@ -87,7 +89,9 @@ export interface ServerPerformDataStructureReturn {
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: 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>;
 }
 /** Used to represent a binary or serialized data return as content type must be specified */
 interface ServerPerformDataReturn {
@@ -98,7 +102,9 @@ interface ServerPerformDataReturn {
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: 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>;
 }
 /** Used to represent a branching return of conventional data and does not require content type to be specified */
 export interface ServerPerformBranchingDataStructureReturn extends ServerPerformDataStructureReturn {

package/dist/util.d.ts

@@ -5,6 +5,16 @@
  */
 import { DataPayload } from "./types/server-types";
 import { KeyValuePair } from "./types";
+/**
+ * This function returns a lower cased version of the headers passed to it.
+ *
+ * - `lowerCaseHeaders({"Content-Type": "Application/JSON"}) will return {"content-type": "Application/JSON"}`
+ * - `lowerCaseHeaders({"Cache-Control": "max-age=604800"}) will return {"cache-control": "max-age=604800"}`
+ * - `lowerCaseHeaders({"Accept-Language": "en-us"}) will return {"accept-language": "en-us"}`
+ * @param headers The headers to convert to lower case
+ * @returns This function returns a header object
+ * */
+export declare const lowerCaseHeaders: (headers: Record<string, string>) => Record<string, string>;
 declare const _default: {
     types: {
         isBool: (value: unknown) => value is boolean;
@@ -25,6 +35,7 @@ declare const _default: {
         toString: (value: unknown, defaultValue?: string) => string;
         keyValPairListToObject: (kvpList?: KeyValuePair<unknown>[]) => Record<string, unknown>;
         isJSON: (value: string) => boolean;
+        lowerCaseHeaders: (headers: Record<string, string>) => Record<string, string>;
     };
     docs: {
         formatJsonExample: (input: unknown) => string;

package/dist/util.js

@@ -8,6 +8,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.lowerCaseHeaders = void 0;
 /** */
 const parseISO_1 = __importDefault(require("date-fns/parseISO"));
 const isValid_1 = __importDefault(require("date-fns/isValid"));
@@ -97,7 +98,7 @@ const toInt = (value, defaultValue) => {
  * - `util.types.isBool("5.5")` will return `true`, since the string `"5.5"` can easily be coerced into a number.
  * - `util.types.isBool("Hello")` will return `false`, since `"Hello"` is not a number.
  *
- * @param value The varible to test.
+ * @param value The variable to test.
  * @returns This function returns true if `value` can easily be coerced into a number, and false otherwise.
  */
 const isNumber = (value) => !Number.isNaN(Number(value));
@@ -310,6 +311,19 @@ const isJSON = (value) => {
         return false;
     }
 };
+/**
+ * This function returns a lower cased version of the headers passed to it.
+ *
+ * - `lowerCaseHeaders({"Content-Type": "Application/JSON"}) will return {"content-type": "Application/JSON"}`
+ * - `lowerCaseHeaders({"Cache-Control": "max-age=604800"}) will return {"cache-control": "max-age=604800"}`
+ * - `lowerCaseHeaders({"Accept-Language": "en-us"}) will return {"accept-language": "en-us"}`
+ * @param headers The headers to convert to lower case
+ * @returns This function returns a header object
+ * */
+const lowerCaseHeaders = (headers) => Object.entries(headers).reduce((result, [key, val]) => {
+    return Object.assign(Object.assign({}, result), { [key.toLowerCase()]: val });
+}, {});
+exports.lowerCaseHeaders = lowerCaseHeaders;
 exports.default = {
     types: {
         isBool,
@@ -330,6 +344,7 @@ exports.default = {
         toString,
         keyValPairListToObject,
         isJSON,
+        lowerCaseHeaders: exports.lowerCaseHeaders,
     },
     docs: {
         formatJsonExample,

package/dist/util.test.js

@@ -283,4 +283,23 @@ describe("util", () => {
             }));
         });
     });
+    const validJSON = fast_check_1.default.jsonObject().map((x) => JSON.stringify(x));
+    const invalidJSON = fast_check_1.default.constantFrom("", "['']", "someString", null, undefined);
+    describe("JSON", () => {
+        it("returns true in the case of actual JSON", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(validJSON, (v) => {
+                expect(util_1.default.types.isJSON(v)).toStrictEqual(true);
+            }));
+        });
+        it("returns false in the case of invalid JSON", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidJSON, (v) => {
+                expect(util_1.default.types.isJSON(util_1.default.types.toString(v))).toStrictEqual(false);
+            }));
+        });
+        describe("JSON", () => {
+            it("returns true in the case of actual JSON", () => {
+                expect(util_1.default.types.lowerCaseHeaders({ "Content-Type": "Application/Json" })).toStrictEqual({ "content-type": "Application/Json" });
+            });
+        });
+    });
 });

package/package.json

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