@prismatic-io/spectral 9.3.1 → 10.0.1

package/dist/serverTypes/convertComponent.d.ts

@@ -1,4 +1,5 @@
-import { InputFieldDefinition, ComponentDefinition, OnPremConnectionInput } from "../types";
-import { Component as ServerComponent, Input as ServerInput } from ".";
+import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, OnPremConnectionInput } from "../types";
+import { Component as ServerComponent, Connection as ServerConnection, Input as ServerInput } from ".";
 export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput) => ServerInput;
+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

@@ -11,7 +11,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertComponent = exports.convertInput = void 0;
+exports.convertComponent = exports.convertConnection = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
 const lodash_1 = require("lodash");
@@ -72,13 +72,16 @@ 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));
-    return Object.assign(Object.assign({}, connection), { inputs: convertedInputs });
+    const { display: { label, icons, description: comments } } = connection, remaining = __rest(connection, ["display"]);
+    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 });
 };
+exports.convertConnection = convertConnection;
 const convertComponent = (_a) => {
     var { connections = [], actions = {}, triggers = {}, dataSources = {}, hooks } = _a, definition = __rest(_a, ["connections", "actions", "triggers", "dataSources", "hooks"]);
     const convertedActions = Object.entries(actions).reduce((result, [actionKey, action]) => (Object.assign(Object.assign({}, result), { [actionKey]: convertAction(actionKey, action, hooks) })), {});
     const convertedTriggers = Object.entries(triggers).reduce((result, [triggerKey, trigger]) => (Object.assign(Object.assign({}, result), { [triggerKey]: convertTrigger(triggerKey, trigger, hooks) })), {});
     const convertedDataSources = Object.entries(dataSources).reduce((result, [dataSourceKey, dataSource]) => (Object.assign(Object.assign({}, result), { [dataSourceKey]: convertDataSource(dataSourceKey, dataSource, hooks) })), {});
-    return Object.assign(Object.assign({}, definition), { connections: connections.map(convertConnection), actions: convertedActions, triggers: convertedTriggers, dataSources: convertedDataSources });
+    return Object.assign(Object.assign({}, definition), { connections: connections.map(exports.convertConnection), actions: convertedActions, triggers: convertedTriggers, dataSources: convertedDataSources });
 };
 exports.convertComponent = convertComponent;

package/dist/serverTypes/convertIntegration.js

@@ -334,7 +334,7 @@ const convertInputValue = (value, collectionType) => {
 };
 /** Converts a Config Var into the structure necessary for YAML generation. */
 const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
-    var _a;
+    var _a, _b, _c;
     if ((0, types_1.isOrganizationActivatedConnectionConfigVar)(configVar)) {
         const { stableKey } = (0, lodash_1.pick)(configVar, ["stableKey"]);
         return {
@@ -387,7 +387,7 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
                     } });
             }, {}),
             orgOnly,
-            meta,
+            meta: Object.assign(Object.assign({}, meta), ("oauth2Config" in configVar ? (_a = configVar.oauth2Config) !== null && _a !== void 0 ? _a : {} : {})),
         };
     }
     if ((0, types_1.isConnectionReferenceConfigVar)(configVar)) {
@@ -402,7 +402,7 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
             connection: Object.assign(Object.assign({}, ref), { template }),
             inputs,
             orgOnly,
-            meta,
+            meta: Object.assign(Object.assign({}, meta), ("oauth2Config" in configVar ? (_b = configVar.oauth2Config) !== null && _b !== void 0 ? _b : {} : {})),
         };
     }
     const rawDefaultValue = "defaultValue" in configVar
