@embeddables/cli 0.8.0 → 0.8.1

package/dist/commands/build.js

@@ -0,0 +1,60 @@
+import path from 'node:path';
+import { compileAllPages } from '../compiler/index.js';
+import { formatError } from '../compiler/errors.js';
+import { promptForLocalEmbeddable } from '../prompts/index.js';
+import { captureException, createLogger, exit } from '../logger.js';
+import { getSentryContextFromEmbeddableConfig, getSentryContextFromProjectConfig, setSentryContext, } from '../sentry-context.js';
+import * as stdout from '../stdout.js';
+import { inferEmbeddableFromCwd } from '../helpers/utils.js';
+export async function runBuild(opts) {
+    const logger = createLogger('runBuild');
+    const inferred = inferEmbeddableFromCwd();
+    let embeddableId = opts.id ?? inferred?.embeddableId;
+    if (inferred && !opts.id && embeddableId) {
+        process.chdir(inferred.projectRoot);
+    }
+    setSentryContext(getSentryContextFromProjectConfig());
+    if (!embeddableId) {
+        const selected = await promptForLocalEmbeddable({
+            message: 'Select an embeddable to build:',
+        });
+        if (!selected) {
+            logger.error('no embeddable selected');
+            await exit(1);
+            return;
+        }
+        embeddableId = selected;
+    }
+    if (embeddableId) {
+        setSentryContext({
+            embeddable: { id: embeddableId },
+            ...getSentryContextFromEmbeddableConfig(embeddableId),
+        });
+    }
+    logger.info('build started');
+    const pagesGlob = opts.pages || `embeddables/${embeddableId}/pages/**/*.page.tsx`;
+    const outPath = opts.out || path.join('embeddables', embeddableId, '.generated', 'embeddable.json');
+    const stylesDir = path.join('embeddables', embeddableId, 'styles');
+    const elapsed = stdout.timer();
+    try {
+        await stdout.withSpinner('Building…', async () => {
+            await compileAllPages({
+                pagesGlob,
+                outPath,
+                pageKeyFrom: opts.pageKeyFrom,
+                stylesDir,
+                embeddableId: embeddableId,
+                fixLint: opts.fix ? true : 'prompt',
+            });
+        });
+        stdout.gap();
+        stdout.successBox(`Built in ${elapsed()} ${stdout.symbols.bolt} ${stdout.randomMessage('build')}`);
+    }
+    catch (e) {
+        captureException(e);
+        stdout.error(formatError(e));
+        logger.error('build failed');
+        await exit(1);
+    }
+    logger.info('build complete');
+}

package/dist/commands/builder-open.d.ts

@@ -0,0 +1,4 @@
+export declare function runBuilderOpen(opts: {
+    id?: string;
+}): Promise<void>;
+//# sourceMappingURL=builder-open.d.ts.map

package/dist/commands/builder-open.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder-open.d.ts","sourceRoot":"","sources":["../../src/commands/builder-open.ts"],"names":[],"mappings":"AA0BA,wBAAsB,cAAc,CAAC,IAAI,EAAE;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,iBAgEzD"}

package/dist/commands/builder-open.js

