@xano/cli 1.0.6-beta.0 → 1.0.6-beta.10

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

@@ -0,0 +1,132 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../base-command.js';
+import { buildPagingJson, buildPagingParams, formatPagingFooter, normalizeListResponse, pagingFlags } from '../../../../utils/paging.js';
+export default class EphemeralStaticHostList extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name',
+            required: true,
+        }),
+    };
+    static description = 'List all static hosts for an ephemeral tenant from the Xano Metadata API';
+    static examples = [
+        `$ xano ephemeral static_host list e4f2-9ab1-xyz1 -w 40
+Available static hosts:
+  - my-static-host (ID: 1)
+  - another-host (ID: 2)
+`,
+        `$ xano ephemeral static_host list e4f2-9ab1-xyz1 --profile production
+Available static hosts:
+  - my-static-host (ID: 1)
+  - another-host (ID: 2)
+`,
+        `$ xano ephemeral static_host list e4f2-9ab1-xyz1 -w 40 --output json
+{
+  "count": 1,
+  "page": 1,
+  "total": 3,
+  "items": [
+    {
+      "id": 1,
+      "name": "my-static-host"
+    }
+  ]
+}
+`,
+        `$ xano ephemeral static_host list e4f2-9ab1-xyz1 -p staging -o json --page 2
+[
+  {
+    "id": 3,
+    "name": "static-host-3"
+  }
+]
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        ...pagingFlags('page-only-envelope', { fixedPerPage: 100 }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (optional if set in profile)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralStaticHostList);
+        const { profile, profileName } = this.resolveProfile(flags);
+        const tenantName = args.tenant_name;
+        // Determine workspace_id from flag or profile
+        let workspaceId;
+        if (flags.workspace) {
+            workspaceId = flags.workspace;
+        }
+        else if (profile.workspace) {
+            workspaceId = profile.workspace;
+        }
+        else {
+            this.error(`Workspace ID is required. Either:\n` +
+                `  1. Provide it as a flag: xano ephemeral static_host list <tenant_name> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        // Build query parameters
+        const queryParams = new URLSearchParams(buildPagingParams(flags, 'page-only-envelope'));
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host?${queryParams.toString()}`;
+        // Fetch static hosts from the API
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const list = normalizeListResponse(await response.json(), ['static_hosts']);
+            const staticHosts = list.items;
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(buildPagingJson(list, { page: flags.page, tier: 'page-only-envelope' }), null, 2));
+            }
+            else {
+                // summary format
+                if (staticHosts.length === 0) {
+                    this.log('No static hosts found');
+                }
+                else {
+                    this.log('Available static hosts:');
+                    for (const host of staticHosts) {
+                        if (host.id === undefined) {
+                            this.log(`  - ${host.name}`);
+                        }
+                        else {
+                            const domainInfo = host.domain ? ` - ${host.domain}` : '';
+                            this.log(`  - ${host.name} (ID: ${host.id})${domainInfo}`);
+                        }
+                    }
+                }
+                const footer = formatPagingFooter(list, { noun: 'static host', page: flags.page, tier: 'page-only-envelope' });
+                if (footer)
+                    this.log(footer);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to fetch static hosts: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch static hosts: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/flatten/index.d.ts

@@ -0,0 +1,34 @@
+import { Command } from '@oclif/core';
+/**
+ * Split a multi-document `.xs` bundle into the standard one-document-per-file
+ * layout that the push pipeline requires.
+ *
+ * A hand-authored bundle keeps every object (workspace, tables, queries,
+ * microservices, …) in a single file joined by `---`. That is convenient to
+ * edit but unsupported by `push`: the partial-diff filter and GUID writeback
+ * both parse only the first document in a file, so such a bundle silently
+ * pushes nothing (partial mode) or corrupts GUIDs (full mode). `flatten` turns
+ * it back into the exact tree `pull` would have produced, using the shared
+ * placement logic so the two never drift.
+ *
+ * Not a BaseCommand: this is a purely local, offline transform — no profile,
+ * token, or network — so it extends oclif's Command directly.
+ */
+export default class Flatten extends Command {
+    static args: {
+        input: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'keep-source': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+    /** Recursively collect `.xs` files under a dir that actually hold >1 document. */
+    private collectMultiDocFiles;
+    /** Flatten a single bundle file. Returns the number of documents written. */
+    private flattenOne;
+}

package/dist/commands/flatten/index.js

@@ -0,0 +1,140 @@
+import { Args, Command, Flags, ux } from '@oclif/core';
+import * as fs from 'node:fs';
+import { join, relative, resolve } from 'node:path';
+import { flattenBundleFile } from '../../utils/flatten.js';
+/**
+ * Split a multi-document `.xs` bundle into the standard one-document-per-file
+ * layout that the push pipeline requires.
+ *
+ * A hand-authored bundle keeps every object (workspace, tables, queries,
+ * microservices, …) in a single file joined by `---`. That is convenient to
+ * edit but unsupported by `push`: the partial-diff filter and GUID writeback
+ * both parse only the first document in a file, so such a bundle silently
+ * pushes nothing (partial mode) or corrupts GUIDs (full mode). `flatten` turns
+ * it back into the exact tree `pull` would have produced, using the shared
+ * placement logic so the two never drift.
+ *
+ * Not a BaseCommand: this is a purely local, offline transform — no profile,
+ * token, or network — so it extends oclif's Command directly.
+ */
+export default class Flatten extends Command {
+    static args = {
+        input: Args.string({
+            description: 'A multi-document .xs file, or a directory containing them, to split',
+            required: true,
+        }),
+    };
+    static description = 'Split a multi-document .xs bundle (documents joined by `---`) into the standard ' +
+        'one-document-per-file layout that push requires. Deletes the original bundle by ' +
+        'default (use --keep-source to keep it). Purely local — no network.';
+    static examples = [
+        `$ xano flatten secret/pdf-micro/multidoc.xs
+Split the bundle in place into per-document files (removes multidoc.xs)`,
+        `$ xano flatten ./bundle.xs -o ./workspace
+Write the split files under ./workspace instead of alongside the bundle`,
+        `$ xano flatten secret/pdf-micro/multidoc.xs --dry-run
+Preview the file layout without writing anything`,
+        `$ xano flatten ./dir-of-bundles --keep-source
+Flatten every multi-doc .xs under a directory, keeping the originals`,
+    ];
+    static flags = {
+        'dry-run': Flags.boolean({
+            default: false,
+            description: 'Show the resulting file layout without writing anything',
+        }),
+        force: Flags.boolean({
+            char: 'f',
+            default: false,
+            description: 'Overwrite existing destination files instead of erroring',
+        }),
+        'keep-source': Flags.boolean({
+            default: false,
+            description: 'Keep the original multi-document file(s) (default: delete after a successful split)',
+        }),
+        output: Flags.string({
+            char: 'o',
+            description: 'Output directory (default: the directory each bundle file lives in)',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Flatten);
+        const inputPath = resolve(args.input);
+        if (!fs.existsSync(inputPath)) {
+            this.error(`Not found: ${inputPath}`);
+        }
+        // Resolve the set of bundle files to flatten.
+        const bundleFiles = fs.statSync(inputPath).isDirectory()
+            ? this.collectMultiDocFiles(inputPath)
+            : [inputPath];
+        if (bundleFiles.length === 0) {
+            this.error(fs.statSync(inputPath).isDirectory()
+                ? `No multi-document .xs files found under ${inputPath}`
+                : `${inputPath} is not a .xs file`);
+        }
+        let totalWritten = 0;
+        for (const bundleFile of bundleFiles) {
+            totalWritten += this.flattenOne(bundleFile, flags);
+        }
+        if (flags['dry-run']) {
+            this.log('');
+            this.log(ux.colorize('dim', `Dry run — ${totalWritten} file(s) would be written. Nothing changed.`));
+        }
+        else {
+            this.log('');
+            this.log(`Flattened ${bundleFiles.length} bundle(s) into ${totalWritten} file(s).`);
+        }
+    }
+    /** Recursively collect `.xs` files under a dir that actually hold >1 document. */
+    collectMultiDocFiles(dir) {
+        const out = [];
+        const walk = (d) => {
+            for (const entry of fs.readdirSync(d, { withFileTypes: true })) {
+                const full = join(d, entry.name);
+                if (entry.isDirectory()) {
+                    walk(full);
+                }
+                else if (entry.isFile() && entry.name.endsWith('.xs')) {
+                    const content = fs.readFileSync(full, 'utf8');
+                    if (/^---$/m.test(content))
+                        out.push(full);
+                }
+            }
+        };
+        walk(dir);
+        return out.sort();
+    }
+    /** Flatten a single bundle file. Returns the number of documents written. */
+    flattenOne(bundleFile, flags) {
+        const rel = relative(process.cwd(), bundleFile) || bundleFile;
+        let result;
+        try {
+            // Buffer the plan so we can print a header before it only when there's work.
+            const planLines = [];
+            result = flattenBundleFile(bundleFile, {
+                dryRun: flags['dry-run'],
+                force: flags.force,
+                keepSource: flags['keep-source'],
+                log: (msg) => planLines.push(msg),
+                outputDir: flags.output,
+            });
+            if (result.skipped === 'empty') {
+                this.warn(`No parseable documents in ${rel}; skipping.`);
+                return 0;
+            }
+            if (result.skipped === 'single') {
+                this.warn(`${rel} holds a single document; nothing to split. Skipping.`);
+                return 0;
+            }
+            this.log('');
+            this.log(ux.colorize('bold', `${rel} → ${result.written.length} documents`));
+            for (const l of planLines) {
+                // Colorize the WRITE marker; dim the incidental notes.
+                this.log(l.startsWith('  WRITE') ? l.replace('WRITE', ux.colorize('green', 'WRITE')) : ux.colorize('dim', l));
+            }
+        }
+        catch (error) {
+            this.error(error.message);
+        }
+        return result.written.length;
+    }
+}

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

@@ -4,14 +4,14 @@ export default class FunctionList extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
+        sort: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        per_page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
         include_draft: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         include_xanoscript: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         order: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        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>;
-        sort: 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>;

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

@@ -1,5 +1,6 @@
 import { Flags } from '@oclif/core';
 import BaseCommand from '../../../base-command.js';
+import { buildPagingJson, formatPagingFooter, normalizeListResponse, pagingFlags } from '../../../utils/paging.js';
 export default class FunctionList extends BaseCommand {
     static args = {};
     static description = 'List all functions in a workspace from the Xano Metadata API';
@@ -16,20 +17,30 @@ Available functions:
   - another-function (ID: 2)
 `,
         `$ xano function:list -w 40 --output json
-[
-  {
-    "id": 1,
-    "name": "function-1"
-  }
-]
+{
+  "count": 1,
+  "page": 1,
+  "per_page": 50,
+  "next_page": 2,
+  "items": [
+    {
+      "id": 1,
+      "name": "function-1"
+    }
+  ]
+}
 `,
         `$ xano function:list -p staging -o json --include_draft
-[
-  {
-    "id": 1,
-    "name": "function-1"
-  }
-]
+{
+  "count": 1,
+  "page": 1,
+  "items": [
+    {
+      "id": 1,
+      "name": "function-1"
+    }
+  ]
+}
 `,
     ];
     static flags = {
@@ -57,16 +68,7 @@ Available functions:
             options: ['summary', 'json'],
             required: false,
         }),
