@xano/cli 1.0.4 → 1.0.6-beta.0

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

@@ -0,0 +1,109 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralEdit extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to edit',
+            required: true,
+        }),
+    };
+    static description = 'Edit an existing ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral edit e4f2-9ab1-xyz1 --display "New Name" --description "Updated description"
+Updated tenant: New Name (e4f2-9ab1-xyz1) - ID: 42
+`,
+        `$ xano ephemeral edit e4f2-9ab1-xyz1 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        description: Flags.string({
+            char: 'd',
+            description: 'New description',
+            required: false,
+        }),
+        display: Flags.string({
+            description: 'New display name',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralEdit);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const tenantName = args.tenant_name;
+        const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
+        const headers = {
+            'accept': 'application/json',
+            'Authorization': `Bearer ${profile.access_token}`,
+            'Content-Type': 'application/json',
+        };
+        try {
+            // Fetch current tenant state (PUT requires all fields)
+            const getResponse = await this.verboseFetch(baseUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!getResponse.ok) {
+                const errorText = await getResponse.text();
+                this.error(`Failed to fetch tenant: ${getResponse.status} ${getResponse.statusText}\n${errorText}`);
+            }
+            const current = await getResponse.json();
+            // Merge in user-provided values
+            const body = {
+                description: flags.description !== undefined ? flags.description : (current.description ?? ''),
+                display: flags.display !== undefined ? flags.display : (current.display ?? current.name),
+                domain: current.domain ?? '',
+                ingress: current.ingress ?? false,
+                proxy: current.proxy ?? '',
+                rbac: {
+                    enabled: current.rbac?.enabled ?? false,
+                },
+                tag: current.tag ?? [],
+                tasks: current.tasks ?? false,
+            };
+            // Update tenant
+            const putResponse = await this.verboseFetch(baseUrl, {
+                body: JSON.stringify(body),
+                headers,
+                method: 'PUT',
+            }, flags.verbose, profile.access_token);
+            if (!putResponse.ok) {
+                const errorText = await putResponse.text();
+                this.error(`API request failed with status ${putResponse.status}: ${putResponse.statusText}\n${errorText}`);
+            }
+            const tenant = await putResponse.json();
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tenant, null, 2));
+            }
+            else {
+                this.log(`Updated tenant: ${tenant.display || tenant.name} (${tenant.name}) - ID: ${tenant.id}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to edit ephemeral tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to edit ephemeral tenant: ${String(error)}`);
+            }
+        }
+    }
+}

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

@@ -0,0 +1,21 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralGet extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: 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>;
+    /**
+     * Render a unix-epoch-seconds expiration as a human-readable "in Xh Ym" string,
+     * falling back to an ISO timestamp if the value has already passed or is absent.
+     */
+    private formatExpiration;
+}

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

