@vizhub/runtime 0.2.0 → 0.3.1

package/dist/cjs/v3/transformSvelte.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformSvelte = exports.svelteCompilerUrl = void 0;
+const parseId_1 = require("./parseId");
+const debug = false;
+// The cache of fetched files.
+const fetchedFileCache = new Map();
+let compile;
+const svelteURL = "https://cdn.jsdelivr.net/npm/svelte@4.2.9";
+exports.svelteCompilerUrl = `${svelteURL}/compiler.cjs`;
+// Responsible for transforming Svelte files.
+// Inspired by:
+//  * https://github.com/sveltejs/sites/blob/master/packages/repl/src/lib/workers/compiler/index.js#L2
+//  * https://github.com/sveltejs/sites/blob/master/packages/repl/src/lib/workers/bundler/index.js#L358
+//  * https://github.com/sveltejs/rollup-plugin-svelte/blob/master/index.js#L146C4-L146C51
+const transformSvelte = ({ getSvelteCompiler, }) => ({
+    name: "transformSvelte",
+    load: async (resolved) => {
+        if (!resolved.startsWith(svelteURL)) {
+            return;
+        }
+        if (debug) {
+            console.log("[transformSvelte]: load() " + resolved);
+        }
+        const cachedFile = fetchedFileCache.get(resolved);
+        if (cachedFile)
+            return cachedFile;
+        const fetchedFile = await fetch(resolved).then((res) => res.text());
+        fetchedFileCache.set(resolved, fetchedFile);
+        return fetchedFile;
+    },
+    // From https://github.com/sveltejs/sites/blob/master/packages/repl/src/lib/workers/bundler/index.js#L255C2-L271C5
+    resolveId: async (importee, importer) => {
+        if (debug) {
+            console.log("[transformSvelte] resolveId() " + importee);
+            console.log("importee: " + importee);
+            console.log("importer: " + importer);
+        }
+        // importing from Svelte
+        if (importee === `svelte`) {
+            return `${svelteURL}/src/runtime/index.js`;
+        }
+        if (importee.startsWith(`svelte/`)) {
+            const sub_path = importee.slice(7);
+            return `${svelteURL}/src/runtime/${sub_path}/index.js`;
+        }
+        // importing from a URL
+        if (/^https?:/.test(importee))
+            return importee;
+        // Relative imports
+        if (importee.startsWith(".")) {
+            if (importer && importer.startsWith(svelteURL)) {
+                const resolved = new URL(importee, importer).href;
+                const url = new URL(importee, importer).href;
+                if (debug) {
+                    console.log("[transformSvelte] resolveId() " + resolved);
+                }
+                return resolved;
+            }
+        }
+    },
+    transform: async (code, id) => {
+        const { fileName } = (0, parseId_1.parseId)(id);
+        const isSvelte = fileName.endsWith(".svelte");
+        if (isSvelte) {
+            if (!compile) {
+                if (!getSvelteCompiler) {
+                    throw new Error("Svelte compiler not available");
+                }
+                compile = await getSvelteCompiler();
+            }
+            const compiled = compile(code, {
+                filename: fileName,
+                hydratable: true,
+            });
+            return compiled.js;
+        }
+        return undefined;
+    },
+});
+exports.transformSvelte = transformSvelte;

