@prismatic-io/spectral 10.4.4 → 10.5.1

package/dist/types/Inputs.d.ts

@@ -8,13 +8,15 @@ import { JsonSchema, UISchemaElement } from "@jsonforms/core";
  * https://github.com/prismatic-io/examples/blob/main/components/aws-s3/src/actions.ts
  */
 export interface KeyValuePair<V = unknown> {
-    /** Key of the KeyValuePair */
+    /** Key of the KeyValuePair. */
     key: string;
-    /** Value of the KeyValuePair */
+    /** Value of the KeyValuePair. */
     value: V;
 }
 export type Element = {
+    /** The value to return for this field. */
     key: string;
+    /** The string to show in the UI for this field. Defaults to the value of `key` */
     label?: string;
 };
 export type ObjectSelection = {
@@ -64,203 +66,226 @@ export type DynamicFieldSelection = string;
 export type InputFieldType = InputFieldDefinition["type"];
 export declare const InputFieldDefaultMap: Record<InputFieldType, string | undefined>;
 export type Inputs = Record<string, InputFieldDefinition>;
-export type ConnectionInput = (StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField) & {
+export type ConnectionInput = (StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | ConnectionTemplateInputField) & {
+    /** Determines if this input field should be shown in the UI. */
     shown?: boolean;
+    /**
+     * Determines if this input should be write-only. See
+     * https://prismatic.io/docs/integrations/config-wizard/config-variables/#write-only-connection-inputs
+     */
     writeOnly?: true;
 };
 export type OnPremConnectionInput = {
+    /**
+     * When this connection is attached to an on-prem agent, this
+     * field will be overridden by a local on-prem value
+     */
     onPremControlled: true;
 } & ConnectionInput;
-export type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField | DynamicObjectSelectionInputField | DynamicFieldSelectionInputField | DateInputField | DateTimeInputField | FlowInputField;
+export type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ConnectionTemplateInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField | DynamicObjectSelectionInputField | DynamicFieldSelectionInputField | DateInputField | DateTimeInputField | FlowInputField;
 export type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
 interface BaseInputField {
-    /** Interface label of the InputField. */
+    /** Name of this field to present in the UI. */
     label: {
         key: string;
         value: string;
     } | string;
-    /** Text to show as the InputField placeholder. */
+    /** Text to show in the UI as the input's placeholder. */
     placeholder?: string;
-    /** Additional text to give guidance to the user configuring the InputField. */
+    /** Additional text to give guidance to the user configuring the input. */
     comments?: string;
-    /** Example valid input for this InputField. */
+    /** Example valid input for this input. */
     example?: string;
-    /** Indicate if this InputField is required. */
+    /** Indicate if this input field is required. */
     required?: boolean;
+    /** Key of the data source that can be used to set the value of this input. */
+    dataSource?: string;
 }
 type CollectionOptions<T> = SingleValue<T> | ValueListCollection<T> | KeyValueListCollection<T>;
 interface SingleValue<T> {
-    /** Collection type of the InputField */
+    /** Collection type of the input. */
     collection?: undefined;
     /** Default value for this field. */
     default?: T;
 }
 interface ValueListCollection<T> {
-    /** Collection type of the InputField */
+    /** Collection type of the input. */
     collection: "valuelist";
     /** Default value for this field. */
     default?: T[];
 }
 interface KeyValueListCollection<T> {
-    /** Collection type of the InputField */
+    /** Collection type of the input. */
     collection: "keyvaluelist";
     /** Default value for this field. */
     default?: KeyValuePair<T>[];
 }
 export type StringInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "string";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 export type DataInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "data";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 export type TextInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "text";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 export type PasswordInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "password";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 export type BooleanInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "boolean";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
+    /** Clean function. */
+    clean?: InputCleanFunction<unknown>;
+} & CollectionOptions<string>;
+export type ConnectionTemplateInputField = BaseInputField & {
+    /** Data type the InputField will collect. */
+    type: "template";
+    /** Default templated string. */
+    templateValue: string;
+    /** Will not be user-facing. */
+    shown?: false;
     /** Clean function */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 /** Defines attributes of a CodeInputField. */
 export type CodeInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "code";
     /** Code language for syntax highlighting. For no syntax highlighting, choose "plaintext" */
     language: "css" | "graphql" | "handlebars" | "hcl" | "html" | "javascript" | "json" | "liquid" | "markdown" | "mysql" | "pgsql" | "plaintext" | "sql" | "typescript" | "xml" | "yaml";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 /** Defines attributes of a ConditionalInputField. */
 export interface ConditionalInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "conditional";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection: InputFieldCollection;
     /** Default value for this field. */
     default?: ConditionalExpression;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"] | null>;
 }
 /** Defines attributes of a ConnectionInputField. */
 export interface ConnectionInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "connection";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection?: InputFieldCollection;
     /** Default value for this field. */
     default?: Connection;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"] | null>;
 }
 export interface Connection {
-    /** Key of the Connection type. */
+    /** Programmatic unique key of the connection type. */
     key: string;
-    /** Key for the Config Variable hosting this Connection. */
+    /** Name of the config variable hosting this connection. */
     configVarKey: string;
-    /** Field values supplied to this Connection. */
+    /** Values of input fields supplied to this connection. */
     fields: {
         [key: string]: unknown;
     };
+    /** If this connection implements OAuth 2.0, this will be an object with properties like `access_token` and `refresh_token` */
     token?: Record<string, unknown>;
+    /** If this connection implements OAuth 2.0, this will contain metadata about the OAuth 2.0 tokens (like expiration time, etc). */
     context?: Record<string, unknown>;
 }
 /** Defines attributes of an ObjectSelectionInputField. */
 export interface ObjectSelectionInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "objectSelection";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection?: InputFieldCollection;
     /** Default value for this field. */
     default?: ObjectSelection;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"]>;
 }
 /** Defines attributes of an ObjectFieldMapInputField. */
 export interface ObjectFieldMapInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "objectFieldMap";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection?: InputFieldCollection;
     /** Default value for this field. */
     default?: ObjectFieldMap;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"]>;
 }
 /** Defines attributes of a JSONFormInputField. */
 export interface JSONFormInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "jsonForm";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection?: InputFieldCollection;
     /** Default value for this field. */
     default?: JSONForm;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"]>;
 }
