@prismatic-io/spectral 5.0.0-rc.3 → 5.0.0-rc.4

package/dist/testing.js

@@ -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/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.3",
+  "version": "5.0.0-rc.4",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"