@webiny/cli 6.0.0-alpha.5 → 6.0.0-rc.0

package/commands/wcp/utils/index.js

@@ -1,19 +0,0 @@
-const { getUser } = require("./getUser");
-const { getProjectEnvironment } = require("./getProjectEnvironment");
-const { updateUserLastActiveOn } = require("./updateUserLastActiveOn");
-const { setProjectId } = require("./setProjectId");
-const { setWcpPat } = require("./setWcpPat");
-const { getWcpPat } = require("./getWcpPat");
-const { getWcpProjectId } = require("./getWcpProjectId");
-const { getWcpOrgProjectId } = require("./getWcpOrgProjectId");
-
-module.exports = {
-    getUser,
-    getProjectEnvironment,
-    updateUserLastActiveOn,
-    setProjectId,
-    setWcpPat,
-    getWcpPat,
-    getWcpProjectId,
-    getWcpOrgProjectId
-};

package/commands/wcp/utils/setProjectId.js

@@ -1,44 +0,0 @@
-const path = require("path");
-const tsMorph = require("ts-morph");
-const { log } = require("@webiny/cli/utils");
-
-module.exports.setProjectId = async ({ project, orgId, projectId }) => {
-    // Assign the necessary IDs into root `webiny.project.ts` project file.
-    const webinyProjectPath = path.join(project.root, "webiny.project.ts");
-
-    const tsMorphProject = new tsMorph.Project();
-    tsMorphProject.addSourceFileAtPath(webinyProjectPath);
-
-    const source = tsMorphProject.getSourceFile(webinyProjectPath);
-
-    const defaultExport = source.getFirstDescendant(node => {
-        if (tsMorph.Node.isExportAssignment(node) === false) {
-            return false;
-        }
-        return node.getText().startsWith("export default ");
-    });
-
-    if (!defaultExport) {
-        throw new Error(
-            `Could not find the default export in ${log.error.hl("webiny.project.ts")}.`
-        );
-    }
-
-    // Get ObjectLiteralExpression within the default export and assign the `id` property to it.
-    const exportedObjectLiteral = defaultExport.getFirstDescendant(
-        node => tsMorph.Node.isObjectLiteralExpression(node) === true
-    );
-
-    const existingIdProperty = exportedObjectLiteral.getProperty(node => {
-        return tsMorph.Node.isPropertyAssignment(node) && node.getName() === "id";
-    });
-
-    const fullId = `${orgId}/${projectId}`;
-    if (tsMorph.Node.isPropertyAssignment(existingIdProperty)) {
-        existingIdProperty.setInitializer(`"${fullId}"`);
-    } else {
-        exportedObjectLiteral.insertProperty(0, `id: "${fullId}"`);
-    }
-
-    await tsMorphProject.save();
-};

package/commands/wcp/utils/setWcpPat.js

@@ -1,5 +0,0 @@
-const { localStorage } = require("@webiny/cli/utils");
-
-module.exports.setWcpPat = wcpPat => {
-    localStorage().set("wcpPat", wcpPat);
-};

package/commands/wcp/utils/updateUserLastActiveOn.js

@@ -1,28 +0,0 @@
-const { request } = require("graphql-request");
-const { localStorage, log } = require("@webiny/cli/utils");
-const { getWcpGqlApiUrl } = require("@webiny/wcp");
-
-const UPDATE_LAST_ACTIVE_TO_NOW = /* GraphQL */ `
-    mutation UpdateLastActiveToNow {
-        users {
-            updateLastActiveToNow {
-                id
-                lastActiveOn
-            }
-        }
-    }
-`;
-
-module.exports.updateUserLastActiveOn = async () => {
-    const pat = localStorage().get("wcpPat");
-    if (!pat) {
-        throw new Error(
-            `It seems you are not logged in. Please login using the ${log.error.hl(
-                "webiny login"
-            )} command.`
-        );
-    }
-
-    const headers = { authorization: pat };
-    return request(getWcpGqlApiUrl(), UPDATE_LAST_ACTIVE_TO_NOW, {}, headers);
-};

package/commands/wcp/whoami.js

