@prismatic-io/spectral 5.0.0-rc.1 → 5.0.0

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  * Both component author-facing types and server types that
  * the Prismatic API expects are imported here.
  */
-import { ActionDefinition, InputFieldDefinition, ActionPerformReturn, ComponentDefinition, ConnectionDefinition, Inputs, TriggerDefinition, TriggerResult } from "./types";
+import { ActionDefinition, InputFieldDefinition, ActionPerformReturn, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, TriggerResult } from "./types";
 import { Component } from "./types/server-types";
 /**
  * This function creates a component object that can be
@@ -49,10 +49,17 @@ export declare const input: <T extends InputFieldDefinition>(definition: T) => T
 /**
  * For information on writing custom component connections, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
- * @param definition A ConnectionfieldDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
+ * @param definition A DefaultConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
  * @returns This functions validates the shape of the `definition` object provided and returns the same connection object.
  */
-export declare const connection: <T extends ConnectionDefinition>(definition: T) => T;
+export declare const connection: <T extends DefaultConnectionDefinition>(definition: T) => T;
+/**
+ * For information on writing custom component connections, see
+ * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * @param definition An OAuth2ConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
+ * @returns This functions validates the shape of the `definition` object provided and returns the same connection object.
+ */
+export declare const oauth2Connection: <T extends OAuth2ConnectionDefinition>(definition: T) => T;
 export { default as util } from "./util";
 export * from "./types";
 export { default as testing } from "./testing";

package/dist/index.js

@@ -18,7 +18,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testing = exports.util = exports.connection = exports.input = exports.trigger = exports.action = exports.component = void 0;
+exports.testing = exports.util = exports.oauth2Connection = exports.connection = exports.input = exports.trigger = exports.action = exports.component = void 0;
 const convertInput = (key, input) => (Object.assign(Object.assign({}, input), { key }));
 /**
  * This is a helper function for component() to convert an
@@ -98,11 +98,19 @@ exports.input = input;
 /**
  * For information on writing custom component connections, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
- * @param definition A ConnectionfieldDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
+ * @param definition A DefaultConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
  * @returns This functions validates the shape of the `definition` object provided and returns the same connection object.
  */
 const connection = (definition) => definition;
 exports.connection = connection;
+/**
+ * For information on writing custom component connections, see
+ * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * @param definition An OAuth2ConnectionDefinition object that describes the type of a connection for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
+ * @returns This functions validates the shape of the `definition` object provided and returns the same connection object.
+ */
+const oauth2Connection = (definition) => definition;
+exports.oauth2Connection = oauth2Connection;
 var util_1 = require("./util");
 Object.defineProperty(exports, "util", { enumerable: true, get: function () { return __importDefault(util_1).default; } });
 __exportStar(require("./types"), exports);

package/dist/testing.js

@@ -18,7 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
 const createConnection = ({ key }, values) => ({
-    instanceConfigVarId: "",
+    configVarKey: "",
     key,
     fields: values,
 });
