@prismatic-io/spectral 7.0.2-pre → 7.0.3-pre

package/dist/types/DataSourceResult.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-import { ObjectSelection, ObjectFieldMap, InputFieldDefaultMap } from "./Inputs";
+import { ObjectSelection, ObjectFieldMap, InputFieldDefaultMap, JSONForm } from "./Inputs";
 /** The type of field that is appropriate for rendering the data that is the result of the data source perform function. */
 export declare type DataSourceResultFieldType = keyof typeof InputFieldDefaultMap;
 /** The actual data type of the data that is the result of the data source perform function. */
-export declare type DataSourceResultType = ObjectSelection | ObjectFieldMap | Buffer | boolean | number | string | Record<string, unknown> | unknown[] | unknown;
+export declare type DataSourceResultType = ObjectSelection | ObjectFieldMap | JSONForm | Buffer | boolean | number | string | Record<string, unknown> | unknown[] | unknown;
 /** Represents the result of a Data Source action. */
 export declare type DataSourceResult<TDataSourceResultType> = {
     /** The resulting data that is returned from the data source. */

package/dist/types/Inputs.d.ts

@@ -17,6 +17,11 @@ export declare type ObjectFieldMap = {
         fieldLabel?: string;
     };
 }[];
+export declare type JSONForm = {
+    schema: Record<string, unknown>;
+    uiSchema: Record<string, unknown>;
+    data: unknown;
+};
 /** InputField type enumeration. */
 export declare type InputFieldType = InputFieldDefinition["type"];
 export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;
@@ -24,7 +29,7 @@ export declare type Inputs = Record<string, InputFieldDefinition>;
 export declare type ConnectionInput = (StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField) & {
     shown?: boolean;
 };
-export declare type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ObjectSelectionInputField | ObjectFieldMapInputField;
+export declare type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField;
 export declare type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
 interface BaseInputField {
     /** Interface label of the InputField. */
@@ -172,6 +177,17 @@ export interface ObjectFieldMapInputField extends BaseInputField {
     /** Clean function */
     clean?: InputCleanFunction<NonNullable<this["default"]>>;
 }
+/** Defines attributes of a JSONFOrmInputField. */
+export interface JSONFormInputField extends BaseInputField {
+    /** Data type the InputField will collect. */
+    type: "jsonform";
+    /** Collection type of the InputField */
+    collection?: InputFieldCollection;
+    /** Default value for this field. */
+    default?: JSONForm;
+    /** Clean function */
+    clean?: InputCleanFunction<NonNullable<this["default"]>>;
+}
 /** Defines a single Choice option for a InputField. */
 export interface InputFieldChoice {
     /** Label to display for this Choice. */

package/dist/types/Inputs.js

@@ -12,4 +12,5 @@ exports.InputFieldDefaultMap = {
     connection: undefined,
     objectselection: undefined,
     objectfieldmap: undefined,
+    jsonform: undefined,
 };

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

package/dist/util.js

@@ -90,6 +90,24 @@ const toObjectFieldMap = (value) => {
     }
     throw new Error(`Value '${value}' cannot be coerced to ObjectFieldMap.`);
 };
+/**
+ * @param value The value to test
+ * @returns This function returns true if the type of `value` is a JSONForm, or false otherwise.
+ */
+const isJSONForm = (value) => {
+    return isObjectWithTruthyKeys(value, ["schema", "uiSchema", "data"]);
+};
+/**
+ * This function coerces a provided value into a JSONForm if possible.
+ * @param value The value to coerce to JSONForm.
+ * @returns This function returns the the value as a JSONForm if possible.
+ */
+const toJSONForm = (value) => {
+    if (isJSONForm(value)) {
+        return value;
+    }
+    throw new Error(`Value '${value}' cannot be coerced to JSONForm.`);
+};
 /**
  * Determine if a variable is a boolean (true or false).
  *
@@ -436,6 +454,8 @@ exports.default = {
         toObjectSelection,
         isObjectFieldMap,
         toObjectFieldMap,
+        isJSONForm,
+        toJSONForm,
     },
     docs: {
         formatJsonExample,

package/package.json

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