@prismatic-io/spectral 10.5.0 → 10.5.1

package/dist/types/ConfigVars.d.ts

@@ -1,7 +1,7 @@
 import { ValidationMode } from "@jsonforms/core";
 import { type DataSourceDefinition, type ConnectionDefinition, type Inputs, type DataSourceType, type Connection, type JSONForm, type ObjectFieldMap, type ObjectSelection, type ConfigVarResultCollection, type Schedule, type CollectionDataSourceType, type DataSourceReference, type ConfigPage, type ConfigPages, type ConfigPageElement, type ComponentRegistryDataSource, type ComponentRegistryConnection, type UserLevelConfigPages, type OrganizationActivatedConnectionConfigVar, type ScopedConfigVarMap } from ".";
 import type { Prettify, UnionToIntersection } from "./utils";
-/** Supported data types for Config Vars. */
+/** Supported data types for config variables. */
 export type ConfigVarDataType = "string" | "date" | "timestamp" | "picklist" | "code" | "boolean" | "number" | "schedule" | "objectSelection" | "objectFieldMap" | "jsonForm" | "htmlElement";
 type ConfigVarDataTypeDefaultValueMap<TMap extends Record<ConfigVarDataType, unknown> = {
     string: string;
@@ -31,60 +31,72 @@ type ConfigVarDataTypeRuntimeValueMap<TMap extends Record<ConfigVarDataType, unk
     jsonForm: unknown;
     htmlElement: string;
 }> = TMap;
-/** Choices of collection types for multi-value Config Vars. */
+/** Choices of collection types for multi-value config vars. */
 export type CollectionType = "valuelist" | "keyvaluelist";
 type ConfigVarSingleDataType = Extract<ConfigVarDataType, "schedule" | "objectSelection" | "objectFieldMap" | "jsonForm">;
 export type PermissionAndVisibilityType = "customer" | "embedded" | "organization";
 export interface ConfigVarVisibility {
     /**
-     * Optional value that sets the permission and visibility of the Config Var. @default "customer"
+     * Optional value that sets the permission and visibility of the config variable. See
+     * https://prismatic.io/docs/integrations/code-native/config-wizard/#config-variable-visibility-in-code-native
      *
-     * "customer" - Customers can view and edit the Config Var.
-     * "embedded" - Customers cannot view or update the Config Var as the value will be set programmatically.
-     * "organization" - Customers cannot view or update the Config Var as it will always have a default value or be set by the organization.
+     * - `"customer"` - Customers can view and edit the config variable.
+     * - `"embedded"` - Customers cannot view or update the config variable as the value will be set programmatically.
+     * - `"organization"` - Customers cannot view or update the config variable as it will always have a default value or be set by the organization.
+     *
+     * @default `"customer"`
      */
     permissionAndVisibilityType?: PermissionAndVisibilityType;
-    /** Optional value that specifies whether this Config Var is visible to an Organization deployer. @default true */
+    /**
+     * Optional value that specifies whether this config var is visible to an organization deployer.
+     * @default true
+     */
     visibleToOrgDeployer?: boolean;
 }
 interface ConfigVarInputVisibility {
     /**
-     * Optional value that sets the permission and visibility of the Config Var Input. @default "customer"
+     * Optional value that sets the permission and visibility of the config variable input. See
+     * https://prismatic.io/docs/integrations/code-native/config-wizard/#config-variable-visibility-in-code-native
      *
-     * "customer" - Customers can view and edit the Config Var Input.
-     * "embedded" - Customers cannot view or update the Config Var Input as the value will be set programmatically.
-     * "organization" - Customers cannot view or update the Config Var Input as it will always have a default value or be set by the organization.
+     * - `"customer"` - Customers can view and edit the config variable input.
+     * - `"embedded"` - Customers cannot view or update the config variable input as the value will be set programmatically.
+     * - `"organization"` - Customers cannot view or update the config variable input as it will always have a default value or be set by the organization.
+     *
+     * @default `"customer"`
      */
     permissionAndVisibilityType?: PermissionAndVisibilityType;
-    /** Optional value that specifies whether this Config Var Input is visible to an Organization deployer. @default true */
+    /**
+     * Optional value that specifies whether this config var input is visible to an organization deployer.
+     * @default true
+     */
     visibleToOrgDeployer?: boolean;
 }
