@prismatic-io/spectral 10.2.0 → 10.2.1

package/dist/index.d.ts

@@ -100,7 +100,7 @@ export declare const trigger: <TInputs extends Inputs, TConfigVars extends Confi
  * @param definition A PollingTriggerDefinition is similar to a TriggerDefinition, except it requires a pollAction instead of a perform. The pollAction, which can be any action defined in the component, will be polled on the defined schedule.
  * @returns This function validates the shape of the `definition` object provided, and returns the same polling trigger object.
  */
-export declare const pollingTrigger: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TPayload extends TriggerPayload, TResult extends TriggerResult<boolean, TPayload>, TActionInputs extends Inputs>(definition: PollingTriggerDefinition<TInputs, TConfigVars, TPayload, TResult, TActionInputs>) => PollingTriggerDefinition<TInputs, TConfigVars, TPayload, TResult, TActionInputs>;
+export declare const pollingTrigger: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TPayload extends TriggerPayload, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching, TPayload>, TActionInputs extends Inputs>(definition: PollingTriggerDefinition<TInputs, TConfigVars, TPayload, TAllowsBranching, TResult, TActionInputs>) => PollingTriggerDefinition<TInputs, TConfigVars, TPayload, TAllowsBranching, TResult, TActionInputs>;
 /**
  * This function creates a data source object that can be referenced
  * by a custom component. It helps ensure that the shape of the

package/dist/serverTypes/perform.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -87,8 +98,8 @@ const createPollingPerform = (trigger, { inputCleaners, errorHandler }) => {
                 errorHandler,
             });
             const combinedContext = Object.assign({}, context, pollingContext);
-            const triggerResponse = yield triggerPerform(combinedContext, payload, params);
-            return triggerResponse;
+            const _a = yield triggerPerform(combinedContext, payload, params), { polledNoChanges } = _a, rest = __rest(_a, ["polledNoChanges"]);
+            return Object.assign(Object.assign({}, rest), { resultType: polledNoChanges ? "polled_no_changes" : "completed" });
         }
         catch (error) {
             throw errorHandler ? errorHandler(error) : error;

package/dist/types/PollingTriggerDefinition.d.ts

@@ -1,31 +1,35 @@
 import type { AxiosRequestConfig, AxiosResponse } from "axios";
-import type { ActionDisplayDefinition, TriggerEventFunction, Inputs, TriggerResult, ConfigVarResultCollection, TriggerPayload, ActionDefinition, ActionContext, ActionInputParameters } from ".";
+import type { ActionDisplayDefinition, TriggerEventFunction, Inputs, ConfigVarResultCollection, TriggerPayload, ActionDefinition, ActionContext, ActionInputParameters, ActionPerformReturn, TriggerResult } from ".";
 export interface PollingContext<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection> extends ActionContext<TConfigVars> {
     polling: {
         reinvokeFlow: (data?: Record<string, unknown>, config?: AxiosRequestConfig<any>) => Promise<AxiosResponse<any, any>>;
-        invokeAction: (params: ActionInputParameters<TInputs>) => Promise<any>;
+        invokeAction: (params: ActionInputParameters<TInputs>) => Promise<ActionPerformReturn<boolean, any>>;
         getState: () => Record<string, unknown>;
         setState: (newState: Record<string, unknown>) => void;
     };
 }
-export type PollingTriggerPerformFunction<TInputs extends Inputs, TActionInputs extends Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TResult extends TriggerResult<boolean, TPayload> = TriggerResult<boolean, TPayload>> = (context: ActionContext<TConfigVars> & PollingContext<TActionInputs>, payload: TPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;
+export type PollingTriggerPerformFunction<TInputs extends Inputs, TActionInputs extends Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TAllowsBranching extends boolean = boolean, TResult extends TriggerResult<TAllowsBranching, TPayload> = TriggerResult<TAllowsBranching, TPayload>> = (context: ActionContext<TConfigVars> & PollingContext<TActionInputs>, payload: TPayload, params: ActionInputParameters<TInputs>) => Promise<TResult>;
 /**
  * PollingTriggerDefinition is the type of the object that is passed in to `pollingTrigger` function to
  * define a component trigger.
  */
-export type PollingTriggerDefinition<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TResult extends TriggerResult<boolean, TPayload> = TriggerResult<boolean, TPayload>, TActionInputs extends Inputs = Inputs, TAction extends ActionDefinition<TActionInputs> = ActionDefinition<TActionInputs>, TCombinedInputs extends TInputs & TActionInputs = TInputs & TActionInputs> = {
+export interface PollingTriggerDefinition<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TPayload extends TriggerPayload = TriggerPayload, TAllowsBranching extends boolean = boolean, TResult extends TriggerResult<TAllowsBranching, TPayload> = TriggerResult<TAllowsBranching, TPayload>, TActionInputs extends Inputs = Inputs, TAction extends ActionDefinition<TActionInputs> = ActionDefinition<TActionInputs>, TCombinedInputs extends TInputs & TActionInputs = TInputs & TActionInputs> {
     triggerType?: "polling";
     /** Defines how the Action is displayed in the Prismatic interface. */
     display: ActionDisplayDefinition;
     /** Defines your trigger's polling behavior. */
     pollAction?: TAction;
     /** Function to perform when this Trigger is invoked. A default perform will be provided for most polling triggers but defining this allows for custom behavior. */
-    perform: PollingTriggerPerformFunction<TCombinedInputs, TActionInputs, TConfigVars, TPayload, TResult>;
+    perform: PollingTriggerPerformFunction<TCombinedInputs, TActionInputs, TConfigVars, TPayload, TAllowsBranching, TResult>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
     onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars>;
     /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
     onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars>;
     /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
     inputs?: TInputs;
-};
+    /** Determines whether this Trigger allows Conditional Branching. */
+    allowsBranching?: TAllowsBranching;
+    /** An example of the payload outputted by this Trigger. */
+    examplePayload?: Awaited<ReturnType<this["perform"]>>;
+}
 export declare const isPollingTriggerDefinition: (ref: unknown) => ref is PollingTriggerDefinition;

package/dist/types/TriggerResult.d.ts

@@ -18,6 +18,8 @@ export interface TriggerBaseResult<TPayload extends TriggerPayload> {
     failed?: boolean;
     /** A field populated by the Prismatic platform which may refer to an object that contains data about any error that resulted in failure. */
     error?: Record<string, unknown>;
+    /** An optional field that component authors can use to denote their CNI trigger result as having a polling response. */
+    polledNoChanges?: boolean;
 }
 /** Represents the result of a Trigger action that uses branching. */
 export interface TriggerBranchingResult<TPayload extends TriggerPayload> extends TriggerBaseResult<TPayload> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.2.0",
+  "version": "10.2.1",
   "description": "Utility library for building Prismatic components and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",