@@ -1,43 +0,0 @@
-const { getUser } = require("./utils");
-
-module.exports.command = () => ({
-    type: "cli-command",
-    name: "cli-command-wcp-whoami",
-    create({ yargs, context }) {
-        yargs.command(
-            "whoami",
-            `Display the current logged-in user`,
-            yargs => {
-                yargs.example("$0 whoami");
-                yargs.option("debug", {
-                    describe: `Turn on debug logs`,
-                    type: "boolean"
-                });
-                yargs.option("debug-level", {
-                    default: 1,
-                    describe: `Set the debug logs verbosity level`,
-                    type: "number"
-                });
-            },
-            async ({ debug }) => {
-                try {
-                    const user = await getUser();
-                    console.log(
-                        `You are logged in to Webiny Control Panel as ${context.info.hl(
-                            user.email
-                        )}.`
-                    );
-                } catch (e) {
-                    if (debug) {
-                        context.debug(e);
-                    }
-                    throw new Error(
-                        `It seems you are not logged in. Please login using the ${context.error.hl(
-                            "webiny login"
-                        )} command.`
-                    );
-                }
-            }
-        );
-    }
-});

package/context.js

@@ -1,137 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-const { importModule, getProject, PluginsContainer, log, localStorage, noop } = require("./utils");
-
-const project = getProject();
-
-if (!project) {
-    console.log(
-        `🚨 Couldn't locate "webiny.project.js"! Webiny CLI relies on that file to find the root of a Webiny project.`
-    );
-    process.exit(1);
-}
-
-class Context {
-    constructor() {
-        this.loadedEnvFiles = {};
-
-        this.version = require("./package.json").version;
-        this.project = project;
-
-        // Check if `projectName` was injected properly.
-        if (this.project.name === "[PROJECT_NAME]") {
-            console.log(
-                [
-                    "",
-                    "🚨 IMPORTANT 🚨",
-                    "Looks like your project was not bootstrapped correctly! We recommend creating a new project from scratch.",
-                    "If you see errors during project creation, please report them to us:",
-                    "🔗 Github:\thttps://github.com/webiny/webiny-js",
-                    "🔗 Slack:\thttps://www.webiny.com/slack",
-                    ""
-                ].join("\n")
-            );
-            process.exit(1);
-        }
-
-        this.plugins = new PluginsContainer();
-
-        this.localStorage = localStorage();
-
-        this.onExitCallbacks = [];
-
-        let onExitProcessed = false;
-        process.on("SIGINT", async () => {
-            if (onExitProcessed) {
-                return;
-            }
-
-            onExitProcessed = true;
-
-            for (let i = 0; i < this.onExitCallbacks.length; i++) {
-                await this.onExitCallbacks[i]("SIGINT");
-            }
-
-            process.exit(1);
-        });
-    }
-
-    onExit(callback) {
-        this.onExitCallbacks.push(callback);
-    }
-
-    import(name) {
-        return importModule(name);
-    }
-
-    async loadUserPlugins() {
-        if (this.project.config.cli) {
-            let plugins = this.project.config.cli.plugins || [];
-            if (typeof plugins === "function") {
-                plugins = await plugins();
-            }
-
-            this.plugins.register(
-                ...plugins.map(plugin => {
-                    if (typeof plugin === "string") {
-                        let loadedPlugin;
-                        try {
-                            loadedPlugin = require(path.join(this.project.root, plugin)); // Try loading the package from the project's root
-                        } catch {
-                            // If it fails, perhaps the user still has the package installed somewhere locally...
-                            loadedPlugin = require(plugin);
-                        }
-                        return loadedPlugin;
-                    }
-                    return plugin;
-                })
-            );
-        }
-    }
-
-    log = log.log;
-    info = log.info;
-    success = log.success;
-    debug = process.argv.some(v => v.match("--debug")) ? log.debug : noop;
-    warning = log.warning;
-    error = log.error;
-
-    resolve(...dir) {
-        return path.resolve(this.project.root, ...dir);
-    }
-
-    replaceProjectRoot(path) {
-        return path.replace(this.project.root, "<projectRoot>").replace(/\\/g, "/");
-    }
-
-    /**
-     * Uses `dotenv` lib to load env files, by accepting a simple file path.
-     * @param filePath
-     * @param debug
-     * @returns {Promise<void>}
-     */
-    async loadEnv(filePath, { debug = false } = {}) {
-        if (this.loadedEnvFiles[filePath]) {
-            return;
-        }
-
-        if (!fs.existsSync(filePath)) {
-            debug && this.debug(`No environment file found on %s.`, filePath);
-            return;
-        }
-
-        try {
-            require("dotenv").config({ path: filePath });
-            debug && this.success(`Loaded environment variables from ${filePath}.`);
-            this.loadedEnvFiles[filePath] = true;
-        } catch (err) {
-            if (debug) {
-                this.error(`Could not load env variables from ${filePath}:`);
-                this.error(err.message);
-                console.log();
-            }
-        }
-    }
-}
-
-module.exports = new Context();

