@prismatic-io/spectral 7.2.0 → 7.3.1

package/dist/serverTypes/index.d.ts

@@ -49,6 +49,7 @@ export interface ActionContext {
     instanceState: Record<string, unknown>;
     crossFlowState: Record<string, unknown>;
     executionState: Record<string, unknown>;
+    integrationState: Record<string, unknown>;
     stepId: string;
     executionId: string;
     webhookUrls: Record<string, string>;
@@ -89,6 +90,7 @@ interface TriggerBaseResult {
     instanceState?: Record<string, unknown>;
     crossFlowState?: Record<string, unknown>;
     executionState?: Record<string, unknown>;
+    integrationState?: Record<string, unknown>;
     failed?: boolean;
     error?: Record<string, unknown>;
 }
@@ -169,6 +171,7 @@ interface ServerPerformDataStructureReturn {
     instanceState?: Record<string, unknown>;
     crossFlowState?: Record<string, unknown>;
     executionState?: Record<string, unknown>;
+    integrationState?: Record<string, unknown>;
     failed?: boolean;
     error?: Record<string, unknown>;
 }
@@ -179,6 +182,7 @@ interface ServerPerformDataReturn {
     instanceState?: Record<string, unknown>;
     crossFlowState?: Record<string, unknown>;
     executionState?: Record<string, unknown>;
+    integrationState?: Record<string, unknown>;
     failed?: boolean;
     error?: Record<string, unknown>;
 }

package/dist/testing.js

@@ -42,6 +42,7 @@ const baseActionContext = {
     instanceState: {},
     crossFlowState: {},
     executionState: {},
+    integrationState: {},
     stepId: "mockStepId",
     executionId: "mockExecutionId",
     webhookUrls: {

package/dist/types/ActionPerformFunction.d.ts

@@ -7,10 +7,12 @@ export interface ActionContext {
     logger: ActionLogger;
     /** A a flow-specific key/value store that may be used to store small amounts of data that is persisted between Instance executions */
     instanceState: Record<string, unknown>;
-    /** An key/value store what is shared between flows on an Instance that may be used to store small amounts of data that is persisted between Instance executions */
+    /** A key/value store that is shared between flows on an Instance that may be used to store small amounts of data that is persisted between Instance executions */
     crossFlowState: 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 key/value store that is shared between all flows of an Instance for any version of an Integration that may be used to store small amounts of data that is persisted between Instance executions */
+    integrationState: 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

@@ -12,6 +12,8 @@ export interface ActionPerformDataReturn<ReturnData> {
     crossFlowState?: 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>;
+    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions */
+    integrationState?: Record<string, unknown>;
     /** A field populated by the Prismatic platform which indicates whether the action failed with an error during execution. */
     failed?: boolean;
     /** A field populated by the Prismatic platform which may refer to an object that contains data about any error that resulted in failure. */

package/dist/types/TriggerResult.d.ts

@@ -12,6 +12,8 @@ export interface TriggerBaseResult {
     crossFlowState?: 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>;
+    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions */
+    integrationState?: Record<string, unknown>;
     /** A field populated by the Prismatic platform which indicates whether the trigger failed with an error during execution. */
     failed?: boolean;
     /** A field populated by the Prismatic platform which may refer to an object that contains data about any error that resulted in failure. */

package/dist/util.d.ts

@@ -7,13 +7,23 @@ import { KeyValuePair, DataPayload, ObjectSelection, ObjectFieldMap, JSONForm, C
 /**
  * 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"}`
+ * - `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>;
+/**
+ * This function parses a JSON string (if JSON) and returns an object, or returns the object.
+ *
+ * - `toObject('{"foo":"bar","baz":123}')` will return object `{foo: "bar", baz: 123}`
+ * - `toObject({foo:"bar",baz:123})` will return object `{foo: "bar", baz: 123}`
+ *
+ * @param value The JSON string or object to convert
+ * @returns This function returns an object, parsing JSON as necessary
+ */
+export declare const toObject: (value: unknown) => object;
 declare const _default: {
     types: {
         isBool: (value: unknown) => value is boolean;
@@ -47,6 +57,7 @@ declare const _default: {
         isSchedule: (value: unknown) => boolean;
         isConnection: (value: unknown) => value is ConnectionDefinition;
         isElement: (value: unknown) => value is Element;
+        toObject: (value: unknown) => object;
     };
 };
 export default _default;

package/dist/util.js

@@ -8,7 +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;
+exports.toObject = exports.lowerCaseHeaders = void 0;
 /** */
 const parseISO_1 = __importDefault(require("date-fns/parseISO"));
 const isValid_1 = __importDefault(require("date-fns/isValid"));
@@ -449,7 +449,8 @@ const isJSON = (value) => {
         return false;
     }
 };
-/** This function accepts an arbitrary object/value and safely serializes it (handles cyclic references).
+/**
+ * This function accepts an arbitrary object/value and safely serializes it (handles cyclic references).
  *
  * @param value Arbitrary object/value to serialize.
  * @returns JSON serialized text that can be safely logged.
@@ -461,9 +462,9 @@ const toJSON = (value) => {
 /**
  * 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"}`
+ * - `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
  * */
@@ -471,6 +472,24 @@ const lowerCaseHeaders = (headers) => Object.entries(headers).reduce((result, [k
     return Object.assign(Object.assign({}, result), { [key.toLowerCase()]: val });
 }, {});
 exports.lowerCaseHeaders = lowerCaseHeaders;
+/**
+ * This function parses a JSON string (if JSON) and returns an object, or returns the object.
+ *
+ * - `toObject('{"foo":"bar","baz":123}')` will return object `{foo: "bar", baz: 123}`
+ * - `toObject({foo:"bar",baz:123})` will return object `{foo: "bar", baz: 123}`
+ *
+ * @param value The JSON string or object to convert
+ * @returns This function returns an object, parsing JSON as necessary
+ */
+const toObject = (value) => {
+    if (typeof value === "string" && isJSON(value)) {
+        return JSON.parse(value);
+    }
+    else {
+        return value;
+    }
+};
+exports.toObject = toObject;
 exports.default = {
     types: {
         isBool,
@@ -504,5 +523,6 @@ exports.default = {
         isSchedule,
         isConnection,
         isElement,
+        toObject: exports.toObject,
     },
 };

package/package.json

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