@prismatic-io/spectral 8.1.6 → 9.0.0-rc.1

package/bin/component-manifest.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/generators/componentManifest/cli.js").runMain(process);

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

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare const runMain: (process: NodeJS.Process) => Promise<void>;

package/dist/generators/componentManifest/cli.js

@@ -0,0 +1,134 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runMain = void 0;
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = require("fs-extra");
+const index_1 = require("./index");
+const createFlagHelpText_1 = require("../utils/createFlagHelpText");
+const getFlagStringValue_1 = require("../utils/getFlagStringValue");
+const getFlagBooleanValue_1 = require("../utils/getFlagBooleanValue");
+const util_1 = require("../../util");
+const runMain = (process) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const componentDir = process.cwd();
+    const componentDistDir = path_1.default.join(componentDir, "dist", "index.js");
+    if (!componentDir) {
+        console.error("Please run this script using npm or yarn.");
+        process.exit(1);
+    }
+    if (!(0, fs_extra_1.existsSync)(componentDistDir)) {
+        console.error("Component build directory `dist` does not exist. Please verify that the component has been built.");
+        process.exit(1);
+    }
+    const component = require(componentDistDir).default;
+    if (!component ||
+        !(0, util_1.isObjectWithTruthyKeys)(component, ["key", "display"]) ||
+        !(0, util_1.isObjectWithOneTruthyKey)(component, [
+            "actions",
+            "connections",
+            "dataSources",
+        ])) {
+        console.error("Component is invalid.");
+        process.exit(1);
+    }
+    const flags = {
+        name: {
+            flag: ["--name", "-n"],
+            value: (0, getFlagStringValue_1.getFlagsStringValue)({
+                args: process.argv.slice(3),
+                flags: ["--name", "-n"],
+            }),
+            description: "The name of the component manifest. Defaults to the name of the current component being generated.",
+        },
+        verbose: {
+            flag: ["--verbose", "-v"],
+            value: (0, getFlagBooleanValue_1.getFlagsBooleanValue)({
+                args: process.argv.slice(3),
+                flags: ["--verbose", "-v"],
+            }),
+            description: "Provides more detailed or extensive information about the files being generated during the process.",
+        },
+        output_dir: {
+            flag: ["--output-dir", "-o"],
+            value: (0, getFlagStringValue_1.getFlagsStringValue)({
+                args: process.argv.slice(3),
+                flags: ["--output-dir", "-o"],
+            }),
+            description: "The output directory for the component manifest. Defaults to the sibling of the current component directory.",
+        },
+        registry: {
+            flag: ["--registry", "-r"],
+            value: (0, getFlagStringValue_1.getFlagsStringValue)({
+                args: process.argv.slice(3),
+                flags: ["--registry", "-r"],
+            }),
+            description: "The registry to publish the component manifest to (as a URI). This is where your package will be published. If not specified, it defaults to your system's default registry.",
+        },
+        dry_run: {
+            flag: ["--dry-run", "-d"],
+            value: (0, getFlagBooleanValue_1.getFlagsBooleanValue)({
+                args: process.argv.slice(3),
+                flags: ["--dry-run", "-d"],
+            }),
+            description: "Perform a dry run without generating the component manifest. This provides a preview of what you could expect to happen when running the command without this flag.",
+        },
+        include_signature: {
+            flag: ["--include-signature", "-s"],
+            value: (0, getFlagBooleanValue_1.getFlagsBooleanValue)({
+                args: process.argv.slice(3),
+                flags: ["--include-signature", "-s"],
+            }),
+            description: "This will include the published component's signature key. Allowing you to publish the Code Native Integrations (CNI) where this component manifest is used.",
+        },
+        help: {
+            flag: ["--help", "-h"],
+            value: (0, getFlagBooleanValue_1.getFlagsBooleanValue)({
+                args: process.argv.slice(3),
+                flags: ["--help", "-h"],
+            }),
+            description: "Show this help message.",
+        },
+    };
+    if (flags.help.value) {
+        (0, createFlagHelpText_1.createFlagHelpText)({
+            command: "component-manifest",
+            flags,
+        });
+        process.exit(0);
+    }
+    const packageJson = (0, fs_extra_1.readJsonSync)(path_1.default.join(__dirname, "../../../package.json"));
+    yield (0, index_1.createComponentManifest)({
+        component,
+        dryRun: flags.dry_run.value,
+        includeSignature: flags.include_signature.value,
+        packageName: (_a = flags.name.value) !== null && _a !== void 0 ? _a : `@components/${component.key}-manifest`,
+        dependencies: {
+            spectral: packageJson.version,
+            dependencies: packageJson.dependencies,
+            devDependencies: packageJson.devDependencies,
+        },
+        verbose: flags.verbose.value,
+        sourceDir: path_1.default.join(__dirname, "templates"),
+        destinationDir: flags.output_dir.value
+            ? flags.output_dir.value
+            : path_1.default.join(componentDir, "..", flags.name.value
+                ? flags.name.value
+                : `${path_1.default.basename(componentDir)}-manifest`),
+        registry: (_b = flags.registry.value) !== null && _b !== void 0 ? _b : null,
+    });
+});
+exports.runMain = runMain;

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

