@owox/ctl 0.26.0

package/README.md

@@ -0,0 +1,46 @@
+# @owox/ctl
+
+OWOX Data Marts Control CLI.
+
+`owox` runs and manages a local or self-managed OWOX Data Marts runtime.
+`owox-ctl` controls an existing OWOX Data Marts instance through the HTTP API.
+
+The full user documentation lives in [docs/api/owox-ctl.md](../../docs/api/owox-ctl.md).
+
+## Install
+
+```bash
+npm install -g @owox/ctl
+```
+
+## Authentication
+
+For human use, prefer interactive login:
+
+```bash
+owox-ctl auth login
+```
+
+For CI and agents, use environment variables. These override stored login config
+and do not write secrets to disk:
+
+```bash
+OWOX_API_ORIGIN=https://app.owox.com \
+OWOX_API_KEY_ID=pmk_xxx \
+OWOX_API_KEY_SECRET=xxx \
+owox-ctl data-marts list --format json
+```
+
+You can also load these variables from an environment file:
+
+```bash
+owox-ctl data-marts list --env-file .env --format json
+```
+
+Access tokens are short-lived and kept in memory only for the current process.
+They are never written to the local config file.
+
+## Compatibility
+
+CLI same version as server: supported.
+CLI different version from server: best effort.

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core';
+
+await execute({ dir: import.meta.url });

package/dist/base-command.d.ts

