@chabokan.net/cli 0.8.15 → 0.9.1

package/dist/commands/cloudserver/create.js

@@ -0,0 +1,242 @@
+import { Flags } from '@oclif/core';
+import Command from "../../base.js";
+import { handleApiError, logErrorDetails, extractRecords, isObject, stripHtml } from "../../helper.js";
+import * as ui from "../../ui.js";
+import inquirer from 'inquirer';
+import axios from "axios";
+export default class CloudserverCreate extends Command {
+    static description = 'create a new cloud server (VPS) — walks through provider, location, plan, OS and wallet';
+    static examples = [
+        {
+            description: 'Create a cloud server, choosing every option interactively',
+            command: '<%= config.bin %> cloudserver create',
+        },
+        {
+            description: 'Skip the hostname prompt',
+            command: '<%= config.bin %> cloudserver create --hostname my-vps',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+        hostname: Flags.string({ description: 'hostname for the new cloud server' }),
+        wallet: Flags.string({ description: 'name of the wallet to pay from' }),
+    };
+    async run() {
+        const { flags } = await this.parse(CloudserverCreate);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        const cloud = await this.pick('cloud provider', 'get', 'cloudservers/cloud/', undefined, ['clouds']);
+        if (!cloud)
+            return;
+        const locationResult = await this.pick_location(cloud.value);
+        if (!locationResult)
+            return;
+        const { location, descriptionConfirmed } = locationResult;
+        const plan = await this.pick('plan', 'post', 'cloudservers/plans/', { cloud_location_id: location.value }, ['plans'], (r) => ({ value: String(r.id), name: `${r.cpu} CPU / ${r.ram} MB RAM / ${r.disk} GB disk — ${r.hourly_price} per hour` }));
+        if (!plan)
+            return;
+        const osTemplate = await this.pick('operating system', 'post', 'cloudservers/os/', { cloud_plan_id: plan.value }, ['cloud_base_templates'], (r) => ({ value: String(r.id), name: String(r.name) }));
+        if (!osTemplate)
+            return;
+        const osVersion = await this.pick('OS version', 'post', 'cloudservers/os/versions/', { cloud_template_name: osTemplate.name, cloud_plan_id: plan.value }, ['cloud_template_versions'], (r) => ({ value: String(r.id), name: String(r.name) }));
+        if (!osVersion)
+            return;
+        const hostname = await this.pick_hostname(flags.hostname);
+        if (!hostname)
+            return;
+        const wallet = await this.select_wallet(flags.wallet);
+        if (!wallet)
+            return;
+        cli.log(ui.info('About to create:'));
+        ui.printRecord({
+            Provider: cloud.name,
+            Location: location.name,
+            Plan: plan.name,
+            OS: `${osTemplate.name} ${osVersion.name}`,
+            Hostname: hostname,
+            Wallet: wallet.name,
+        });
+        const { confirmed } = await inquirer.prompt({
+            type: 'confirm',
+            name: 'confirmed',
+            message: 'This will start billing your wallet immediately. Create this cloud server?',
+            default: false,
+        });
+        if (!confirmed) {
+            cli.log(ui.info('Cancelled.'));
+            return;
+        }
+        try {
+            const { data } = await axios.post('cloudservers/create/', {
+                cloud: cloud.value,
+                cloud_location: location.value,
+                hostname,
+                cloud_plan: plan.value,
+                cloud_template: osTemplate.name,
+                cloud_template_version: osVersion.value,
+                wallet: wallet.id,
+                // Undocumented: this location's API response included a
+                // datacenter disclaimer under `extra_data.description`, and
+                // creation is rejected until it's echoed back as accepted. The
+                // exact field name isn't in the OpenAPI schema — reverse-engineered
+                // from the rejection message.
+                ...(descriptionConfirmed === undefined ? {} : { confirm_description: descriptionConfirmed }),
+            }, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Cloud server ${ui.value(hostname)} is being created.`));
+                cli.log(ui.hint(`Check on it with ${ui.cmd('chabok cloudserver list')}`));
+            }
+            else {
+                cli.log(ui.error(`Could not create the cloud server. ${data.message || 'Please try again in a moment.'}`));
+            }
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to create cloud server.', {
+                endpoint: 'cloudservers/create/',
+                operation: 'Create Cloudserver'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+    /**
+     * Fetches locations for `cloudId` and lets the user pick one. Some
+     * locations (notably Iranian ones) come with a legal disclaimer under
+     * `extra_data.description` that the user must read and accept before the
+     * server can be created — this isn't documented in the OpenAPI schema at
+     * all, only discovered by hitting the create endpoint's rejection message.
+     */
+    async pick_location(cloudId) {
+        let data;
+        try {
+            ({ data } = await axios.post('cloudservers/locations/', { cloud_id: cloudId }, this.axiosConfig));
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to fetch location options.', {
+                endpoint: 'cloudservers/locations/',
+                operation: 'Fetch location',
+            });
+            this.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, this);
+            return undefined;
+        }
+        const records = extractRecords(data, ['locations']);
+        if (records.length === 0) {
+            this.log(ui.error('No location options are available.'));
+            return undefined;
+        }
+        const choices = records.map((r) => ({ value: String(r.id), name: `${r.city ?? r.region ?? r.id}${r.status ? ` (${r.status})` : ''}` }));
+        let location = choices[0];
+        if (choices.length > 1) {
+            const { picked } = await inquirer.prompt({
+                type: 'select',
+                message: 'Select a location:',
+                name: 'picked',
+                choices,
+            });
+            location = choices.find((c) => c.value === picked);
+        }
+        if (!location)
+            return undefined;
+        const description = isObject(data) && typeof data.extra_data === 'object' && data.extra_data !== null && 'description' in data.extra_data && typeof data.extra_data.description === 'string'
+            ? stripHtml(data.extra_data.description)
+            : undefined;
+        if (!description) {
+            return { location, descriptionConfirmed: undefined };
+        }
+        this.log(ui.info('This location comes with the following terms:'));
+        this.log(description);
+        const { confirmed } = await inquirer.prompt({
+            type: 'confirm',
+            name: 'confirmed',
+            message: 'Do you accept these terms?',
+            default: false,
+        });
+        if (!confirmed) {
+            this.log(ui.info('Cancelled.'));
+            return undefined;
+        }
+        return { location, descriptionConfirmed: true };
+    }
+    async pick_hostname(flagValue) {
+        let hostname = flagValue;
+        // Each retry depends on what the user typed (or the previous check's
+        // rejection), so this loop is inherently sequential.
+        /* eslint-disable no-await-in-loop */
+        while (true) {
+            if (!hostname) {
+                ({ hostname } = await inquirer.prompt({
+                    type: 'input',
+                    name: 'hostname',
+                    message: 'Hostname:',
+                    validate(input) {
+                        return input.trim().length > 0 || 'Hostname cannot be empty';
+                    },
+                }));
+            }
+            hostname = hostname.trim();
+            try {
+                const { data } = await axios.post('cloudservers/name-check/', { hostname }, this.axiosConfig);
+                if (data.success) {
+                    return hostname;
+                }
+                this.log(ui.error(`${ui.value(hostname)} is not available. ${data.message || 'Choose a different hostname.'}`));
+            }
+            catch (error) {
+                const errorInfo = handleApiError(error, 'Failed to check hostname.', {
+                    endpoint: 'cloudservers/name-check/',
+                    operation: 'Check Hostname'
+                });
+                this.log(ui.error(errorInfo.message));
+                logErrorDetails(errorInfo, this);
+                return undefined;
+            }
+            hostname = undefined;
+        }
+        /* eslint-enable no-await-in-loop */
+    }
+    /**
+     * Fetches a list from `endpoint`, lets the user pick one, and returns its
+     * {value, name}. `toChoice` defaults to a generic id/name mapper, but most
+     * of these endpoints have a known shape (learned by hand against the live
+     * API), so callers pass an explicit mapper for a clearer label. `value` is
+     * whatever the create request needs (an id) — the choice list itself only
+     * ever shows `name`.
+     */
+    async pick(label, method, endpoint, body, wrapperKeys, toChoice = (r) => ({ value: String(r.id), name: String(r.name ?? r.id) })) {
+        let records;
+        try {
+            const { data } = method === 'get'
+                ? await axios.get(endpoint, this.axiosConfig)
+                : await axios.post(endpoint, body, this.axiosConfig);
+            records = extractRecords(data, wrapperKeys);
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, `Failed to fetch ${label} options.`, {
+                endpoint,
+                operation: `Fetch ${label}`,
+            });
+            this.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, this);
+            return undefined;
+        }
+        if (records.length === 0) {
+            this.log(ui.error(`No ${label} options are available.`));
+            return undefined;
+        }
+        const choices = records.map(toChoice);
+        if (choices.length === 1) {
+            return choices[0];
+        }
+        const { picked } = await inquirer.prompt({
+            type: 'select',
+            message: `Select a ${label}:`,
+            name: 'picked',
+            choices,
+        });
+        return choices.find((c) => c.value === picked);
+    }
+}

package/dist/commands/cloudserver/delete.d.ts

@@ -0,0 +1,14 @@
+import Command from "../../base.js";
+export default class CloudserverDelete extends Command {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static flags: {
+        hostname: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/cloudserver/delete.js

@@ -0,0 +1,65 @@
+import { Flags } from '@oclif/core';
+import Command from "../../base.js";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
+import inquirer from 'inquirer';
+import axios from "axios";
+export default class CloudserverDelete extends Command {
+    static description = 'permanently delete a cloud server';
+    static examples = [
+        {
+            description: 'Pick a cloud server from an interactive list, then confirm',
+            command: '<%= config.bin %> cloudserver delete',
+        },
+        {
+            description: 'Delete a specific cloud server without a confirmation prompt',
+            command: '<%= config.bin %> cloudserver delete --hostname my-vps --yes',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+        hostname: Flags.string({ description: 'hostname of the cloud server to delete' }),
+        yes: Flags.boolean({ char: 'y', description: 'skip the confirmation prompt', default: false }),
+    };
+    async run() {
+        const { flags } = await this.parse(CloudserverDelete);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        const selected = await this.select_cloud_server(flags.hostname, 'Delete Cloudserver');
+        if (!selected) {
+            return;
+        }
+        if (!flags.yes) {
+            const { confirmed } = await inquirer.prompt({
+                type: 'confirm',
+                name: 'confirmed',
+                message: `Delete cloud server ${selected.hostname}? This cannot be undone.`,
+                default: false,
+            });
+            if (!confirmed) {
+                cli.log(ui.info('Cancelled.'));
+                return;
+            }
+        }
+        try {
+            const { data } = await axios.post('cloudservers/delete/', { cloud_server_id: selected.id }, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Cloud server ${ui.value(selected.hostname)} was deleted.`));
+            }
+            else {
+                cli.log(ui.error(`Could not delete ${ui.value(selected.hostname)}. ${data.message || 'Please try again in a moment.'}`));
+            }
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to delete cloud server.', {
+                endpoint: 'cloudservers/delete/',
+                operation: 'Delete Cloudserver'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+}

package/dist/commands/cloudserver/list.d.ts

@@ -0,0 +1,12 @@
+import Command from "../../base.js";
+export default class CloudserverList extends Command {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static flags: {
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/cloudserver/list.js

@@ -0,0 +1,46 @@
+import Command from "../../base.js";
+import * as ui from "../../ui.js";
+import { handleApiError, logErrorDetails, extractRecords } from "../../helper.js";
+import axios from "axios";
+export default class CloudserverList extends Command {
+    static description = "list the cloud servers (VPS) on your account";
+    static examples = [
+        {
+            description: 'List every cloud server on the active account',
+            command: '<%= config.bin %> cloudserver list',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+    };
+    async run() {
+        await this.parse(CloudserverList);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        try {
+            const { data } = await axios.get('cloudservers/', this.axiosConfig);
+            const cloudservers = extractRecords(data, ['user_cloud_servers', 'cloudservers', 'results', 'data']);
+            if (cloudservers.length === 0) {
+                cli.log(ui.info('You have no cloud servers yet.'));
+                cli.log(ui.hint('Create one at https://hub.chabokan.net'));
+                return;
+            }
+            // The internal id is plumbing for the API, not something the user
+            // needs — every command refers to cloud servers by hostname instead.
+            const displayRecords = cloudservers.map(({ id: _id, ...rest }) => rest);
+            ui.printRecords(displayRecords);
+            cli.log(ui.hint(`Act on one with ${ui.cmd('chabok cloudserver restart')}, ${ui.cmd('start')}, ${ui.cmd('stop')} …`));
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to fetch cloud servers list.', {
+                endpoint: 'cloudservers/',
+                operation: 'List Cloudservers'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+}

package/dist/commands/cloudserver/restart.d.ts

@@ -0,0 +1,13 @@
+import Command from "../../base.js";
+export default class CloudserverRestart extends Command {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static flags: {
+        hostname: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/cloudserver/restart.js

@@ -0,0 +1,51 @@
+import { Flags } from '@oclif/core';
+import Command from "../../base.js";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
+import axios from "axios";
+export default class CloudserverRestart extends Command {
+    static description = 'restart a cloud server';
+    static examples = [
+        {
+            description: 'Pick a cloud server from an interactive list',
+            command: '<%= config.bin %> cloudserver restart',
+        },
+        {
+            description: 'Restart a specific cloud server by hostname',
+            command: '<%= config.bin %> cloudserver restart --hostname my-vps',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+        hostname: Flags.string({ description: 'hostname of the cloud server to restart' }),
+    };
+    async run() {
+        const { flags } = await this.parse(CloudserverRestart);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        const selected = await this.select_cloud_server(flags.hostname, 'Restart Cloudserver');
+        if (!selected) {
+            return;
+        }
+        try {
+            const { data } = await axios.post('cloudservers/restart/', { cloud_server_id: selected.id }, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Cloud server ${ui.value(selected.hostname)} is restarting.`));
+            }
+            else {
+                cli.log(ui.error(`Could not restart ${ui.value(selected.hostname)}. ${data.message || 'Please try again in a moment.'}`));
+            }
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to restart cloud server.', {
+                endpoint: 'cloudservers/restart/',
+                operation: 'Restart Cloudserver'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+}

package/dist/commands/cloudserver/start.d.ts

@@ -0,0 +1,13 @@
+import Command from "../../base.js";
+export default class CloudserverStart extends Command {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static flags: {
+        hostname: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/cloudserver/start.js

@@ -0,0 +1,51 @@
+import { Flags } from '@oclif/core';
+import Command from "../../base.js";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
+import axios from "axios";
+export default class CloudserverStart extends Command {
+    static description = 'turn on a cloud server';
+    static examples = [
+        {
+            description: 'Pick a cloud server from an interactive list',
+            command: '<%= config.bin %> cloudserver start',
+        },
+        {
+            description: 'Turn on a specific cloud server by hostname',
+            command: '<%= config.bin %> cloudserver start --hostname my-vps',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+        hostname: Flags.string({ description: 'hostname of the cloud server to turn on' }),
+    };
+    async run() {
+        const { flags } = await this.parse(CloudserverStart);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        const selected = await this.select_cloud_server(flags.hostname, 'Start Cloudserver');
+        if (!selected) {
+            return;
+        }
+        try {
+            const { data } = await axios.post('cloudservers/start/', { cloud_server_id: selected.id }, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Cloud server ${ui.value(selected.hostname)} is starting.`));
+            }
+            else {
+                cli.log(ui.error(`Could not start ${ui.value(selected.hostname)}. ${data.message || 'Please try again in a moment.'}`));
+            }
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to start cloud server.', {
+                endpoint: 'cloudservers/start/',
+                operation: 'Start Cloudserver'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+}

package/dist/commands/cloudserver/stop.d.ts

@@ -0,0 +1,13 @@
+import Command from "../../base.js";
+export default class CloudserverStop extends Command {
+    static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
+    static flags: {
+        hostname: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/cloudserver/stop.js

@@ -0,0 +1,52 @@
+import { Flags } from '@oclif/core';
+import Command from "../../base.js";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
+import axios from "axios";
+export default class CloudserverStop extends Command {
+    static description = 'turn off a cloud server';
+    static examples = [
+        {
+            description: 'Pick a cloud server from an interactive list',
+            command: '<%= config.bin %> cloudserver stop',
+        },
+        {
+            description: 'Turn off a specific cloud server by hostname',
+            command: '<%= config.bin %> cloudserver stop --hostname my-vps',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+        hostname: Flags.string({ description: 'hostname of the cloud server to turn off' }),
+    };
+    async run() {
+        const { flags } = await this.parse(CloudserverStop);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        const selected = await this.select_cloud_server(flags.hostname, 'Stop Cloudserver');
+        if (!selected) {
+            return;
+        }
+        try {
+            const { data } = await axios.post('cloudservers/stop/', { cloud_server_id: selected.id }, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Cloud server ${ui.value(selected.hostname)} is stopping.`));
+                cli.log(ui.hint(`Bring it back with ${ui.cmd(`chabok cloudserver start --hostname ${selected.hostname}`)}`));
+            }
+            else {
+                cli.log(ui.error(`Could not stop ${ui.value(selected.hostname)}. ${data.message || 'Please try again in a moment.'}`));
+            }
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to stop cloud server.', {
+                endpoint: 'cloudservers/stop/',
+                operation: 'Stop Cloudserver'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+}

package/dist/commands/deploy.d.ts

@@ -2,12 +2,22 @@ import Command from "../base.js";
 import type { ChabokFile } from "../types.js";
 export default class Deploy extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        path: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        service: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        path: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
+    /**
+     * Loads chabok.json from the project root. A missing file is normal; a
+     * malformed one is reported rather than silently ignored, because deploying
+     * with the wrong options is worse than not deploying.
+     */
+    read_chabok_file(project_path: string): ChabokFile;
     prepare_archive(project_path: string): Promise<string>;
     upload(archive_path: string, selected_service: string, cli: Command, chabok_file: ChabokFile): Promise<{
         success: boolean;