@xano/cli 1.0.6-beta.3 → 1.0.6-beta.6

package/dist/utils/document-parser.js

@@ -133,6 +133,145 @@ export function buildChannelServerResolver(documents) {
     }
     return (channelName) => channelToServer.get(channelName);
 }
+/**
+ * Sanitize a document name for use as a single on-disk filename segment.
+ * Strips quotes and snake_cases the rest. Mirrors the per-command
+ * `sanitizeFilename` the pull commands used to each define privately.
+ */
+export function sanitizeDocumentName(name, snakeCaseFn) {
+    return snakeCaseFn(name.replaceAll('"', ''));
+}
+/**
+ * Resolve where a parsed document lands on disk — the SINGLE source of truth for
+ * the pull layout, shared by every pull command (workspace, tenant, release,
+ * sandbox, ephemeral). Previously each command inlined a ~130-line copy of this
+ * decision; the copies drifted (the realtime v2 realtime_server/channel/message
+ * branches existed only in workspace/tenant), so an ephemeral pull dumped v2
+ * objects into flat top-level channel/, message/ and realtime_server/ folders —
+ * detaching messages from their channels and risking name collisions (message
+ * names are unique only WITHIN a channel).
+ *
+ * @param doc - the parsed document
+ * @param outputDir - the resolved pull output root
+ * @param deps - injected dependencies
+ * @param deps.getApiGroupFolder - resolves an api_group name to its unique folder
+ * @param deps.getChannelServer - resolves a v2 channel path to its owning realtime_server
+ * @param deps.join - the path.join implementation (injectable for testing)
+ * @param deps.snakeCase - the snakeCase implementation the caller uses
+ */
+export function resolveDocumentPath(doc, outputDir, deps) {
+    const { getApiGroupFolder, getChannelServer, join, snakeCase } = deps;
+    const sanitize = (name) => sanitizeDocumentName(name, snakeCase);
+    if (doc.type === 'workspace') {
+        // workspace → workspace/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'workspace') };
+    }
+    if (doc.type === 'workspace_trigger' || doc.type === 'error_trigger') {
+        // workspace_trigger / error_trigger → workspace/trigger/{name}.xs
+        // (error_trigger is a singleton, colocated with workspace triggers)
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'workspace', 'trigger') };
+    }
+    if (doc.type === 'agent') {
+        // agent → ai/agent/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'agent') };
+    }
+    if (doc.type === 'mcp_server') {
+        // mcp_server → ai/mcp_server/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'mcp_server') };
+    }
+    if (doc.type === 'tool') {
+        // tool → ai/tool/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'tool') };
+    }
+    if (doc.type === 'agent_trigger') {
+        // agent_trigger → ai/agent/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'agent', 'trigger') };
+    }
+    if (doc.type === 'mcp_server_trigger') {
+        // mcp_server_trigger → ai/mcp_server/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'ai', 'mcp_server', 'trigger') };
+    }
+    if (doc.type === 'table_trigger') {
+        // table_trigger → table/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'table', 'trigger') };
+    }
+    if (doc.type === 'realtime_channel') {
+        // Realtime v1: realtime_channel → realtime/channel/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'realtime', 'channel') };
+    }
+    if (doc.type === 'realtime_trigger') {
+        // Realtime v1: realtime_trigger → realtime/trigger/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'realtime', 'trigger') };
+    }
+    if (doc.type === 'realtime_server') {
+        // Realtime v2. The realtime_server is the top-level container that owns
+        // channels (which own messages). Its own document is named after itself
+        // inside its name directory, mirroring api_group (api/<group>/<group>.xs).
+        //   realtime_server "chat" → realtime/server/chat/chat.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'realtime', 'server', sanitize(doc.name)) };
+    }
+    if (doc.type === 'channel') {
+        // Realtime v2. The channel owns a directory named after itself (the full
+        // channel name, snake_cased into a single flat segment), and its messages
+        // live in a message/ subfolder inside it. It nests under its owning
+        // realtime_server (from `realtime_server = "..."`):
+        //   channel "rooms/{room_id}" (server "chat")
+        //     → realtime/server/chat/channel/rooms_room_id/rooms_room_id.xs
+        //
+        // A channel with no resolvable server (e.g. a pre-server export) falls back
+        // to the legacy flat channel/<path>/_channel.xs layout.
+        if (doc.server) {
+            return {
+                baseName: snakeCase(doc.name),
+                typeDir: join(outputDir, 'realtime', 'server', sanitize(doc.server), 'channel', snakeCase(doc.name)),
+            };
+        }
+        return { baseName: '_channel', typeDir: join(outputDir, 'channel', ...channelPathSegments(doc.name, snakeCase)) };
+    }
+    if (doc.type === 'message' && doc.channel) {
+        // Realtime v2 message → nests in a message/ subfolder under its channel,
+        // under that channel's server (resolved via the two-pass channel→server map).
+        //   message "post" on channel "rooms/{room_id}" (server "chat")
+        //     → realtime/server/chat/channel/rooms_room_id/message/post.xs
+        //
+        // Nesting matters beyond tidiness: message names are unique only WITHIN a
+        // channel, so a flat message/ directory would collide when two channels
+        // both define e.g. "say". A channel whose server can't be resolved falls
+        // back to the legacy flat channel/ layout.
+        const messageServer = getChannelServer(doc.channel);
+        return {
+            baseName: sanitize(doc.name),
+            typeDir: messageServer
+                ? join(outputDir, 'realtime', 'server', sanitize(messageServer), 'channel', snakeCase(doc.channel), 'message')
+                : join(outputDir, 'channel', ...channelPathSegments(doc.channel, snakeCase)),
+        };
+    }
+    if (doc.type === 'api_group') {
+        // api_group "test" → api/{resolved_folder}/{name}.xs
+        return { baseName: sanitize(doc.name), typeDir: join(outputDir, 'api', getApiGroupFolder(doc.name)) };
+    }
+    if (doc.type === 'query' && doc.apiGroup) {
+        // query in group "test" → api/{resolved_folder}/{folders}/{query_name}[_verb].xs
+        const groupFolder = getApiGroupFolder(doc.apiGroup);
+        const nameParts = doc.name.split('/');
+        const leafName = nameParts.pop();
+        const folderParts = nameParts.map((part) => snakeCase(part));
+        const baseName = sanitize(leafName);
+        return {
+            baseName: doc.verb ? `${baseName}_${doc.verb}` : baseName,
+            typeDir: join(outputDir, 'api', groupFolder, ...folderParts),
+        };
+    }
+    // Default: split folder path from name
+    const nameParts = doc.name.split('/');
+    const leafName = nameParts.pop();
+    const folderParts = nameParts.map((part) => snakeCase(part));
+    const baseName = sanitize(leafName);
+    return {
+        baseName: doc.verb ? `${baseName}_${doc.verb}` : baseName,
+        typeDir: join(outputDir, doc.type, ...folderParts),
+    };
+}
 /**
  * Build a unique key for a document based on its type, name, verb, and api_group.
  * Used to match server GUID map entries back to local files.

package/dist/utils/paging.d.ts

@@ -0,0 +1,141 @@
+/**
+ * How much paging information the backing Metadata API endpoint gives us.
+ *
+ * The Metadata API pages unevenly, and what the CLI can honestly tell the user
+ * depends entirely on what the response carries:
+ *
+ * - `envelope`            accepts page + per_page and returns
+ *                         {curPage, nextPage, prevPage, items[]}. `nextPage` is
+ *                         server-computed and null on the last page, so it is the
+ *                         one place a "there is more" hint is guaranteed correct.
+ * - `page-only-envelope`  accepts page only (per_page is hardcoded server-side)
+ *                         and returns an object carrying `itemsTotal`. A true
+ *                         total, so we can say where the user sits — but we offer
+ *                         no next-page affordance.
+ * - `none`                no server-side paging at all. The full set comes back,
+ *                         so the item count IS the total.
+ *
+ * There is deliberately no tier for endpoints that page but return a bare array
+ * with no metadata (tenants, releases, platforms, clusters, ephemerals, tenant
+ * backups). Those commands are left alone: the only has-more signal available
+ * would be "the page came back full", which is a guaranteed false positive when
+ * the result set is an exact multiple of the page size — sending the user to an
+ * empty page. Better to offer nothing than to offer a lie.
+ */
+export type PagingTier = 'envelope' | 'none' | 'page-only-envelope';
+export interface PagingFlagValues {
+    page?: number;
+    per_page?: number;
+}
+export interface NormalizedList<T> {
+    curPage?: number;
+    items: T[];
+    itemsTotal?: number;
+    nextPage?: number;
+    prevPage?: number;
+}
+export interface PagingFlagOptions {
+    /** Page size the endpoint hardcodes server-side; surfaced in the page flag description. */
+    fixedPerPage?: number;
+    /** Maximum per_page the endpoint accepts; surfaced in the per_page flag description. */
+    maxPerPage?: number;
+}
+declare function makePageFlag(description: string): import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+declare function makePerPageFlag(defaultValue: number, description: string): import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+type PageFlag = ReturnType<typeof makePageFlag>;
+type PerPageFlag = ReturnType<typeof makePerPageFlag>;
+/**
+ * Build the oclif flag definitions appropriate to an endpoint's paging tier.
+ * Spread the result into a command's `static flags`.
+ *
+ * A flag the server ignores is worse than no flag, so `per_page` is only
+ * produced for tiers whose endpoint actually accepts it. The overloads keep
+ * oclif's flag-type inference intact so `flags.page` stays typed at call sites.
+ */
+export declare function pagingFlags(tier: 'envelope', options?: PagingFlagOptions): {
+    page: PageFlag;
+    per_page: PerPageFlag;
+};
+export declare function pagingFlags(tier: 'page-only-envelope', options?: PagingFlagOptions): {
+    page: PageFlag;
+};
+export declare function pagingFlags(tier: 'none', options?: PagingFlagOptions): Record<string, never>;
+export declare function pagingFlags(tier: PagingTier, options?: PagingFlagOptions): Record<string, unknown>;
+/**
+ * Translate parsed paging flags into query-string entries, emitting only the
+ * params the endpoint actually declares.
+ */
+export declare function buildPagingParams(flags: PagingFlagValues | Record<string, unknown>, tier: PagingTier): Array<[string, string]>;
+/**
+ * Absorb the response shapes the Metadata API returns for list endpoints:
+ * a bare array, a paging envelope keyed on `items`, or an object keyed on the
+ * resource name (e.g. `{workspaces: [...]}`).
+ *
+ * `resourceKeys` names any resource-keyed fallbacks to check, in order.
+ */
+export declare function normalizeListResponse<T>(data: unknown, resourceKeys?: string[]): NormalizedList<T>;
+/** Page size used when the CLI pages an endpoint on the user's behalf. */
+export declare const INTERNAL_PAGE_SIZE = 100;
+/**
+ * Walk an envelope-tier endpoint page by page and collect every item.
+ *
+ * Termination is the server's own `nextPage`, never "the page came back full" —
+ * the same rule the footer follows. An empty page also stops the walk, which
+ * covers an endpoint that omits `nextPage` entirely rather than looping forever.
+ *
+ * `maxPages` is a runaway backstop, not a limit users are expected to hit; when
+ * it trips, `onTruncate` fires so the caller can say so out loud instead of
+ * silently processing a subset.
+ */
+export declare function collectAllPages<T>(fetchPage: (page: number) => Promise<NormalizedList<T>>, options?: {
+    maxPages?: number;
+    onTruncate?: (collected: number) => void;
+}): Promise<T[]>;
+export interface PagingJson<T> {
+    count: number;
+    items: T[];
+    next_page?: number;
+    page?: number;
+    per_page?: number;
+    prev_page?: number;
+    total?: number;
+}
+/**
+ * Build the `--output json` payload for a list command.
+ *
+ * Emits only fields the response actually proves, mirroring the footer's
+ * honesty rule: `total` appears only when the server sent `itemsTotal`,
+ * `next_page` only when the server computed it. `count` is always the number of
+ * items in this payload and is the one figure that is unconditionally true.
+ *
+ * Without this, a script driving `--output json` sees a bare array and its only
+ * available stop condition is `length < per_page` — precisely the page-fullness
+ * inference this module refuses to make in the footer.
+ */
+export declare function buildPagingJson<T>(list: NormalizedList<T>, options: {
+    page?: number;
+    perPage?: number;
+    tier: PagingTier;
+}): PagingJson<T>;
+export interface PagingFooterOptions {
+    /** Singular noun for the listed resource, used by the `none` tier. */
+    noun: string;
+    /** Plural form; defaults to `noun + 's'`. */
+    nounPlural?: string;
+    /** Page the user requested, used when the response omits `curPage`. */
+    page?: number;
+    /** Page size the user requested. Recorded for context; never used to infer a next page. */
+    perPage?: number;
+    tier: PagingTier;
+}
+/**
+ * Render the paging footer for a list command, reporting only facts the response
+ * actually proves. Returns null when there is nothing worth saying — an empty
+ * result set already prints its own "No X found" line.
+ *
+ * Deliberately asymmetric across tiers: `envelope` shows a next-page hint but no
+ * total, `page-only-envelope` shows a total but no next-page hint, and `none`
+ * shows a bare count. See PagingTier for why.
+ */
+export declare function formatPagingFooter<T>(list: NormalizedList<T>, options: PagingFooterOptions): null | string;
+export {};

