@prismatic-io/spectral 9.0.0-rc.8 → 9.0.0

package/dist/generators/componentManifest/cli.js

@@ -17,6 +17,7 @@ exports.runMain = void 0;
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = require("fs-extra");
+const lodash_1 = require("lodash");
 const index_1 = require("./index");
 const createFlagHelpText_1 = require("../utils/createFlagHelpText");
 const getFlagStringValue_1 = require("../utils/getFlagStringValue");
@@ -116,7 +117,7 @@ const runMain = (process) => __awaiter(void 0, void 0, void 0, function* () {
         component,
         dryRun: flags.dry_run.value,
         skipSignatureVerify: flags.skip_signature_verify.value,
-        packageName: (_a = flags.name.value) !== null && _a !== void 0 ? _a : `@component-manifests/${component.key}`,
+        packageName: (_a = flags.name.value) !== null && _a !== void 0 ? _a : `@component-manifests/${(0, lodash_1.kebabCase)(component.key)}`,
         dependencies: {
             spectral: packageJson.version,
             dependencies: packageJson.dependencies,

package/dist/generators/componentManifest/createActions.js

@@ -18,20 +18,6 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOC_BLOCK = [
-    {
-        propertyKey: "comments",
-    },
-    {
-        propertyKey: "default",
-    },
-    {
-        propertyKey: "example",
-    },
-    {
-        propertyKey: "placeholder",
-    },
-];
 const createActions = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     if (verbose) {
@@ -51,7 +37,6 @@ const createActions = ({ component, dryRun, verbose, sourceDir, destinationDir,
     const actions = yield Promise.all(Object.entries((_b = component.actions) !== null && _b !== void 0 ? _b : {}).map(([actionKey, action]) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: action.inputs,
-            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderAction({

package/dist/generators/componentManifest/createConnections.js

@@ -18,30 +18,6 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOC_BLOCK = [
-    {
-        propertyKey: "comments",
-    },
-    {
-        propertyKey: "default",
-    },
-    {
-        propertyKey: "example",
-    },
-    {
-        propertyKey: "placeholder",
-    },
-    {
-        propertyKey: "onPremControlled",
-        propertyValue: true,
-        output: "This input will be supplied when using an on prem resource.",
-    },
-    {
-        propertyKey: "onPremiseControlled",
-        propertyValue: true,
-        output: "This input will be supplied when using an on prem resource.",
-    },
-];
 const createConnections = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     if (verbose) {
@@ -61,7 +37,6 @@ const createConnections = ({ component, dryRun, verbose, sourceDir, destinationD
     const connections = yield Promise.all(((_b = component.connections) !== null && _b !== void 0 ? _b : []).map((connection) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: connection.inputs,
-            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         const onPremAvailable = connection.inputs.some((input) => input.onPremControlled || input.onPremiseControlled);

package/dist/generators/componentManifest/createDataSources.js

@@ -18,20 +18,6 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOC_BLOCK = [
-    {
-        propertyKey: "comments",
-    },
-    {
-        propertyKey: "default",
-    },
-    {
-        propertyKey: "example",
-    },
-    {
-        propertyKey: "placeholder",
-    },
-];
 const createDataSources = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     if (verbose) {
@@ -51,7 +37,6 @@ const createDataSources = ({ component, dryRun, verbose, sourceDir, destinationD
     const dataSources = yield Promise.all(Object.entries((_b = component.dataSources) !== null && _b !== void 0 ? _b : {}).map(([dataSourceKey, dataSource]) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: dataSource.inputs,
-            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderDataSource({
@@ -59,6 +44,7 @@ const createDataSources = ({ component, dryRun, verbose, sourceDir, destinationD
                 key: dataSource.key || dataSourceKey,
                 label: dataSource.display.label,
                 description: dataSource.display.description,
+                dataSourceType: dataSource.dataSourceType,
                 inputs,
             },
             imports,

package/dist/generators/componentManifest/createTriggers.js

@@ -18,20 +18,6 @@ const getInputs_1 = require("./getInputs");
 const getImports_1 = require("./getImports");
 const helpers_1 = require("./helpers");
 const createTemplate_1 = require("../utils/createTemplate");
-const DOC_BLOCK = [
-    {
-        propertyKey: "comments",
-    },
-    {
-        propertyKey: "default",
-    },
-    {
-        propertyKey: "example",
-    },
-    {
-        propertyKey: "placeholder",
-    },
-];
 const createTriggers = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     if (verbose) {
@@ -51,7 +37,6 @@ const createTriggers = ({ component, dryRun, verbose, sourceDir, destinationDir,
     const triggers = yield Promise.all(Object.entries((_b = component.triggers) !== null && _b !== void 0 ? _b : {}).map(([triggerKey, trigger]) => __awaiter(void 0, void 0, void 0, function* () {
         const inputs = (0, getInputs_1.getInputs)({
             inputs: trigger.inputs,
-            docBlock: DOC_BLOCK,
         });
         const imports = (0, getImports_1.getImports)({ inputs });
         return yield renderTrigger({

package/dist/generators/componentManifest/docBlock.d.ts

@@ -0,0 +1,10 @@
+import { ServerTypeInput } from "./getInputs";
+export declare const DOC_BLOCK_DEFAULT: (input: ServerTypeInput) => string;
+interface AddLineProps {
+    key?: string;
+    value?: string | unknown | undefined | null;
+    raw?: string;
+}
+export declare const addLine: ({ key, value, raw }: AddLineProps) => string;
+export declare const addPunctuation: (value: string | undefined) => string;
+export {};

package/dist/generators/componentManifest/docBlock.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPunctuation = exports.addLine = exports.DOC_BLOCK_DEFAULT = void 0;
+const DOC_BLOCK_DEFAULT = (input) => {
+    const comments = (0, exports.addPunctuation)(input.comments);
+    const onPrem = input.onPremControlled || input.onPremiseControlled
+        ? " This input will be supplied when using an on prem resource."
+        : "";
+    return ((0, exports.addLine)({ raw: "/**" }) +
+        (0, exports.addLine)({ value: input.label }) +
+        (0, exports.addLine)({ value: comments + onPrem }) +
+        (0, exports.addLine)({ raw: "*" }) +
+        (0, exports.addLine)({ key: "default", value: input.default }) +
+        (0, exports.addLine)({ key: "example", value: input.example }) +
+        (0, exports.addLine)({ key: "placeholder", value: input.placeholder }) +
+        (0, exports.addLine)({ raw: "*/" }));
+};
+exports.DOC_BLOCK_DEFAULT = DOC_BLOCK_DEFAULT;
+const addLine = ({ key, value, raw }) => {
+    if (raw) {
+        return ` ${raw}\n`;
+    }
+    if (typeof value === "undefined" || value === null || value === "") {
+        return "";
+    }
+    const sanitizedValue = JSON.stringify(value)
+        .replace(/(^"|"$)|(^'|'$)/g, "")
+        .trim();
+    return ` * ${key ? `@${key} ${sanitizedValue}` : sanitizedValue}\n`;
+};
+exports.addLine = addLine;
+const addPunctuation = (value) => {
+    if (typeof value === "undefined" || value === null || value === "") {
+        return "";
+    }
+    return value.endsWith(".") || value.endsWith("!") || value.endsWith("?")
+        ? value
+        : value + ".";
+};
+exports.addPunctuation = addPunctuation;

package/dist/generators/componentManifest/getImports.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getImports = void 0;
 const getImports = ({ inputs }) => {
     return inputs.reduce((acc, input) => {
-        if (typeof input.type === "string") {
+        if (typeof input.valueType === "string") {
             return acc;
         }
-        return Object.assign(Object.assign({}, acc), { [input.type.module]: acc[input.type.module]
-                ? !acc[input.type.module].includes(input.type.type)
-                    ? [...acc[input.type.module], input.type.type]
-                    : acc[input.type.module]
-                : [input.type.type] });
+        return Object.assign(Object.assign({}, acc), { [input.valueType.module]: acc[input.valueType.module]
+                ? !acc[input.valueType.module].includes(input.valueType.type)
+                    ? [...acc[input.valueType.module], input.valueType.type]
+                    : acc[input.valueType.module]
+                : [input.valueType.type] });
     }, {});
 };
 exports.getImports = getImports;

package/dist/generators/componentManifest/getInputs.d.ts

@@ -1,19 +1,18 @@
 import type { Input as InputBase } from "../../serverTypes";
 import type { InputFieldDefinition } from "../../types/Inputs";
-declare type ServerTypeInput = InputBase & {
+export declare type ServerTypeInput = InputBase & {
     onPremControlled?: boolean;
+    shown?: boolean;
 };
 export interface Input {
     key: string;
     label: string;
-    type: InputType;
+    inputType: string;
+    valueType: ValueType;
+    docBlock: string;
     required: boolean | undefined;
-    properties: {
-        key: keyof ServerTypeInput;
-        value: string;
-    }[];
 }
-export declare type InputType = string | {
+export declare type ValueType = string | {
     type: string;
     module: string;
 };
@@ -25,8 +24,8 @@ export declare type DocBlock = {
 }[];
 interface GetInputsProps {
     inputs: ServerTypeInput[];
-    docBlock: DocBlock;
+    docBlock?: (input: ServerTypeInput) => string;
 }
-export declare const getInputs: ({ inputs, docBlock }: GetInputsProps) => Input[];
-export declare const INPUT_TYPE_MAP: Record<InputFieldDefinition["type"], InputType>;
+export declare const getInputs: ({ inputs, docBlock, }: GetInputsProps) => Input[];
+export declare const INPUT_TYPE_MAP: Record<InputFieldDefinition["type"], ValueType>;
 export {};

package/dist/generators/componentManifest/getInputs.js

@@ -1,50 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.INPUT_TYPE_MAP = exports.getInputs = void 0;
-const getInputs = ({ inputs, docBlock }) => {
-    return inputs.map((input) => {
-        return {
-            key: input.key,
-            label: input.label,
-            type: getInputType(input),
-            required: input.required,
-            collection: input.collection,
-            inputType: input.type,
-            onPremiseControlled: input.onPremiseControlled || input.onPremControlled,
-            properties: docBlock.reduce((acc, { propertyKey, inputKey, propertyValue, output }) => {
-                if (inputKey && inputKey !== input.key) {
-                    return acc;
-                }
-                if (output &&
-                    (input[propertyKey] === propertyValue ||
-                        typeof propertyValue === "undefined")) {
-                    return [
-                        ...acc,
-                        {
-                            key: propertyKey,
-                            value: output,
-                        },
-                    ];
-                }
-                if (typeof input[propertyKey] === "undefined" ||
-                    input[propertyKey] === null ||
-                    input[propertyKey] === "" ||
-                    (typeof propertyValue !== "undefined" &&
-                        input[propertyKey] !== propertyValue)) {
-                    return acc;
-                }
-                return [
-                    ...acc,
-                    {
-                        key: propertyKey,
-                        value: JSON.stringify(input[propertyKey])
-                            .replace(/(^"|"$)|(^'|'$)/g, "")
-                            .trim(),
-                    },
-                ];
-            }, []),
-        };
-    });
+const docBlock_1 = require("./docBlock");
+const getInputs = ({ inputs, docBlock = docBlock_1.DOC_BLOCK_DEFAULT, }) => {
+    return inputs.reduce((acc, input) => {
+        if ((typeof input.shown === "boolean" && input.shown === false) ||
+            input.type === "dynamicObjectSelection" ||
+            input.type === "dynamicFieldSelection") {
+            return acc;
+        }
+        return [
+            ...acc,
+            {
+                key: input.key,
+                label: input.label,
+                inputType: input.type,
+                valueType: getInputValueType(input),
+                required: input.required &&
+                    (input.default === undefined || input.default === ""),
+                collection: input.collection,
+                onPremControlled: input.onPremiseControlled || input.onPremControlled,
+                docBlock: docBlock(input),
+            },
+        ];
+    }, []);
 };
 exports.getInputs = getInputs;
 exports.INPUT_TYPE_MAP = {
@@ -77,12 +56,12 @@ exports.INPUT_TYPE_MAP = {
     dynamicObjectSelection: "string",
     dynamicFieldSelection: "string",
 };
-const getInputType = (input) => {
+const getInputValueType = (input) => {
     const valueType = input.model
         ? input.model.map((choice) => `"${choice.value}"`).join(" | ")
         : exports.INPUT_TYPE_MAP[input.type] || "never";
     if (input.collection === "keyvaluelist") {
-        return `Record<string, ${valueType}>`;
+        return `Record<string, ${valueType}> | Array<{key: string, value: ${valueType}}>`;
     }
     if (input.collection === "valuelist") {
         return `${valueType}[]`;

package/dist/generators/componentManifest/removeComponentManifest.js

@@ -1,13 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeComponentManifest = void 0;
-const fs_extra_1 = require("fs-extra");
+const fs_1 = require("fs");
 const removeComponentManifest = ({ destinationDir, verbose, }) => {
     if (verbose) {
         console.info("Removing existing component manifest files...");
     }
     try {
-        (0, fs_extra_1.removeSync)(destinationDir);
+        if ((0, fs_1.existsSync)(destinationDir)) {
+            (0, fs_1.rmSync)(destinationDir, { recursive: true, force: true });
+        }
     }
     catch (err) {
         console.error(err);

package/dist/generators/componentManifest/templates/actions/action.ts.ejs

@@ -1,4 +1,4 @@
-<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+<%- include('../partials/imports.ejs', { imports, helpers }) %>
 
 export interface <%= helpers.capitalizeFirstLetter(action.key) %>Values {
 <%- include('../partials/performArgs.ejs', { inputs: action.inputs }) -%>
@@ -16,4 +16,4 @@ export const <%= action.key %> = {
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: action.inputs }) -%>
   }
-}
+} as const;

package/dist/generators/componentManifest/templates/connections/connection.ts.ejs

@@ -1,4 +1,4 @@
-<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+<%- include('../partials/imports.ejs', { imports, helpers }) %>
 
 export interface <%= helpers.capitalizeFirstLetter(connection.key) %>Values {
 <%- include('../partials/performArgs.ejs', { inputs: connection.inputs }) -%>
@@ -19,4 +19,4 @@ export const <%= connection.key %> = {
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: connection.inputs }) -%>
   }
-};
+} as const;

package/dist/generators/componentManifest/templates/dataSources/dataSource.ts.ejs

@@ -1,4 +1,4 @@
-<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+<%- include('../partials/imports.ejs', { imports, helpers }) %>
 
 export interface <%= helpers.capitalizeFirstLetter(dataSource.key) %>Values {
 <%- include('../partials/performArgs.ejs', { inputs: dataSource.inputs }) -%>
@@ -13,7 +13,8 @@ export const <%= dataSource.key %> = {
   perform: (
     _values: <%= helpers.capitalizeFirstLetter(dataSource.key) %>Values
   ): Promise<void> => Promise.resolve(),
+  dataSourceType: "<%= dataSource.dataSourceType %>",
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: dataSource.inputs }) -%>
   }
-}
+} as const;

package/dist/generators/componentManifest/templates/index.ts.ejs

@@ -17,4 +17,4 @@ export default {
   dataSources,
   connections,
   triggers,
-};
+} as const;

package/dist/generators/componentManifest/templates/partials/inputs.ejs

@@ -1,10 +1,10 @@
 <% inputs.forEach((input) => { -%>
   <%= input.key %>: {
-    inputType: "<%= input.defaultType %>",
+    inputType: "<%= input.inputType %>",
     <%_ if (input.collection) { -%>
-    collection: "<%= input.collection %>" as const,
+    collection: "<%= input.collection %>",
     <%_ } else { -%>
-    collection: null,
+    collection: undefined,
     <%_ } -%>
     <%_ if (input.default) { -%>
     default: <%= input.default %>,

package/dist/generators/componentManifest/templates/partials/performArgs.ejs

@@ -1,10 +1,4 @@
 <% inputs.forEach((input) => { -%>
-  /**
-   * <%= input.label %>
-   *
-   <%_ input.properties.forEach((property) => { -%>
-   * @<%= property.key %> <%- property.value %>
-   <%_ }); -%>
-   */
-  <%= input.key %><%= input.required ? "" : "?" %>: <%- input.type.type ? input.type.type : input.type %>;
+  <%= input.docBlock -%>
+  <%= input.key %><%= input.required ? "" : "?" %>: <%- input.valueType.type ? input.valueType.type : input.valueType %>;
 <% }); -%>

package/dist/generators/componentManifest/templates/triggers/trigger.ts.ejs

@@ -1,4 +1,4 @@
-<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+<%- include('../partials/imports.ejs', { imports, helpers }) %>
 
 export interface <%= helpers.capitalizeFirstLetter(trigger.key) %>Values {
 <%- include('../partials/performArgs.ejs', { inputs: trigger.inputs }) -%>
@@ -16,4 +16,4 @@ export const <%= trigger.key %> = {
   inputs: {
     <%- include('../partials/inputs.ejs', { inputs: trigger.inputs }) -%>
   }
-}
+} as const;

package/dist/generators/utils/createTemplate.js

@@ -16,19 +16,25 @@ exports.createTemplate = void 0;
 const ejs_1 = require("ejs");
 const fs_extra_1 = require("fs-extra");
 const path_1 = __importDefault(require("path"));
+const prettier_1 = require("prettier");
 const createTemplate = ({ source, destination = source.replace(/\.ejs$/, ""), data = {}, dryRun, verbose, }) => __awaiter(void 0, void 0, void 0, function* () {
     if (!source) {
         throw new Error("Source is required");
     }
     try {
         if (path_1.default.extname(source) === ".ejs") {
-            const rendered = yield (0, ejs_1.renderFile)(source, data);
+            const render = yield (0, ejs_1.renderFile)(source, data);
+            const formattedRender = [".ts", ".js"].includes(path_1.default.extname(destination))
+                ? (0, prettier_1.format)(render, {
+                    parser: "typescript",
+                })
+                : render;
             if (dryRun) {
                 console.info("");
                 console.info("");
                 console.info(`Rendering ${source} to ${destination}`);
                 console.info("---------------------------- Start ----------------------------");
-                console.info(rendered);
+                console.info(formattedRender);
                 console.info("---------------------------- End ----------------------------");
                 console.info("");
                 return;
@@ -36,7 +42,7 @@ const createTemplate = ({ source, destination = source.replace(/\.ejs$/, ""), da
             if (verbose) {
                 console.info(`Rendering ${source} to ${destination}`);
             }
-            yield (0, fs_extra_1.outputFile)(destination, rendered, { encoding: "utf-8" });
+            yield (0, fs_extra_1.outputFile)(destination, formattedRender, { encoding: "utf-8" });
         }
         else {
             if (dryRun) {

package/dist/index.d.ts

@@ -3,8 +3,8 @@
  * 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, OnPremConnectionDefinition, ScheduleConfigVar, ComponentManifest } from "./types";
-import { convertComponent } from "./serverTypes/convert";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, OnPremConnectionDefinition, ComponentManifest } from "./types";
+import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
  * This function creates a Integration object that can be
@@ -35,7 +35,7 @@ export declare const configPage: <T extends ConfigPage = ConfigPage>(definition:
  * @param definition A Config Var type object.
  * @returns This function returns a standard config var object that has the shape the Prismatic API expects.
  */
-export declare const configVar: <T extends StandardConfigVar | ScheduleConfigVar>(definition: T) => T;
+export declare const configVar: <T extends StandardConfigVar>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.

package/dist/index.js

@@ -23,7 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testing = exports.util = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
-const convert_1 = require("./serverTypes/convert");
+const convertComponent_1 = require("./serverTypes/convertComponent");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
  * This function creates a Integration object that can be
@@ -96,7 +96,7 @@ exports.componentManifest = componentManifest;
  * @param definition A ComponentDefinition type object, including display information, unique key, and a set of actions the component implements.
  * @returns This function returns a component object that has the shape the Prismatic API expects.
  */
-const component = (definition) => (0, convert_1.convertComponent)(definition);
+const component = (definition) => (0, convertComponent_1.convertComponent)(definition);
 exports.component = component;
 /**
  * This function creates an action object that can be referenced