@@ -426,7 +426,7 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
         result.scheduleType = "custom";
     }
     if ((0, types_1.isJsonFormConfigVar)(configVar) || (0, types_1.isJsonFormDataSourceConfigVar)(configVar)) {
-        result.meta = Object.assign(Object.assign({}, result.meta), { validationMode: (_a = configVar === null || configVar === void 0 ? void 0 : configVar.validationMode) !== null && _a !== void 0 ? _a : "ValidateAndShow" });
+        result.meta = Object.assign(Object.assign({}, result.meta), { validationMode: (_c = configVar === null || configVar === void 0 ? void 0 : configVar.validationMode) !== null && _c !== void 0 ? _c : "ValidateAndShow" });
     }
     if ((0, types_1.isDataSourceDefinitionConfigVar)(configVar)) {
         result.dataType = configVar.dataSourceType;
@@ -564,7 +564,11 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
             } });
     }, {});
     const convertedTriggers = flows.reduce((result, { name, onTrigger, onInstanceDeploy, onInstanceDelete, schedule }) => {
-        if (!flowUsesWrapperTrigger({ onTrigger, onInstanceDelete, onInstanceDeploy })) {
+        if (!flowUsesWrapperTrigger({
+            onTrigger,
+            onInstanceDelete,
+            onInstanceDeploy,
+        })) {
             // In this scenario, the user has defined an existing component trigger
             // without any custom behavior, so we don't need to wrap anything.
             return result;
@@ -614,14 +618,17 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
                 }, inputs: [] }) });
     }, {});
     const convertedConnections = Object.entries(configVars).reduce((result, [key, configVar]) => {
+        var _a;
         if (!(0, types_1.isConnectionDefinitionConfigVar)(configVar)) {
             return result;
         }
         const convertedInputs = Object.entries(configVar.inputs).map(([key, value]) => (0, convertComponent_1.convertInput)(key, value));
-        const connection = (0, lodash_1.pick)(configVar, ["oauth2Type", "iconPath"]);
+        const connection = (0, lodash_1.pick)(configVar, ["oauth2Type"]);
+        const { avatarPath: avatarIconPath, oauth2ConnectionIconPath: iconPath } = (_a = configVar.icons) !== null && _a !== void 0 ? _a : {};
         return [
             ...result,
-            Object.assign(Object.assign({}, connection), { inputs: convertedInputs, key: (0, lodash_1.camelCase)(key), label: key }),
+            Object.assign(Object.assign({}, connection), { iconPath,
+                avatarIconPath, inputs: convertedInputs, key: (0, lodash_1.camelCase)(key), label: key }),
         ];
     }, []);
     return {

package/dist/serverTypes/index.d.ts

@@ -176,6 +176,7 @@ export interface Connection {
     comments?: string;
     oauth2Type?: OAuth2Type;
     iconPath?: string;
+    avatarIconPath?: string;
     inputs: (Input & {
         shown?: boolean;
         onPremControlled?: boolean;

package/dist/types/ConfigVars.d.ts

@@ -141,7 +141,8 @@ export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceRefe
 type BaseConnectionConfigVar = BaseConfigVar & {
     dataType: "connection";
 };
-type ConnectionDefinitionConfigVar = ConnectionDefinition extends infer TConnectionDefinitionType extends ConnectionDefinition ? TConnectionDefinitionType extends infer TConnectionDefinition extends ConnectionDefinition ? BaseConnectionConfigVar & Omit<TConnectionDefinition, "inputs" | "label" | "comments" | "key"> & {
+type ConnectionDefinitionConfigVar = ConnectionDefinition extends infer TConnectionDefinitionType extends ConnectionDefinition ? TConnectionDefinitionType extends infer TConnectionDefinition extends ConnectionDefinition ? BaseConnectionConfigVar & Omit<TConnectionDefinition, "inputs" | "display" | "key"> & {
+    icons?: TConnectionDefinition["display"]["icons"];
     inputs: {
         [Key in keyof TConnectionDefinition["inputs"]]: TConnectionDefinition["inputs"][Key] & ConfigVarInputVisibility;
     };

package/dist/types/ConnectionDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { ConnectionInput, OnPremConnectionInput } from ".";
+import type { ConnectionDisplayDefinition, ConnectionInput, OnPremConnectionInput } from ".";
 export declare enum OAuth2Type {
     ClientCredentials = "client_credentials",
     AuthorizationCode = "authorization_code"
@@ -9,9 +9,7 @@ export declare enum OAuth2PkceMethod {
 }
 interface BaseConnectionDefinition {
     key: string;
-    label: string;
-    comments?: string;
-    iconPath?: string;
+    display: ConnectionDisplayDefinition;
     oauth2Type?: OAuth2Type;
 }
 export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
@@ -30,9 +28,13 @@ interface OAuth2Config {
     overrideGrantType?: string;
     allowedTokenParams?: string[];
 }
+export interface OAuth2UrlOverrides {
+    oAuthSuccessRedirectUri?: string;
+    oAuthFailureRedirectUri?: string;
+}
 interface OAuth2AuthorizationCodeConnectionDefinition extends BaseConnectionDefinition {
     oauth2Type: OAuth2Type.AuthorizationCode;
-    oauth2Config?: OAuth2Config;
+    oauth2Config?: OAuth2Config & OAuth2UrlOverrides;
     /** The PKCE method (S256 or plain) that this OAuth 2.0 connection uses (if any) */
     oauth2PkceMethod?: OAuth2PkceMethod;
     inputs: {
@@ -46,6 +48,7 @@ interface OAuth2AuthorizationCodeConnectionDefinition extends BaseConnectionDefi
 }
 interface OAuth2ClientCredentialConnectionDefinition extends BaseConnectionDefinition {
     oauth2Type: OAuth2Type.ClientCredentials;
+    oauth2Config?: OAuth2UrlOverrides;
     inputs: {
         tokenUrl: ConnectionInput;
         scopes: ConnectionInput;

package/dist/types/DisplayDefinition.d.ts

@@ -24,4 +24,13 @@ export interface ActionDisplayDefinition extends DisplayDefinition {
     /** Indicate that this Action is important and/or commonly used from the parent Component. Should be enabled sparingly. */
     important?: boolean;
 }
+/** Connection-specific Display attributes. */
+export interface ConnectionDisplayDefinition extends DisplayDefinition {
+    icons?: {
+        /** Path to icon to use for this Connection. Path should be relative to the built component source. */
+        avatarPath?: string;
+        /** Path to icon to use for this Connection's "Connect" button. Path should be relative to the built component source. */
+        oauth2ConnectionIconPath?: string;
+    };
+}
 export {};

package/package.json

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