@xano/cli 0.0.94 → 0.0.95-beta.10

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

@@ -0,0 +1,180 @@
+import { Args, 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 args = {
+        directory: Args.string({
+            description: 'Output directory for pulled documents',
+            required: true,
+        }),
+    };
+    static description = 'Pull documents from your sandbox environment and split into individual files';
+    static examples = [
+        `$ xano sandbox pull ./my-sandbox
+Pulled 42 documents from sandbox environment to ./my-sandbox
+`,
+        `$ xano sandbox pull ./backup --env --records`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        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 { args, 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 errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            responseText = await response.text();
+        }
+        catch (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(args.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 ${args.directory}`);
+    }
+    sanitizeFilename(name) {
+        return snakeCase(name.replaceAll('"', ''));
+    }
+}

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

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../base-command.js';
+export default class SandboxPush extends BaseCommand {
+    static args: {
+        directory: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        transaction: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        truncate: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private collectFiles;
+}

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

@@ -0,0 +1,141 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+import { findFilesWithGuid } from '../../../utils/document-parser.js';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+export default class SandboxPush extends BaseCommand {
+    static args = {
+        directory: Args.string({
+            description: 'Directory containing documents to push (as produced by sandbox pull or workspace pull)',
+            required: true,
+        }),
+    };
+    static description = 'Push local documents to your sandbox environment via multidoc import';
+    static examples = [
+        `$ xano sandbox push ./my-workspace
+Pushed 42 documents to sandbox environment from ./my-workspace
+`,
+        `$ xano sandbox push ./backup --records --env`,
+        `$ xano sandbox push ./my-workspace --truncate`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        env: Flags.boolean({
+            default: false,
+            description: 'Include environment variables in import',
+            required: false,
+        }),
+        records: Flags.boolean({
+            default: false,
+            description: 'Include records in import',
+            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 { args, flags } = await this.parse(SandboxPush);
+        const { profile } = this.resolveProfile(flags);
+        const inputDir = path.resolve(args.directory);
+        if (!fs.existsSync(inputDir)) {
+            this.error(`Directory not found: ${inputDir}`);
+        }
+        if (!fs.statSync(inputDir).isDirectory()) {
+            this.error(`Not a directory: ${inputDir}`);
+        }
+        const files = this.collectFiles(inputDir);
+        if (files.length === 0) {
+            this.error(`No .xs files found in ${args.directory}`);
+        }
+        const documentEntries = [];
+        for (const filePath of files) {
+            const content = fs.readFileSync(filePath, 'utf8').trim();
+            if (content) {
+                documentEntries.push({ content, filePath });
+            }
+        }
+        if (documentEntries.length === 0) {
+            this.error(`All .xs files in ${args.directory} are empty`);
+        }
+        const multidoc = documentEntries.map((d) => d.content).join('\n---\n');
+        const queryParams = new URLSearchParams({
+            env: flags.env.toString(),
+            records: flags.records.toString(),
+            transaction: flags.transaction.toString(),
+            truncate: flags.truncate.toString(),
+        });
+        const apiUrl = `${profile.instance_origin}/api:meta/sandbox/multidoc?${queryParams.toString()}`;
+        const startTime = Date.now();
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                body: multidoc,
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'text/x-xanoscript',
+                },
+                method: 'POST',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                let errorMessage = `Push failed (${response.status})`;
+                try {
+                    const errorJson = JSON.parse(errorText);
+                    errorMessage += `: ${errorJson.message}`;
+                    if (errorJson.payload?.param) {
+                        errorMessage += `\n  Parameter: ${errorJson.payload.param}`;
+                    }
+                }
+                catch {
+                    errorMessage += `\n${errorText}`;
+                }
+                const guidMatch = errorMessage.match(/Duplicate \w+ guid: (\S+)/);
+                if (guidMatch) {
+                    const dupeFiles = findFilesWithGuid(documentEntries, guidMatch[1]);
+                    if (dupeFiles.length > 0) {
+                        const relPaths = dupeFiles.map((f) => path.relative(inputDir, f));
+                        errorMessage += `\n  Local files with this GUID:\n${relPaths.map((f) => `    ${f}`).join('\n')}`;
+                    }
+                }
+                this.error(errorMessage);
+            }
+            const responseText = await response.text();
+            if (responseText && responseText !== 'null' && flags.verbose) {
+                this.log(responseText);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to push multidoc: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to push multidoc: ${String(error)}`);
+            }
+        }
+        const elapsed = ((Date.now() - startTime) / 1000).toFixed(1);
+        this.log(`Pushed ${documentEntries.length} documents to sandbox environment from ${args.directory} in ${elapsed}s`);
+    }
+    collectFiles(dir) {
+        const files = [];
+        const entries = fs.readdirSync(dir, { withFileTypes: true });
+        for (const entry of entries) {
+            const fullPath = path.join(dir, entry.name);
+            if (entry.isDirectory()) {
+                files.push(...this.collectFiles(fullPath));
+            }
+            else if (entry.isFile() && entry.name.endsWith('.xs')) {
+                files.push(fullPath);
+            }
+        }
+        return files.sort();
+    }
+}

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

@@ -0,0 +1,12 @@
+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>;
+        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,69 @@
+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 errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            this.log('Sandbox environment has been reset.');
+        }
+        catch (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,13 @@
+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>;
+        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,92 @@
+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 errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            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) {
+                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,13 @@
+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>;
+        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/sandbox/unit_test/list/index.js

@@ -0,0 +1,89 @@
+import { Flags } from '@oclif/core';
+import BaseCommand from '../../../../base-command.js';
+export default class SandboxUnitTestList extends BaseCommand {
+    static description = 'List all unit tests for a sandbox environment';
+    static examples = [
+        `$ xano sandbox unit-test list
+Unit tests:
+  - my-test (ID: abc-123) [function: math]
+`,
+        `$ xano sandbox unit-test list -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        branch: Flags.string({
+            char: 'b',
+            description: 'Filter by branch name',
+            required: false,
+        }),
+        'obj-type': Flags.string({
+            description: 'Filter by object type',
+            options: ['function', 'query', 'middleware'],
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SandboxUnitTestList);
+        const { profile } = this.resolveProfile(flags);
+        const params = new URLSearchParams();
+        params.set('per_page', '10000');
+        if (flags.branch)
+            params.set('branch', flags.branch);
+        if (flags['obj-type'])
+            params.set('obj_type', flags['obj-type']);
+        const apiUrl = `${profile.instance_origin}/api:meta/sandbox/unit_test?${params}`;
+        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 tests;
+            if (Array.isArray(data)) {
+                tests = data;
+            }
+            else if (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)) {
+                tests = data.items;
+            }
+            else {
+                this.error('Unexpected API response format');
+            }
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(tests, null, 2));
+            }
+            else {
+                if (tests.length === 0) {
+                    this.log('No unit tests found');
+                }
+                else {
+                    this.log(`Unit tests for sandbox environment:`);
+                    for (const test of tests) {
+                        this.log(`  - ${test.name} (ID: ${test.id}) [${test.obj_type}: ${test.obj_name}]`);
+                    }
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to list unit tests: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to list unit tests: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/sandbox/unit_test/run/index.d.ts

@@ -0,0 +1,14 @@
+import BaseCommand from '../../../../base-command.js';
+export default class SandboxUnitTestRun extends BaseCommand {
+    static args: {
+        unit_test_id: 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>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}