@chabokan.net/cli 0.8.10 → 0.9.0

package/dist/commands/service/restart.js

@@ -1,57 +1,66 @@
 import { Flags } from "@oclif/core";
 import Command from "../../base.js";
-import { isEmptyObject } from "../../helper.js";
-import chalk from "chalk";
-import inquirer from "inquirer";
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
 import axios from "axios";
 export default class ServiceRestart extends Command {
     static description = "restart a service";
+    static examples = [
+        {
+            description: 'Pick a service from an interactive list',
+            command: '<%= config.bin %> service restart',
+        },
+        {
+            description: 'Restart a specific service by name',
+            command: '<%= config.bin %> service restart --service my-app',
+        },
+        {
+            description: 'Restart, then tail the logs to confirm it came back up',
+            command: '<%= config.bin %> service restart -s my-app && <%= config.bin %> service logs -s my-app',
+        },
+    ];
     static flags = {
         ...Command.flags,
-        service: Flags.string({ char: "s", description: "service name" }),
+        service: Flags.string({ char: "s", description: "name of the service to restart" }),
     };
     async run() {
-        const { args, flags } = await this.parse(ServiceRestart);
+        const { flags } = await this.parse(ServiceRestart);
         const cli = this;
         await this.init_run();
-        const config_json = await this.read_config();
-        let selected_service = flags.service;
-        if (isEmptyObject(config_json.users)) {
-            cli.log(`${chalk.red("[Error]")} first you should login!`);
+        if (!(await this.require_login())) {
             return;
         }
-        if (!flags.service) {
-            let all_services = await this.get_services({
-                not_status: "pending",
-            });
-            if (all_services) {
-                let { service } = await inquirer.prompt({
-                    type: "list",
-                    message: "Please select a service:",
-                    name: "service",
-                    choices: all_services,
-                });
-                selected_service = service;
-            }
+        const selected_service = await this.select_service(flags.service, { not_status: "pending" }, "Restart Service");
+        if (!selected_service) {
+            return;
         }
         await this.send_request(cli, selected_service);
     }
     async send_request(cli, selected_service) {
         try {
-            if (selected_service) {
-                const { data } = await axios.get("services/" + selected_service + "/restart/", this.axiosConfig);
-                if (data.success) {
-                    cli.log(`${chalk.green("[Success]")} service restarted successfully.`);
-                }
+            const { data } = await axios.get(`services/${selected_service}/restart/`, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Service ${ui.value(selected_service)} is restarting.`));
+                cli.log(ui.hint(`Follow its output with ${ui.cmd(`chabok service logs -s ${selected_service}`)}`));
+            }
+            else {
+                cli.log(ui.error(`Could not restart ${ui.value(selected_service)}. ${data.message || 'Please try again in a moment.'}`));
             }
         }
-        catch (e) {
-            if (e.response.status == 404) {
-                cli.log(chalk.blue("Selected Service Not Founded."));
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to restart service.', {
+                endpoint: `services/${selected_service}/restart/`,
+                serviceName: selected_service,
+                operation: 'Restart Service'
+            });
+            if (errorInfo.status === 404) {
+                cli.log(ui.error(`Service ${ui.value(selected_service)} was not found.`));
+                cli.log(ui.hint(`Check the available names with ${ui.cmd('chabok service list')}`));
             }
             else {
-                console.log(e.data);
+                cli.log(ui.error(errorInfo.message));
             }
+            logErrorDetails(errorInfo, cli);
         }
     }
 }

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

@@ -1,10 +1,14 @@
 import Command from "../../base.js";
 export default class ServiceStart extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        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>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
-    send_request(cli: any, selected_service: any): Promise<void>;
+    send_request(cli: Command, selected_service: string): Promise<void>;
 }

package/dist/commands/service/start.js

@@ -1,55 +1,66 @@
 import { Flags } from '@oclif/core';
 import Command from "../../base.js";
-import { isEmptyObject } from "../../helper.js";
-import chalk from "chalk";
-import inquirer from 'inquirer';
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
 import axios from "axios";
 export default class ServiceStart extends Command {
-    static description = 'start a service';
+    static description = 'start a stopped service';
+    static examples = [
+        {
+            description: 'Pick a service from an interactive list',
+            command: '<%= config.bin %> service start',
+        },
+        {
+            description: 'Start a specific service by name',
+            command: '<%= config.bin %> service start --service my-app',
+        },
+        {
+            description: 'Same, using the short flag',
+            command: '<%= config.bin %> service start -s my-app',
+        },
+    ];
     static flags = {
         ...Command.flags,
-        service: Flags.string({ char: 's', description: 'service name' }),
+        service: Flags.string({ char: 's', description: 'name of the service to start' }),
     };
     async run() {
-        const { args, flags } = await this.parse(ServiceStart);
+        const { flags } = await this.parse(ServiceStart);
         const cli = this;
         await this.init_run();
-        const config_json = await this.read_config();
-        let selected_service = flags.service;
-        if (isEmptyObject(config_json.users)) {
-            cli.log(`${chalk.red('[Error]')} first you should login!`);
+        if (!(await this.require_login())) {
             return;
         }
-        if (!flags.service) {
-            let all_services = await this.get_services({ 'not_status': 'pending' });
-            if (all_services) {
-                let { service } = await inquirer.prompt({
-                    type: 'list',
-                    message: 'Please select a service:',
-                    name: 'service',
-                    choices: all_services
-                });
-                selected_service = service;
-            }
+        const selected_service = await this.select_service(flags.service, { 'not_status': 'pending' }, 'Start Service');
+        if (!selected_service) {
+            return;
         }
         await this.send_request(cli, selected_service);
     }
     async send_request(cli, selected_service) {
         try {
-            if (selected_service) {
-                const { data } = await axios.get("services/" + selected_service + "/start/", this.axiosConfig);
-                if (data.success) {
-                    cli.log(`${chalk.green('[Success]')} service start successfully.`);
-                }
+            const { data } = await axios.get(`services/${selected_service}/start/`, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Service ${ui.value(selected_service)} is starting.`));
+                cli.log(ui.hint(`Follow its output with ${ui.cmd(`chabok service logs -s ${selected_service}`)}`));
+            }
+            else {
+                cli.log(ui.error(`Could not start ${ui.value(selected_service)}. ${data.message || 'Check the service status and try again.'}`));
             }
         }
-        catch (e) {
-            if (e.response.status == 404) {
-                cli.log(chalk.blue("Selected Service Not Founded."));
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to start service.', {
+                endpoint: `services/${selected_service}/start/`,
+                serviceName: selected_service,
+                operation: 'Start Service'
+            });
+            if (errorInfo.status === 404) {
+                cli.log(ui.error(`Service ${ui.value(selected_service)} was not found.`));
+                cli.log(ui.hint(`Check the available names with ${ui.cmd('chabok service list')}`));
             }
             else {
-                console.log(e.data);
+                cli.log(ui.error(errorInfo.message));
             }
+            logErrorDetails(errorInfo, cli);
         }
     }
 }

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

