@xano/cli 0.0.95 → 1.0.1

package/dist/commands/sandbox/pull/index.js

@@ -0,0 +1,185 @@
+import { Flags } from '@oclif/core';
+import snakeCase from 'lodash.snakecase';
+import BaseCommand from '../../../base-command.js';
+import { buildApiGroupFolderResolver, parseDocument } from '../../../utils/document-parser.js';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+export default class SandboxPull extends BaseCommand {
+    static description = 'Pull documents from your sandbox environment and split into individual files';
+    static examples = [
+        `$ xano sandbox pull
+Pulled 42 documents from sandbox environment to current directory
+`,
+        `$ xano sandbox pull -d ./my-sandbox
+Pulled 42 documents from sandbox environment to ./my-sandbox
+`,
+        `$ xano sandbox pull --env --records`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        directory: Flags.string({
+            char: 'd',
+            default: '.',
+            description: 'Output directory for pulled documents (defaults to current directory)',
+            required: false,
+        }),
+        draft: Flags.boolean({
+            default: false,
+            description: 'Include draft versions',
+            required: false,
+        }),
+        env: Flags.boolean({
+            default: false,
+            description: 'Include environment variables',
+            required: false,
+        }),
+        records: Flags.boolean({
+            default: false,
+            description: 'Include records',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SandboxPull);
+        const { profile } = this.resolveProfile(flags);
+        const queryParams = new URLSearchParams({
+            env: flags.env.toString(),
+            include_draft: flags.draft.toString(),
+            records: flags.records.toString(),
+        });
+        const apiUrl = `${profile.instance_origin}/api:meta/sandbox/multidoc?${queryParams.toString()}`;
+        let responseText;
+        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 message = await this.parseApiError(response, 'API request failed');
+                this.error(message);
+            }
+            responseText = await response.text();
+        }
+        catch (error) {
+            if (error instanceof Error && 'oclif' in error)
+                throw error;
+            if (error instanceof Error) {
+                this.error(`Failed to fetch multidoc: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch multidoc: ${String(error)}`);
+            }
+        }
+        const rawDocuments = responseText.split('\n---\n');
+        const documents = [];
+        for (const raw of rawDocuments) {
+            const trimmed = raw.trim();
+            if (!trimmed) {
+                continue;
+            }
+            const parsed = parseDocument(trimmed);
+            if (parsed) {
+                documents.push(parsed);
+            }
+        }
+        if (documents.length === 0) {
+            this.log('No documents found in response');
+            return;
+        }
+        const outputDir = path.resolve(flags.directory);
+        fs.mkdirSync(outputDir, { recursive: true });
+        const getApiGroupFolder = buildApiGroupFolderResolver(documents, snakeCase);
+        const filenameCounters = new Map();
+        let writtenCount = 0;
+        for (const doc of documents) {
+            let typeDir;
+            let baseName;
+            if (doc.type === 'workspace') {
+                typeDir = path.join(outputDir, 'workspace');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'workspace_trigger') {
+                typeDir = path.join(outputDir, 'workspace', 'trigger');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'agent') {
+                typeDir = path.join(outputDir, 'ai', 'agent');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'mcp_server') {
+                typeDir = path.join(outputDir, 'ai', 'mcp_server');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'tool') {
+                typeDir = path.join(outputDir, 'ai', 'tool');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'agent_trigger') {
+                typeDir = path.join(outputDir, 'ai', 'agent', 'trigger');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'mcp_server_trigger') {
+                typeDir = path.join(outputDir, 'ai', 'mcp_server', 'trigger');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'table_trigger') {
+                typeDir = path.join(outputDir, 'table', 'trigger');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'realtime_channel') {
+                typeDir = path.join(outputDir, 'realtime', 'channel');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'realtime_trigger') {
+                typeDir = path.join(outputDir, 'realtime', 'trigger');
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'api_group') {
+                const groupFolder = getApiGroupFolder(doc.name);
+                typeDir = path.join(outputDir, 'api', groupFolder);
+                baseName = this.sanitizeFilename(doc.name);
+            }
+            else if (doc.type === 'query' && doc.apiGroup) {
+                const groupFolder = getApiGroupFolder(doc.apiGroup);
+                const nameParts = doc.name.split('/');
+                const leafName = nameParts.pop();
+                const folderParts = nameParts.map((part) => snakeCase(part));
+                typeDir = path.join(outputDir, 'api', groupFolder, ...folderParts);
+                baseName = this.sanitizeFilename(leafName);
+                if (doc.verb) {
+                    baseName = `${baseName}_${doc.verb}`;
+                }
+            }
+            else {
+                const nameParts = doc.name.split('/');
+                const leafName = nameParts.pop();
+                const folderParts = nameParts.map((part) => snakeCase(part));
+                typeDir = path.join(outputDir, doc.type, ...folderParts);
+                baseName = this.sanitizeFilename(leafName);
+                if (doc.verb) {
+                    baseName = `${baseName}_${doc.verb}`;
+                }
+            }
+            fs.mkdirSync(typeDir, { recursive: true });
+            const dirKey = path.relative(outputDir, typeDir);
+            if (!filenameCounters.has(dirKey)) {
+                filenameCounters.set(dirKey, new Map());
+            }
+            const typeCounters = filenameCounters.get(dirKey);
+            const count = typeCounters.get(baseName) || 0;
+            typeCounters.set(baseName, count + 1);
+            let filename;
+            filename = count === 0 ? `${baseName}.xs` : `${baseName}_${count + 1}.xs`;
+            const filePath = path.join(typeDir, filename);
+            fs.writeFileSync(filePath, doc.content, 'utf8');
+            writtenCount++;
+        }
+        this.log(`Pulled ${writtenCount} documents from sandbox environment to ${flags.directory}`);
+    }
+    sanitizeFilename(name) {
+        return snakeCase(name.replaceAll('"', ''));
+    }
+}

