@prismatic-io/spectral 10.13.0 → 10.14.0

package/dist/serverTypes/convertIntegration.js

@@ -417,6 +417,22 @@ const convertInputValue = (value, collectionType) => {
     }));
 };
 exports.convertInputValue = convertInputValue;
+const validateOnPremConnectionConfig = (connection) => {
+    if ((0, types_1.isConnectionDefinitionConfigVar)(connection)) {
+        const hasOnPremControlledInputs = Object.values(connection.inputs).some((value) => {
+            return "onPremControlled" in value && value.onPremControlled;
+        });
+        const { onPremConnectionConfig: config } = connection;
+        if (hasOnPremControlledInputs && !config) {
+            throw new Error(`Connection ${connection.stableKey} has onPremControlled inputs but no onPremConnectionConfig value set. Please set an onPremConnectionConfig value for the connection.`);
+        }
+        if (!hasOnPremControlledInputs && config && config !== "disallowed") {
+            throw new Error(`Connection ${connection.stableKey} has onPremConnectionConfig set but no onPremControlled inputs. The connection will not be valid without onPremControlled inputs (host, port).`);
+        }
+        return hasOnPremControlledInputs && config ? config : "disallowed";
+    }
+    return "disallowed";
+};
 /** Converts a Config Var into the structure necessary for YAML generation. */
 const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
     var _a, _b, _c;
@@ -437,6 +453,7 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
             description,
             key,
             dataType: "connection",
+            onPremiseConnectionConfig: validateOnPremConnectionConfig(configVar),
             connection: {
                 key: (0, camelCase_1.default)(key),
                 component: codeNativeIntegrationComponentReference(referenceKey),

package/dist/types/ConfigVars.d.ts

@@ -169,13 +169,14 @@ export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceRefe
 type BaseConnectionConfigVar = BaseConfigVar & {
     dataType: "connection";
 };
+export type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
 type ConnectionDefinitionConfigVar = ConnectionDefinition extends infer TConnectionDefinitionType extends ConnectionDefinition ? TConnectionDefinitionType extends infer TConnectionDefinition extends ConnectionDefinition ? BaseConnectionConfigVar & Omit<TConnectionDefinition, "inputs" | "display" | "key"> & {
     icons?: TConnectionDefinition["display"]["icons"];
+    onPremConnectionConfig?: OnPremiseConnectionConfigTypeEnum;
     inputs: {
         [Key in keyof TConnectionDefinition["inputs"]]: TConnectionDefinition["inputs"][Key] & ConfigVarInputVisibility;
     };
 } : never : never;
-type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
 type ConnectionReferenceConfigVar = ComponentRegistryConnection extends infer TConnectionReference ? TConnectionReference extends ComponentRegistryConnection ? BaseConnectionConfigVar & {
     connection: TConnectionReference["reference"] & ("onPremAvailable" extends keyof TConnectionReference ? TConnectionReference["onPremAvailable"] extends true ? {
         template?: string;

package/package.json

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