@@ -0,0 +1,27 @@
+import { Command } from '@oclif/core';
+import { type EnvSetupConfig, type EnvSetupResult } from '@owox/internal-helpers';
+import { OWOXApiClient, type OWOXApiClientOptions } from '@owox/api-client';
+import { type OutputFormat, type TableColumn } from './output.js';
+type BaseFlags = {
+    format?: string;
+    'no-color'?: boolean;
+    'env-file'?: string;
+};
+type SetupEnvironment = (config?: EnvSetupConfig) => EnvSetupResult;
+export declare function setupEnvironmentFromFlags(flags: Pick<BaseFlags, 'env-file'>, setupEnvironment?: SetupEnvironment): void;
+export declare abstract class BaseCommand extends Command {
+    static baseFlags: {
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected createClient(config: OWOXApiClientOptions): OWOXApiClient;
+    protected loadEnvironment(flags: Pick<BaseFlags, 'env-file'>): void;
+    protected getAuthenticatedClient(): Promise<OWOXApiClient>;
+    protected writeRows<T extends Record<string, unknown>>(rows: T[], columns: TableColumn<T>[], flags: BaseFlags): void;
+    protected handleCliError(error: unknown, flags: BaseFlags): never;
+    protected colorEnabled(flags: BaseFlags): boolean;
+    private normalizeError;
+    protected outputFormat(flags: BaseFlags): OutputFormat;
+}
+export {};

package/dist/base-command.js

@@ -0,0 +1,92 @@
+import { Command, Flags } from '@oclif/core';
+import { EnvManager } from '@owox/internal-helpers';
+import { OWOXApiClient, OWOXApiError, OWOXAuthError, OWOXConfigError, } from '@owox/api-client';
+import { ConfigStore, resolveAuthConfig } from './config-store.js';
+import { renderJson, renderTable, shouldUseColor, } from './output.js';
+export function setupEnvironmentFromFlags(flags, setupEnvironment = EnvManager.setupEnvironment.bind(EnvManager)) {
+    const envFileValue = flags['env-file'];
+    const envFile = typeof envFileValue === 'string' ? envFileValue : '';
+    const hasExplicitEnvFile = envFile.trim().length > 0;
+    const result = setupEnvironment({ envFile });
+    if (hasExplicitEnvFile && !result.success) {
+        throw new OWOXConfigError(`Failed to load environment file: ${envFile}`);
+    }
+}
+export class BaseCommand extends Command {
+    static baseFlags = {
+        'env-file': Flags.string({
+            char: 'e',
+            description: 'Path to environment file to load variables from',
+            helpValue: '/path/to/.env',
+        }),
+        format: Flags.string({
+            default: 'table',
+            description: 'Output format',
+            options: ['table', 'json'],
+        }),
+        'no-color': Flags.boolean({
+            description: 'Disable color output',
+        }),
+    };
+    createClient(config) {
+        return new OWOXApiClient(config);
+    }
+    loadEnvironment(flags) {
+        setupEnvironmentFromFlags(flags);
+    }
+    async getAuthenticatedClient() {
+        const resolved = await resolveAuthConfig({ store: new ConfigStore() });
+        if (!resolved) {
+            throw new OWOXConfigError('Not authenticated. Run owox-ctl auth login or set OWOX_API_ORIGIN, OWOX_API_KEY_ID, and OWOX_API_KEY_SECRET.');
+        }
+        return this.createClient(resolved.config);
+    }
+    writeRows(rows, columns, flags) {
+        if (this.outputFormat(flags) === 'json') {
+            this.log(renderJson(rows));
+            return;
+        }
+        this.log(renderTable(rows, columns));
+    }
+    handleCliError(error, flags) {
+        const normalized = this.normalizeError(error);
+        if (this.outputFormat(flags) === 'json') {
+            process.stderr.write(`${renderJson({ error: normalized })}\n`);
+            this.exit(1);
+        }
+        this.error(normalized.message, {
+            code: normalized.code,
+            exit: 1,
+        });
+    }
+    colorEnabled(flags) {
+        return shouldUseColor({
+            format: this.outputFormat(flags),
+            noColor: flags['no-color'],
+            stream: process.stdout,
+            env: process.env,
+        });
+    }
+    normalizeError(error) {
+        if (error instanceof OWOXApiError || error instanceof OWOXAuthError) {
+            return {
+                message: error.message,
+                status: error.status,
+                code: error.code,
+                name: error.name,
+            };
+        }
+        if (error instanceof OWOXConfigError || error instanceof Error) {
+            return {
+                message: error.message,
+                name: error.name,
+            };
+        }
+        return {
+            message: String(error),
+        };
+    }
+    outputFormat(flags) {
+        return flags.format === 'json' ? 'json' : 'table';
+    }
+}

package/dist/commands/auth/login.d.ts

@@ -0,0 +1,41 @@
+import { type OWOXApiClientOptions } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+import { ConfigStore, type AuthConfig } from '../../config-store.js';
+type Authenticator = {
+    authenticate(): Promise<void>;
+};
+type LoginDeps = {
+    store: ConfigStore;
+    createClient: (config: OWOXApiClientOptions) => Authenticator;
+};
+type LoginInput = {
+    apiOrigin: string;
+    apiKeyId: string;
+    apiKeySecret: string;
+};
+type LoginFlags = {
+    'api-origin'?: string;
+    'api-key-id'?: string;
+    'api-key-secret'?: string;
+};
+type LoginPrompts = {
+    promptText: (message: string) => Promise<string>;
+    promptSecret: (message: string) => Promise<string>;
+};
+export declare function performLogin(input: LoginInput, deps?: LoginDeps): Promise<AuthConfig>;
+export declare function promptSecret(message: string, input?: NodeJS.ReadStream, output?: NodeJS.WriteStream): Promise<string>;
+export declare function resolveLoginInput(flags: LoginFlags, env?: NodeJS.ProcessEnv, prompts?: LoginPrompts): Promise<LoginInput>;
+export default class AuthLogin extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        'api-origin': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-key-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-key-secret': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+export {};

package/dist/commands/auth/login.js

@@ -0,0 +1,121 @@
+import { Flags } from '@oclif/core';
+import { OWOXApiClient } from '@owox/api-client';
+import { createInterface } from 'node:readline/promises';
+import { BaseCommand } from '../../base-command.js';
+import { ConfigStore, maskApiKeyId } from '../../config-store.js';
+import { colors, renderJson } from '../../output.js';
+const defaultDeps = (store = new ConfigStore()) => ({
+    store,
+    createClient: config => new OWOXApiClient(config),
+});
+export async function performLogin(input, deps = defaultDeps()) {
+    const config = {
+        apiOrigin: input.apiOrigin.trim(),
+        apiKeyId: input.apiKeyId.trim(),
+        apiKeySecret: input.apiKeySecret,
+    };
+    await deps.createClient(config).authenticate();
+    await deps.store.save(config);
+    return config;
+}
+async function promptText(message, input = process.stdin, output = process.stdout) {
+    const readline = createInterface({
+        input,
+        output,
+    });
+    try {
+        return await readline.question(message);
+    }
+    finally {
+        readline.close();
+    }
+}
+export async function promptSecret(message, input = process.stdin, output = process.stdout) {
+    if (!input.isTTY) {
+        return promptText(message, input, output);
+    }
+    output.write(message);
+    input.setRawMode(true);
+    input.resume();
+    return new Promise((resolve, reject) => {
+        let value = '';
+        const cleanup = () => {
+            input.setRawMode(false);
+            input.off('data', onData);
+            input.pause();
+            output.write('\n');
+        };
+        const onData = (chunk) => {
+            const text = chunk.toString('utf8');
+            if (text === '\u0003') {
+                cleanup();
+                reject(new Error('Prompt cancelled'));
+                return;
+            }
+            if (text === '\r' || text === '\n') {
+                cleanup();
+                resolve(value);
+                return;
+            }
+            if (text === '\u007F') {
+                value = value.slice(0, -1);
+                return;
+            }
+            value += text;
+        };
+        input.on('data', onData);
+    });
+}
+export async function resolveLoginInput(flags, env = process.env, prompts = { promptText, promptSecret }) {
+    return {
+        apiOrigin: flags['api-origin'] ??
+            env.OWOX_API_ORIGIN ??
+            (await prompts.promptText('OWOX Data Marts API origin: ')),
+        apiKeyId: flags['api-key-id'] ?? env.OWOX_API_KEY_ID ?? (await prompts.promptText('API key ID: ')),
+        apiKeySecret: flags['api-key-secret'] ??
+            env.OWOX_API_KEY_SECRET ??
+            (await prompts.promptSecret('API key secret: ')),
+    };
+}
+export default class AuthLogin extends BaseCommand {
+    static description = 'Authenticate with OWOX Data Marts';
+    static examples = [
+        '<%= config.bin %> auth login',
+        '<%= config.bin %> auth login --api-origin https://app.owox.com --api-key-id pmk_xxx --api-key-secret xxx',
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        'api-origin': Flags.string({
+            description: 'OWOX Data Marts API origin, for example https://app.owox.com',
+        }),
+        'api-key-id': Flags.string({
+            description: 'API key ID',
+        }),
+        'api-key-secret': Flags.string({
+            description: 'API key secret',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AuthLogin);
+        try {
+            this.loadEnvironment(flags);
+            const config = await performLogin(await resolveLoginInput(flags), {
+                store: new ConfigStore(),
+                createClient: config => this.createClient(config),
+            });
+            if (this.outputFormat(flags) === 'json') {
+                this.log(renderJson({
+                    apiOrigin: config.apiOrigin,
+                    apiKeyId: maskApiKeyId(config.apiKeyId),
+                    authenticated: true,
+                }));
+                return;
+            }
+            const palette = colors({ enabled: this.colorEnabled(flags) });
+            this.log(palette.success('Authenticated with OWOX Data Marts'));
+        }
+        catch (error) {
+            this.handleCliError(error, flags);
+        }
+    }
+}

package/dist/commands/auth/logout.d.ts

@@ -0,0 +1,18 @@
+import { BaseCommand } from '../../base-command.js';
+import { ConfigStore } from '../../config-store.js';
+type LogoutDeps = {
+    store: ConfigStore;
+};
+export declare function performLogout(deps?: LogoutDeps): Promise<{
+    removed: boolean;
+}>;
+export default class AuthLogout extends BaseCommand {
+    static description: string;
+    static flags: {
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+export {};

package/dist/commands/auth/logout.js

@@ -0,0 +1,30 @@
+import { BaseCommand } from '../../base-command.js';
+import { ConfigStore } from '../../config-store.js';
+import { colors, renderJson } from '../../output.js';
+export async function performLogout(deps = { store: new ConfigStore() }) {
+    return { removed: await deps.store.remove() };
+}
+export default class AuthLogout extends BaseCommand {
+    static description = 'Remove stored OWOX Data Marts credentials';
+    static flags = {
+        ...BaseCommand.baseFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(AuthLogout);
+        try {
+            this.loadEnvironment(flags);
+            const result = await performLogout({ store: new ConfigStore() });
+            if (this.outputFormat(flags) === 'json') {
+                this.log(renderJson({ loggedOut: true, removed: result.removed }));
+                return;
+            }
+            const palette = colors({ enabled: this.colorEnabled(flags) });
+            this.log(result.removed
+                ? palette.success('Stored credentials removed')
+                : palette.warning('No stored credentials found'));
+        }
+        catch (error) {
+            this.handleCliError(error, flags);
+        }
+    }
+}

package/dist/commands/auth/status.d.ts

@@ -0,0 +1,24 @@
+import { type OWOXApiClientOptions } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+import { type AuthConfig } from '../../config-store.js';
+type AuthStatus = {
+    apiOrigin: string;
+    apiKeyId: string;
+    authenticated: boolean;
+};
+type AuthStatusDeps = {
+    createClient: (config: OWOXApiClientOptions) => {
+        authenticate(): Promise<void>;
+    };
+};
+export declare function getAuthStatus(config: AuthConfig, deps?: AuthStatusDeps): Promise<AuthStatus>;
+export default class AuthStatusCommand extends BaseCommand {
+    static description: string;
+    static flags: {
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+export {};

package/dist/commands/auth/status.js

@@ -0,0 +1,45 @@
+import { OWOXApiClient } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+import { ConfigStore, maskApiKeyId, resolveAuthConfig, } from '../../config-store.js';
+import { renderJson, renderKeyValues } from '../../output.js';
+export async function getAuthStatus(config, deps = { createClient: clientConfig => new OWOXApiClient(clientConfig) }) {
+    await deps.createClient(config).authenticate();
+    return {
+        apiOrigin: config.apiOrigin,
+        apiKeyId: maskApiKeyId(config.apiKeyId),
+        authenticated: true,
+    };
+}
+export default class AuthStatusCommand extends BaseCommand {
+    static description = 'Show OWOX Data Marts authentication status';
+    static flags = {
+        ...BaseCommand.baseFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(AuthStatusCommand);
+        try {
+            this.loadEnvironment(flags);
+            const resolved = await resolveAuthConfig({ store: new ConfigStore() });
+            if (!resolved) {
+                const status = { authenticated: false };
+                this.log(flags.format === 'json' ? renderJson(status) : renderKeyValues({ Authenticated: 'no' }));
+                return;
+            }
+            const status = await getAuthStatus(resolved.config, {
+                createClient: config => this.createClient(config),
+            });
+            if (flags.format === 'json') {
+                this.log(renderJson(status));
+                return;
+            }
+            this.log(renderKeyValues({
+                'API origin': status.apiOrigin,
+                'API key ID': status.apiKeyId,
+                Authenticated: status.authenticated ? 'yes' : 'no',
+            }));
+        }
+        catch (error) {
+            this.handleCliError(error, flags);
+        }
+    }
+}

package/dist/commands/data-marts/list.d.ts

@@ -0,0 +1,12 @@
+import type { OWOXApiClient, OWOXDataMart } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+export declare function listDataMarts(client: Pick<OWOXApiClient, 'dataMarts'>): Promise<OWOXDataMart[]>;
+export default class DataMartsList extends BaseCommand {
+    static description: string;
+    static flags: {
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/data-marts/list.js

@@ -0,0 +1,25 @@
+import { BaseCommand } from '../../base-command.js';
+export async function listDataMarts(client) {
+    return client.dataMarts.list();
+}
+export default class DataMartsList extends BaseCommand {
+    static description = 'List data marts';
+    static flags = {
+        ...BaseCommand.baseFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(DataMartsList);
+        try {
+            this.loadEnvironment(flags);
+            const rows = await listDataMarts(await this.getAuthenticatedClient());
+            this.writeRows(rows, [
+                { key: 'id', label: 'ID' },
+                { key: 'title', label: 'Title' },
+                { key: 'status', label: 'Status' },
+            ], flags);
+        }
+        catch (error) {
+            this.handleCliError(error, flags);
+        }
+    }
+}

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

@@ -0,0 +1,12 @@
+import type { OWOXApiClient, OWOXDestination } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+export declare function listDestinations(client: Pick<OWOXApiClient, 'destinations'>): Promise<OWOXDestination[]>;
+export default class DestinationsList extends BaseCommand {
+    static description: string;
+    static flags: {
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/destinations/list.js

@@ -0,0 +1,25 @@
+import { BaseCommand } from '../../base-command.js';
+export async function listDestinations(client) {
+    return client.destinations.list();
+}
+export default class DestinationsList extends BaseCommand {
+    static description = 'List destinations';
+    static flags = {
+        ...BaseCommand.baseFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(DestinationsList);
+        try {
+            this.loadEnvironment(flags);
+            const rows = await listDestinations(await this.getAuthenticatedClient());
+            this.writeRows(rows, [
+                { key: 'id', label: 'ID' },
+                { key: 'title', label: 'Title' },
+                { key: 'type', label: 'Type' },
+            ], flags);
+        }
+        catch (error) {
+            this.handleCliError(error, flags);
+        }
+    }
+}

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

@@ -0,0 +1,12 @@
+import type { OWOXApiClient, OWOXStorage } from '@owox/api-client';
+import { BaseCommand } from '../../base-command.js';
+export declare function listStorages(client: Pick<OWOXApiClient, 'storages'>): Promise<OWOXStorage[]>;
+export default class StoragesList extends BaseCommand {
+    static description: string;
+    static flags: {
+        'env-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-color': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/storages/list.js

@@ -0,0 +1,25 @@
+import { BaseCommand } from '../../base-command.js';
+export async function listStorages(client) {
+    return client.storages.list();
+}
+export default class StoragesList extends BaseCommand {
+    static description = 'List storages';
+    static flags = {
+        ...BaseCommand.baseFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(StoragesList);
+        try {
+            this.loadEnvironment(flags);
+            const rows = await listStorages(await this.getAuthenticatedClient());
+            this.writeRows(rows, [
+                { key: 'id', label: 'ID' },
+                { key: 'title', label: 'Title' },
+                { key: 'type', label: 'Type' },
+            ], flags);
+        }
+        catch (error) {
+            this.handleCliError(error, flags);
+        }
+    }
+}

package/dist/config-store.d.ts

@@ -0,0 +1,24 @@
+export type AuthConfig = {
+    apiOrigin: string;
+    apiKeyId: string;
+    apiKeySecret: string;
+};
+export type ResolvedAuthConfig = {
+    source: 'env' | 'stored';
+    config: AuthConfig;
+};
+type ResolveAuthConfigInput = {
+    env?: NodeJS.ProcessEnv;
+    store?: ConfigStore;
+};
+export declare function getDefaultConfigPath(env?: NodeJS.ProcessEnv): string;
+export declare function maskApiKeyId(apiKeyId: string): string;
+export declare class ConfigStore {
+    readonly path: string;
+    constructor(path?: string);
+    read(): Promise<AuthConfig | null>;
+    save(config: AuthConfig): Promise<void>;
+    remove(): Promise<boolean>;
+}
+export declare function resolveAuthConfig(input?: ResolveAuthConfigInput): Promise<ResolvedAuthConfig | null>;
+export {};

package/dist/config-store.js

@@ -0,0 +1,107 @@
+import { chmod, mkdir, readFile, rm, stat, writeFile } from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+import envPaths from 'env-paths';
+import { OWOXConfigError } from '@owox/api-client';
+function isAuthConfig(value) {
+    if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        return false;
+    }
+    const record = value;
+    return (typeof record.apiOrigin === 'string' &&
+        typeof record.apiKeyId === 'string' &&
+        typeof record.apiKeySecret === 'string');
+}
+export function getDefaultConfigPath(env = process.env) {
+    if (env.OWOX_CTL_CONFIG_PATH) {
+        return env.OWOX_CTL_CONFIG_PATH;
+    }
+    return join(envPaths('owox', { suffix: '' }).config, 'ctl', 'config.json');
+}
+export function maskApiKeyId(apiKeyId) {
+    if (apiKeyId.length <= 8) {
+        return `${apiKeyId.slice(0, 2)}...`;
+    }
+    return `${apiKeyId.slice(0, 8)}...`;
+}
+export class ConfigStore {
+    path;
+    constructor(path = getDefaultConfigPath()) {
+        this.path = path;
+    }
+    async read() {
+        try {
+            const raw = await readFile(this.path, 'utf8');
+            const parsed = JSON.parse(raw);
+            if (!isAuthConfig(parsed)) {
+                throw new OWOXConfigError(`Invalid owox-ctl config file at ${this.path}`);
+            }
+            return parsed;
+        }
+        catch (error) {
+            if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
+                return null;
+            }
+            throw error;
+        }
+    }
+    async save(config) {
+        await mkdir(dirname(this.path), { recursive: true, mode: 0o700 });
+        await chmod(dirname(this.path), 0o700).catch(() => undefined);
+        await writeFile(this.path, `${JSON.stringify(config, null, 2)}\n`, {
+            encoding: 'utf8',
+            mode: 0o600,
+        });
+        await chmod(this.path, 0o600).catch(() => undefined);
+    }
+    async remove() {
+        let removed = true;
+        try {
+            await rm(this.path);
+        }
+        catch (error) {
+            if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
+                removed = false;
+            }
+            else {
+                throw error;
+            }
+        }
+        if (removed) {
+            try {
+                await stat(this.path);
+                throw new OWOXConfigError(`Failed to remove owox-ctl config file at ${this.path}`);
+            }
+            catch (error) {
+                if (!(error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT')) {
+                    throw error;
+                }
+            }
+        }
+        return removed;
+    }
+}
+export async function resolveAuthConfig(input = {}) {
+    const env = input.env ?? process.env;
+    const store = input.store ?? new ConfigStore();
+    const envValues = {
+        apiOrigin: env.OWOX_API_ORIGIN,
+        apiKeyId: env.OWOX_API_KEY_ID,
+        apiKeySecret: env.OWOX_API_KEY_SECRET,
+    };
+    const hasAnyEnvValue = Object.values(envValues).some(value => value !== undefined);
+    if (hasAnyEnvValue) {
+        if (!envValues.apiOrigin || !envValues.apiKeyId || !envValues.apiKeySecret) {
+            throw new OWOXConfigError('OWOX_API_ORIGIN, OWOX_API_KEY_ID, and OWOX_API_KEY_SECRET must be set together');
+        }
+        return {
+            source: 'env',
+            config: {
+                apiOrigin: envValues.apiOrigin,
+                apiKeyId: envValues.apiKeyId,
+                apiKeySecret: envValues.apiKeySecret,
+            },
+        };
+    }
+    const stored = await store.read();
+    return stored ? { source: 'stored', config: stored } : null;
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/dist/output.d.ts

@@ -0,0 +1,25 @@
+export type OutputFormat = 'table' | 'json';
+export type TableColumn<T extends Record<string, unknown>> = {
+    key: keyof T & string;
+    label: string;
+    get?: (row: T) => string | number | boolean | null | undefined;
+};
+export type ColorOptions = {
+    enabled: boolean;
+};
+export declare function shouldUseColor(options: {
+    format: OutputFormat;
+    noColor?: boolean;
+    stream?: NodeJS.WriteStream;
+    env?: NodeJS.ProcessEnv;
+}): boolean;
+export declare function colors(options: ColorOptions): {
+    bold: (text: string) => string;
+    dim: (text: string) => string;
+    error: (text: string) => string;
+    success: (text: string) => string;
+    warning: (text: string) => string;
+};
+export declare function renderJson(value: unknown): string;
+export declare function renderTable<T extends Record<string, unknown>>(rows: T[], columns: TableColumn<T>[]): string;
+export declare function renderKeyValues(values: Record<string, string | number | boolean>, options?: ColorOptions): string;

package/dist/output.js

@@ -0,0 +1,58 @@
+const ANSI = {
+    bold: ['\u001B[1m', '\u001B[22m'],
+    dim: ['\u001B[2m', '\u001B[22m'],
+    green: ['\u001B[32m', '\u001B[39m'],
+    red: ['\u001B[31m', '\u001B[39m'],
+    yellow: ['\u001B[33m', '\u001B[39m'],
+};
+export function shouldUseColor(options) {
+    if (options.format === 'json' || options.noColor || options.env?.NO_COLOR !== undefined) {
+        return false;
+    }
+    return options.stream?.isTTY === true;
+}
+function colorize(text, code, options) {
+    if (!options.enabled) {
+        return text;
+    }
+    const [open, close] = ANSI[code];
+    return `${open}${text}${close}`;
+}
+export function colors(options) {
+    return {
+        bold: (text) => colorize(text, 'bold', options),
+        dim: (text) => colorize(text, 'dim', options),
+        error: (text) => colorize(text, 'red', options),
+        success: (text) => colorize(text, 'green', options),
+        warning: (text) => colorize(text, 'yellow', options),
+    };
+}
+export function renderJson(value) {
+    return JSON.stringify(value, null, 2);
+}
+function stringifyCell(value) {
+    if (value === null || value === undefined) {
+        return '';
+    }
+    return String(value);
+}
+export function renderTable(rows, columns) {
+    if (rows.length === 0) {
+        return 'No results';
+    }
+    const renderedRows = rows.map(row => columns.map(column => stringifyCell(column.get ? column.get(row) : row[column.key])));
+    const widths = columns.map((column, columnIndex) => Math.max(column.label.length, ...renderedRows.map(row => row[columnIndex]?.length ?? 0)));
+    const renderLine = (values) => values.map((value, index) => value.padEnd(widths[index] ?? 0)).join('  ');
+    return [
+        renderLine(columns.map(column => column.label)),
+        renderLine(widths.map(width => '-'.repeat(width))),
+        ...renderedRows.map(row => renderLine(row)),
+    ].join('\n');
+}
+export function renderKeyValues(values, options = { enabled: false }) {
+    const labelWidth = Math.max(...Object.keys(values).map(label => label.length));
+    const palette = colors(options);
+    return Object.entries(values)
+        .map(([label, value]) => `${palette.bold(`${label}:`.padEnd(labelWidth + 1))} ${value}`)
+        .join('\n');
+}

package/oclif.manifest.json

@@ -0,0 +1,324 @@
+{
+  "commands": {
+    "auth:login": {
+      "aliases": [],
+      "args": {},
+      "description": "Authenticate with OWOX Data Marts",
+      "examples": [
+        "<%= config.bin %> auth login",
+        "<%= config.bin %> auth login --api-origin https://app.owox.com --api-key-id pmk_xxx --api-key-secret xxx"
+      ],
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json"
+          ],
+          "type": "option"
+        },
+        "no-color": {
+          "description": "Disable color output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "api-origin": {
+          "description": "OWOX Data Marts API origin, for example https://app.owox.com",
+          "name": "api-origin",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-key-id": {
+          "description": "API key ID",
+          "name": "api-key-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-key-secret": {
+          "description": "API key secret",
+          "name": "api-key-secret",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "auth:login",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "auth",
+        "login.js"
+      ]
+    },
+    "auth:logout": {
+      "aliases": [],
+      "args": {},
+      "description": "Remove stored OWOX Data Marts credentials",
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json"
+          ],
+          "type": "option"
+        },
+        "no-color": {
+          "description": "Disable color output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "auth:logout",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "auth",
+        "logout.js"
+      ]
+    },
+    "auth:status": {
+      "aliases": [],
+      "args": {},
+      "description": "Show OWOX Data Marts authentication status",
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json"
+          ],
+          "type": "option"
+        },
+        "no-color": {
+          "description": "Disable color output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "auth:status",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "auth",
+        "status.js"
+      ]
+    },
+    "data-marts:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List data marts",
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json"
+          ],
+          "type": "option"
+        },
+        "no-color": {
+          "description": "Disable color output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "data-marts:list",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "data-marts",
+        "list.js"
+      ]
+    },
+    "destinations:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List destinations",
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json"
+          ],
+          "type": "option"
+        },
+        "no-color": {
+          "description": "Disable color output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "destinations:list",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "destinations",
+        "list.js"
+      ]
+    },
+    "storages:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List storages",
+      "flags": {
+        "env-file": {
+          "char": "e",
+          "description": "Path to environment file to load variables from",
+          "name": "env-file",
+          "hasDynamicHelp": false,
+          "helpValue": "/path/to/.env",
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json"
+          ],
+          "type": "option"
+        },
+        "no-color": {
+          "description": "Disable color output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "storages:list",
+      "pluginAlias": "@owox/ctl",
+      "pluginName": "@owox/ctl",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "storages",
+        "list.js"
+      ]
+    }
+  },
+  "version": "0.26.0"
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@owox/ctl",
+  "description": "OWOX Data Marts Control CLI",
+  "version": "0.26.0",
+  "type": "module",
+  "author": "OWOX",
+  "license": "ELv2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "owox-ctl": "./bin/run.js"
+  },
+  "bugs": "https://github.com/OWOX/owox-data-marts/issues",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@owox/api-client": "0.26.0",
+    "@owox/internal-helpers": "0.26.0",
+    "env-paths": "^3.0.0"
+  },
+  "devDependencies": {
+    "@owox/eslint-config": "*",
+    "@owox/prettier-config": "*",
+    "@types/jest": "29.5.14",
+    "@types/node": "^22.10.7",
+    "jest": "^30.2.0",
+    "shx": "^0.4.0",
+    "ts-jest": "^29.4.6"
+  },
+  "engines": {
+    "node": ">=22.16.0"
+  },
+  "files": [
+    "./bin",
+    "./dist/**/*.d.ts",
+    "./dist/**/*.js",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/OWOX/owox-data-marts",
+  "keywords": [
+    "owox",
+    "data-marts",
+    "cli",
+    "control"
+  ],
+  "main": "dist/index.js",
+  "oclif": {
+    "bin": "owox-ctl",
+    "dirname": "owox-ctl",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": " "
+  },
+  "repository": "OWOX/owox-data-marts",
+  "scripts": {
+    "build": "tsc",
+    "build:clean": "shx rm -rf dist oclif.manifest.json tsconfig.tsbuildinfo",
+    "build:dep": "npm run build -w @owox/internal-helpers --prefix ../.. && npm run build -w @owox/api-client --prefix ../..",
+    "clean": "npm run build:clean",
+    "format": "prettier --write \"**/*.{ts,js,json}\" --ignore-path ../../.prettierignore",
+    "format:check": "prettier --check \"**/*.{ts,js,json}\" --ignore-path ../../.prettierignore",
+    "lint": "eslint . --config ./eslint.config.js",
+    "lint:fix": "eslint . --fix --config ./eslint.config.js",
+    "prebuild": "npm run build:clean && npm run build:dep",
+    "prepack": "oclif manifest",
+    "prepublishOnly": "npm run lint && npm run typecheck",
+    "pretest": "npm run build:dep",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  },
+  "types": "dist/index.d.ts"
+}