@prismatic-io/spectral 10.4.4 → 10.5.1

package/dist/serverTypes/convertIntegration.js

@@ -24,6 +24,8 @@ const integration_1 = require("./integration");
 const merge_1 = __importDefault(require("lodash/merge"));
 const perform_1 = require("./perform");
 const context_1 = require("./context");
+const path_1 = __importDefault(require("path"));
+const fs_1 = require("fs");
 const convertIntegration = (definition) => {
     var _a, _b, _c;
     // Generate a unique reference key that will be used to reference the
@@ -44,8 +46,17 @@ const convertIntegration = (definition) => {
         }
         return Object.assign(Object.assign({}, acc), { [key]: element });
     }, acc), {}))), {});
+    let metadata = {};
+    try {
+        const metaDataPath = path_1.default.join("..", ".spectral", "metadata.json");
+        const file = (0, fs_1.readFileSync)(metaDataPath, { encoding: "utf-8" });
+        metadata = JSON.parse(file);
+    }
+    catch (e) {
+        // No-op. If there's no metadata file then we move on.
+    }
     const cniComponent = codeNativeIntegrationComponent(definition, referenceKey, configVars);
-    const cniYaml = codeNativeIntegrationYaml(definition, referenceKey, configVars);
+    const cniYaml = codeNativeIntegrationYaml(definition, referenceKey, configVars, metadata);
     return Object.assign(Object.assign({}, cniComponent), { codeNativeIntegrationYAML: cniYaml });
 };
 exports.convertIntegration = convertIntegration;
@@ -76,7 +87,7 @@ const convertConfigPages = (pages, userLevelConfigured) => {
             };
         }) })));
 };
-const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, scopedConfigVars, componentRegistry = {}, }, referenceKey, configVars) => {
+const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, scopedConfigVars, componentRegistry = {}, }, referenceKey, configVars, metadata) => {
     // Find the preprocess flow config on the flow, if one exists.
     const preprocessFlows = flows.filter((flow) => flow.preprocessFlowConfig);
     // Do some validation of preprocess flow configs.
@@ -129,6 +140,7 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
             ...convertConfigPages(configPages, false),
             ...convertConfigPages(userLevelConfigPages, true),
         ],
+        importMetadata: metadata,
     };
     return yaml_1.default.stringify(result);
 };
@@ -342,7 +354,7 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
     return result;
 };
 exports.convertFlow = convertFlow;
-/** Converts an input value to the expected server type by its collection type */
+/** Converts an input value to the expected server type by its collection type. */
 const convertInputValue = (value, collectionType) => {
     if (collectionType !== "keyvaluelist") {
         return value;
@@ -364,7 +376,6 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
             key,
             stableKey,
             dataType: "connection",
-            orgOnly: false,
             useScopedConfigVar: stableKey,
         };
     }
@@ -484,7 +495,7 @@ const flowFunctionKey = (flowName, functionName) => {
         .join("");
     return `${flowKey}_${functionName}`;
 };
-/* Generates component argument for invokeTrigger calls */
+/* Generates component argument for invokeTrigger calls. */
 const invokeTriggerComponentInput = (componentRef, onTrigger, eventName) => {
     const { component } = componentRef;
     const inputComponent = "signature" in componentRef.component
@@ -504,7 +515,7 @@ const invokeTriggerComponentInput = (componentRef, onTrigger, eventName) => {
         triggerEventFunctionName: eventName,
     };
 };