package/dist/cjs/v3/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/v3/v3Build.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v3Build = void 0;
+const computeBundleJSV3_1 = require("./computeBundleJSV3");
+const htmlTemplate_1 = require("./htmlTemplate");
+const parseId_1 = require("./parseId");
+const viz_utils_1 = require("@vizhub/viz-utils");
+const v3Build = async ({ files, rollup, enableSourcemap = true, vizCache, vizId, slugCache, getSvelteCompiler, }) => {
+    const { src, cssFiles } = await (0, computeBundleJSV3_1.computeBundleJSV3)({
+        files,
+        rollup,
+        enableSourcemap,
+        vizCache,
+        vizId,
+        slugCache,
+        getSvelteCompiler,
+    });
+    // Generate CSS styles from imported CSS files
+    let styles = "";
+    // Inject CSS files.
+    if (cssFiles.length > 0) {
+        for (let i = 0; i < cssFiles.length; i++) {
+            const id = cssFiles[i];
+            const indent = i > 0 ? "    " : "\n    ";
+            const styleElementId = "injected-style" + id;
+            const { vizId, fileName } = (0, parseId_1.parseId)(id);
+            const content = await vizCache.get(vizId);
+            const src = (0, viz_utils_1.getFileText)(content, fileName);
+            styles += `${indent}<style id="${styleElementId}">${src}</style>`;
+        }
+    }
+    return (0, htmlTemplate_1.htmlTemplate)({ cdn: "", src, styles });
+};
+exports.v3Build = v3Build;

package/dist/cjs/v3/vizCache.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createVizCache = void 0;
+// A cache of viz content.
+// For use in resolving imports from other vizzes.
+// Runs both on the server and in the browser.
+const createVizCache = ({ initialContents, handleCacheMiss, }) => {
+    // Track the content of cached vizzes.
+    const contentMap = new Map(initialContents.map((content) => [content.id, content]));
+    // Gets the content of a viz.
+    // Returns the cached content if it exists.
+    // Otherwise, calls handleCacheMiss to fetch the content.
+    const get = async (vizId) => {
+        const cachedContent = contentMap.get(vizId);
+        // Cache hit
+        if (cachedContent !== undefined) {
+            return cachedContent;
+        }
+        // Cache miss
+        if (!handleCacheMiss) {
+            throw new Error(`Unresolved import from vizId ${vizId}, cache miss handler not provided.`);
+        }
+        const freshContent = await handleCacheMiss(vizId);
+        if (freshContent) {
+            contentMap.set(vizId, freshContent);
+            return freshContent;
+        }
+        // TODO surface this error to the user
+        throw new Error(`Unresolved import from vizId ${vizId}`);
+    };
+    // Updates the content of a viz in the cache.
+    const set = (content) => {
+        contentMap.set(content.id, content);
+    };
+    const invalidate = (vizId) => {
+        contentMap.delete(vizId);
+    };
+    return { get, set, invalidate };
+};
+exports.createVizCache = createVizCache;

