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

package/dist/serverTypes/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="node" />
-import { DataSourceResultType, DataSourceResultFieldType } from "../types";
+import { DataSourceResultType, DataSourceResultFieldType, Instance, Customer } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
 }
+export { Instance } from "../types";
+export { Customer } from "../types";
 export interface Component {
     key: string;
     public?: boolean;
@@ -52,15 +54,8 @@ export interface ActionContext {
     webhookUrls: Record<string, string>;
     webhookApiKeys: Record<string, string[]>;
     invokeUrl: string;
-    customer: {
-        id: string | null;
-        externalId: string | null;
-        name: string | null;
-    };
-    instance: {
-        id: string | null;
-        name: string | null;
-    };
+    customer: Customer;
+    instance: Instance;
 }
 declare type TriggerOptionChoice = "invalid" | "valid" | "required";
 export interface TriggerPayload {
@@ -79,15 +74,8 @@ export interface TriggerPayload {
     webhookApiKeys: Record<string, string[]>;
     invokeUrl: string;
     executionId: string;
-    customer: {
-        id: string | null;
-        externalId: string | null;
-        name: string | null;
-    };
-    instance: {
-        id: string | null;
-        name: string | null;
-    };
+    customer: Customer;
+    instance: Instance;
 }
 interface HttpResponse {
     statusCode: number;
@@ -129,12 +117,12 @@ export interface Trigger {
 }
 export declare type DataSourceResult = {
     result: DataSourceResultType;
-    supplementalData: {
+    supplementalData?: {
         data: unknown;
         contentType: string;
     };
 };
-export declare type DataSourcePerformFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<DataSourceResult>;
+export declare type DataSourcePerformFunction = (params: Record<string, unknown>) => Promise<DataSourceResult>;
 export interface DataSource {
     key: string;
     display: DisplayDefinition & {
@@ -215,4 +203,3 @@ export interface Input {
     model?: InputFieldChoice[];
     language?: string;
 }
-export {};

package/dist/serverTypes/perform.js

@@ -22,6 +22,10 @@ const cleanParams = (params, cleaners) => Object.entries(params).reduce((result,
 const createPerform = (performFn, { inputCleaners, errorHandler }) => {
     return (...args) => __awaiter(void 0, void 0, void 0, function* () {
         try {
+            if (args.length === 1) {
+                const [params] = args;
+                return yield performFn(cleanParams(params, inputCleaners));
+            }
             if (args.length === 2) {
                 const [context, params] = args;
                 return yield performFn(context, cleanParams(params, inputCleaners));

package/dist/testing.d.ts

@@ -5,7 +5,7 @@
  * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
  */
 import { TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, ActionContext, ActionPerformReturn, DataSourceResult } from "./serverTypes";
-import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult } from "./types";
+import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult } from "./types";
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>) => ConnectionValue;
 /**
  * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected.
@@ -13,7 +13,7 @@ export declare const createConnection: <T extends ConnectionDefinition>({ key }:
  */
 export declare const loggerMock: () => ActionLogger;
 /**
- * The type of data returned by an `invoke()` function used for unit testing component actions.
+ * The type of data returned by an `invoke()` function used for unit testing component actions and triggers.
  */
 interface InvokeReturn<ReturnData> {
     result: ReturnData;
@@ -35,19 +35,18 @@ export declare const defaultTriggerPayload: () => TriggerPayload;
  */
 export declare const invokeTrigger: <TInputs extends Inputs, TAllowsBranching extends boolean, TResult extends InvokeTriggerResult<TAllowsBranching>>({ perform }: TriggerDefinition<TInputs, TAllowsBranching, TResult>, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<TInputs> | undefined) => Promise<InvokeReturn<TResult>>;
 /**
- * Invokes specified DataSourceDefinition perform function using supplied params
- * and optional context. Accepts a generic type matching DataSourceResult as a convenience
- * to avoid extra casting within test methods. Returns an InvokeResult containing both the
- * action result and a mock logger for asserting logging.
+ * Invokes specified DataSourceDefinition perform function using supplied params.
+ * Accepts a generic type matching DataSourceResult as a convenience to avoid extra
+ * casting within test methods. Returns a DataSourceResult.
  */
-export declare const invokeDataSource: <TInputs extends Inputs, TReturn extends InvokeDataSourceResult<unknown>>({ perform }: DataSourceDefinition<TInputs, TReturn>, params: ActionInputParameters<TInputs>, context?: Partial<ActionContext> | undefined) => Promise<InvokeReturn<TReturn>>;
+export declare const invokeDataSource: <TInputs extends Inputs, TReturn extends DataSourceResult>({ perform }: DataSourceDefinition<TInputs, TReturn>, params: ActionInputParameters<TInputs>) => Promise<TReturn>;
 export declare class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);
     connectionValue({ key }: ConnectionDefinition): ConnectionValue;
     trigger(key: string, payload?: TriggerPayload, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<TriggerResult>;
     action(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<ActionPerformReturn>;
-    dataSource(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext>): Promise<DataSourceResult>;
+    dataSource(key: string, params?: Record<string, unknown>): Promise<DataSourceResult>;
 }
 export declare const createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
 declare const _default: {
@@ -55,6 +54,6 @@ declare const _default: {
     invoke: <TInputs extends Inputs, TAllowsBranching extends boolean, TReturn extends InvokeActionPerformReturn<TAllowsBranching, unknown>>({ perform }: ActionDefinition<TInputs, TAllowsBranching, TReturn>, params: ActionInputParameters<TInputs>, context?: Partial<ActionContext> | undefined) => Promise<InvokeReturn<TReturn>>;
     invokeTrigger: <TInputs_1 extends Inputs, TAllowsBranching_1 extends boolean, TResult extends InvokeTriggerResult<TAllowsBranching_1>>({ perform }: TriggerDefinition<TInputs_1, TAllowsBranching_1, TResult>, context?: Partial<ActionContext> | undefined, payload?: TriggerPayload | undefined, params?: ActionInputParameters<TInputs_1> | undefined) => Promise<InvokeReturn<TResult>>;
     createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
-    invokeDataSource: <TInputs_2 extends Inputs, TReturn_1 extends InvokeDataSourceResult<unknown>>({ perform }: DataSourceDefinition<TInputs_2, TReturn_1>, params: ActionInputParameters<TInputs_2>, context?: Partial<ActionContext> | undefined) => Promise<InvokeReturn<TReturn_1>>;
+    invokeDataSource: <TInputs_2 extends Inputs, TReturn_1 extends DataSourceResult>({ perform }: DataSourceDefinition<TInputs_2, TReturn_1>, params: ActionInputParameters<TInputs_2>) => Promise<TReturn_1>;
 };
 export default _default;

package/dist/testing.js

@@ -131,18 +131,13 @@ const invokeTrigger = ({ perform }, context, payload, params) => __awaiter(void
 });
 exports.invokeTrigger = invokeTrigger;
 /**
- * Invokes specified DataSourceDefinition perform function using supplied params
- * and optional context. Accepts a generic type matching DataSourceResult as a convenience
- * to avoid extra casting within test methods. Returns an InvokeResult containing both the
- * action result and a mock logger for asserting logging.
+ * Invokes specified DataSourceDefinition perform function using supplied params.
+ * Accepts a generic type matching DataSourceResult as a convenience to avoid extra
+ * casting within test methods. Returns a DataSourceResult.
  */
-const invokeDataSource = ({ perform }, params, context) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign(Object.assign({}, baseContext), context);
-    const result = yield perform(realizedContext, params);
-    return {
-        result,
-        loggerMock: realizedContext.logger,
-    };
+const invokeDataSource = ({ perform }, params) => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield perform(params);
+    return result;
 });
 exports.invokeDataSource = invokeDataSource;
 class ComponentTestHarness {
@@ -171,11 +166,10 @@ class ComponentTestHarness {
             return action.perform(realizedContext, Object.assign({}, params));
         });
     }
-    dataSource(key, params, context) {
+    dataSource(key, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const realizedContext = Object.assign(Object.assign({}, baseContext), context);
             const dataSource = this.component.dataSources[key];
-            return dataSource.perform(realizedContext, Object.assign({}, params));
+            return dataSource.perform(Object.assign({}, params));
         });
     }
 }

package/dist/types/ActionPerformFunction.d.ts

@@ -1,4 +1,4 @@
-import { Inputs, ActionPerformReturn, ActionInputParameters, ActionLogger } from ".";
+import { Inputs, ActionPerformReturn, ActionInputParameters, ActionLogger, Instance, Customer } from ".";
 /** Definition of the function to perform when an Action is invoked. */
 export declare type ActionPerformFunction<TInputs extends Inputs, TAllowsBranching extends boolean | undefined, TReturn extends ActionPerformReturn<TAllowsBranching, unknown>> = (context: ActionContext, params: ActionInputParameters<TInputs>) => Promise<TReturn>;
 /** Context provided to perform method containing helpers and contextual data */
@@ -21,15 +21,8 @@ export interface ActionContext {
     webhookApiKeys: Record<string, string[]>;
     /** The URL used to invoke the current execution */
     invokeUrl: string;
-    /** An object containing the ID, External ID and name of the customer the instance is deployed to */
-    customer: {
-        id: string | null;
-        externalId: string | null;
-        name: string | null;
-    };
-    /** An object containing the ID ad name of the currently running instance */
-    instance: {
-        id: string | null;
-        name: string | null;
-    };
+    /** Contains attributes of the Customer for whom an Instance is being executed. */
+    customer: Customer;
+    /** Contains attributes of the Instance that is being executed. */
+    instance: Instance;
 }

package/dist/types/Customer.d.ts

@@ -0,0 +1,6 @@
+/** Contains attributes of the Customer for whom an Instance is being executed. */
+export interface Customer {
+    id: string;
+    externalId: string;
+    name: string;
+}

package/dist/types/Customer.js

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

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/DataSourcePerformFunction.d.ts

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

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>;

package/dist/types/Instance.d.ts

@@ -0,0 +1,5 @@
+/** Contains attributes of the Instance that is being executed. */
+export interface Instance {
+    id: string;
+    name: string;
+}

package/dist/types/Instance.js

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

package/dist/types/TriggerPayload.d.ts

@@ -1,3 +1,4 @@
+import { Instance, Customer } from ".";
 /** Represents a Trigger Payload, which is data passed into a Trigger to invoke an Integration execution. */
 export interface TriggerPayload {
     headers: {
@@ -27,13 +28,8 @@ export interface TriggerPayload {
     /** The URL that was used to invoke the execution. */
     invokeUrl: string;
     executionId: string;
-    customer: {
-        id: string | null;
-        externalId: string | null;
-        name: string | null;
-    };
-    instance: {
-        id: string | null;
-        name: string | null;
-    };
+    /** Contains attributes of the Customer for whom an Instance is being executed. */
+    customer: Customer;
+    /** Contains attributes of the Instance that is being executed. */
+    instance: Instance;
 }

package/dist/types/index.d.ts

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

package/dist/types/index.js

@@ -50,4 +50,6 @@ __exportStar(require("./TriggerPayload"), exports);
 __exportStar(require("./DataSourceDefinition"), exports);
 __exportStar(require("./DataSourcePerformFunction"), exports);
 __exportStar(require("./DataSourceResult"), exports);
+__exportStar(require("./Instance"), exports);
+__exportStar(require("./Customer"), exports);
 exports.serverTypes = __importStar(require("../serverTypes"));

package/package.json

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