@xano/cli 0.0.37 → 0.0.40

package/dist/commands/tenant/license/set/index.js

@@ -0,0 +1,141 @@
+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 BaseCommand from '../../../../base-command.js';
+export default class TenantLicenseSet extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Tenant name',
+            required: true,
+        }),
+    };
+    static description = 'Set/update the license for a tenant';
+    static examples = [
+        `$ xano tenant license set my-tenant
+Reads from license_my-tenant.yaml
+`,
+        `$ xano tenant license set my-tenant --file ./license.yaml`,
+        `$ xano tenant license set my-tenant --value 'key: value'`,
+        `$ xano tenant license set my-tenant -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        clean: Flags.boolean({
+            default: false,
+            description: 'Remove the source file after successful upload',
+            exclusive: ['value'],
+            required: false,
+        }),
+        file: Flags.string({
+            char: 'f',
+            description: 'Path to license file (default: license_<tenant_name>.yaml)',
+            exclusive: ['value'],
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        value: Flags.string({
+            description: 'Inline license value',
+            exclusive: ['file', 'clean'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(TenantLicenseSet);
+        const tenantName = args.tenant_name;
+        let licenseValue;
+        let sourceFilePath;
+        if (flags.value) {
+            licenseValue = flags.value;
+        }
+        else {
+            sourceFilePath = path.resolve(flags.file || `license_${tenantName}.yaml`);
+            if (!fs.existsSync(sourceFilePath)) {
+                this.error(`File not found: ${sourceFilePath}`);
+            }
+            licenseValue = fs.readFileSync(sourceFilePath, 'utf8');
+        }
+        const profileName = flags.profile || this.getDefaultProfile();
+        const credentials = this.loadCredentials();
+        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];
+        if (!profile.instance_origin) {
+            this.error(`Profile '${profileName}' is missing instance_origin`);
+        }
+        if (!profile.access_token) {
+            this.error(`Profile '${profileName}' is missing access_token`);
+        }
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/license`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                body: JSON.stringify({ value: licenseValue }),
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'application/json',
+                },
+                method: 'POST',
+            }, 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 result = await response.json();
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(result, null, 2));
+            }
+            else {
+                this.log(`Tenant license updated successfully for ${tenantName}`);
+            }
+            if (flags.clean && sourceFilePath && fs.existsSync(sourceFilePath)) {
+                fs.unlinkSync(sourceFilePath);
+                this.log(`Removed ${sourceFilePath}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to set tenant license: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to set tenant license: ${String(error)}`);
+            }
+        }
+    }
+    loadCredentials() {
+        const configDir = path.join(os.homedir(), '.xano');
+        const credentialsPath = path.join(configDir, 'credentials.yaml');
+        if (!fs.existsSync(credentialsPath)) {
+            this.error(`Credentials file not found at ${credentialsPath}\n` + `Create a profile using 'xano profile create'`);
+        }
+        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}`);
+        }
+    }
+}

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

@@ -52,8 +52,8 @@ Tenants in workspace 5:
         try {
             const response = await this.verboseFetch(apiUrl, {
                 headers: {
-                    'accept': 'application/json',
-                    'Authorization': `Bearer ${profile.access_token}`,
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
                 },
                 method: 'GET',
             }, flags.verbose, profile.access_token);
@@ -61,7 +61,7 @@ Tenants in workspace 5:
                 const errorText = await response.text();
                 this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
             }
-            const data = await response.json();
+            const data = (await response.json());
             let tenants;
             if (Array.isArray(data)) {
                 tenants = data;
@@ -87,7 +87,8 @@ Tenants in workspace 5:
                     for (const tenant of tenants) {
                         const state = tenant.state ? ` [${tenant.state}]` : '';
                         const license = tenant.license ? ` - ${tenant.license}` : '';
-                        this.log(`  - ${tenant.display || tenant.name} (${tenant.name})${state}${license}`);
+                        const ephemeral = tenant.ephemeral ? ' [ephemeral]' : '';
+                        this.log(`  - ${tenant.display || tenant.name} (${tenant.name})${state}${license}${ephemeral}`);
                     }
                 }
             }
@@ -105,8 +106,7 @@ Tenants in workspace 5:
         const configDir = path.join(os.homedir(), '.xano');
         const credentialsPath = path.join(configDir, 'credentials.yaml');
         if (!fs.existsSync(credentialsPath)) {
-            this.error(`Credentials file not found at ${credentialsPath}\n` +
-                `Create a profile using 'xano profile create'`);
+            this.error(`Credentials file not found at ${credentialsPath}\n` + `Create a profile using 'xano profile create'`);
         }
         try {
             const fileContent = fs.readFileSync(credentialsPath, 'utf8');

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

@@ -0,0 +1,31 @@
+import BaseCommand from '../../../base-command.js';
+export default class Pull extends BaseCommand {
+    static args: {
+        directory: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        draft: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        tenant: 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;
+    /**
+     * 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/tenant/pull/index.js

@@ -0,0 +1,327 @@
+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 Pull extends BaseCommand {
+    static args = {
+        directory: Args.string({
+            description: 'Output directory for pulled documents',
+            required: true,
+        }),
+    };
+    static description = 'Pull a tenant multidoc from the Xano Metadata API and split into individual files';
+    static examples = [
+        `$ xano tenant pull ./my-tenant -t my-tenant
+Pulled 42 documents from tenant my-tenant to ./my-tenant
+`,
+        `$ xano tenant pull ./output -t my-tenant -w 40
+Pulled 15 documents from tenant my-tenant to ./output
+`,
+        `$ xano tenant pull ./backup -t my-tenant --profile production --env --records
+Pulled 58 documents from tenant my-tenant to ./backup
+`,
+        `$ xano tenant pull ./my-tenant -t my-tenant --draft
+Pulled 42 documents from tenant my-tenant to ./my-tenant
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        draft: Flags.boolean({
+            default: false,
+            description: 'Include draft versions',
+            required: false,
+        }),
+        env: Flags.boolean({
+            default: false,
+            description: 'Include environment variables',
+            required: false,
+        }),
+        records: Flags.boolean({
+            default: false,
+            description: 'Include records',
+            required: false,
+        }),
+        tenant: Flags.string({
+            char: 't',
+            description: 'Tenant 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(Pull);
+        // 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 tenant pull <directory> -t <tenant_name> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        const tenantName = flags.tenant;
+        // Build query parameters
+        const queryParams = new URLSearchParams({
+            env: flags.env.toString(),
+            include_draft: flags.draft.toString(),
+            records: flags.records.toString(),
+        });
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/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 tenant ${tenantName} 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 };
+    }
+    /**
+     * 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/tenant/push/index.d.ts

@@ -0,0 +1,24 @@
+import BaseCommand from '../../../base-command.js';
+export default class Push 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>;
+        tenant: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        truncate: 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;
+}