@api-now/cli 1.0.4 → 1.2.0

package/dist/utils/config.js

@@ -1,202 +0,0 @@
-import os from 'node:os';
-import path from 'node:path';
-import fs from 'node:fs';
-/**
- * The fallback API URL when not configured.
- */
-const DEFAULT_API_URL = 'http://localhost:8080';
-/**
- * The folder name for the CLI configuration.
- */
-const CLI_FOLDER = 'apinow-cli';
-/**
- * The config file name.
- */
-const CONFIG_FILE = 'config.json';
-/**
- * Manager class for resolving, loading, and saturating the CLI configuration.
- */
-class CliConfigManager {
-    _resolved = null;
-    /**
-     * The resolved read-only CLI configuration.
-     */
-    get resolved() {
-        if (!this._resolved) {
-            this.load();
-        }
-        const res = this._resolved;
-        if (!res) {
-            throw new Error('Configuration could not be loaded.');
-        }
-        return res;
-    }
-    /**
-     * The directory path for storing configuration files.
-     */
-    configDir = this.#getConfigDir();
-    /**
-     * The absolute configuration file path.
-     */
-    configPath = path.join(this.configDir, CONFIG_FILE);
-    /**
-     * Loads configuration from disk and environment variables.
-     */
-    load() {
-        const diskConfig = this.#readConfig();
-        const token = process.env.APINOW_API_TOKEN || process.env.APINOW_TOKEN || diskConfig.token;
-        const apiUrl = process.env.APINOW_API_URL || diskConfig.apiUrl || DEFAULT_API_URL;
-        const org = diskConfig.org || '';
-        this._resolved = {
-            token,
-            apiUrl,
-            org,
-            format: 'text',
-        };
-    }
-    /**
-     * Saturates/overrides configuration fields with commander options.
-     */
-    saturate(options) {
-        if (!this._resolved) {
-            this.load();
-        }
-        const current = this._resolved;
-        if (!current) {
-            throw new Error('Configuration could not be loaded.');
-        }
-        this._resolved = {
-            token: current.token,
-            apiUrl: options.apiUrl || current.apiUrl,
-            org: current.org,
-            format: options.format === 'json' ? 'json' : 'text',
-        };
-    }
-    /**
-     * Returns the directory path for storing configuration files depending on the OS platform.
-     *
-     * - Windows: `%APPDATA%/apinow-cli`
-     * - MacOS: `~/Library/Preferences/apinow-cli`
-     * - Linux: `~/.config/apinow-cli` (or respects `$XDG_CONFIG_HOME`)
-     *
-     * @returns The absolute directory path.
-     */
-    #getConfigDir() {
-        if (process.platform === 'win32') {
-            const appData = process.env.APPDATA || path.join(os.homedir(), 'AppData', 'Roaming');
-            if (!appData) {
-                throw new Error('Could not determine the configuration directory.');
-            }
-            return path.join(appData, CLI_FOLDER);
-        }
-        if (process.platform === 'darwin') {
-            return path.join(os.homedir(), 'Library', 'Preferences', CLI_FOLDER);
-        }
-        return path.join(process.env.XDG_CONFIG_HOME || path.join(os.homedir(), '.config'), CLI_FOLDER);
-    }
-    /**
-     * Reads and parses the CLI configuration from the configuration file.
-     * If the configuration file does not exist, returns default settings.
-     *
-     * @example
-     * ```typescript
-     * const config = this.#readConfig();
-     * console.log(config.apiUrl);
-     * ```
-     *
-     * @returns The current configuration object.
-     */
-    #readConfig() {
-        try {
-            if (!fs.existsSync(this.configPath)) {
-                return { apiUrl: DEFAULT_API_URL };
-            }
-            const content = fs.readFileSync(this.configPath, 'utf8');
-            const config = JSON.parse(content);
-            return {
-                apiUrl: DEFAULT_API_URL,
-                ...config,
-            };
-        }
-        catch (_error) {
-            return { apiUrl: DEFAULT_API_URL };
-        }
-    }
-    /**
-     * Writes a single property to the configuration file on disk.
-     */
-    writeProperty(key, value) {
-        const current = this.#readConfig();
-        current[key] = value;
-        this.#writeConfig(current);
-    }
-    /**
-     * Merges and writes the provided settings to the configuration file on disk.
-     * Creates the directory structure if it does not exist.
-     *
-     * @example
-     * ```typescript
-     * writeConfig({ token: 'my-secret-token' });
-     * ```
-     *
-     * @param config A partial config object containing keys to set or update.
-     */
-    #writeConfig(config) {
-        try {
-            const current = this.#readConfig();
-            const updated = { ...current, ...config };
-            if (!fs.existsSync(this.configDir)) {
-                fs.mkdirSync(this.configDir, { recursive: true });
-            }
-            fs.writeFileSync(this.configPath, JSON.stringify(updated, null, 2), 'utf8');
-        }
-        catch (error) {
-            console.error('Failed to write configuration:', error);
-        }
-    }
-    /**
-     * Clears/removes a specific configuration key from the configuration file.
-     *
-     * @example
-     * ```typescript
-     * clearConfigKey('token');
-     * ```
-     *
-     * @param key The key of the CliConfig to remove.
-     */
-    clearConfigKey(key) {
-        try {
-            const current = this.#readConfig();
-            // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-            delete current[key];
-            if (!fs.existsSync(this.configDir)) {
-                fs.mkdirSync(this.configDir, { recursive: true });
-            }
-            fs.writeFileSync(this.configPath, JSON.stringify(current, null, 2), 'utf8');
-        }
-        catch (error) {
-            console.error(`Failed to clear key ${key} from configuration:`, error);
-        }
-    }
-    /**
-     * Resets/removes the configuration file and directory.
-     */
-    reset() {
-        try {
-            if (fs.existsSync(this.configPath)) {
-                fs.unlinkSync(this.configPath);
-            }
-            if (fs.existsSync(this.configDir)) {
-                const files = fs.readdirSync(this.configDir);
-                if (files.length === 0) {
-                    fs.rmdirSync(this.configDir);
-                }
-            }
-            this._resolved = null;
-        }
-        catch (error) {
-            console.error('Failed to reset configuration:', error);
-        }
-    }
-}
-export const config = new CliConfigManager();