-/** Common attribute shared by all types of Config Vars. */
+/** Common attribute shared by all types of config variables. */
 type BaseConfigVar = {
-    /** A unique, unchanging value that is used to maintain identity for the Config Var even if the key changes. */
+    /** A unique, unchanging value that is used to maintain identity for the config variable even if the key changes. */
     stableKey: string;
-    /** Optional description for this Config Var. */
+    /** Description for this config variable. */
     description?: string;
 } & ConfigVarVisibility;
 type GetDynamicProperties<TValue, TCollectionType extends CollectionType | undefined> = TCollectionType extends undefined ? {
     defaultValue?: TValue;
-    /** Optional value to specify the type of collection if the Config Var is multi-value. */
+    /** Value to specify the type of collection if the config variable is multi-value. */
     collectionType?: undefined;
 } : TCollectionType extends "valuelist" ? {
     defaultValue?: TValue[];
-    /** Optional value to specify the type of collection if the Config Var is multi-value. */
+    /** Value to specify the type of collection if the config variable is multi-value. */
     collectionType: "valuelist";
 } : {
     defaultValue?: Record<string, TValue> | Array<{
         key: string;
         value: TValue;
     }>;
-    /** Optional value to specify the type of collection if the Config Var is multi-value. */
+    /** Value to specify the type of collection if the config variable is multi-value. */
     collectionType: "keyvaluelist";
 };
 type StandardConfigVarDynamicProperties<TDataType extends ConfigVarDataType> = CollectionType | undefined extends infer TCollectionType ? TCollectionType extends CollectionType | undefined ? TDataType extends ConfigVarSingleDataType ? TCollectionType extends undefined ? GetDynamicProperties<ConfigVarDataTypeDefaultValueMap[TDataType], undefined> : never : GetDynamicProperties<ConfigVarDataTypeDefaultValueMap[TDataType], TCollectionType> : never : never;
 type CreateStandardConfigVar<TDataType extends ConfigVarDataType> = BaseConfigVar & StandardConfigVarDynamicProperties<TDataType> & {
-    /** The data type of the Config Var. */
+    /** The data type of the config variable. */
     dataType: TDataType;
 };
 type StringConfigVar = CreateStandardConfigVar<"string">;
@@ -94,16 +106,16 @@ type PicklistConfigVar = CreateStandardConfigVar<"picklist"> & {
     /** List of picklist values. */
     pickList: string[];
 };
-/** Choices of programming languages that may be used for Config Var code values. */
+/** Syntax highlighting to use for this code config variable. */
 export type CodeLanguageType = "json" | "xml" | "html";
 type CodeConfigVar = CreateStandardConfigVar<"code"> & {
-    /** Value to specify the type of language of a code Config Var. */
+    /** Value to specify the type of language of a code config variable. */
     codeLanguage: CodeLanguageType;
 };
 type BooleanConfigVar = CreateStandardConfigVar<"boolean">;
 type NumberConfigVar = CreateStandardConfigVar<"number">;
 type ScheduleConfigVar = CreateStandardConfigVar<"schedule"> & {
-    /** Optional timezone for the schedule. */
+    /** Timezone for the schedule. */
     timeZone?: string;
 };
 type ObjectSelectionConfigVar = CreateStandardConfigVar<"objectSelection">;
@@ -139,7 +151,7 @@ type DataSourceReferenceConfigVar = ComponentRegistryDataSource extends infer TD
     dataSource: TDataSourceReference["reference"];
     validationMode?: ValidationMode;
 } : never;
-/** Defines attributes of a data source Config Var. */
+/** Defines attributes of a data source config variable. */
 export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar;
 type BaseConnectionConfigVar = BaseConfigVar & {
     dataType: "connection";
@@ -163,7 +175,7 @@ type ConnectionReferenceConfigVar = ComponentRegistryConnection extends infer TC
         onPremiseConnectionConfig?: undefined;
     });
 } : never : never;
