@xano/cli 1.0.6-beta.3 → 1.0.6-beta.5

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, buildChannelServerResolver, channelPathSegments, parseDocument, } from '../../../utils/document-parser.js';
+import { buildApiGroupFolderResolver, buildChannelServerResolver, parseDocument, resolveDocumentPath, } 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';
@@ -141,141 +141,12 @@ Pulled 58 documents
         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 === 'realtime_server') {
-                // Realtime v2. The realtime_server is the top-level container that owns
-                // channels (which own messages). Its own document is named after itself
-                // inside its name directory, mirroring api_group (api/<group>/<group>.xs)
-                // — the server name is a simple segment, so no fixed leaf is needed.
-                //   realtime_server "chat" → realtime/server/chat/chat.xs
-                typeDir = path.join(outputDir, 'realtime', 'server', this.sanitizeFilename(doc.name));
-                baseName = this.sanitizeFilename(doc.name);
-            }
-            else if (doc.type === 'channel') {
-                // Realtime v2. The channel owns a directory named after itself (the full
-                // channel name, snake_cased into a single flat segment — like every other
-                // object), and its messages live in a message/ subfolder inside it. It
-                // nests under its owning realtime_server (from `server = "..."`):
-                //   channel "rooms/{room_id}" (server "chat")
-                //     → realtime/server/chat/channel/rooms_room_id/rooms_room_id.xs
-                //
-                // The channel name is snake_cased as a whole (rooms/{room_id} →
-                // rooms_room_id), so there is no path nesting and no bracket escaping —
-                // the on-disk name is a display form; the .xs content keeps the real
-                // name. A channel with no resolvable server (e.g. a pre-server export)
-                // falls back to the legacy flat channel/<path>/_channel.xs layout.
-                if (doc.server) {
-                    typeDir = path.join(outputDir, 'realtime', 'server', this.sanitizeFilename(doc.server), 'channel', snakeCase(doc.name));
-                    baseName = snakeCase(doc.name);
-                }
-                else {
-                    typeDir = path.join(outputDir, 'channel', ...channelPathSegments(doc.name, snakeCase));
-                    baseName = '_channel';
-                }
-            }
-            else if (doc.type === 'message' && doc.channel) {
-                // Realtime v2 message → nests in a message/ subfolder under its channel,
-                // under that channel's server. The message names only its channel; the
-                // server is resolved by looking that channel up in the same multidoc
-                // (two-pass resolve).
-                //   message "post" on channel "rooms/{room_id}" (server "chat")
-                //     → realtime/server/chat/channel/rooms_room_id/message/post.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". A channel whose server can't be
-                // resolved falls back to the legacy flat channel/ layout.
-                const messageServer = getChannelServer(doc.channel);
-                typeDir = messageServer
-                    ? path.join(outputDir, 'realtime', 'server', this.sanitizeFilename(messageServer), 'channel', snakeCase(doc.channel), 'message')
-                    : 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);
-                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);
@@ -304,12 +175,4 @@ Pulled 58 documents
             parts.push(`${knowledgeCount} knowledge file${knowledgeCount === 1 ? '' : 's'}`);
         this.log(`Pulled ${parts.join(' + ')} to ${flags.directory}`);
     }
-    /**
-     * 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/utils/document-parser.d.ts

@@ -58,6 +58,45 @@ export declare function channelPathSegments(name: string, snakeCaseFn: (s: strin
  * callers fall back accordingly.
  */
 export declare function buildChannelServerResolver(documents: ParsedDocument[]): (channelName: string) => string | undefined;
