@prismatic-io/spectral 7.0.13-pre → 7.0.14-pre

package/dist/serverTypes/index.d.ts

@@ -115,6 +115,11 @@ export interface Trigger {
     examplePayload?: unknown;
     isCommonTrigger?: boolean;
 }
+export interface DataSourceContext {
+    logger: ActionLogger;
+    customer: Customer;
+    instance: Instance;
+}
 export declare type DataSourceResult = {
     result: DataSourceResultType;
     supplementalData?: {
@@ -122,7 +127,7 @@ export declare type DataSourceResult = {
         contentType: string;
     };
 };
-export declare type DataSourcePerformFunction = (params: Record<string, unknown>) => Promise<DataSourceResult>;
+export declare type DataSourcePerformFunction = (context: DataSourceContext, params: Record<string, unknown>) => Promise<DataSourceResult>;
 export interface DataSource {
     key: string;
     display: DisplayDefinition & {

package/dist/testing.d.ts

@@ -4,7 +4,7 @@
  * information on unit testing, check out our docs:
  * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
  */
-import { TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, ActionContext, ActionPerformReturn, DataSourceResult } from "./serverTypes";
+import { TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, ActionContext, ActionPerformReturn, DataSourceResult, DataSourceContext } from "./serverTypes";
 import { ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceResult as InvokeDataSourceResult } from "./types";
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>) => ConnectionValue;
 /**
@@ -55,7 +55,7 @@ export declare const invokeDataSource: <TInputs extends Inputs, TDataSourceType
     objectSelection: import("./types").ObjectSelection;
     objectFieldMap: import("./types").ObjectFieldMap;
     jsonForm: import("./types").JSONForm;
-}>({ perform }: DataSourceDefinition<TInputs, TDataSourceType>, params: ActionInputParameters<TInputs>) => Promise<InvokeDataSourceResult<TDataSourceType>>;
+}>({ perform }: DataSourceDefinition<TInputs, TDataSourceType>, params: ActionInputParameters<TInputs>, context?: Partial<DataSourceContext> | undefined) => Promise<InvokeDataSourceResult<TDataSourceType>>;
 export declare class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);
@@ -64,7 +64,7 @@ export declare class ComponentTestHarness<TComponent extends Component> {
     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>): Promise<DataSourceResult>;
+    dataSource(key: string, params?: Record<string, unknown>, context?: Partial<DataSourceContext>): Promise<DataSourceResult>;
 }
 export declare const createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
 declare const _default: {
@@ -88,6 +88,6 @@ declare const _default: {
         objectSelection: import("./types").ObjectSelection;
         objectFieldMap: import("./types").ObjectFieldMap;
         jsonForm: import("./types").JSONForm;
-    }>({ perform }: DataSourceDefinition<TInputs_2, TDataSourceType>, params: ActionInputParameters<TInputs_2>) => Promise<InvokeDataSourceResult<TDataSourceType>>;
+    }>({ perform }: DataSourceDefinition<TInputs_2, TDataSourceType>, params: ActionInputParameters<TInputs_2>, context?: Partial<DataSourceContext> | undefined) => Promise<InvokeDataSourceResult<TDataSourceType>>;
 };
 export default _default;

package/dist/testing.js

@@ -37,7 +37,7 @@ const loggerMock = () => ({
     error: (0, jest_mock_1.spyOn)(console, "error"),
 });
 exports.loggerMock = loggerMock;
-const baseContext = {
+const baseActionContext = {
     logger: (0, exports.loggerMock)(),
     instanceState: {},
     crossFlowState: {},
@@ -68,7 +68,7 @@ const baseContext = {
  * action result and a mock logger for asserting logging.
  */
 const invoke = ({ perform }, params, context) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign(Object.assign({}, baseContext), context);
+    const realizedContext = Object.assign(Object.assign({}, baseActionContext), context);
     const result = yield perform(realizedContext, params);
     return {
         result,
@@ -120,7 +120,7 @@ exports.defaultTriggerPayload = defaultTriggerPayload;
  * trigger result and a mock logger for asserting logging.
  */
 const invokeTrigger = ({ perform }, context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
-    const realizedContext = Object.assign(Object.assign({}, baseContext), context);
+    const realizedContext = Object.assign(Object.assign({}, baseActionContext), context);
     const realizedPayload = Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload);
     const realizedParams = params || {};
     const result = yield perform(realizedContext, realizedPayload, realizedParams);
@@ -130,13 +130,26 @@ const invokeTrigger = ({ perform }, context, payload, params) => __awaiter(void
     };
 });
 exports.invokeTrigger = invokeTrigger;
+const baseDataSourceContext = {
+    logger: (0, exports.loggerMock)(),
+    customer: {
+        id: "customerId",
+        name: "Customer 1",
+        externalId: "1234",
+    },
+    instance: {
+        id: "instanceId",
+        name: "Instance 1",
+    },
+};
 /**
  * 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) => __awaiter(void 0, void 0, void 0, function* () {
-    const result = yield perform(params);
+const invokeDataSource = ({ perform }, params, context) => __awaiter(void 0, void 0, void 0, function* () {
+    const realizedContext = Object.assign(Object.assign({}, baseDataSourceContext), context);
+    const result = yield perform(realizedContext, params);
     return result;
 });
 exports.invokeDataSource = invokeDataSource;
@@ -144,7 +157,7 @@ class ComponentTestHarness {
     constructor(component) {
         this.component = component;
     }
-    buildContext(context) {
+    buildContext(baseContext, context) {
         return Object.assign(Object.assign({}, baseContext), context);
     }
     buildParams(inputs, params) {
@@ -162,19 +175,19 @@ class ComponentTestHarness {
     trigger(key, payload, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const trigger = this.component.triggers[key];
-            return trigger.perform(this.buildContext(context), Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload), this.buildParams(trigger.inputs, params));
+            return trigger.perform(this.buildContext(baseActionContext, context), Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload), this.buildParams(trigger.inputs, params));
         });
     }
     action(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const action = this.component.actions[key];
-            return action.perform(this.buildContext(context), this.buildParams(action.inputs, params));
+            return action.perform(this.buildContext(baseActionContext, context), this.buildParams(action.inputs, params));
         });
     }
-    dataSource(key, params) {
+    dataSource(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const dataSource = this.component.dataSources[key];
-            return dataSource.perform(this.buildParams(dataSource.inputs, params));
+            return dataSource.perform(this.buildContext(baseDataSourceContext, context), this.buildParams(dataSource.inputs, params));
         });
     }
 }

package/dist/types/DataSourcePerformFunction.d.ts

@@ -1,3 +1,9 @@
-import { Inputs, DataSourceResult, DataSourceType, ActionInputParameters } from ".";
+import { Inputs, DataSourceResult, DataSourceType, ActionInputParameters, ActionLogger, Customer, Instance } from ".";
+/** Context provided to perform method containing helpers and contextual data */
+export interface DataSourceContext {
+    logger: ActionLogger;
+    customer: Customer;
+    instance: Instance;
+}
 /** Definition of the function to perform when a Data Source is invoked. */
-export declare type DataSourcePerformFunction<TInputs extends Inputs, TDataSourceType extends DataSourceType> = (params: ActionInputParameters<TInputs>) => Promise<DataSourceResult<TDataSourceType>>;
+export declare type DataSourcePerformFunction<TInputs extends Inputs, TDataSourceType extends DataSourceType> = (context: DataSourceContext, params: ActionInputParameters<TInputs>) => Promise<DataSourceResult<TDataSourceType>>;

package/package.json

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