@prismatic-io/spectral 7.1.0 → 7.2.1

package/dist/index.d.ts

@@ -47,7 +47,7 @@ export declare const dataSource: <TInputs extends Inputs, TDataSourceType extend
     string: string;
     date: string;
     timestamp: string;
-    picklist: string[];
+    picklist: string[] | import("./types").Element[];
     schedule: {
         value: string;
     };

package/dist/testing.d.ts

@@ -43,7 +43,7 @@ export declare const invokeDataSource: <TInputs extends Inputs, TDataSourceType
     string: string;
     date: string;
     timestamp: string;
-    picklist: string[];
+    picklist: string[] | import("./types").Element[];
     schedule: {
         value: string;
     };
@@ -76,7 +76,7 @@ declare const _default: {
         string: string;
         date: string;
         timestamp: string;
-        picklist: string[];
+        picklist: string[] | import("./types").Element[];
         schedule: {
             value: string;
         };

package/dist/types/DataSourceResult.d.ts

@@ -1,11 +1,11 @@
 import { ConnectionDefinition } from "./ConnectionDefinition";
-import { ObjectSelection, ObjectFieldMap, JSONForm } from "./Inputs";
+import { ObjectSelection, ObjectFieldMap, JSONForm, Element } from "./Inputs";
 /** The type of field that is appropriate for rendering the data that is the result of the data source perform function. */
 declare type DataSourceTypeMap = {
     string: string;
     date: string;
     timestamp: string;
-    picklist: string[];
+    picklist: string[] | Element[];
     schedule: {
         value: string;
     };

package/dist/util.d.ts

@@ -3,17 +3,27 @@
  * Many functions in the `util` module are used to coerce data into a particular type, and can be accessed through `util.types`.
  * For example, `util.types.toInt("5.5")` will return an integer, `5`.
  */
-import { KeyValuePair, DataPayload, ObjectSelection, ObjectFieldMap, JSONForm, ConnectionDefinition } from "./types";
+import { KeyValuePair, DataPayload, ObjectSelection, ObjectFieldMap, JSONForm, ConnectionDefinition, Element } 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"}`
+ * - `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;
@@ -46,9 +56,8 @@ declare const _default: {
         isPicklist: (value: unknown) => boolean;
         isSchedule: (value: unknown) => boolean;
         isConnection: (value: unknown) => value is ConnectionDefinition;
-    };
-    docs: {
-        formatJsonExample: (input: unknown) => string;
+        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"));
@@ -20,6 +20,13 @@ const isObjectWithTruthyKeys = (value, keys) => {
         typeof value === "object" &&
         keys.every((key) => key in value && Boolean(value === null || value === void 0 ? void 0 : value[key])));
 };
+/**
+ * This function checks if value is an Element.
+ * `util.types.isElement({key: "foo"})` and `util.types.isElement({key: "foo", label: "Foo"})` return true.
+ * @param value The variable to test.
+ * @returns This function returns true or false, depending on if `value` is an Element.
+ */
+const isElement = (value) => isObjectWithTruthyKeys(value, ["key"]);
 /**
  * @param value The value to test
  * @returns This function returns true if the type of `value` is an ObjectSelection, or false otherwise.
@@ -57,9 +64,7 @@ const isObjectFieldMap = (value) => {
         const { fields } = value;
         return (Array.isArray(fields) &&
             fields.every((item) => isObjectWithTruthyKeys(item, ["field"]) &&
-                isObjectWithTruthyKeys(item === null || item === void 0 ? void 0 : item.field, [
-                    "key",
-                ])));
+                isElement(item === null || item === void 0 ? void 0 : item.field)));
     }
     return false;
 };
@@ -281,7 +286,7 @@ const isUrl = (value) => (0, valid_url_1.isWebUri)(value) !== undefined;
  * @param value The variable to test.
  * @returns This function returns true if `value` is a valid picklist.
  */
-const isPicklist = (value) => Array.isArray(value) && value.every(isString);
+const isPicklist = (value) => Array.isArray(value) && (value.every(isString) || value.every(isElement));
 /**
  * This function checks if value is a valid schedule.
  *
@@ -379,12 +384,6 @@ const isData = (value) => isBufferDataPayload(value);
  * @returns This function returns an object with two keys: `data`, which is a `Buffer`, and `contentType`, which is a string.
  */
 const toData = (value) => toBufferDataPayload(value);
-/**
- * This function helps to format JSON examples for documentation.
- * @param input An object to be JSONified.
- * @returns This function returns a code block that can be used for documentation.
- */
-const formatJsonExample = (input) => ["```json", JSON.stringify(input, undefined, 2), "```"].join("\n");
 /**
  * This function checks if value is a string.
  * `util.types.isString("value")` and `util.types.isString(new String("value"))` return true.
@@ -450,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.
@@ -462,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
  * */
@@ -472,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,8 +522,7 @@ exports.default = {
         isPicklist,
         isSchedule,
         isConnection,
-    },
-    docs: {
-        formatJsonExample,
+        isElement,
+        toObject: exports.toObject,
     },
 };

package/package.json

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