@prismatic-io/spectral 7.2.0 → 7.2.1

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.2.1",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"