@prismatic-io/spectral 7.0.15-pre → 7.0.16-pre

package/dist/util.d.ts

@@ -3,7 +3,7 @@
  * 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 } from "./types";
+import { KeyValuePair, DataPayload, ObjectSelection, ObjectFieldMap, JSONForm, ConnectionDefinition } from "./types";
 /**
  * This function returns a lower cased version of the headers passed to it.
  *
@@ -45,6 +45,7 @@ declare const _default: {
         toJSONForm: (value: unknown) => JSONForm;
         isPicklist: (value: unknown) => boolean;
         isSchedule: (value: unknown) => boolean;
+        isConnection: (value: unknown) => value is ConnectionDefinition;
     };
     docs: {
         formatJsonExample: (input: unknown) => string;

package/dist/util.js

@@ -405,6 +405,37 @@ const isString = (value) => typeof value === "string" || value instanceof String
  * @returns This function returns the stringified version fo `value`, or `defaultValue` in the case that `value` is undefined or an empty string.
  */
 const toString = (value, defaultValue = "") => `${value !== null && value !== void 0 ? value : defaultValue}`;
+/**
+ * This function checks if value is a valid connection.
+ * @param value The variable to test.
+ * @returns This function returns true or false, depending on if `value` is a valid connection.
+ */
+const isConnection = (value) => {
+    if (typeof value === "string" && isJSON(value)) {
+        return isConnection(JSON.parse(value));
+    }
+    if (Boolean(value) && typeof value === "object") {
+        const { inputs } = value;
+        if (isObjectWithTruthyKeys(value, ["key", "label", "oauth2Type"])) {
+            return (isObjectWithTruthyKeys(inputs, [
+                "authorizeUrl",
+                "tokenUrl",
+                "scopes",
+                "clientId",
+                "clientSecret",
+            ]) ||
+                isObjectWithTruthyKeys(inputs, [
+                    "tokenUrl",
+                    "scopes",
+                    "clientId",
+                    "clientSecret",
+                ]));
+        }
+        return (isObjectWithTruthyKeys(value, ["key", "label"]) &&
+            typeof inputs === "object");
+    }
+    return false;
+};
 /**
  * This function returns true if `value` resembles the shape of JSON, and false otherwise.
  *
@@ -478,6 +509,7 @@ exports.default = {
         toJSONForm,
         isPicklist,
         isSchedule,
+        isConnection,
     },
     docs: {
         formatJsonExample,

package/package.json

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