@xano/cli 1.0.4-beta.7 → 1.0.4-beta.9

package/README.md

@@ -255,8 +255,35 @@ xano function edit <function_id> -f new.xs              # Update from file
 xano function edit <function_id> -f new.xs --edit       # Open in $EDITOR before updating
 cat function.xs | xano function edit <function_id> --stdin  # Update from stdin
 xano function edit <function_id> --no-publish           # Edit without publishing
+
+# Run (execute) a function by name
+xano function run <name>                                # Prompts for declared inputs (on a TTY)
+xano function run <name> --data email=jo@x.com --data age:=30 --data active:=true
+xano function run <name> --json @payload.json --data env=staging   # base payload + override
+echo '{"email":"jo@x.com"}' | xano function run <name> --stdin -o json | jq .result
+xano function run <name> --branch dev --logs            # run on a branch, show execution logs
 ```
 
+Input flexibility for `function run` (assembled into one JSON `input` object):
+
+| Form | Meaning |
+| --- | --- |
+| `--data key=value` | string field |
+| `--data key:=<json>` | raw JSON field (`age:=30`, `active:=true`, `tags:='["a","b"]'`) |
+| `--data key@file` | field value read from a file |
+| `--json '<inline>'` / `--json @file.json` / `--json -` | a base JSON object (stdin with `-`) |
+| `--stdin` | read the JSON object from stdin (same as `--json -`) |
+
+Merge order is JSON base first, then `--data` overrides. Missing required inputs are
+prompted for on an interactive terminal; in a non-TTY (CI) context the command fails
+listing them. Output defaults to the raw `result` (`-o json`); the exit code is non-zero
+when the function returns an error status.
+
+> **Permissions:** running a function requires **Function** (read) plus the **run/debug**
+> action on your workspace role. If your access token's role lacks run/debug, the call is
+> denied with an access error — grant run/debug to the role (or use a token whose role has
+> it). `function list`/`get`/`create`/`edit` only need the Function permission.
+
 ### Releases
 
 All release commands use **release names** (e.g., `v1.0`), not IDs.
@@ -326,6 +353,7 @@ xano unit_test list --branch dev --obj-type function
 
 # Run a single unit test
 xano unit_test run <unit_test_id>
+xano unit_test run <unit_test_id> --branch dev   # run the test from a specific branch
 
 # Run all unit tests
 xano unit_test run_all

package/dist/commands/function/run/index.d.ts

@@ -0,0 +1,40 @@
+import BaseCommand from '../../../base-command.js';
+export default class FunctionRun extends BaseCommand {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        data: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        json: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        logs: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'no-input-check': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        stdin: 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>;
+    private emitResult;
+    /**
+     * Fetch a single function record by name via the list endpoint's search,
+     * returning the exact-name match (so `calc` doesn't accidentally match
+     * `calcScore`). Best-effort: returns undefined and warns on any failure so a
+     * transient introspection problem never blocks an otherwise-valid run.
+     */
+    private fetchFunctionByName;
+    /**
+     * Prompt for each missing required input on an interactive TTY. Values are
+     * read as raw JSON when they parse as such (so numbers/bools/objects work),
+     * otherwise treated as a string — mirroring the `key:=`/`key=` distinction.
+     * Non-TTY: fail fast with the list of missing params (never hang on a prompt).
+     */
+    private promptForMissing;
+    private readStdinSync;
+    private resolveWorkspaceId;
+}

package/dist/commands/function/run/index.js

@@ -0,0 +1,244 @@
+import { Args, Flags } from '@oclif/core';
+import { readFileSync } from 'node:fs';
+import BaseCommand from '../../../base-command.js';
+import { assembleInput, loadJsonSource, parseDataPairs, validateAgainstSchema, } from '../../../utils/function-input.js';
+export default class FunctionRun extends BaseCommand {
+    static args = {
+        name: Args.string({
+            description: 'Name of the function to run (interactive if omitted with --name unset)',
+            required: false,
+        }),
+    };
+    static description = 'Run (execute) a named function in a workspace and print its result';
+    static examples = [
+        `$ xano function:run calcScore -w 40
+# Prompts for any declared inputs, then runs the function`,
+        `$ xano function:run calcScore --data email=jo@x.com --data age:=30 --data active:=true`,
+        `$ xano function:run calcScore --json @payload.json --data env=staging`,
+        `$ echo '{"email":"jo@x.com"}' | xano function:run calcScore --stdin -o json | jq .result`,
+        `$ xano function:run calcScore --branch dev --logs`,
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        branch: Flags.string({
+            description: 'Branch to run from (defaults to profile branch, then main)',
+            required: false,
+        }),
+        data: Flags.string({
+            char: 'd',
+            description: 'Input field as key=value (string), key:=json (raw JSON), or key@file (file contents). Repeatable.',
+            multiple: true,
+            required: false,
+        }),
+        json: Flags.string({
+            description: "Input as a JSON object: inline, @file.json, or '-' for stdin",
+            exclusive: ['stdin'],
+            required: false,
+        }),
+        logs: Flags.boolean({
+            default: false,
+            description: 'Print the execution logs returned by the debugger',
+            required: false,
+        }),
+        'name': Flags.string({
+            char: 'n',
+            description: 'Name of the function to run (alternative to the positional argument)',
+            required: false,
+        }),
+        'no-input-check': Flags.boolean({
+            default: false,
+            description: 'Skip local schema validation and interactive prompting; send the payload as-is',
+            required: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            default: 'json',
+            description: 'Output format',
+            options: ['json', 'summary'],
+            required: false,
+        }),
+        stdin: Flags.boolean({
+            char: 's',
+            default: false,
+            description: "Read the input JSON object from stdin (same as --json -)",
+            exclusive: ['json'],
+            required: false,
+        }),
+        workspace: Flags.string({
+            char: 'w',
+            description: 'Workspace ID (optional if set in profile)',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(FunctionRun);
+        const { profile, profileName } = this.resolveProfile(flags);
+        const functionName = args.name ?? flags.name;
+        if (!functionName) {
+            this.error('A function name is required. Provide it as an argument or with --name.');
+        }
+        const workspaceId = this.resolveWorkspaceId(flags, profile, profileName);
+        const branch = flags.branch ?? profile.branch ?? '';
+        // 1) Assemble the input object from JSON base + --data overrides.
+        const jsonSource = flags.stdin ? '-' : flags.json;
+        const jsonBase = loadJsonSource(jsonSource, { stdin: () => this.readStdinSync() });
+        let input = assembleInput({ dataPairs: parseDataPairs(flags.data ?? []), jsonBase });
+        // 2) Introspect the function's declared inputs (best-effort) to validate,
+        //    warn on obvious mismatches, and prompt for missing required params.
+        if (!flags['no-input-check']) {
+            const fn = await this.fetchFunctionByName({
+                branch,
+                name: functionName,
+                profile,
+                verbose: flags.verbose,
+                workspaceId,
+            });
+            const schema = fn?.input;
+            const { missingRequired, warnings } = validateAgainstSchema(input, schema);
+            for (const w of warnings)
+                this.warn(w);
+            if (missingRequired.length > 0) {
+                input = await this.promptForMissing(input, missingRequired);
+            }
+        }
+        // 3) Execute via the meta run endpoint.
+        const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/function/run`;
+        const body = { input, name: functionName };
+        if (branch)
+            body.branch = branch;
+        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 run function');
+            this.error(message);
+        }
+        const result = (await response.json());
+        this.emitResult(result, flags.output, flags.logs);
+        // 4) Compose in scripts/CI: non-zero exit when the function errored.
+        if (result.status && result.status !== 'ok') {
+            this.exit(1);
+        }
+    }
+    emitResult(result, output, showLogs) {
+        if (output === 'json') {
+            // Raw result object so `| jq .result` works predictably.
+            this.log(JSON.stringify(result.result ?? null, null, 2));
+        }
+        else {
+            const status = result.status ?? 'ok';
+            this.log(`Status: ${status}`);
+            this.log('Result:');
+            this.log(JSON.stringify(result.result ?? null, null, 2));
+        }
+        if (showLogs && Array.isArray(result.logs) && result.logs.length > 0) {
+            this.log('');
+            this.log('Logs:');
+            for (const entry of result.logs) {
+                this.log(typeof entry === 'string' ? entry : JSON.stringify(entry));
+            }
+        }
+    }
+    /**
+     * Fetch a single function record by name via the list endpoint's search,
+     * returning the exact-name match (so `calc` doesn't accidentally match
+     * `calcScore`). Best-effort: returns undefined and warns on any failure so a
+     * transient introspection problem never blocks an otherwise-valid run.
+     */
+    async fetchFunctionByName(opts) {
+        const { branch, name, profile, verbose, workspaceId } = opts;
+        // eslint-disable-next-line camelcase -- external Metadata API query param
+        const params = new URLSearchParams({ per_page: '100', search: name });
+        if (branch)
+            params.set('branch', branch);
+        const url = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/function?${params.toString()}`;
+        try {
+            const response = await this.verboseFetch(url, { headers: { accept: 'application/json', Authorization: `Bearer ${profile.access_token}` }, method: 'GET' }, verbose, profile.access_token);
+            if (!response.ok)
+                return undefined;
+            const page = (await response.json());
+            const items = Array.isArray(page) ? page : (page.items ?? []);
+            const exact = items.filter((f) => f.name === name);
+            if (exact.length > 1) {
+                this.warn(`Multiple functions named '${name}' found; skipping input validation.`);
+                return undefined;
+            }
+            return exact[0];
+        }
+        catch {
+            // Introspection is a convenience, not a requirement.
+            return undefined;
+        }
+    }
+    /**
+     * Prompt for each missing required input on an interactive TTY. Values are
+     * read as raw JSON when they parse as such (so numbers/bools/objects work),
+     * otherwise treated as a string — mirroring the `key:=`/`key=` distinction.
+     * Non-TTY: fail fast with the list of missing params (never hang on a prompt).
+     */
+    async promptForMissing(input, missing) {
+        if (!process.stdout.isTTY || !process.stdin.isTTY) {
+            const names = missing.map((p) => `${p.name}${p.type ? ` (${p.type})` : ''}`).join(', ');
+            this.error(`Missing required input: ${names}. ` +
+                `Provide via --data/--json, or run interactively in a terminal.`);
+        }
+        const readline = await import('node:readline');
+        const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+        const ask = (message) => new Promise((resolve) => {
+            rl.question(message, resolve);
+        });
+        const filled = { ...input };
+        try {
+            for (const param of missing) {
+                const hint = [param.type, param.description].filter(Boolean).join(' — ');
+                // eslint-disable-next-line no-await-in-loop
+                const raw = await ask(`${param.name}${hint ? ` (${hint})` : ''}: `);
+                filled[param.name] = coercePromptValue(raw, param);
+            }
+        }
+        finally {
+            rl.close();
+        }
+        return filled;
+    }
+    readStdinSync() {
+        // Synchronous read of all of stdin (fd 0); used for --json - / --stdin.
+        try {
+            return readFileSync(0, 'utf8');
+        }
+        catch (error) {
+            this.error(`Failed to read from stdin: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    resolveWorkspaceId(flags, profile, profileName) {
+        if (flags.workspace)
+            return flags.workspace;
+        if (profile.workspace)
+            return profile.workspace;
+        this.error(`Workspace ID is required. Either:\n` +
+            `  1. Provide it as a flag: xano function:run <name> -w <workspace_id>\n` +
+            `  2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
+    }
+}
+/**
+ * Coerce a prompted string into the value the parameter likely expects. Non-text
+ * params attempt a JSON parse (so `30`, `true`, `["a"]` become typed values);
+ * text params keep the raw string. Falls back to the raw string on parse errors.
+ */
+function coercePromptValue(raw, param) {
+    const isTextLike = !param.type || param.type === 'text' || param.type === 'uuid';
+    if (isTextLike)
+        return raw;
+    try {
+        return JSON.parse(raw);
+    }
+    catch {
+        return raw;
+    }
+}

package/dist/commands/tenant/unit_test/run/index.d.ts

@@ -6,6 +6,7 @@ export default class TenantUnitTestRun extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
+        branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         tenant: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;

package/dist/commands/tenant/unit_test/run/index.js

@@ -17,6 +17,11 @@ Result: PASS
     ];
     static flags = {
         ...BaseCommand.baseFlags,
+        branch: Flags.string({
+            char: 'b',
+            description: 'Branch the unit test belongs to (uses profile branch if not provided, then the live branch)',
+            required: false,
+        }),
         output: Flags.string({
             char: 'o',
             default: 'summary',
@@ -43,12 +48,14 @@ Result: PASS
             this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
         }
         const tenantName = encodeURIComponent(flags.tenant);
+        const branch = flags.branch ?? profile.branch;
         const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/unit_test/${encodeURIComponent(args.unit_test_id)}/run`;
         try {
             if (flags.output === 'summary') {
                 this.log(`Running unit test ${args.unit_test_id}...`);
             }
             const response = await this.verboseFetch(apiUrl, {
+                body: JSON.stringify(branch ? { branch } : {}),
                 headers: {
                     accept: 'application/json',
                     Authorization: `Bearer ${profile.access_token}`,

package/dist/commands/tenant/unit_test/run_all/index.js

@@ -18,7 +18,7 @@ Results: 4 passed, 1 failed
         ...BaseCommand.baseFlags,
         branch: Flags.string({
             char: 'b',
-            description: 'Filter by branch name',
+            description: 'Branch to run tests from (uses profile branch if not provided, then the live branch)',
             required: false,
         }),
         'obj-type': Flags.string({
@@ -53,11 +53,14 @@ Results: 4 passed, 1 failed
         }
         const tenantName = encodeURIComponent(flags.tenant);
         const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/unit_test`;
+        // Resolve the branch once so the listed tests and the tests we run come
+        // from the same branch.
+        const branch = flags.branch ?? profile.branch;
         try {
             const listParams = new URLSearchParams();
             listParams.set('per_page', '10000');
-            if (flags.branch)
-                listParams.set('branch', flags.branch);
+            if (branch)
+                listParams.set('branch', branch);
             if (flags['obj-type'])
                 listParams.set('obj_type', flags['obj-type']);
             const listResponse = await this.verboseFetch(`${baseUrl}?${listParams}`, {
@@ -94,6 +97,7 @@ Results: 4 passed, 1 failed
                 const runUrl = `${baseUrl}/${test.id}/run`;
                 try {
                     const runResponse = await this.verboseFetch(runUrl, {
+                        body: JSON.stringify(branch ? { branch } : {}),
                         headers: {
                             accept: 'application/json',
                             Authorization: `Bearer ${profile.access_token}`,

package/dist/commands/unit_test/run/index.d.ts

@@ -6,6 +6,7 @@ export default class UnitTestRun extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
+        branch: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;

package/dist/commands/unit_test/run/index.js

@@ -14,9 +14,15 @@ Running unit test abc-123...
 Result: PASS
 `,
         `$ xano unit-test run abc-123 -o json`,
+        `$ xano unit-test run abc-123 --branch dev`,
     ];
     static flags = {
         ...BaseCommand.baseFlags,
+        branch: Flags.string({
+            char: 'b',
+            description: 'Branch the unit test belongs to (uses profile branch if not provided, then the live branch)',
+            required: false,
+        }),
         output: Flags.string({
             char: 'o',
             default: 'summary',
@@ -37,12 +43,14 @@ Result: PASS
         if (!workspaceId) {
             this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
         }
+        const branch = flags.branch ?? profile.branch;
         const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/unit_test/${args.unit_test_id}/run`;
         try {
             if (flags.output === 'summary') {
                 this.log(`Running unit test ${args.unit_test_id}...`);
             }
             const response = await this.verboseFetch(apiUrl, {
+                body: JSON.stringify(branch ? { branch } : {}),
                 headers: {
                     'accept': 'application/json',
                     'Authorization': `Bearer ${profile.access_token}`,

package/dist/commands/unit_test/run_all/index.js

@@ -19,7 +19,7 @@ Results: 2 passed, 1 failed
         ...BaseCommand.baseFlags,
         branch: Flags.string({
             char: 'b',
-            description: 'Filter by branch name',
+            description: 'Branch to run tests from (uses profile branch if not provided, then the live branch)',
             required: false,
         }),
         'obj-type': Flags.string({
@@ -48,12 +48,15 @@ Results: 2 passed, 1 failed
             this.error('No workspace ID provided. Use --workspace flag or set one in your profile.');
         }
         const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/unit_test`;
+        // Resolve the branch once so the listed tests and the tests we run come
+        // from the same branch.
+        const branch = flags.branch ?? profile.branch;
         try {
             // Step 1: List all unit tests
             const listParams = new URLSearchParams();
             listParams.set('per_page', '10000');
-            if (flags.branch) {
-                listParams.set('branch', flags.branch);
+            if (branch) {
+                listParams.set('branch', branch);
             }
             if (flags['obj-type']) {
                 listParams.set('obj_type', flags['obj-type']);
@@ -93,6 +96,7 @@ Results: 2 passed, 1 failed
                 const runUrl = `${baseUrl}/${test.id}/run`;
                 try {
                     const runResponse = await this.verboseFetch(runUrl, {
+                        body: JSON.stringify(branch ? { branch } : {}),
                         headers: {
                             accept: 'application/json',
                             Authorization: `Bearer ${profile.access_token}`,

package/dist/utils/function-input.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Input assembly for `xano function run`.
+ *
+ * A run's `input` is a single JSON object sent to the Metadata API. Users can
+ * build that object from several sources, which this module normalizes and
+ * merges:
+ *
+ *   --json <inline | @file | ->   a base JSON object
+ *   --data key=value              a string field (httpie convention)
+ *   --data key:=<json>            a raw-JSON field (numbers, bools, arrays, ...)
+ *   --data key@<file>             a field whose value is a file's contents (string)
+ *
+ * Merge order is: JSON base first, then --data pairs override — so the common
+ * "reuse a payload file, tweak one field" flow works without editing the file.
+ *
+ * Everything here is pure and free of oclif/network deps so it is unit-testable
+ * in isolation; the command layer handles fetching, prompting and output.
+ */
+export type JsonObject = Record<string, unknown>;
+/** A single declared function input parameter, as returned by the meta API. */
+export interface FunctionInputParam {
+    children?: FunctionInputParam[];
+    default?: unknown;
+    description?: string;
+    name: string;
+    nullable?: boolean;
+    required?: boolean;
+    style?: {
+        type?: string;
+    };
+    type?: string;
+    values?: unknown[];
+}
+/**
+ * Split a `--data` token into its key, operator and value.
+ * Recognizes, in priority order: `:=` (raw json), `@` (file), `=` (string).
+ * The operator is the FIRST occurrence scanned left-to-right, but `:=` is
+ * detected before a bare `=` at the same position so `k:=1` is raw-json, not
+ * a string key `k:` set to `=1`.
+ */
+export declare function splitDataToken(token: string): {
+    key: string;
+    op: ':=' | '=' | '@';
+    value: string;
+};
+/**
+ * Parse `--data` tokens into an object, applying httpie-style typing.
+ * Later tokens override earlier ones with the same key.
+ */
+export declare function parseDataPairs(pairs: string[], readFile?: (p: string) => string): JsonObject;
+/**
+ * Load the `--json` source: inline JSON, `@file`, or `-` (stdin, supplied by
+ * the caller via `stdin`). Must parse to a plain object; arrays/scalars are
+ * rejected because a function's input is always a keyed object.
+ */
+export declare function loadJsonSource(source: string | undefined, opts?: {
+    readFile?: (p: string) => string;
+    stdin?: () => string;
+}): JsonObject | undefined;
+/**
+ * Merge a JSON base with --data overrides into the final input object.
+ * Precedence: base first, then dataPairs override (shallow).
+ */
+export declare function assembleInput(opts: {
+    dataPairs?: JsonObject;
+    jsonBase?: JsonObject;
+}): JsonObject;
+/**
+ * Validate a supplied input object against a function's declared input schema.
+ * Non-destructive: returns lists the caller can act on (prompt for missing
+ * required params on a TTY, warn on enum mismatches, etc.). The server remains
+ * the source of truth, so type mismatches are warnings, not hard failures.
+ */
+export declare function validateAgainstSchema(input: JsonObject, schema: FunctionInputParam[] | undefined): {
+    missingRequired: FunctionInputParam[];
+    warnings: string[];
+};