@prismatic-io/spectral 7.8.0-preview4 → 7.8.0

package/dist/serverTypes/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Instance, Customer, DataSourceType, DataSourceResultType, User, TriggerEventFunctionReturn } from "../types";
+import { Instance, Customer, DataSourceType, DataSourceResultType, User, TriggerEventFunctionReturn, Integration, Flow } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
@@ -7,6 +7,8 @@ interface DisplayDefinition {
 export { Instance } from "../types";
 export { Customer } from "../types";
 export { User } from "../types";
+export { Integration } from "../types";
+export { Flow } from "../types";
 export interface Component {
     key: string;
     public?: boolean;
@@ -59,6 +61,8 @@ export interface ActionContext {
     customer: Customer;
     instance: Instance;
     user: User;
+    integration: Integration;
+    flow: Flow;
 }
 declare type TriggerOptionChoice = "invalid" | "valid" | "required";
 export interface TriggerPayload {
@@ -80,6 +84,8 @@ export interface TriggerPayload {
     customer: Customer;
     instance: Instance;
     user: User;
+    integration: Integration;
+    flow: Flow;
 }
 interface HttpResponse {
     statusCode: number;
@@ -102,7 +108,8 @@ interface TriggerBranchingResult extends TriggerBaseResult {
 }
 export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult | undefined;
 export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: Record<string, unknown>) => Promise<TriggerResult>;
-export declare type TriggerEventFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<void | TriggerEventFunctionReturn>;
+export declare type TriggerEventFunctionResult = TriggerEventFunctionReturn | void;
+export declare type TriggerEventFunction = (context: ActionContext, params: Record<string, unknown>) => Promise<TriggerEventFunctionResult>;
 export interface Trigger {
     key: string;
     display: DisplayDefinition & {

package/dist/testing.js

@@ -68,6 +68,15 @@ const baseActionContext = {
         name: "User 1",
         externalId: "1234",
     },
+    integration: {
+        id: "integrationId",
+        name: "Integration 1",
+        versionSequenceId: "1234",
+    },
+    flow: {
+        id: "flowId",
+        name: "Flow 1",
+    },
 };
 /**
  * Invokes specified ActionDefinition perform function using supplied params
@@ -124,6 +133,15 @@ const defaultTriggerPayload = () => {
             name: "User 1",
             externalId: "1234",
         },
+        integration: {
+            id: "integrationId",
+            name: "Integration 1",
+            versionSequenceId: "1234",
+        },
+        flow: {
+            id: "flowId",
+            name: "Flow 1",
+        },
     };
 };
 exports.defaultTriggerPayload = defaultTriggerPayload;

package/dist/types/ActionPerformFunction.d.ts

@@ -1,4 +1,4 @@
-import { Inputs, ActionPerformReturn, ActionInputParameters, ActionLogger, Instance, Customer, User } from ".";
+import { Inputs, ActionPerformReturn, ActionInputParameters, ActionLogger, Instance, Customer, User, Integration, Flow } 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 */
@@ -29,4 +29,8 @@ export interface ActionContext {
     instance: Instance;
     /** Contains attributes of the User for whom a User Level Configuration is being used. */
     user: User;
+    /** Contains attributes of the Integration that is being executed. */
+    integration: Integration;
+    /** Contains attributes of the Flow that is being executed. */
+    flow: Flow;
 }

package/dist/types/Flow.d.ts

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

package/dist/types/Flow.js

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

package/dist/types/Integration.d.ts

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

package/dist/types/Integration.js

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

package/dist/types/TriggerPayload.d.ts

@@ -1,4 +1,4 @@
-import { Instance, Customer, User } from ".";
+import { Instance, Customer, User, Integration, Flow } from ".";
 /** Represents a Trigger Payload, which is data passed into a Trigger to invoke an Integration execution. */
 export interface TriggerPayload {
     headers: {
@@ -34,4 +34,8 @@ export interface TriggerPayload {
     instance: Instance;
     /** Contains attributes of the User for whom a User Level Configuration is being used. */
     user: User;
+    /** Contains attributes of the Integration that is being executed. */
+    integration: Integration;
+    /** Contains attributes of the Flow that is being executed. */
+    flow: Flow;
 }

package/dist/types/index.d.ts

@@ -25,4 +25,6 @@ export * from "./DataSourceResult";
 export * from "./Instance";
 export * from "./Customer";
 export * from "./User";
+export * from "./Integration";
+export * from "./Flow";
 export * as serverTypes from "../serverTypes";

package/dist/types/index.js

@@ -54,4 +54,6 @@ __exportStar(require("./DataSourceResult"), exports);
 __exportStar(require("./Instance"), exports);
 __exportStar(require("./Customer"), exports);
 __exportStar(require("./User"), exports);
+__exportStar(require("./Integration"), exports);
+__exportStar(require("./Flow"), exports);
 exports.serverTypes = __importStar(require("../serverTypes"));

package/package.json

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