package/dist/cjs/v3/vizCache.test.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const vizCache_1 = require("./vizCache");
+const v3_1 = require("../test/fixtures/v3");
+(0, vitest_1.describe)("VizCache", () => {
+    (0, vitest_1.describe)("VizCache - get method", () => {
+        (0, vitest_1.it)("should return content from cache if available", async () => {
+            const vizCache = (0, vizCache_1.createVizCache)({
+                initialContents: [v3_1.sampleVizContent],
+                handleCacheMiss: vitest_1.vi.fn(),
+            });
+            const content = await vizCache.get(v3_1.sampleVizContent.id);
+            (0, vitest_1.expect)(content).toEqual(v3_1.sampleVizContent);
+            (0, vitest_1.expect)(vitest_1.vi.fn()).toHaveBeenCalledTimes(0); // handleCacheMiss should not be called
+        });
+        (0, vitest_1.it)("should fetch content on cache miss and store it", async () => {
+            const handleCacheMissMock = vitest_1.vi
+                .fn()
+                .mockResolvedValue(v3_1.sampleVizContent);
+            const vizCache = (0, vizCache_1.createVizCache)({
+                initialContents: [],
+                handleCacheMiss: handleCacheMissMock,
+            });
+            const content = await vizCache.get(v3_1.sampleVizContent.id);
+            (0, vitest_1.expect)(handleCacheMissMock).toHaveBeenCalledWith(v3_1.sampleVizContent.id);
+            (0, vitest_1.expect)(content).toEqual(v3_1.sampleVizContent);
+            // Verify that the cache now contains the fetched content
+            const cachedContent = await vizCache.get(v3_1.sampleVizContent.id);
+            (0, vitest_1.expect)(cachedContent).toEqual(v3_1.sampleVizContent);
+        });
+        (0, vitest_1.it)("should throw an error if handleCacheMiss does not return content", async () => {
+            const handleCacheMissMock = vitest_1.vi
+                .fn()
+                .mockResolvedValue(undefined);
+            const vizCache = (0, vizCache_1.createVizCache)({
+                initialContents: [],
+                handleCacheMiss: handleCacheMissMock,
+            });
+            await (0, vitest_1.expect)(vizCache.get("nonexistentId")).rejects.toThrow("Unresolved import from vizId nonexistentId");
+        });
+        // Add tests for set
+    });
+    (0, vitest_1.describe)("VizCache - set method", () => {
+        (0, vitest_1.it)("should add new content to the cache", async () => {
+            const vizCache = (0, vizCache_1.createVizCache)({
+                initialContents: [],
+                handleCacheMiss: vitest_1.vi.fn(),
+            });
+            const newContent = {
+                id: "newContent",
+                files: {},
+                title: "New Content",
+            };
+            vizCache.set(newContent);
+            // Verify new content is added
+            const content = await vizCache.get(newContent.id);
+            (0, vitest_1.expect)(content).toEqual(newContent);
+        });
+        (0, vitest_1.it)("should update existing content in the cache", async () => {
+            const updatedContent = {
+                ...v3_1.sampleVizContent,
+                title: "Updated Content Title",
+            };
+            const vizCache = (0, vizCache_1.createVizCache)({
+                initialContents: [v3_1.sampleVizContent],
+                handleCacheMiss: vitest_1.vi.fn(),
+            });
+            // Update existing content
+            vizCache.set(updatedContent);
+            // Verify content is updated
+            const content = await vizCache.get(updatedContent.id);
+            (0, vitest_1.expect)(content).toEqual(updatedContent);
+        });
+        (0, vitest_1.it)("should keep the cache consistent after multiple set operations", async () => {
+            const vizCache = (0, vizCache_1.createVizCache)({
+                initialContents: [],
+                handleCacheMiss: vitest_1.vi.fn(),
+            });
+            // Adding multiple contents
+            const contentA = {
+                id: "contentA",
+                files: {},
+                title: "Content A",
+            };
+            const contentB = {
+                id: "contentB",
+                files: {},
+                title: "Content B",
+            };
+            vizCache.set(contentA);
+            vizCache.set(contentB);
+            // Verify both contents are retrievable
+            const retrievedA = await vizCache.get(contentA.id);
+            const retrievedB = await vizCache.get(contentB.id);
+            (0, vitest_1.expect)(retrievedA).toEqual(contentA);
+            (0, vitest_1.expect)(retrievedB).toEqual(contentB);
+        });
+    });
+});

package/dist/cjs/v3/vizLoad.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vizLoad = void 0;
+const parseId_1 = require("./parseId");
+const viz_utils_1 = require("@vizhub/viz-utils");
+const debug = false;
+// Responsible for loading all imports and
+// tracking which CSS files are imported.
+// Throws an error if a file is imported but not found.
+const vizLoad = ({ vizCache, trackCSSImport, }) => ({
+    name: "vizLoad",
+    // `id` here is of the form
+    // `{vizId}/{fileName}`
+    load: async (id) => {
+        if (debug) {
+            console.log("[vizLoadCSS]: load() " + id);
+        }
+        const { vizId, fileName } = (0, parseId_1.parseId)(id);
+        if (debug) {
+            console.log("  [vizLoadCSS] vizId: " + vizId);
+            console.log("  [vizLoadCSS] fileName: " + fileName);
+        }
+        // For CSS imports, all we need to do here is
+        // keep track of them so they can be injected
+        // into the IFrame later.
+        if (fileName.endsWith(".css")) {
+            if (debug) {
+                console.log("    [vizResolve] tracking CSS import for " + id);
+            }
+            // The import is tracked here so that it can be
+            // injected into the IFrame later, external to the
+            // Rollup build.
+            trackCSSImport(id);
+            // TODO consider using Rollup's `emitFile` to emit a CSS file.
+            return "";
+        }
+        const content = await vizCache.get(vizId);
+        const fileText = (0, viz_utils_1.getFileText)(content, fileName);
+        // If a file is imported but not found, throw an error.
+        if (fileText === null) {
+            throw new Error(`Imported file "${fileName}" not found.`);
+            // TODO ideally show username/slug instead of vizId
+            // `Imported file "${fileName}" not found in viz ${vizId}`,
+            // `Imported file "${fileName}" not found.`,
+            // );
+        }
+        return fileText;
+    },
+});
+exports.vizLoad = vizLoad;

