@prismatic-io/spectral 7.0.5-pre → 7.0.8-pre

package/dist/types/DataSourceDefinition.d.ts

@@ -14,4 +14,6 @@ export interface DataSourceDefinition<TInputs extends Inputs, TDataSourceResult
     inputs: TInputs;
     /** An example of the payload outputted by this Data Source. */
     examplePayload?: Awaited<ReturnType<this["perform"]>>;
+    /** Specifies the name of a Data Source in this Component which can provide additional details about the content for this Data Source, such as example values when selecting particular API object fields. */
+    detailDataSource?: string;
 }

package/dist/types/DataSourceResult.d.ts

@@ -8,7 +8,9 @@ export declare type DataSourceResultType = ObjectSelection | ObjectFieldMap | JS
 export declare type DataSourceResult<TDataSourceResultType> = {
     /** The resulting data that is returned from the data source. */
     result: TDataSourceResultType;
-    /** Additional data that may be useful for out-of-band processing at a later time. */
+    /** Additional data that may be useful for out-of-band processing at a later time.
+     *  NOTE: This is only available when the Data Source is called as part of fetching
+     *  contents for a Configuration Wizard Page. */
     supplementalData?: {
         data: unknown;
         contentType: string;

package/dist/types/Inputs.d.ts

@@ -19,9 +19,7 @@ export declare type ObjectFieldMap = {
     };
     defaultValue?: {
         objectKey: string;
-        objectLabel?: string;
         fieldKey: string;
-        fieldLabel?: string;
     };
 }[];
 export declare type JSONForm = {
@@ -165,7 +163,7 @@ export interface Connection {
 /** Defines attributes of an ObjectSelectionInputField. */
 export interface ObjectSelectionInputField extends BaseInputField {
     /** Data type the InputField will collect. */
-    type: "objectselection";
+    type: "objectSelection";
     /** Collection type of the InputField */
     collection?: InputFieldCollection;
     /** Default value for this field. */
@@ -176,7 +174,7 @@ export interface ObjectSelectionInputField extends BaseInputField {
 /** Defines attributes of an ObjectFieldMapInputField. */
 export interface ObjectFieldMapInputField extends BaseInputField {
     /** Data type the InputField will collect. */
-    type: "objectfieldmap";
+    type: "objectFieldMap";
     /** Collection type of the InputField */
     collection?: InputFieldCollection;
     /** Default value for this field. */
@@ -184,10 +182,10 @@ export interface ObjectFieldMapInputField extends BaseInputField {
     /** Clean function */
     clean?: InputCleanFunction<NonNullable<this["default"]>>;
 }
-/** Defines attributes of a JSONFOrmInputField. */
+/** Defines attributes of a JSONFormInputField. */
 export interface JSONFormInputField extends BaseInputField {
     /** Data type the InputField will collect. */
-    type: "jsonform";
+    type: "jsonForm";
     /** Collection type of the InputField */
     collection?: InputFieldCollection;
     /** Default value for this field. */

package/dist/types/Inputs.js

@@ -10,7 +10,7 @@ exports.InputFieldDefaultMap = {
     code: "",
     conditional: undefined,
     connection: undefined,
-    objectselection: undefined,
-    objectfieldmap: undefined,
-    jsonform: undefined,
+    objectSelection: undefined,
+    objectFieldMap: undefined,
+    jsonForm: undefined,
 };

package/dist/util.d.ts

@@ -31,6 +31,7 @@ declare const _default: {
         toBufferDataPayload: (value: unknown) => DataPayload;
         isData: (value: unknown) => boolean;
         toData: (value: unknown) => DataPayload;
+        isString: (value: unknown) => value is string;
         toString: (value: unknown, defaultValue?: string) => string;
         keyValPairListToObject: <TValue = unknown>(kvpList: KeyValuePair<unknown>[], valueConverter?: ((value: unknown) => TValue) | undefined) => Record<string, TValue>;
         isJSON: (value: string) => boolean;
@@ -42,6 +43,8 @@ declare const _default: {
         toObjectFieldMap: (value: unknown) => ObjectFieldMap;
         isJSONForm: (value: unknown) => value is JSONForm;
         toJSONForm: (value: unknown) => JSONForm;
+        isPicklist: (value: unknown) => boolean;
+        isSchedule: (value: unknown) => boolean;
     };
     docs: {
         formatJsonExample: (input: unknown) => string;

package/dist/util.js

@@ -280,6 +280,25 @@ const toDate = (value) => {
  * @returns This function returns true if `value` is a valid URL, and false otherwise.
  */
 const isUrl = (value) => (0, valid_url_1.isWebUri)(value) !== undefined;
+/**
+ * This function checks if value is a valid picklist.
+ *
+ * - `util.types.isPicklist(["value", new String("value")])` will return `true`.
+ *
+ * @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);
+/**
+ * This function checks if value is a valid schedule.
+ *
+ * - `util.types.isSchedule({value: "00 00 * * 2,3"})` will return `true`.
+ * - `util.types.isSchedule({value: "00 00 * * 2,3", scheduleType: "week", timeZone: "America/Chicago"})` will return `true`.
+ *
+ * @param value The variable to test.
+ * @returns This function returns true if `value` is a valid schedule.
+ */
+const isSchedule = (value) => isObjectWithTruthyKeys(value, ["value"]);
 /**
  * This function helps to transform key-value lists to objects.
  * This is useful for transforming inputs that are key-value collections into objects.
@@ -373,6 +392,13 @@ const toData = (value) => toBufferDataPayload(value);
  * @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.
+ * @param value The variable to test.
+ * @returns This function returns true or false, depending on if `value` is a string.
+ */
+const isString = (value) => typeof value === "string" || value instanceof String;
 /**
  * This function converts a `value` to a string.
  * If `value` is undefined or an empty string, an optional `defaultValue` can be returned.
@@ -445,6 +471,7 @@ exports.default = {
         toBufferDataPayload,
         isData,
         toData,
+        isString,
         toString,
         keyValPairListToObject,
         isJSON,
@@ -456,6 +483,8 @@ exports.default = {
         toObjectFieldMap,
         isJSONForm,
         toJSONForm,
+        isPicklist,
+        isSchedule,
     },
     docs: {
         formatJsonExample,

package/package.json

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