npm - @revoengine/cli - Versions diffs - 1.0.0 - Mend

@revoengine/cli 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

package/README.md +211 -0
package/dist/bin/revo.d.ts +2 -0
package/dist/bin/revo.js +19 -0
package/dist/src/cli.d.ts +3 -0
package/dist/src/cli.js +213 -0
package/dist/src/client.d.ts +72 -0
package/dist/src/client.js +315 -0
package/dist/src/commands/auth.d.ts +2 -0
package/dist/src/commands/auth.js +131 -0
package/dist/src/commands/component.d.ts +2 -0
package/dist/src/commands/component.js +905 -0
package/dist/src/commands/endpoints.d.ts +2 -0
package/dist/src/commands/endpoints.js +4 -0
package/dist/src/commands/index.d.ts +7 -0
package/dist/src/commands/index.js +7 -0
package/dist/src/commands/info.d.ts +2 -0
package/dist/src/commands/info.js +6 -0
package/dist/src/commands/project.d.ts +2 -0
package/dist/src/commands/project.js +80 -0
package/dist/src/commands/request.d.ts +2 -0
package/dist/src/commands/request.js +59 -0
package/dist/src/commands/search.d.ts +2 -0
package/dist/src/commands/search.js +22 -0
package/dist/src/config.d.ts +54 -0
package/dist/src/config.js +356 -0
package/dist/src/index.d.ts +4 -0
package/dist/src/index.js +4 -0
package/dist/src/legacy.d.ts +8 -0
package/dist/src/legacy.js +88 -0
package/dist/src/project.d.ts +102 -0
package/dist/src/project.js +475 -0
package/dist/src/prompt.d.ts +4 -0
package/dist/src/prompt.js +64 -0
package/dist/src/runtime-view.d.ts +17 -0
package/dist/src/runtime-view.js +80 -0
package/dist/src/spinner.d.ts +14 -0
package/dist/src/spinner.js +46 -0
package/dist/src/types.d.ts +36 -0
package/dist/src/types.js +1 -0
package/dist/src/ui.d.ts +26 -0
package/dist/src/ui.js +182 -0
package/dist/src/utils.d.ts +10 -0
package/dist/src/utils.js +86 -0
package/package.json +32 -0
package/tsconfig.build.json +15 -0
package/tsconfig.json +19 -0

package/README.md ADDED Viewed