-/** Defines attributes of a Config Var that represents a Connection. */
+/** Defines attributes of a config variable that represents a connection. */
 export type ConnectionConfigVar = ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar;
 export type ConfigVar = StandardConfigVar | DataSourceConfigVar | ConnectionConfigVar | OrganizationActivatedConnectionConfigVar;
 type WithCollectionType<TValue, TCollectionType extends CollectionType | undefined> = undefined | unknown extends TCollectionType ? TValue : TCollectionType extends "valuelist" ? TValue[] : Array<{

package/dist/types/ConnectionDefinition.d.ts

@@ -1,6 +1,14 @@
-import type { ConnectionDisplayDefinition, ConnectionInput, OnPremConnectionInput } from ".";
+import type { ConnectionDisplayDefinition, ConnectionInput, ConnectionTemplateInputField, OnPremConnectionInput } from ".";
 export declare enum OAuth2Type {
+    /**
+     * This connection uses the OAuth 2.0 client credentials flow. See
+     * https://prismatic.io/docs/integrations/connections/oauth2/client-credentials-grant-type/
+     */
     ClientCredentials = "client_credentials",
+    /**
+     * This connection uses the OAuth 2.0 auth code flow. See
+     * https://prismatic.io/docs/integrations/connections/oauth2/authorization-code-grant-type/
+     */
     AuthorizationCode = "authorization_code"
 }
 export declare enum OAuth2PkceMethod {
@@ -10,6 +18,10 @@ export declare enum OAuth2PkceMethod {
 interface BaseConnectionDefinition {
     key: string;
     display: ConnectionDisplayDefinition;
+    /**
+     * If this connection implements OAuth 2.0, specify which flavor of OAuth 2.0. See
+     * https://prismatic.io/docs/custom-connectors/connections/#writing-oauth-20-connections
+     */
     oauth2Type?: OAuth2Type;
 }
 export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
@@ -19,41 +31,108 @@ export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
 }
 export interface OnPremConnectionDefinition extends BaseConnectionDefinition {
     inputs: {
+        /**
+         * When on-prem is enabled for this connection, the `host` value will be
+         * overwritten with a local endpoint for the established on-prem tunnel. See
+         * https://prismatic.io/docs/integrations/connections/on-prem-agent/#supporting-on-prem-connections-in-a-custom-connector
+         */
         host: OnPremConnectionInput;
+        /**
+         * When on-prem is enabled for this connection, the `port` value will be
+         * overwritten with a local port for the established on-prem tunnel. See
+         * https://prismatic.io/docs/integrations/connections/on-prem-agent/#supporting-on-prem-connections-in-a-custom-connector
+         */
         port: OnPremConnectionInput;
         [key: string]: ConnectionInput;
     };
 }
+type TTemplateComplement<TRequired, TGiven> = {
+    [K in Exclude<keyof TRequired, keyof TGiven>]: ConnectionTemplateInputField;
+};
+interface OAuth2AuthorizationCodeInputs {
+    /**
+     * The OAuth 2.0 authorization URL where users can consent to granting you permissions
+     * to their third-party account. (e.g. `https://app.acme.com/oauth2/authorize`)
+     */
+    authorizeUrl: ConnectionInput;
+    /**
+     * The OAuth 2.0 token URL which can be used to exchange an auth code or refresh
+     * token for an access token. (e.g. `https://app.acme.com/oauth2/token`)
+     */
+    tokenUrl: ConnectionInput;
+    /** OAuth 2.0 permissions (scopes) to request from the authenticated user. */
+    scopes: ConnectionInput;
+    /** OAuth 2.0 client ID (sometimes called app key or client key). */
+    clientId: ConnectionInput;
+    /** OAuth 2.0 client secret (sometimes called app secret or secret key). */
+    clientSecret: ConnectionInput;
+}
+interface OAuth2ClientCredentialInputs {
+    /**
+     * The OAuth 2.0 token URL which can be used to exchange a client ID and secret
+     * for an access token. (e.g. `https://app.acme.com/oauth2/token`)
+     */
+    tokenUrl: ConnectionInput;
+    /** OAuth 2.0 permissions (scopes) to request from the authenticated user. */
+    scopes: ConnectionInput;
+    /** OAuth 2.0 client ID (sometimes called app key or client key). */
+    clientId: ConnectionInput;
+    /** OAuth 2.0 client secret (sometimes called app secret or secret key). */
+    clientSecret: ConnectionInput;
+}
+export declare function templateConnectionInputs<TConnectionType extends "client_credentials" | "authorization_code" | null = null, TInputs extends Record<string, ConnectionInput> = Record<string, ConnectionInput>>(inputs: TConnectionType extends null | undefined ? Record<string, ConnectionInput> : TConnectionType extends OAuth2Type.ClientCredentials ? TInputs & Partial<OAuth2ClientCredentialInputs> & {
+    [key: string]: ConnectionInput;
+} : TInputs & Partial<OAuth2AuthorizationCodeInputs> & {
+    [key: string]: ConnectionInput;
+}, templateInputs: TConnectionType extends null | undefined ? {
+    [key: string]: ConnectionTemplateInputField;
+} : TConnectionType extends "client_credentials" ? TTemplateComplement<OAuth2ClientCredentialInputs, TInputs> & {
+    [key: string]: ConnectionTemplateInputField;
+} : TTemplateComplement<OAuth2AuthorizationCodeInputs, TInputs> & {
+    [key: string]: ConnectionTemplateInputField;
+}, _authType?: TConnectionType): (TConnectionType extends null | undefined ? Record<string, ConnectionInput> : TConnectionType extends OAuth2Type.ClientCredentials ? TInputs & Partial<OAuth2ClientCredentialInputs> & {
+    [key: string]: ConnectionInput;
+} : TInputs & Partial<OAuth2AuthorizationCodeInputs> & {
+    [key: string]: ConnectionInput;
+}) & (TConnectionType extends null | undefined ? {
+    [key: string]: ConnectionTemplateInputField;
+} : TConnectionType extends "client_credentials" ? TTemplateComplement<OAuth2ClientCredentialInputs, TInputs> & {
+    [key: string]: ConnectionTemplateInputField;
+} : TTemplateComplement<OAuth2AuthorizationCodeInputs, TInputs> & {
+    [key: string]: ConnectionTemplateInputField;
+});
 interface OAuth2Config {
     overrideGrantType?: string;
     allowedTokenParams?: string[];
 }
 export interface OAuth2UrlOverrides {
+    /**
+     * Custom URI where users should be sent on OAuth success. See
+     * https://prismatic.io/docs/integrations/connections/oauth2/custom-redirects/
+     */
     oAuthSuccessRedirectUri?: string;
+    /**
+     * Custom URI where users should be sent on OAuth failure. See
+     * https://prismatic.io/docs/integrations/connections/oauth2/custom-redirects/
+     */
     oAuthFailureRedirectUri?: string;
 }
 interface OAuth2AuthorizationCodeConnectionDefinition extends BaseConnectionDefinition {
     oauth2Type: OAuth2Type.AuthorizationCode;
     oauth2Config?: OAuth2Config & OAuth2UrlOverrides;
-    /** The PKCE method (S256 or plain) that this OAuth 2.0 connection uses (if any) */
+    /**
+     * The PKCE method (S256 or plain) that this OAuth 2.0 connection uses (if any). See
+     * https://prismatic.io/docs/custom-connectors/connections/#supporting-pkce-with-oauth-20
+     */
     oauth2PkceMethod?: OAuth2PkceMethod;
-    inputs: {
-        authorizeUrl: ConnectionInput;
-        tokenUrl: ConnectionInput;
-        scopes: ConnectionInput;
-        clientId: ConnectionInput;
-        clientSecret: ConnectionInput;
+    inputs: OAuth2AuthorizationCodeInputs & {
         [key: string]: ConnectionInput;
     };
 }
 interface OAuth2ClientCredentialConnectionDefinition extends BaseConnectionDefinition {
     oauth2Type: OAuth2Type.ClientCredentials;
     oauth2Config?: OAuth2UrlOverrides;
-    inputs: {
-        tokenUrl: ConnectionInput;
-        scopes: ConnectionInput;
-        clientId: ConnectionInput;
-        clientSecret: ConnectionInput;
+    inputs: OAuth2ClientCredentialInputs & {
         [key: string]: ConnectionInput;
     };
 }

package/dist/types/ConnectionDefinition.js

@@ -1,9 +1,22 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OAuth2PkceMethod = exports.OAuth2Type = void 0;
+exports.templateConnectionInputs = templateConnectionInputs;
+const merge_1 = __importDefault(require("lodash/merge"));
 var OAuth2Type;
 (function (OAuth2Type) {
+    /**
+     * This connection uses the OAuth 2.0 client credentials flow. See
+     * https://prismatic.io/docs/integrations/connections/oauth2/client-credentials-grant-type/
+     */
     OAuth2Type["ClientCredentials"] = "client_credentials";
+    /**
+     * This connection uses the OAuth 2.0 auth code flow. See
+     * https://prismatic.io/docs/integrations/connections/oauth2/authorization-code-grant-type/
+     */
     OAuth2Type["AuthorizationCode"] = "authorization_code";
 })(OAuth2Type || (exports.OAuth2Type = OAuth2Type = {}));
 var OAuth2PkceMethod;
@@ -11,3 +24,6 @@ var OAuth2PkceMethod;
     OAuth2PkceMethod["Plain"] = "plain";
     OAuth2PkceMethod["S256"] = "S256";
 })(OAuth2PkceMethod || (exports.OAuth2PkceMethod = OAuth2PkceMethod = {}));
+function templateConnectionInputs(inputs, templateInputs, _authType) {
+    return (0, merge_1.default)(inputs, templateInputs);
+}

package/dist/types/CustomerAttributes.d.ts

@@ -1,6 +1,12 @@
 /** Contains attributes of the Customer for whom an Instance is being executed. */
 export interface CustomerAttributes {
+    /** The programmatic ID of a customer. */
     id: string;
+    /**
+     * The external ID you set for a customer. See
+     * https://prismatic.io/docs/customers/managing-customers/#customer-external-ids
+     */
     externalId: string;
+    /** The name of the customer. */
     name: string;
 }

package/dist/types/DataPayload.d.ts

@@ -1,9 +1,9 @@
-/** Binary data payload */
+/** Binary data payload. */
 export interface DataPayload {
-    /** Raw binary data as a Buffer */
+    /** Raw binary data as a Buffer. */
     data: Buffer;
-    /** Content type of data contained within this payload */
+    /** Content type of data contained within this payload. */
     contentType: string;
-    /** Suggested extension to use when writing the data */
+    /** Suggested extension to use when writing the data. */
     suggestedExtension?: string;
 }

package/dist/types/DataSourceDefinition.d.ts

@@ -1,19 +1,23 @@
 import { ActionDisplayDefinition, DataSourcePerformFunction, Inputs, DataSourceType, ConfigVarResultCollection } from ".";
 /**
  * DataSourceDefinition is the type of the object that is passed in to `dataSource` function to
- * define a component Data Source.
+ * define a data source. See
+ * https://prismatic.io/docs/custom-connectors/data-sources/
  */
 export interface DataSourceDefinition<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TDataSourceType extends DataSourceType> {
-    /** Defines how the Data Source is displayed in the Prismatic interface. */
+    /** Defines how the data source is displayed in the Prismatic UI. */
     display: ActionDisplayDefinition;
-    /** Function to perform when this Data Source is invoked; fetches data from the data source. */
+    /** Function to perform when this data source is invoked; fetches data from an external API and returns data to be presented in an integration config wizard UI. */
     perform: DataSourcePerformFunction<TInputs, TConfigVars, TDataSourceType>;
-    /** The type of data that this Data Source represents. */
+    /** The type of UI that will present the data the `perform` function returns. */
     dataSourceType: TDataSourceType;
-    /** InputFields to present in the Prismatic interface for configuration of this Data Source. */
+    /**
+     * 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;
-    /** An example of the payload outputted by this Data Source. */
+    /** An example of the payload outputted by this data source. Must match the type of the object that the `perform` function returns. */
     examplePayload?: Awaited<ReturnType<this["perform"]>>;
-    /** Specifies the name of a Data Source in this Component which can provide additional details about the content for this Data Source, such as example values when selecting particular API object fields. */
+    /** Specifies the name of a data source in this component which can provide additional details about the content for this data source, such as example values when selecting particular API object fields. */
     detailDataSource?: string;
 }

package/dist/types/DataSourcePerformFunction.d.ts

@@ -1,5 +1,5 @@
 import { Inputs, DataSourceResult, DataSourceType, ActionInputParameters, ConfigVarResultCollection, ActionContext } from ".";
-/** Context provided to perform method containing helpers and contextual data */
+/** Context provided to perform method containing helpers and contextual data. */
 export type DataSourceContext<TConfigVars extends ConfigVarResultCollection = ConfigVarResultCollection> = Pick<ActionContext<TConfigVars>, "logger" | "customer" | "instance" | "user" | "configVars">;
 /** Definition of the function to perform when a Data Source is invoked. */
 export type DataSourcePerformFunction<TInputs extends Inputs, TConfigVars extends ConfigVarResultCollection, TDataSourceType extends DataSourceType> = (context: DataSourceContext<TConfigVars>, params: ActionInputParameters<TInputs>) => Promise<DataSourceResult<TDataSourceType>>;

package/dist/types/FlowAttributes.d.ts

@@ -1,5 +1,7 @@
 /** Contains attributes of the Flow that is being executed. */
 export interface FlowAttributes {
+    /** The ID of the currently running flow. */
     id: string;
+    /** The name of the currently running flow. */
     name: string;
 }

package/dist/types/HttpResponse.d.ts

@@ -1,9 +1,16 @@
 /** Represents an HTTP Response, which are required for some Triggers. */
 export interface HttpResponse {
+    /**
+     * HTTP status code to return from a trigger. See
+     * https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status.
+     */
     statusCode: number;
+    /** The MIME type (`content-type` header) of the trigger's response. */
     contentType: string;
+    /** Custom headers to return in the trigger's response. */
     headers?: {
         [key: string]: string;
     };
+    /** The trigger's response body. When omitted, defaults to `{ "executionId": "SOME-ID" }` */
     body?: string;
 }