@prismatic-io/spectral 8.1.5 → 8.1.6

package/dist/index.d.ts

@@ -3,7 +3,7 @@
  * authors create inputs, actions, and components that can
  * be processed by the Prismatic API.
  */
-import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, ConfigPages, OnPremiseConnectionDefinition, ScheduleConfigVar, ComponentSelector } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, ConfigPages, OnPremConnectionDefinition, ScheduleConfigVar, ComponentSelector } from "./types";
 import { convertComponent } from "./serverTypes/convert";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
@@ -128,10 +128,10 @@ export declare const connection: <T extends DefaultConnectionDefinition>(definit
 /**
  * For information on writing custom component connections using on-premise resources, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.
- * @param definition An OnPremiseConnectionDefinition 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.
+ * @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 onPremiseConnection: <T extends OnPremiseConnectionDefinition>(definition: T) => T;
+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.

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testing = exports.util = exports.oauth2Connection = exports.onPremiseConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.reference = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.reference = exports.configPage = exports.flow = exports.integration = void 0;
 const convert_1 = require("./serverTypes/convert");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -153,11 +153,11 @@ 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.
- * @param definition An OnPremiseConnectionDefinition 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.
+ * @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 onPremiseConnection = (definition) => definition;
-exports.onPremiseConnection = onPremiseConnection;
+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.

package/dist/serverTypes/convert.d.ts

@@ -1,4 +1,4 @@
-import { InputFieldDefinition, ComponentDefinition } from "../types";
+import { InputFieldDefinition, ComponentDefinition, OnPremConnectionInput } from "../types";
 import { Component as ServerComponent, Input as ServerInput } from ".";
-export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition) => ServerInput;
+export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput) => ServerInput;
 export declare const convertComponent: <TPublic extends boolean, TKey extends string>({ connections, actions, triggers, dataSources, hooks, ...definition }: ComponentDefinition<TPublic, TKey>) => ServerComponent;

package/dist/serverTypes/convert.js

@@ -14,13 +14,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertComponent = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
+const lodash_1 = require("lodash");
 const convertInput = (key, _a) => {
     var { default: defaultValue, type, label, collection } = _a, rest = __rest(_a, ["default", "type", "label", "collection"]);
     const keyLabel = collection === "keyvaluelist" && typeof label === "object"
         ? label.key
         : undefined;
-    return Object.assign(Object.assign({}, rest), { key,
-        type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel });
+    return Object.assign(Object.assign({}, (0, lodash_1.omit)(rest, ["onPremControlled"])), { key,
+        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 convertAction = (actionKey, _a, hooks) => {

package/dist/serverTypes/index.d.ts

@@ -174,7 +174,7 @@ export interface Connection {
     iconPath?: string;
     inputs: (Input & {
         shown?: boolean;
-        onPremiseControlled?: boolean;
+        onPremControlled?: boolean;
     })[];
 }
 export interface ConnectionValue {
@@ -235,4 +235,5 @@ export interface Input {
     required?: boolean;
     model?: InputFieldChoice[];
     language?: string;
+    onPremiseControlled?: boolean;
 }

package/dist/types/ConnectionDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ConnectionInput } from ".";
+import { ConnectionInput, OnPremConnectionInput } from ".";
 export declare enum OAuth2Type {
     ClientCredentials = "client_credentials",
     AuthorizationCode = "authorization_code"
@@ -19,13 +19,10 @@ export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
         [key: string]: ConnectionInput;
     };
 }
-declare type OnPremiseConnectionInput = ConnectionInput & {
-    onPremiseControlled: true;
-};
-export interface OnPremiseConnectionDefinition extends BaseConnectionDefinition {
+export interface OnPremConnectionDefinition extends BaseConnectionDefinition {
     inputs: {
-        host: OnPremiseConnectionInput;
-        port: OnPremiseConnectionInput;
+        host: OnPremConnectionInput;
+        port: OnPremConnectionInput;
         [key: string]: ConnectionInput;
     };
 }
@@ -53,5 +50,5 @@ interface OAuth2ClientCredentialConnectionDefinition extends BaseConnectionDefin
     };
 }
 export declare type OAuth2ConnectionDefinition = OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition;
-export declare type ConnectionDefinition = DefaultConnectionDefinition | OnPremiseConnectionDefinition | OAuth2ConnectionDefinition;
+export declare type ConnectionDefinition = DefaultConnectionDefinition | OnPremConnectionDefinition | OAuth2ConnectionDefinition;
 export {};

package/dist/types/Inputs.d.ts

@@ -67,6 +67,9 @@ export declare type Inputs = Record<string, InputFieldDefinition>;
 export declare type ConnectionInput = (StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField) & {
     shown?: boolean;
 };
+export declare type OnPremConnectionInput = ConnectionInput & {
+    onPremControlled: true;
+};
 export declare type InputFieldDefinition = StringInputField | DataInputField | TextInputField | PasswordInputField | BooleanInputField | CodeInputField | ConditionalInputField | ConnectionInputField | ObjectSelectionInputField | ObjectFieldMapInputField | JSONFormInputField | DynamicObjectSelectionInputField | DynamicFieldSelectionInputField;
 export declare type InputCleanFunction<TValue, TResult = TValue> = (value: TValue) => TResult;
 interface BaseInputField {

package/package.json

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