package/dist/commands/sandbox/push/index.d.ts

@@ -0,0 +1,26 @@
+import BaseCommand from '../../../base-command.js';
+export default class SandboxPush extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        delete: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        exclude: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        guids: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        include: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        review: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        sync: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        transaction: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        truncate: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        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 openReview;
+    private getFrontendUrl;
+}

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

@@ -0,0 +1,196 @@
+import { Flags } from '@oclif/core';
+import * as fs from 'node:fs';
+import { resolve } from 'node:path';
+import open from 'open';
+import BaseCommand from '../../../base-command.js';
+import { executePush } from '../../../utils/multidoc-push.js';
+export default class SandboxPush extends BaseCommand {
+    static description = 'Push local documents to your sandbox environment 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 sandbox push
+Push from current directory (default partial mode)
+`,
+        `$ xano sandbox push -d ./my-workspace
+Push from a specific directory
+`,
+        `$ xano sandbox push --sync
+Push all files to the sandbox
+`,
+        `$ xano sandbox push --sync --delete
+Push all files and delete remote objects not included
+`,
+        `$ xano sandbox push --dry-run
+Preview changes without pushing
+`,
+        `$ xano sandbox push --force
+Skip preview and push immediately
+`,
+        `$ xano sandbox push --records --env`,
+        `$ xano sandbox push --truncate`,
+        `$ xano sandbox push -i "**/func*"
+Push only files matching the glob pattern
+`,
+        `$ xano sandbox push -i "function/*" -i "table/*"
+Push files matching multiple patterns
+`,
+        `$ xano sandbox push -e "table/*"
+Push all files except tables
+`,
+        `$ xano sandbox push --review
+Push and open sandbox review in the browser
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        directory: Flags.string({
+            char: 'd',
+            default: '.',
+            description: 'Directory containing documents to push (defaults to current directory)',
+            required: false,
+        }),
+        delete: Flags.boolean({
+            default: false,
+            description: 'Delete sandbox objects not included in the push (requires --sync)',
+            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,
+        }),
+        exclude: Flags.string({
+            char: 'e',
+            description: 'Glob pattern to exclude files (e.g. "table/*", "**/test*"). Matched against relative paths from the push directory.',
+            multiple: true,
+            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,
+        }),
+        include: Flags.string({
+            char: 'i',
+            description: 'Glob pattern to include files (e.g. "**/func*", "table/*.xs"). Matched against relative paths from the push directory.',
+            multiple: true,
+            required: false,
+        }),
+        records: Flags.boolean({
+            default: false,
+            description: 'Include records in import',
+            required: false,
+        }),
+        review: Flags.boolean({
+            default: false,
+            description: 'Open sandbox review in the browser after pushing',
+            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: 'Wrap import in a database transaction (use --no-transaction for debugging purposes)',
+            required: false,
+        }),
+        truncate: Flags.boolean({
+            default: false,
+            description: 'Truncate all table records before importing',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SandboxPush);
+        const { profile } = this.resolveProfile(flags);
+        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 baseUrl = `${profile.instance_origin}/api:meta/sandbox`;
+        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: 'sandbox environment',
+            supportsBranches: false,
+            supportsPartial: true,
+        };
+        const pushFlags = {
+            delete: flags.delete,
+            'dry-run': flags['dry-run'],
+            env: flags.env,
+            exclude: flags.exclude,
+            force: flags.force,
+            guids: flags.guids,
+            include: flags.include,
+            records: flags.records,
+            sync: flags.sync,
+            transaction: flags.transaction,
+            truncate: flags.truncate,
+            verbose: flags.verbose,
+        };
+        await executePush({
+            accessToken: profile.access_token,
+            branch: '',
+            command: this,
+            inputDir,
+            verboseFetch: this.verboseFetch.bind(this),
+        }, target, pushFlags);
+        if (flags.review) {
+            await this.openReview(profile.instance_origin, profile.access_token, flags.verbose);
+        }
+    }
+    async openReview(instanceOrigin, accessToken, verbose) {
+        const response = await this.verboseFetch(`${instanceOrigin}/api:meta/sandbox/impersonate`, {
+            headers: {
+                accept: 'application/json',
+                Authorization: `Bearer ${accessToken}`,
+            },
+            method: 'GET',
+        }, verbose, accessToken);
+        if (!response.ok) {
+            const message = await this.parseApiError(response, 'Failed to open sandbox review');
+            this.error(message);
+        }
+        const result = (await response.json());
+        if (!result._ti) {
+            this.error('No one-time token returned from impersonate API');
+        }
+        const frontendUrl = this.getFrontendUrl(instanceOrigin);
+        const params = new URLSearchParams({ _ti: result._ti });
+        const reviewUrl = `${frontendUrl}/impersonate?${params.toString()}`;
+        this.log('Opening sandbox review...');
+        await open(reviewUrl);
+    }
+    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/sandbox/reset/index.d.ts

