@prismatic-io/spectral 6.5.2 → 6.6.0

package/dist/serverTypes/index.d.ts

@@ -47,6 +47,18 @@ export interface ActionContext {
     executionState: Record<string, unknown>;
     stepId: string;
     executionId: string;
+    webhookUrls: Record<string, string>;
+    webhookApiKeys: Record<string, string[]>;
+    invokeUrl: string;
+    customer: {
+        id: string | null;
+        externalId: string | null;
+        name: string | null;
+    };
+    instance: {
+        id: string | null;
+        name: string | null;
+    };
 }
 declare type TriggerOptionChoice = "invalid" | "valid" | "required";
 export interface TriggerPayload {

package/dist/testing.js

@@ -44,7 +44,18 @@ exports.loggerMock = loggerMock;
  * action result and a mock logger for asserting logging.
  */
 const invoke = ({ perform }, params, context) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+    const realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId", webhookUrls: {
+            "Flow 1": "https://example.com",
+        }, webhookApiKeys: {
+            "Flow 1": ["example-123", "example-456"],
+        }, invokeUrl: "https://example.com", customer: {
+            id: "customerId",
+            name: "Customer 1",
+            externalId: "1234",
+        }, instance: {
+            id: "instanceId",
+            name: "Instance 1",
+        } }, context);
     const result = yield perform(realizedContext, params);
     return {
         result,
@@ -96,7 +107,18 @@ exports.defaultTriggerPayload = defaultTriggerPayload;
  * trigger result and a mock logger for asserting logging.
  */
 const invokeTrigger = ({ perform }, context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+    const realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId", webhookUrls: {
+            "Flow 1": "https://example.com",
+        }, webhookApiKeys: {
+            "Flow 1": ["example-123", "example-456"],
+        }, invokeUrl: "https://example.com", customer: {
+            id: "customerId",
+            name: "Customer 1",
+            externalId: "1234",
+        }, instance: {
+            id: "instanceId",
+            name: "Instance 1",
+        } }, context);
     const realizedPayload = Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload);
     const realizedParams = params || {};
     const result = yield perform(realizedContext, realizedPayload, realizedParams);
@@ -120,14 +142,36 @@ class ComponentTestHarness {
     }
     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 realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId", webhookUrls: {
+                    "Flow 1": "https://example.com",
+                }, webhookApiKeys: {
+                    "Flow 1": ["example-123", "example-456"],
+                }, invokeUrl: "https://example.com", customer: {
+                    id: "customerId",
+                    name: "Customer 1",
+                    externalId: "1234",
+                }, instance: {
+                    id: "instanceId",
+                    name: "Instance 1",
+                } }, 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 realizedContext = Object.assign({ logger: (0, exports.loggerMock)(), instanceState: {}, crossFlowState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId", webhookUrls: {
+                    "Flow 1": "https://example.com",
+                }, webhookApiKeys: {
+                    "Flow 1": ["example-123", "example-456"],
+                }, invokeUrl: "https://example.com", customer: {
+                    id: "customerId",
+                    name: "Customer 1",
+                    externalId: "1234",
+                }, instance: {
+                    id: "instanceId",
+                    name: "Instance 1",
+                } }, context);
             const action = this.component.actions[key];
             return action.perform(realizedContext, Object.assign({}, params));
         });

package/dist/types/ActionPerformFunction.d.ts

@@ -15,4 +15,21 @@ export interface ActionContext {
     stepId: string;
     /** A unique id that corresponds to the specific execution of the Integration */
     executionId: string;
+    /** An object containing webhook URLs for all flows of the currently running instance */
+    webhookUrls: Record<string, string>;
+    /** An object containing webhook API keys for all flows of the currently running instance */
+    webhookApiKeys: Record<string, string[]>;
+    /** The URL used to invoke the current execution */
+    invokeUrl: string;
+    /** An object containing the ID, External ID and name of the customer the instance is deployed to */
+    customer: {
+        id: string | null;
+        externalId: string | null;
+        name: string | null;
+    };
+    /** An object containing the ID ad name of the currently running instance */
+    instance: {
+        id: string | null;
+        name: string | null;
+    };
 }

package/dist/util.js

@@ -26,16 +26,16 @@ const valid_url_1 = require("valid-url");
  */
 const isBool = (value) => value === true || value === false;
 /**
- * Convert truthey (true, "t", "true", "y", "yes") values to boolean `true`,
- * and falsey (false, "f", "false", "n", "no") values to boolean `false`.
- * Truthy/falsey checks are case-insensitive.
+ * Convert truthy (true, "t", "true", "y", "yes") values to boolean `true`,
+ * and falsy (false, "f", "false", "n", "no") values to boolean `false`.
+ * Truthy/falsy checks are case-insensitive.
  *
  * In the event that `value` is undefined or an empty string, a default value can be provided.
  * For example, `util.types.toBool('', true)` will return `true`.
  *
  * @param value The value to convert to a boolean.
  * @param defaultValue The value to return if `value` is undefined or an empty string.
- * @returns The boolean equivalent of the truthey or falsey `value`.
+ * @returns The boolean equivalent of the truthy or falsy `value`.
  */
 const toBool = (value, defaultValue) => {
     if (isBool(value)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "6.5.2",
+  "version": "6.6.0",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -29,7 +29,7 @@
     "check": "yarn run check-format && yarn run lint",
     "lint": "eslint --ext .ts .",
     "lint-fix": "eslint --fix --ext .ts .",
-    "test": "jest --maxWorkers=4",
+    "test": "jest",
     "tsd": "tsd",
     "docs": "rm -f sidebars.{js,jse} && typedoc"
   },