package/dist/utils/paging.js

@@ -0,0 +1,194 @@
+/* eslint-disable camelcase */
+import { Flags } from '@oclif/core';
+function makePageFlag(description) {
+    return Flags.integer({ default: 1, description, required: false });
+}
+function makePerPageFlag(defaultValue, description) {
+    return Flags.integer({ default: defaultValue, description, required: false });
+}
+export function pagingFlags(tier, options = {}) {
+    if (tier === 'none') {
+        return {};
+    }
+    if (tier === 'page-only-envelope') {
+        const fixed = options.fixedPerPage;
+        return {
+            page: makePageFlag(fixed
+                ? `Page number for pagination (page size is fixed at ${fixed} by the API)`
+                : 'Page number for pagination'),
+        };
+    }
+    return {
+        page: makePageFlag('Page number for pagination'),
+        per_page: makePerPageFlag(50, options.maxPerPage
+            ? `Number of results per page (max ${options.maxPerPage})`
+            : 'Number of results per page'),
+    };
+}
+/**
+ * Translate parsed paging flags into query-string entries, emitting only the
+ * params the endpoint actually declares.
+ */
+export function buildPagingParams(flags, tier) {
+    if (tier === 'none') {
+        return [];
+    }
+    const { page, per_page: perPage } = flags;
+    const params = [];
+    if (page !== undefined) {
+        params.push(['page', String(page)]);
+    }
+    if (tier === 'envelope' && perPage !== undefined) {
+        params.push(['per_page', String(perPage)]);
+    }
+    return params;
+}
+/** Coerce a possibly-null numeric paging field to a number or undefined. */
+function optionalNumber(value) {
+    return typeof value === 'number' ? value : undefined;
+}
+/**
+ * Absorb the response shapes the Metadata API returns for list endpoints:
+ * a bare array, a paging envelope keyed on `items`, or an object keyed on the
+ * resource name (e.g. `{workspaces: [...]}`).
+ *
+ * `resourceKeys` names any resource-keyed fallbacks to check, in order.
+ */
+export function normalizeListResponse(data, resourceKeys = []) {
+    if (Array.isArray(data)) {
+        return { items: data };
+    }
+    if (data && typeof data === 'object') {
+        const record = data;
+        if (Array.isArray(record.items)) {
+            return {
+                curPage: optionalNumber(record.curPage),
+                items: record.items,
+                itemsTotal: optionalNumber(record.itemsTotal),
+                nextPage: optionalNumber(record.nextPage),
+                prevPage: optionalNumber(record.prevPage),
+            };
+        }
+        for (const key of resourceKeys) {
+            if (Array.isArray(record[key])) {
+                return {
+                    curPage: optionalNumber(record.curPage),
+                    items: record[key],
+                    itemsTotal: optionalNumber(record.itemsTotal),
+                    nextPage: optionalNumber(record.nextPage),
+                    prevPage: optionalNumber(record.prevPage),
+                };
+            }
+        }
+    }
+    const accepted = ['an array', 'an object with an items array', ...resourceKeys.map((k) => `an object with a ${k} array`)];
+    throw new Error(`Unexpected API response format. Expected ${accepted.join(', ')}.`);
+}
+/** Page size used when the CLI pages an endpoint on the user's behalf. */
+export const INTERNAL_PAGE_SIZE = 100;
+/**
+ * Walk an envelope-tier endpoint page by page and collect every item.
+ *
+ * Termination is the server's own `nextPage`, never "the page came back full" —
+ * the same rule the footer follows. An empty page also stops the walk, which
+ * covers an endpoint that omits `nextPage` entirely rather than looping forever.
+ *
+ * `maxPages` is a runaway backstop, not a limit users are expected to hit; when
+ * it trips, `onTruncate` fires so the caller can say so out loud instead of
+ * silently processing a subset.
+ */
+export async function collectAllPages(fetchPage, options = {}) {
+    const maxPages = options.maxPages ?? 100;
+    const items = [];
+    for (let page = 1; page <= maxPages; page++) {
+        // eslint-disable-next-line no-await-in-loop
+        const list = await fetchPage(page);
+        items.push(...list.items);
+        if (list.items.length === 0 || list.nextPage === undefined) {
+            return items;
+        }
+    }
+    options.onTruncate?.(items.length);
+    return items;
+}
+/**
+ * Build the `--output json` payload for a list command.
+ *
+ * Emits only fields the response actually proves, mirroring the footer's
+ * honesty rule: `total` appears only when the server sent `itemsTotal`,
+ * `next_page` only when the server computed it. `count` is always the number of
+ * items in this payload and is the one figure that is unconditionally true.
+ *
+ * Without this, a script driving `--output json` sees a bare array and its only
+ * available stop condition is `length < per_page` — precisely the page-fullness
+ * inference this module refuses to make in the footer.
+ */
+export function buildPagingJson(list, options) {
+    const payload = { count: list.items.length, items: list.items };
+    if (options.tier === 'none') {
+        return payload;
+    }
+    const hasPositionEvidence = list.curPage !== undefined ||
+        list.nextPage !== undefined ||
+        list.prevPage !== undefined ||
+        list.itemsTotal !== undefined;
+    // Same rule as the footer: with no metadata we cannot assert a position.
+    if (!hasPositionEvidence) {
+        return payload;
+    }
+    const page = list.curPage ?? options.page;
+    if (page !== undefined)
+        payload.page = page;
+    if (options.tier === 'envelope' && options.perPage !== undefined)
+        payload.per_page = options.perPage;
+    if (list.nextPage !== undefined)
+        payload.next_page = list.nextPage;
+    if (list.prevPage !== undefined)
+        payload.prev_page = list.prevPage;
+    if (list.itemsTotal !== undefined)
+        payload.total = list.itemsTotal;
+    return payload;
+}
+const SEPARATOR = ' · ';
+/**
+ * Render the paging footer for a list command, reporting only facts the response
+ * actually proves. Returns null when there is nothing worth saying — an empty
+ * result set already prints its own "No X found" line.
+ *
+ * Deliberately asymmetric across tiers: `envelope` shows a next-page hint but no
+ * total, `page-only-envelope` shows a total but no next-page hint, and `none`
+ * shows a bare count. See PagingTier for why.
+ */
+export function formatPagingFooter(list, options) {
+    const count = list.items.length;
+    const plural = options.nounPlural ?? `${options.noun}s`;
+    const countPhrase = `${count} ${count === 1 ? options.noun : plural}`;
+    // A paged tier whose response carried no metadata at all tells us nothing
+    // about position — the endpoint may have ignored `page` entirely. Reporting
+    // the requested page here would state the user's wish as a server fact, so
+    // fall back to the bare count.
+    const hasPositionEvidence = list.curPage !== undefined ||
+        list.nextPage !== undefined ||
+        list.prevPage !== undefined ||
+        list.itemsTotal !== undefined;
+    if (options.tier === 'none' || !hasPositionEvidence) {
+        return count === 0 ? null : countPhrase;
+    }
+    // An empty page past the end is worth reporting when we know the true total —
+    // otherwise `--page 99` on a populated workspace is indistinguishable from an
+    // empty one.
+    if (count === 0 && list.itemsTotal === undefined) {
+        return null;
+    }
+    const page = list.curPage ?? options.page ?? 1;
+    const parts = [`Page ${page}`, `${count} shown`];
+    if (options.tier === 'envelope' && list.nextPage !== undefined) {
+        // Server-computed. Null/absent on the last page, so following it can never
+        // land on an empty result. Page fullness is never consulted here.
+        parts.push(`next: --page ${list.nextPage}`);
+    }
+    if (options.tier === 'page-only-envelope' && list.itemsTotal !== undefined) {
+        parts.push(`${list.itemsTotal} total`);
+    }
+    return parts.join(SEPARATOR);
+}