@prismatic-io/spectral 5.0.0-rc.0 → 5.0.0-rc.1

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  * Both component author-facing types and server types that
  * the Prismatic API expects are imported here.
  */
-import { ActionDefinition, InputFieldDefinition, ActionPerformReturn, ComponentDefinition, ConnectionFieldDefinition, Inputs, TriggerDefinition, TriggerResult } from "./types";
+import { ActionDefinition, InputFieldDefinition, ActionPerformReturn, ComponentDefinition, ConnectionDefinition, Inputs, TriggerDefinition, TriggerResult } from "./types";
 import { Component } from "./types/server-types";
 /**
  * This function creates a component object that can be
@@ -52,9 +52,7 @@ export declare const input: <T extends InputFieldDefinition>(definition: T) => T
  * @param definition A ConnectionfieldDefinition 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 Omit<ConnectionFieldDefinition, "type">>(definition: T) => T & {
-    type: "connection";
-};
+export declare const connection: <T extends ConnectionDefinition>(definition: T) => T;
 export { default as util } from "./util";
 export * from "./types";
 export { default as testing } from "./testing";

package/dist/index.js

@@ -19,13 +19,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testing = exports.util = exports.connection = exports.input = exports.trigger = exports.action = exports.component = void 0;
-const convertInput = (key, input) => {
-    var _a;
-    if ("inputs" in input) {
-        return Object.assign(Object.assign({}, input), { key, inputs: Object.entries((_a = input.inputs) !== null && _a !== void 0 ? _a : {}).map(([key, value]) => convertInput(key, value)) });
-    }
-    return Object.assign(Object.assign({}, input), { key });
-};
+const convertInput = (key, input) => (Object.assign(Object.assign({}, input), { key }));
 /**
  * This is a helper function for component() to convert an
  * action defined in TypeScript into an action object that
@@ -50,9 +44,9 @@ const convertTrigger = (triggerKey, trigger) => {
     var _a;
     return (Object.assign(Object.assign({}, trigger), { key: triggerKey, inputs: Object.entries((_a = trigger.inputs) !== null && _a !== void 0 ? _a : {}).map(([key, value]) => convertInput(key, value)), perform: trigger.perform, examplePayload: trigger.examplePayload || undefined }));
 };
-const convertConnection = (connectionKey, connection) => {
+const convertConnection = (connection) => {
     var _a;
-    return (Object.assign(Object.assign({}, connection), { key: connectionKey, inputs: Object.entries((_a = connection.inputs) !== null && _a !== void 0 ? _a : {}).map(([key, value]) => convertInput(key, value)) }));
+    return (Object.assign(Object.assign({}, connection), { inputs: Object.entries((_a = connection.inputs) !== null && _a !== void 0 ? _a : {}).map(([key, value]) => convertInput(key, value)) }));
 };
 /**
  * This function creates a component object that can be
@@ -68,10 +62,7 @@ const component = (definition) => (Object.assign(Object.assign({}, definition),
     ])), triggers: Object.fromEntries(Object.entries(definition.triggers || {}).map(([triggerKey, trigger]) => [
         triggerKey,
         convertTrigger(triggerKey, trigger),
-    ])), connections: Object.fromEntries(Object.entries(definition.connections || {}).map(([connectionKey, connection]) => [
-        connectionKey,
-        convertConnection(connectionKey, connection),
-    ])) }));
+    ])), connections: (definition.connections || []).map(convertConnection) }));
 exports.component = component;
 /**
  * This function creates an action object that can be referenced
@@ -110,7 +101,7 @@ exports.input = input;
  * @param definition A ConnectionfieldDefinition 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) => (Object.assign(Object.assign({}, definition), { type: "connection" }));
+const connection = (definition) => definition;
 exports.connection = connection;
 var util_1 = require("./util");
 Object.defineProperty(exports, "util", { enumerable: true, get: function () { return __importDefault(util_1).default; } });

package/dist/testing.d.ts

@@ -5,8 +5,8 @@
  * https://prismatic.io/docs/custom-components/writing-custom-components/#testing-a-component
  */
 /** */
