@forzalabs/remora-preview 1.0.0

package/dist/Snapshot.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromSnapshot = void 0;
+const Affirm_1 = require("./Affirm");
+/**
+ * Serves one already-built document — the standalone `remora-preview <file>` entrypoint, and any
+ * static export. Resource views come from the snapshot's own `resources`, so a document generated
+ * without them shows the graph and reports that the detail was not included.
+ */
+const fromSnapshot = (snapshot) => {
+    (0, Affirm_1.affirm)(snapshot, 'Cannot serve an empty preview snapshot');
+    (0, Affirm_1.affirm)(snapshot.graph, 'The preview snapshot carries no graph');
+    const views = new Map((snapshot.resources ?? []).map(view => [view.id, view]));
+    return {
+        snapshot: () => snapshot,
+        resource: nodeId => views.get(nodeId) ?? null
+    };
+};
+exports.fromSnapshot = fromSnapshot;

package/dist/bin.d.ts

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

package/dist/bin.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const Server_1 = require("./Server");
+const Snapshot_1 = require("./Snapshot");
+const USAGE = `remora-preview <snapshot.json> [--port <n>] [--no-open]
+
+Serves a preview snapshot produced by "remora graph -f json".
+Read-only: this viewer has no drivers and cannot reach a data source.`;
+/**
+ * The standalone entrypoint: someone with a snapshot file and no remora CLI, and no licence.
+ * `remora ui-preview` does not go through here — it calls `serve()` with a live provider instead.
+ */
+const main = async () => {
+    const args = process.argv.slice(2);
+    const file = args.find(arg => !arg.startsWith('-'));
+    if (!file || args.includes('--help') || args.includes('-h')) {
+        console.log(USAGE);
+        process.exit(file ? 0 : 1);
+    }
+    const resolved = node_path_1.default.resolve(file);
+    if (!node_fs_1.default.existsSync(resolved)) {
+        console.error(`No such snapshot file: ${resolved}`);
+        process.exit(1);
+    }
+    const snapshot = read(resolved);
+    const server = await (0, Server_1.serve)({
+        provider: (0, Snapshot_1.fromSnapshot)(snapshot),
+        port: portOf(args),
+        open: !args.includes('--no-open')
+    });
+    console.log(`Preview of "${snapshot.project}" on ${server.url} (Ctrl+C to stop)`);
+    process.on('SIGINT', () => server.close().then(() => process.exit(0)));
+};
+const read = (resolved) => {
+    try {
+        return JSON.parse(node_fs_1.default.readFileSync(resolved, 'utf-8'));
+    }
+    catch (error) {
+        console.error(`${resolved} is not a parseable preview snapshot: ${error.message}`);
+        process.exit(1);
+    }
+};
+const portOf = (args) => {
+    const index = args.indexOf('--port');
+    if (index < 0)
+        return undefined;
+    const port = parseInt(args[index + 1], 10);
+    if (isNaN(port) || port <= 0 || port > 65535) {
+        console.error(`Invalid --port value: ${args[index + 1]}`);
+        process.exit(1);
+    }
+    return port;
+};
+main().catch(error => {
+    console.error(error.message);
+    process.exit(1);
+});

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * `@forzalabs/remora-preview` — the read-only viewer for a remora project.
+ *
+ * It receives one versioned JSON document and renders it. It has no drivers, no credentials and no
+ * remora configuration reader, so it physically cannot reach a data source: live sampling stays a
+ * capability of the CLI that hosts it. See docs/PREVIEW_PLAN.md §2.
+ */
+export { SUPPORTED_FORMAT_VERSION } from './Contract';
+export type { ILineageEdge, ILineageGraph, ILineageNode, ILineageRun, IPreviewCapabilities, IPreviewDiagnostic, IPreviewFile, IPreviewLogs, IPreviewRunResult, IPreviewSaveResult, IPreviewSnapshot, IResourceView, IViewCell, IViewColumn, IViewField, IViewTable, LineageEdgeKind, LineageNodeKind, LineageRunStatus, LineageStatus } from './Contract';
+export { fromSnapshot } from './Snapshot';
+export type { IPreviewProvider } from './Snapshot';
+export { serve } from './Server';
+export type { IPreviewServer, IServeOptions } from './Server';

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serve = exports.fromSnapshot = exports.SUPPORTED_FORMAT_VERSION = void 0;
+/**
+ * `@forzalabs/remora-preview` — the read-only viewer for a remora project.
+ *
+ * It receives one versioned JSON document and renders it. It has no drivers, no credentials and no
+ * remora configuration reader, so it physically cannot reach a data source: live sampling stays a
+ * capability of the CLI that hosts it. See docs/PREVIEW_PLAN.md §2.
+ */
+var Contract_1 = require("./Contract");
+Object.defineProperty(exports, "SUPPORTED_FORMAT_VERSION", { enumerable: true, get: function () { return Contract_1.SUPPORTED_FORMAT_VERSION; } });
+var Snapshot_1 = require("./Snapshot");
+Object.defineProperty(exports, "fromSnapshot", { enumerable: true, get: function () { return Snapshot_1.fromSnapshot; } });
+var Server_1 = require("./Server");
+Object.defineProperty(exports, "serve", { enumerable: true, get: function () { return Server_1.serve; } });