-/** Defines attributes of a DynamicObjectSelectionInputField */
+/** Defines attributes of a DynamicObjectSelectionInputField. */
 export interface DynamicObjectSelectionInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "dynamicObjectSelection";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection?: InputFieldCollection;
     /** Default value for this field. */
     default?: unknown;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"]>;
 }
-/** Defines attributes of a SelectedFieldInputField */
+/** Defines attributes of a SelectedFieldInputField. */
 export interface DynamicFieldSelectionInputField extends BaseInputField {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "dynamicFieldSelection";
-    /** Collection type of the InputField */
+    /** Collection type of the InputField. */
     collection?: InputFieldCollection;
     /** Default value for this field. */
     default?: unknown;
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<this["default"]>;
 }
 export type DateInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "date";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 export type DateTimeInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "timestamp";
     /** Dictates possible choices for the input. */
     model?: InputFieldChoice[];
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 /** Defines a single Choice option for a InputField. */
@@ -270,14 +295,14 @@ export interface InputFieldChoice {
     /** Value to use if this Choice is chosen. */
     value: string;
 }
-/** InputField collection enumeration */
+/** InputField collection enumeration. */
 export type InputFieldCollection = "valuelist" | "keyvaluelist";
-/** Config variable result collection */
+/** Config variable result collection. */
 export type ConfigVarResultCollection = Record<string, string | Schedule | Connection | unknown | ObjectSelection | ObjectFieldMap>;
 export type FlowInputField = BaseInputField & {
-    /** Data type the InputField will collect. */
+    /** Data type the input will collect. */
     type: "flow";
-    /** Clean function */
+    /** Clean function. */
     clean?: InputCleanFunction<unknown>;
 } & CollectionOptions<string>;
 export {};

