@xano/cli 1.2.0 → 1.3.1-beta.0

package/dist/commands/ephemeral/push/index.js

@@ -0,0 +1,228 @@
+import { Args, Flags } from '@oclif/core';
+import * as fs from 'node:fs';
+import { resolve } from 'node:path';
+import BaseCommand from '../../../base-command.js';
+import { isAwaited, waitForMicroservices, } from '../../../utils/microservice-wait.js';
+import { executePush } from '../../../utils/multidoc-push.js';
+import { policiesSkippedNotice } from '../../../utils/policy/feedback.js';
+/** Status glyph for one microservice row in the `--wait` progress block. */
+const icon = (e) => {
+    if (!isAwaited(e))
+        return '➖';
+    switch (e.status) {
+        case 'error': {
+            return '❌';
+        }
+        case 'ok': {
+            return '✅';
+        }
+        default: {
+            return '⏳';
+        }
+    }
+};
+/** One rendered microservice row: glyph, padded name, status detail. */
+const line = (e) => {
+    const detail = isAwaited(e) ? e.detail || e.status : `skipped (${e.tenant_deploy ?? 'manual'})`;
+    return `  ${icon(e)} ${e.name.padEnd(24)} ${detail}`;
+};
+export default class EphemeralPush extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to push to',
+            required: true,
+        }),
+    };
+    static description = '[IMPORTANT] ALWAYS run --dry-run first and show the user the output before pushing. Push local documents to an ephemeral tenant via multidoc import. By default, only changed files are pushed (partial mode). Use --sync to push all files. Shows a preview of changes before pushing unless --force is specified. Use --dry-run to preview only.';
+    static examples = [
+        `$ xano ephemeral push e4f2-9ab1-xyz1
+Push from current directory (default partial mode)
+`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 -d ./my-workspace
+Push from a specific directory
+`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 --sync
+Push all files to the ephemeral tenant
+`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 --sync --delete
+Push all files and delete remote objects not included
+`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 --dry-run
+Preview changes without pushing
+`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 --force
+Skip preview and push immediately
+`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 --records --env`,
+        `$ xano ephemeral push e4f2-9ab1-xyz1 --truncate`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        delete: Flags.boolean({
+            default: false,
+            description: 'Delete remote objects not included in the push (requires --sync)',
+            required: false,
+        }),
+        directory: Flags.string({
+            char: 'd',
+            default: '.',
+            description: 'Directory containing documents to push (defaults to current directory)',
+            required: false,
+        }),
+        'dry-run': Flags.boolean({
+            default: false,
+            description: 'Show preview of changes without pushing (exit after preview)',
+            required: false,
+        }),
+        env: Flags.boolean({
+            default: false,
+            description: 'Include environment variables in import',
+            required: false,
+        }),
+        force: Flags.boolean({
+            default: false,
+            description: 'Skip preview and confirmation prompt (for CI/CD pipelines)',
+            required: false,
+        }),
+        guids: Flags.boolean({
+            allowNo: true,
+            default: true,
+            description: 'Write server-assigned GUIDs back to local files (use --no-guids to skip)',
+            required: false,
+        }),
+        records: Flags.boolean({
+            default: false,
+            description: 'Include records in import',
+            required: false,
+        }),
+        sync: Flags.boolean({
+            default: false,
+            description: 'Full push — send all files, not just changed ones. Required for --delete.',
+            required: false,
+        }),
+        transaction: Flags.boolean({
+            allowNo: true,
+            default: true,
+            description: '[CRITICAL] DO NOT run with --no-transaction without explicit user confirmation; this disables rollback. Wraps import in a database transaction (use --no-transaction for debugging purposes).',
+            required: false,
+        }),
+        truncate: Flags.boolean({
+            default: false,
+            description: '[CRITICAL] STOP and confirm with the user; this truncates live tables before importing.',
+            required: false,
+        }),
+        wait: Flags.boolean({
+            default: false,
+            description: 'After pushing, wait for auto-deployed microservices (tenant_deploy="auto") to become ready. Exits non-zero if any fails to deploy or the wait times out. Ignored with --dry-run.',
+            required: false,
+        }),
+        'wait-timeout': Flags.integer({
+            default: 300,
+            description: 'Seconds to wait for microservices to become ready when --wait is set (default 300).',
+            min: 1,
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    /** Number of lines the last progress render wrote (for in-place TTY updates). */
+    lastRenderLines = 0;
+    async run() {
+        const { args, flags } = await this.parse(EphemeralPush);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Ephemeral tenants require a workspace — use --workspace or set one in your profile.');
+        }
+        const inputDir = resolve(flags.directory);
+        if (!fs.existsSync(inputDir)) {
+            this.error(`Directory not found: ${inputDir}`);
+        }
+        if (!fs.statSync(inputDir).isDirectory()) {
+            this.error(`Not a directory: ${inputDir}`);
+        }
+        const tenantName = args.tenant_name;
+        const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
+        const target = {
+            buildDryRunUrl: (params) => `${baseUrl}/multidoc/dry-run?${params.toString()}`,
+            buildPushUrl: (params) => `${baseUrl}/multidoc?${params.toString()}`,
+            cliVersion: this.config.version,
+            instanceOrigin: profile.instance_origin,
+            label: `ephemeral tenant ${tenantName}`,
+            sourceWorkspaceId: profile.workspace,
+            supportsBranches: false,
+            supportsPartial: true,
+            warnOnWorkspaceMismatch: false,
+        };
+        const pushFlags = {
+            delete: flags.delete,
+            'dry-run': flags['dry-run'],
+            env: flags.env,
+            force: flags.force,
+            guids: flags.guids,
+            records: flags.records,
+            sync: flags.sync,
+            transaction: flags.transaction,
+            truncate: flags.truncate,
+            verbose: flags.verbose,
+        };
+        const result = await executePush({
+            accessToken: profile.access_token,
+            branch: '',
+            command: this,
+            inputDir,
+            verboseFetch: this.verboseFetch.bind(this),
+        }, target, pushFlags);
+        // When the platform leaves policy files out, it says so once.
+        const skipped = policiesSkippedNotice(result.response ?? result.preview);
+        if (skipped)
+            this.warn(skipped);
+        // --wait: after a real push, poll the tenant's live microservice status until
+        // every auto-deployed microservice (tenant_deploy="auto") is ready or the
+        // wait times out. Skipped on --dry-run (nothing was deployed).
+        if (flags.wait && !flags['dry-run']) {
+            await this.waitForDeploy(baseUrl, profile.access_token, tenantName, flags['wait-timeout'], flags.verbose);
+        }
+    }
+    /**
+     * Poll GET .../tenant/{name}/microservice until auto microservices settle.
+     * Renders a one-line-per-microservice progress view that updates in place, then
+     * exits non-zero if any auto microservice failed or the wait timed out.
+     */
+    async waitForDeploy(baseUrl, accessToken, tenantName, timeoutSeconds, verbose) {
+        this.log('');
+        this.log(`Waiting for microservices to deploy (timeout ${timeoutSeconds}s)…`);
+        const result = await waitForMicroservices({
+            accessToken,
+            onPoll: (entries) => {
+                // Re-render the block: move the cursor up over the previous render (if any)
+                // and rewrite. Falls back to plain appends when not a TTY.
+                if (process.stdout.isTTY && this.lastRenderLines > 0) {
+                    process.stdout.write(`[${this.lastRenderLines}A`);
+                }
+                const lines = entries.map((e) => line(e));
+                for (const l of lines)
+                    this.log(l);
+                this.lastRenderLines = process.stdout.isTTY ? lines.length : 0;
+            },
+            statusUrl: `${baseUrl}/microservice`,
+            timeoutMs: timeoutSeconds * 1000,
+            verbose,
+            verboseFetch: this.verboseFetch.bind(this),
+        });
+        const awaited = result.entries.filter((e) => isAwaited(e));
+        const ready = awaited.filter((e) => e.status === 'ok').length;
+        if (result.timedOut) {
+            this.error(`Timed out after ${timeoutSeconds}s waiting for microservices (${ready}/${awaited.length} ready). ` +
+                `Check status with the Xano dashboard or re-run with a larger --wait-timeout.`);
+        }
+        if (result.hadError) {
+            const failed = awaited.filter((e) => e.status === 'error').map((e) => `${e.name} (${e.detail || 'error'})`);
+            this.error(`Microservice deploy failed: ${failed.join(', ')}`);
+        }
+        this.log(`All microservices ready (${ready}/${awaited.length}).`);
+    }
+}

package/dist/commands/ephemeral/static_host/build/delete/index.d.ts

@@ -0,0 +1,20 @@
+import BaseCommand from '../../../../../base-command.js';
+export default class EphemeralStaticHostBuildDelete extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        build_id: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private confirm;
+}

