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

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

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../../base-command.js';
+export default class EphemeralStaticHostGet extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    /** Print a one-line summary for a dev/prod env if it has been deployed. */
+    private logEnv;
+}

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

@@ -0,0 +1,101 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../base-command.js';
+export default class EphemeralStaticHostGet extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name',
+            required: true,
+        }),
+    };
+    static description = 'Get a single static host\'s details (name, git config, dev/prod environments) for an ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral static_host get e4f2-9ab1-xyz1 --static-host newsite
+Static Host: newsite
+ID: 5
+Dev: https://newsite-dev-....dev.xano.io (v2)
+`,
+        `$ xano ephemeral static_host get e4f2-9ab1-xyz1 -H newsite -w 40 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        'static-host': Flags.string({
+            char: 'H',
+            description: 'Static host name',
+            required: true,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (optional if set in profile)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(EphemeralStaticHostGet);
+        const { profile, profileName } = this.resolveProfile(flags);
+        const tenantName = args.tenant_name;
+        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 get <tenant_name> --static-host <static_host> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile edit ${profileName} -w <workspace_id>`);
+        }
+        const staticHost = flags['static-host'];
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}`;
+        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, `Failed to get static host '${staticHost}'`);
+                this.error(message);
+            }
+            const host = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(host, null, 2));
+            }
+            else {
+                this.log(`Static Host: ${host.name}`);
+                this.log(`ID: ${host.id}`);
+                if (host.description)
+                    this.log(`Description: ${host.description}`);
+                if (host.git?.repo)
+                    this.log(`Git: ${host.git.repo}`);
+                this.logEnv('Dev', host.dev);
+                this.logEnv('Prod', host.prod);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to get static host: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to get static host: ${String(error)}`);
+            }
+        }
+    }
+    /** Print a one-line summary for a dev/prod env if it has been deployed. */
+    logEnv(label, env) {
+        if (!env?.default_url)
+            return;
+        const modeInfo = env.mode ? ` (${env.mode})` : '';
+        const custom = env.custom_url ? ` [custom: ${env.custom_url}]` : '';
+        this.log(`${label}: ${env.default_url}${modeInfo}${custom}`);
+    }
+}

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

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../../base-command.js';
+export default class EphemeralStaticHostList extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        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>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,152 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../base-command.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
+[
+  {
+    "id": 1,
+    "name": "my-static-host",
+    "domain": "example.com"
+  }
+]
+`,
+        `$ 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,
+        }),
+        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,
+        }),
+        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({
+            page: flags.page.toString(),
+        });
+        // Only add per_page if it's not the default value
+        if (flags.per_page !== 50) {
+            queryParams.append('per_page', flags.per_page.toString());
+        }
+        // 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 data = await response.json();
+            // Handle different response formats
+            let staticHosts;
+            if (Array.isArray(data)) {
+                staticHosts = data;
+            }
+            else if (data && typeof data === 'object' && 'static_hosts' in data && Array.isArray(data.static_hosts)) {
+                staticHosts = data.static_hosts;
+            }
+            else if (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)) {
+                staticHosts = data.items;
+            }
+            else {
+                this.error('Unexpected API response format');
+            }
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(staticHosts, 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}`);
+                        }
+                    }
+                }
+            }
+        }
+        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/tenant/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, channelPathSegments, parseDocument, } from '../../../utils/document-parser.js';
 export default class Pull extends BaseCommand {
     static description = 'Pull a tenant multidoc from the Xano Metadata API and split into individual files';
     static examples = [
@@ -190,6 +190,17 @@ Pulled 58 documents from tenant my-tenant
                 typeDir = path.join(outputDir, 'realtime', 'trigger');
                 baseName = this.sanitizeFilename(doc.name);
             }
+            else if (doc.type === 'channel') {
+                // Realtime v2 — see workspace/pull for the full rationale.
+                // channel "rooms/{room_id}" → channel/rooms/[room_id]/_channel.xs
+                typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.name, snakeCase));
+                baseName = '_channel';
+            }
+            else if (doc.type === 'message' && doc.channel) {
+                // Realtime v2 message → channel/{channel_path}/{message_name}.xs
+                typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.channel, snakeCase));
+                baseName = this.sanitizeFilename(doc.name);
+            }
             else if (doc.type === 'api_group') {
                 // api_group "test" → api/{resolved_folder}/{name}.xs
                 const groupFolder = getApiGroupFolder(doc.name);

package/dist/commands/workspace/git/pull/index.js

@@ -5,7 +5,7 @@ import * as os from 'node:os';
 import * as path from 'node:path';
 import snakeCase from 'lodash.snakecase';
 import BaseCommand, { buildUserAgent } from '../../../../base-command.js';
-import { buildApiGroupFolderResolver, parseDocument } from '../../../../utils/document-parser.js';
+import { buildApiGroupFolderResolver, channelPathSegments, parseDocument, } from '../../../../utils/document-parser.js';
 export default class GitPull extends BaseCommand {
     static description = 'Pull XanoScript files from a git repository into a local directory';
     static examples = [
@@ -373,6 +373,15 @@ export default class GitPull extends BaseCommand {
             typeDir = path.join(outputDir, 'realtime', 'trigger');
             baseName = this.sanitizeFilename(doc.name);
         }
+        else if (doc.type === 'channel') {
+            // Realtime v2 — see workspace/pull for the full rationale.
+            typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.name, snakeCase));
+            baseName = '_channel';
+        }
+        else if (doc.type === 'message' && doc.channel) {
+            typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.channel, snakeCase));
+            baseName = this.sanitizeFilename(doc.name);
+        }
         else if (doc.type === 'api_group') {
             const groupFolder = getApiGroupFolder(doc.name);
             typeDir = path.join(outputDir, 'api', groupFolder);

package/dist/commands/workspace/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, channelPathSegments, parseDocument, } from '../../../utils/document-parser.js';
 import { fetchKnowledge, writeKnowledge } from '../../../utils/knowledge-sync.js';
 export default class Pull extends BaseCommand {
     static description = 'Pull a workspace multidoc from the Xano Metadata API and split into individual files';
@@ -195,6 +195,26 @@ Pulled 58 documents
                 typeDir = path.join(outputDir, 'realtime', 'trigger');
                 baseName = this.sanitizeFilename(doc.name);
             }