package/dist/cjs/v3/vizResolve.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vizResolve = void 0;
+const extractVizImport_1 = require("./extractVizImport");
+const parseId_1 = require("./parseId");
+const viz_utils_1 = require("@vizhub/viz-utils");
+const debug = false;
+const vizResolve = ({ vizId, slugCache, }) => ({
+    name: "vizResolve",
+    resolveId: async (id, importer) => {
+        if (debug) {
+            console.log("[vizIdResolve] resolveId() " + id);
+            console.log("  importer: " + importer);
+        }
+        // Handle virtual file system resolution
+        // .e.g. `import { foo } from './foo.js'`
+        // .e.g. `import { foo } from './foo'`
+        if (id.startsWith("./") &&
+            !importer?.startsWith("https://")) {
+            let fileName = id.substring(2);
+            // Handle CSS files
+            // e.g. `import './styles.css'`
+            // Handle JS files
+            // e.g. `import { foo } from './foo.js'`
+            // e.g. `import { foo } from './foo'`
+            if (!fileName.endsWith(".js") &&
+                !fileName.endsWith(".css") &&
+                !fileName.endsWith(".csv") &&
+                !fileName.endsWith(".svelte")) {
+                fileName += ".js";
+            }
+            // const js = (name: string) =>
+            // name.endsWith('.js') ? name : name + '.js';
+            // If there is an importer, then the file is not part of
+            // the entry point, so it should be resolved relative
+            // to the importer's directory
+            if (importer) {
+                const { vizId: importerVizId, fileName: importerFileName, } = (0, parseId_1.parseId)(importer);
+                // Get the directory of the importing file
+                const importerDir = importerFileName
+                    .split("/")
+                    .slice(0, -1)
+                    .join("/");
+                // Combine the directory with the imported file name
+                const resolvedFileName = importerDir
+                    ? `${importerDir}/${fileName}`
+                    : fileName;
+                return `${importerVizId}/${resolvedFileName}`;
+            }
+            return vizId + "/" + fileName;
+        }
+        // Handle viz import resolution
+        // e.g. `import { foo } from '@curran/98e6d6509a1e407897d4f238a330efec'`
+        // e.g. `import { foo } from '@curran/scatter-plot'`
+        const vizImport = (0, extractVizImport_1.extractVizImport)(id);
+        if (vizImport) {
+            let vizId;
+            if ((0, viz_utils_1.isVizId)(vizImport.idOrSlug)) {
+                vizId = vizImport.idOrSlug;
+            }
+            else {
+                if (!slugCache) {
+                    throw new Error("slugCache is required to import by slug in v3 runtime");
+                }
+                vizId = await slugCache.get(`${vizImport.userName}/${vizImport.idOrSlug}`);
+            }
+            return vizId + "/index.js";
+        }
+        // If neither condition is met, return undefined.
+        return undefined;
+    },
+});
+exports.vizResolve = vizResolve;

