@prismatic-io/spectral 7.8.4 → 8.0.0-preview10

package/dist/types/TriggerDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ActionDisplayDefinition, TriggerPerformFunction, TriggerEventFunction, Inputs, TriggerResult } from ".";
+import { ActionDisplayDefinition, TriggerPerformFunction, TriggerEventFunction, Inputs, TriggerResult, ConfigVarResultCollection, TriggerPayload } from ".";
 declare const optionChoices: readonly ["invalid", "valid", "required"];
 export declare type TriggerOptionChoice = typeof optionChoices[number];
 export declare const TriggerOptionChoices: TriggerOptionChoice[];
@@ -6,15 +6,15 @@ export declare const TriggerOptionChoices: TriggerOptionChoice[];
  * TriggerDefinition is the type of the object that is passed in to `trigger` function to
  * define a component trigger.
  */
-export interface TriggerDefinition<TInputs extends Inputs, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching>> {
+export interface TriggerDefinition<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> {
     /** Defines how the Trigger is displayed in the Prismatic interface. */
     display: ActionDisplayDefinition;
     /** Function to perform when this Trigger is invoked. */
-    perform: TriggerPerformFunction<TInputs, TAllowsBranching, TResult>;
+    perform: TriggerPerformFunction<TInputs, TConfigVars, false, TAllowsBranching, TResult>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
-    onInstanceDeploy?: TriggerEventFunction<TInputs>;
+    onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars, false>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
-    onInstanceDelete?: TriggerEventFunction<TInputs>;
+    onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars, false>;
     /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
     inputs: TInputs;
     /** Specifies whether this Trigger supports executing the Integration on a recurring schedule. */

package/dist/types/TriggerEventFunction.d.ts

@@ -1,4 +1,4 @@
-import { Inputs, ActionContext, ActionInputParameters } from ".";
+import { Inputs, ActionContext, ActionInputParameters, ConfigVarResultCollection } from ".";
 export declare type TriggerEventFunctionReturn = {
     /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
     instanceState?: Record<string, unknown>;
@@ -10,4 +10,4 @@ export declare type TriggerEventFunctionReturn = {
     integrationState?: Record<string, unknown>;
 };
 /** Definition of the function to execute when a Trigger Event occurs. */
-export declare type TriggerEventFunction<TInputs extends Inputs> = (context: ActionContext, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;
+export declare type TriggerEventFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, THasConfigVars extends boolean> = (context: ActionContext<TConfigVars, THasConfigVars>, params: ActionInputParameters<TInputs>) => Promise<void | TriggerEventFunctionReturn>;

package/dist/types/TriggerPayload.d.ts

@@ -1,4 +1,4 @@
-import { Instance, Customer, User, Integration, Flow } from ".";
+import { InstanceAttributes, CustomerAttributes, UserAttributes, IntegrationAttributes, FlowAttributes } from ".";
 /** Represents a Trigger Payload, which is data passed into a Trigger to invoke an Integration execution. */
 export interface TriggerPayload {
     headers: {
@@ -29,15 +29,15 @@ export interface TriggerPayload {
     invokeUrl: string;
     executionId: string;
     /** Contains attributes of the Customer for whom an Instance is being executed. */
-    customer: Customer;
+    customer: CustomerAttributes;
     /** Contains attributes of the Instance that is being executed. */
-    instance: Instance;
+    instance: InstanceAttributes;
     /** Contains attributes of the User for whom a User Level Configuration is being used. */
-    user: User;
+    user: UserAttributes;
     /** Contains attributes of the Integration that is being executed. */
-    integration: Integration;
+    integration: IntegrationAttributes;
     /** Contains attributes of the Flow that is being executed. */
-    flow: Flow;
+    flow: FlowAttributes;
     /** The time in UTC that execution started. */
     startedAt: string;
 }

package/dist/types/TriggerPerformFunction.d.ts

@@ -1,3 +1,3 @@
-import { Inputs, TriggerResult, ActionInputParameters, ActionContext, TriggerPayload } from ".";
+import { Inputs, TriggerResult, ActionInputParameters, ActionContext, TriggerPayload, ConfigVarResultCollection } from ".";
 /** Definition of the function to perform when a Trigger is invoked. */
-export declare type TriggerPerformFunction<T extends Inputs, TAllowsBranching extends boolean | undefined, TResult extends TriggerResult<TAllowsBranching>> = (context: ActionContext, payload: TriggerPayload, params: ActionInputParameters<T>) => Promise<TResult>;
+export declare type TriggerPerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, THasConfigVars extends boolean, TAllowsBranching extends boolean | undefined, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>> = (context: ActionContext<TConfigVars, THasConfigVars>, payload: TriggerPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;

package/dist/types/TriggerResult.d.ts

@@ -1,9 +1,9 @@
 import { TriggerPayload } from "./TriggerPayload";
 import { HttpResponse } from "./HttpResponse";
 /** Represents the result of a Trigger action. */
-export interface TriggerBaseResult {
+export interface TriggerBaseResult<TPayload extends TriggerPayload> {
     /** The payload in the request that invoked the Integration, which is returned as a result for later use. */
-    payload: TriggerPayload;
+    payload: TPayload;
     /** Optional HTTP response to the request that invoked the integration. */
     response?: HttpResponse;
     /** An optional object, the keys and values of which will be persisted in the flow-specific instanceState and available for subsequent actions and executions */
@@ -20,9 +20,9 @@ export interface TriggerBaseResult {
     error?: Record<string, unknown>;
 }
 /** Represents the result of a Trigger action that uses branching. */
-export interface TriggerBranchingResult extends TriggerBaseResult {
+export interface TriggerBranchingResult<TPayload extends TriggerPayload> extends TriggerBaseResult<TPayload> {
     /** Name of the Branch to take. */
     branch: string;
 }
 /** Required return type of all trigger perform functions */
-export declare type TriggerResult<AllowsBranching extends boolean | undefined> = (AllowsBranching extends true ? TriggerBranchingResult : TriggerBaseResult) | undefined;
+export declare type TriggerResult<AllowsBranching extends boolean | undefined, TPayload extends TriggerPayload> = (AllowsBranching extends true ? TriggerBranchingResult<TPayload> : TriggerBaseResult<TPayload>) | undefined;

package/dist/types/{User.d.ts → UserAttributes.d.ts}

@@ -1,5 +1,5 @@
 /** Contains attributes of the User for whom a User Level Configuration is being used. */
-export interface User {
+export interface UserAttributes {
     id: string;
     email: string;
     name: string;

package/dist/types/index.d.ts

@@ -22,9 +22,10 @@ export * from "./TriggerPayload";
 export * from "./DataSourceDefinition";
 export * from "./DataSourcePerformFunction";
 export * from "./DataSourceResult";
-export * from "./Instance";
-export * from "./Customer";
-export * from "./User";
-export * from "./Integration";
-export * from "./Flow";
+export * from "./InstanceAttributes";
+export * from "./CustomerAttributes";
+export * from "./UserAttributes";
+export * from "./IntegrationAttributes";
+export * from "./FlowAttributes";
+export * from "./IntegrationDefinition";
 export * as serverTypes from "../serverTypes";

package/dist/types/index.js

@@ -51,9 +51,10 @@ __exportStar(require("./TriggerPayload"), exports);
 __exportStar(require("./DataSourceDefinition"), exports);
 __exportStar(require("./DataSourcePerformFunction"), exports);
 __exportStar(require("./DataSourceResult"), exports);
-__exportStar(require("./Instance"), exports);
-__exportStar(require("./Customer"), exports);
-__exportStar(require("./User"), exports);
-__exportStar(require("./Integration"), exports);
-__exportStar(require("./Flow"), exports);
+__exportStar(require("./InstanceAttributes"), exports);
+__exportStar(require("./CustomerAttributes"), exports);
+__exportStar(require("./UserAttributes"), exports);
+__exportStar(require("./IntegrationAttributes"), exports);
+__exportStar(require("./FlowAttributes"), exports);
+__exportStar(require("./IntegrationDefinition"), exports);
 exports.serverTypes = __importStar(require("../serverTypes"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "7.8.4",
+  "version": "8.0.0-preview10",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -48,7 +48,8 @@
     "soap": "1.0.0",
     "url-join": "5.0.0",
     "uuid": "8.3.2",
-    "valid-url": "1.0.9"
+    "valid-url": "1.0.9",
+    "yaml": "2.3.4"
   },
   "devDependencies": {
     "@types/jest": "27.4.1",