-import { ActionContext, ActionLogger, ActionDefinition, ActionInputParameters, ConnectionFieldDefinition, Connection, ActionPerformReturn, Inputs, TriggerDefinition, TriggerResult, TriggerPayload } from "./types";
-export declare const createConnection: <T extends ConnectionFieldDefinition>({ connectionKey }: T, values: { [Property in keyof T["inputs"]]: unknown; }) => Connection<T>;
+import { ActionContext, ActionLogger, ActionDefinition, ActionInputParameters, ConnectionDefinition, Connection, ActionPerformReturn, Inputs, TriggerDefinition, TriggerResult, TriggerPayload } from "./types";
+export declare const createConnection: <T extends ConnectionDefinition>({ key }: T, values: Record<string, unknown>) => Connection;
 /**
  * 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.

package/dist/testing.js

@@ -17,9 +17,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.invokeTrigger = exports.defaultTriggerPayload = exports.invoke = exports.loggerMock = exports.createConnection = void 0;
 const jest_mock_1 = require("jest-mock");
-const createConnection = ({ connectionKey }, values) => ({
+const createConnection = ({ key }, values) => ({
     instanceConfigVarId: "",
-    key: connectionKey,
+    key,
     fields: values,
 });
 exports.createConnection = createConnection;

package/dist/types/ActionInputParameters.d.ts

@@ -1,12 +1,12 @@
-import { InputFieldDefinition, Inputs, InputFieldTypeMap, Connection, ConnectionFieldDefinition } from ".";
+import { InputFieldDefinition, Inputs, InputFieldTypeMap } from ".";
 /**
  * Collection of input parameters.
  * Inputs can be static values, references to config variables, or
  * references to previous steps' outputs.
  */
-export declare type ActionInputParameters<TInputs extends Inputs> = {
-    [Property in keyof TInputs]: TInputs[Property] extends ConnectionFieldDefinition ? Connection<TInputs[Property]> : ExtractValue<TInputs[Property]>;
-};
+export declare type ActionInputParameters<TInputs extends Inputs> = TInputs extends Record<string, InputFieldDefinition> ? {
+    [Property in keyof TInputs]: ExtractValue<TInputs[Property]>;
+} : never;
 export declare type ExtractValue<TValue extends InputFieldDefinition> = MapCollectionValues<InputFieldTypeMap[TValue["type"]], TValue["collection"]>;
 export declare type MapCollectionValues<TType, TCollection extends InputFieldDefinition["collection"] | undefined> = TCollection extends "keyvaluelist" ? KeyValuePair<TType>[] | undefined : TCollection extends "valuelist" ? TType[] | undefined : TType;
 /**

package/dist/types/ComponentDefinition.d.ts

@@ -1,7 +1,7 @@
 import { Component } from "./server-types";
-import { ActionPerformReturn, ActionDefinition, TriggerDefinition, TriggerResult, ConnectionFieldDefinition } from ".";
+import { ActionPerformReturn, ActionDefinition, ConnectionDefinition, TriggerDefinition, TriggerResult } from ".";
 export declare type ComponentDefinition<T extends boolean> = Omit<Component<T>, "actions" | "triggers" | "connections"> & {
     actions?: Record<string, ActionDefinition<any, boolean, ActionPerformReturn<boolean, any>>>;
     triggers?: Record<string, TriggerDefinition<any, boolean, TriggerResult<boolean>>>;
-    connections?: Record<string, ConnectionFieldDefinition>;
+    connections?: ConnectionDefinition[];
 };

package/dist/types/ConnectionDefinition.d.ts

@@ -0,0 +1,9 @@
+import { ConnectionInputs, OAuth2Type } from ".";
+export interface ConnectionDefinition {
+    key: string;
+    label: string;
+    comments?: string;
+    oauth2Type?: OAuth2Type;
+    iconPath?: string;
+    inputs: ConnectionInputs;
+}

package/dist/types/ConnectionDefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/InputFieldType.d.ts

@@ -1,3 +1,4 @@
+import { Connection } from ".";
 import { ConditionalExpression } from "./conditional-logic";
 /** InputField type enumeration. */
 export declare type InputFieldType = keyof InputFieldTypeMap;
@@ -9,5 +10,5 @@ export declare type InputFieldTypeMap = {
     boolean: unknown;
     code: unknown;
     conditional: ConditionalExpression;
-    connection: never;
+    connection: Connection;
 };

package/dist/types/Inputs.d.ts

@@ -3,7 +3,7 @@ export declare type Inputs = Record<string, InputFieldDefinition>;
 export declare type ConnectionInputs = Record<string, DefaultInputFieldDefinition & {
     shown?: boolean;
 }>;