package/files/README.md

@@ -1 +0,0 @@
-Do not manually create files in this folder. This folder is used to store the files that are generated by the CLI.

package/index.d.ts

@@ -1,5 +0,0 @@
-import {CliContext} from "./types";
-
-export * from "./regions"
-
-export declare const cli: CliContext;

package/regions.d.ts

@@ -1,6 +0,0 @@
-export interface RegionValue {
-    name: string;
-    value: string;
-}
-
-export declare const regions: RegionValue[];

package/regions.js

@@ -1,30 +0,0 @@
-const regions = [
-    { value: "us-east-1", name: "us-east-1 (US East, N. Virginia)" },
-    { value: "us-east-2", name: "us-east-2 (US East, Ohio)" },
-    { value: "us-west-1", name: "us-west-1 (US West, N. California)" },
-    { value: "us-west-2", name: "us-west-2 (US West, Oregon)" },
-    { value: "ca-central-1", name: "ca-central-1 (Canada, Central)" },
-    { value: "eu-central-1", name: "eu-central-1 (EU, Frankfurt)" },
-    { value: "eu-west-1", name: "eu-west-1 (EU, Ireland)" },
-    { value: "eu-west-2", name: "eu-west-2 (EU, London)" },
-    /**
-     * This was commented out because cognito was not available in this region in 2021.
-     * TODO - uncomment and test it out
-     */
-    /*{ value: "eu-south-1", name: "eu-south-1 (EU, Milan)" },*/
-    { value: "eu-west-3", name: "eu-west-3 (EU, Paris)" },
-    { value: "eu-north-1", name: "eu-north-1 (EU, Stockholm)" },
-    { value: "af-south-1", name: "af-south-1 (Africa, Cape Town)" },
-    { value: "ap-east-1", name: "ap-east-1 (Asia Pacific, Hong Kong)" },
-    { value: "ap-south-1", name: "ap-south-1 (Asia Pacific, Mumbai)" },
-    { value: "ap-northeast-2", name: "ap-northeast-2 (Asia Pacific, Seoul)" },
-    { value: "ap-southeast-1", name: "ap-southeast-1 (Asia Pacific, Singapore)" },
-    { value: "ap-southeast-2", name: "ap-southeast-2 (Asia Pacific, Sydney)" },
-    { value: "ap-northeast-1", name: "ap-northeast-1 (Asia Pacific, Tokyo)" },
-    // { value: "me-south-1", name: "me-south-1 (Middle East, Bahrain)" },
-    { value: "sa-east-1", name: "sa-east-1 (South America, São Paulo)" }
-];
-
-module.exports = {
-    regions
-};

package/types.d.ts