@@ -1,10 +1,14 @@
 import Command from "../../base.js";
 export default class ServiceStop extends Command {
     static description: string;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     static flags: {
-        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>;
+        service: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        help: import("@oclif/core/interfaces").BooleanFlag<void>;
     };
     run(): Promise<void>;
-    send_request(cli: any, selected_service: any): Promise<void>;
+    send_request(cli: Command, selected_service: string): Promise<void>;
 }

package/dist/commands/service/stop.js

@@ -1,55 +1,66 @@
 import { Flags } from '@oclif/core';
 import Command from "../../base.js";
-import { isEmptyObject } from "../../helper.js";
-import chalk from "chalk";
-import inquirer from 'inquirer';
+import { handleApiError, logErrorDetails } from "../../helper.js";
+import * as ui from "../../ui.js";
 import axios from "axios";
 export default class ServiceStop extends Command {
-    static description = 'stop a service';
+    static description = 'stop a running service';
+    static examples = [
+        {
+            description: 'Pick a service from an interactive list',
+            command: '<%= config.bin %> service stop',
+        },
+        {
+            description: 'Stop a specific service by name',
+            command: '<%= config.bin %> service stop --service my-app',
+        },
+        {
+            description: 'Same, using the short flag',
+            command: '<%= config.bin %> service stop -s my-app',
+        },
+    ];
     static flags = {
         ...Command.flags,
-        service: Flags.string({ char: 's', description: 'service name' }),
+        service: Flags.string({ char: 's', description: 'name of the service to stop' }),
     };
     async run() {
-        const { args, flags } = await this.parse(ServiceStop);
+        const { flags } = await this.parse(ServiceStop);
         const cli = this;
         await this.init_run();
-        const config_json = await this.read_config();
-        let selected_service = flags.service;
-        if (isEmptyObject(config_json.users)) {
-            cli.log(`${chalk.red('[Error]')} first you should login!`);
+        if (!(await this.require_login())) {
             return;
         }
-        if (!flags.service) {
-            let all_services = await this.get_services({ 'not_status': 'pending' });
-            if (all_services) {
-                let { service } = await inquirer.prompt({
-                    type: 'list',
-                    message: 'Please select a service:',
-                    name: 'service',
-                    choices: all_services
-                });
-                selected_service = service;
-            }
+        const selected_service = await this.select_service(flags.service, { 'not_status': 'pending' }, 'Stop Service');
+        if (!selected_service) {
+            return;
         }
         await this.send_request(cli, selected_service);
     }
     async send_request(cli, selected_service) {
         try {
-            if (selected_service) {
-                const { data } = await axios.get("services/" + selected_service + "/stop/", this.axiosConfig);
-                if (data.success) {
-                    cli.log(`${chalk.green('[Success]')} service stop successfully.`);
-                }
+            const { data } = await axios.get(`services/${selected_service}/stop/`, this.axiosConfig);
+            if (data.success) {
+                cli.log(ui.success(`Service ${ui.value(selected_service)} is stopping.`));
+                cli.log(ui.hint(`Bring it back with ${ui.cmd(`chabok service start -s ${selected_service}`)}`));
+            }
+            else {
+                cli.log(ui.error(`Could not stop ${ui.value(selected_service)}. ${data.message || 'Please try again in a moment.'}`));
             }
         }
-        catch (e) {
-            if (e.response.status == 404) {
-                cli.log(chalk.blue("Selected Service Not Founded."));
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to stop service.', {
+                endpoint: `services/${selected_service}/stop/`,
+                serviceName: selected_service,
+                operation: 'Stop Service'
+            });
+            if (errorInfo.status === 404) {
+                cli.log(ui.error(`Service ${ui.value(selected_service)} was not found.`));
+                cli.log(ui.hint(`Check the available names with ${ui.cmd('chabok service list')}`));
             }
             else {
-                console.log(e.data);
+                cli.log(ui.error(errorInfo.message));
             }
+            logErrorDetails(errorInfo, cli);
         }
     }
 }

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

@@ -0,0 +1,12 @@
+import Command from "../../base.js";
+export default class WalletList 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/wallet/list.js

@@ -0,0 +1,41 @@
+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 WalletList extends Command {
+    static description = "list the wallets on your account";
+    static examples = [
+        {
+            description: 'Show every wallet and its balance',
+            command: '<%= config.bin %> wallet list',
+        },
+    ];
+    static flags = {
+        ...Command.flags,
+    };
+    async run() {
+        await this.parse(WalletList);
+        const cli = this;
+        await this.init_run();
+        if (!(await this.require_login())) {
+            return;
+        }
+        try {
+            const { data } = await axios.get('wallets/', this.axiosConfig);
+            const wallets = extractRecords(data, ['wallets', 'results', 'data']);
+            if (wallets.length === 0) {
+                cli.log(ui.info('You have no wallets yet.'));
+                return;
+            }
+            ui.printRecords(wallets);
+        }
+        catch (error) {
+            const errorInfo = handleApiError(error, 'Failed to fetch wallets.', {
+                endpoint: 'wallets/',
+                operation: 'List Wallets'
+            });
+            cli.log(ui.error(errorInfo.message));
+            logErrorDetails(errorInfo, cli);
+        }
+    }
+}

package/dist/constants.d.ts

@@ -1,2 +1,4 @@
 export declare const GLOBAL_CONF_PATH: string;
 export declare let BASE_API_URL: string;
+export declare const REQUEST_TIMEOUT = 30000;
+export declare const UPLOAD_TIMEOUT: number;

package/dist/constants.js

@@ -1,7 +1,12 @@
-import * as path from 'path';
-import * as os from 'os';
+import * as path from 'node:path';
+import * as os from 'node:os';
 export const GLOBAL_CONF_PATH = path.join(os.homedir(), '.chabok.json');
 export let BASE_API_URL = 'https://apihub.chabokan.net/fa/api/v1/';
 if (process.env.CHABOK_API_URL) {
     BASE_API_URL = process.env.CHABOK_API_URL;
 }
+// Timeout for regular API calls. Deploy uploads use their own (much longer)
+// budget, so this only bounds the short control-plane requests.
+export const REQUEST_TIMEOUT = 30_000;
+// Deploy uploads can legitimately take minutes on a slow connection.
+export const UPLOAD_TIMEOUT = 30 * 60 * 1000;

package/dist/helper.d.ts

@@ -1,12 +1,35 @@
-import { Ignore } from 'ignore';
-export declare function isObject(obj: any): boolean;
-export declare function isEmptyObject(obj: any): any;
-export declare function read_config_file(): {
-    users: {};
-    default_user: string;
-};
-export declare function get_all_services(filter: {} | undefined, axiosConfig: any): Promise<any>;
+import { AxiosRequestConfig } from "axios";
+import type { Ignore } from 'ignore';
+import type { ConfigFile, Service, ErrorInfo, ErrorContext } from './types.js';
+/** Some API error/description text comes wrapped in HTML tags (e.g. `<p>...</p>`). */
+export declare function stripHtml(text: string): string;
+export declare function isDebug(): boolean;
+export declare function isObject(obj: unknown): obj is Record<string, unknown>;
+export declare function isEmptyObject(obj: unknown): boolean;
+export declare function read_config_file(): ConfigFile;
+export declare function write_config_file(config_json: ConfigFile): void;
+/**
+ * Fetches the account's services. Throws on failure so callers can surface a
+ * real error instead of an empty list that reads as "you have no services".
+ */
+export declare function get_all_services(filter: Record<string, string> | undefined, axiosConfig: AxiosRequestConfig): Promise<Service[]>;
+/**
+ * Pulls a list of records out of an API response whose exact wrapper key
+ * isn't guaranteed (some endpoints return a bare array, others wrap it under
+ * `data`, `results`, or a resource-named key).
+ */
+export declare function extractRecords(data: unknown, wrapperKeys?: string[]): Record<string, unknown>[];
 export declare function trimLines(lines: string[]): string[];
 export declare const loadIgnoreFile: (ignoreInstance: Ignore, ignoreFilePath: string, projectPath: string) => void;
 export declare function addIgnorePatterns(ignoreInstance: Ignore, projectPath: string, dir: string): void;
-export declare const checkUpdate: (version: any) => Promise<void>;
+/**
+ * Tells the user about a newer release. This runs ahead of every command, so it
+ * is deliberately defensive: it is skippable, it only hits the network once a
+ * day, it gives up after 1.5s, and any failure is silent. A user with no
+ * internet should not notice that this function exists.
+ */
+export declare const checkUpdate: (version: string) => Promise<void>;
+export declare function handleApiError(error: unknown, defaultMessage: string, context?: ErrorContext): ErrorInfo;
+export declare function logErrorDetails(errorInfo: ErrorInfo, command: {
+    log: (msg: string) => void;
+}): void;