@xano/cli 1.2.0 → 1.3.1-beta.0

package/dist/commands/ephemeral/static_host/build/list/index.js

@@ -0,0 +1,137 @@
+import { Args, Flags } from '@oclif/core';
+import BaseCommand from '../../../../../base-command.js';
+import { buildPagingJson, buildPagingParams, formatPagingFooter, normalizeListResponse, pagingFlags } from '../../../../../utils/paging.js';
+export default class EphemeralStaticHostBuildList extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name',
+            required: true,
+        }),
+    };
+    static description = 'List all builds for a static host of an ephemeral tenant';
+    static examples = [
+        `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 --static-host default -w 40
+Available builds:
+  - v1.0.0 (ID: 1) - Status: completed
+  - v1.0.1 (ID: 2) - Status: pending
+`,
+        `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 -H myhost --profile production
+Available builds:
+  - production (ID: 1) - Status: completed
+  - staging (ID: 2) - Status: completed
+`,
+        `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 -H default -w 40 --output json
+{
+  "count": 1,
+  "page": 1,
+  "total": 12,
+  "items": [
+    {
+      "id": 52
+    }
+  ]
+}
+`,
+        `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 -H default -p staging -o json --page 2
+[
+  {
+    "id": 3,
+    "name": "v1.0.2"
+  }
+]
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        output: Flags.string({
+            char: 'o',
+            default: 'summary',
+            description: 'Output format',
+            options: ['summary', 'json'],
+            required: false,
+        }),
+        ...pagingFlags('page-only-envelope', { fixedPerPage: 100 }),
+        'static-host': Flags.string({
+            char: 'H',
+            description: 'Static host name',
+            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(EphemeralStaticHostBuildList);
+        const { profile, profileName } = this.resolveProfile(flags);
+        const tenantName = args.tenant_name;
+        const staticHost = flags['static-host'];
+        // 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 ephemeral static_host build list <tenant_name> --static-host <static_host> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+        }
+        // Build query parameters
+        const queryParams = new URLSearchParams(buildPagingParams(flags, 'page-only-envelope'));
+        // Construct the API URL
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build?${queryParams.toString()}`;
+        // Fetch builds from the API
+        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 errorText = await response.text();
+                this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
+            }
+            const list = normalizeListResponse(await response.json(), ['builds']);
+            const builds = list.items;
+            // Output results
+            if (flags.output === 'json') {
+                this.log(JSON.stringify(buildPagingJson(list, { page: flags.page, tier: 'page-only-envelope' }), null, 2));
+            }
+            else {
+                // summary format
+                if (builds.length === 0) {
+                    this.log('No builds found');
+                }
+                else {
+                    this.log('Available builds:');
+                    for (const build of builds) {
+                        if (build.id === undefined) {
+                            this.log(`  - ${build.name}`);
+                        }
+                        else {
+                            const statusInfo = build.status ? ` - Status: ${build.status}` : '';
+                            this.log(`  - ${build.name} (ID: ${build.id})${statusInfo}`);
+                        }
+                    }
+                }
+                const footer = formatPagingFooter(list, { noun: 'build', page: flags.page, tier: 'page-only-envelope' });
+                if (footer)
+                    this.log(footer);
+            }
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                this.error(`Failed to fetch builds: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch builds: ${String(error)}`);
+            }
+        }
+    }
+}

package/dist/commands/ephemeral/static_host/build/pull/index.d.ts

