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

package/dist/serverTypes/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { DataSourceType } from "../types";
+import { DataSourceResultType, DataSourceResultFieldType } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
@@ -128,7 +128,7 @@ export interface Trigger {
     isCommonTrigger?: boolean;
 }
 export declare type DataSourceResult = {
-    content: DataSourceType;
+    result: DataSourceResultType;
     supplementalData: {
         data: unknown;
         contentType: string;
@@ -143,6 +143,7 @@ export interface DataSource {
     };
     inputs: Input[];
     perform: DataSourcePerformFunction;
+    resultFieldType: DataSourceResultFieldType;
     examplePayload?: unknown;
 }
 export declare enum OAuth2Type {

package/dist/types/DataSourceDefinition.d.ts

@@ -1,13 +1,15 @@
-import { ActionDisplayDefinition, DataSourcePerformFunction, Inputs, DataSourceResult, DataSourceType } from ".";
+import { ActionDisplayDefinition, DataSourcePerformFunction, Inputs, DataSourceResult, DataSourceResultType, DataSourceResultFieldType } from ".";
 /**
  * DataSourceDefinition is the type of the object that is passed in to `dataSource` function to
  * define a component Data Source.
  */
-export interface DataSourceDefinition<TInputs extends Inputs, TDataSourceResult extends DataSourceResult<DataSourceType>> {
+export interface DataSourceDefinition<TInputs extends Inputs, TDataSourceResult extends DataSourceResult<DataSourceResultType>> {
     /** Defines how the Data Source is displayed in the Prismatic interface. */
     display: ActionDisplayDefinition;
     /** Function to perform when this Data Source is invoked. */
     perform: DataSourcePerformFunction<TInputs, TDataSourceResult>;
+    /** Field type of the data produced by the data source perform function. */
+    resultFieldType: DataSourceResultFieldType;
     /** InputFields to present in the Prismatic interface for configuration of this Data Source. */
     inputs: TInputs;
     /** An example of the payload outputted by this Data Source. */

package/dist/types/DataSourcePerformFunction.d.ts

@@ -1,3 +1,3 @@
-import { Inputs, DataSourceResult, DataSourceType, ActionInputParameters, ActionContext } from ".";
+import { Inputs, DataSourceResult, DataSourceResultType, ActionInputParameters, ActionContext } from ".";
 /** Definition of the function to perform when a Data Source is invoked. */
-export declare type DataSourcePerformFunction<T extends Inputs, TResult extends DataSourceResult<DataSourceType>> = (context: ActionContext, params: ActionInputParameters<T>) => Promise<TResult>;
+export declare type DataSourcePerformFunction<T extends Inputs, TResult extends DataSourceResult<DataSourceResultType>> = (context: ActionContext, params: ActionInputParameters<T>) => Promise<TResult>;

package/dist/types/DataSourceResult.d.ts

@@ -1,7 +1,13 @@
+/// <reference types="node" />
+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 | JSONForm | Buffer | boolean | number | string | Record<string, unknown> | unknown[] | unknown;
 /** Represents the result of a Data Source action. */
-export declare type DataSourceResult<ContentData> = {
-    /** The data that will be used as content. */
-    content: ContentData;
+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. */
     supplementalData?: {
         data: unknown;

package/dist/types/Inputs.d.ts

@@ -1,5 +1,27 @@
 import { ConditionalExpression } from "./conditional-logic";
-import { ObjectSelection, ObjectFieldMap } from "./DataSourceType";
+export declare type ObjectSelection = {
+    key: string;
+    label?: string;
+    fields: {
+        key: string;
+        label?: string;
+    }[];
+}[];
+export declare type ObjectFieldMap = {
+    key: string;
+    label?: string;
+    value: {
+        objectKey: string;
+        objectLabel?: string;
+        fieldKey: string;
+        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>;
@@ -7,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. */
@@ -155,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/types/index.d.ts

@@ -21,4 +21,4 @@ export * from "./TriggerPayload";
 export * from "./DataSourceDefinition";
 export * from "./DataSourcePerformFunction";
 export * from "./DataSourceResult";
-export * from "./DataSourceType";
+export * as serverTypes from "../serverTypes";

package/dist/types/index.js

@@ -14,10 +14,23 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 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);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.serverTypes = void 0;
 __exportStar(require("./ActionDefinition"), exports);
 __exportStar(require("./ComponentDefinition"), exports);
 __exportStar(require("./ConnectionDefinition"), exports);
@@ -37,4 +50,4 @@ __exportStar(require("./TriggerPayload"), exports);
 __exportStar(require("./DataSourceDefinition"), exports);
 __exportStar(require("./DataSourcePerformFunction"), exports);
 __exportStar(require("./DataSourceResult"), exports);
-__exportStar(require("./DataSourceType"), exports);
+exports.serverTypes = __importStar(require("../serverTypes"));

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.0-pre",
+  "version": "7.0.3-pre",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"

package/dist/types/DataSourceType.d.ts

@@ -1,20 +0,0 @@
-/// <reference types="node" />
-export declare type ObjectSelection = {
-    key: string;
-    label?: string;
-    fields: {
-        key: string;
-        label?: string;
-    }[];
-}[];
-export declare type ObjectFieldMap = {
-    key: string;
-    label?: string;
-    value: {
-        objectKey: string;
-        objectLabel?: string;
-        fieldKey: string;
-        fieldLabel?: string;
-    };
-}[];
-export declare type DataSourceType = ObjectSelection | ObjectFieldMap | Buffer | boolean | number | string | Record<string, unknown> | unknown[] | unknown;

package/dist/types/DataSourceType.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });