@xano/cli 0.0.21 → 0.0.22

package/dist/base-command.d.ts

@@ -8,6 +8,6 @@ export default abstract class BaseCommand extends Command {
         profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    protected getProfile(): string | undefined;
     protected getDefaultProfile(): string;
+    protected getProfile(): string | undefined;
 }

package/dist/base-command.js

@@ -1,8 +1,8 @@
 import { Command, 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 * as yaml from 'js-yaml';
 export default class BaseCommand extends Command {
     static baseFlags = {
         profile: Flags.string({
@@ -13,18 +13,14 @@ export default class BaseCommand extends Command {
         }),
         verbose: Flags.boolean({
             char: 'v',
+            default: false,
             description: 'Show detailed request/response information',
             env: 'XANO_VERBOSE',
             required: false,
-            default: false,
         }),
     };
     // Override the flags property to include baseFlags
     static flags = BaseCommand.baseFlags;
-    // Helper method to get the profile flag value
-    getProfile() {
-        return this.flags?.profile;
-    }
     // Helper method to get the default profile from credentials file
     getDefaultProfile() {
         try {
@@ -44,4 +40,8 @@ export default class BaseCommand extends Command {
             return 'default';
         }
     }
+    // Helper method to get the profile flag value
+    getProfile() {
+        return this.flags?.profile;
+    }
 }

package/dist/commands/branch/create/index.d.ts

@@ -0,0 +1,17 @@
+import BaseCommand from '../../../base-command.js';
+export default class BranchCreate extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        color: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        label: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        source: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<number | 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;
+}

package/dist/commands/branch/create/index.js

@@ -0,0 +1,164 @@
+import { 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 BranchCreate extends BaseCommand {
+    static description = 'Create a new branch by cloning from an existing branch';
+    static examples = [
+        `$ xano branch create --label dev
+Created branch: dev
+  Cloned from: v1
+`,
+        `$ xano branch create -l feature-auth -s dev -d "Authentication feature"
+Created branch: feature-auth
+  Cloned from: dev
+  Description: Authentication feature
+`,
+        `$ xano branch create --label staging --color "#ebc346" --output json
+{
+  "created_at": "2024-02-11T10:00:00Z",
+  "label": "staging",
+  "backup": false,
+  "live": false
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        color: Flags.string({
+            char: 'c',
+            description: 'Color hex code for the branch (e.g., "#ebc346")',
+            required: false,
+        }),
+        description: Flags.string({
+            char: 'd',
+            description: 'Description for the new branch',
+            required: false,
+        }),
+        label: Flags.string({
+            char: 'l',
+            description: 'Label for the new branch',
+            required: true,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        source: Flags.string({
+            char: 's',
+            default: 'v1',
+            description: 'Source branch to clone from (defaults to "v1")',
+            required: false,
+        }),
+        workspace: Flags.integer({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(BranchCreate);
+        // 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`);
+        }
+        // Get workspace ID from flag or profile
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Either use --workspace flag or set one in your profile.\n' +
+                'Usage: xano branch create --label <label> [--workspace <workspace_id>]');
+        }
+        // Build request body
+        const body = {
+            label: flags.label,
+            source_branch: flags.source,
+        };
+        if (flags.description) {
+            body.description = flags.description;
+        }
+        if (flags.color) {
+            body.color = flags.color;
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/branch`;
+        // Create branch via the API
+        try {
+            const response = await fetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                    'content-type': 'application/json',
+                },
+                method: 'POST',
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const branch = await response.json();
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(branch, null, 2));
+            }
+            else {
+                // summary format
+                this.log(`Created branch: ${branch.label}`);
+                this.log(`  Cloned from: ${flags.source}`);
+                if (flags.description) {
+                    this.log(`  Description: ${flags.description}`);
+                }
+                if (flags.color) {
+                    this.log(`  Color: ${flags.color}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to create branch: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to create branch: ${String(error)}`);
+            }
+        }
+    }
+    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}`);
+        }
+    }
+}

package/dist/commands/branch/delete/index.d.ts