@@ -1,234 +0,0 @@
-import type yargs from "yargs";
-
-/**
- * Rename file to types.ts when switching the package to Typescript.
- */
-export type GenericRecord<K extends PropertyKey = PropertyKey, V = any> = Record<K, V>;
-
-export type NonEmptyArray<T> = [T, ...T[]];
-
-/**
- * A simplified plugins container interface, used specifically within the Webiny CLI.
- * Not in relation with "@webiny/plugins" package.
- */
-export interface PluginsContainer {
-    register(...args: any[]): void;
-    byType<T extends Plugin>(type: T["type"]): T[];
-
-    byName<T extends Plugin>(name: T["name"]): T;
-}
-
-/**
- * A simplified plugin interface, used specifically within the Webiny CLI.
- * Not in relation with "@webiny/plugins" package.
- */
-export interface Plugin {
-    type: string;
-    name?: string;
-
-    [key: string]: any;
-}
-
-interface Project {
-    /**
-     * Name of the project.
-     */
-    name: string;
-    /**
-     * Configurations.
-     */
-    config: {
-        appAliases: {
-            [key: string]: string;
-        }
-        [key: string]: any;
-    };
-    /**
-     * Root path of the project.
-     */
-    root: string;
-}
-
-
-export interface IProjectApplicationPackage {
-    name: string;
-    paths: {
-        root: string;
-        relative: string;
-        packageJson: string;
-        config: string;
-    };
-    packageJson: Record<string, any>;
-    get config(): any;
-}
-
-export interface IProjectApplicationConfigCli {
-    watch?: boolean;
-}
-
-export interface IProjectApplicationConfig {
-    appAliases?: Record<string, string>;
-    cli?: IProjectApplicationConfigCli;
-    [key: string]: unknown
-}
-
-export interface ProjectApplication {
-    /**
-     * Unique ID of the project application.
-     */
-    id: string;
-    /**
-     * Name of the project application.
-     */
-    name: string;
-    /**
-     * Description of the project application.
-     */
-    description: string;
-    /**
-     * Type of the project application.
-     */
-    type: string;
-    /**
-     * Root path of the project application.
-     */
-    root: string;
-    /**
-     * Commonly used paths.
-     */
-    paths: {
-        relative: string;
-        absolute: string;
-        workspace: string;
-    };
-    /**
-     * Project application config (exported via `webiny.application.ts` file).
-     */
-    config: IProjectApplicationConfig;
-    /**
-     * Project application package.json.
-     */
-    project: Project;
-
-    /**
-     * A list of all the packages in the project application.
-     */
-    get packages(): IProjectApplicationPackage[];
-}
-
-/**
- * A type that represents the logging method.
- */
-interface Log {
-    (...args: any): string;
-
-    hl: (...args: any) => string;
-    highlight: (...args: any) => string;
-}
-
-/**
- * Interface representing the CLI Context.
- */
-export interface CliContext {
-    /**
-     * All registered plugins.
-     */
-    plugins: PluginsContainer;
-    /**
-     * Load environment variables from a given file.
-     */
-    loadEnv(filePath: string, options?: {debug?: boolean}): Promise<void>;
-    /**
-     * All the environment variables.
-     */
-    loadedEnvFiles: Record<string, any>;
-    /**
-     * Version of the Webiny CLI.
-     */
-    version: string;
-    /**
-     * Project information.
-     */
-    project: Project;
-    /**
-     * Trigger given callback on SIGINT.
-     */
-    onExit: (cb: () => any) => void;
-    /**
-     * Import a given module.
-     */
-    import: (module: string) => Promise<void>;
-    /**
-     * Regular logging.
-     */
-    log: Log;
-    /**
-     * Info logging.
-     */
-    info: Log;
-    /**
-     * Success logging.
-     */
-    success: Log;
-    /**
-     * Debug logging.
-     */
-    debug: Log;
-    /**
-     * Warnings logging.
-     */
-    warning: Log;
-    /**
-     * Errors logging.
-     */
-    error: Log;
-    /**
-     * Resolve given dir or dirs against project root path.
-     */
-    resolve: (dir: string) => string;
-
-    /**
-     * Provides a way to store some metadata in the project's local ".webiny/cli.json" file.
-     * Only trivial data should be passed here, specific to the current project.
-     */
-    localStorage: {
-        set: (key: string, value: any) => Record<string, any>;
-        get: (key: string) => any;
-    };
-}
-
-/**
- * Arguments for CliPlugin.create
- *
- * @category Cli
- */
-export interface CliCommandPluginArgs {
-    yargs: typeof yargs;
-    context: CliContext;
-}
-
-/**
- * A plugin defining cli-command type.
- *
- * @category Plugin
- * @category Cli
- */
-export interface CliCommandPlugin extends Plugin {
-    type: "cli-command";
-    name: string;
-    create: (args: CliCommandPluginArgs) => void;
-}
-
-export interface CliCommandErrorPluginHandleParams {
-    context: CliContext;
-    error: Error;
-}
-
-export interface CliCommandErrorPluginHandle {
-    (params: CliCommandErrorPluginHandleParams):void;
-}
-
-export interface CliCommandErrorPlugin extends Plugin {
-    type: "cli-command-error";
-    handle: CliCommandErrorPluginHandle;
-}

