@prismatic-io/spectral 10.4.4 → 10.5.1

package/dist/clients/http/index.d.ts

@@ -5,22 +5,59 @@ import { ActionInputParameters } from "../../types";
 import { inputs } from "./inputs";
 export type HttpClient = AxiosInstance;
 interface RetryConfig extends Omit<IAxiosRetryConfig, "retryDelay"> {
+    /** The number of milliseconds to wait between retry attempts. */
     retryDelay?: IAxiosRetryConfig["retryDelay"] | number;
+    /**
+     * When true, all errors will be retried. When false, specify
+     * a retryCondition function to determine when retries should occur.
+     */
     retryAllErrors?: boolean;
+    /** When true, double the retry delay after each attempt (e.g. 1000ms, 2000ms, 4000ms, 8000ms, etc.). */
     useExponentialBackoff?: boolean;
 }
 export interface ClientProps {
+    /** The API's base URL (e.g. `https://api.acme.com/v2/`). */
     baseUrl?: string;
+    /** The type of response to expect. Set to 'json' to automatically parse a JSON response, or 'arraybuffer' for a binary file. */
     responseType?: AxiosRequestConfig["responseType"];
+    /** Headers to send for all requests (e.g. Authorization header, etc.). */
     headers?: AxiosRequestConfig["headers"];
+    /** URL Search parameters to add to all requests. */
     params?: Record<string, any>;
+    /** The maximum amount of time (in milliseconds) to wait for a response. Defaults to infinity. */
     timeout?: number;
+    /** When enabled, log all HTTP requests and responses. */
     debug?: boolean;
+    /** Configuration used to determine if and how failed HTTP requests should be retried. */
     retryConfig?: RetryConfig;
 }
+/**
+ * Creates a reusable Axios HTTP client. See
+ * https://prismatic.io/docs/custom-connectors/connections/#using-the-built-in-createclient-http-client
+ */
 export declare const createClient: ({ baseUrl, responseType, headers, timeout, params, debug, retryConfig, }: ClientProps) => HttpClient;
+/**
+ * A global error handler that examines a thrown error and yields additional
+ * information if the error was produced by Spectral's HTTP client. See
+ * https://prismatic.io/docs/custom-connectors/error-handling/
+ * and
+ * https://prismatic.io/docs/custom-connectors/connections/#using-the-built-in-createclient-http-client
+ *
+ * @param error A JavaScript error to handle
+ * @returns An error with data, status and headers if it was an Axios error, or the error otherwise
+ */
 export declare const handleErrors: (error: unknown) => unknown;
 type SendRawRequestValues = ActionInputParameters<typeof inputs>;
+/**
+ * This function allows you to build a generic "Raw Request" action
+ * for a custom connector. See
+ * https://prismatic.io/docs/integrations/low-code-integration-designer/raw-request-actions/#building-an-http-raw-request-action-in-your-custom-component
+ *
+ * @param baseUrl The base URL of the API you're integrating with
+ * @param values An object comprising the HTTP request you'd like to make
+ * @param authorizationHeaders Auth headers to apply to the request
+ * @returns The response to the request
+ */
 export declare const sendRawRequest: (baseUrl: string, values: SendRawRequestValues, authorizationHeaders?: Record<string, string>) => Promise<AxiosResponse>;
 export declare const buildRawRequestAction: (baseUrl: string, label?: string, description?: string) => import("../..").ActionDefinition<{
     url: {

package/dist/clients/http/index.js

@@ -96,6 +96,10 @@ const toAxiosRetryConfig = (_a) => {
                 ? retryCondition
                 : axios_retry_1.isNetworkOrIdempotentRequestError }));
 };
