@xano/cli 1.3.3 → 1.3.5-beta.0

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

@@ -0,0 +1,159 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../base-command.js';
+import { gateOverrideHint, gateRefusal, gateRefusalOutput, quoted } from '../../../utils/policy/gate.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,
+        }),
+        'override-policy': Flags.boolean({
+            default: false,
+            description: 'With --status approve: if this vote deploys, proceed past a blocking policy gate, recording --reason as the override reason (needs the workspace:policy update permission; audited)',
+            hidden: true,
+        }),
+        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,
+        }),
+    };
+    /** Set once the policy gate refuses the deploy an approval triggered, the one failure that exits 2. */
+    refusedByPolicyGate = false;
+    /** Exit 2 is the policy gate's refusal; every other failure, flag errors included, exits 1. */
+    async catch(error) {
+        if (this.refusedByPolicyGate)
+            return super.catch(error);
+        return this.catchAsOperational(error);
+    }
+    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}"`);
+        }
+        if (flags['override-policy'])
+            this.checkOverride(flags);
+        const body = {
+            action: flags.status,
+            reason: flags.reason ?? '',
+            ...(flags['override-policy'] ? { override_policy: true } : {}),
+        };
+        // A refusal by the policy gate exits 2 with its verdict; the catch that rewords other failures keeps it.
+        let refused = null;
+        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) {
+                refused = await gateRefusal(response);
+                if (refused)
+                    this.refuseByPolicyGate(refused, args.id, flags.output === 'json');
+                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 (refused)
+                throw 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)}`);
+            }
+        }
+    }
+    /** `--override-policy` overrides the deploy an approve can trigger, and its reason is `--reason`. */
+    checkOverride(flags) {
+        if (flags.status !== 'approve')
+            this.error('--override-policy applies only to --status approve, the vote that can deploy.');
+        if (!flags.reason?.trim())
+            this.error('--override-policy needs --reason: say why this deploy may proceed past the policy gate.');
+    }
+    /**
+     * The deploy this approval triggered was refused by the policy gate: its verdict, then the refusal,
+     * exiting 2. The vote that completes the approvals is recorded before the deploy, so the request
+     * stays approved, and a later deploy of the pair that overrides the gate completes it.
+     */
+    refuseByPolicyGate(refused, id, json) {
+        for (const line of gateRefusalOutput(refused, json))
+            this.log(line);
+        const approved = refused.answer.gate === 'tenant_approve'
+            ? '\nYour approval was recorded and the request is approved, but its release was not deployed.'
+            : '';
+        const release = refused.answer.release?.name?.trim();
+        const override = `xano tenant deploy_release <tenant> --release ${release ? quoted(release) : '<release>'} --override-reason "<why>" (\`xano tenant_deploy_request get ${id}\` names the tenant)`;
+        this.refusedByPolicyGate = true;
+        this.error(`${refused.message}${approved}${gateOverrideHint(refused.answer, override)}`, { exit: 2 });
+    }
+}

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

@@ -1,4 +1,10 @@
 import BaseCommand from '../../../base-command.js';
