@prismatic-io/spectral 7.0.0-pre → 7.0.1-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 } 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;
 /** 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,22 @@
 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;
+    };
+}[];
 /** InputField type enumeration. */
 export declare type InputFieldType = InputFieldDefinition["type"];
 export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;

package/dist/types/index.d.ts

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

package/dist/types/index.js

@@ -37,4 +37,3 @@ __exportStar(require("./TriggerPayload"), exports);
 __exportStar(require("./DataSourceDefinition"), exports);
 __exportStar(require("./DataSourcePerformFunction"), exports);
 __exportStar(require("./DataSourceResult"), exports);
-__exportStar(require("./DataSourceType"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.0.0-pre",
+  "version": "7.0.1-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 });