package/dist/cjs/v4/index.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v4Build = void 0;
+const jsdom_1 = require("jsdom");
+const virtualFileSystem_1 = require("../common/virtualFileSystem");
+const sucrasePlugin_1 = require("../common/sucrasePlugin");
+const packageJson_1 = require("../common/packageJson");
+const DEBUG = false;
+/**
+ * Extract module script entry points from index.html
+ */
+const extractModuleEntryPoints = (html) => {
+    const dom = new jsdom_1.JSDOM(html);
+    const document = dom.window.document;
+    const moduleScripts = document.querySelectorAll('script[type="module"]');
+    const entryPoints = [];
+    moduleScripts.forEach((script) => {
+        const src = script.getAttribute("src");
+        if (src) {
+            entryPoints.push(src);
+        }
+    });
+    return entryPoints;
+};
+/**
+ * Bundle an ES module entry point
+ */
+const bundleESModule = async ({ entryPoint, files, rollup, enableSourcemap = true, }) => {
+    const inputOptions = {
+        input: `./${entryPoint}`,
+        plugins: [(0, virtualFileSystem_1.virtualFileSystem)(files), (0, sucrasePlugin_1.sucrasePlugin)()],
+        onwarn(warning, warn) {
+            // Suppress "treating module as external dependency" warnings
+            if (warning.code === "UNRESOLVED_IMPORT")
+                return;
+            warn(warning);
+        },
+    };
+    const bundle = await rollup(inputOptions);
+    const outputOptions = {
+        format: "es",
+        sourcemap: enableSourcemap,
+    };
+    const { output } = await bundle.generate(outputOptions);
+    return output[0].code;
+};
+/**
+ * Generate an import map for all dependencies
+ */
+const generateImportMap = (files) => {
+    const deps = (0, packageJson_1.dependencies)(files);
+    if (Object.keys(deps).length === 0) {
+        return null;
+    }
+    const libraries = (0, packageJson_1.getConfiguredLibraries)(files);
+    const imports = {};
+    Object.entries(deps).forEach(([name, version]) => {
+        const url = (0, packageJson_1.dependencySource)({ name, version }, libraries);
+        imports[name] = url;
+    });
+    return JSON.stringify({ imports }, null, 2);
+};
+/**
+ * Update HTML to include import map and bundled modules
+ */
+const updateHTML = (files, bundledModules) => {
+    const html = files["index.html"] || "";
+    if (!html) {
+        return "";
+    }
+    const dom = new jsdom_1.JSDOM(html);
+    const document = dom.window.document;
+    // Replace script src with bundled content
+    bundledModules.forEach((code, src) => {
+        const scripts = document.querySelectorAll(`script[src="${src}"]`);
+        scripts.forEach((script) => {
+            const newScript = document.createElement("script");
+            newScript.setAttribute("type", "module");
+            newScript.textContent = code;
+            script.parentNode?.replaceChild(newScript, script);
+        });
+    });
+    // Add import map if needed
+    const importMap = generateImportMap(files);
+    if (importMap) {
+        // Check if import map already exists
+        const existingImportMap = document.querySelector('script[type="importmap"]');
+        if (!existingImportMap) {
+            const importMapScript = document.createElement("script");
+            importMapScript.setAttribute("type", "importmap");
+            importMapScript.textContent = importMap;
+            const head = document.head || document.querySelector("head");
+            if (head) {
+                head.prepend(importMapScript);
+            }
+            else {
+                const html = document.documentElement;
+                const newHead = document.createElement("head");
+                newHead.appendChild(importMapScript);
+                html.insertBefore(newHead, html.firstChild);
+            }
+        }
+    }
+    return `<!DOCTYPE html>${document.documentElement.outerHTML}`;
+};
+/**
+ * Build for v4 runtime
+ */
+const v4Build = async ({ files, rollup, enableSourcemap = true, }) => {
+    // Extract entry points
+    const html = files["index.html"] || "";
+    const entryPoints = extractModuleEntryPoints(html);
+    if (entryPoints.length === 0) {
+        DEBUG &&
+            console.log("[v4Build] No module entry points found");
+        // Fall back to a default approach if no module entry points
+        // Just return the HTML as-is if there are no module scripts
+        return files;
+    }
+    // Bundle each entry point
+    const bundledModules = new Map();
+    for (const entryPoint of entryPoints) {
+        const code = await bundleESModule({
+            entryPoint,
+            files,
+            rollup,
+            enableSourcemap,
+        });
+        bundledModules.set(entryPoint, code);
+    }
+    // Update HTML with bundled modules and import map
+    const updatedHTML = updateHTML(files, bundledModules);
+    return {
+        ...files,
+        "index.html": updatedHTML,
+    };
+};
+exports.v4Build = v4Build;