@@ -0,0 +1,74 @@
+import { exec } from 'node:child_process';
+import pc from 'picocolors';
+import { isLoggedIn } from '../auth/index.js';
+import { getProjectId, writeProjectConfig } from '../config/index.js';
+import { promptForProject, promptForLocalEmbeddable } from '../prompts/index.js';
+import { createLogger, exit } from '../logger.js';
+import { getSentryContextFromEmbeddableConfig, getSentryContextFromProjectConfig, setSentryContext, } from '../sentry-context.js';
+import * as stdout from '../stdout.js';
+import { inferEmbeddableFromCwd } from '../helpers/utils.js';
+function openUrl(url) {
+    const platform = process.platform;
+    const cmd = platform === 'darwin' ? 'open' : platform === 'win32' ? 'start' : 'xdg-open';
+    exec(`${cmd} ${JSON.stringify(url)}`, (err) => {
+        if (err) {
+            stdout.warn('Could not open browser automatically. Please open the URL manually.');
+        }
+    });
+}
+export async function runBuilderOpen(opts) {
+    const logger = createLogger('runBuilderOpen');
+    const inferred = inferEmbeddableFromCwd();
+    let embeddableId = opts.id ?? inferred?.embeddableId;
+    if (inferred && !opts.id && embeddableId) {
+        process.chdir(inferred.projectRoot);
+    }
+    setSentryContext(getSentryContextFromProjectConfig());
+    let projectId = getProjectId();
+    if (!projectId) {
+        if (!isLoggedIn()) {
+            stdout.warn('No project configured and not logged in.');
+            stdout.dim('Run "embeddables login" first, or add a project_id to embeddables.json.');
+            logger.error('no project id and not logged in');
+            await exit(1);
+            return;
+        }
+        stdout.step('No project configured. Fetching projects…');
+        const selectedProject = await promptForProject();
+        if (!selectedProject) {
+            logger.error('project selection failed');
+            await exit(1);
+            return;
+        }
+        projectId = selectedProject.id;
+        writeProjectConfig({
+            org_id: selectedProject.org_id || undefined,
+            org_title: selectedProject.org_title || undefined,
+            project_id: projectId,
+            project_name: selectedProject.title || undefined,
+        });
+        stdout.success('Saved project to embeddables.json');
+        stdout.gap();
+    }
+    if (!embeddableId) {
+        const selected = await promptForLocalEmbeddable({
+            message: 'Select an embeddable to open in the Builder:',
+        });
+        if (!selected) {
+            logger.error('no embeddable selected');
+            await exit(1);
+            return;
+        }
+        embeddableId = selected;
+        stdout.gap();
+    }
+    if (embeddableId) {
+        setSentryContext({
+            embeddable: { id: embeddableId },
+            ...getSentryContextFromEmbeddableConfig(embeddableId),
+        });
+    }
+    const url = `https://app.embeddables.com/project/${projectId}/embeddables/${embeddableId}/edit`;
+    stdout.success(`Opening Builder: ${pc.underline(url)}`);
+    openUrl(url);
+}

package/dist/commands/dev.d.ts

@@ -0,0 +1,12 @@
+export declare function runDev(opts: {
+    id?: string;
+    pages?: string;
+    out?: string;
+    fix?: boolean;
+    local?: boolean;
+    engine: string;
+    port: string;
+    overrideRoute: string;
+    pageKeyFrom: 'filename' | 'export';
+}): Promise<void>;
+//# sourceMappingURL=dev.d.ts.map

package/dist/commands/dev.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../../src/commands/dev.ts"],"names":[],"mappings":"AAoHA,wBAAsB,MAAM,CAAC,IAAI,EAAE;IACjC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,UAAU,GAAG,QAAQ,CAAA;CACnC,iBAwJA"}

package/dist/commands/dev.js