-/* Generates a wrapper function that calls an existing component trigger's perform */
+/* Generates a wrapper function that calls an existing component trigger's perform. */
 const generateTriggerPerformFn = (componentRef, onTrigger) => {
     const performFn = componentRef && typeof onTrigger !== "function"
         ? (context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {

package/dist/serverTypes/index.d.ts

@@ -247,4 +247,6 @@ export interface Input {
     model?: InputFieldChoice[];
     language?: string;
     onPremiseControlled?: boolean;
+    dataSource?: string;
+    shown?: boolean;
 }

package/dist/serverTypes/integration.d.ts

@@ -57,7 +57,6 @@ export interface DefaultRequiredConfigVariable {
 export interface OrganizationActivatedConnectionRequiredConfigVariable {
     key: string;
     dataType: "connection";
-    orgOnly: false;
     inputs?: never;
     useScopedConfigVar: string;
 }

package/dist/testing.d.ts

@@ -2,16 +2,25 @@
  * This module provides functions to help developers unit
  * test custom components prior to publishing them. For
  * information on unit testing, check out our docs:
- * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
+ * https://prismatic.io/docs/custom-connectors/unit-testing/
  */
 import { ActionPerformReturn as ServerActionPerformReturn, TriggerPayload, TriggerResult, ConnectionValue, ActionLogger, Component, DataSourceResult, DataSourceContext } from "./serverTypes";
 import { ActionContext, ConnectionDefinition, ActionDefinition, TriggerDefinition, Inputs, ActionInputParameters, DataSourceDefinition, ActionPerformReturn as InvokeActionPerformReturn, TriggerResult as InvokeTriggerResult, DataSourceType, DataSourceResult as InvokeDataSourceResult, TriggerEventFunctionReturn, Flow, ConfigVarResultCollection, ComponentManifest } from "./types";
+/**
+ * Create a test connection to use when testing your custom component locally. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/#providing-test-connection-inputs-to-an-action-test
+ */
 export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>, tokenValues?: Record<string, unknown>) => ConnectionValue;
 export declare const defaultConnectionValueEnvironmentVariable = "PRISMATIC_CONNECTION_VALUE";
+/**
+ * Source a test connection from an environment variable for local testing. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/#access-connections-for-local-testing
+ */
 export declare const connectionValue: (envVarKey?: string) => 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.
+ * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/#verifying-correct-logging-in-action-tests
+ * for information on testing correct logging behavior in your custom component.
  */
 export declare const loggerMock: () => ActionLogger;
 /**
@@ -66,7 +75,8 @@ type ToTestValues<TConfigVars extends ConfigVarResultCollection> = {
 };
 /**
  * Invokes specified Flow of a Code Native Integration using supplied params.
- * Runs the Trigger and then the Action function and returns the result of the Action.
+ * Runs the Trigger and then the Action function and returns the result of the Action. See
+ * https://prismatic.io/docs/integrations/triggers/cross-flow/#using-cross-flow-triggers-in-code-native
  */
 export declare const invokeFlow: <TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow, { configVars, context, payload, }?: {
     configVars?: TConfigVarValues;
@@ -77,13 +87,41 @@ export declare class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);
     private buildParams;
+    /**
+     * Source a test connection from an environment variable for local testing. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/#access-connections-for-local-testing
+     */
     connectionValue({ key }: ConnectionDefinition): ConnectionValue;
+    /**
+     * Invoke a trigger by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     trigger<TConfigVars extends ConfigVarResultCollection>(key: string, payload?: TriggerPayload, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<TriggerResult>;
+    /**
+     * Invoke a trigger's onInstanceDeploy function by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     triggerOnInstanceDeploy<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<TriggerEventFunctionReturn | void>;
+    /**
+     * Invoke a trigger's onInstanceDelete function by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     triggerOnInstanceDelete<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<TriggerEventFunctionReturn | void>;
+    /**
+     * Invoke an action by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     action<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<ActionContext<TConfigVars>>): Promise<ServerActionPerformReturn>;
+    /**
+     * Invoke a data source by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     dataSource<TConfigVars extends ConfigVarResultCollection>(key: string, params?: Record<string, unknown>, context?: Partial<DataSourceContext<TConfigVars>>): Promise<DataSourceResult>;
 }
+/**
+ * Create a testing harness to test a custom component's actions, triggers and data sources. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/
+ */
 export declare const createHarness: <TComponent extends Component>(component: TComponent) => ComponentTestHarness<TComponent>;
 declare const _default: {
     loggerMock: () => ActionLogger;

package/dist/testing.js

@@ -3,7 +3,7 @@
  * This module provides functions to help developers unit
  * test custom components prior to publishing them. For
  * information on unit testing, check out our docs:
- * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
+ * https://prismatic.io/docs/custom-connectors/unit-testing/
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -17,6 +17,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createHarness = exports.ComponentTestHarness = exports.invokeFlow = exports.invokeDataSource = exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.createMockContextComponents = exports.loggerMock = exports.connectionValue = exports.defaultConnectionValueEnvironmentVariable = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
+/**
+ * Create a test connection to use when testing your custom component locally. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/#providing-test-connection-inputs-to-an-action-test
+ */
 const createConnection = ({ key }, values, tokenValues) => ({
     configVarKey: "",
     key,
@@ -25,6 +29,10 @@ const createConnection = ({ key }, values, tokenValues) => ({
 });
 exports.createConnection = createConnection;
 exports.defaultConnectionValueEnvironmentVariable = "PRISMATIC_CONNECTION_VALUE";
+/**
+ * Source a test connection from an environment variable for local testing. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/#access-connections-for-local-testing
+ */
 const connectionValue = (envVarKey = exports.defaultConnectionValueEnvironmentVariable) => {
     const value = process.env[envVarKey];
     if (!value) {
@@ -35,8 +43,9 @@ const connectionValue = (envVarKey = exports.defaultConnectionValueEnvironmentVa
 };
 exports.connectionValue = 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.
+ * Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/#verifying-correct-logging-in-action-tests
+ * for information on testing correct logging behavior in your custom component.
  */
 const loggerMock = () => ({
     metric: console.log,
@@ -251,7 +260,8 @@ const createConfigVars = (values) => {
 };
 /**
  * Invokes specified Flow of a Code Native Integration using supplied params.
- * Runs the Trigger and then the Action function and returns the result of the Action.
+ * Runs the Trigger and then the Action function and returns the result of the Action. See
+ * https://prismatic.io/docs/integrations/triggers/cross-flow/#using-cross-flow-triggers-in-code-native
  */
 const invokeFlow = (flow_1, ...args_1) => __awaiter(void 0, [flow_1, ...args_1], void 0, function* (flow, { configVars, context, payload, } = {}) {
     const realizedConfigVars = createConfigVars(configVars);
@@ -279,6 +289,10 @@ class ComponentTestHarness {
         const defaults = inputs.reduce((result, { key, default: defaultValue }) => (Object.assign(Object.assign({}, result), { [key]: `${defaultValue !== null && defaultValue !== void 0 ? defaultValue : ""}` })), {});
         return Object.assign(Object.assign({}, defaults), params);
     }
+    /**
+     * Source a test connection from an environment variable for local testing. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/#access-connections-for-local-testing
+     */
     connectionValue({ key }) {
         const { PRISMATIC_CONNECTION_VALUE: value } = process.env;
         if (!value) {
@@ -287,12 +301,20 @@ class ComponentTestHarness {
         const result = Object.assign(Object.assign({}, JSON.parse(value)), { key });
         return result;
     }
+    /**
+     * Invoke a trigger by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     trigger(key, payload, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const trigger = this.component.triggers[key];
             return trigger.perform(createActionContext(context), Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload), this.buildParams(trigger.inputs, params));
         });
     }
+    /**
+     * Invoke a trigger's onInstanceDeploy function by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     triggerOnInstanceDeploy(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const trigger = this.component.triggers[key];
@@ -302,6 +324,10 @@ class ComponentTestHarness {
             return trigger.onInstanceDeploy(createActionContext(context), this.buildParams(trigger.inputs, params));
         });
     }
+    /**
+     * Invoke a trigger's onInstanceDelete function by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     triggerOnInstanceDelete(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const trigger = this.component.triggers[key];
@@ -311,12 +337,20 @@ class ComponentTestHarness {
             return trigger.onInstanceDelete(createActionContext(context), this.buildParams(trigger.inputs, params));
         });
     }
+    /**
+     * Invoke an action by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     action(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const action = this.component.actions[key];
             return action.perform(createActionContext(context), this.buildParams(action.inputs, params));
         });
     }
+    /**
+     * Invoke a data source by its key within a unit test. See
+     * https://prismatic.io/docs/custom-connectors/unit-testing/
+     */
     dataSource(key, params, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const dataSource = this.component.dataSources[key];
@@ -325,6 +359,10 @@ class ComponentTestHarness {
     }
 }
 exports.ComponentTestHarness = ComponentTestHarness;
+/**
+ * Create a testing harness to test a custom component's actions, triggers and data sources. See
+ * https://prismatic.io/docs/custom-connectors/unit-testing/
+ */
 const createHarness = (component) => {
     return new ComponentTestHarness(component);
 };

package/dist/types/ActionDefinition.d.ts

@@ -2,25 +2,36 @@ import { ActionDisplayDefinition, ActionPerformFunction, ActionPerformReturn, Co
 import { ComponentManifestAction } from "./ComponentManifest";
 /**
  * ActionDefinition is the type of the object that is passed in to `action` function to
- * define a component action.
+ * define a component action. See
+ * https://prismatic.io/docs/custom-connectors/actions/
  */
 export interface ActionDefinition<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TAllowsBranching extends boolean = boolean, TReturn extends ActionPerformReturn<TAllowsBranching, unknown> = ActionPerformReturn<TAllowsBranching, unknown>> {
-    /** Defines how the Action is displayed in the Prismatic interface. */
+    /** Defines how the action is displayed in the Prismatic UI. */
     display: ActionDisplayDefinition;
-    /** Function to perform when this Action is invoked. */
+    /** The function to perform when this action is invoked. */
     perform: ActionPerformFunction<TInputs, TConfigVars, Record<string, Record<string, ComponentManifestAction>>, TAllowsBranching, TReturn>;
-    /** InputFields to present in the Prismatic interface for configuration of this Action. */
+    /**
+     * The inputs to present a low-code integration builder. Values of these inputs
+     * are passed to the `perform` function when the action is invoked.
+     */
     inputs: TInputs;
-    /** Optional attribute that specifies whether an Action will terminate execution.*/
+    /** Attribute that specifies whether an action will terminate execution.*/
     terminateExecution?: boolean;
-    /** Specifies whether an Action will break out of a loop. */
+    /** Specifies whether an action will break out of a loop. */
     breakLoop?: boolean;
-    /** Determines whether an Action will allow Conditional Branching.*/
+    /**
+     * Determines whether an action will allow branching. See
+     * https://prismatic.io/docs/custom-connectors/branching/
+     */
     allowsBranching?: TAllowsBranching;
-    /** Static Branch names associated with an Action. */
+    /**
+     * Static branches associated with an action.
+     * Use if your action supports branching. See
+     * https://prismatic.io/docs/custom-connectors/branching/
+     */
     staticBranchNames?: string[];
-    /** The Input associated with Dynamic Branching.*/
+    /** The input field associated with dynamic branching. */
     dynamicBranchInput?: string;
-    /** An example of the payload outputted by an Action*/
+    /** An example of the payload output by this action. */
     examplePayload?: Awaited<ReturnType<this["perform"]>>;
 }

package/dist/types/ActionLogger.d.ts

@@ -2,14 +2,15 @@
  * Actions' perform functions receive a logger object as part of their first parameter.
  * Types in this file define the shape of the logger that is passed to an action.
  * For information on the logger object, see:
- * https://prismatic.io/docs/custom-components/writing-custom-components/#contextlogger
+ * https://prismatic.io/docs/custom-connectors/actions/#logger-object
  */
 /**
  * A logger function, similar to `console.log()` or `console.error()`.
  */
 export type ActionLoggerFunction = (...args: unknown[]) => void;
 /**
- * An object containing logger functions.
+ * An object containing logger functions. See
+ * https://prismatic.io/docs/custom-connectors/actions/#logger-object
  */
 export interface ActionLogger {
     metric: ActionLoggerFunction;

package/dist/types/ActionLogger.js

@@ -3,6 +3,6 @@
  * Actions' perform functions receive a logger object as part of their first parameter.
  * Types in this file define the shape of the logger that is passed to an action.
  * For information on the logger object, see:
- * https://prismatic.io/docs/custom-components/writing-custom-components/#contextlogger
+ * https://prismatic.io/docs/custom-connectors/actions/#logger-object
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/ActionPerformFunction.d.ts

@@ -43,7 +43,7 @@ interface DebugResult {
             duration: number;
         }>;
     };
-    /** Memory limit in MB */
+    /** Memory limit in MB. */
     allowedMemory: number;
     /** Resulting data bout memory usage. */
     memoryUsage: Array<{
@@ -69,17 +69,17 @@ export type ExecutionFrame = ({
 export type FlowInvoker<TFlows extends Readonly<string[]> | undefined> = (flowName: TFlows extends Readonly<string[]> ? TFlows[number] : string, data?: Record<string, unknown>, config?: AxiosRequestConfig<any>, source?: string) => Promise<AxiosResponse<any, any>>;
 /** Definition of the function to perform when an Action is invoked. */
 export type ActionPerformFunction<TInputs extends Inputs = Inputs, TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]> = Record<string, ComponentManifest["actions"]>, TAllowsBranching extends boolean | undefined = undefined, TReturn extends ActionPerformReturn<TAllowsBranching, unknown> = ActionPerformReturn<TAllowsBranching, unknown>> = (context: ActionContext<TConfigVars, TComponentActions>, params: ActionInputParameters<TInputs>) => Promise<TReturn>;
-/** Context provided to perform method containing helpers and contextual data */
+/** Context provided to perform method containing helpers and contextual data. */
 export type ActionContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection, TComponentActions extends Record<string, ComponentManifest["actions"]> = Record<string, ComponentManifest["actions"]>, TFlows extends string[] = string[]> = {
-    /** Logger for permanent logging; console calls are also captured */
+    /** Logger for permanent logging; console calls are also captured. */
     logger: ActionLogger;
-    /** A a flow-specific key/value store that may be used to store small amounts of data that is persisted between Instance executions */
+    /** A a flow-specific 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 is shared between flows on an Instance that may be used to store small amounts of data that is persisted between Instance executions */
+    /** A key/value store that is shared between flows on an Instance that may be used to store small amounts of data that is persisted between Instance executions. */
     crossFlowState: Record<string, unknown>;
-    /** A key/value store that may be used to store small amounts of data for use later during the execution */
+    /** 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 key/value store that is shared between all flows of an Instance for any version of an Integration that may be used to store small amounts of data that is persisted between Instance executions */
+    /** A key/value store that is shared between all flows of an Instance for any version of an Integration that may be used to store small amounts of data that is persisted between Instance executions. */
     integrationState: Record<string, unknown>;
     /** Key/value collection of config variables of the integration. */
     configVars: TConfigVars;
@@ -89,15 +89,15 @@ export type ActionContext<TConfigVars extends ConfigVarResultCollection = Config
             [A in keyof TComponentActions[K]]: TComponentActions[K][A]["perform"];
         };
     };
-    /** A unique id that corresponds to the step on the Integration */
+    /** 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 */
+    /** A unique id that corresponds to the specific execution of the Integration. */
     executionId: string;
-    /** An object containing webhook URLs for all flows of the currently running instance */
+    /** An object containing webhook URLs for all flows of the currently running instance. */
     webhookUrls: Record<string, string>;
-    /** An object containing webhook API keys for all flows of the currently running instance */
+    /** An object containing webhook API keys for all flows of the currently running instance. */
     webhookApiKeys: Record<string, string[]>;
-    /** The URL used to invoke the current execution */
+    /** The URL used to invoke the current execution. */
     invokeUrl: string;
     /** Contains attributes of the Customer for whom an Instance is being executed. */
     customer: CustomerAttributes;

package/dist/types/ActionPerformReturn.d.ts

@@ -1,31 +1,31 @@
-/** Used to represent a binary or serialized data return as content type must be specified */
+/** Used to represent a binary or serialized data return as content type must be specified. */
 export interface ActionPerformDataReturn<ReturnData> {
-    /** Data payload containing data of the specified contentType */
+    /** Data payload containing data of the specified contentType. */
     data: ReturnData;
-    /** The Content Type of the payload data */
+    /** The Content Type of the payload data. */
     contentType?: string;
     /** The HTTP Status code that will be used if this terminates a synchronous invocation  */
     statusCode?: number;
-    /** The HTTP headers that will be sent back if this terminates a synchronous invocation */
+    /** The HTTP headers that will be sent back if this terminates a synchronous invocation. */
     headers?: Record<string, string>;
-    /** 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>;
     /** A field populated by the Prismatic platform which indicates whether the action failed with an error during execution. */
     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>;
 }
-/** 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 */
+/** 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. */
 export interface ActionPerformBranchingDataReturn<ReturnData> extends ActionPerformDataReturn<ReturnData> {
     /** Name of the Branch to take. */
     branch: string;
 }
-/** Required return type of all action perform functions */
+/** Required return type of all action perform functions. */
 export type ActionPerformReturn<AllowsBranching extends boolean | undefined, ReturnData> = (AllowsBranching extends true ? ActionPerformBranchingDataReturn<ReturnData> : ActionPerformDataReturn<ReturnData>) | undefined;

package/dist/types/ComponentDefinition.d.ts

@@ -2,29 +2,52 @@ import { ActionDefinition, ConnectionDefinition, ComponentDisplayDefinition, Tri
 import { PollingTriggerDefinition } from "./PollingTriggerDefinition";
 export type ErrorHandler = (error: unknown) => unknown;
 export interface ComponentHooks {
-    /** Defines a global error handler that automatically wraps the component's action/trigger perform functions. */
+    /**
+     * Defines a global error handler that automatically wraps the component's action/trigger
+     * perform functions. See
+     * https://prismatic.io/docs/custom-connectors/error-handling/#global-error-handlers
+     */
     error?: ErrorHandler;
 }
-/** Defines attributes of a Component. */
+/** Defines attributes of a component. */
 export type ComponentDefinition<TPublic extends boolean, TKey extends string> = {
-    /** Specifies unique key for this Component. */
+    /** Specifies a unique programmatic key for this component. */
     key: TKey;
-    /** Specifies if this Component is available for all Organizations or only your own @default false */
+    /**
+     * Specifies if this component is available for all organizations or only your own.
+     * Only Prismatic public components can specify 'true'
+     * @default false
+     */
     public?: TPublic;
-    /** Defines how the Component is displayed in the Prismatic interface. */
+    /** Defines how the component is displayed in the Prismatic UI. */
     display: ComponentDisplayDefinition<TPublic>;
-    /** Specifies the supported Actions of this Component. */
+    /**
+     * Specifies the supported Actions of this component. See
+     * https://prismatic.io/docs/custom-connectors/actions/
+     */
     actions?: Record<string, ActionDefinition<any, any, boolean, any>>;
-    /** Specifies the supported Triggers of this Component. */
+    /**
+     * Specifies the supported triggers of this component. See
+     * https://prismatic.io/docs/custom-connectors/triggers/
+     */
     triggers?: Record<string, TriggerDefinition<any, any, boolean, any> | PollingTriggerDefinition<any, any, any, any, any, any>>;
-    /** Specifies the supported Data Sources of this Component. */
+    /**
+     * Specifies the supported data sources of this component. See
+     * https://prismatic.io/docs/custom-connectors/data-sources/
+     */
     dataSources?: Record<string, DataSourceDefinition<any, any, any>>;
-    /** Specifies the supported Connections of this Component. */
+    /**
+     * Specifies the supported connections of this component. See
+     * https://prismatic.io/docs/custom-connectors/connections/
+     */
     connections?: ConnectionDefinition[];
-    /** Hooks */
+    /**
+     * Hooks (error handler) for this component. See
+     * https://prismatic.io/docs/custom-connectors/error-handling/
+     */
     hooks?: ComponentHooks;
 } & (TPublic extends true ? {
-    /** Specified the URL for the Component Documentation. */
+    /** The URL for this component's documentation. */
     documentationUrl: `https://prismatic.io/docs/components/${TKey}/`;
 } : {
     documentationUrl?: string;