-        page: Flags.integer({
-            default: 1,
-            description: 'Page number for pagination',
-            required: false,
-        }),
-        per_page: Flags.integer({
-            default: 50,
-            description: 'Number of results per page',
-            required: false,
-        }),
+        ...pagingFlags('envelope', { maxPerPage: 10_000 }),
         sort: Flags.string({
             default: 'created_at',
             description: 'Sort field',
@@ -118,24 +120,11 @@ Available functions:
                 const errorText = await response.text();
                 this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
             }
-            const data = await response.json();
-            // Handle different response formats
-            let functions;
-            if (Array.isArray(data)) {
-                functions = data;
-            }
-            else if (data && typeof data === 'object' && 'functions' in data && Array.isArray(data.functions)) {
-                functions = data.functions;
-            }
-            else if (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)) {
-                functions = data.items;
-            }
-            else {
-                this.error('Unexpected API response format');
-            }
+            const list = normalizeListResponse(await response.json(), ['functions']);
+            const functions = list.items;
             // Output results
             if (flags.output === 'json') {
-                this.log(JSON.stringify(functions, null, 2));
+                this.log(JSON.stringify(buildPagingJson(list, { page: flags.page, perPage: flags.per_page, tier: 'envelope' }), null, 2));
             }
             else {
                 // summary format
@@ -153,6 +142,9 @@ Available functions:
                         }
                     }
                 }
+                const footer = formatPagingFooter(list, { noun: 'function', page: flags.page, tier: 'envelope' });
+                if (footer)
+                    this.log(footer);
             }
         }
         catch (error) {

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;
 }