+/**
+ * Creates a reusable Axios HTTP client. See
+ * https://prismatic.io/docs/custom-connectors/connections/#using-the-built-in-createclient-http-client
+ */
 const createClient = ({ baseUrl, responseType, headers, timeout, params, debug = false, retryConfig, }) => {
     const client = axios_1.default.create({
         baseURL: baseUrl,
@@ -142,6 +146,16 @@ const createClient = ({ baseUrl, responseType, headers, timeout, params, debug =
     return client;
 };
 exports.createClient = createClient;
+/**
+ * A global error handler that examines a thrown error and yields additional
+ * information if the error was produced by Spectral's HTTP client. See
+ * https://prismatic.io/docs/custom-connectors/error-handling/
+ * and
+ * https://prismatic.io/docs/custom-connectors/connections/#using-the-built-in-createclient-http-client
+ *
+ * @param error A JavaScript error to handle
+ * @returns An error with data, status and headers if it was an Axios error, or the error otherwise
+ */
 const handleErrors = (error) => {
     if (axios_1.default.isAxiosError(error)) {
         const { message, response } = error;
@@ -155,6 +169,16 @@ const handleErrors = (error) => {
     return error;
 };
 exports.handleErrors = handleErrors;
+/**
+ * This function allows you to build a generic "Raw Request" action
+ * for a custom connector. See
+ * https://prismatic.io/docs/integrations/low-code-integration-designer/raw-request-actions/#building-an-http-raw-request-action-in-your-custom-component
+ *
+ * @param baseUrl The base URL of the API you're integrating with
+ * @param values An object comprising the HTTP request you'd like to make
+ * @param authorizationHeaders Auth headers to apply to the request
+ * @returns The response to the request
+ */
 const sendRawRequest = (baseUrl_1, values_1, ...args_1) => __awaiter(void 0, [baseUrl_1, values_1, ...args_1], void 0, function* (baseUrl, values, authorizationHeaders = {}) {
     if (values.data && (!(0, isEmpty_1.default)(values.formData) || !(0, isEmpty_1.default)(values.fileData))) {
         throw new Error("Cannot specify both Data and File/Form Data.");

package/dist/generators/componentManifest/getInputs.js

@@ -66,6 +66,7 @@ exports.INPUT_TYPE_MAP = {
     date: "string",
     timestamp: "string",
     flow: "string",
+    template: "string",
 };
 const getInputValueType = (input) => {
     const inputType = exports.INPUT_TYPE_MAP[input.type];

package/dist/index.d.ts

@@ -1,68 +1,87 @@
 /**
- * This module contains functions to help custom component
- * authors create inputs, actions, and components that can
- * be processed by the Prismatic API.
+ * This module contains functions to help custom component and code-native
+ * integration authors create inputs, actions, components, and integrations
+ * that can run on the Prismatic platform.
  */
-import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, DataSourceType, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, OnPremConnectionDefinition, ComponentManifest, OrganizationActivatedConnectionConfigVar } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, DataSourceType, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, OnPremConnectionDefinition, ComponentManifest, OrganizationActivatedConnectionConfigVar, CustomerActivatedConnectionConfigVar } from "./types";
 import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 import { PollingTriggerDefinition } from "./types/PollingTriggerDefinition";
 /**
- * This function creates a Integration object that can be
- * imported into the Prismatic API. For information on using
- * this function to write code native integrations, see
- * https://prismatic.io/docs/code-native-integrations/.
+ * This function creates a code-native integration object that can be
+ * imported into Prismatic. For information on using this function to
+ * write code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/.
+ *
  * @param definition An IntegrationDefinition type object.
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
 export declare const integration: <T extends IntegrationDefinition = IntegrationDefinition>(definition: T) => ReturnType<typeof convertIntegration>;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-flows.
+ * This function creates a flow object for use in code-native integrations.
+ * For information on writing code-native flows, see
+ * https://prismatic.io/docs/integrations/code-native/flows/.
+ *
  * @param definition A Flow type object.
  * @returns This function returns a flow object that has the shape the Prismatic API expects.
  */
 export declare const flow: <TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TTriggerPayload> = Flow<TTriggerPayload>>(definition: T) => T;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-pages.
+ * This function creates a config wizard page object for use in code-native
+ * integrations. For information on code-native config wizards, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/.
+ *
  * @param definition A Config Page type object.
  * @returns This function returns a config page object that has the shape the Prismatic API expects.
  */
 export declare const configPage: <T extends ConfigPage = ConfigPage>(definition: T) => T;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a config variable object for code-native integrations.
+ * For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/#other-config-variable-types-in-code-native-integrations.
+ *
  * @param definition A Config Var type object.
  * @returns This function returns a standard config var object that has the shape the Prismatic API expects.
  */
 export declare const configVar: <T extends StandardConfigVar>(definition: T) => T;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a data source-backed config variable for code-native
+ * integrations. For information on code-native data sources, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/#data-sources-is-code-native-integrations.
+ *
  * @param definition A Data Source Config Var type object.
  * @returns This function returns a data source config var object that has the shape the Prismatic API expects.
  */
 export declare const dataSourceConfigVar: <TDataSourceConfigVar extends DataSourceConfigVar>(definition: TDataSourceConfigVar) => TDataSourceConfigVar;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a connection config variable for code-native
+ * integrations. For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/#connections-in-code-native-integrations.
+ *
  * @param definition A Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
 export declare const connectionConfigVar: <T extends ConnectionConfigVar = ConnectionConfigVar>(definition: T) => T;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a customer-activated connection for code-native
+ * integrations. For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/.
+ * For information on customer-activated connections, see
+ * https://prismatic.io/docs/integrations/connections/integration-agnostic-connections/customer-activated/.
+ *
  * @param definition A Customer-Activated Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
 export declare const customerActivatedConnection: <T extends {
     stableKey: string;
-}>(definition: T) => OrganizationActivatedConnectionConfigVar;
-/**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+}>(definition: T) => CustomerActivatedConnectionConfigVar;
+/**
+ * This function creates an org-activated connection for code-native
+ * integrations. For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/.
+ * For information on customer-activated connections, see
+ * https://prismatic.io/docs/integrations/connections/integration-agnostic-connections/org-activated-customer/.
+ *
  * @param definition An Organization-Activated Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
@@ -70,6 +89,9 @@ export declare const organizationActivatedConnection: <T extends {
     stableKey: string;
 }>(definition: T) => OrganizationActivatedConnectionConfigVar;
 /**
+ * Generate a manifest of components that this code-native integration relies on. See
+ * https://prismatic.io/docs/integrations/code-native/existing-components/
+ *
  * @param definition A Component Manifest type object.
  * @returns This function returns a component manifest object that has the shape the Prismatic API expects.
  */
@@ -78,7 +100,8 @@ export declare const componentManifest: <T extends ComponentManifest>(definition
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using
  * this function to write custom components, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#exporting-a-component.
+ * https://prismatic.io/docs/custom-connectors/.
+ *
  * @param definition A ComponentDefinition type object, including display information, unique key, and a set of actions the component implements.
  * @returns This function returns a component object that has the shape the Prismatic API expects.
  */
@@ -88,7 +111,8 @@ export declare const component: <TPublic extends boolean, TKey extends string>(d
  * by a custom component. It helps ensure that the shape of the
  * action object conforms to what the Prismatic API expects.
  * For information on writing custom component actions, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#writing-actions.
+ * https://prismatic.io/docs/custom-connectors/actions/.
+ *
  * @param definition An ActionDefinition type object that includes UI display information, a function to perform when the action is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same action object.
  */
@@ -98,14 +122,17 @@ export declare const action: <TInputs extends Inputs, TConfigVars extends Config
  * by a custom component. It helps ensure that the shape of the
  * trigger object conforms to what the Prismatic API expects.
  * For information on writing custom component triggers, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#writing-triggers.
+ * https://prismatic.io/docs/custom-connectors/triggers/.
+ *
  * @param definition A TriggerDefinition type object that includes UI display information, a function to perform when the trigger is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same trigger object.
  */
 export declare const trigger: <TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TAllowsBranching extends boolean, TResult extends TriggerResult<TAllowsBranching, TriggerPayload>>(definition: TriggerDefinition<TInputs, TConfigVars, TAllowsBranching, TResult>) => TriggerDefinition<TInputs, TConfigVars, TAllowsBranching, TResult>;
 /**
  * This function creates a polling trigger object that can be referenced
- * by a custom component.
+ * by a custom component. See
+ * https://prismatic.io/docs/custom-connectors/triggers/#app-event-polling-triggers
+ *
  * @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.
  */
@@ -115,7 +142,8 @@ export declare const pollingTrigger: <TInputs extends Inputs, TConfigVars extend
  * by a custom component. It helps ensure that the shape of the
  * data source object conforms to what the Prismatic API expects.
  * For information on writing custom component data sources, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#writing-data-sources.
+ * https://prismatic.io/docs/custom-connectors/data-sources/.
+ *
  * @param definition A DataSourceDefinition type object that includes UI display information, a function to perform when the data source is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same data source object.
  */
@@ -123,28 +151,35 @@ export declare const dataSource: <TInputs extends Inputs, TConfigVars extends Co
 /**
  * For information and examples on how to write inputs
  * for custom component actions and triggers, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-inputs.
+ * https://prismatic.io/docs/custom-connectors/actions/#action-inputs.
+ *
  * @param definition An InputFieldDefinition object that describes the type of an input for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
  * @returns This function validates the shape of the `definition` object provided, and returns the same input object.
  */
 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.
+ * This function creates a connection that can be used by a code-native integration
+ * or custom component. For information on writing connections, see
+ * https://prismatic.io/docs/custom-connectors/connections/.
+ *
  * @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 DefaultConnectionDefinition>(definition: T) => T;
 /**
- * For information on writing custom component connections using on-premise resources, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * This function creates an on-prem connection for a code-native integration or custom component.
+ * For information on writing custom component connections using on-prem resources, see
+ * https://prismatic.io/docs/integrations/connections/on-prem-agent/#supporting-on-prem-connections-in-a-custom-connector.
+ *
  * @param definition An OnPremConnectionDefinition 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 function validates the shape of the `definition` object provided and returns the same connection object.
  */
 export declare const onPremConnection: <T extends OnPremConnectionDefinition>(definition: T) => T;
 /**
- * For information on writing custom component connections, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * This function creates an OAuth 2.0 connection for a code-native integration or custom component.
+ * For information on writing an OAuth 2.0 connection, see
+ * https://prismatic.io/docs/custom-connectors/connections/#writing-oauth-20-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.
  */

package/dist/index.js

@@ -1,8 +1,8 @@
 "use strict";
 /**
- * This module contains functions to help custom component
- * authors create inputs, actions, and components that can
- * be processed by the Prismatic API.
+ * This module contains functions to help custom component and code-native
+ * integration authors create inputs, actions, components, and integrations
+ * that can run on the Prismatic platform.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -26,10 +26,11 @@ exports.testing = exports.util = exports.componentManifests = exports.oauth2Conn
 const convertComponent_1 = require("./serverTypes/convertComponent");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
- * This function creates a Integration object that can be
- * imported into the Prismatic API. For information on using
- * this function to write code native integrations, see
- * https://prismatic.io/docs/code-native-integrations/.
+ * This function creates a code-native integration object that can be
+ * imported into Prismatic. For information on using this function to
+ * write code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/.
+ *
  * @param definition An IntegrationDefinition type object.
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
@@ -43,48 +44,62 @@ const integration = (definition) => {
 };
 exports.integration = integration;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-flows.
+ * This function creates a flow object for use in code-native integrations.
+ * For information on writing code-native flows, see
+ * https://prismatic.io/docs/integrations/code-native/flows/.
+ *
  * @param definition A Flow type object.
  * @returns This function returns a flow object that has the shape the Prismatic API expects.
  */
 const flow = (definition) => definition;
 exports.flow = flow;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-pages.
+ * This function creates a config wizard page object for use in code-native
+ * integrations. For information on code-native config wizards, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/.
+ *
  * @param definition A Config Page type object.
  * @returns This function returns a config page object that has the shape the Prismatic API expects.
  */
 const configPage = (definition) => definition;
 exports.configPage = configPage;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a config variable object for code-native integrations.
+ * For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/#other-config-variable-types-in-code-native-integrations.
+ *
  * @param definition A Config Var type object.
  * @returns This function returns a standard config var object that has the shape the Prismatic API expects.
  */
 const configVar = (definition) => definition;
 exports.configVar = configVar;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a data source-backed config variable for code-native
+ * integrations. For information on code-native data sources, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/#data-sources-is-code-native-integrations.
+ *
  * @param definition A Data Source Config Var type object.
  * @returns This function returns a data source config var object that has the shape the Prismatic API expects.
  */
 const dataSourceConfigVar = (definition) => definition;
 exports.dataSourceConfigVar = dataSourceConfigVar;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a connection config variable for code-native
+ * integrations. For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/config-wizard/#connections-in-code-native-integrations.
+ *
  * @param definition A Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
 const connectionConfigVar = (definition) => definition;
 exports.connectionConfigVar = connectionConfigVar;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates a customer-activated connection for code-native
+ * integrations. For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/.
+ * For information on customer-activated connections, see
+ * https://prismatic.io/docs/integrations/connections/integration-agnostic-connections/customer-activated/.
+ *
  * @param definition A Customer-Activated Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
@@ -93,8 +108,12 @@ const customerActivatedConnection = (definition) => {
 };
 exports.customerActivatedConnection = customerActivatedConnection;
 /**
- * For information on writing Code Native Integrations, see
- * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * This function creates an org-activated connection for code-native
+ * integrations. For information on writing code-native integrations, see
+ * https://prismatic.io/docs/integrations/code-native/.
+ * For information on customer-activated connections, see
+ * https://prismatic.io/docs/integrations/connections/integration-agnostic-connections/org-activated-customer/.
+ *
  * @param definition An Organization-Activated Connection Config Var type object.
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
@@ -103,6 +122,9 @@ const organizationActivatedConnection = (definition) => {
 };
 exports.organizationActivatedConnection = organizationActivatedConnection;
 /**
+ * Generate a manifest of components that this code-native integration relies on. See
+ * https://prismatic.io/docs/integrations/code-native/existing-components/
+ *
  * @param definition A Component Manifest type object.
  * @returns This function returns a component manifest object that has the shape the Prismatic API expects.
  */
@@ -112,7 +134,8 @@ exports.componentManifest = componentManifest;
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using
  * this function to write custom components, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#exporting-a-component.
+ * https://prismatic.io/docs/custom-connectors/.
+ *
  * @param definition A ComponentDefinition type object, including display information, unique key, and a set of actions the component implements.
  * @returns This function returns a component object that has the shape the Prismatic API expects.
  */
@@ -123,7 +146,8 @@ exports.component = component;
  * by a custom component. It helps ensure that the shape of the
  * action object conforms to what the Prismatic API expects.
  * For information on writing custom component actions, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#writing-actions.
+ * https://prismatic.io/docs/custom-connectors/actions/.
+ *
  * @param definition An ActionDefinition type object that includes UI display information, a function to perform when the action is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same action object.
  */
@@ -134,7 +158,8 @@ exports.action = action;
  * by a custom component. It helps ensure that the shape of the
  * trigger object conforms to what the Prismatic API expects.
  * For information on writing custom component triggers, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#writing-triggers.
+ * https://prismatic.io/docs/custom-connectors/triggers/.
+ *
  * @param definition A TriggerDefinition type object that includes UI display information, a function to perform when the trigger is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same trigger object.
  */
@@ -142,7 +167,9 @@ const trigger = (definition) => definition;
 exports.trigger = trigger;
 /**
  * This function creates a polling trigger object that can be referenced
- * by a custom component.
+ * by a custom component. See
+ * https://prismatic.io/docs/custom-connectors/triggers/#app-event-polling-triggers
+ *
  * @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.
  */
@@ -155,7 +182,8 @@ exports.pollingTrigger = pollingTrigger;
  * by a custom component. It helps ensure that the shape of the
  * data source object conforms to what the Prismatic API expects.
  * For information on writing custom component data sources, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#writing-data-sources.
+ * https://prismatic.io/docs/custom-connectors/data-sources/.
+ *
  * @param definition A DataSourceDefinition type object that includes UI display information, a function to perform when the data source is invoked, and a an object containing inputs for the perform function.
  * @returns This function validates the shape of the `definition` object provided, and returns the same data source object.
  */
@@ -164,31 +192,38 @@ exports.dataSource = dataSource;
 /**
  * For information and examples on how to write inputs
  * for custom component actions and triggers, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-inputs.
+ * https://prismatic.io/docs/custom-connectors/actions/#action-inputs.
+ *
  * @param definition An InputFieldDefinition object that describes the type of an input for a custom component action or trigger, and information on how it should be displayed in the Prismatic WebApp.
  * @returns This function validates the shape of the `definition` object provided, and returns the same input object.
  */
 const input = (definition) => definition;
 exports.input = input;
 /**
- * For information on writing custom component connections, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * This function creates a connection that can be used by a code-native integration
+ * or custom component. For information on writing connections, see
+ * https://prismatic.io/docs/custom-connectors/connections/.
+ *
  * @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 using on-premise resources, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * This function creates an on-prem connection for a code-native integration or custom component.
+ * For information on writing custom component connections using on-prem resources, see
+ * https://prismatic.io/docs/integrations/connections/on-prem-agent/#supporting-on-prem-connections-in-a-custom-connector.
+ *
  * @param definition An OnPremConnectionDefinition 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 function validates the shape of the `definition` object provided and returns the same connection object.
  */
 const onPremConnection = (definition) => definition;
 exports.onPremConnection = onPremConnection;
 /**
- * For information on writing custom component connections, see
- * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
+ * This function creates an OAuth 2.0 connection for a code-native integration or custom component.
+ * For information on writing an OAuth 2.0 connection, see
+ * https://prismatic.io/docs/custom-connectors/connections/#writing-oauth-20-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.
  */

package/dist/serverTypes/convertComponent.d.ts

@@ -1,7 +1,8 @@
-import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, TriggerDefinition, ComponentHooks, ConfigVarResultCollection, OnPremConnectionInput, TriggerPayload } from "../types";
+import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, TriggerDefinition, ComponentHooks, ConfigVarResultCollection, OnPremConnectionInput, TriggerPayload, ConnectionTemplateInputField } from "../types";
 import { Component as ServerComponent, Connection as ServerConnection, Trigger as ServerTrigger, Input as ServerInput } from ".";
 import { PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
 export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput) => ServerInput;
+export declare const convertTemplateInput: (key: string, { templateValue, label, ...rest }: ConnectionTemplateInputField) => ServerInput;
 export declare const convertTrigger: (triggerKey: string, trigger: TriggerDefinition<any> | PollingTriggerDefinition<any, ConfigVarResultCollection, TriggerPayload, boolean, any, any>, hooks?: ComponentHooks) => ServerTrigger;
 export declare const convertConnection: ({ inputs, ...connection }: ConnectionDefinition) => ServerConnection;
 export declare const convertComponent: <TPublic extends boolean, TKey extends string>({ connections, actions, triggers, dataSources, hooks, ...definition }: ComponentDefinition<TPublic, TKey>) => ServerComponent;

package/dist/serverTypes/convertComponent.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertInput = void 0;
+exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertTemplateInput = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
 const omit_1 = __importDefault(require("lodash/omit"));
@@ -31,6 +31,11 @@ const convertInput = (key, _a) => {
         type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel, onPremiseControlled: ("onPremControlled" in rest && rest.onPremControlled) || undefined });
 };
 exports.convertInput = convertInput;
+const convertTemplateInput = (key, _a) => {
+    var { templateValue, label } = _a, rest = __rest(_a, ["templateValue", "label"]);
+    return Object.assign(Object.assign({}, (0, omit_1.default)(rest, ["permissionAndVisibilityType", "visibleToOrgDeployer", "writeOnly"])), { key, type: "template", default: templateValue !== null && templateValue !== void 0 ? templateValue : "", label: typeof label === "string" ? label : label.value, shown: false });
+};
+exports.convertTemplateInput = convertTemplateInput;
 const convertAction = (actionKey, _a, hooks) => {
     var { inputs = {}, perform } = _a, action = __rest(_a, ["inputs", "perform"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
@@ -114,8 +119,13 @@ const convertDataSource = (dataSourceKey, _a, hooks) => {
 };
 const convertConnection = (_a) => {
     var { inputs = {} } = _a, connection = __rest(_a, ["inputs"]);
-    const convertedInputs = Object.entries(inputs).map(([key, value]) => (0, exports.convertInput)(key, value));
     const { display: { label, icons, description: comments } } = connection, remaining = __rest(connection, ["display"]);
+    const convertedInputs = Object.entries(inputs).map(([key, value]) => {
+        if ("templateValue" in value) {
+            return (0, exports.convertTemplateInput)(key, value);
+        }
+        return (0, exports.convertInput)(key, value);
+    });
     return Object.assign(Object.assign({}, remaining), { label,
         comments, iconPath: icons === null || icons === void 0 ? void 0 : icons.oauth2ConnectionIconPath, avatarIconPath: icons === null || icons === void 0 ? void 0 : icons.avatarPath, inputs: convertedInputs });
 };