@@ -0,0 +1,53 @@
+import BaseCommand from '../../../../../base-command.js';
+export interface StaticHostEnv {
+    canonical?: null | string;
+}
+export interface StaticHostSummary {
+    [k: string]: unknown;
+    dev?: StaticHostEnv;
+    name: string;
+    prod?: StaticHostEnv;
+}
+export interface BuildSummary {
+    canonical?: string;
+    id: number;
+}
+/**
+ * Find the deployed `canonical` for a static host's env from a list of hosts.
+ * Returns null when the host isn't present or nothing is deployed to that env.
+ */
+export declare function extractEnvCanonical(hosts: StaticHostSummary[], staticHost: string, env: string): null | string;
+/** Find the build whose unique `canonical` matches, or null if none do. */
+export declare function findBuildByCanonical(builds: BuildSummary[], canonical: string): BuildSummary | null;
+export default class EphemeralStaticHostBuildPull extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        build_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        env: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        latest: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        source: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'static-host': 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>;
+    private parseFileDocument;
+    /**
+     * Resolve the build ID currently deployed to a static host's dev/prod env.
+     *
+     * The deployed env stores the `canonical` of the build it was created from
+     * (static_host.{env}.canonical). Each build carries that same unique
+     * `canonical`, so we match the env's canonical against the build list to
+     * recover the build ID — a shortcut for "list builds, find the deployed one,
+     * then pull it".
+     */
+    private resolveEnvBuild;
+    private resolveLatestBuild;
+}

package/dist/commands/ephemeral/static_host/build/pull/index.js

