@prismatic-io/spectral 8.0.2 → 8.0.4

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 } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, ConfigPages, OnPremiseConnectionDefinition } from "./types";
 import { convertComponent } from "./serverTypes/convert";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
@@ -118,6 +118,13 @@ export declare const input: <T extends InputFieldDefinition>(definition: T) => T
  * @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.
+ * @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.
+ * @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;
 /**
  * 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.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
+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.configPage = exports.flow = exports.integration = void 0;
 const convert_1 = require("./serverTypes/convert");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -135,6 +135,14 @@ exports.input = input;
  */
 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.
+ * @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.
+ * @returns This function validates the shape of the `definition` object provided and returns the same connection object.
+ */
+const onPremiseConnection = (definition) => definition;
+exports.onPremiseConnection = onPremiseConnection;
 /**
  * For information on writing custom component connections, see
  * https://prismatic.io/docs/custom-components/writing-custom-components/#adding-connections.

package/dist/serverTypes/convertIntegration.js

@@ -215,8 +215,9 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
         if (!(0, types_1.isDataSourceConfigVar)(configVar)) {
             return result;
         }
+        const camelKey = (0, lodash_1.camelCase)(key);
         const dataSource = (0, lodash_1.pick)(configVar, ["perform", "dataSourceType"]);
-        return Object.assign(Object.assign({}, result), { [key]: Object.assign(Object.assign({}, dataSource), { key: (0, lodash_1.camelCase)(key), display: {
+        return Object.assign(Object.assign({}, result), { [camelKey]: Object.assign(Object.assign({}, dataSource), { key: camelKey, display: {
                     label: key,
                     description: key,
                 }, inputs: [] }) });

package/dist/serverTypes/index.d.ts

@@ -174,6 +174,7 @@ export interface Connection {
     iconPath?: string;
     inputs: (Input & {
         shown?: boolean;
+        onPremiseControlled?: boolean;
     })[];
 }
 export interface ConnectionValue {

package/dist/types/ConnectionDefinition.d.ts

@@ -19,6 +19,16 @@ export interface DefaultConnectionDefinition extends BaseConnectionDefinition {
         [key: string]: ConnectionInput;
     };
 }
+declare type OnPremiseConnectionInput = ConnectionInput & {
+    onPremiseControlled: true;
+};
+export interface OnPremiseConnectionDefinition extends BaseConnectionDefinition {
+    inputs: {
+        host: OnPremiseConnectionInput;
+        port: OnPremiseConnectionInput;
+        [key: string]: ConnectionInput;
+    };
+}
 interface OAuth2AuthorizationCodeConnectionDefinition extends BaseConnectionDefinition {
     oauth2Type: OAuth2Type.AuthorizationCode;
     /** The PKCE method (S256 or plain) that this OAuth 2.0 connection uses (if any) */
@@ -43,5 +53,5 @@ interface OAuth2ClientCredentialConnectionDefinition extends BaseConnectionDefin
     };
 }
 export declare type OAuth2ConnectionDefinition = OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition;
-export declare type ConnectionDefinition = DefaultConnectionDefinition | OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition;
+export declare type ConnectionDefinition = DefaultConnectionDefinition | OnPremiseConnectionDefinition | OAuth2ConnectionDefinition;
 export {};

package/package.json

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