@@ -0,0 +1,211 @@
+# @revoengine/cli
+Official CLI for RevoEngine Platform.
+## Install
+```bash
+npm install -g @revoengine/cli
+```
+The package installs two binaries:
+- `revo` is the primary documented command.
+- `revoengine` is kept as a compatible alias.
+## Quick start
+Inspect the local runtime and config path:
+```bash
+revo -i
+```
+Log in and save your default credentials:
+```bash
+revo auth login
+```
+`revo auth login` opens an interactive terminal prompt for your API key and instance ID. If you are already logged in, the CLI warns and asks you to `revo auth logout` first.
+Check the active session:
+```bash
+revo auth status
+```
+Remove stored credentials:
+```bash
+revo auth logout
+```
+Show the command reference:
+```bash
+revo --help
+```
+Initialize a project for ambient low-code editor globals:
+```bash
+revo project
+revo project init ./app
+revo project switch a931e927-738d-42a4-b486-5fc19bfb3dfb
+```
+This writes `.revoengine/types/revo.editor.d.ts`, `.revoengine/revo.json`, patches `tsconfig.json` or `jsconfig.json`, and updates `.gitignore` so the generated type bundle stays local by default. `revo project switch <instanceId>` rebinds the current project to another stored instance and refreshes the ambient editor types for that instance.
+## Common commands
+```bash
+revo endpoints
+revo project ./app
+revo search CODE button
+revo search SIMPLE customer
+revo request GET /api/component/list
+revo request POST /api/component "{\"name\":\"Customer Card\"}"
+```
+`revo search` accepts only two search types:
+- `CODE` searches code references.
+- `SIMPLE` searches everything.
+`revo request` accepts an optional positional `<BODY>` argument as a JSON string. The existing `--body` / `-d` flag still works as well.
+## Component sync
+Pull one or more components by id:
+```bash
+revo component pull 6dfb536a-1111-4222-8333-123456789abc
+revo component pull 6dfb536a-1111-4222-8333-123456789abc 7afc7b98-4444-4555-8666-abcdefabcdef
+```
+Pull every available component:
+```bash
+revo component pull --all
+revo component pull --all --force
+```
+Pull one or more remote components:
+```bash
+revo component pull 6dfb536a-1111-4222-8333-123456789abc
+revo component pull 6dfb536a-1111-4222-8333-123456789abc --stale
+revo component pull --all
+revo component pull --all --stale
+revo component pull --all --force
+```
+Push one or more local components:
+```bash
+revo component push 6dfb536a-1111-4222-8333-123456789abc
+revo component push --all
+revo component push --all --force
+```
+Debug one local component in sandbox:
+```bash
+revo component debug 6dfb536a-1111-4222-8333-123456789abc
+revo component debug 6dfb536a-1111-4222-8333-123456789abc -d '{"filters":{}}'
+revo component debug 6dfb536a-1111-4222-8333-123456789abc --timeout 30 --memory 256
+```
+Pulled components are stored as a tree:
+```text
+Components/
+  Forms/
+    Customer_Card-6dfb536a-1111-4222-8333-123456789abc/
+      component.json
+      elements/
+        1_template.ts
+        2_logic.ts
+```
+Each component folder keeps its `component.json` manifest alongside an `elements/` directory with the source payload for every element.
+Components with `category: null` are stored under `Components/__no_category__/...` while the manifest keeps `"category": null`.
+Bulk sync behavior:
+- `revo component pull --all` and `revo component push --all` require terminal confirmation unless `--force` is passed.
+- Pull compares the full local workspace contract before overwriting anything.
+- Pull skips with `no changes` when the local workspace already matches the remote component.
+- Pull skips with `changed` when local files differ from the remote contract.
+- Pull skips with `stale version` when the local version is older than the remote version, unless `--stale` or `--force` is passed.
+- Push treats backend `Not modified` responses as skipped instead of failing the whole run.
+- Debug posts the local `component.json` plus `elements/{order}_{key}.{js|ts}` source files to the instance sandbox `debug` endpoint.
+- Sync logs show direction explicitly: `RevoEngine -> path` for pull and `RevoEngine <- path` for push.
+- Bulk runs print a summary such as `Deployed 54/67, Skipped 13/67 in 13s`.
+## Configuration
+The CLI reads configuration in this order:
+1. CLI flags such as `--url`, `--instance`, and `--token`
+2. Environment variables such as `REVO_URL`, `REVO_INSTANCE`, and `REVO_TOKEN`
+3. Stored config in the OS config directory
+This means environment variables override the locally stored config, which is the intended setup for CI and non-interactive automation.
+Use `--url` for one-off local or dedicated API targets:
+```bash
+revo --url https://api.test.revong.com -i
+revo --url https://api.test.revong.com auth login --instance a931e927-738d-42a4-b486-5fc19bfb3dfb
+revo --url https://api.revoengine.com endpoints
+```
+Use environment variables for CI/CD or shell profiles:
+```bash
+# TEST
+export REVO_URL="https://api.test.revong.com"
+export REVO_INSTANCE="a931e927-738d-42a4-b486-5fc19bfb3dfb"
+export REVO_TOKEN="your-test-token"
+revo endpoints
+# PROD
+export REVO_URL="https://api.revoengine.com"
+export REVO_INSTANCE="a931e927-738d-42a4-b486-5fc19bfb3dfb"
+export REVO_TOKEN="your-prod-token"
+revo endpoints
+```
+Supported environment variables:
+- `REVO_URL` or `REVO_BASE_URL`
+- `REVO_INSTANCE`
+- `REVO_TOKEN` or `REVO_API_KEY`
+- `REVOENGINE_URL` or `REVOENGINE_BASE_URL`
+- `REVOENGINE_INSTANCE`
+- `REVOENGINE_TOKEN` or `REVOENGINE_API_KEY`
+Example for CI:
+```bash
+export REVO_URL="https://api.revoengine.com"
+export REVO_INSTANCE="a931e927-738d-42a4-b486-5fc19bfb3dfb"
+export REVO_TOKEN="your-ci-token"
+revo endpoints
+```
+Stored config lives in:
+- macOS and Linux: `~/.config/revoengine`
+- Windows: `%APPDATA%/revoengine`
+## Local development
+```bash
+npm install
+npm run check
+npm test
+node ./bin/revo.ts --help
+```

package/dist/bin/revo.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ #!/usr/bin/env node
2	+ export {};

package/dist/bin/revo.js ADDED Viewed

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import { realpathSync } from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { main } from "../src/cli.js";
+function isDirectExecution() {
+    try {
+        return Boolean(process.argv[1] && import.meta.url === pathToFileURL(realpathSync(process.argv[1])).href);
+    }
+    catch {
+        return false;
+    }
+}
+if (isDirectExecution()) {
+    main().catch((error) => {
+        const message = error instanceof Error ? error.message : String(error);
+        process.stderr.write(`${message}\n`);
+        process.exitCode = 1;
+    });
+}

package/dist/src/cli.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import type { ParsedArgs } from './types.ts';
+export declare function parseArgs(argv: string[]): ParsedArgs;
+export declare function main(argv?: string[]): Promise<void>;

