@xano/cli 0.0.37 → 0.0.39

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

@@ -1,10 +1,7 @@
 import BaseCommand from '../../../base-command.js';
 export default class ReleaseGet extends BaseCommand {
     static args: {
-        release_id: import("@oclif/core/interfaces").Arg<number, {
-            max?: number;
-            min?: number;
-        }>;
+        release_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
     static description: string;
     static examples: string[];
@@ -16,4 +13,5 @@ export default class ReleaseGet extends BaseCommand {
     };
     run(): Promise<void>;
     private loadCredentials;
+    private resolveReleaseName;
 }

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

@@ -6,20 +6,20 @@ import * as path from 'node:path';
 import BaseCommand from '../../../base-command.js';
 export default class ReleaseGet extends BaseCommand {
     static args = {
-        release_id: Args.integer({
-            description: 'Release ID to retrieve',
+        release_name: Args.string({
+            description: 'Release name to retrieve',
             required: true,
         }),
     };
     static description = 'Get details of a specific release';
     static examples = [
-        `$ xano release get 10
+        `$ xano release get v1.0
 Release: v1.0 - ID: 10
   Branch: main
   Description: Initial release
   Hotfix: false
 `,
-        `$ xano release get 10 -w 5 -o json`,
+        `$ xano release get v1.0 -w 5 -o json`,
     ];
     static flags = {
         ...BaseCommand.baseFlags,
@@ -55,7 +55,7 @@ Release: v1.0 - ID: 10
         if (!workspaceId) {
             this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
         }
-        const releaseId = args.release_id;
+        const releaseId = await this.resolveReleaseName(profile, workspaceId, args.release_name, flags.verbose);
         const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/release/${releaseId}`;
         try {
             const response = await this.verboseFetch(apiUrl, {
@@ -120,4 +120,30 @@ Release: v1.0 - ID: 10
             this.error(`Failed to parse credentials file: ${error}`);
         }
     }
+    async resolveReleaseName(profile, workspaceId, releaseName, verbose) {
+        const listUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/release`;
+        const response = await this.verboseFetch(listUrl, {
+            headers: {
+                'accept': 'application/json',
+                'Authorization': `Bearer ${profile.access_token}`,
+            },
+            method: 'GET',
+        }, verbose, profile.access_token);
+        if (!response.ok) {
+            const errorText = await response.text();
+            this.error(`Failed to list releases: ${response.status} ${response.statusText}\n${errorText}`);
+        }
+        const data = await response.json();
+        const releases = Array.isArray(data)
+            ? data
+            : (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items))
+                ? data.items
+                : [];
+        const match = releases.find(r => r.name === releaseName);
+        if (!match) {
+            const available = releases.map(r => r.name).join(', ');
+            this.error(`Release '${releaseName}' not found.${available ? ` Available releases: ${available}` : ''}`);
+        }
+        return match.id;
+    }
 }

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

@@ -0,0 +1,31 @@
+import BaseCommand from '../../../base-command.js';
+export default class ReleasePull extends BaseCommand {
+    static args: {
+        directory: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        release: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: 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>;
+    private loadCredentials;
+    /**
+     * Parse a single document to extract its type, name, and optional verb.
+     * Skips leading comment lines (starting with //) to find the first
+     * meaningful line containing the type keyword and name.
+     */
+    private parseDocument;
+    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

@@ -0,0 +1,345 @@
+import { Args, Flags } from '@oclif/core';
+import * as yaml from 'js-yaml';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import snakeCase from 'lodash.snakecase';
+import BaseCommand from '../../../base-command.js';
+export default class ReleasePull extends BaseCommand {
+    static args = {
+        directory: Args.string({
+            description: 'Output directory for pulled documents',
+            required: true,
+        }),
+    };
+    static description = 'Pull a release multidoc from the Xano Metadata API and split into individual files';
+    static examples = [
+        `$ xano release pull ./my-release -r v1.0
+Pulled 42 documents from release 'v1.0' to ./my-release
+`,
+        `$ xano release pull ./output -r v1.0 -w 40
+Pulled 15 documents from release 'v1.0' to ./output
+`,
+        `$ xano release pull ./backup -r v1.0 --profile production --env --records
+Pulled 58 documents from release 'v1.0' to ./backup
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        env: Flags.boolean({
+            default: false,
+            description: 'Include environment variables',
+            required: false,
+        }),
+        records: Flags.boolean({
+            default: false,
+            description: 'Include records',
+            required: false,
+        }),
+        release: Flags.string({
+            char: 'r',
+            description: 'Release name to pull from',
+            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(ReleasePull);
+        // Get profile name (default or from flag/env)
+        const profileName = flags.profile || this.getDefaultProfile();
+        // Load credentials
+        const credentials = this.loadCredentials();
+        // Get the profile configuration
+        if (!(profileName in credentials.profiles)) {
+            this.error(`Profile '${profileName}' not found. Available profiles: ${Object.keys(credentials.profiles).join(', ')}\n` +
+                `Create a profile using 'xano profile:create'`);
+        }
+        const profile = credentials.profiles[profileName];
+        // Validate required fields
+        if (!profile.instance_origin) {
+            this.error(`Profile '${profileName}' is missing instance_origin`);
+        }
+        if (!profile.access_token) {
+            this.error(`Profile '${profileName}' is missing access_token`);
+        }
+        // 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 release pull <directory> -r <release_name> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        const releaseName = flags.release;
+        const releaseId = await this.resolveReleaseName(profile, workspaceId, releaseName, flags.verbose);
+        // Build query parameters
+        const queryParams = new URLSearchParams({
+            env: flags.env.toString(),
+            records: flags.records.toString(),
+        });
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/release/${releaseId}/multidoc?${queryParams.toString()}`;
+        // Fetch multidoc from the API
+        let responseText;
+        const requestHeaders = {
+            accept: 'application/json',
+            Authorization: `Bearer ${profile.access_token}`,
+        };
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: requestHeaders,
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            responseText = await response.text();
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to fetch multidoc: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch multidoc: ${String(error)}`);
+            }
+        }
+        // Split the response into individual documents
+        const rawDocuments = responseText.split('\n---\n');
+        // Parse each document
+        const documents = [];
+        for (const raw of rawDocuments) {
+            const trimmed = raw.trim();
+            if (!trimmed) {
+                continue;
+            }
+            const parsed = this.parseDocument(trimmed);
+            if (parsed) {
+                documents.push(parsed);
+            }
+        }
+        if (documents.length === 0) {
+            this.log('No documents found in response');
+            return;
+        }
+        // Resolve the output directory
+        const outputDir = path.resolve(args.directory);
+        // Create the output directory if it doesn't exist
+        fs.mkdirSync(outputDir, { recursive: true });
+        // 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 === '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/test/api_group.xs
+                const groupFolder = snakeCase(doc.name);
+                typeDir = path.join(outputDir, 'api', groupFolder);
+                baseName = 'api_group';
+            }
+            else if (doc.type === 'query' && doc.apiGroup) {
+                // query in group "test" → api/test/{query_name}.xs
+                const groupFolder = snakeCase(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}`;
+                }
+            }
+            fs.mkdirSync(typeDir, { recursive: true });
+            // Track duplicates per directory
+            const dirKey = path.relative(outputDir, typeDir);
+            if (!filenameCounters.has(dirKey)) {
+                filenameCounters.set(dirKey, new Map());
+            }
+            const typeCounters = filenameCounters.get(dirKey);
+            const count = typeCounters.get(baseName) || 0;
+            typeCounters.set(baseName, count + 1);
+            // Append numeric suffix for duplicates
+            let filename;
+            filename = count === 0 ? `${baseName}.xs` : `${baseName}_${count + 1}.xs`;
+            const filePath = path.join(typeDir, filename);
+            fs.writeFileSync(filePath, doc.content, 'utf8');
+            writtenCount++;
+        }
+        this.log(`Pulled ${writtenCount} documents from release '${releaseName}' to ${args.directory}`);
+    }
+    loadCredentials() {
+        const configDir = path.join(os.homedir(), '.xano');
+        const credentialsPath = path.join(configDir, 'credentials.yaml');
+        // Check if credentials file exists
+        if (!fs.existsSync(credentialsPath)) {
+            this.error(`Credentials file not found at ${credentialsPath}\n` + `Create a profile using 'xano profile:create'`);
+        }
+        // Read credentials file
+        try {
+            const fileContent = fs.readFileSync(credentialsPath, 'utf8');
+            const parsed = yaml.load(fileContent);
+            if (!parsed || typeof parsed !== 'object' || !('profiles' in parsed)) {
+                this.error('Credentials file has invalid format.');
+            }
+            return parsed;
+        }
+        catch (error) {
+            this.error(`Failed to parse credentials file: ${error}`);
+        }
+    }
+    /**
+     * Parse a single document to extract its type, name, and optional verb.
+     * Skips leading comment lines (starting with //) to find the first
+     * meaningful line containing the type keyword and name.
+     */
+    parseDocument(content) {
+        const lines = content.split('\n');
+        // Find the first non-comment line
+        let firstLine = null;
+        for (const line of lines) {
+            const trimmedLine = line.trim();
+            if (trimmedLine && !trimmedLine.startsWith('//')) {
+                firstLine = trimmedLine;
+                break;
+            }
+        }
+        if (!firstLine) {
+            return null;
+        }
+        // Parse the type keyword and name from the first meaningful line
+        // Expected formats:
+        //   type name {
+        //   type name verb=GET {
+        //   type "name with spaces" {
+        //   type "name with spaces" verb=PATCH {
+        const match = firstLine.match(/^(\w+)\s+("(?:[^"\\]|\\.)*"|\S+)(?:\s+(.*))?/);
+        if (!match) {
+            return null;
+        }
+        const type = match[1];
+        let name = match[2];
+        const rest = match[3] || '';
+        // Strip surrounding quotes from the name
+        if (name.startsWith('"') && name.endsWith('"')) {
+            name = name.slice(1, -1);
+        }
+        // Extract verb if present (e.g., verb=GET)
+        let verb;
+        const verbMatch = rest.match(/verb=(\S+)/);
+        if (verbMatch) {
+            verb = verbMatch[1];
+        }
+        // Extract api_group if present (e.g., api_group = "test")
+        let apiGroup;
+        const apiGroupMatch = content.match(/api_group\s*=\s*"([^"]*)"/);
+        if (apiGroupMatch) {
+            apiGroup = apiGroupMatch[1];
+        }
+        return { apiGroup, content, name, type, verb };
+    }
+    async resolveReleaseName(profile, workspaceId, releaseName, verbose) {
+        const listUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/release`;
+        const response = await this.verboseFetch(listUrl, {
+            headers: {
+                'accept': 'application/json',
+                'Authorization': `Bearer ${profile.access_token}`,
+            },
+            method: 'GET',
+        }, verbose, profile.access_token);
+        if (!response.ok) {
+            const errorText = await response.text();
+            this.error(`Failed to list releases: ${response.status} ${response.statusText}\n${errorText}`);
+        }
+        const data = await response.json();
+        const releases = Array.isArray(data)
+            ? data
+            : (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items))
+                ? data.items
+                : [];
+        const match = releases.find(r => r.name === releaseName);
+        if (!match) {
+            const available = releases.map(r => r.name).join(', ');
+            this.error(`Release '${releaseName}' not found.${available ? ` Available releases: ${available}` : ''}`);
+        }
+        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/release/push/index.d.ts

@@ -0,0 +1,26 @@
+import BaseCommand from '../../../base-command.js';
+export default class ReleasePush extends BaseCommand {
+    static args: {
+        directory: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        description: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        hotfix: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        workspace: 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>;
+    /**
+     * Recursively collect all .xs files from a directory, sorted by
+     * type subdirectory name then filename for deterministic ordering.
+     */
+    private collectFiles;
+    private loadCredentials;
+}