@@ -0,0 +1,13 @@
+import BaseCommand from '../../../base-command.js';
+export default class SandboxReset extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        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/sandbox/reset/index.js

@@ -0,0 +1,71 @@
+import { Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class SandboxReset extends BaseCommand {
+    static description = 'Reset your sandbox environment (clears all workspace data and drafts)';
+    static examples = [
+        `$ xano sandbox reset
+Are you sure you want to reset your sandbox environment? All workspace data and drafts will be cleared. (y/N) y
+Sandbox environment has been reset.
+`,
+        `$ xano sandbox reset --force`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        force: Flags.boolean({
+            char: 'f',
+            default: false,
+            description: 'Skip confirmation prompt',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SandboxReset);
+        const { profile } = this.resolveProfile(flags);
+        if (!flags.force) {
+            const confirmed = await this.confirm(`Are you sure you want to reset your sandbox environment? All workspace data and drafts will be cleared.`);
+            if (!confirmed) {
+                this.log('Reset cancelled.');
+                return;
+            }
+        }
+        const apiUrl = `${profile.instance_origin}/api:meta/sandbox/reset`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'application/json',
+                },
+                method: 'POST',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const message = await this.parseApiError(response, 'API request failed');
+                this.error(message);
+            }
+            this.log('Sandbox environment has been reset.');
+        }
+        catch (error) {
+            if (error instanceof Error && 'oclif' in error)
+                throw error;
+            if (error instanceof Error) {
+                this.error(`Failed to reset sandbox environment: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to reset sandbox environment: ${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/sandbox/review/index.d.ts

@@ -0,0 +1,14 @@
+import BaseCommand from '../../../base-command.js';
+export default class SandboxReview extends BaseCommand {
+    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>;
+        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 getFrontendUrl;
+}

package/dist/commands/sandbox/review/index.js

@@ -0,0 +1,94 @@
+import { Flags } from '@oclif/core';
+import open from 'open';
+import BaseCommand from '../../../base-command.js';
+export default class SandboxReview extends BaseCommand {
+    static description = 'Open your sandbox environment in the browser to review and promote changes';
+    static examples = [
+        `$ xano sandbox review
+Opening browser...
+Review session started!
+`,
+        `$ xano sandbox review -u`,
+        `$ xano sandbox review -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,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SandboxReview);
+        const { profile } = this.resolveProfile(flags);
+        const apiUrl = `${profile.instance_origin}/api:meta/sandbox/impersonate`;
+        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 message = await this.parseApiError(response, 'API request failed');
+                this.error(message);
+            }
+            const result = (await response.json());
+            if (!result._ti) {
+                this.error('No one-time token returned from impersonate API');
+            }
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(result, null, 2));
+            }
+            else {
+                const frontendUrl = this.getFrontendUrl(profile.instance_origin);
+                const params = new URLSearchParams({
+                    _ti: result._ti,
+                });
+                const impersonateUrl = `${frontendUrl}/impersonate?${params.toString()}`;
+                if (flags['url-only']) {
+                    this.log(impersonateUrl);
+                }
+                else {
+                    this.log('Opening browser...');
+                    await open(impersonateUrl);
+                    this.log('Review session started!');
+                }
+            }
+            process.exit(0);
+        }
+        catch (error) {
+            if (error instanceof Error && 'oclif' in error)
+                throw error;
+            if (error instanceof Error) {
+                this.error(`Failed to open sandbox review: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to open sandbox review: ${String(error)}`);
+            }
+        }
+    }
+    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/sandbox/unit_test/list/index.d.ts

@@ -0,0 +1,14 @@
+import BaseCommand from '../../../../base-command.js';
+export default class SandboxUnitTestList extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'obj-type': import("@oclif/core/interfaces").OptionFlag<string | undefined, 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>;
+}