@prismatic-io/spectral 7.0.4-pre → 7.0.7-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

@@ -1,14 +1,16 @@
 /// <reference types="node" />
-import { ObjectSelection, ObjectFieldMap, InputFieldDefaultMap, JSONForm } from "./Inputs";
+import { ObjectSelection, ObjectFieldMap, 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;
+export declare type DataSourceResultFieldType = "string" | "date" | "timestamp" | "picklist" | "schedule" | "code" | "credential" | "boolean" | "number" | "connection" | "objectSelection" | "objectFieldMap" | "jsonForm";
 /** 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<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

@@ -2,6 +2,7 @@ import { ConditionalExpression } from "./conditional-logic";
 export declare type ObjectSelection = {
     key: string;
     label?: string;
+    selected?: boolean;
     fields: {
         key: string;
         label?: string;
@@ -16,6 +17,10 @@ export declare type ObjectFieldMap = {
         fieldKey: string;
         fieldLabel?: string;
     };
+    defaultValue?: {
+        objectKey: string;
+        fieldKey: string;
+    };
 }[];
 export declare type JSONForm = {
     schema: Record<string, unknown>;
@@ -158,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. */
@@ -169,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. */
@@ -177,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/package.json

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