package/dist/src/cli.js ADDED Viewed

@@ -0,0 +1,213 @@
+import { realpathSync } from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { RevoClient } from "./client.js";
+import { resolveRuntimeConfig } from "./config.js";
+import { handleAuthCommand, handleComponentCommand, handleEndpointsCommand, handleInfoCommand, handleProjectCommand, handleRequestCommand, handleSearchCommand, } from "./commands/index.js";
+import { buildRuntimeViewModel } from "./runtime-view.js";
+import { renderHelp, renderOverview } from "./ui.js";
+import { readPackageVersion } from "./utils.js";
+const packageVersion = readPackageVersion();
+const ANSI = {
+    reset: '\u001b[0m',
+    red: '\u001b[31m',
+};
+function color(text, code) {
+    return process.stdout.isTTY || process.env.FORCE_COLOR ? `${code}${text}${ANSI.reset}` : text;
+}
+function danger(text) {
+    return color(text, ANSI.red);
+}
+function isDirectExecution() {
+    try {
+        return Boolean(process.argv[1] && import.meta.url === pathToFileURL(realpathSync(process.argv[1])).href);
+    }
+    catch {
+        return false;
+    }
+}
+export function parseArgs(argv) {
+    const result = { _: [] };
+    let stopOptions = false;
+    const setValue = (key, value) => {
+        const current = result[key];
+        if (current === undefined) {
+            result[key] = value;
+            return;
+        }
+        if (typeof current === 'boolean') {
+            result[key] = typeof value === 'boolean' ? current || value : value;
+            return;
+        }
+        if (typeof value === 'boolean') {
+            result[key] = current;
+            return;
+        }
+        result[key] = Array.isArray(current) ? [...current, value] : [current, value];
+    };
+    const isValueToken = (value) => {
+        if (!value || value === '--') {
+            return false;
+        }
+        return value === '-' || !value.startsWith('-') || /^-\d+(\.\d+)?$/.test(value);
+    };
+    for (let index = 0; index < argv.length; index += 1) {
+        const arg = argv[index];
+        if (stopOptions || arg === '-' || !arg.startsWith('-')) {
+            result._.push(arg);
+            continue;
+        }
+        if (arg === '--') {
+            stopOptions = true;
+            continue;
+        }
+        if (arg.startsWith('--')) {
+            const body = arg.slice(2);
+            if (body.startsWith('no-') && body.length > 3) {
+                setValue(body.slice(3), false);
+                continue;
+            }
+            const equalsIndex = body.indexOf('=');
+            if (equalsIndex !== -1) {
+                setValue(body.slice(0, equalsIndex), body.slice(equalsIndex + 1));
+                continue;
+            }
+            const next = argv[index + 1];
+            if (isValueToken(next)) {
+                setValue(body, next);
+                index += 1;
+                continue;
+            }
+            setValue(body, true);
+            continue;
+        }
+        const body = arg.slice(1);
+        const equalsIndex = body.indexOf('=');
+        if (equalsIndex !== -1) {
+            const keys = body.slice(0, equalsIndex).split('').filter(Boolean);
+            const value = body.slice(equalsIndex + 1);
+            if (keys.length === 0) {
+                continue;
+            }
+            for (const key of keys.slice(0, -1)) {
+                setValue(key, true);
+            }
+            setValue(keys[keys.length - 1], value);
+            continue;
+        }
+        if (body.length > 1) {
+            const next = argv[index + 1];
+            if (isValueToken(next)) {
+                for (const key of body.slice(0, -1)) {
+                    setValue(key, true);
+                }
+                setValue(body[body.length - 1], next);
+                index += 1;
+                continue;
+            }
+            for (const key of body) {
+                setValue(key, true);
+            }
+            continue;
+        }
+        const key = body;
+        const next = argv[index + 1];
+        if (!isValueToken(next)) {
+            setValue(key, true);
+            continue;
+        }
+        setValue(key, next);
+        index += 1;
+    }
+    return result;
+}
+function print(value) {
+    if (typeof value === 'string') {
+        process.stdout.write(`${value}\n`);
+        return;
+    }
+    process.stdout.write(`${JSON.stringify(value, null, 2)}\n`);
+}
+function println(message) {
+    process.stdout.write(`${message}\n`);
+}
+function printError(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    process.stderr.write(`${danger('Error:')} ${message}\n`);
+}
+function resolveClient(args) {
+    const runtime = resolveRuntimeConfig({
+        baseUrl: typeof args.url === 'string' ? args.url : typeof args.baseUrl === 'string' ? args.baseUrl : undefined,
+        instance: typeof args.instance === 'string' ? args.instance : typeof args.i === 'string' ? args.i : undefined,
+        token: typeof args.token === 'string' ? args.token : typeof args.t === 'string' ? args.t : undefined,
+    });
+    return new RevoClient(runtime);
+}
+function createContext(args) {
+    const client = resolveClient(args);
+    return {
+        args,
+        client,
+        cwd: process.cwd(),
+        packageVersion,
+        print,
+        println,
+        error: (message) => printError(new Error(message)),
+    };
+}
+function printHelp() {
+    print(renderHelp(packageVersion));
+}
+export async function main(argv = process.argv.slice(2)) {
+    const args = parseArgs(argv);
+    const command = args._[0];
+    const noPositionals = args._.length === 0;
+    if (command === 'version' || ((args.version !== undefined || args.V !== undefined) && noPositionals)) {
+        print(packageVersion);
+        return;
+    }
+    if (command === 'info' || ((args.i === true || args.info === true) && noPositionals)) {
+        await handleInfoCommand(createContext(args));
+        return;
+    }
+    if (command === 'help' || ((args.help !== undefined || args.h !== undefined) && noPositionals)) {
+        printHelp();
+        return;
+    }
+    const context = createContext(args);
+    if (!command) {
+        const view = await buildRuntimeViewModel(context);
+        print(renderOverview(view));
+        return;
+    }
+    if (command === 'auth') {
+        await handleAuthCommand(context);
+        return;
+    }
+    if (command === 'component') {
+        await handleComponentCommand(context);
+        return;
+    }
+    if (command === 'endpoints') {
+        await handleEndpointsCommand(context);
+        return;
+    }
+    if (command === 'project') {
+        await handleProjectCommand(context);
+        return;
+    }
+    if (command === 'search') {
+        await handleSearchCommand(context);
+        return;
+    }
+    if (command === 'request') {
+        await handleRequestCommand(context);
+        return;
+    }
+    throw new Error(`Unknown command: ${command}`);
+}
+if (isDirectExecution()) {
+    main().catch((error) => {
+        printError(error);
+        process.exitCode = 1;
+    });
+}