package/dist/commands/ephemeral/static_host/build/delete/index.js

@@ -0,0 +1,121 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../../base-command.js';
+export default class EphemeralStaticHostBuildDelete extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name',
+            required: true,
+        }),
+    };
+    static description = 'Delete a static host build for an ephemeral tenant permanently. This action cannot be undone.';
+    static examples = [
+        `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 --static-host default --build_id 52
+Are you sure you want to delete build 52 from static host 'default'? This action cannot be undone. (y/N) y
+Deleted build 52 from static host 'default'
+`,
+        `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 -H default --build_id 52 --force
+Deleted build 52 from static host 'default'
+`,
+        `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 -H myhost --build_id 123 -w 40 -f
+Deleted build 123 from static host 'myhost'
+`,
+        `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 -H default --build_id 52 -f -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        build_id: Flags.string({
+            description: 'Build ID to delete',
+            required: true,
+        }),
+        force: Flags.boolean({
+            char: 'f',
+            default: false,
+            description: '[CRITICAL] NEVER run without explicit user confirmation. Skips the confirmation prompt.',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        'static-host': Flags.string({
+            char: 'H',
+            description: 'Static host name',
+            required: true,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (optional if set in profile)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralStaticHostBuildDelete);
+        const { profile, profileName } = this.resolveProfile(flags);
+        const tenantName = args.tenant_name;
+        const staticHost = flags['static-host'];
+        // Determine workspace_id from flag or profile
+        let workspaceId;
+        if (flags.workspace) {
+            workspaceId = flags.workspace;
+        }
+        else if (profile.workspace) {
+            workspaceId = profile.workspace;
+        }
+        else {
+            this.error(`Workspace ID is required. Either:\n` +
+                `  1. Provide it as a flag: xano ephemeral static_host build delete <tenant_name> --static-host <static_host> --build_id <id> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile edit ${profileName} -w <workspace_id>`);
+        }
+        if (!flags.force) {
+            const confirmed = await this.confirm(`Are you sure you want to delete build ${flags.build_id} from static host '${staticHost}'? This action cannot be undone.`);
+            if (!confirmed) {
+                this.log('Deletion cancelled.');
+                return;
+            }
+        }
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build/${flags.build_id}`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'DELETE',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            if (flags.output === 'json') {
+                this.log(JSON.stringify({ build_id: flags.build_id, deleted: true, static_host: staticHost }, null, 2));
+            }
+            else {
+                this.log(`Deleted build ${flags.build_id} from static host '${staticHost}'`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to delete build: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to delete build: ${String(error)}`);
+            }
+        }
+    }
+    async confirm(message) {
+        const readline = await import('node:readline');
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        return new Promise((resolve) => {
+            rl.question(`${message} (y/N) `, (answer) => {
+                rl.close();
+                resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+            });
+        });
+    }
+}

package/dist/commands/ephemeral/static_host/build/get/index.d.ts

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../../../base-command.js';
+export default class EphemeralStaticHostBuildGet extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        build_id: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/ephemeral/static_host/build/get/index.js

@@ -0,0 +1,137 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../../base-command.js';
+export default class EphemeralStaticHostBuildGet extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name',
+            required: true,
+        }),
+    };
+    static description = 'Get details of a specific build for a static host of an ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 --static-host default --build_id 52
+Build Details:
+ID: 52
+Name: v1.0.0
+Status: completed
+`,
+        `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 -H default --build_id 52 -w 40
+Build Details:
+ID: 52
+Name: v1.0.0
+Status: completed
+`,
+        `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 -H myhost --build_id 123 --profile production
+Build Details:
+ID: 123
+Name: production-build
+`,
+        `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 -H default --build_id 52 -o json
+{
+  "id": 52,
+  "name": "v1.0.0",
+  "status": "completed"
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        build_id: Flags.string({
+            description: 'Build ID',
+            required: true,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        'static-host': Flags.string({
+            char: 'H',
+            description: 'Static host name',
+            required: true,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (optional if set in profile)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralStaticHostBuildGet);
+        const { profile, profileName } = this.resolveProfile(flags);
+        const tenantName = args.tenant_name;
+        const staticHost = flags['static-host'];
+        // Determine workspace_id from flag or profile
+        let workspaceId;
+        if (flags.workspace) {
+            workspaceId = flags.workspace;
+        }
+        else if (profile.workspace) {
+            workspaceId = profile.workspace;
+        }
+        else {
+            this.error(`Workspace ID is required. Either:\n` +
+                `  1. Provide it as a flag: xano ephemeral static_host build get <tenant_name> --static-host <static_host> --build_id <id> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build/${flags.build_id}`;
+        // Fetch build from the API
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const build = await response.json();
+            // Validate response
+            if (!build || typeof build !== 'object') {
+                this.error('Unexpected API response format');
+            }
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(build, null, 2));
+            }
+            else {
+                // summary format
+                this.log('Build Details:');
+                this.log(`ID: ${build.id}`);
+                this.log(`Name: ${build.name}`);
+                if (build.description) {
+                    this.log(`Description: ${build.description}`);
+                }
+                if (build.status) {
+                    this.log(`Status: ${build.status}`);
+                }
+                if (typeof build.file_count === 'number') {
+                    this.log(`Files: ${build.file_count}`);
+                }
+                if (typeof build.file_bytes === 'number') {
+                    this.log(`Size: ${build.file_bytes} bytes`);
+                }
+                if (build.created_at) {
+                    this.log(`Created: ${build.created_at}`);
+                }
+                if (build.updated_at) {
+                    this.log(`Updated: ${build.updated_at}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to fetch build: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch build: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/ephemeral/static_host/build/list/index.d.ts

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../../../base-command.js';
+export default class EphemeralStaticHostBuildList extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}