@@ -0,0 +1,13 @@
+import { Component } from "../../serverTypes";
+interface CreateActionsProps {
+    component: Component;
+    dryRun: boolean;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+}
+export declare const createActions: ({ component, dryRun, verbose, sourceDir, destinationDir, }: CreateActionsProps) => Promise<{
+    actionIndex: string | void;
+    actions: (string | void)[];
+}>;
+export {};

package/dist/generators/componentManifest/createActions.js

@@ -0,0 +1,95 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createActions = void 0;
+const path_1 = __importDefault(require("path"));
+const getInputs_1 = require("./getInputs");
+const getImports_1 = require("./getImports");
+const helpers_1 = require("./helpers");
+const createTemplate_1 = require("../utils/createTemplate");
+const DOCUMENT_PROPERTIES = [
+    "comments",
+    "default",
+    "example",
+    "placeholder",
+];
+const createActions = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (verbose) {
+        console.info("Creating actions...");
+    }
+    const actionIndex = yield renderActionsIndex({
+        actions: Object.entries((_a = component.actions) !== null && _a !== void 0 ? _a : {}).map(([actionKey, action]) => {
+            return {
+                key: action.key || actionKey,
+            };
+        }),
+        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,
+            documentProperties: DOCUMENT_PROPERTIES,
+        });
+        const imports = (0, getImports_1.getImports)({ inputs });
+        return yield renderAction({
+            action: {
+                key: action.key || actionKey,
+                label: action.display.description,
+                description: action.display.description,
+                inputs,
+            },
+            imports,
+            dryRun,
+            verbose,
+            sourceDir,
+            destinationDir,
+        });
+    })));
+    if (verbose) {
+        console.info("");
+    }
+    return Promise.resolve({
+        actionIndex,
+        actions,
+    });
+});
+exports.createActions = createActions;
+const renderActionsIndex = ({ actions, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, createTemplate_1.createTemplate)({
+        source: path_1.default.join(sourceDir, "actions", "index.ts.ejs"),
+        destination: path_1.default.join(destinationDir, "actions", "index.ts"),
+        data: {
+            actions,
+        },
+        dryRun,
+        verbose,
+    });
+});
+const renderAction = ({ action, dryRun, imports, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, createTemplate_1.createTemplate)({
+        source: path_1.default.join(sourceDir, "actions", "action.ts.ejs"),
+        destination: path_1.default.join(destinationDir, "actions", `${action.key}.ts`),
+        data: {
+            action,
+            helpers: helpers_1.helpers,
+            imports,
+        },
+        dryRun,
+        verbose,
+    });
+});

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