@@ -0,0 +1,125 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralGet extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to retrieve',
+            required: true,
+        }),
+    };
+    static description = 'Get details of a specific ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral get e4f2-9ab1-xyz1
+Tenant: PR preview (e4f2-9ab1-xyz1)
+  State: ok
+  License: tier1
+  Expires: in 1h 0m
+`,
+        `$ xano ephemeral get e4f2-9ab1-xyz1 -w 5 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralGet);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const tenantName = args.tenant_name;
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
+        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 tenant = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tenant, null, 2));
+            }
+            else {
+                this.log(`Tenant: ${tenant.display || tenant.name} (${tenant.name})`);
+                if (tenant.state)
+                    this.log(`  State: ${tenant.state}`);
+                if (tenant.license)
+                    this.log(`  License: ${tenant.license}`);
+                if (tenant.xano_domain)
+                    this.log(`  Domain: ${tenant.xano_domain}`);
+                if (tenant.domain)
+                    this.log(`  Custom Domain: ${tenant.domain}`);
+                if (tenant.cluster?.name)
+                    this.log(`  Cluster: ${tenant.cluster.name}`);
+                const releaseName = typeof tenant.release === 'string' ? tenant.release : tenant.release?.name;
+                const releaseId = typeof tenant.release === 'object' ? tenant.release?.id : undefined;
+                if (releaseName)
+                    this.log(`  Release: ${releaseName} (ID: ${releaseId})`);
+                if (tenant.platform?.name)
+                    this.log(`  Platform: ${tenant.platform.name}`);
+                if (tenant.version !== undefined)
+                    this.log(`  Version: ${tenant.version}`);
+                if (tenant.tasks !== undefined)
+                    this.log(`  Tasks: ${tenant.tasks}`);
+                if (tenant.ingress !== undefined)
+                    this.log(`  Ingress: ${tenant.ingress}`);
+                if (tenant.type)
+                    this.log(`  Type: ${tenant.type}`);
+                this.log(`  Expires: ${this.formatExpiration(tenant.ephemeral_expires_at)}`);
+                if (tenant.deployed_at) {
+                    const d = new Date(tenant.deployed_at);
+                    const deployedDate = Number.isNaN(d.getTime()) ? tenant.deployed_at : d.toISOString().split('T')[0];
+                    this.log(`  Deployed: ${deployedDate}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to get ephemeral tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to get ephemeral tenant: ${String(error)}`);
+            }
+        }
+    }
+    /**
+     * Render a unix-epoch-seconds expiration as a human-readable "in Xh Ym" string,
+     * falling back to an ISO timestamp if the value has already passed or is absent.
+     */
+    formatExpiration(expiresAt) {
+        if (!expiresAt) {
+            return '-';
+        }
+        // The API serializes the timestamp field as a date string
+        // ("2026-07-24 19:49:15+0000"); tolerate a raw unix-epoch number too.
+        const expiresMs = typeof expiresAt === 'number' ? expiresAt * 1000 : Date.parse(String(expiresAt).replace(' ', 'T'));
+        if (Number.isNaN(expiresMs)) {
+            return String(expiresAt);
+        }
+        const diffSeconds = (expiresMs - Date.now()) / 1000;
+        if (diffSeconds <= 0) {
+            return `${new Date(expiresMs).toISOString()} (expired)`;
+        }
+        const hours = Math.floor(diffSeconds / 3600);
+        const minutes = Math.floor((diffSeconds % 3600) / 60);
+        return `in ${hours}h ${minutes}m`;
+    }
+}

package/dist/commands/ephemeral/impersonate/index.d.ts

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralImpersonate extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'url-only': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        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 getImpersonateResponse;
+    private getFrontendUrl;
+}

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