+            else if (doc.type === 'channel') {
+                // Realtime v2. The channel owns a directory mirroring its path and its
+                // messages live inside it, so ownership is visible in the tree.
+                //   channel "rooms/{room_id}" → channel/rooms/[room_id]/_channel.xs
+                //
+                // The document uses a FIXED "_channel.xs" leaf: naming it after the
+                // last segment yields "[room_id].xs", which names the parameter rather
+                // than the channel. A fixed leaf also sorts first, making "the channel
+                // vs its messages" obvious.
+                typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.name, snakeCase));
+                baseName = '_channel';
+            }
+            else if (doc.type === 'message' && doc.channel) {
+                // Realtime v2 message → channel/{channel_path}/{message_name}.xs
+                // Nesting matters beyond tidiness: message names are unique only WITHIN
+                // a channel, so a flat message/ directory would collide when two
+                // channels both define e.g. "say".
+                typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.channel, snakeCase));
+                baseName = this.sanitizeFilename(doc.name);
+            }
             else if (doc.type === 'api_group') {
                 // api_group "test" → api/{resolved_folder}/{name}.xs
                 const groupFolder = getApiGroupFolder(doc.name);

package/dist/utils/document-parser.d.ts

@@ -1,6 +1,8 @@
 export interface ParsedDocument {
     apiGroup?: string;
     canonical?: string;
+    /** Owning channel path for realtime v2 `message` documents. */
+    channel?: string;
     content: string;
     guid?: string;
     name: string;
@@ -12,6 +14,30 @@ export interface ParsedDocument {
  * Skips leading comment lines (starting with //) to find the first meaningful line.
  */
 export declare function parseDocument(content: string): null | ParsedDocument;
+/**
+ * Map a realtime v2 channel path onto directory segments.
+ *
+ * A channel name IS a path template — "rooms/{room_id}" — so the directory tree
+ * mirrors it rather than flattening it. That is the whole reason messages nest
+ * under channels: the tree should show the structure, and
+ * "channel/rooms/[room_id]/post.xs" says immediately that `post` lives on a
+ * parameterized rooms channel.
+ *
+ *   "rooms"                    -> ["rooms"]
+ *   "rooms/{room_id}"          -> ["rooms", "[room_id]"]
+ *   "org/{org_id}/room/{id}"   -> ["org", "[org_id]", "room", "[id]"]
+ *
+ * Braces become brackets because "{" and "}" are awkward in shells, while "["
+ * and "]" are legal on every filesystem. They are still glob character classes,
+ * so scripting against a checkout needs the path quoted.
+ *
+ * Escaping the braces rather than dropping them is what keeps a parameterized
+ * channel distinct from a literal one: without it, "rooms/{room_id}" and a
+ * literal channel named "rooms/room_id" collide on the same directory.
+ *
+ * Mirrors Vfs::channelSegment() on the server.
+ */
+export declare function channelPathSegments(name: string, snakeCaseFn: (s: string) => string): string[];
 /**
  * Build a unique key for a document based on its type, name, verb, and api_group.
  * Used to match server GUID map entries back to local files.

package/dist/utils/document-parser.js

@@ -45,6 +45,14 @@ export function parseDocument(content) {
     if (apiGroupMatch) {
         apiGroup = apiGroupMatch[1];
     }
+    // Extract channel if present (e.g., channel = "rooms/{room_id}").
+    // Realtime v2 messages reference their owning channel by PATH, which is what
+    // nests them under it on disk.
+    let channel;
+    const channelMatch = content.match(/^\s*channel\s*=\s*"([^"]*)"/m);
+    if (channelMatch) {
+        channel = channelMatch[1];
+    }
     // Extract canonical if present (e.g., canonical = "abc123")
     let canonical;
     const canonicalMatch = content.match(/canonical\s*=\s*"([^"]*)"/);
@@ -57,7 +65,36 @@ export function parseDocument(content) {
     if (guidMatch) {
         guid = guidMatch[1];
     }
-    return { apiGroup, canonical, content, guid, name, type, verb };
+    return { apiGroup, canonical, channel, content, guid, name, type, verb };
+}
+/**
+ * Map a realtime v2 channel path onto directory segments.
+ *
+ * A channel name IS a path template — "rooms/{room_id}" — so the directory tree
+ * mirrors it rather than flattening it. That is the whole reason messages nest
+ * under channels: the tree should show the structure, and
+ * "channel/rooms/[room_id]/post.xs" says immediately that `post` lives on a
+ * parameterized rooms channel.
+ *
+ *   "rooms"                    -> ["rooms"]
+ *   "rooms/{room_id}"          -> ["rooms", "[room_id]"]
+ *   "org/{org_id}/room/{id}"   -> ["org", "[org_id]", "room", "[id]"]
+ *
+ * Braces become brackets because "{" and "}" are awkward in shells, while "["
+ * and "]" are legal on every filesystem. They are still glob character classes,
+ * so scripting against a checkout needs the path quoted.
+ *
+ * Escaping the braces rather than dropping them is what keeps a parameterized
+ * channel distinct from a literal one: without it, "rooms/{room_id}" and a
+ * literal channel named "rooms/room_id" collide on the same directory.
+ *
+ * Mirrors Vfs::channelSegment() on the server.
+ */
+export function channelPathSegments(name, snakeCaseFn) {
+    // A parameter keeps the author's name verbatim so it matches the `input`
+    // block; only the delimiters are swapped.
+    const isParam = /^\{.*\}$/;
+    return name.split('/').map((segment) => (isParam.test(segment) ? `[${segment.slice(1, -1)}]` : snakeCaseFn(segment)));
 }
 /**
  * Build a unique key for a document based on its type, name, verb, and api_group.