@@ -0,0 +1,308 @@
+import { Args, Flags } from '@oclif/core';
+import * as fs from 'node:fs';
+import path from 'node:path';
+import BaseCommand from '../../../../../base-command.js';
+/**
+ * Find the deployed `canonical` for a static host's env from a list of hosts.
+ * Returns null when the host isn't present or nothing is deployed to that env.
+ */
+export function extractEnvCanonical(hosts, staticHost, env) {
+    const host = hosts.find((h) => h.name === staticHost);
+    if (!host) {
+        return null;
+    }
+    const envObj = host[env];
+    return envObj?.canonical ?? null;
+}
+/** Find the build whose unique `canonical` matches, or null if none do. */
+export function findBuildByCanonical(builds, canonical) {
+    return builds.find((b) => b.canonical === canonical) ?? null;
+}
+export default class EphemeralStaticHostBuildPull extends BaseCommand {
+    static args = {
+        tenant_name: Args.string({
+            description: 'Ephemeral tenant name',
+            required: true,
+        }),
+    };
+    static description = 'Pull a static host build for an ephemeral tenant to disk. Defaults to the original uploaded source (including package.json); use --source built for the compiled/served output.';
+    static examples = [
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 --static-host default --build_id 52
+Pulled 15 files to current directory
+`,
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 -H default --build_id 52 -d ./output
+Pulled 15 files to ./output
+`,
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 -H myhost --build_id 123 -w 40
+Pulled 8 files to current directory
+`,
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 -H default --latest
+Pulled 22 files to current directory
+`,
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 -H default --env dev
+Pulled 18 files to current directory
+`,
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 -H default --env prod -d ./prod-release
+Pulled 18 files to ./prod-release
+`,
+        `$ xano ephemeral static_host build pull e4f2-9ab1-xyz1 -H default --build_id 52 --source built
+Pulled the compiled/served output instead of the original source
+`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        build_id: Flags.string({
+            description: 'Build ID to pull',
+            exclusive: ['latest', 'env'],
+            required: false,
+        }),
+        directory: Flags.string({
+            char: 'd',
+            default: '.',
+            description: 'Output directory for pulled files (defaults to current directory)',
+            required: false,
+        }),
+        env: Flags.string({
+            description: 'Pull the build currently deployed to this environment',
+            exclusive: ['build_id', 'latest'],
+            options: ['dev', 'prod'],
+            required: false,
+        }),
+        latest: Flags.boolean({
+            default: false,
+            description: 'Pull the latest build',
+            exclusive: ['build_id', 'env'],
+            required: false,
+        }),
+        source: Flags.string({
+            default: 'original',
+            description: 'Which files to pull: "original" (the uploaded source, including package.json) or "built" (the compiled/served output)',
+            options: ['original', 'built'],
+            required: false,
+        }),
+        'static-host': Flags.string({
+            char: 'H',
+            description: 'Static host name',
+            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(EphemeralStaticHostBuildPull);
+        if (!flags.build_id && !flags.latest && !flags.env) {
+            this.error('One of --build_id <id>, --latest, or --env <dev|prod> is required');
+        }
+        const { profile, profileName } = this.resolveProfile(flags);
+        const tenantName = args.tenant_name;
+        const staticHost = flags['static-host'];
+        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 ephemeral static_host build pull <tenant_name> --static-host <static_host> --build_id <id> -w <workspace_id>\n` +
+                `  2. Set it in your profile using: xano profile edit ${profileName} -w <workspace_id>`);
+        }
+        let buildId;
+        if (flags.build_id) {
+            buildId = flags.build_id;
+        }
+        else if (flags.env) {
+            buildId = await this.resolveEnvBuild({
+                env: flags.env,
+                profile,
+                staticHost,
+                tenantName,
+                verbose: flags.verbose,
+                workspaceId,
+            });
+        }
+        else {
+            buildId = await this.resolveLatestBuild(profile, workspaceId, tenantName, staticHost, flags.verbose);
+        }
+        // Default is "original" (the uploaded source); only append the param when
+        // pulling the built output, so default requests stay clean.
+        const query = flags.source === 'built' ? '?source=built' : '';
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build/${buildId}/multidoc${query}`;
+        let responseText;
+        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 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 build multidoc: ${error.message}`);
+            }
+            else {
+                this.error(`Failed to fetch build multidoc: ${String(error)}`);
+            }
+        }
+        if (!responseText.trim()) {
+            this.log('No files found in build');
+            return;
+        }
+        const rawDocuments = responseText.split('\n---\n');
+        const files = [];
+        for (const raw of rawDocuments) {
+            const trimmed = raw.trim();
+            if (!trimmed)
+                continue;
+            const parsed = this.parseFileDocument(trimmed);
+            if (parsed) {
+                files.push(parsed);
+            }
+        }
+        if (files.length === 0) {
+            this.log('No files found in response');
+            return;
+        }
+        const outputDir = path.resolve(flags.directory);
+        fs.mkdirSync(outputDir, { recursive: true });
+        let writtenCount = 0;
+        for (const file of files) {
+            const filePath = path.resolve(outputDir, file.path);
+            if (!filePath.startsWith(outputDir + path.sep) && filePath !== outputDir) {
+                this.warn(`Skipping file with path outside output directory: ${file.path}`);
+                continue;
+            }
+            const fileDir = path.dirname(filePath);
+            fs.mkdirSync(fileDir, { recursive: true });
+            if (file.encoding === 'base64') {
+                const buffer = Buffer.from(file.content, 'base64');
+                fs.writeFileSync(filePath, buffer);
+            }
+            else {
+                fs.writeFileSync(filePath, file.content, 'utf8');
+            }
+            writtenCount++;
+        }
+        this.log(`Pulled ${writtenCount} files to ${flags.directory}`);
+    }
+    parseFileDocument(raw) {
+        const lines = raw.split('\n');
+        const firstLine = lines[0];
+        if (!firstLine.startsWith('path: ')) {
+            return null;
+        }
+        const filePath = firstLine.slice('path: '.length).trim();
+        if (lines.length > 1 && lines[1] === 'encoding: base64') {
+            const content = lines.slice(2).join('\n');
+            return { content, encoding: 'base64', path: filePath };
+        }
+        const content = lines.slice(1).join('\n');
+        return { content, path: filePath };
+    }
+    /**
+     * Resolve the build ID currently deployed to a static host's dev/prod env.
+     *
+     * The deployed env stores the `canonical` of the build it was created from
+     * (static_host.{env}.canonical). Each build carries that same unique
+     * `canonical`, so we match the env's canonical against the build list to
+     * recover the build ID — a shortcut for "list builds, find the deployed one,
+     * then pull it".
+     */
+    async resolveEnvBuild(opts) {
+        const { env, profile, staticHost, tenantName, verbose, workspaceId } = opts;
+        // 1. Look up the static host to read the deployed canonical for this env.
+        const hostUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host`;
+        const hostResponse = await this.verboseFetch(hostUrl, {
+            headers: {
+                accept: 'application/json',
+                Authorization: `Bearer ${profile.access_token}`,
+            },
+            method: 'GET',
+        }, verbose, profile.access_token);
+        if (!hostResponse.ok) {
+            const errorText = await hostResponse.text();
+            this.error(`Failed to list static hosts: ${hostResponse.status} ${hostResponse.statusText}\n${errorText}`);
+        }
+        const hostData = (await hostResponse.json());
+        const hosts = Array.isArray(hostData)
+            ? hostData
+            : hostData && typeof hostData === 'object' && 'items' in hostData && Array.isArray(hostData.items)
+                ? hostData.items
+                : [];
+        const canonical = extractEnvCanonical(hosts, staticHost, env);
+        if (!canonical) {
+            if (!hosts.some((h) => h.name === staticHost)) {
+                this.error(`Static host '${staticHost}' not found`);
+            }
+            this.error(`No build is deployed to the '${env}' environment of static host '${staticHost}'`);
+        }
+        // 2. Page through builds to find the one matching the deployed canonical.
+        const perPage = 100;
+        for (let page = 1;; page++) {
+            const listUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build?page=${page}&per_page=${perPage}`;
+            // eslint-disable-next-line no-await-in-loop
+            const response = await this.verboseFetch(listUrl, {
+                headers: {
+                    accept: 'application/json',
+                    Authorization: `Bearer ${profile.access_token}`,
+                },
+                method: 'GET',
+            }, verbose, profile.access_token);
+            if (!response.ok) {
+                // eslint-disable-next-line no-await-in-loop
+                const errorText = await response.text();
+                this.error(`Failed to list builds: ${response.status} ${response.statusText}\n${errorText}`);
+            }
+            // eslint-disable-next-line no-await-in-loop
+            const data = (await response.json());
+            const builds = Array.isArray(data)
+                ? data
+                : data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)
+                    ? data.items
+                    : [];
+            const match = findBuildByCanonical(builds, canonical);
+            if (match) {
+                return String(match.id);
+            }
+            if (builds.length < perPage) {
+                // Reached the last page without a match.
+                this.error(`Could not find the build deployed to '${env}' (canonical ${canonical}) in the build list for '${staticHost}'`);
+            }
+        }
+    }
+    async resolveLatestBuild(profile, workspaceId, tenantName, staticHost, verbose) {
+        const listUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build?page=1&per_page=1`;
+        const response = await this.verboseFetch(listUrl, {
+            headers: {
+                accept: 'application/json',
+                Authorization: `Bearer ${profile.access_token}`,
+            },
+            method: 'GET',
+        }, verbose, profile.access_token);
+        if (!response.ok) {
+            const errorText = await response.text();
+            this.error(`Failed to list builds: ${response.status} ${response.statusText}\n${errorText}`);
+        }
+        const data = await response.json();
+        const builds = Array.isArray(data)
+            ? data
+            : data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)
+                ? data.items
+                : [];
+        if (builds.length === 0) {
+            this.error(`No builds found for static host '${staticHost}'`);
+        }
+        return String(builds[0].id);
+    }
+}

package/dist/commands/ephemeral/static_host/build/push/index.d.ts

@@ -0,0 +1,24 @@
+import BaseCommand from '../../../../../base-command.js';
+export default class EphemeralStaticHostBuildPush extends BaseCommand {
+    static args: {
+        tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        description: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        directory: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'no-gitignore': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'no-wait': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'static-host': 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>;
+    private createZipBuffer;
+}