package/dist/types/Inputs.js

@@ -18,4 +18,5 @@ exports.InputFieldDefaultMap = {
     date: "",
     timestamp: "",
     flow: "",
+    template: "",
 };

package/dist/types/InstanceAttributes.d.ts

@@ -1,5 +1,7 @@
-/** Contains attributes of the Instance that is being executed. */
+/** Contains attributes of the instance that is being executed. */
 export interface InstanceAttributes {
+    /** Programmatic ID of the deployed instance. */
     id: string;
+    /** Name of the deployed instance. */
     name: string;
 }

package/dist/types/IntegrationAttributes.d.ts

@@ -1,7 +1,10 @@
-/** Contains attributes of the Integration that is being executed. */
+/** Contains attributes of the integration that is being executed. */
 export interface IntegrationAttributes {
+    /** Programmatic ID of the integration being executed. */
     id: string;
+    /** Name of the integration being executed. */
     name: string;
+    /** ID of the version of the integration being executed. */
     versionSequenceId: string;
     externalVersion: string;
 }

package/dist/types/IntegrationDefinition.d.ts

@@ -1,35 +1,57 @@
 import { ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, TriggerPayload, ComponentRegistry, TriggerReference, ConfigVars, ConfigPages, UserLevelConfigPages, ValueExpression, ConfigVarExpression, ActionContext, ScopedConfigVarMap } from ".";
