@xano/cli 1.0.6-beta.2 → 1.0.6-beta.20

package/dist/commands/function/run/index.js

@@ -17,6 +17,8 @@ export default class FunctionRun extends BaseCommand {
         `$ xano function:run calcScore --json @payload.json --data env=staging`,
         `$ echo '{"email":"jo@x.com"}' | xano function:run calcScore --stdin -o json | jq .result`,
         `$ xano function:run calcScore --branch dev --logs`,
+        `$ xano function:run calcScore --datasource test
+# Runs against the 'test' data source instead of 'live'`,
     ];
     static flags = {
         ...BaseCommand.baseFlags,
@@ -30,6 +32,10 @@ export default class FunctionRun extends BaseCommand {
             multiple: true,
             required: false,
         }),
+        datasource: Flags.string({
+            description: 'Data source to run against, e.g. test (defaults to live)',
+            required: false,
+        }),
         json: Flags.string({
             description: "Input as a JSON object: inline, @file.json, or '-' for stdin",
             exclusive: ['stdin'],
@@ -106,13 +112,21 @@ export default class FunctionRun extends BaseCommand {
         const body = { input, name: functionName };
         if (branch)
             body.branch = branch;
+        const headers = {
+            'accept': 'application/json',
+            'Authorization': `Bearer ${profile.access_token}`,
+            'Content-Type': 'application/json',
+        };
+        // The Metadata API resolves the workspace's tables against the data source
+        // named by X-Data-Source (defaulting to `live`), so the run reads and writes
+        // the same tables a request carrying that header would. An unknown label is
+        // rejected server-side with "Invalid data source."
+        const dataSource = flags.datasource?.trim();
+        if (dataSource)
+            headers['X-Data-Source'] = dataSource;
         const response = await this.verboseFetch(apiUrl, {
             body: JSON.stringify(body),
-            headers: {
-                'accept': 'application/json',
-                'Authorization': `Bearer ${profile.access_token}`,
-                'Content-Type': 'application/json',
-            },
+            headers,
             method: 'POST',
         }, flags.verbose, profile.access_token);
         if (!response.ok) {

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

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
 import BaseCommand from '../../../base-command.js';
+import { buildPagingJson } from '../../../utils/paging.js';
 export default class KnowledgeList extends BaseCommand {
     static args = {};
     static description = 'List workspace knowledge and skills as plain-text markdown';
@@ -92,7 +93,7 @@ export default class KnowledgeList extends BaseCommand {
             const data = await response.json();
             const items = Array.isArray(data) ? data : (data.items ?? []);
             if (flags.output === 'json') {
-                this.log(JSON.stringify(items, null, 2));
+                this.log(JSON.stringify(buildPagingJson({ items }, { tier: 'none' }), null, 2));
                 return;
             }
             this.log(this.formatMarkdown(items));

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

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
 import BaseCommand from '../../../base-command.js';
+import { buildPagingJson } from '../../../utils/paging.js';
 export default class PlatformList extends BaseCommand {
     static description = 'List all platforms';
     static examples = [
@@ -47,22 +48,20 @@ Platforms:
                 this.error('Unexpected API response format');
             }
             if (flags.output === 'json') {
-                this.log(JSON.stringify(platforms, null, 2));
+                this.log(JSON.stringify(buildPagingJson({ items: platforms }, { tier: 'none' }), null, 2));
+            }
+            else if (platforms.length === 0) {
+                this.log('No platforms found');
             }
             else {
-                if (platforms.length === 0) {
-                    this.log('No platforms found');
-                }
-                else {
-                    this.log('Platforms:');
-                    for (const platform of platforms) {
-                        const label = platform.name || `ID: ${platform.id}`;
-                        const helmTag = platform.helm?.tag ? ` | Helm: ${platform.helm.tag}` : '';
-                        const created = platform.created_at
-                            ? ` | Created: ${new Date(platform.created_at).toISOString().split('T')[0]}`
-                            : '';
-                        this.log(`  ${label}${helmTag}${created}`);
-                    }
+                this.log('Platforms:');
+                for (const platform of platforms) {
+                    const label = platform.name || `ID: ${platform.id}`;
+                    const helmTag = platform.helm?.tag ? ` | Helm: ${platform.helm.tag}` : '';
+                    const created = platform.created_at
+                        ? ` | Created: ${new Date(platform.created_at).toISOString().split('T')[0]}`
+                        : '';
+                    this.log(`  ${label}${helmTag}${created}`);
                 }
             }
         }

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

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
 import BaseCommand from '../../../base-command.js';
+import { buildPagingJson } from '../../../utils/paging.js';
 export default class ReleaseList extends BaseCommand {
     static description = 'List all releases in a workspace';
     static examples = [
@@ -57,22 +58,20 @@ Releases in workspace 5:
                 this.error('Unexpected API response format');
             }
             if (flags.output === 'json') {
-                this.log(JSON.stringify(releases, null, 2));
+                this.log(JSON.stringify(buildPagingJson({ items: releases }, { tier: 'none' }), null, 2));
+            }
+            else if (releases.length === 0) {
+                this.log('No releases found');
             }
             else {
-                if (releases.length === 0) {
-                    this.log('No releases found');
-                }
-                else {
-                    this.log(`Releases in workspace ${workspaceId}:`);
-                    for (const release of releases) {
-                        const branch = release.branch ? ` - ${release.branch}` : '';
-                        const hotfix = release.hotfix ? ' [hotfix]' : '';
-                        const createdAt = release.created_at
-                            ? ` (${new Date(release.created_at).toLocaleString(undefined, { timeZoneName: 'short' })})`
-                            : '';
-                        this.log(`  - ${release.name} (ID: ${release.id})${branch}${hotfix}${createdAt}`);
-                    }
+                this.log(`Releases in workspace ${workspaceId}:`);
+                for (const release of releases) {
+                    const branch = release.branch ? ` - ${release.branch}` : '';
+                    const hotfix = release.hotfix ? ' [hotfix]' : '';
+                    const createdAt = release.created_at
+                        ? ` (${new Date(release.created_at).toLocaleString(undefined, { timeZoneName: 'short' })})`
+                        : '';
+                    this.log(`  - ${release.name} (ID: ${release.id})${branch}${hotfix}${createdAt}`);
                 }
             }
         }

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

@@ -14,10 +14,4 @@ export default class ReleasePull extends BaseCommand {
     };
     run(): Promise<void>;
     private resolveReleaseName;
-    /**
-     * 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;
 }

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

@@ -3,7 +3,7 @@ import * as fs from 'node:fs';
 import * as path from 'node:path';
 import snakeCase from 'lodash.snakecase';
 import BaseCommand from '../../../base-command.js';
-import { buildApiGroupFolderResolver, parseDocument } from '../../../utils/document-parser.js';
+import { buildApiGroupFolderResolver, buildChannelServerResolver, parseDocument, resolveDocumentPath, } from '../../../utils/document-parser.js';
 export default class ReleasePull extends BaseCommand {
     static description = 'Pull a release multidoc from the Xano Metadata API and split into individual files';
     static examples = [
@@ -123,96 +123,19 @@ Pulled 58 documents from release 'v1.0'
         fs.mkdirSync(outputDir, { recursive: true });
         // Resolve api_group names to unique folder names, disambiguating collisions
         const getApiGroupFolder = buildApiGroupFolderResolver(documents, snakeCase);
+        // Resolve a realtime v2 channel path -> owning realtime_server name, so
+        // messages can nest under their channel's server (see resolver docs).
+        const getChannelServer = buildChannelServerResolver(documents);
         // Track filenames per type to handle duplicates
         const filenameCounters = new Map();
         let writtenCount = 0;
         for (const doc of documents) {
-            let typeDir;
-            let baseName;
-            if (doc.type === 'workspace') {
-                // workspace → workspace/{name}.xs
-                typeDir = path.join(outputDir, 'workspace');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'workspace_trigger') {
-                // workspace_trigger → workspace/trigger/{name}.xs
-                typeDir = path.join(outputDir, 'workspace', 'trigger');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'error_trigger') {
-                // error_trigger → workspace/trigger/{name}.xs (singleton, colocated with workspace triggers)
-                typeDir = path.join(outputDir, 'workspace', 'trigger');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'agent') {
-                // agent → ai/agent/{name}.xs
-                typeDir = path.join(outputDir, 'ai', 'agent');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'mcp_server') {
-                // mcp_server → ai/mcp_server/{name}.xs
-                typeDir = path.join(outputDir, 'ai', 'mcp_server');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'tool') {
-                // tool → ai/tool/{name}.xs
-                typeDir = path.join(outputDir, 'ai', 'tool');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'agent_trigger') {
-                // agent_trigger → ai/agent/trigger/{name}.xs
-                typeDir = path.join(outputDir, 'ai', 'agent', 'trigger');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'mcp_server_trigger') {
-                // mcp_server_trigger → ai/mcp_server/trigger/{name}.xs
-                typeDir = path.join(outputDir, 'ai', 'mcp_server', 'trigger');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'table_trigger') {
-                // table_trigger → table/trigger/{name}.xs
-                typeDir = path.join(outputDir, 'table', 'trigger');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'realtime_channel') {
-                // realtime_channel → realtime/channel/{name}.xs
-                typeDir = path.join(outputDir, 'realtime', 'channel');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'realtime_trigger') {
-                // realtime_trigger → realtime/trigger/{name}.xs
-                typeDir = path.join(outputDir, 'realtime', 'trigger');
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'api_group') {
-                // api_group "test" → api/{resolved_folder}/{name}.xs
-                const groupFolder = getApiGroupFolder(doc.name);
-                typeDir = path.join(outputDir, 'api', groupFolder);
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'query' && doc.apiGroup) {
-                // query in group "test" → api/{resolved_folder}/{query_name}.xs
-                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 {
-                // Default: split folder path from name
-                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}`;
-                }
-            }
+            const { baseName, typeDir } = resolveDocumentPath(doc, outputDir, {
+                getApiGroupFolder,
+                getChannelServer,
+                join: path.join,
+                snakeCase,
+            });
             fs.mkdirSync(typeDir, { recursive: true });
             // Track duplicates per directory
             const dirKey = path.relative(outputDir, typeDir);
@@ -257,12 +180,4 @@ Pulled 58 documents from release 'v1.0'
         }
         return match.id;
     }
-    /**
-     * Sanitize a document name for use as a filename.
-     * Strips quotes, replaces spaces with underscores, and removes
-     * characters that are unsafe in filenames.
-     */
-    sanitizeFilename(name) {
-        return snakeCase(name.replaceAll('"', ''));
-    }
 }

package/dist/commands/sandbox/env/list/index.js

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
 import BaseCommand from '../../../../base-command.js';
+import { formatPagingFooter } from '../../../../utils/paging.js';
 export default class SandboxEnvList extends BaseCommand {
     static description = 'List environment variable keys for a sandbox environment';
     static examples = [
@@ -51,6 +52,9 @@ Environment variables for sandbox environment:
                         this.log(`  - ${envVar.name}`);
                     }
                 }
+                const footer = formatPagingFooter({ items: envVars }, { noun: 'environment variable', tier: 'none' });
+                if (footer)
+                    this.log(footer);
             }
         }
         catch (error) {

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

@@ -12,5 +12,4 @@ export default class SandboxPull extends BaseCommand {
         verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
-    private sanitizeFilename;
 }

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

@@ -1,7 +1,7 @@
 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 { buildApiGroupFolderResolver, buildChannelServerResolver, parseDocument, resolveDocumentPath, } from '../../../utils/document-parser.js';
 import { fetchKnowledge, writeKnowledge } from '../../../utils/knowledge-sync.js';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
@@ -92,82 +92,18 @@ Pulled 42 documents from sandbox environment to ./my-sandbox
         const outputDir = path.resolve(flags.directory);
         fs.mkdirSync(outputDir, { recursive: true });
         const getApiGroupFolder = buildApiGroupFolderResolver(documents, snakeCase);
+        // Resolve a realtime v2 channel path -> owning realtime_server name, so
+        // messages can nest under their channel's server (see resolver docs).
+        const getChannelServer = buildChannelServerResolver(documents);
         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 === 'error_trigger') {
-                // error_trigger → workspace/trigger/{name}.xs (singleton, colocated with workspace triggers)
-                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}`;
-                }
-            }
+            const { baseName, typeDir } = resolveDocumentPath(doc, outputDir, {
+                getApiGroupFolder,
+                getChannelServer,
+                join: path.join,
+                snakeCase,
+            });
             fs.mkdirSync(typeDir, { recursive: true });
             const dirKey = path.relative(outputDir, typeDir);
             if (!filenameCounters.has(dirKey)) {
@@ -194,7 +130,4 @@ Pulled 42 documents from sandbox environment to ./my-sandbox
             parts.push(`${knowledgeCount} knowledge file${knowledgeCount === 1 ? '' : 's'}`);
         this.log(`Pulled ${parts.join(' + ')} from sandbox environment to ${flags.directory}`);
     }
-    sanitizeFilename(name) {
-        return snakeCase(name.replaceAll('"', ''));
-    }
 }

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

@@ -3,6 +3,8 @@ export default class SandboxUnitTestList extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
+        page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        per_page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
         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>;

package/dist/commands/sandbox/unit_test/list/index.js

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
 import BaseCommand from '../../../../base-command.js';
+import { buildPagingJson, buildPagingParams, formatPagingFooter, normalizeListResponse, pagingFlags } from '../../../../utils/paging.js';
 export default class SandboxUnitTestList extends BaseCommand {
     static description = 'List all unit tests for a sandbox environment';
     static examples = [
@@ -28,12 +29,12 @@ Unit tests:
             options: ['summary', 'json'],
             required: false,
         }),
+        ...pagingFlags('envelope', { maxPerPage: 10_000 }),
     };
     async run() {
         const { flags } = await this.parse(SandboxUnitTestList);
         const { profile } = this.resolveProfile(flags);
-        const params = new URLSearchParams();
-        params.set('per_page', '10000');
+        const params = new URLSearchParams(buildPagingParams(flags, 'envelope'));
         if (flags.branch)
             params.set('branch', flags.branch);
         if (flags['obj-type'])
@@ -51,19 +52,10 @@ Unit tests:
                 const message = await this.parseApiError(response, 'API request failed');
                 this.error(message);
             }
-            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');
-            }
+            const list = normalizeListResponse(await response.json());
+            const tests = list.items;
             if (flags.output === 'json') {
-                this.log(JSON.stringify(tests, null, 2));
+                this.log(JSON.stringify(buildPagingJson(list, { page: flags.page, perPage: flags.per_page, tier: 'envelope' }), null, 2));
             }
             else {
                 if (tests.length === 0) {
@@ -75,6 +67,9 @@ Unit tests:
                         this.log(`  - ${test.name} (ID: ${test.id}) [${test.obj_type}: ${test.obj_name}]`);
                     }
                 }
+                const footer = formatPagingFooter(list, { noun: 'unit test', page: flags.page, tier: 'envelope' });
+                if (footer)
+                    this.log(footer);
             }
         }
         catch (error) {

package/dist/commands/sandbox/unit_test/run/index.js

@@ -46,24 +46,30 @@ Result: PASS
                 this.error(message);
             }
             const result = (await response.json());
+            // Anything other than 'ok' is a failure -- the API has been observed
+            // returning several distinct non-ok statuses, so never enumerate them.
+            const passed = result.status === 'ok';
             if (flags.output === 'json') {
                 this.log(JSON.stringify(result, null, 2));
             }
+            else if (passed) {
+                this.log('Result: PASS');
+            }
             else {
-                if (result.status === 'ok') {
-                    this.log('Result: PASS');
-                }
-                else {
-                    this.log('Result: FAIL');
-                    const failedExpects = result.results?.filter((r) => r.status === 'fail') ?? [];
-                    for (const expect of failedExpects) {
-                        if (expect.message) {
-                            this.log(`  Error: ${expect.message}`);
-                        }
+                this.log('Result: FAIL');
+                const failedExpects = result.results?.filter((r) => r.status === 'fail') ?? [];
+                for (const expect of failedExpects) {
+                    if (expect.message) {
+                        this.log(`  Error: ${expect.message}`);
                     }
-                    this.exit(1);
                 }
             }
+            // Set the code rather than throwing via this.exit(): the exit must apply
+            // in both output modes, and process.exitCode cannot be swallowed by the
+            // surrounding catch. Mirrors what run_all already does.
+            if (!passed) {
+                process.exitCode = 1;
+            }
         }
         catch (error) {
             if (error instanceof Error && 'oclif' in error)

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

@@ -4,6 +4,7 @@ export default class SandboxUnitTestRunAll extends BaseCommand {
     static examples: string[];
     static flags: {
         branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        concurrency: import("@oclif/core/interfaces").OptionFlag<number, 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>;