package/dist/utils/formatter.js

@@ -1,195 +0,0 @@
-import { styleText } from 'node:util';
-import { createRequire } from 'node:module';
-const require = createRequire(import.meta.url);
-const pkg = require('../../package.json');
-const CLI_VERSION = pkg.version;
-/**
- * Standard error codes for the CLI.
- */
-export var CliErrorCode;
-(function (CliErrorCode) {
-    CliErrorCode["INVALID_ARGUMENT"] = "CLI_ERR_INVALID_ARGUMENT";
-    CliErrorCode["MISSING_REQUIRED"] = "CLI_ERR_MISSING_REQUIRED";
-    CliErrorCode["UNAUTHORIZED"] = "CLI_ERR_UNAUTHORIZED";
-    CliErrorCode["API_FAILURE"] = "CLI_ERR_API_FAILURE";
-    CliErrorCode["UNKNOWN"] = "CLI_ERR_UNKNOWN";
-})(CliErrorCode || (CliErrorCode = {}));
-/**
- * Global CLI text formatting and styling helper object using Node.js's native styleText.
- */
-export const style = {
-    green: (str) => styleText('green', str),
-    red: (str) => styleText('red', str),
-    yellow: (str) => styleText('yellow', str),
-    cyan: (str) => styleText('cyan', str),
-    dim: (str) => styleText('dim', str),
-    bold: (str) => styleText('bold', str),
-};
-/**
- * Global CLI debug logger.
- * Prints verbose info to stderr to avoid polluting stdout when piping/formatting.
- */
-export function debug(module, message) {
-    const isDebug = process.argv.includes('--debug') ||
-        process.argv.includes('--verbose') ||
-        (typeof process !== 'undefined' &&
-            process.env.DEBUG &&
-            (process.env.DEBUG === '*' || process.env.DEBUG.includes('apinow')));
-    if (isDebug) {
-        console.error(style.dim(`[debug][${module}] ${message}`));
-    }
-}
-/**
- * Aligning helper that formats rows and headers into a aligned column grid.
- *
- * @param rows - The data records to draw.
- * @param columns - The property keys of the records to draw.
- * @param customHeaders - Optional override titles for headers.
- * @returns The formatted string table.
- */
-function formatTable(rows, columns, customHeaders) {
-    if (rows.length === 0)
-        return 'No data available.';
-    const widths = {};
-    const displayHeaders = customHeaders || columns;
-    // Initialize widths with header sizes
-    for (let i = 0; i < columns.length; i++) {
-        const col = columns[i];
-        const headerName = displayHeaders[i] || col;
-        widths[col] = headerName.length;
-    }
-    // Adjust column widths based on content size
-    for (const row of rows) {
-        for (const col of columns) {
-            const val = typeof row[col] === 'object' && row[col] !== null ? JSON.stringify(row[col]) : String(row[col] ?? '');
-            if (val.length > (widths[col] || 0)) {
-                widths[col] = val.length;
-            }
-        }
-    }
-    // Build header row and separator
-    const header = columns
-        .map((col, idx) => {
-        const name = displayHeaders[idx] || col;
-        return name.toUpperCase().padEnd(widths[col]);
-    })
-        .join('  ');
-    const separator = columns.map((col) => '-'.repeat(widths[col])).join('  ');
-    // Build content rows
-    const formattedRows = rows.map((row) => {
-        return columns
-            .map((col) => {
-            const val = typeof row[col] === 'object' && row[col] !== null ? JSON.stringify(row[col]) : String(row[col] ?? '');
-            return val.padEnd(widths[col]);
-        })
-            .join('  ');
-    });
-    return [header, separator, ...formattedRows].join('\n');
-}
-/**
- * Output formatter class providing type-safe methods to write to standard output / error.
- */
-export class Formatter {
-    format;
-    /**
-     * Constructs a Formatter instance.
-     * @param options - Formatting configuration.
-     */
-    constructor(options = {}) {
-        this.format = options.format || 'text';
-    }
-    /**
-     * Outputs a success message to console.
-     *
-     * @param message - Short description of success.
-     * @param data - Optional data payload to print under the success.
-     */
-    success(message, data) {
-        if (this.format === 'json') {
-            console.log(JSON.stringify({ success: true, message, data }, null, 2));
-        }
-        else {
-            console.log(style.green(`✔ ${message}`));
-            if (data !== undefined) {
-                if (typeof data === 'object' && data !== null) {
-                    this.object(data);
-                }
-                else {
-                    console.log(data);
-                }
-            }
-        }
-    }
-    error(error) {
-        const code = error.code || CliErrorCode.UNKNOWN;
-        if (this.format === 'json') {
-            console.error(JSON.stringify({ success: false, code, cliVersion: CLI_VERSION, ...error }, null, 2));
-        }
-        else {
-            console.error(style.red(`✖ Error [${code}]: ${error.message}`));
-            if (error.detail) {
-                console.error(style.dim(error.detail));
-            }
-            if (error.errors && error.errors.length > 0) {
-                console.error('\nValidation errors:');
-                for (const err of error.errors) {
-                    console.error(`  - ${style.yellow(err.field)}: ${err.message}`);
-                }
-            }
-            console.error(style.dim(`(cli v${CLI_VERSION})`));
-            if (code === CliErrorCode.UNKNOWN) {
-                const repoUrl = 'https://github.com/api-now/cli';
-                const title = encodeURIComponent(`[BUG] CLI Crash: ${error.message}`);
-                const body = encodeURIComponent(`**CLI Version:** ${CLI_VERSION}
-**Error Code:** ${code}
-
-**Error Message:**
-${error.message}
-
-**Error Details / Stack:**
-\`\`\`
-${error.detail || 'No stack trace available'}
-\`\`\`
-`);
-                const bugReportUrl = `${repoUrl}/issues/new?title=${title}&body=${body}`;
-                console.error(`\nPlease report this bug: ${bugReportUrl}`);
-            }
-        }
-    }
-    /**
-     * Formats and prints a collection of records.
-     *
-     * @param rows - The array of items/records.
-     * @param columns - The keys to extract and show as table columns.
-     * @param options - Customization options such as custom headers.
-     */
-    list(rows, columns, options = {}) {
-        if (this.format === 'json') {
-            console.log(JSON.stringify(rows, null, 2));
-        }
-        else {
-            if (rows.length === 0) {
-                console.log('No records found.');
-                return;
-            }
-            console.log(formatTable(rows, columns, options.headers));
-        }
-    }
-    /**
-     * Prints a single record/object as key-value pairs.
-     *
-     * @param data - The object to print.
-     */
-    object(data) {
-        const record = data;
-        if (this.format === 'json') {
-            console.log(JSON.stringify(record, null, 2));
-        }
-        else {
-            for (const [key, value] of Object.entries(record)) {
-                const valStr = typeof value === 'object' && value !== null ? JSON.stringify(value) : String(value);
-                console.log(`${style.bold(key)}: ${valStr}`);
-            }
-        }
-    }
-}