@@ -0,0 +1,18 @@
+import BaseCommand from '../../../base-command.js';
+export default class BranchDelete extends BaseCommand {
+    static args: {
+        branch_label: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<number | 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 confirm;
+    private loadCredentials;
+}

package/dist/commands/branch/delete/index.js

@@ -0,0 +1,156 @@
+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 BranchDelete extends BaseCommand {
+    static args = {
+        branch_label: Args.string({
+            description: 'Branch label to delete (cannot delete "v1" or the live branch)',
+            required: true,
+        }),
+    };
+    static description = 'Delete a branch (cannot delete "v1" or the live branch)';
+    static examples = [
+        `$ xano branch delete feature-old
+Are you sure you want to delete branch 'feature-old'? This action cannot be undone. (y/N) y
+Deleted branch: feature-old
+`,
+        `$ xano branch delete dev --force
+Deleted branch: dev
+`,
+        `$ xano branch delete staging -f -o json
+{
+  "deleted": true,
+  "branch_label": "staging"
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        force: Flags.boolean({
+            char: 'f',
+            default: false,
+            description: 'Skip confirmation prompt',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.integer({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(BranchDelete);
+        // 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`);
+        }
+        // Get workspace ID from flag or profile
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Either use --workspace flag or set one in your profile.\n' +
+                'Usage: xano branch delete <branch_label> [--workspace <workspace_id>]');
+        }
+        const branchLabel = args.branch_label;
+        // Warn about protected branches
+        if (branchLabel === 'v1') {
+            this.error('Cannot delete the "v1" branch. This is the default branch and cannot be removed.');
+        }
+        // Confirmation prompt unless --force is used
+        if (!flags.force) {
+            const confirmed = await this.confirm(`Are you sure you want to delete branch '${branchLabel}'? This action cannot be undone.`);
+            if (!confirmed) {
+                this.log('Deletion cancelled.');
+                return;
+            }
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/branch/${encodeURIComponent(branchLabel)}`;
+        // Delete branch via the API
+        try {
+            const response = await fetch(apiUrl, {
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                },
+                method: 'DELETE',
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify({ branch_label: branchLabel, deleted: true }, null, 2));
+            }
+            else {
+                this.log(`Deleted branch: ${branchLabel}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to delete branch: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to delete branch: ${String(error)}`);
+            }
+        }
+    }
+    async confirm(message) {
+        // Use readline for simple yes/no confirmation
+        const readline = await import('node:readline');
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        return new Promise((resolve) => {
+            rl.question(`${message} (y/N) `, (answer) => {
+                rl.close();
+                resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+            });
+        });
+    }
+    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}`);
+        }
+    }
+}

package/dist/commands/branch/edit/index.d.ts

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../base-command.js';
+export default class BranchEdit extends BaseCommand {
+    static args: {
+        branch_label: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        color: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        label: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<number | 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;
+}

package/dist/commands/branch/edit/index.js

@@ -0,0 +1,166 @@
+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 BranchEdit extends BaseCommand {
+    static args = {
+        branch_label: Args.string({
+            description: 'Branch label to edit (cannot edit "v1" label)',
+            required: true,
+        }),
+    };
+    static description = 'Update an existing branch (cannot update "v1" label)';
+    static examples = [
+        `$ xano branch edit dev --label development
+Updated branch: development
+`,
+        `$ xano branch edit feature-auth -l feature-authentication --color "#ff5733"
+Updated branch: feature-authentication
+  Color: #ff5733
+`,
+        `$ xano branch edit staging --description "Staging environment" -o json
+{
+  "created_at": "2024-02-10T09:15:00Z",
+  "label": "staging",
+  "backup": false
+}
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        color: Flags.string({
+            char: 'c',
+            description: 'New color hex code for the branch (e.g., "#ff5733")',
+            required: false,
+        }),
+        description: Flags.string({
+            char: 'd',
+            description: 'New description for the branch',
+            required: false,
+        }),
+        label: Flags.string({
+            char: 'l',
+            description: 'New label for the branch',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        workspace: Flags.integer({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(BranchEdit);
+        // 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`);
+        }
+        // Get workspace ID from flag or profile
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Either use --workspace flag or set one in your profile.\n' +
+                'Usage: xano branch edit <branch_label> [--workspace <workspace_id>]');
+        }
+        const branchLabel = args.branch_label;
+        // Build request body - only include fields that were specified
+        const body = {};
+        if (flags.label !== undefined) {
+            body.label = flags.label;
+        }
+        if (flags.description !== undefined) {
+            body.description = flags.description;
+        }
+        if (flags.color !== undefined) {
+            body.color = flags.color;
+        }
+        // Check if at least one field is being updated
+        if (Object.keys(body).length === 0) {
+            this.error('No fields specified to update. Use --label, --description, or --color flags.\n' +
+                'Example: xano branch edit dev --label development');
+        }
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/branch/${encodeURIComponent(branchLabel)}`;
+        // Update branch via the API
+        try {
+            const response = await fetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    'accept': 'application/json',
+                    'Authorization': `Bearer ${profile.access_token}`,
+                    'content-type': 'application/json',
+                },
+                method: 'PUT',
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const branch = await response.json();
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(branch, null, 2));
+            }
+            else {
+                // summary format
+                this.log(`Updated branch: ${branch.label}`);
+                if (flags.description) {
+                    this.log(`  Description: ${flags.description}`);
+                }
+                if (flags.color) {
+                    this.log(`  Color: ${flags.color}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to update branch: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to update branch: ${String(error)}`);
+            }
+        }
+    }
+    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}`);
+        }
+    }
+}

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

@@ -0,0 +1,16 @@
+import BaseCommand from '../../../base-command.js';
+export default class BranchGet extends BaseCommand {
+    static args: {
+        branch_label: 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>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<number | 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;
+}