@prismatic-io/spectral 10.5.2 → 10.5.4

package/dist/serverTypes/convertComponent.d.ts

@@ -1,8 +1,16 @@
-import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, TriggerDefinition, ComponentHooks, ConfigVarResultCollection, OnPremConnectionInput, TriggerPayload, ConnectionTemplateInputField } from "../types";
+import { InputFieldDefinition, ComponentDefinition, ConnectionDefinition, TriggerDefinition, ComponentHooks, ConfigVarResultCollection, OnPremConnectionInput, TriggerPayload, ConnectionTemplateInputField, ConnectionInput } from "../types";
 import { Component as ServerComponent, Connection as ServerConnection, Trigger as ServerTrigger, Input as ServerInput } from ".";
 import { PollingTriggerDefinition } from "../types/PollingTriggerDefinition";
 export declare const convertInput: (key: string, { default: defaultValue, type, label, collection, ...rest }: InputFieldDefinition | OnPremConnectionInput) => ServerInput;
-export declare const convertTemplateInput: (key: string, { templateValue, label, ...rest }: ConnectionTemplateInputField) => ServerInput;
+export declare const _isValidTemplateValue: (template: string, inputs: {
+    [key: string]: ConnectionInput | ConnectionTemplateInputField;
+}) => {
+    isValid: boolean;
+    error?: string;
+};
+export declare const convertTemplateInput: (key: string, { templateValue, label, ...rest }: ConnectionTemplateInputField, inputs: {
+    [key: string]: ConnectionInput | ConnectionTemplateInputField;
+}) => ServerInput;
 export declare const convertTrigger: (triggerKey: string, trigger: TriggerDefinition<any> | PollingTriggerDefinition<any, ConfigVarResultCollection, TriggerPayload, boolean, any, any>, hooks?: ComponentHooks) => ServerTrigger;
 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

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertTemplateInput = exports.convertInput = void 0;
+exports.convertComponent = exports.convertConnection = exports.convertTrigger = exports.convertTemplateInput = exports._isValidTemplateValue = exports.convertInput = void 0;
 const types_1 = require("../types");
 const perform_1 = require("./perform");
 const omit_1 = __importDefault(require("lodash/omit"));
@@ -31,8 +31,42 @@ const convertInput = (key, _a) => {
         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 convertTemplateInput = (key, _a) => {
+const TEMPLATE_VALUE_REGEX = /{{#(\w+)}}/g;
+const TEMPLATE_VALUE_ERRORS = {
+    NO_SLOTS: "No template slots were found. Declare a template slot with this notation: {{#someInputKey}}",
+    INVALID_KEYS: "Invalid keys were found in the template string. All referenced keys must be non-template inputs declared in the first argument:",
+};
+const _isValidTemplateValue = (template, inputs) => {
+    const matches = [...template.matchAll(TEMPLATE_VALUE_REGEX)];
+    if (matches.length === 0) {
+        return {
+            isValid: false,
+            error: TEMPLATE_VALUE_ERRORS.NO_SLOTS,
+        };
+    }
+    const invalidKeys = [];
+    for (const [_substr, key] of matches) {
+        if (!inputs[key] || inputs[key].type === "template") {
+            invalidKeys.push(key);
+        }
+    }
+    if (invalidKeys.length > 0) {
+        return {
+            isValid: false,
+            error: `${TEMPLATE_VALUE_ERRORS.INVALID_KEYS} ${invalidKeys}`,
+        };
+    }
+    return {
+        isValid: true,
+    };
+};
+exports._isValidTemplateValue = _isValidTemplateValue;
+const convertTemplateInput = (key, _a, inputs) => {
     var { templateValue, label } = _a, rest = __rest(_a, ["templateValue", "label"]);
+    const validation = (0, exports._isValidTemplateValue)(templateValue, inputs);
+    if (!validation.isValid) {
+        throw `Template input "${key}": ${validation.error}`;
+    }
     return Object.assign(Object.assign({}, (0, omit_1.default)(rest, ["permissionAndVisibilityType", "visibleToOrgDeployer", "writeOnly"])), { key, type: "template", default: templateValue !== null && templateValue !== void 0 ? templateValue : "", label: typeof label === "string" ? label : label.value, shown: false });
 };
 exports.convertTemplateInput = convertTemplateInput;
@@ -122,7 +156,7 @@ const convertConnection = (_a) => {
     const { display: { label, icons, description: comments } } = connection, remaining = __rest(connection, ["display"]);
     const convertedInputs = Object.entries(inputs).map(([key, value]) => {
         if ("templateValue" in value) {
-            return (0, exports.convertTemplateInput)(key, value);
+            return (0, exports.convertTemplateInput)(key, value, inputs);
         }
         return (0, exports.convertInput)(key, value);
     });

package/dist/serverTypes/convertIntegration.js

@@ -392,7 +392,8 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
                 component: codeNativeIntegrationComponentReference(referenceKey),
             },
             inputs: Object.entries(configVar.inputs).reduce((result, [key, input]) => {
-                if (input.shown === false) {
+                // Connection template inputs are never shown in the resulting YAML.
+                if (input.shown === false || "templateValue" in input) {
                     return result;
                 }
                 const meta = convertInputPermissionAndVisibility((0, pick_1.default)(input, ["permissionAndVisibilityType", "visibleToOrgDeployer"]));
@@ -666,7 +667,12 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
         if (!(0, types_1.isConnectionDefinitionConfigVar)(configVar)) {
             return result;
         }
-        const convertedInputs = Object.entries(configVar.inputs).map(([key, value]) => (0, convertComponent_1.convertInput)(key, value));
+        const convertedInputs = Object.entries(configVar.inputs).map(([key, value]) => {
+            if ("templateValue" in value) {
+                return (0, convertComponent_1.convertTemplateInput)(key, value, configVar.inputs);
+            }
+            return (0, convertComponent_1.convertInput)(key, value);
+        });
         const connection = (0, pick_1.default)(configVar, ["oauth2Type", "oauth2PkceMethod"]);
         const { avatarPath: avatarIconPath, oauth2ConnectionIconPath: iconPath } = (_a = configVar.icons) !== null && _a !== void 0 ? _a : {};
         return [

package/package.json

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