package/dist/utils/org-setup.js

@@ -1,96 +0,0 @@
-import { config } from './config.js';
-import { style } from './formatter.js';
-import { askInput, askConfirm } from './prompt.js';
-import { handleApiError } from './api.js';
-/**
- * Checks if the user has any organizations. If not, guides them through setting up their first organization.
- *
- * @param client - The StoreSdk client.
- * @param formatter - The current output formatter.
- */
-export async function setupFirstOrganizationIfNeeded(client, formatter) {
-    // 1. Fetch organization list
-    let orgs;
-    try {
-        const res = await client.organizations.list({ token: client.token });
-        orgs = res.data || [];
-    }
-    catch (_err) {
-        // If we fail to fetch orgs (e.g. server is down or auth issue), return early
-        return;
-    }
-    // If the user already has organizations, check if a default is set.
-    if (orgs.length > 0) {
-        if (!config.resolved.org) {
-            const firstOrg = orgs[0];
-            const firstOrgId = firstOrg.key;
-            config.writeProperty('org', firstOrgId);
-            if (formatter.format !== 'json') {
-                console.log('\n' + style.cyan(`ℹ Automatically set default organization to "${firstOrg.name}" (${firstOrgId}).`));
-            }
-        }
-        return;
-    }
-    // If the format is JSON, do not prompt interactively.
-    if (formatter.format === 'json') {
-        return;
-    }
-    console.log('\n' + style.yellow('⚠ It looks like you do not have any organizations yet.'));
-    console.log("Let's set up your first organization now.");
-    let name = '';
-    while (!name) {
-        name = await askInput('Enter organization name:');
-        if (!name) {
-            console.log(style.red('Error: Organization name cannot be empty.'));
-        }
-    }
-    // 2. Generate slug from name using backend API
-    let slug;
-    try {
-        slug = await client.organizations.slugs.generate(name, { token: client.token });
-    }
-    catch (_err) {
-        slug = name
-            .toLowerCase()
-            .replace(/[^a-z0-9]+/g, '-')
-            .replace(/(^-|-$)/g, '');
-    }
-    const useSuggested = await askConfirm(`Use suggested organization slug "${slug}"?`, true);
-    if (!useSuggested) {
-        let isValid = false;
-        while (!isValid) {
-            const customSlug = await askInput('Enter organization slug:');
-            if (!customSlug) {
-                console.log(style.red('Error: Slug cannot be empty.'));
-                continue;
-            }
-            try {
-                const valData = await client.organizations.slugs.validate(customSlug, { token: client.token });
-                if (valData.valid) {
-                    slug = customSlug;
-                    isValid = true;
-                }
-                else {
-                    console.log(style.red(`Error: ${valData.reason || 'Invalid slug'}`));
-                }
-            }
-            catch (_err) {
-                console.log(style.red('Error validating slug with server. Please try another slug.'));
-            }
-        }
-    }
-    // 3. Create the organization
-    console.log(`\nCreating organization "${name}" with slug "${slug}"...`);
-    try {
-        const createdOrg = await client.organizations.create(name, slug, { token: client.token });
-        const orgId = createdOrg.key;
-        // 4. Set as default
-        config.writeProperty('org', orgId);
-        console.log('\n' + style.green(`✔ Organization "${name}" created successfully!`));
-        console.log(`Set as default organization: ${style.cyan(orgId)}`);
-    }
-    catch (err) {
-        const apiErr = handleApiError(err);
-        console.log(style.red(`Error creating organization: ${apiErr.message}`));
-    }
-}

package/dist/utils/prompt.js

@@ -1,41 +0,0 @@
-import { input, confirm, select } from '@inquirer/prompts';
-/**
- * Prompts the user with a text input using @inquirer/prompts.
- *
- * @param message - The prompt message to show.
- * @param defaultValue - An optional default value.
- * @returns A promise resolving to the user's input.
- */
-export async function askInput(message, defaultValue) {
-    const result = await input({
-        message,
-        default: defaultValue,
-    });
-    return result.trim();
-}
-/**
- * Prompts the user with a confirmation (y/n) question.
- *
- * @param message - The prompt message to show.
- * @param defaultValue - The default boolean choice (defaults to true).
- * @returns A promise resolving to the user's choice.
- */
-export async function askConfirm(message, defaultValue = true) {
-    return confirm({
-        message,
-        default: defaultValue,
-    });
-}
-/**
- * Prompts the user to make a choice from a select dropdown.
- *
- * @param message - The prompt message to show.
- * @param choices - List of choice objects.
- * @returns A promise resolving to the selected value.
- */
-export async function askSelect(message, choices) {
-    return select({
-        message,
-        choices,
-    });
-}