@@ -0,0 +1,13 @@
+import { Component } from "../../serverTypes";
+interface CreateConnectionsProps {
+    component: Component;
+    dryRun: boolean;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+}
+export declare const createConnections: ({ component, dryRun, verbose, sourceDir, destinationDir, }: CreateConnectionsProps) => Promise<{
+    connectionIndex: string | void;
+    connections: (string | void)[];
+}>;
+export {};

package/dist/generators/componentManifest/createConnections.js

@@ -0,0 +1,95 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConnections = void 0;
+const path_1 = __importDefault(require("path"));
+const getInputs_1 = require("./getInputs");
+const getImports_1 = require("./getImports");
+const helpers_1 = require("./helpers");
+const createTemplate_1 = require("../utils/createTemplate");
+const DOCUMENT_PROPERTIES = [
+    "comments",
+    "default",
+    "example",
+    "placeholder",
+];
+const createConnections = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (verbose) {
+        console.info("Creating connections...");
+    }
+    const connectionIndex = yield renderConnectionsIndex({
+        connections: ((_a = component.connections) !== null && _a !== void 0 ? _a : []).map((connection) => {
+            return {
+                key: connection.key,
+            };
+        }),
+        dryRun,
+        verbose,
+        sourceDir,
+        destinationDir,
+    });
+    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,
+            documentProperties: DOCUMENT_PROPERTIES,
+        });
+        const imports = (0, getImports_1.getImports)({ inputs });
+        return yield renderConnection({
+            connection: {
+                key: connection.key,
+                label: connection.label,
+                comments: connection.comments,
+                inputs,
+            },
+            imports,
+            dryRun,
+            verbose,
+            sourceDir,
+            destinationDir,
+        });
+    })));
+    if (verbose) {
+        console.info("");
+    }
+    return Promise.resolve({
+        connectionIndex,
+        connections,
+    });
+});
+exports.createConnections = createConnections;
+const renderConnectionsIndex = ({ connections, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, createTemplate_1.createTemplate)({
+        source: path_1.default.join(sourceDir, "connections", "index.ts.ejs"),
+        destination: path_1.default.join(destinationDir, "connections", "index.ts"),
+        data: {
+            connections,
+        },
+        dryRun,
+        verbose,
+    });
+});
+const renderConnection = ({ connection, dryRun, imports, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, createTemplate_1.createTemplate)({
+        source: path_1.default.join(sourceDir, "connections", "connection.ts.ejs"),
+        destination: path_1.default.join(destinationDir, "connections", `${connection.key}.ts`),
+        data: {
+            connection,
+            helpers: helpers_1.helpers,
+            imports,
+        },
+        dryRun,
+        verbose,
+    });
+});

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

@@ -0,0 +1,13 @@
+import { Component } from "../../serverTypes";
+interface CreateDataSourcesProps {
+    component: Component;
+    dryRun: boolean;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+}
+export declare const createDataSources: ({ component, dryRun, verbose, sourceDir, destinationDir, }: CreateDataSourcesProps) => Promise<{
+    dataSourceIndex: string | void;
+    dataSources: (string | void)[];
+}>;
+export {};

package/dist/generators/componentManifest/createDataSources.js