@@ -0,0 +1,226 @@
+import fs from 'node:fs';
+import net from 'node:net';
+import path from 'node:path';
+import chokidar from 'chokidar';
+import pc from 'picocolors';
+import { compileAllPages } from '../compiler/index.js';
+import { startProxyServer } from '../proxy/server.js';
+import { formatError } from '../compiler/errors.js';
+import { captureException, createLogger, exit } from '../logger.js';
+import { getSentryContextFromEmbeddableConfig, getSentryContextFromProjectConfig, setSentryContext, } from '../sentry-context.js';
+import * as stdout from '../stdout.js';
+import { inferEmbeddableFromCwd } from '../helpers/utils.js';
+/**
+ * Check whether a port is available by attempting to listen on it.
+ */
+function isPortAvailable(port) {
+    return new Promise((resolve) => {
+        const server = net.createServer();
+        server.once('error', () => resolve(false));
+        server.once('listening', () => {
+            server.close(() => resolve(true));
+        });
+        server.listen(port);
+    });
+}
+/**
+ * Starting from `startPort`, find the first available port.
+ * Tries up to `maxAttempts` consecutive ports.
+ */
+async function getAvailablePort(startPort, maxAttempts = 20) {
+    for (let i = 0; i < maxAttempts; i++) {
+        const port = startPort + i;
+        if (await isPortAvailable(port)) {
+            return port;
+        }
+    }
+    throw new Error(`Could not find an available port (tried ${startPort}–${startPort + maxAttempts - 1})`);
+}
+async function discoverEmbeddables() {
+    const embeddablesDir = 'embeddables';
+    if (!fs.existsSync(embeddablesDir)) {
+        return [];
+    }
+    const entries = fs.readdirSync(embeddablesDir, { withFileTypes: true });
+    const embeddables = [];
+    for (const entry of entries) {
+        if (!entry.isDirectory())
+            continue;
+        const id = entry.name;
+        const metadataPath = path.join(embeddablesDir, id, 'metadata.json');
+        let title = null;
+        if (fs.existsSync(metadataPath)) {
+            try {
+                const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8'));
+                title = metadata.title || null;
+            }
+            catch {
+                // Ignore JSON parse errors
+            }
+        }
+        embeddables.push({ id, title });
+    }
+    // Sort by title (with title) first, then by id
+    return embeddables.sort((a, b) => {
+        if (a.title && !b.title)
+            return -1;
+        if (!a.title && b.title)
+            return 1;
+        const aLabel = a.title || a.id;
+        const bLabel = b.title || b.id;
+        return aLabel.localeCompare(bLabel, undefined, { sensitivity: 'base' });
+    });
+}
+async function promptForEmbeddable() {
+    const embeddables = await discoverEmbeddables();
+    if (embeddables.length === 0) {
+        stdout.error('No embeddables found in the embeddables/ directory.');
+        stdout.dim('Run `embeddables pull --id <id>` to pull an embeddable first.');
+        return null;
+    }
+    const choices = embeddables.map((e) => ({
+        title: e.title ? `${e.title} (${e.id})` : e.id,
+        value: e.id,
+    }));
+    const { prompt: promptWithCancel } = await import('../helpers/prompt.js');
+    const response = await promptWithCancel({
+        type: 'select',
+        name: 'id',
+        message: 'Select an embeddable to run:',
+        choices,
+    });
+    return response.id || null;
+}
+export async function runDev(opts) {
+    const logger = createLogger('runDev');
+    const inferred = inferEmbeddableFromCwd();
+    let embeddableId = opts.id ?? inferred?.embeddableId;
+    if (inferred && !opts.id && embeddableId) {
+        process.chdir(inferred.projectRoot);
+    }
+    setSentryContext(getSentryContextFromProjectConfig());
+    if (!embeddableId) {
+        const selected = await promptForEmbeddable();
+        if (!selected) {
+            logger.error('no embeddable selected');
+            await exit(1);
+            return;
+        }
+        embeddableId = selected;
+    }
+    if (embeddableId) {
+        setSentryContext({
+            embeddable: { id: embeddableId },
+            ...getSentryContextFromEmbeddableConfig(embeddableId),
+        });
+    }
+    logger.info('dev started', { engine: opts.engine, port: opts.port });
+    const pagesGlob = opts.pages || `embeddables/${embeddableId}/pages/**/*.page.tsx`;
+    const outPath = opts.out || path.join('embeddables', embeddableId, '.generated', 'embeddable.json');
+    const stylesDir = path.join('embeddables', embeddableId, 'styles');
+    const stylesGlob = `embeddables/${embeddableId}/styles/**/*.css`;
+    const configPath = path.join('embeddables', embeddableId, 'config.json');
+    const globalComponentsGlob = `embeddables/${embeddableId}/global-components/**/*.location.tsx`;
+    const computedFieldsGlob = `embeddables/${embeddableId}/computed-fields/**/*.js`;
+    const actionsGlob = `embeddables/${embeddableId}/actions/**/*.js`;
+    const fixLint = opts.fix ? true : 'prompt';
+    // Initial build with spinner
+    try {
+        await stdout.withSpinner('Building…', async () => {
+            await compileAllPages({
+                pagesGlob,
+                outPath,
+                pageKeyFrom: opts.pageKeyFrom,
+                stylesDir,
+                embeddableId: embeddableId,
+                configPath,
+                fixLint,
+            });
+        }, {
+            successText: 'Initial build complete',
+        });
+    }
+    catch (e) {
+        captureException(e);
+        stdout.error(formatError(e));
+        logger.error('initial build failed');
+        await exit(1);
+    }
+    // Start proxy — find an available port if the requested one is taken
+    const requestedPort = Number(opts.port);
+    let port;
+    try {
+        port = await getAvailablePort(requestedPort);
+    }
+    catch (e) {
+        captureException(e);
+        stdout.error(e.message);
+        logger.error('no available port', { requestedPort });
+        await exit(1);
+        return;
+    }
+    if (port !== requestedPort) {
+        stdout.warn(`Port ${requestedPort} is in use, using ${port} instead.`);
+    }
+    // Mute proxy startup logs (workbench, routes, etc.) — the Dev Server box has all the info
+    stdout.mute();
+    const proxy = await startProxyServer({
+        port,
+        engineOrigin: opts.engine,
+        overrideRoute: opts.overrideRoute,
+        generatedJsonPath: outPath,
+        embeddableId,
+        watchWorkbench: true,
+    });
+    stdout.unmute();
+    logger.info('dev server running', { port });
+    // Watch all source files: pages, styles, config, global components, computed fields, and actions
+    const watcher = chokidar.watch([pagesGlob, stylesGlob, configPath, globalComponentsGlob, computedFieldsGlob, actionsGlob], {
+        ignoreInitial: true,
+    });
+    const rebuild = async () => {
+        const elapsed = stdout.timer();
+        const s = stdout.spinner('Rebuilding…');
+        try {
+            await compileAllPages({
+                pagesGlob,
+                outPath,
+                pageKeyFrom: opts.pageKeyFrom,
+                stylesDir,
+                embeddableId: embeddableId,
+                configPath,
+                fixLint,
+            });
+            proxy.broadcastReload();
+            s.succeed(`Rebuilt in ${elapsed()}`);
+        }
+        catch (e) {
+            // Keep dev server running; compiler errors show in console.
+            // (Proxy will still serve the last good JSON.)
+            captureException(e);
+            s.fail('Rebuild failed');
+            stdout.error(formatError(e));
+        }
+    };
+    let t;
+    watcher.on('all', () => {
+        clearTimeout(t);
+        t = setTimeout(rebuild, 80);
+    });
+    // Embeddable context
+    stdout.infoBox(`ID: ${embeddableId}  ·  Engine: ${opts.engine}`);
+    // Dev server ready box
+    const previewUrl = `http://localhost:${port}?id=${embeddableId}&version=latest`;
+    const modeLabel = opts.local
+        ? `${pc.blue('Local')} (${opts.engine})`
+        : `${pc.yellow('Remote')} (${opts.engine})`;
+    const boxContent = [
+        `${pc.gray('Mode:')}      ${modeLabel}`,
+        `${pc.gray('Preview:')}   ${pc.underline(pc.cyan(previewUrl))}`,
+        '',
+        `${pc.gray(`Watching embeddables/${embeddableId}/ for changes…`)}`,
+    ].join('\n');
+    stdout.gap();
+    stdout.box(boxContent, { title: 'Dev Server', borderColor: 'green' });
+    stdout.gap();
+}

