@prismatic-io/spectral 7.3.8 → 7.4.0

package/dist/serverTypes/index.d.ts

@@ -1,11 +1,12 @@
 /// <reference types="node" />
-import { Instance, Customer, DataSourceType, DataSourceResultType } from "../types";
+import { Instance, Customer, DataSourceType, DataSourceResultType, User } from "../types";
 interface DisplayDefinition {
     label: string;
     description: string;
 }
 export { Instance } from "../types";
 export { Customer } from "../types";
+export { User } from "../types";
 export interface Component {
     key: string;
     public?: boolean;
@@ -57,6 +58,7 @@ export interface ActionContext {
     invokeUrl: string;
     customer: Customer;
     instance: Instance;
+    user: User;
 }
 declare type TriggerOptionChoice = "invalid" | "valid" | "required";
 export interface TriggerPayload {
@@ -77,6 +79,7 @@ export interface TriggerPayload {
     executionId: string;
     customer: Customer;
     instance: Instance;
+    user: User;
 }
 interface HttpResponse {
     statusCode: number;

package/dist/testing.d.ts

@@ -6,7 +6,7 @@
  */
 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;
+export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>, tokenValues?: Record<string, unknown> | undefined) => ConnectionValue;
 /**
  * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected.
  * See https://prismatic.io/docs/custom-components/writing-custom-components/#verifying-correct-logging-in-action-tests for information on testing correct logging behavior in your custom component.

package/dist/testing.js

@@ -17,10 +17,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createHarness = exports.ComponentTestHarness = exports.invokeDataSource = exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
-const createConnection = ({ key }, values) => ({
+const createConnection = ({ key }, values, tokenValues) => ({
     configVarKey: "",
     key,
     fields: values,
+    token: tokenValues,
 });
 exports.createConnection = createConnection;
 /**
@@ -61,6 +62,12 @@ const baseActionContext = {
         id: "instanceId",
         name: "Instance 1",
     },
+    user: {
+        id: "userId",
+        email: "user@example.com",
+        name: "User 1",
+        externalId: "1234",
+    },
 };
 /**
  * Invokes specified ActionDefinition perform function using supplied params
@@ -111,6 +118,12 @@ const defaultTriggerPayload = () => {
             id: "instanceId",
             name: "Instance 1",
         },
+        user: {
+            id: "userId",
+            email: "user@example.com",
+            name: "User 1",
+            externalId: "1234",
+        },
     };
 };
 exports.defaultTriggerPayload = defaultTriggerPayload;

package/dist/types/ActionPerformFunction.d.ts

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

package/dist/types/TriggerPayload.d.ts

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

package/dist/types/User.d.ts

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

package/dist/types/User.js

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

package/dist/types/index.d.ts

@@ -23,4 +23,5 @@ export * from "./DataSourcePerformFunction";
 export * from "./DataSourceResult";
 export * from "./Instance";
 export * from "./Customer";
+export * from "./User";
 export * as serverTypes from "../serverTypes";

package/dist/types/index.js

@@ -52,4 +52,5 @@ __exportStar(require("./DataSourcePerformFunction"), exports);
 __exportStar(require("./DataSourceResult"), exports);
 __exportStar(require("./Instance"), exports);
 __exportStar(require("./Customer"), exports);
+__exportStar(require("./User"), exports);
 exports.serverTypes = __importStar(require("../serverTypes"));

package/package.json

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