+/**
+ * Sanitize a document name for use as a single on-disk filename segment.
+ * Strips quotes and snake_cases the rest. Mirrors the per-command
+ * `sanitizeFilename` the pull commands used to each define privately.
+ */
+export declare function sanitizeDocumentName(name: string, snakeCaseFn: (s: string) => string): string;
+/**
+ * The directory + base filename (no extension, no duplicate suffix) a document
+ * is written to on disk. `resolveDocumentPath` returns this; callers append the
+ * `.xs` extension and any `_N` duplicate suffix.
+ */
+export interface DocumentPlacement {
+    baseName: string;
+    typeDir: string;
+}
+/**
+ * Resolve where a parsed document lands on disk — the SINGLE source of truth for
+ * the pull layout, shared by every pull command (workspace, tenant, release,
+ * sandbox, ephemeral). Previously each command inlined a ~130-line copy of this
+ * decision; the copies drifted (the realtime v2 realtime_server/channel/message
+ * branches existed only in workspace/tenant), so an ephemeral pull dumped v2
+ * objects into flat top-level channel/, message/ and realtime_server/ folders —
+ * detaching messages from their channels and risking name collisions (message
+ * names are unique only WITHIN a channel).
+ *
+ * @param doc - the parsed document
+ * @param outputDir - the resolved pull output root
+ * @param deps - injected dependencies
+ * @param deps.getApiGroupFolder - resolves an api_group name to its unique folder
+ * @param deps.getChannelServer - resolves a v2 channel path to its owning realtime_server
+ * @param deps.join - the path.join implementation (injectable for testing)
+ * @param deps.snakeCase - the snakeCase implementation the caller uses
+ */
+export declare function resolveDocumentPath(doc: ParsedDocument, outputDir: string, deps: {
+    getApiGroupFolder: (groupName: string) => string;
+    getChannelServer: (channelName: string) => string | undefined;
+    join: (...parts: string[]) => string;
+    snakeCase: (s: string) => string;
+}): DocumentPlacement;
 /**
  * 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

@@ -133,6 +133,145 @@ export function buildChannelServerResolver(documents) {
     }
     return (channelName) => channelToServer.get(channelName);
 }
+/**
+ * Sanitize a document name for use as a single on-disk filename segment.
+ * Strips quotes and snake_cases the rest. Mirrors the per-command
+ * `sanitizeFilename` the pull commands used to each define privately.
+ */
+export function sanitizeDocumentName(name, snakeCaseFn) {
+    return snakeCaseFn(name.replaceAll('"', ''));
+}
+/**
+ * Resolve where a parsed document lands on disk — the SINGLE source of truth for
+ * the pull layout, shared by every pull command (workspace, tenant, release,
+ * sandbox, ephemeral). Previously each command inlined a ~130-line copy of this
+ * decision; the copies drifted (the realtime v2 realtime_server/channel/message
+ * branches existed only in workspace/tenant), so an ephemeral pull dumped v2
+ * objects into flat top-level channel/, message/ and realtime_server/ folders —
+ * detaching messages from their channels and risking name collisions (message
+ * names are unique only WITHIN a channel).
+ *
+ * @param doc - the parsed document
+ * @param outputDir - the resolved pull output root
+ * @param deps - injected dependencies
+ * @param deps.getApiGroupFolder - resolves an api_group name to its unique folder
+ * @param deps.getChannelServer - resolves a v2 channel path to its owning realtime_server
+ * @param deps.join - the path.join implementation (injectable for testing)
+ * @param deps.snakeCase - the snakeCase implementation the caller uses
+ */
+export function resolveDocumentPath(doc, outputDir, deps) {
+    const { getApiGroupFolder, getChannelServer, join, snakeCase } = deps;
+    const sanitize = (name) => sanitizeDocumentName(name, snakeCase);
+    if (doc.type === 'workspace') {
+        // workspace → workspace/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'workspace') };
+    }
+    if (doc.type === 'workspace_trigger' || doc.type === 'error_trigger') {
+        // workspace_trigger / error_trigger → workspace/trigger/{name}.xs
+        // (error_trigger is a singleton, colocated with workspace triggers)
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'workspace', 'trigger') };
+    }
+    if (doc.type === 'agent') {
+        // agent → ai/agent/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'agent') };
+    }
+    if (doc.type === 'mcp_server') {
+        // mcp_server → ai/mcp_server/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'mcp_server') };
+    }
+    if (doc.type === 'tool') {
+        // tool → ai/tool/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'tool') };
+    }
+    if (doc.type === 'agent_trigger') {
+        // agent_trigger → ai/agent/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'agent', 'trigger') };
+    }
+    if (doc.type === 'mcp_server_trigger') {
+        // mcp_server_trigger → ai/mcp_server/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'mcp_server', 'trigger') };
+    }
+    if (doc.type === 'table_trigger') {
+        // table_trigger → table/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'table', 'trigger') };
+    }
+    if (doc.type === 'realtime_channel') {
+        // Realtime v1: realtime_channel → realtime/channel/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'realtime', 'channel') };
+    }
+    if (doc.type === 'realtime_trigger') {
+        // Realtime v1: realtime_trigger → realtime/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'realtime', 'trigger') };
+    }
+    if (doc.type === 'realtime_server') {
+        // Realtime v2. The realtime_server is the top-level container that owns
+        // channels (which own messages). Its own document is named after itself
+        // inside its name directory, mirroring api_group (api/<group>/<group>.xs).
+        //   realtime_server "chat" → realtime/server/chat/chat.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'realtime', 'server', sanitize(doc.name)) };
+    }
+    if (doc.type === 'channel') {
+        // Realtime v2. The channel owns a directory named after itself (the full
+        // channel name, snake_cased into a single flat segment), and its messages
+        // live in a message/ subfolder inside it. It nests under its owning
+        // realtime_server (from `realtime_server = "..."`):
+        //   channel "rooms/{room_id}" (server "chat")
+        //     → realtime/server/chat/channel/rooms_room_id/rooms_room_id.xs
+        //
+        // A channel with no resolvable server (e.g. a pre-server export) falls back
+        // to the legacy flat channel/<path>/_channel.xs layout.
+        if (doc.server) {
+            return {
+                baseName: snakeCase(doc.name),
+                typeDir: join(outputDir, 'realtime', 'server', sanitize(doc.server), 'channel', snakeCase(doc.name)),
+            };
+        }
+        return { baseName: '_channel', typeDir: join(outputDir, 'channel', ...channelPathSegments(doc.name, snakeCase)) };
+    }
+    if (doc.type === 'message' && doc.channel) {
+        // Realtime v2 message → nests in a message/ subfolder under its channel,
+        // under that channel's server (resolved via the two-pass channel→server map).
+        //   message "post" on channel "rooms/{room_id}" (server "chat")
+        //     → realtime/server/chat/channel/rooms_room_id/message/post.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". A channel whose server can't be resolved falls
+        // back to the legacy flat channel/ layout.
+        const messageServer = getChannelServer(doc.channel);
+        return {
+            baseName: sanitize(doc.name),
+            typeDir: messageServer
+                ? join(outputDir, 'realtime', 'server', sanitize(messageServer), 'channel', snakeCase(doc.channel), 'message')
+                : join(outputDir, 'channel', ...channelPathSegments(doc.channel, snakeCase)),
+        };
+    }
+    if (doc.type === 'api_group') {
+        // api_group "test" → api/{resolved_folder}/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'api', getApiGroupFolder(doc.name)) };
+    }
+    if (doc.type === 'query' && doc.apiGroup) {
+        // query in group "test" → api/{resolved_folder}/{folders}/{query_name}[_verb].xs
+        const groupFolder = getApiGroupFolder(doc.apiGroup);
+        const nameParts = doc.name.split('/');
+        const leafName = nameParts.pop();
+        const folderParts = nameParts.map((part) => snakeCase(part));
+        const baseName = sanitize(leafName);
+        return {
+            baseName: doc.verb ? `${baseName}_${doc.verb}` : baseName,
+            typeDir: join(outputDir, 'api', groupFolder, ...folderParts),
+        };
+    }
+    // Default: split folder path from name
+    const nameParts = doc.name.split('/');
+    const leafName = nameParts.pop();
+    const folderParts = nameParts.map((part) => snakeCase(part));
+    const baseName = sanitize(leafName);
+    return {
+        baseName: doc.verb ? `${baseName}_${doc.verb}` : baseName,
+        typeDir: join(outputDir, doc.type, ...folderParts),
+    };
+}
 /**
  * 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.