package/dist/src/client.d.ts ADDED Viewed

@@ -0,0 +1,72 @@
+export type RequestOptions = {
+    query?: Record<string, unknown>;
+    body?: unknown;
+    headers?: HeadersInit;
+    authGuard?: boolean;
+    spinnerLabel?: string;
+};
+export type ComponentListRequest = {
+    path?: string;
+    query?: Record<string, unknown>;
+};
+export type ClientOptions = {
+    baseUrl?: string;
+    instance?: string;
+    token?: string;
+    fetch?: typeof fetch;
+};
+export type ApiResponse<T = unknown> = {
+    status: number;
+    ok: boolean;
+    data: T;
+    headers: Headers;
+};
+export declare class ApiError extends Error {
+    status: number;
+    data: unknown;
+    constructor(status: number, message: string, data: unknown);
+}
+export declare class AuthenticationError extends ApiError {
+    constructor(status: number, message: string, data: unknown);
+}
+export declare class PermissionDeniedError extends ApiError {
+    path: string;
+    constructor(path: string, message: string, data: unknown);
+}
+declare function buildUrl(baseUrl: string, requestPath: string, query?: Record<string, unknown>): URL;
+declare function normalizeToken(token?: string): string;
+export declare class RevoClient {
+    baseUrl: string;
+    instance: string;
+    token: string;
+    fetchImpl: typeof fetch | undefined;
+    constructor(options?: ClientOptions);
+    get authHeader(): string;
+    get authValidationKey(): string;
+    assertReady(): void;
+    validateSession(options?: {
+        force?: boolean;
+    }): Promise<{
+        authenticated: boolean;
+        fromCache: true;
+        profile: {} | null;
+    } | {
+        authenticated: boolean;
+        fromCache: false;
+        profile: unknown;
+    }>;
+    request(method: string, path: string, options?: RequestOptions): Promise<ApiResponse>;
+    requestData<T = unknown>(method: string, path: string, options?: RequestOptions): Promise<T>;
+    me(options?: {
+        force?: boolean;
+    }): Promise<unknown>;
+    listEndpoints(): Promise<unknown>;
+    getEditorTypes(requestPath?: string): Promise<unknown>;
+    debugComponent(requestPath: string, body: unknown): Promise<unknown>;
+    search(params: Record<string, unknown>): Promise<unknown>;
+    listComponents(options?: ComponentListRequest): Promise<unknown>;
+    getComponent(componentId: string): Promise<unknown>;
+    createComponent(body: Record<string, unknown>): Promise<ApiResponse<unknown>>;
+    saveComponentElements(componentId: string, body: unknown): Promise<ApiResponse<unknown>>;
+}
+export { buildUrl, normalizeToken };