package/dist/common/packageJson.d.ts

@@ -1,4 +1,4 @@
-import { FileCollection } from "../types";
+import { FileCollection } from "@vizhub/viz-types";
 export type Licence = string;
 export interface PackageJson {
     dependencies?: {

package/dist/common/virtualFileSystem.d.ts

@@ -1,3 +1,3 @@
+import { FileCollection } from "@vizhub/viz-types";
 import { Plugin } from "rollup";
-import { FileCollection } from "../types";
 export declare const virtualFileSystem: (files: FileCollection) => Plugin;

package/dist/determineRuntimeVersion.d.ts

@@ -1,2 +1,3 @@
-import { FileCollection, runtimeVersion } from "./types";
+import { FileCollection } from "@vizhub/viz-types";
+import { runtimeVersion } from "./types";
 export declare const determineRuntimeVersion: (files: FileCollection) => runtimeVersion | null;

package/dist/esm/buildHTML.js

@@ -0,0 +1,67 @@
+import { magicSandbox } from "magic-sandbox";
+import { determineRuntimeVersion } from "./determineRuntimeVersion";
+import { v2Build } from "./v2";
+import { v3Build } from "./v3";
+import { v4Build } from "./v4";
+import { createVizCache } from "./v3/vizCache";
+import { createVizContent } from "./v3/createVizContent";
+import { vizContentToFileCollection } from "./utils/vizContentToFileCollection";
+const DEBUG = false;
+export const buildHTML = async ({ files, rollup, enableSourcemap = true, vizCache, vizId, slugCache, getSvelteCompiler, }) => {
+    if (!files && !vizCache) {
+        throw new Error("Either files or vizCache is required");
+    }
+    if (!files && vizCache && !vizId) {
+        throw new Error("vizId is required when using vizCache");
+    }
+    if (!files && vizCache && vizId) {
+        files = vizContentToFileCollection(await vizCache.get(vizId));
+    }
+    if (!files) {
+        throw new Error("Upable to extract viz files");
+    }
+    const version = determineRuntimeVersion(files);
+    DEBUG && console.log("[buildHTML] version:", version);
+    if (version === "v1") {
+        return magicSandbox(files);
+    }
+    if (version === "v2") {
+        if (!rollup) {
+            throw new Error("Rollup is required for v2 runtime");
+        }
+        return magicSandbox(await v2Build({ files, rollup, enableSourcemap }));
+    }
+    if (version === "v3") {
+        if (!rollup) {
+            throw new Error("Rollup is required for v3 runtime");
+        }
+        if (!vizCache && !vizId) {
+            const vizContent = createVizContent(files);
+            vizId = vizContent.id;
+            vizCache = createVizCache({
+                initialContents: [vizContent],
+                handleCacheMiss: async () => {
+                    throw new Error("Cache miss handler not implemented");
+                },
+            });
+        }
+        if (!vizCache || !vizId) {
+            throw new Error("vizCache and vizId are required for v3 runtime");
+        }
+        return await v3Build({
+            files,
+            rollup,
+            vizCache,
+            vizId,
+            slugCache,
+            getSvelteCompiler,
+        });
+    }
+    if (version === "v4") {
+        if (!rollup) {
+            throw new Error("Rollup is required for v4 runtime");
+        }
+        return magicSandbox(await v4Build({ files, rollup, enableSourcemap }));
+    }
+    throw new Error(`Unsupported runtime version: ${version}`);
+};