-export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition | ConnectionFieldDefinition;
+export declare type InputFieldDefinition = DefaultInputFieldDefinition | CodeInputFieldDefinition;
 interface BaseInputFieldDefinition {
     /** Interface label of the InputField. */
     label: string;
@@ -24,7 +24,7 @@ interface BaseInputFieldDefinition {
 }
 /** Defines attributes of a InputField. */
 export interface DefaultInputFieldDefinition extends BaseInputFieldDefinition {
-    type: Exclude<InputFieldType, "code" | "connection">;
+    type: Exclude<InputFieldType, "code">;
 }
 /** Defines attributes of a CodeInputField. */
 export interface CodeInputFieldDefinition extends BaseInputFieldDefinition {
@@ -35,22 +35,14 @@ export declare enum OAuth2Type {
     ClientCredentials = "client_credentials",
     AuthorizationCode = "authorization_code"
 }
-/** Defines attributes of a ConnectionField. */
-export interface ConnectionFieldDefinition extends BaseInputFieldDefinition {
-    type: Extract<InputFieldType, "connection">;
-    connectionKey: string;
-    oauth2Type?: OAuth2Type;
-    iconPath?: string;
-    inputs: ConnectionInputs;
-}
-export interface Connection<TField extends ConnectionFieldDefinition = ConnectionFieldDefinition> {
+export interface Connection {
     /** Key of the Connection type. */
-    key: TField["connectionKey"];
+    key: string;
     /** Identifier for the Config Variable hosting this Connection. */
     instanceConfigVarId: string;
     /** Field values supplied to this Connection. */
     fields: {
-        [Property in keyof TField["inputs"]]: unknown;
+        [key: string]: unknown;
     };
     token?: Record<string, unknown>;
     context?: Record<string, unknown>;

package/dist/types/index.d.ts

@@ -4,6 +4,7 @@
  */
 export * from "./ActionDefinition";
 export * from "./ComponentDefinition";
+export * from "./ConnectionDefinition";
 export * from "./Inputs";
 export * from "./ActionPerformReturn";
 export * from "./DisplayDefinition";

package/dist/types/index.js

@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serverTypes = void 0;
 __exportStar(require("./ActionDefinition"), exports);
 __exportStar(require("./ComponentDefinition"), exports);
+__exportStar(require("./ConnectionDefinition"), exports);
 __exportStar(require("./Inputs"), exports);
 __exportStar(require("./ActionPerformReturn"), exports);
 __exportStar(require("./DisplayDefinition"), exports);

package/dist/types/server-types.d.ts

@@ -26,7 +26,7 @@ interface ComponentBase<TPublic extends boolean> {
     /** Specifies the supported Triggers of this Component. */
     triggers?: Record<string, Trigger>;
     /** Specifies the supported Connections of this Component. */
-    connections?: Record<string, ConnectionField>;
+    connections?: Connection[];
 }
 export declare type Component<TPublic extends boolean> = ComponentBase<TPublic> & (TPublic extends true ? {
     /** Specified the URL for the Component Documentation. */
@@ -72,6 +72,16 @@ export interface Trigger extends BaseAction {
     /** Specifies if this Trigger appears in the list of 'common' Triggers. Only configurable by Prismatic. @default false */
     isCommonTrigger?: boolean;
 }
+export interface Connection {
+    key: string;
+    label: string;
+    comments?: string;
+    oauth2Type?: OAuth2Type;
+    iconPath?: string;
+    inputs: (InputField & {
+        shown?: boolean;
+    })[];
+}
 /** Collection of input parameters provided by the user or previous steps' outputs */
 interface ActionInputParameters {
     [key: string]: unknown;
@@ -116,7 +126,7 @@ export declare type TriggerResult = TriggerBranchingResult | TriggerBaseResult |
 /** Definition of the function to perform when a Trigger is invoked. */
 export declare type TriggerPerformFunction = (context: ActionContext, payload: TriggerPayload, params: ActionInputParameters) => Promise<TriggerResult>;
 export declare type TriggerPayload = _TriggerPayload;
-export declare type InputField = DefaultInputField | CodeInputField | ConnectionField;
+export declare type InputField = DefaultInputField | CodeInputField;
 /** Defines attributes of a InputField. */
 interface DefaultInputField {
     /** Unique identifier of the InputField. Must be unique within an Action. */
@@ -144,15 +154,6 @@ interface CodeInputField extends DefaultInputField {
     type: "code";
     language?: string;
 }
-export interface ConnectionField extends DefaultInputField {
-    type: "connection";
-    key: string;
-    oauth2Type?: OAuth2Type;
-    iconPath?: string;
-    inputs: (Exclude<InputField, ConnectionField> & {
-        shown?: boolean;
-    })[];
-}
 /** InputField type enumeration. */
 export declare type InputFieldType = "string" | "text" | "password" | "boolean" | "code" | "data" | "conditional" | "connection";
 /** Binary data payload */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "5.0.0-rc.0",
+  "version": "5.0.0-rc.1",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"