@prismatic-io/spectral 10.17.2 → 10.18.2

package/dist/types/typeExportIntegration.js

@@ -14,30 +14,30 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ComponentRegistry"), exports);
-__exportStar(require("./ConfigPages"), exports);
-__exportStar(require("./ConfigVars"), exports);
-__exportStar(require("./ScopedConfigVars"), exports);
-__exportStar(require("./Inputs"), exports);
-__exportStar(require("./ActionPerformReturn"), exports);
-__exportStar(require("./DataPayload"), exports);
 __exportStar(require("./ActionInputParameters"), exports);
 __exportStar(require("./ActionLogger"), exports);
 __exportStar(require("./ActionPerformFunction"), exports);
+__exportStar(require("./ActionPerformReturn"), exports);
+__exportStar(require("./ComponentManifest"), exports);
+__exportStar(require("./ComponentRegistry"), exports);
+__exportStar(require("./ConfigPages"), exports);
+__exportStar(require("./ConfigVars"), exports);
+__exportStar(require("./CustomerAttributes"), exports);
 __exportStar(require("./conditional-logic"), exports);
-__exportStar(require("./TriggerEventFunction"), exports);
-__exportStar(require("./TriggerResult"), exports);
-__exportStar(require("./TriggerPerformFunction"), exports);
-__exportStar(require("./HttpResponse"), exports);
-__exportStar(require("./TriggerPayload"), exports);
+__exportStar(require("./DataPayload"), exports);
 __exportStar(require("./DataSourcePerformFunction"), exports);
 __exportStar(require("./DataSourceResult"), exports);
+__exportStar(require("./FlowAttributes"), exports);
+__exportStar(require("./FlowSchemas"), exports);
+__exportStar(require("./HttpResponse"), exports);
+__exportStar(require("./Inputs"), exports);
 __exportStar(require("./InstanceAttributes"), exports);
-__exportStar(require("./CustomerAttributes"), exports);
-__exportStar(require("./UserAttributes"), exports);
 __exportStar(require("./IntegrationAttributes"), exports);
-__exportStar(require("./FlowAttributes"), exports);
 __exportStar(require("./IntegrationDefinition"), exports);
-__exportStar(require("./ComponentManifest"), exports);
 __exportStar(require("./ScopedConfigVars"), exports);
-__exportStar(require("./FlowSchemas"), exports);
+__exportStar(require("./ScopedConfigVars"), exports);
+__exportStar(require("./TriggerEventFunction"), exports);
+__exportStar(require("./TriggerPayload"), exports);
+__exportStar(require("./TriggerPerformFunction"), exports);
+__exportStar(require("./TriggerResult"), exports);
+__exportStar(require("./UserAttributes"), exports);

package/dist/util.d.ts

@@ -3,31 +3,46 @@
  * 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, Element } from "./types";
+import { ConnectionDefinition, DataPayload, Element, JSONForm, KeyValuePair, ObjectFieldMap, ObjectSelection } from "./types";
 export declare const isObjectWithOneTruthyKey: (value: unknown, keys: string[]) => boolean;
 export declare const isObjectWithTruthyKeys: (value: unknown, keys: string[]) => boolean;
 /**
- * This function returns a lower cased version of the headers passed to it.
+ * This function returns a version of the headers object where all header
+ * names (keys) are lower-cased. Header values are left unchanged.
  *
- * - `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
- * */
+ * @param headers The headers to convert to lower case.
+ * @returns A new header object with lower-cased keys.
+ * @example
+ * import { util } from "@prismatic-io/spectral";
+ *
+ * util.types.lowerCaseHeaders({ "Content-Type": "application/json" });
+ * // { "content-type": "application/json" }
+ *
+ * util.types.lowerCaseHeaders({
+ *   "Cache-Control": "max-age=604800",
+ *   "Accept-Language": "en-us",
+ * });
+ * // { "cache-control": "max-age=604800", "accept-language": "en-us" }
+ */
 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.
+ * This function parses a JSON string and returns the resulting object,
+ * or returns the value as-is if it is already an 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 An object, parsing JSON as necessary.
+ * @example
+ * import { util } from "@prismatic-io/spectral";
  *
- * @param value The JSON string or object to convert
- * @returns This function returns an object, parsing JSON as necessary
+ * util.types.toObject('{"foo":"bar","baz":123}');
+ * // { foo: "bar", baz: 123 }
+ *
+ * util.types.toObject({ foo: "bar", baz: 123 });
+ * // { foo: "bar", baz: 123 } (returned as-is)
  */
 export declare const toObject: (value: unknown) => object;
-export * from "./errors";
 export * from "./conditionalLogic";
+export * from "./errors";
 declare const _default: {
     types: {
         isBool: (value: unknown) => value is boolean;