@hpcc-js/observablehq-compiler 1.5.0 → 1.5.1

package/src/index.ts

@@ -1,6 +1,6 @@
-export type { ohq } from "@hpcc-js/observable-shim";
-
-export * from "./compiler";
-export { ojs2notebook, omd2notebook, download } from "./util";
-
-import "../src/index.css";
+export type { ohq } from "@hpcc-js/observable-shim";
+
+export * from "./compiler";
+export { ojs2notebook, omd2notebook, download } from "./util";
+
+import "../src/index.css";

package/src/util.md

@@ -1,113 +1,113 @@
-# Utilities
-
-Various utilities and helpers.
-
----
-
-<a name="download" href="#download">#</a> **download**(_impUrl_) => Promise\<ohq.Module\> · [<>](https://github.com/hpcc-systems/Visualization/blob/trunk/packages/observablehq/compiler/src/util.ts "Source")
-
-* _impUrl_:  Full url to Obaservable HQ notebook as a string.
-* _returns_: Returns a Promise of a notebook (a JSON object).
-
-Downloads a notebook directly from [Observable HQ](https://observablehq.com/) as a JSON object.  The following example downloads the [@observablehq/plot](https://observablehq.com/@observablehq/plot) notebook as JSON:
-
-<ClientOnly>
-  <hpcc-vitepress style="width:100%;height:600px">
-    <hpcc-codemirror id="placeholder" mode="json" theme="dark" style="width:100%;height:100%">
-    </hpcc-codemirror>
-    <script type="module">
-      import "@hpcc-js/wc-editor";
-      import { download } from "@hpcc-js/observablehq-compiler";
-
-      const notebook = await download("https://observablehq.com/@observablehq/plot");
-      const placeholder = document.getElementById("placeholder");
-      placeholder.text = JSON.stringify(notebook, undefined, 4);
-    </script>
-  </hpcc-vitepress>
-</ClientOnly>
-
----
-
-<a name="ojs2notebook" href="#ojs2notebook">#</a> **ojs2notebook**(_ojs_) => ohq.Module · [<>](https://github.com/hpcc-systems/Visualization/blob/trunk/packages/observablehq/compiler/src/util.ts "Source")
-
-* _ojs_:  String containing Observable JavaScript.
-* _returns_: Returns the notebook as a JSON object.
-
-Transforms Observable JavaScript to a JSON notebook.
-
-<ClientOnly>
-  <hpcc-vitepress style="width:100%;height:600px">
-    <hpcc-codemirror id="placeholder" mode="json" theme="dark" style="width:100%;height:100%">
-    </hpcc-codemirror>
-    <script type="module">
-      import "@hpcc-js/wc-editor";
-      import { ojs2notebook } from "@hpcc-js/observablehq-compiler";
-
-      const notebook = ojs2notebook(`
-        md\`# Simple Notebook\`
-        a = 1
-        b = 2
-        c = a + b
-        d = {
-          yield 1;
-          yield 2;
-          yield 3;
-        }
-
-        viewof e = {
-          let output = {};
-          let listeners = [];
-          output.value = 10;
-          output.addEventListener = (listener) => listeners.push(listener);;
-          output.removeEventListener = (listener) => {
-            listeners = listeners.filter(l => l !== listener);
-          };
-          return output;
-        }
-      `);
-      const placeholder = document.getElementById("placeholder");
-      placeholder.text = JSON.stringify(notebook, undefined, 4);
-    </script>
-  </hpcc-vitepress>
-</ClientOnly>
-
-<a name="omd2notebook" href="#omd2notebook">#</a> **omd2notebook**(_omd_) => ohq.Module · [<>](https://github.com/hpcc-systems/Visualization/blob/trunk/packages/observablehq/compiler/src/util.ts "Source")
-
-* _omd_:  String containing Observable Markdown.
-* _returns_: Returns the notebook as a JSON object.
-
-Transforms Observable Markdown to a JSON notebook.
-
-<ClientOnly>
-  <hpcc-vitepress style="width:100%;height:600px">
-    <hpcc-codemirror id="placeholder" mode="json" theme="dark" style="width:100%;height:100%">
-    </hpcc-codemirror>
-    <script type="module">
-      import "@hpcc-js/wc-editor";
-      import { omd2notebook } from "@hpcc-js/observablehq-compiler";
-
-      const notebook = omd2notebook(`\
-        # Simple Notebook
-
-        * Set A
-        \`\`\`
-        a = 1
-        \`\`\`
-
-        * Set B
-        \`\`\`
-        b = 2
-        \`\`\`
-
-        * Calculate c
-
-        \`\`\`
-        c = a + b
-        \`\`\`
-      `);
-      const placeholder = document.getElementById("placeholder");
-      placeholder.text = JSON.stringify(notebook, undefined, 4);
-    </script>
-  </hpcc-vitepress>
-</ClientOnly>
-
+# Utilities
+
+Various utilities and helpers.
+
+---
+
+<a name="download" href="#download">#</a> **download**(_impUrl_) => Promise\<ohq.Module\> · [<>](https://github.com/hpcc-systems/Visualization/blob/trunk/packages/observablehq/compiler/src/util.ts "Source")
+
+* _impUrl_:  Full url to Obaservable HQ notebook as a string.
+* _returns_: Returns a Promise of a notebook (a JSON object).
+
+Downloads a notebook directly from [Observable HQ](https://observablehq.com/) as a JSON object.  The following example downloads the [@observablehq/plot](https://observablehq.com/@observablehq/plot) notebook as JSON:
+
+<ClientOnly>
+  <hpcc-vitepress style="width:100%;height:600px">
+    <hpcc-codemirror id="placeholder" mode="json" theme="dark" style="width:100%;height:100%">
+    </hpcc-codemirror>
+    <script type="module">
+      import "@hpcc-js/wc-editor";
+      import { download } from "@hpcc-js/observablehq-compiler";
+
+      const notebook = await download("https://observablehq.com/@observablehq/plot");
+      const placeholder = document.getElementById("placeholder");
+      placeholder.text = JSON.stringify(notebook, undefined, 4);
+    </script>
+  </hpcc-vitepress>
+</ClientOnly>
+
+---
+
+<a name="ojs2notebook" href="#ojs2notebook">#</a> **ojs2notebook**(_ojs_) => ohq.Module · [<>](https://github.com/hpcc-systems/Visualization/blob/trunk/packages/observablehq/compiler/src/util.ts "Source")
+
+* _ojs_:  String containing Observable JavaScript.
+* _returns_: Returns the notebook as a JSON object.
+
+Transforms Observable JavaScript to a JSON notebook.
+
+<ClientOnly>
+  <hpcc-vitepress style="width:100%;height:600px">
+    <hpcc-codemirror id="placeholder" mode="json" theme="dark" style="width:100%;height:100%">
+    </hpcc-codemirror>
+    <script type="module">
+      import "@hpcc-js/wc-editor";
+      import { ojs2notebook } from "@hpcc-js/observablehq-compiler";
+
+      const notebook = ojs2notebook(`
+        md\`# Simple Notebook\`
+        a = 1
+        b = 2
+        c = a + b
+        d = {
+          yield 1;
+          yield 2;
+          yield 3;
+        }
+
+        viewof e = {
+          let output = {};
+          let listeners = [];
+          output.value = 10;
+          output.addEventListener = (listener) => listeners.push(listener);;
+          output.removeEventListener = (listener) => {
+            listeners = listeners.filter(l => l !== listener);
+          };
+          return output;
+        }
+      `);
+      const placeholder = document.getElementById("placeholder");
+      placeholder.text = JSON.stringify(notebook, undefined, 4);
+    </script>
+  </hpcc-vitepress>
+</ClientOnly>
+
+<a name="omd2notebook" href="#omd2notebook">#</a> **omd2notebook**(_omd_) => ohq.Module · [<>](https://github.com/hpcc-systems/Visualization/blob/trunk/packages/observablehq/compiler/src/util.ts "Source")
+
+* _omd_:  String containing Observable Markdown.
+* _returns_: Returns the notebook as a JSON object.
+
+Transforms Observable Markdown to a JSON notebook.
+
+<ClientOnly>
+  <hpcc-vitepress style="width:100%;height:600px">
+    <hpcc-codemirror id="placeholder" mode="json" theme="dark" style="width:100%;height:100%">
+    </hpcc-codemirror>
+    <script type="module">
+      import "@hpcc-js/wc-editor";
+      import { omd2notebook } from "@hpcc-js/observablehq-compiler";
+
+      const notebook = omd2notebook(`\
+        # Simple Notebook
+
+        * Set A
+        \`\`\`
+        a = 1
+        \`\`\`
+
+        * Set B
+        \`\`\`
+        b = 2
+        \`\`\`
+
+        * Calculate c
+
+        \`\`\`
+        c = a + b
+        \`\`\`
+      `);
+      const placeholder = document.getElementById("placeholder");
+      placeholder.text = JSON.stringify(notebook, undefined, 4);
+    </script>
+  </hpcc-vitepress>
+</ClientOnly>
+

package/src/util.ts

@@ -1,176 +1,176 @@
-import type { ohq } from "@hpcc-js/observable-shim";
-import { parseCell, splitModule } from "@hpcc-js/observable-shim";
-
-const FuncTypes = {
-    functionType: Object.getPrototypeOf(function () { }).constructor,
-    asyncFunctionType: Object.getPrototypeOf(async function () { }).constructor,
-    generatorFunctionType: Object.getPrototypeOf(function* () { }).constructor,
-    asyncGeneratorFunctionType: Object.getPrototypeOf(async function* () { }).constructor
-};
-
-function funcType(async: boolean = false, generator: boolean = false) {
-    if (!async && !generator) return FuncTypes.functionType;
-    if (async && !generator) return FuncTypes.asyncFunctionType;
-    if (!async && generator) return FuncTypes.generatorFunctionType;
-    return FuncTypes.asyncGeneratorFunctionType;
-}
-
-interface Ref {
-    start: number,
-    end: number,
-    newText: string
-}
-
-export interface Refs {
-    inputs: string[];
-    args: string[];
-    patches: Ref[];
-}
-
-export function createFunction(refs: Refs, async = false, generator = false, blockStatement = false, body?: string) {
-    if (body === undefined) {
-        return undefined;
-    }
-
-    refs.patches.sort((l, r) => r.start - l.start);
-    refs.patches.forEach(r => {
-        body = body!.substring(0, r.start) + r.newText + body!.substring(r.end);
-    });
-    return new (funcType(async, generator))(...refs.args, blockStatement ?
-        body.substring(1, body.length - 1).trim() :
-        `return (\n${body}\n);`);
-}
-
-function join(baseURL, relativeURL) {
-    return relativeURL
-        ? baseURL.replace(/\/+$/, "") + "/" + relativeURL.replace(/^\/+/, "")
-        : baseURL;
-}
-
-export const isRelativePath = (path: string) => path[0] === ".";
-export const fixRelativeUrl = (path: string, basePath: string) => {
-    if (isRelativePath(path)) {
-        return join(basePath, path);
-    }
-    return path;
-};
-
-//  Hide "import" from bundlers as they have a habit of replacing "import" with "require"
-export async function obfuscatedImport(url: string) {
-    return new FuncTypes.asyncFunctionType("url", "return import(url)")(url);
-}
-
-interface ParsedOJS {
-    ojs: string;
-    offset: number;
-    inlineMD: boolean;
-    cell: any;
-    error: any;
-}
-
-export function encodeBacktick(str: string) {
-    return str
-        .split("`").join("\\`")
-        ;
-}
-
-function createParsedOJS(ojs: string, offset: number, inlineMD: boolean): ParsedOJS {
-    let cell;
-    let error;
-    try {
-        cell = parseCell(ojs);
-    } catch (e) {
-        error = e;
-    }
-    return {
-        ojs,
-        offset,
-        inlineMD,
-        cell,
-        error
-    };
-}
-
-function splitOmd(_: string): ParsedOJS[] {
-    const retVal: ParsedOJS[] = [];
-    //  Load Markdown  ---
-    const re = /(```(?:\s|\S)[\s\S]*?```)/g;
-    let prevOffset = 0;
-    let match = re.exec(_);
-    while (match !== null) {
-        if (match.index > prevOffset) {
-            retVal.push(createParsedOJS(_.substring(prevOffset, match.index), prevOffset, true));
-        }
-
-        const outer = match[0];
-        if (outer.indexOf("``` ") === 0 || outer.indexOf("```\n") === 0 || outer.indexOf("```\r\n") === 0) {
-            const prefixLen = 3;
-            const inner = outer.substring(prefixLen, outer.length - prefixLen);
-            retVal.push(createParsedOJS(inner, match.index + prefixLen, false));
-        } else {
-            retVal.push(createParsedOJS(outer, match.index, true));
-        }
-
-        prevOffset = match.index + match[0].length;
-        match = re.exec(_);
-    }
-    if (_.length > prevOffset) {
-        retVal.push(createParsedOJS(_.substring(prevOffset, _.length), prevOffset, true));
-    }
-    return retVal;
-}
-
-export function notebook2ojs(_: string): ParsedOJS[] {
-    const parsed: ohq.Notebook = JSON.parse(_);
-    return parsed.nodes.map(node => createParsedOJS(node.value, 0, node.mode === "md"));
-}
-
-export function ojs2notebook(ojs: string): ohq.Notebook {
-    const cells = splitModule(ojs);
-    return {
-        files: [],
-        nodes: cells.map((cell, idx) => {
-            return {
-                id: idx,
-                mode: "js",
-                value: cell.text,
-                start: cell.start,
-                end: cell.end
-            };
-        })
-    } as ohq.Notebook;
-}
-
-export function omd2notebook(omd: string): ohq.Notebook {
-    const cells = splitOmd(omd);
-    return {
-        files: [],
-        nodes: cells.map((cell, idx) => {
-            return {
-                id: idx,
-                mode: cell.inlineMD ? "md" : "js",
-                value: cell.ojs,
-                start: cell.offset,
-                end: cell.offset + cell.ojs.length
-            };
-        })
-    } as ohq.Notebook;
-}
-
-export function fetchEx(url: string, proxyPrefix = "https://api.codetabs.com/v1/proxy/?quest=", proxyPostfix = "") {
-    const matches = url.match(/^(?:https?:\/\/)?(?:[^@\n]+@)?(?:www\.)?([^:\/\n?]+)/img);
-    return fetch(url, { headers: { origin: matches[0], referer: url } }).then(response => {
-        if (response.ok) return response;
-        throw new Error("CORS?");
-    }).catch(e => {
-        url = `${proxyPrefix}${url}${proxyPostfix}`;
-        return fetch(url, { headers: { origin: matches[0], referer: url } });
-    });
-}
-
-export function download(impUrl: string, proxyPrefix?: string, proxyPostfix?: string): Promise<ohq.Notebook> {
-    const isShared = impUrl.indexOf("https://observablehq.com/d") === 0;
-    return fetchEx(impUrl.replace(`https://observablehq.com/${isShared ? "d/" : ""}`, "https://api.observablehq.com/document/"), proxyPrefix, proxyPostfix)
-        .then(r => r.json())
-        ;
+import type { ohq } from "@hpcc-js/observable-shim";
+import { parseCell, splitModule } from "@hpcc-js/observable-shim";
+
+const FuncTypes = {
+    functionType: Object.getPrototypeOf(function () { }).constructor,
+    asyncFunctionType: Object.getPrototypeOf(async function () { }).constructor,
+    generatorFunctionType: Object.getPrototypeOf(function* () { }).constructor,
+    asyncGeneratorFunctionType: Object.getPrototypeOf(async function* () { }).constructor
+};
+
+function funcType(async: boolean = false, generator: boolean = false) {
+    if (!async && !generator) return FuncTypes.functionType;
+    if (async && !generator) return FuncTypes.asyncFunctionType;
+    if (!async && generator) return FuncTypes.generatorFunctionType;
+    return FuncTypes.asyncGeneratorFunctionType;
+}
+
+interface Ref {
+    start: number,
+    end: number,
+    newText: string
+}
+
+export interface Refs {
+    inputs: string[];
+    args: string[];
+    patches: Ref[];
+}
+
+export function createFunction(refs: Refs, async = false, generator = false, blockStatement = false, body?: string) {
+    if (body === undefined) {
+        return undefined;
+    }
+
+    refs.patches.sort((l, r) => r.start - l.start);
+    refs.patches.forEach(r => {
+        body = body!.substring(0, r.start) + r.newText + body!.substring(r.end);
+    });
+    return new (funcType(async, generator))(...refs.args, blockStatement ?
+        body.substring(1, body.length - 1).trim() :
+        `return (\n${body}\n);`);
+}
+
+function join(baseURL, relativeURL) {
+    return relativeURL
+        ? baseURL.replace(/\/+$/, "") + "/" + relativeURL.replace(/^\/+/, "")
+        : baseURL;
+}
+
+export const isRelativePath = (path: string) => path[0] === ".";
+export const fixRelativeUrl = (path: string, basePath: string) => {
+    if (isRelativePath(path)) {
+        return join(basePath, path);
+    }
+    return path;
+};
+
+//  Hide "import" from bundlers as they have a habit of replacing "import" with "require"
+export async function obfuscatedImport(url: string) {
+    return new FuncTypes.asyncFunctionType("url", "return import(url)")(url);
+}
+
+interface ParsedOJS {
+    ojs: string;
+    offset: number;
+    inlineMD: boolean;
+    cell: any;
+    error: any;
+}
+
+export function encodeBacktick(str: string) {
+    return str
+        .split("`").join("\\`")
+        ;
+}
+
+function createParsedOJS(ojs: string, offset: number, inlineMD: boolean): ParsedOJS {
+    let cell;
+    let error;
+    try {
+        cell = parseCell(ojs);
+    } catch (e) {
+        error = e;
+    }
+    return {
+        ojs,
+        offset,
+        inlineMD,
+        cell,
+        error
+    };
+}
+
+function splitOmd(_: string): ParsedOJS[] {
+    const retVal: ParsedOJS[] = [];
+    //  Load Markdown  ---
+    const re = /(```(?:\s|\S)[\s\S]*?```)/g;
+    let prevOffset = 0;
+    let match = re.exec(_);
+    while (match !== null) {
+        if (match.index > prevOffset) {
+            retVal.push(createParsedOJS(_.substring(prevOffset, match.index), prevOffset, true));
+        }
+
+        const outer = match[0];
+        if (outer.indexOf("``` ") === 0 || outer.indexOf("```\n") === 0 || outer.indexOf("```\r\n") === 0) {
+            const prefixLen = 3;
+            const inner = outer.substring(prefixLen, outer.length - prefixLen);
+            retVal.push(createParsedOJS(inner, match.index + prefixLen, false));
+        } else {
+            retVal.push(createParsedOJS(outer, match.index, true));
+        }
+
+        prevOffset = match.index + match[0].length;
+        match = re.exec(_);
+    }
+    if (_.length > prevOffset) {
+        retVal.push(createParsedOJS(_.substring(prevOffset, _.length), prevOffset, true));
+    }
+    return retVal;
+}
+
+export function notebook2ojs(_: string): ParsedOJS[] {
+    const parsed: ohq.Notebook = JSON.parse(_);
+    return parsed.nodes.map(node => createParsedOJS(node.value, 0, node.mode === "md"));
+}
+
+export function ojs2notebook(ojs: string): ohq.Notebook {
+    const cells = splitModule(ojs);
+    return {
+        files: [],
+        nodes: cells.map((cell, idx) => {
+            return {
+                id: idx,
+                mode: "js",
+                value: cell.text,
+                start: cell.start,
+                end: cell.end
+            };
+        })
+    } as ohq.Notebook;
+}
+
+export function omd2notebook(omd: string): ohq.Notebook {
+    const cells = splitOmd(omd);
+    return {
+        files: [],
+        nodes: cells.map((cell, idx) => {
+            return {
+                id: idx,
+                mode: cell.inlineMD ? "md" : "js",
+                value: cell.ojs,
+                start: cell.offset,
+                end: cell.offset + cell.ojs.length
+            };
+        })
+    } as ohq.Notebook;
+}
+
+export function fetchEx(url: string, proxyPrefix = "https://api.codetabs.com/v1/proxy/?quest=", proxyPostfix = "") {
+    const matches = url.match(/^(?:https?:\/\/)?(?:[^@\n]+@)?(?:www\.)?([^:\/\n?]+)/img);
+    return fetch(url, { headers: { origin: matches[0], referer: url } }).then(response => {
+        if (response.ok) return response;
+        throw new Error("CORS?");
+    }).catch(e => {
+        url = `${proxyPrefix}${url}${proxyPostfix}`;
+        return fetch(url, { headers: { origin: matches[0], referer: url } });
+    });
+}
+
+export function download(impUrl: string, proxyPrefix?: string, proxyPostfix?: string): Promise<ohq.Notebook> {
+    const isShared = impUrl.indexOf("https://observablehq.com/d") === 0;
+    return fetchEx(impUrl.replace(`https://observablehq.com/${isShared ? "d/" : ""}`, "https://api.observablehq.com/document/"), proxyPrefix, proxyPostfix)
+        .then(r => r.json())
+        ;
 }