@@ -0,0 +1,112 @@
+import { Args, Flags } from '@oclif/core';
+import open from 'open';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralImpersonate extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name to impersonate',
+            required: true,
+        }),
+    };
+    static description = 'Impersonate an ephemeral tenant and open it in the browser';
+    static examples = [
+        `$ xano ephemeral impersonate e4f2-9ab1-xyz1
+Opening browser...
+Impersonation successful!
+`,
+        `$ xano ephemeral impersonate e4f2-9ab1-xyz1 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        'url-only': Flags.boolean({
+            char: 'u',
+            default: false,
+            description: 'Print the URL without opening the browser',
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralImpersonate);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const tenantName = args.tenant_name;
+        try {
+            const response = await this.getImpersonateResponse(profile, workspaceId, tenantName);
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(response, null, 2));
+            }
+            else {
+                const frontendUrl = this.getFrontendUrl(profile.instance_origin);
+                const params = new URLSearchParams({
+                    _ti: response._ti,
+                });
+                const impersonateUrl = `${frontendUrl}/impersonate?${params.toString()}`;
+                if (flags['url-only']) {
+                    this.log(impersonateUrl);
+                }
+                else {
+                    this.log('Opening browser...');
+                    await open(impersonateUrl);
+                    this.log('Impersonation successful!');
+                }
+            }
+            process.exit(0);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to impersonate tenant: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to impersonate tenant: ${String(error)}`);
+            }
+        }
+    }
+    async getImpersonateResponse(profile, workspaceId, tenantName) {
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${encodeURIComponent(tenantName)}/impersonate`;
+        const { verbose } = await this.parse(EphemeralImpersonate).then((r) => r.flags);
+        const response = await this.verboseFetch(apiUrl, {
+            headers: {
+                Authorization: `Bearer ${profile.access_token}`,
+                accept: 'application/json',
+            },
+            method: 'GET',
+        }, verbose, profile.access_token);
+        if (!response.ok) {
+            const errorText = await response.text();
+            throw new Error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+        }
+        const result = (await response.json());
+        if (!result._ti) {
+            throw new Error('No one-time token returned from impersonate API');
+        }
+        return result;
+    }
+    getFrontendUrl(instanceOrigin) {
+        try {
+            const url = new URL(instanceOrigin);
+            if (url.hostname === 'localhost' || url.hostname === '127.0.0.1') {
+                url.port = '4200';
+                return url.origin;
+            }
+        }
+        catch {
+            // fall through
+        }
+        return instanceOrigin;
+    }
+}

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

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralList extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        global: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: 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>;
+    /**
+     * Render a unix-epoch-seconds expiration as a human-readable "in Xh Ym" string,
+     * falling back to an ISO timestamp if the value has already passed or is malformed.
+     */
+    private formatExpiration;
+}

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

@@ -0,0 +1,122 @@
+import { Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralList extends BaseCommand {
+    static description = 'List ephemeral tenants in a workspace, or across the whole instance with --global';
+    static examples = [
+        `$ xano ephemeral list
+Ephemeral tenants in workspace 5:
+  - PR preview (e4f2-9ab1-...) [ok] - expires in 1h 0m
+  - Demo (e7a3-2c10-...) [ok] - expires in 23h 12m
+`,
+        `$ xano ephemeral list --global
+Ephemeral tenants (all workspaces):
+  - PR preview (e4f2-9ab1-...) [ok] - expires in 1h 0m
+`,
+        `$ xano ephemeral list -w 5 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        global: Flags.boolean({
+            default: false,
+            description: 'List ephemeral tenants across the whole instance (all workspaces)',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(EphemeralList);
+        const { profile } = this.resolveProfile(flags);
+        let workspaceId;
+        let apiUrl;
+        if (flags.global) {
+            apiUrl = `${profile.instance_origin}/api:meta/ephemeral`;
+        }
+        else {
+            workspaceId = flags.workspace || profile.workspace;
+            if (!workspaceId) {
+                this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+            }
+            apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/ephemeral`;
+        }
+        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 data = (await response.json());
+            let tenants;
+            if (Array.isArray(data)) {
+                tenants = data;
+            }
+            else if (data && typeof data === 'object' && Array.isArray(data.items)) {
+                tenants = data.items;
+            }
+            else {
+                this.error('Unexpected API response format');
+            }
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tenants, null, 2));
+            }
+            else if (tenants.length === 0) {
+                this.log('No ephemeral tenants found');
+            }
+            else {
+                this.log(flags.global ? 'Ephemeral tenants (all workspaces):' : `Ephemeral tenants in workspace ${workspaceId}:`);
+                for (const tenant of tenants) {
+                    const state = tenant.state ? ` [${tenant.state}]` : '';
+                    const expires = ` - expires ${this.formatExpiration(tenant.ephemeral_expires_at)}`;
+                    const workspaceLabel = flags.global && tenant.workspace_id ? ` (workspace ${tenant.workspace_id})` : '';
+                    this.log(`  - ${tenant.display || tenant.name} (${tenant.name})${state}${expires}${workspaceLabel}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to list ephemeral tenants: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to list ephemeral tenants: ${String(error)}`);
+            }
+        }
+    }
+    /**
+     * Render a unix-epoch-seconds expiration as a human-readable "in Xh Ym" string,
+     * falling back to an ISO timestamp if the value has already passed or is malformed.
+     */
+    formatExpiration(expiresAt) {
+        if (!expiresAt) {
+            return '-';
+        }
+        // The API serializes the timestamp field as a date string
+        // ("2026-07-24 19:49:15+0000"); tolerate a raw unix-epoch number too.
+        const expiresMs = typeof expiresAt === 'number' ? expiresAt * 1000 : Date.parse(String(expiresAt).replace(' ', 'T'));
+        if (Number.isNaN(expiresMs)) {
+            return String(expiresAt);
+        }
+        const diffSeconds = (expiresMs - Date.now()) / 1000;
+        if (diffSeconds <= 0) {
+            return `${new Date(expiresMs).toISOString()} (expired)`;
+        }
+        const hours = Math.floor(diffSeconds / 3600);
+        const minutes = Math.floor((diffSeconds % 3600) / 60);
+        return `in ${hours}h ${minutes}m`;
+    }
+}

package/dist/commands/ephemeral/pull/index.d.ts

@@ -0,0 +1,23 @@
+import BaseCommand from '../../../base-command.js';
+export default class EphemeralPull extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        draft: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        tenant: 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>;
+    /**
+     * Sanitize a document name for use as a filename.
+     * Strips quotes, replaces spaces with underscores, and removes
+     * characters that are unsafe in filenames.
+     */
+    private sanitizeFilename;
+}