@@ -0,0 +1,95 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDataSources = void 0;
+const path_1 = __importDefault(require("path"));
+const getInputs_1 = require("./getInputs");
+const getImports_1 = require("./getImports");
+const helpers_1 = require("./helpers");
+const createTemplate_1 = require("../utils/createTemplate");
+const DOCUMENT_PROPERTIES = [
+    "comments",
+    "default",
+    "example",
+    "placeholder",
+];
+const createDataSources = ({ component, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (verbose) {
+        console.info("Creating data sources...");
+    }
+    const dataSourceIndex = yield renderDataSourcesIndex({
+        dataSources: Object.entries((_a = component.dataSources) !== null && _a !== void 0 ? _a : {}).map(([dataSourceKey, dataSource]) => {
+            return {
+                key: dataSource.key || dataSourceKey,
+            };
+        }),
+        dryRun,
+        verbose,
+        sourceDir,
+        destinationDir,
+    });
+    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,
+            documentProperties: DOCUMENT_PROPERTIES,
+        });
+        const imports = (0, getImports_1.getImports)({ inputs });
+        return yield renderDataSource({
+            dataSource: {
+                key: dataSource.key || dataSourceKey,
+                label: dataSource.display.label,
+                description: dataSource.display.description,
+                inputs,
+            },
+            imports,
+            dryRun,
+            verbose,
+            sourceDir,
+            destinationDir,
+        });
+    })));
+    if (verbose) {
+        console.info("");
+    }
+    return Promise.resolve({
+        dataSourceIndex,
+        dataSources,
+    });
+});
+exports.createDataSources = createDataSources;
+const renderDataSourcesIndex = ({ dataSources, dryRun, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, createTemplate_1.createTemplate)({
+        source: path_1.default.join(sourceDir, "dataSources", "index.ts.ejs"),
+        destination: path_1.default.join(destinationDir, "dataSources", "index.ts"),
+        data: {
+            dataSources,
+        },
+        dryRun,
+        verbose,
+    });
+});
+const renderDataSource = ({ dataSource, dryRun, imports, verbose, sourceDir, destinationDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield (0, createTemplate_1.createTemplate)({
+        source: path_1.default.join(sourceDir, "dataSources", "dataSource.ts.ejs"),
+        destination: path_1.default.join(destinationDir, "dataSources", `${dataSource.key}.ts`),
+        data: {
+            dataSource,
+            helpers: helpers_1.helpers,
+            imports,
+        },
+        dryRun,
+        verbose,
+    });
+});

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

@@ -0,0 +1,80 @@
+import { Component } from "../../serverTypes";
+export interface PackageDependencies {
+    spectral: string;
+    dependencies: Record<string, string>;
+    devDependencies: Record<string, string>;
+}
+interface CreateStaticFilesProps {
+    component: Component;
+    dryRun: boolean;
+    signature: string | null;
+    packageName: string;
+    dependencies: PackageDependencies;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+    registry: string | null;
+}
+export declare const createStaticFiles: ({ component, dryRun, signature, packageName, dependencies, verbose, sourceDir, destinationDir, registry, }: CreateStaticFilesProps) => Promise<{
+    index: string | void;
+    packageJson: string | void;
+    tsConfig: string | void;
+    readme: string | void;
+}>;
+interface RenderIndexProps {
+    component: {
+        key: string;
+        public: boolean;
+        signature: string | null;
+    };
+    dryRun: boolean;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+}
+export declare const renderIndex: ({ component, dryRun, verbose, sourceDir, destinationDir, }: RenderIndexProps) => Promise<string | void>;
+interface RenderPackageJsonProps {
+    dryRun: boolean;
+    packageName: string;
+    dependencies: PackageDependencies;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+    registry: string | null;
+}
+export declare const renderPackageJson: ({ dryRun, packageName, dependencies, verbose, sourceDir, destinationDir, registry, }: RenderPackageJsonProps) => Promise<string | void>;
+interface RenderTsConfigProps {
+    dryRun: boolean;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+}
+export declare const renderTsConfig: ({ dryRun, verbose, sourceDir, destinationDir, }: RenderTsConfigProps) => Promise<string | void>;
+interface RenderReadmeProps {
+    component: {
+        key: string;
+        label: string;
+        description: string;
+        isPublic: boolean;
+        action: {
+            key: string;
+        } | null;
+        trigger: {
+            key: string;
+        } | null;
+        connection: {
+            key: string;
+        } | null;
+        dataSource: {
+            key: string;
+            type: string;
+        } | null;
+    };
+    dryRun: boolean;
+    packageName: string;
+    verbose: boolean;
+    sourceDir: string;
+    destinationDir: string;
+}
+export declare const renderReadme: ({ component, dryRun, packageName, verbose, sourceDir, destinationDir, }: RenderReadmeProps) => Promise<string | void>;
+export {};