package/utils/PluginsContainer.js

@@ -1,49 +0,0 @@
-const uniqid = require("uniqid");
-
-// Since the Webiny CLI can rely on "@webiny/plugins" package (chicken-egg problem), then
-// we need to make a copy of its PluginsContainer class. We removed all of the extra
-// features that are in reality not needed for the Webiny CLI.
-const assign = (plugins, target) => {
-    for (let i = 0; i < plugins.length; i++) {
-        const plugin = plugins[i];
-        if (Array.isArray(plugin)) {
-            assign(plugin, target);
-            continue;
-        }
-
-        let name = plugin._name || plugin.name;
-        if (!name) {
-            plugin.name = name = uniqid(plugin.type + "-");
-        }
-
-        target[name] = plugin;
-    }
-};
-
-module.exports = class PluginsContainer {
-    plugins = {};
-    constructor(...args) {
-        this.register(...args);
-    }
-
-    byName(name) {
-        return this.plugins[name];
-    }
-
-    byType(type) {
-        const plugins = this.findByType(type);
-        return Array.from(plugins);
-    }
-
-    findByType(type) {
-        return Object.values(this.plugins).filter(pl => pl.type === type);
-    }
-
-    register(...args) {
-        assign(args, this.plugins);
-    }
-
-    unregister(name) {
-        delete this.plugins[name];
-    }
-};

package/utils/createProjectApplicationWorkspace.js

@@ -1,16 +0,0 @@
-const util = require("util");
-const fs = require("fs-extra");
-const ncpBase = require("ncp");
-const ncp = util.promisify(ncpBase.ncp);
-
-module.exports = async projectApplication => {
-    if (await fs.pathExists(projectApplication.paths.workspace)) {
-        await fs.remove(projectApplication.paths.workspace);
-    }
-
-    await fs.ensureDir(projectApplication.paths.workspace);
-    await ncp(projectApplication.paths.absolute, projectApplication.paths.workspace);
-
-    // Wait a bit and make sure the files are ready to have its content replaced.
-    return new Promise(resolve => setTimeout(resolve, 10));
-};

package/utils/getProject.js

@@ -1,48 +0,0 @@
-const findUp = require("find-up");
-const { dirname } = require("path");
-const { importModule } = require("./importModule");
-
-const projectConfigs = ["webiny.project.js", "webiny.project.ts"];
-
-function getRoot({ cwd } = {}) {
-    let root = findUp.sync(projectConfigs, { cwd });
-    if (root) {
-        return dirname(root).replace(/\\/g, "/");
-    }
-
-    // For backwards compatibility
-    root = findUp.sync("webiny.root.js", { cwd });
-    if (root) {
-        return dirname(root).replace(/\\/g, "/");
-    }
-
-    throw new Error("Couldn't detect Webiny project.");
-}
-
-function getConfig({ cwd } = {}) {
-    let path = findUp.sync(projectConfigs, { cwd });
-    if (path) {
-        return importModule(path);
-    }
-
-    path = findUp.sync("webiny.root.js", { cwd });
-    if (path) {
-        return require(path);
-    }
-
-    throw new Error("Couldn't detect Webiny project.");
-}
-
-module.exports = args => {
-    const root = getRoot(args);
-    return {
-        get name() {
-            // Check "projectName" for backwards compatibility.
-            return process.env.WEBINY_PROJECT_NAME || this.config.projectName || this.config.name;
-        },
-        root,
-        get config() {
-            return getConfig(args);
-        }
-    };
-};