+/**
+ * Whether pull should write `.xano/sync_state.json`: only when asked to, or to keep an existing
+ * record current. A `--draft` pull never writes it, because `--fast` compares against published
+ * versions and recording draft bodies as synced would stop those drafts from being pushed.
+ */
+export declare function syncStateAction(flag: boolean, dir: string, draft: boolean): 'draft' | 'skip' | 'write';
 export default class Pull extends BaseCommand {
     static description: string;
     static examples: string[];
@@ -8,10 +14,21 @@ export default class Pull extends BaseCommand {
         draft: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'sync-state': 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>;
+    /**
+     * Policy keys are unique on the server without regard to case, but an older export or a local file
+     * can still differ only in case, and file names are not case-sensitive on every checkout. The
+     * policies whose file name differs only in case from another exported policy, or from a local file
+     * it would overwrite, are left out with a warning; everything else is written. Local policy files
+     * absent from the export are kept. They are reported as stale only when this credential reads the
+     * branch's policies, because an export leaves out the policies its credential cannot read, and
+     * every policy while the Policies feature is off.
+     */
+    private policyClashes;
 }

package/dist/commands/workspace/pull/index.js

@@ -3,8 +3,20 @@ import snakeCase from 'lodash.snakecase';
 import * as fs from 'node:fs';
 import path from 'node:path';
 import BaseCommand from '../../../base-command.js';
-import { buildApiGroupFolderResolver, buildChannelServerResolver, parseDocument, resolveDocumentPath, } from '../../../utils/document-parser.js';
+import { buildApiGroupFolderResolver, buildChannelServerResolver, parseDocument, policyBaseName, resolveDocumentPath, } from '../../../utils/document-parser.js';
 import { fetchKnowledge, writeKnowledge } from '../../../utils/knowledge-sync.js';
+import { policyListing } from '../../../utils/policy/request.js';
+import { recordEntriesForPaths, resolveTarget, saveSyncState, syncStateExists } from '../../../utils/sync-state.js';
+/**
+ * Whether pull should write `.xano/sync_state.json`: only when asked to, or to keep an existing
+ * record current. A `--draft` pull never writes it, because `--fast` compares against published
+ * versions and recording draft bodies as synced would stop those drafts from being pushed.
+ */
+export function syncStateAction(flag, dir, draft) {
+    if (!flag && !syncStateExists(dir))
+        return 'skip';
+    return draft ? 'draft' : 'write';
+}
 export default class Pull extends BaseCommand {
     static description = 'Pull a workspace multidoc from the Xano Metadata API and split into individual files';
     static examples = [
@@ -22,12 +34,15 @@ Pulled 58 documents
 `,
         `$ xano workspace pull --draft`,
         `$ xano workspace pull -b dev`,
+        `$ xano workspace pull --sync-state
+Write .xano/sync_state.json after pulling; later pulls keep it current while it exists
+`,
     ];
     static flags = {
         ...BaseCommand.baseFlags,
         branch: Flags.string({
             char: 'b',
-            description: 'Branch name (optional if set in profile, defaults to live)',
+            description: "Branch name (defaults to profile branch or live; -b '' selects live)",
             required: false,
         }),
         directory: Flags.string({
@@ -51,6 +66,11 @@ Pulled 58 documents
             description: 'Include records',
             required: false,
         }),
+        'sync-state': Flags.boolean({
+            default: false,
+            description: 'Write .xano/sync_state.json after a successful pull. Needed only the first time; later pulls keep the record current while it exists.',
+            required: false,
+        }),
         workspace: Flags.string({
             char: 'w',
             description: 'Workspace ID (optional if set in profile)',
@@ -73,8 +93,8 @@ Pulled 58 documents
                 `  1. Provide it as a flag: xano workspace pull -w <workspace_id>\n` +
                 `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
         }
-        // Determine branch from flag or profile
-        const branch = flags.branch || profile.branch || '';
+        // Determine branch from flag or profile; `-b ''` selects live whatever the profile's branch, as in push.
+        const branch = flags.branch ?? profile.branch ?? '';
         // Build query parameters
         const queryParams = new URLSearchParams({
             branch,
@@ -123,12 +143,13 @@ Pulled 58 documents
                 documents.push(parsed);
             }
         }
+        // Resolve the output directory
+        const outputDir = path.resolve(flags.directory);
+        const clashing = await this.policyClashes(documents, outputDir, () => policyListing({ logToStderr: (message) => this.logToStderr(message), verboseFetch: (...args) => this.verboseFetch(...args) }, { branch, profile, verbose: flags.verbose, workspace: workspaceId }));
         if (documents.length === 0) {
             this.log('No documents found in response');
             return;
         }
-        // Resolve the output directory
-        const outputDir = path.resolve(flags.directory);
         // Create the output directory if it doesn't exist
         fs.mkdirSync(outputDir, { recursive: true });
         // Resolve api_group names to unique folder names, disambiguating collisions
@@ -140,7 +161,8 @@ Pulled 58 documents
         // Track filenames per type to handle duplicates
         const filenameCounters = new Map();
         let writtenCount = 0;
-        for (const doc of documents) {
+        const writtenPaths = [];
+        for (const doc of documents.filter((document) => !clashing.has(document))) {
             const { baseName, typeDir } = resolveDocumentPath(doc, outputDir, {
                 getApiGroupFolder,
                 getChannelServer,
@@ -160,6 +182,7 @@ Pulled 58 documents
             const filename = count === 0 ? `${baseName}.xs` : `${baseName}_${count + 1}.xs`;
             const filePath = path.join(typeDir, filename);
             fs.writeFileSync(filePath, doc.content, 'utf8');
+            writtenPaths.push(filePath);
             writtenCount++;
         }
         // ── Pull knowledge ────────────────────────────────────────────────────
@@ -173,5 +196,99 @@ Pulled 58 documents
         if (knowledgeCount > 0)
             parts.push(`${knowledgeCount} knowledge file${knowledgeCount === 1 ? '' : 's'}`);
         this.log(`Pulled ${parts.join(' + ')} to ${flags.directory}`);
+        // Policy files state the rules; the skill the instance generates tells an agent how to follow them.
+        // Only a pull that carried policy files says so: an instance with the Policies feature off exports
+        // none, and its skill route answers 403.
+        if (documents.some((doc) => doc.type === 'policy')) {
+            this.log('Run `xano skills pull` to install the policies skill for your coding agent.');
+        }
+        const syncState = syncStateAction(flags['sync-state'], outputDir, flags.draft);
+        if (syncState === 'skip') {
+            return;
+        }
+        if (syncState === 'draft') {
+            this.warn('Skipped writing .xano/sync_state.json: --draft pulls draft versions, which --fast does not compare against');
+            return;
+        }
+        const origin = profile.instance_origin.replace(/\/$/, '');
+        try {
+            const target = await resolveTarget(profile.instance_origin, workspaceId, branch, async (pathname) => {
+                const response = await this.verboseFetch(`${origin}/api:meta${pathname}`, {
+                    headers: {
+                        accept: 'application/json',
+                        Authorization: `Bearer ${profile.access_token}`,
+                    },
+                    method: 'GET',
+                }, flags.verbose, profile.access_token);
+                if (!response.ok) {
+                    throw new Error(`HTTP ${response.status}`);
+                }
+                return response.json();
+            });
+            if (!target) {
+                this.warn('Could not resolve workspace/branch fingerprints; skipped writing .xano/sync_state.json');
+                return;
+            }
+            const entries = recordEntriesForPaths(outputDir, writtenPaths);
+            saveSyncState(outputDir, target, entries, { replace: true });
+        }
+        catch (error) {
+            this.warn(`Skipped writing .xano/sync_state.json: ${error.message}`);
+        }
+    }
+    /**
+     * Policy keys are unique on the server without regard to case, but an older export or a local file
+     * can still differ only in case, and file names are not case-sensitive on every checkout. The
+     * policies whose file name differs only in case from another exported policy, or from a local file
+     * it would overwrite, are left out with a warning; everything else is written. Local policy files
+     * absent from the export are kept. They are reported as stale only when this credential reads the
+     * branch's policies, because an export leaves out the policies its credential cannot read, and
+     * every policy while the Policies feature is off.
+     */
+    async policyClashes(documents, outputDir, readsPolicies) {
+        const exported = new Map();
+        for (const doc of documents.filter(doc => doc.type === 'policy')) {
+            const filename = `${policyBaseName(doc.name)}.xs`;
+            exported.set(filename.toLowerCase(), [...(exported.get(filename.toLowerCase()) ?? []), filename]);
+        }
+        const clashes = new Map();
+        for (const [normalized, names] of exported) {
+            if (names.length > 1)
+                clashes.set(normalized, names.map(name => `policies/${name}`).join(' and '));
+        }
+        const policyDir = path.join(outputDir, 'policies');
+        const localFiles = fs.existsSync(policyDir)
+            ? fs.readdirSync(policyDir, { withFileTypes: true })
+                .filter(entry => entry.isFile() && entry.name.toLowerCase().endsWith('.xs'))
+                .map(entry => entry.name)
+                .sort()
+            : [];
+        const stale = [];
+        for (const filename of localFiles) {
+            const names = exported.get(filename.toLowerCase());
+            if (!names)
+                stale.push(`policies/${filename}`);
+            else if (!names.includes(filename) && !clashes.has(filename.toLowerCase())) {
+                clashes.set(filename.toLowerCase(), `policies/${names[0]} (local policies/${filename})`);
+            }
+        }
+        if (clashes.size > 0) {
+            this.warn(`Policy files that differ only in case are left out of this pull; everything else is written:\n  ${[...clashes.values()].join('\n  ')}\n` +
+                'Rename one of the policies, or move the local file aside, then pull again.');
+        }
+        if (stale.length > 0) {
+            // An export that carries a policy was made by a credential that reads them.
+            const listing = exported.size > 0 ? 'listed' : await readsPolicies();
+            if (listing === 'listed') {
+                this.warn(`Stale local policy files are absent from this export and were kept:\n  ${stale.join('\n  ')}\nReview them before pushing; a push can publish these policies again.`);
+            }
+            else if (listing === 'feature_off') {
+                this.log('Local policy files were kept: Policies are not enabled on this instance, so the export carries none.');
+            }
+            else {
+                this.log(`Local policy files were kept: this credential cannot list this workspace's policies, and the export carries none.`);
+            }
+        }
+        return new Set(documents.filter(doc => doc.type === 'policy' && clashes.has(`${doc.name}.xs`.toLowerCase())));
     }
 }

package/dist/commands/workspace/push/index.d.ts

@@ -9,17 +9,40 @@ export default class Push extends BaseCommand {
         'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         exclude: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        fast: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         guids: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         include: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        message: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'policy-override': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         records: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        refresh: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         sync: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         transaction: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         truncate: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        writeback: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'writeback-diff': 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>;
     };
+    protected catch(error: Error & {
+        oclif?: {
+            exit?: number;
+        };
+    }): Promise<void>;
     run(): Promise<void>;
+    /**
+     * A failure after the import landed. The import stands, so its policy feedback is reported as for
+     * any push and a blocking finding still exits 2; otherwise the failure exits 1. Under `-o json`
+     * stdout holds the import's document with the failure as `error`.
+     */
+    private catchAfterImport;
+    /**
+     * What happened to the policy documents, then the policy check the import answered with. When the
+     * platform left the policy files out, its notice says so instead of a count of what was sent.
+     */
+    private reportPolicyFeedback;
 }