-/** Defines attributes of a Code-Native Integration. */
+/**
+ * Defines attributes of a code-native integration. See
+ * https://prismatic.io/docs/integrations/code-native/
+ */
 export type IntegrationDefinition = {
-    /** The unique name for this Integration. */
+    /** The unique name for this integration. */
     name: string;
-    /** Optional description for this Integration. */
+    /** Description for this integration. */
     description?: string;
-    /** Optional path to icon to use for this Integration. Path should be relative to the built Integration source. */
+    /** Path to icon to use for this integration. Path should be relative to the built integration source. */
     iconPath?: string;
-    /** Optional category for this Integration. */
+    /** Category for this integration. */
     category?: string;
-    /** Optional documentation for this Integration. */
+    /** Documentation for this integration. */
     documentation?: string;
-    /** Optional version identifier for this Integration. */
+    /** Version identifier for this integration. */
     version?: string;
-    /** Optional labels for this Integration. */
+    /** Labels for this integration. */
     labels?: string[];
-    /** Optional endpoint type used by Instances of this Integration.
-     *  A Preprocess Flow Config must be specified when using anything other than 'Flow Specific'.
-     *  @default EndpointType.FlowSpecific. */
+    /**
+     * Endpoint type used by Instances of this integration.
+     * A Preprocess Flow Config must be specified when using anything other than 'Flow Specific'. See
+     * https://prismatic.io/docs/integrations/code-native/endpoint-config/.
+     *
+     *  @default `EndpointType.FlowSpecific` */
     endpointType?: EndpointType;
-    /** Optional Preprocess Flow configuration for when the Trigger payload contains the flow routing attributes.
-     *  Cannot specify this if a Preprocess Flow is also configured. */
+    /**
+     * Preprocess Flow configuration for when the Trigger payload contains the flow routing attributes.
+     *  Cannot specify this if a Preprocess Flow is also configured. See
+     * https://prismatic.io/docs/integrations/code-native/endpoint-config/#endpoint-configuration-in-code-native-with-preprocess-flow
+     */
     triggerPreprocessFlowConfig?: PreprocessFlowConfig;
-    /** Flows for this Integration. */
+    /**
+     * Flows for this integration. See
+     * https://prismatic.io/docs/integrations/code-native/flows/
+     */
     flows: Flow[];
-    /** Config Wizard Pages for this Integration. */
+    /**
+     * Config wizard pages for this integration. See
+     * https://prismatic.io/docs/integrations/code-native/config-wizard/
+     */
     configPages?: ConfigPages;
-    /** User Level Config Wizard Pages for this Integration. */
+    /**
+     * User Level Config Wizard Pages for this integration. See
+     * https://prismatic.io/docs/integrations/code-native/config-wizard/#user-level-config-wizards-in-code-native-integrations
+     */
     userLevelConfigPages?: UserLevelConfigPages;
-    /** Scoped ConfigVars for this Integration. */
+    /** Scoped ConfigVars for this integration. */
     scopedConfigVars?: ScopedConfigVarMap;
+    /**
+     * A list of components this code-native integration uses. See
+     * https://prismatic.io/docs/integrations/code-native/existing-components/
+     */
     componentRegistry?: ComponentRegistry;
 };
 export type FlowOnExecution<TTriggerPayload extends TriggerPayload> = ActionPerformFunction<{
@@ -47,49 +69,64 @@ export type FlowExecutionContext = ActionContext<ConfigVars, {
     [Key in keyof ComponentRegistry]: ComponentRegistry[Key]["actions"];
 }>;
 export type FlowExecutionContextActions = FlowExecutionContext["components"];
-/** Defines attributes of a Flow of a Code-Native Integration. */
+/** Defines attributes of a flow of a code-native integration. */
 export interface Flow<TTriggerPayload extends TriggerPayload = TriggerPayload> {
-    /** The unique name for this Flow. */
+    /** The unique name for this flow. */
     name: string;
-    /** A unique, unchanging value that is used to maintain identity for the Flow even if the name changes. */
+    /** A unique, unchanging value that is used to maintain identity for the flow even if the name changes. */
     stableKey: string;
-    /** Optional description for this Flow. */
+    /** Description for this flow. */
     description?: string;
-    /** Optional Preprocess Flow configuration for when the result of this Flow contains the flow routing attributes. Only one Flow per Integration may define this. */
+    /**
+     * Preprocess flow configuration for when the result of this flow contains the flow routing attributes.
+     * Only one flow per integration may define this.
+     */
     preprocessFlowConfig?: PreprocessFlowConfig;
-    /** Optional value that specifies whether this Flow is synchronous. @default false */
+    /** Value that specifies whether this flow is synchronous. @default `false` */
     isSynchronous?: boolean;
-    /** Optional Retry Configuration for this Flow. */
+    /** Retry Configuration for this flow. */
     retryConfig?: RetryConfig;
-    /** Optional security configuration to use for the endpoint of this Flow. @default EndpointSecurityType.CustomerOptional */
+    /**
+     * Security configuration to use for the endpoint of this flow.
+     * @default `EndpointSecurityType.CustomerOptional`
+     */
     endpointSecurityType?: EndpointSecurityType;
-    /** Optional list of API key(s) to use for the endpoint of this Flow when the endpoint security type is EndpointSecurityType.Organization. */
+    /**
+     * List of API key(s) to use for the endpoint of this flow
+     * when the endpoint security type is `EndpointSecurityType.Organization`.
+     */
     organizationApiKeys?: string[];
-    /** Optional schedule configuration that defines the frequency with which this Flow will be automatically executed. */
+    /** Schedule configuration that defines the frequency with which this flow will be automatically executed. */
     schedule?: (ValueExpression<string> | ConfigVarExpression) & {
         timezone?: string;
     };
-    /** Optional error handling configuration. */
+    /** Error handling configuration. */
     errorConfig?: StepErrorConfig;
-    /** Specifies the trigger function for this Flow, which returns a payload and optional HTTP response. */
+    /** Specifies the trigger function for this flow, which returns a payload and optional HTTP response. */
     onTrigger?: TriggerReference | TriggerPerformFunction<Inputs, ConfigVars, false, TriggerResult<false, TTriggerPayload>>;
-    /** Specifies the function to execute when an Instance of this Integration is deployed. */
+    /**
+     * Specifies the function to execute when an instance of this integration is deployed. See
+     * https://prismatic.io/docs/custom-connectors/triggers/#instance-deploy-and-delete-events-for-triggers
+     */
     onInstanceDeploy?: TriggerEventFunction<Inputs, ConfigVars>;
-    /** Specifies the function to execute when an Instance of an Integration is deleted. */
+    /**
+     * Specifies the function to execute when an instance of an integration is deleted. See
+     * https://prismatic.io/docs/custom-connectors/triggers/#instance-deploy-and-delete-events-for-triggers
+     */
     onInstanceDelete?: TriggerEventFunction<Inputs, ConfigVars>;
-    /** Specifies the main function for this Flow */
+    /** Specifies the main function for this flow which is run when this flow is invoked. */
     onExecution: FlowOnExecution<TTriggerPayload>;
 }
-/** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
+/** Defines attributes of a Preprocess flow Configuration used by a flow of an integration. */
 export type PreprocessFlowConfig = {
-    /** Name of the field in the data payload returned by the Preprocess Flow to use for a Flow Name. */
+    /** Name of the field in the data payload returned by the Preprocess flow to use for a flow Name. */
     flowNameField: string;
-    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer Id. */
+    /** Name of the field in the data payload returned by the Preprocess flow to use for an External Customer Id. */
     externalCustomerIdField?: string;
-    /** Optional name of the field in the data payload returned by the Preprocess Flow to use for an External Customer User Id. */
+    /** Name of the field in the data payload returned by the Preprocess flow to use for an External Customer User Id. */
     externalCustomerUserIdField?: string;
 };
-/** Defines attributes of a Retry Configuration used by a Flow of an Integration. */
+/** Defines attributes of a retry configuration used by a flow of an integration. */
 export type RetryConfig = {
     /** The maximum number of retry attempts. Must be between 0 and 10. */
     maxAttempts: number;
@@ -97,10 +134,10 @@ export type RetryConfig = {
     delayMinutes: number;
     /** Specifies whether to use exponential backoff to calculate the delay between retry attempts. */
     usesExponentialBackoff: boolean;
-    /** Name of the field in the data payload returned by the Flow Trigger to use as a Unique Request ID for retry request cancellation. */
+    /** Name of the field in the data payload returned by the flow's trigger to use as a Unique Request ID for retry request cancellation. */
     uniqueRequestIdField?: string;
 };
-/** Defines attributes of a Step Error Configuration used to determine how to handle errors during Flow step execution. */
+/** Defines attributes of a step error configuration used to determine how to handle errors during flow step execution. */
 export type StepErrorConfig = {
     /** Defines the type of error handler. */
     errorHandlerType: StepErrorHandlerType;
@@ -113,9 +150,9 @@ export type StepErrorConfig = {
     /** Specifies whether to ignore the final error after the final retry attempt. @default false */
     ignoreFinalError?: boolean;
 };
-/** Choices of Endpoint Types that may be used by Instances of an Integration. */
+/** Choices of Endpoint Types that may be used by Instances of an integration. */
 export type EndpointType = "flow_specific" | "instance_specific" | "shared_instance";
-/** Choices of Endpoint Security Types that may be used by endpoints of a Flow. */
+/** Choices of Endpoint Security Types that may be used by endpoints of a flow. */
 export type EndpointSecurityType = "unsecured" | "customer_optional" | "customer_required" | "organization";
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
 export type StepErrorHandlerType = "fail" | "ignore" | "retry";

package/dist/types/TriggerDefinition.d.ts

@@ -4,36 +4,51 @@ export type TriggerOptionChoice = (typeof optionChoices)[number];
 export declare const TriggerOptionChoices: TriggerOptionChoice[];
 /**
  * TriggerDefinition is the type of the object that is passed in to `trigger` function to
- * define a component trigger.
+ * define a component trigger. See
+ * https://prismatic.io/docs/custom-connectors/triggers/
  */
 export interface TriggerDefinition<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TAllowsBranching extends boolean = boolean, TResult extends TriggerResult<TAllowsBranching, TriggerPayload> = TriggerResult<TAllowsBranching, TriggerPayload>> {
-    /** Defines how the Trigger is displayed in the Prismatic interface. */
+    /** Defines how the trigger is displayed in the Prismatic UI. */
     display: ActionDisplayDefinition;
-    /** Function to perform when this Trigger is invoked. */
+    /** Function to perform when this trigger is invoked. */
     perform: TriggerPerformFunction<TInputs, TConfigVars, TAllowsBranching, TResult>;
-    /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deployed. */
+    /**
+     * Function to execute when an instance of an integration with a flow that uses this trigger is deployed. See
+     * https://prismatic.io/docs/custom-connectors/triggers/#instance-deploy-and-delete-events-for-triggers
+     */
     onInstanceDeploy?: TriggerEventFunction<TInputs, TConfigVars>;
-    /** Function to execute when an Instance of an Integration with a Flow that uses this Trigger is deleted. */
+    /** Function to execute when an instance of an integration with a flow that uses this trigger is deleted. See
+     * https://prismatic.io/docs/custom-connectors/triggers/#instance-deploy-and-delete-events-for-triggers
+     */
     onInstanceDelete?: TriggerEventFunction<TInputs, TConfigVars>;
-    /** InputFields to present in the Prismatic interface for configuration of this Trigger. */
+    /**
+     * The inputs to present a low-code integration builder. Values of these inputs
+     * are passed to the `perform` function when the trigger is invoked.
+     */
     inputs: TInputs;
-    /** Specifies whether this Trigger supports executing the Integration on a recurring schedule. */
+    /** Specifies whether this trigger supports executing the integration on a recurring schedule. */
     scheduleSupport: TriggerOptionChoice;
-    /** Specifies whether this Trigger supports synchronous responses to an Integration webhook request. */
+    /** Specifies whether this trigger supports synchronous responses to a webhook request. */
     synchronousResponseSupport: TriggerOptionChoice;
-    /** Optional attribute that specifies whether this Trigger will terminate execution. */
+    /** 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. */
+    /**
+     * Determines whether this trigger supports branching. See
+     * https://prismatic.io/docs/custom-connectors/branching/
+     */
     allowsBranching?: TAllowsBranching;
-    /** Static Branch names associated with this Trigger. */
+    /** Static Branch names associated with this trigger. */
     staticBranchNames?: string[];
-    /** The Input associated with Dynamic Branching. */
+    /** The input field associated with dynamic branching. */
     dynamicBranchInput?: string;
-    /** An example of the payload outputted by this Trigger. */
+    /** An example of the payload outputted by this trigger. */
     examplePayload?: Awaited<ReturnType<this["perform"]>>;
-    /** Specifies if this Trigger appears in the list of 'common' Triggers. Only configurable by Prismatic. @default false */
+    /**
+     * Specifies if this trigger appears in the list of 'common' triggers. Only configurable by Prismatic.
+     * @default false
+     */
     isCommonTrigger?: boolean;
 }
 export {};

package/dist/types/TriggerEventFunction.d.ts

@@ -1,12 +1,12 @@
 import { Inputs, ActionContext, ActionInputParameters, ConfigVarResultCollection } from ".";
 export 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 */
+    /** 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>;
-    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the crossFlowState and available in any flow for subsequent actions and executions. */
     crossFlowState?: 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 */
+    /** 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>;
-    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions */
+    /** An optional object, the keys and values of which will be persisted in the integrationState and available in any flow of an Instance for any version of an Integration for subsequent actions and executions. */
     integrationState?: Record<string, unknown>;
 };
 /** Definition of the function to execute when a Trigger Event occurs. */