@@ -28,6 +28,8 @@ exports.createConnection = createConnection;
  * 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.
  */
 const loggerMock = () => ({
+    metric: console.log,
+    trace: jest_mock_1.spyOn(console, "trace"),
     debug: jest_mock_1.spyOn(console, "debug"),
     info: jest_mock_1.spyOn(console, "info"),
     log: jest_mock_1.spyOn(console, "log"),
@@ -43,7 +45,7 @@ exports.loggerMock = loggerMock;
  */
 const invoke = (actionBase, params, context) => __awaiter(void 0, void 0, void 0, function* () {
     const action = (actionBase.perform ? actionBase : Object.values(actionBase)[0]);
-    const realizedContext = Object.assign({ logger: exports.loggerMock(), instanceState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+    const realizedContext = Object.assign({ logger: exports.loggerMock(), instanceState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
     const result = yield action.perform(realizedContext, params);
     return {
         result,
@@ -88,7 +90,7 @@ exports.defaultTriggerPayload = defaultTriggerPayload;
  */
 const invokeTrigger = (triggerBase, context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
     const trigger = (triggerBase.perform ? triggerBase : Object.values(triggerBase)[0]);
-    const realizedContext = Object.assign({ logger: exports.loggerMock(), instanceState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
+    const realizedContext = Object.assign({ logger: exports.loggerMock(), instanceState: {}, executionState: {}, stepId: "mockStepId", executionId: "mockExecutionId" }, context);
     const realizedPayload = Object.assign(Object.assign({}, exports.defaultTriggerPayload()), payload);
     const realizedParams = params || {};
     const result = yield trigger.perform(realizedContext, realizedPayload, realizedParams);

package/dist/types/ActionDefinition.d.ts

@@ -12,6 +12,8 @@ export interface ActionDefinition<T extends Inputs, AllowsBranching extends bool
     inputs: T;
     /** Optional attribute that specifies whether an Action will terminate execution.*/
     terminateExecution?: boolean;
+    /** Specifies whether an Action will break out of a loop. */
+    breakLoop?: boolean;
     /** Determines whether an Action will allow Conditional Branching.*/
     allowsBranching?: AllowsBranching;
     /** Static Branch names associated with an Action. */

package/dist/types/ActionLogger.d.ts

@@ -12,6 +12,8 @@ export declare type ActionLoggerFunction = (...args: unknown[]) => void;
  * An object containing logger functions.
  */
 export interface ActionLogger {
+    metric: ActionLoggerFunction;
+    trace: ActionLoggerFunction;
     debug: ActionLoggerFunction;
     info: ActionLoggerFunction;
     log: ActionLoggerFunction;

package/dist/types/ActionPerformFunction.d.ts

@@ -7,6 +7,8 @@ export interface ActionContext {
     logger: ActionLogger;
     /** A key/value store that may be used to store small amounts of data that is persisted between Instance executions */
     instanceState: Record<string, unknown>;
+    /** A key/value store that may be used to store small amounts of data for use later during the execution */
+    executionState: Record<string, unknown>;
     /** A unique id that corresponds to the step on the Integration */
     stepId: string;
     /** A unique id that corresponds to the specific execution of the Integration */

package/dist/types/ActionPerformReturn.d.ts

@@ -7,7 +7,9 @@ export interface ActionPerformDataReturn<ReturnData> {
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    executionState?: Record<string, unknown>;
 }
 /** Used to represent a branching return of conventional data and does not require content type to be specified */
 /** Used to represent a binary or serialized data branching return as content type must be specified */

package/dist/types/ConnectionDefinition.d.ts

@@ -1,9 +1,41 @@
-import { ConnectionInputs, OAuth2Type } from ".";
-export interface ConnectionDefinition {
+import { ConnectionInput } from ".";
+export declare enum OAuth2Type {
+    ClientCredentials = "client_credentials",
+    AuthorizationCode = "authorization_code"
+}
+interface BaseConnectionDefinition {
     key: string;
     label: string;
     comments?: string;
-    oauth2Type?: OAuth2Type;
     iconPath?: string;
-    inputs: ConnectionInputs;
+    oauth2Type?: OAuth2Type;
+}
+export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
+    inputs: {
+        [key: string]: ConnectionInput;
+    };
+}
+interface OAuth2AuthorizationCodeConnectionDefinition extends BaseConnectionDefinition {
+    oauth2Type: OAuth2Type.AuthorizationCode;
+    inputs: {
+        authorizeUrl: ConnectionInput;
+        tokenUrl: ConnectionInput;
+        scopes: ConnectionInput;
+        clientId: ConnectionInput;
+        clientSecret: ConnectionInput;
+        [key: string]: ConnectionInput;
+    };
+}
+interface OAuth2ClientCredentialConnectionDefinition extends BaseConnectionDefinition {
+    oauth2Type: OAuth2Type.ClientCredentials;
+    inputs: {
+        tokenUrl: ConnectionInput;
+        scopes: ConnectionInput;
+        clientId: ConnectionInput;
+        clientSecret: ConnectionInput;
+        [key: string]: ConnectionInput;
+    };
 }
+export declare type OAuth2ConnectionDefinition = OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition;
+export declare type ConnectionDefinition = DefaultConnectionDefinition | OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition;
+export {};

package/dist/types/ConnectionDefinition.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAuth2Type = void 0;
+var OAuth2Type;
+(function (OAuth2Type) {
+    OAuth2Type["ClientCredentials"] = "client_credentials";
+    OAuth2Type["AuthorizationCode"] = "authorization_code";
+})(OAuth2Type = exports.OAuth2Type || (exports.OAuth2Type = {}));

package/dist/types/DisplayDefinition.d.ts

@@ -9,8 +9,8 @@ interface DisplayDefinition {
     description: string;
 }
 interface ExtraDisplayDefinitionFields {
-    /** Path to icon to use for this Component. Path should be relative to component roto index. */
-    iconPath?: string;
+    /** Path to icon to use for this Component. Path should be relative to the built component source. */
+    iconPath: string;
     /** Category of the Component. */
     category?: string;
 }

package/dist/types/Inputs.d.ts

@@ -1,8 +1,8 @@
 import { InputFieldType } from ".";
 export declare type Inputs = Record<string, InputFieldDefinition>;
-export declare type ConnectionInputs = Record<string, DefaultInputFieldDefinition & {
+export declare type ConnectionInput = DefaultInputFieldDefinition & {
     shown?: boolean;
-}>;
+};
 export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition;
 interface BaseInputFieldDefinition {
     /** Interface label of the InputField. */
@@ -31,15 +31,11 @@ export interface CodeInputFieldDefinition extends BaseInputFieldDefinition {
     type: Extract<InputFieldType, "code">;
     language?: string;
 }
-export declare enum OAuth2Type {
-    ClientCredentials = "client_credentials",
-    AuthorizationCode = "authorization_code"
-}
 export interface Connection {
     /** Key of the Connection type. */
     key: string;
-    /** Identifier for the Config Variable hosting this Connection. */
-    instanceConfigVarId: string;
+    /** Key for the Config Variable hosting this Connection. */
+    configVarKey: string;
     /** Field values supplied to this Connection. */
     fields: {
         [key: string]: unknown;

package/dist/types/Inputs.js

@@ -1,8 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OAuth2Type = void 0;
-var OAuth2Type;
-(function (OAuth2Type) {
-    OAuth2Type["ClientCredentials"] = "client_credentials";
-    OAuth2Type["AuthorizationCode"] = "authorization_code";
-})(OAuth2Type = exports.OAuth2Type || (exports.OAuth2Type = {}));

package/dist/types/TriggerDefinition.d.ts

@@ -19,6 +19,8 @@ export interface TriggerDefinition<T extends Inputs, AllowsBranching extends boo
     synchronousResponseSupport: TriggerOptionChoice;
     /** Optional attribute that specifies whether this Trigger will terminate execution. */
     terminateExecution?: boolean;
+    /** Specifies whether an Action will break out of a loop. */
+    breakLoop?: boolean;
     /** Determines whether this Trigger allows Conditional Branching. */
     allowsBranching?: AllowsBranching;
     /** Static Branch names associated with this Trigger. */

package/dist/types/TriggerResult.d.ts

@@ -7,7 +7,9 @@ export interface TriggerBaseResult {
     /** 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 instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    executionState?: Record<string, unknown>;
 }
 /** Represents the result of a Trigger action that uses branching. */
 export interface TriggerBranchingResult extends TriggerBaseResult {

package/dist/types/server-types.d.ts

@@ -45,6 +45,8 @@ interface BaseAction {
     inputs: InputField[];
     /** Optional attribute that specifies whether an Action will terminate execution. */
     terminateExecution?: boolean;
+    /** Specifies whether an Action will break out of a loop. */
+    breakLoop?: boolean;
     /** Determines whether an Action will allow Conditional Branching. */
     allowsBranching?: boolean;
     /** Static Branch names associated with an Action. */
@@ -95,7 +97,9 @@ export interface ServerPerformDataStructureReturn {
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    executionState?: Record<string, unknown>;
 }
 /** Used to represent a binary or serialized data return as content type must be specified */
 interface ServerPerformDataReturn {
@@ -106,7 +110,9 @@ interface ServerPerformDataReturn {
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
     /** An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions */
-    state?: Record<string, unknown>;
+    instanceState?: Record<string, unknown>;
+    /** An optional object, the keys and values of which will be persisted in the executionState and available for the duration of the execution */
+    executionState?: Record<string, unknown>;
 }
 /** Used to represent a branching return of conventional data and does not require content type to be specified */
 export interface ServerPerformBranchingDataStructureReturn extends ServerPerformDataStructureReturn {

package/package.json

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