package/dist/commands/diff.d.ts

@@ -0,0 +1,76 @@
+export type DiffDepth = 'pages' | 'components' | 'props';
+export type RunDiffOptions = {
+    id?: string;
+    from?: string;
+    to?: string;
+    depth?: DiffDepth;
+    color?: boolean;
+    engine?: string;
+    branch?: string;
+};
+export interface PageDiff {
+    key: string;
+    title?: string;
+    status: 'added' | 'removed' | 'modified';
+    components?: ComponentDiff[];
+}
+export interface ComponentDiff {
+    id: string;
+    key?: string;
+    type?: string;
+    status: 'added' | 'removed' | 'modified';
+    props?: PropDiff[];
+}
+export interface PropDiff {
+    name: string;
+    status: 'added' | 'removed' | 'changed';
+    from?: unknown;
+    to?: unknown;
+}
+export interface SectionDiff {
+    name: string;
+    status: 'added' | 'removed' | 'modified';
+}
+export interface DiffSummary {
+    pagesAdded: number;
+    pagesRemoved: number;
+    pagesModified: number;
+    componentsAdded: number;
+    componentsRemoved: number;
+    componentsModified: number;
+    propsAdded: number;
+    propsRemoved: number;
+    propsChanged: number;
+}
+export interface DiffResult {
+    pages: PageDiff[];
+    globalComponents: ComponentDiff[];
+    sections: SectionDiff[];
+    summary: DiffSummary;
+}
+type Colorizer = {
+    red: (s: string) => string;
+    green: (s: string) => string;
+    yellow: (s: string) => string;
+    gray: (s: string) => string;
+    bold: (s: string) => string;
+    cyan: (s: string) => string;
+    dim: (s: string) => string;
+    white: (s: string) => string;
+};
+export interface ParsedVersionSpec {
+    version: string;
+    branch?: string;
+}
+export declare function parseVersionSpecifier(spec: string): ParsedVersionSpec;
+export declare function versionLabel(spec: ParsedVersionSpec): string;
+export declare function resolveLocalVersion(embeddableId: string): Promise<Record<string, unknown>>;
+export declare function fetchCloudVersion(embeddableId: string, version: string, opts: {
+    engine?: string;
+    branch?: string;
+}): Promise<Record<string, unknown>>;
+export declare function computeDiff(from: Record<string, unknown>, to: Record<string, unknown>, depth: DiffDepth): DiffResult;
+export declare function renderDiff(diff: DiffResult, depth: DiffDepth, c: Colorizer): string[];
+export declare function runDiff(opts: RunDiffOptions): Promise<void>;
+export {};
+//# sourceMappingURL=diff.d.ts.map

package/dist/commands/diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../src/commands/diff.ts"],"names":[],"mappings":"AAkBA,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,CAAA;AAExD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAA;IACxC,UAAU,CAAC,EAAE,aAAa,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAA;IACxC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACvC,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,EAAE,CAAC,EAAE,OAAO,CAAA;CACb;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAA;CACzC;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,gBAAgB,EAAE,aAAa,EAAE,CAAA;IACjC,QAAQ,EAAE,WAAW,EAAE,CAAA;IACvB,OAAO,EAAE,WAAW,CAAA;CACrB;AAID,KAAK,SAAS,GAAG;IACf,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC1B,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC5B,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC7B,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC3B,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC3B,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC3B,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAC1B,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;CAC7B,CAAA;AAiDD,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAYD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAiBrE;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAI5D;AAID,wBAAsB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAqBhG;AAED,wBAAsB,iBAAiB,CACrC,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACzC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA0BlC;AAaD,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3B,KAAK,EAAE,SAAS,GACf,UAAU,CAMZ;AAgQD,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,MAAM,EAAE,CAgDrF;AAiID,wBAAsB,OAAO,CAAC,IAAI,EAAE,cAAc,iBAmKjD"}