@xano/cli 1.0.6-beta.19 → 1.0.6-beta.20

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

@@ -0,0 +1,103 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestEdit extends BaseCommand {
+    static args = {
+        id: Args.integer({
+            description: 'Tenant deploy request ID',
+            required: true,
+        }),
+    };
+    static description = "Edit a tenant deploy request's title, description or reviewers. The author or an existing reviewer may do this.";
+    static examples = [
+        `$ xano tenant_deploy_request edit 12 --title "Deploy v1.2.1 to prod"
+Updated deploy request #12: "Deploy v1.2.1 to prod" [pending]
+`,
+        `$ xano tenant_deploy_request edit 12 --reviewers 12,45,67 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        description: Flags.string({
+            char: 'd',
+            description: 'New description',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        reviewers: Flags.string({
+            description: 'Replacement comma-separated user IDs to request review from',
+            required: false,
+        }),
+        title: Flags.string({
+            description: 'New title',
+            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(TenantDeployRequestEdit);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/approval_request/${args.id}`;
+        try {
+            const getResponse = await this.verboseFetch(baseUrl, {
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!getResponse.ok) {
+                const message = await this.parseApiError(getResponse, 'Failed to fetch tenant deploy request');
+                this.error(message);
+            }
+            const current = (await getResponse.json());
+            const body = {
+                description: flags.description !== undefined ? flags.description : (current.description ?? ''),
+                reviewer_ids: flags.reviewers
+                    ? flags.reviewers.split(',').map((id) => Number.parseInt(id.trim(), 10))
+                    : (current.reviewers ?? []).map((r) => r.id),
+                title: flags.title !== undefined ? flags.title : current.title,
+            };
+            const putResponse = await this.verboseFetch(baseUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'application/json',
+                },
+                method: 'PUT',
+            }, flags.verbose, profile.access_token);
+            if (!putResponse.ok) {
+                const message = await this.parseApiError(putResponse, 'Failed to edit tenant deploy request');
+                this.error(message);
+            }
+            const item = (await putResponse.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(item, null, 2));
+            }
+            else {
+                this.log(`Updated deploy request #${item.id}: "${item.title}" [${item.status}]`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to edit tenant deploy request: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to edit tenant deploy request: ${String(error)}`);
+            }
+        }
+    }
+}

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

@@ -0,0 +1,19 @@
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestGet extends BaseCommand {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    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<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,75 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestGet extends BaseCommand {
+    static args = {
+        id: Args.integer({
+            description: 'Tenant deploy request ID',
+            required: true,
+        }),
+    };
+    static description = 'Get details of a specific tenant deploy request';
+    static examples = [
+        `$ xano tenant_deploy_request get 12
+Deploy request #12: "Deploy v1.2 to prod" [pending]
+`,
+        `$ xano tenant_deploy_request get 12 -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            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(TenantDeployRequestGet);
+        const { profile } = this.resolveProfile(flags);
+        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}/approval_request/${args.id}`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const message = await this.parseApiError(response, 'Failed to get tenant deploy request');
+                this.error(message);
+            }
+            const item = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(item, null, 2));
+            }
+            else {
+                this.log(`Deploy request #${item.id}: "${item.title}" [${item.status}]`);
+                if (item.description)
+                    this.log(`  Description: ${item.description}`);
+                if (item.reviewers?.length)
+                    this.log(`  Reviewers: ${item.reviewers.map((r) => r.id).join(', ')}`);
+                if (item.can_review !== undefined)
+                    this.log(`  Can review: ${item.can_review}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to get tenant deploy request: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to get tenant deploy request: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/tenant_deploy_request/list/index.d.ts

@@ -0,0 +1,20 @@
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestList extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        mine: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        'per-page': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        release: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        status: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        tenant: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'to-review': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,122 @@
+import { Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestList extends BaseCommand {
+    static description = 'List tenant deploy requests (deployment approval requests) in a workspace';
+    static examples = [
+        `$ xano tenant_deploy_request list
+Deploy requests in workspace 5:
+  - #12 "Deploy v1.2 to prod" [pending] -> prod / v1.2
+`,
+        `$ xano tenant_deploy_request list --tenant prod --status pending`,
+        `$ xano tenant_deploy_request list --tenant prod --release v1.2`,
+        `$ xano tenant_deploy_request list --to-review -o json`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        mine: Flags.boolean({
+            default: false,
+            description: 'Only requests you authored',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        page: Flags.integer({
+            default: 1,
+            description: 'Page number',
+            required: false,
+        }),
+        'per-page': Flags.integer({
+            default: 25,
+            description: 'Items per page',
+            required: false,
+        }),
+        release: Flags.string({
+            char: 'r',
+            description: 'Filter to requests targeting this release. Applied client-side (the API has no release filter), after --page/--per-page, so a narrow page size can hide matches on other pages.',
+            required: false,
+        }),
+        status: Flags.string({
+            description: 'Filter by status',
+            options: ['draft', 'pending', 'changes_requested', 'approved', 'closed'],
+            required: false,
+        }),
+        tenant: Flags.string({
+            description: 'Filter to requests targeting this tenant',
+            required: false,
+        }),
+        'to-review': Flags.boolean({
+            default: false,
+            description: 'Only requests you are able to review',
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(TenantDeployRequestList);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const params = new URLSearchParams();
+        if (flags.status)
+            params.set('status', flags.status);
+        if (flags.tenant)
+            params.set('tenant_name', flags.tenant);
+        if (flags.mine)
+            params.set('mine', 'true');
+        if (flags['to-review'])
+            params.set('to_review', 'true');
+        params.set('page', String(flags.page));
+        params.set('per_page', String(flags['per-page']));
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/approval_request?${params}`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const message = await this.parseApiError(response, 'Failed to list tenant deploy requests');
+                this.error(message);
+            }
+            const data = (await response.json());
+            const allItems = Array.isArray(data) ? data : (data.items ?? []);
+            const items = flags.release ? allItems.filter((item) => item._release?.name === flags.release) : allItems;
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(items, null, 2));
+            }
+            else if (items.length === 0) {
+                this.log('No tenant deploy requests found');
+            }
+            else {
+                this.log(`Deploy requests in workspace ${workspaceId}:`);
+                for (const item of items) {
+                    const review = item.can_review ? ' (reviewable)' : '';
+                    const tenantName = item._tenant?.name ?? '?';
+                    const releaseName = item._release?.name ?? '?';
+                    this.log(`  - #${item.id} "${item.title}" [${item.status}]${review} -> ${tenantName} / ${releaseName}`);
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to list tenant deploy requests: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to list tenant deploy requests: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/tenant_deploy_request/revision/index.d.ts

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

package/dist/commands/tenant_deploy_request/revision/index.js

@@ -0,0 +1,83 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestRevision extends BaseCommand {
+    static args = {
+        id: Args.integer({
+            description: 'Tenant deploy request ID',
+            required: true,
+        }),
+    };
+    static description = 'Link a newer release candidate to an existing tenant deploy request after changes were requested. The previous candidate is kept in the revision history and the request returns to pending. Author only.';
+    static examples = [
+        `$ xano tenant_deploy_request revision 12 --release v1.2.1 --note "Added the missing migration"
+Deploy request #12 is now: pending
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        note: Flags.string({
+            description: 'Note describing what changed in this revision',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        release: Flags.string({
+            char: 'r',
+            description: 'Name of the new release to review',
+            required: true,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(TenantDeployRequestRevision);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        const body = {
+            note: flags.note ?? '',
+            release_name: flags.release,
+        };
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/approval_request/${args.id}/revision`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'application/json',
+                },
+                method: 'POST',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const message = await this.parseApiError(response, 'Failed to add revision to tenant deploy request');
+                this.error(message);
+            }
+            const item = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(item, null, 2));
+            }
+            else {
+                this.log(`Deploy request #${item.id} is now: ${item.status}`);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to add revision to tenant deploy request: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to add revision to tenant deploy request: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/tenant_deploy_request/set_status/index.d.ts

@@ -0,0 +1,21 @@
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestSetStatus extends BaseCommand {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        reason: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        status: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/tenant_deploy_request/set_status/index.js

@@ -0,0 +1,112 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+export default class TenantDeployRequestSetStatus extends BaseCommand {
+    static args = {
+        id: Args.integer({
+            description: 'Tenant deploy request ID',
+            required: true,
+        }),
+    };
+    static description = "[CRITICAL] STOP and confirm with the user before running --status approve; if this is the vote that completes the tenant's required reviewer count, it deploys the release to the tenant immediately as part of approving. Change a tenant deploy request's status (draft, submit, approve, request_changes, close, or reopen).";
+    static examples = [
+        `$ xano tenant_deploy_request set_status 12 --status submit
+Deploy request #12 is now: pending
+`,
+        `$ xano tenant_deploy_request set_status 12 --status approve
+Vote recorded on deploy request #12: 1/2 required reviewers.
+`,
+        `$ xano tenant_deploy_request set_status 12 --status approve
+Deploy request #12 is now: approved (2/2 required reviewers)
+Deployed to tenant as part of this approval.
+`,
+        `$ xano tenant_deploy_request set_status 12 --status request_changes --reason "Needs a migration note"`,
+        `$ xano tenant_deploy_request set_status 12 --status close --reason "Superseded by #14"`,
+        `$ xano tenant_deploy_request set_status 12 --status reopen`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        reason: Flags.string({
+            description: 'Reason for this status change. Required for request_changes and close.',
+            required: false,
+        }),
+        status: Flags.string({
+            description: 'The status transition to apply',
+            options: ['draft', 'submit', 'approve', 'request_changes', 'close', 'reopen'],
+            required: true,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (uses profile workspace if not provided)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(TenantDeployRequestSetStatus);
+        const { profile } = this.resolveProfile(flags);
+        const workspaceId = flags.workspace || profile.workspace;
+        if (!workspaceId) {
+            this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
+        }
+        if ((flags.status === 'request_changes' || flags.status === 'close') && !flags.reason) {
+            this.error(`--reason is required when --status is "${flags.status}"`);
+        }
+        const body = {
+            action: flags.status,
+            reason: flags.reason ?? '',
+        };
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/approval_request/${args.id}/status`;
+        try {
+            const response = await this.verboseFetch(apiUrl, {
+                body: JSON.stringify(body),
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                    'Content-Type': 'application/json',
+                },
+                method: 'POST',
+            }, flags.verbose, profile.access_token);
+            if (!response.ok) {
+                const message = await this.parseApiError(response, 'Failed to change tenant deploy request status');
+                this.error(message);
+            }
+            const item = (await response.json());
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(item, null, 2));
+            }
+            else if (flags.status === 'approve' && item.fully_approved === false) {
+                // required_reviewers > 1: this vote didn't complete the quorum, so status
+                // stays "pending" and nothing was deployed yet.
+                this.log(`Vote recorded on deploy request #${item.id}: ${item.approvals_count}/${item.required_reviewers} required reviewers.`);
+            }
+            else {
+                const quorum = item.approvals_count !== undefined && item.required_reviewers !== undefined
+                    ? ` (${item.approvals_count}/${item.required_reviewers} required reviewers)`
+                    : '';
+                this.log(`Deploy request #${item.id} is now: ${item.status}${quorum}`);
+                if (flags.status === 'approve') {
+                    if (item.resolution?.deploy_status === 'deployed') {
+                        this.log('Deployed to tenant as part of this approval.');
+                    }
+                    else if (item.resolution?.deploy_status === 'failed') {
+                        this.log(`Approved, but the deploy failed: ${item.resolution.deploy_error ?? 'unknown error'}`);
+                    }
+                }
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to change tenant deploy request status: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to change tenant deploy request status: ${String(error)}`);
+            }
+        }
+    }
+}