@hpcc-js/observablehq-compiler 1.4.0 → 3.2.0

package/src/types.ts

@@ -0,0 +1,180 @@
+export namespace ohq {
+
+    //  ObservableHQ Notebook Format  ---
+    export interface Owner {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        type?: string;
+        tier?: string;
+    }
+
+    export interface Creator {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        tier?: string;
+    }
+
+    export interface Author {
+        id?: string;
+        avatar_url?: string;
+        name?: string;
+        login?: string;
+        bio?: string;
+        home_url?: string;
+        github_login?: string;
+        tier?: string;
+        approved?: boolean;
+        description?: string;
+    }
+
+    export interface Owner2 {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        type?: string;
+        tier?: string;
+    }
+
+    export interface Collection {
+        id?: string;
+        type?: string;
+        slug?: string;
+        title?: string;
+        description?: string;
+        update_time?: Date;
+        pinned?: boolean;
+        ordered?: boolean;
+        custom_thumbnail?: any;
+        default_thumbnail?: string;
+        thumbnail?: string;
+        listing_count?: number;
+        parent_collection_count?: number;
+        owner?: Owner2;
+    }
+
+    export interface File {
+        id?: string;
+        url: string;
+        download_url?: string;
+        name: string;
+        create_time?: Date;
+        status?: string;
+        size?: number;
+        mime_type?: string;
+        content_encoding?: string;
+    }
+
+    export interface User {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        tier?: string;
+    }
+
+    export interface Comment {
+        id?: string;
+        content?: string;
+        node_id?: number;
+        create_time?: Date;
+        update_time?: any;
+        resolved?: boolean;
+        user?: User;
+    }
+
+    export interface Node {
+        id: string | number;
+        mode: string;
+        value: string;
+        pinned?: boolean;   // Show source code?
+        data?: any;
+        name?: string;
+        //  NodeEx  ---
+        start?: number;
+        end?: number;
+        private?: boolean;
+        outputs?: string[];
+    }
+
+    export interface Notebook {
+        id?: string;
+        slug?: any;
+        trashed?: boolean;
+        description?: string;
+        likes?: number;
+        publish_level?: string;
+        forks?: number;
+        fork_of?: any;
+        update_time?: Date;
+        publish_time?: Date;
+        publish_version?: number;
+        latest_version?: number;
+        thumbnail?: string;
+        default_thumbnail?: string;
+        roles?: any[];
+        sharing?: any;
+        owner?: Owner;
+        creator?: Creator;
+        authors?: Author[];
+        collections?: Collection[];
+        files: File[];
+        comments?: Comment[];
+        commenting_lock?: any;
+        suggestion_from?: any;
+        suggestions_to?: any[];
+        version?: number;
+        title?: string;
+        license?: string;
+        copyright?: string;
+        nodes: Node[];
+        resolutions?: any[];
+    }
+
+    //  @observablehq/runtime API  ---
+    export type InspectorFactory = (name?: string) => Inspector;
+
+    export interface Inspector {
+        _node?: HTMLDivElement;
+        pending();
+        fulfilled(value);
+        rejected(error);
+    }
+
+    export interface Runtime {
+        fileAttachments(func: (name: string) => ohq.File): any;
+        module(define?, inspector?: InspectorFactory): Module;
+        dispose(): void;
+    }
+
+    export interface Module {
+        derive(specifiers: string[] | { name: string, alias: string }[], source: any);
+        import(name: string, alias: string | undefined, mod: Module): Variable;
+        builtin(name: string, _: any);
+        variable(inspector?: Inspector): Variable;
+        value(name: string): Promise<any>;
+    }
+
+    export interface Variable {
+        delete();
+        define(name?: string, inputs?: string[], definition?: any);
+        import(name: string, otherModule: ohq.Module);
+        import(name: string, alias: string, otherModule: ohq.Module);
+    }
+}

package/src/util.ts

@@ -1,5 +1,5 @@
-import type { ohq } from "@hpcc-js/observable-shim";
-import { parseCell, splitModule } from "@hpcc-js/observable-shim";
+import type { ohq } from "./observable-shim.ts";
+import { parseCell, splitModule } from "./observable-shim.ts";
 
 const FuncTypes = {
     functionType: Object.getPrototypeOf(function () { }).constructor,
@@ -41,7 +41,7 @@ export function createFunction(refs: Refs, async = false, generator = false, blo
         `return (\n${body}\n);`);
 }
 
-function join(baseURL, relativeURL) {
+function join(baseURL: string, relativeURL: string) {
     return relativeURL
         ? baseURL.replace(/\/+$/, "") + "/" + relativeURL.replace(/^\/+/, "")
         : baseURL;
@@ -159,6 +159,9 @@ export function omd2notebook(omd: string): 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);
+    if (!matches || matches.length === 0) {
+        throw new Error(`Invalid URL:  ${url}`);
+    }
     return fetch(url, { headers: { origin: matches[0], referer: url } }).then(response => {
         if (response.ok) return response;
         throw new Error("CORS?");

package/src/writer.ts

@@ -1,5 +1,5 @@
-import { ohq } from "@hpcc-js/observable-shim";
-import { ParsedImportCell, ParsedVariable } from "./cst";
+import { ohq } from "./observable-shim.ts";
+import { ParsedImportCell, ParsedVariable } from "./cst.ts";
 
 export class Writer {
 
@@ -43,14 +43,16 @@ export default function define(runtime, observer) {
     }
 
     importDefine(imp: Partial<ParsedImportCell>) {
-        const injections = imp.injections.map(inj => {
+        const impInjections = imp.injections ?? [];
+        const injections = impInjections.map(inj => {
             return inj.name === inj.alias ?
                 `"${inj.name}"` :
                 `{name: "${inj.name}", alias: "${inj.alias}"}`;
         });
-        const derive = imp.injections.length ? `.derive([${injections.join(", ")}], main)` : "";
+        const derive = impInjections.length ? `.derive([${injections.join(", ")}], main)` : "";
         this._defines.push(`const child${this._defineUid} = runtime.module(define${this._defineUid})${derive};`);
-        imp.specifiers.forEach(s => {
+        const impSpecifiers = imp.specifiers ?? [];
+        impSpecifiers.forEach(s => {
             this._defines.push(`main.import("${s.name}"${s.alias && s.alias !== s.name ? `, "${s.alias}"` : ""}, child${this._defineUid}); `);
         });
     }
@@ -67,7 +69,8 @@ export default function define(runtime, observer) {
         funcId = funcId ?? variable.id;
         const observe = observable ? `.variable(observer(${variable.id ? JSON.stringify(variable.id) : ""}))` : "";
         const id = variable.id ? `${JSON.stringify(variable.id)}, ` : "";
-        const inputs = variable.inputs.length ? `[${variable.inputs.map(i => JSON.stringify(i)).join(", ")}], ` : "";
+        const variableInputs = variable.inputs ?? [];
+        const inputs = variableInputs.length ? `[${variableInputs.map(i => JSON.stringify(i)).join(", ")}], ` : "";
         const func = inlineFunc ?
             variable.func?.toString() :
             funcId;

package/types/compiler.d.ts

@@ -1,11 +1,11 @@
-import { ohq } from "@hpcc-js/observable-shim";
-import { Writer } from "./writer";
+import { ohq } from "./observable-shim.ts";
+import { Writer } from "./writer.ts";
 export type InspectorFactoryEx = (name: string | undefined, id: string | number) => Inspector;
 export interface Inspector {
     _node?: HTMLDivElement;
-    pending(): any;
-    fulfilled(value: any): any;
-    rejected(error: any): any;
+    pending(): void;
+    fulfilled(value: any): void;
+    rejected(error: Error): void;
 }
 declare function createCell(node: ohq.Node, options: CompileOptions): Promise<{
     (runtime: ohq.Runtime, main: ohq.Module, inspector?: InspectorFactoryEx): void;
@@ -66,7 +66,7 @@ export declare function notebook(_files?: ohq.File[], _cells?: CellFunc[], { bas
         write(w: Writer): void;
     }>;
     set(n: ohq.Node): Promise<CellFunc>;
-    get(id: string | number): CellFunc;
+    get(id: string | number): CellFunc | undefined;
     delete(id: string | number): boolean;
     clear(): void;
     write(w: Writer): void;
@@ -101,7 +101,7 @@ export declare function compile(notebookOrOjs: ohq.Notebook | string, { baseUrl,
         write(w: Writer): void;
     }>;
     set(n: ohq.Node): Promise<CellFunc>;
-    get(id: string | number): CellFunc;
+    get(id: string | number): CellFunc | undefined;
     delete(id: string | number): boolean;
     clear(): void;
     write(w: Writer): void;
@@ -109,4 +109,3 @@ export declare function compile(notebookOrOjs: ohq.Notebook | string, { baseUrl,
 }>;
 export type compileFunc = Awaited<ReturnType<typeof compile>>;
 export {};
-//# sourceMappingURL=compiler.d.ts.map

package/types/cst.d.ts

@@ -39,4 +39,3 @@ interface ParsedVariableCell extends ParsedCell {
 }
 export declare function parseCell(cellStr: string, baseUrl: string): ParsedImportCell | ParsedViewCell | ParsedMutableCell | ParsedVariableCell;
 export {};
-//# sourceMappingURL=cst.d.ts.map

package/types/index.d.ts

@@ -1,5 +1,5 @@
-export type { ohq } from "@hpcc-js/observable-shim";
-export * from "./compiler";
-export { ojs2notebook, omd2notebook, download } from "./util";
+export type { ohq } from "./observable-shim.ts";
+export * from "./compiler.ts";
+export { ojs2notebook, omd2notebook, download } from "./util.ts";
+export * from "./writer.ts";
 import "../src/index.css";
-//# sourceMappingURL=index.d.ts.map

package/types/observable-shim.d.ts

@@ -0,0 +1,2 @@
+export type { ohq } from "./types.ts";
+export * from "./parse.ts";

package/types/parse.d.ts

@@ -0,0 +1,26 @@
+import { Statement, ModuleDeclaration, Expression as ExpressionBase, Node } from "acorn";
+import { ancestor, RecursiveVisitors, AncestorVisitors } from "acorn-walk";
+export interface MutableExpression extends Node {
+    type: "MutableExpression";
+}
+export interface ViewExpression extends Node {
+    type: "ViewExpression";
+}
+export type Expression = ExpressionBase | MutableExpression | ViewExpression;
+export declare function parseModule(input: any, { globals }?: {
+    globals: any;
+}): any;
+export interface Cell extends Node {
+    type: "Cell";
+    id: Expression;
+    text: string;
+    body?: Statement | ModuleDeclaration | Expression;
+    references: unknown[];
+    async: boolean;
+    generator: boolean;
+    strict: boolean;
+}
+export declare function splitModule(input: string): Cell[];
+export { Node, ancestor, AncestorVisitors };
+export declare function parseCell(input: string): Cell;
+export declare const walk: RecursiveVisitors<any>;

package/types/types.d.ts

@@ -0,0 +1,165 @@
+export declare namespace ohq {
+    interface Owner {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        type?: string;
+        tier?: string;
+    }
+    interface Creator {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        tier?: string;
+    }
+    interface Author {
+        id?: string;
+        avatar_url?: string;
+        name?: string;
+        login?: string;
+        bio?: string;
+        home_url?: string;
+        github_login?: string;
+        tier?: string;
+        approved?: boolean;
+        description?: string;
+    }
+    interface Owner2 {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        type?: string;
+        tier?: string;
+    }
+    interface Collection {
+        id?: string;
+        type?: string;
+        slug?: string;
+        title?: string;
+        description?: string;
+        update_time?: Date;
+        pinned?: boolean;
+        ordered?: boolean;
+        custom_thumbnail?: any;
+        default_thumbnail?: string;
+        thumbnail?: string;
+        listing_count?: number;
+        parent_collection_count?: number;
+        owner?: Owner2;
+    }
+    interface File {
+        id?: string;
+        url: string;
+        download_url?: string;
+        name: string;
+        create_time?: Date;
+        status?: string;
+        size?: number;
+        mime_type?: string;
+        content_encoding?: string;
+    }
+    interface User {
+        id?: string;
+        github_login?: string;
+        avatar_url?: string;
+        login?: string;
+        name?: string;
+        bio?: string;
+        home_url?: string;
+        tier?: string;
+    }
+    interface Comment {
+        id?: string;
+        content?: string;
+        node_id?: number;
+        create_time?: Date;
+        update_time?: any;
+        resolved?: boolean;
+        user?: User;
+    }
+    interface Node {
+        id: string | number;
+        mode: string;
+        value: string;
+        pinned?: boolean;
+        data?: any;
+        name?: string;
+        start?: number;
+        end?: number;
+        private?: boolean;
+        outputs?: string[];
+    }
+    interface Notebook {
+        id?: string;
+        slug?: any;
+        trashed?: boolean;
+        description?: string;
+        likes?: number;
+        publish_level?: string;
+        forks?: number;
+        fork_of?: any;
+        update_time?: Date;
+        publish_time?: Date;
+        publish_version?: number;
+        latest_version?: number;
+        thumbnail?: string;
+        default_thumbnail?: string;
+        roles?: any[];
+        sharing?: any;
+        owner?: Owner;
+        creator?: Creator;
+        authors?: Author[];
+        collections?: Collection[];
+        files: File[];
+        comments?: Comment[];
+        commenting_lock?: any;
+        suggestion_from?: any;
+        suggestions_to?: any[];
+        version?: number;
+        title?: string;
+        license?: string;
+        copyright?: string;
+        nodes: Node[];
+        resolutions?: any[];
+    }
+    type InspectorFactory = (name?: string) => Inspector;
+    interface Inspector {
+        _node?: HTMLDivElement;
+        pending(): any;
+        fulfilled(value: any): any;
+        rejected(error: any): any;
+    }
+    interface Runtime {
+        fileAttachments(func: (name: string) => ohq.File): any;
+        module(define?: any, inspector?: InspectorFactory): Module;
+        dispose(): void;
+    }
+    interface Module {
+        derive(specifiers: string[] | {
+            name: string;
+            alias: string;
+        }[], source: any): any;
+        import(name: string, alias: string | undefined, mod: Module): Variable;
+        builtin(name: string, _: any): any;
+        variable(inspector?: Inspector): Variable;
+        value(name: string): Promise<any>;
+    }
+    interface Variable {
+        delete(): any;
+        define(name?: string, inputs?: string[], definition?: any): any;
+        import(name: string, otherModule: ohq.Module): any;
+        import(name: string, alias: string, otherModule: ohq.Module): any;
+    }
+}

package/types/util.d.ts

@@ -1,4 +1,4 @@
-import type { ohq } from "@hpcc-js/observable-shim";
+import type { ohq } from "./observable-shim.ts";
 interface Ref {
     start: number;
     end: number;
@@ -11,7 +11,7 @@ export interface Refs {
 }
 export declare function createFunction(refs: Refs, async?: boolean, generator?: boolean, blockStatement?: boolean, body?: string): any;
 export declare const isRelativePath: (path: string) => boolean;
-export declare const fixRelativeUrl: (path: string, basePath: string) => any;
+export declare const fixRelativeUrl: (path: string, basePath: string) => string;
 export declare function obfuscatedImport(url: string): Promise<any>;
 interface ParsedOJS {
     ojs: string;
@@ -27,4 +27,3 @@ export declare function omd2notebook(omd: string): ohq.Notebook;
 export declare function fetchEx(url: string, proxyPrefix?: string, proxyPostfix?: string): Promise<Response>;
 export declare function download(impUrl: string, proxyPrefix?: string, proxyPostfix?: string): Promise<ohq.Notebook>;
 export {};
-//# sourceMappingURL=util.d.ts.map

package/types/writer.d.ts

@@ -1,5 +1,5 @@
-import { ohq } from "@hpcc-js/observable-shim";
-import { ParsedImportCell, ParsedVariable } from "./cst";
+import { ohq } from "./observable-shim.ts";
+import { ParsedImportCell, ParsedVariable } from "./cst.ts";
 export declare class Writer {
     protected _files: ohq.File[];
     protected _imports: string[];
@@ -16,4 +16,3 @@ export declare class Writer {
     define(variable: Partial<ParsedVariable>, observable?: boolean, inlineFunc?: boolean, funcId?: string): void;
     error(msg: string): void;
 }
-//# sourceMappingURL=writer.d.ts.map

package/dist/index.esm.css

@@ -1 +0,0 @@
-@import url("https://fonts.googleapis.com/css2?family=Source+Serif+Pro:ital,wght@0,400;0,600;0,700;1,400;1,600;1,700&display=swap");:root{--syntax-normal:#1b1e23;--syntax-comment:#828282;--syntax-number:#20a5ba;--syntax-keyword:#c30771;--syntax-atom:#10a778;--syntax-string:#008ec4;--syntax-error:#ffbedc;--syntax-unknown-variable:#838383;--syntax-known-variable:#005f87;--syntax-matchbracket:#20bbfc;--syntax-key:#6636b4;--mono-fonts:82%/1.5 Menlo,Consolas,monospace}.observablehq--collapsed,.observablehq--expanded,.observablehq--function,.observablehq--gray,.observablehq--import,.observablehq--string:after,.observablehq--string:before{color:var(--syntax-normal)}.observablehq--collapsed,.observablehq--expanded.observablehq--inspect a{cursor:pointer}.observablehq--field{margin-left:1em;text-indent:-1em}.observablehq--empty{color:var(--syntax_comment)}.observablehq--blue,.observablehq--keyword,a[href]{color:#3182bd}.hljs-deletion,.hljs-variable,.observablehq--forbidden,.observablehq--pink{color:#e377c2}.observablehq--orange{color:#e6550d}.hljs-literal,.observablehq--boolean,.observablehq--null,.observablehq--undefined{color:var(--syntax-atom)}.hljs-bullet,.hljs-link,.hljs-number,.hljs-regexp,.observablehq--bigint,.observablehq--date,.observablehq--green,.observablehq--number,.observablehq--regexp,.observablehq--symbol{color:var(--syntax-number)}.observablehq--index,.observablehq--key{color:var(--syntax-key)}.observablehq--prototype-key{color:#aaa}.observablehq--empty{font-style:oblique}.hljs-addition,.hljs-meta,.hljs-string,.hljs-symbol,.hljs-template-tag,.hljs-template-variable,.observablehq--purple,.observablehq--string{color:var(--syntax-string)}.observablehq--error,.observablehq--red{color:#e7040f}.observablehq--inspect,.observablehq:empty:after,.observablehq>link:only-child,.observablehq>style:only-child{display:block;font:var(--monospace-font);overflow-x:auto;padding:4px 0;white-space:pre}.observablehq--error .observablehq--inspect{white-space:pre-wrap;word-break:break-all}:root{--syntax-diff:#24292e;--syntax-diff-bg:#fff;--hr:rgba(0,0,0,.05);--monospace:Menlo,Consolas,monospace;--monospace-font:14px/1.5 var(--monospace);--serif:"Source Serif Pro","Iowan Old Style","Apple Garamond","Palatino Linotype","Times New Roman","Droid Serif",Times,serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--sans-serif:-apple-system,BlinkMacSystemFont,"avenir next",avenir,helvetica,"helvetica neue",ubuntu,roboto,noto,"segoe ui",arial,sans-serif}html{-webkit-text-size-adjust:100%;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;color:#1b1e23;font:17px/1.5 var(--serif)}body{margin:0 14px}body.fullscreen{margin:0}h1,h2,h3,h4,h5,h6{color:#333;font-weight:700;line-height:1.15;margin-bottom:.25rem;margin-top:0}h2~p,h2~table,h3~p,h3~table,h4~p,h4~table{margin-top:0}.observablehq:first-of-type h1+h2{font-size:20px;font-style:italic;font-weight:400;margin-bottom:1rem}a[href]{text-decoration:none}a[href]:hover{text-decoration:underline}h1 code,h2 code,h3 code,h4 code,h5 code,h6 code{font-size:90%}code,pre,tt{font-family:var(--monospace);font-size:14px;line-height:1.5}img{max-width:calc(100vw - 28px)}.katex-display,figcaption,figure,h1,h2,h3,h4,h5,h6,p,table{max-width:640px}blockquote,ol,ul{max-width:600px}blockquote{margin:1rem 1.5rem}ol,ul{padding-left:28px}hr{background:no-repeat 50%/100% 1px linear-gradient(to right,var(--hr),var(--hr));border:none;height:1px;margin:1rem 0;padding:1rem 0}pre{padding:2px 0}.observablehq--md-pre{overflow-x:auto}input:not([type]),input[type=email],input[type=number],input[type=password],input[type=range],input[type=search],input[type=tel],input[type=text],input[type=url]{width:240px}button,canvas,input{vertical-align:middle}button,input,textarea{accent-color:#3b5fc0}table{border-collapse:collapse;font:13px/1.2 var(--sans-serif);width:100%}table code,table pre,table tt{font-size:inherit;line-height:inherit}td>pre:only-child,th>pre:only-child{margin:0;padding:0}th{color:#111;text-align:left;vertical-align:bottom}td{color:#444;vertical-align:top}td,th{padding:3px 6.5px 3px 0}td:last-child,th:last-child{padding-right:0}tr:not(:last-child){border-bottom:1px solid #eee}thead tr{border-bottom:1px solid #ccc}figure,table{margin:1rem 0}figure img{max-width:100%}figcaption{color:var(--syntax-unknown-variable);font:small var(--sans-serif)}.observablehq--caret{margin-right:4px;vertical-align:baseline}.observablehq--field{margin-left:1rem;text-indent:-1rem}.hljs-comment,.observablehq--empty,.observablehq--prototype-key{color:var(--syntax-comment)}.hljs-built_in{color:var(--syntax-known-variable)}.observablehq--unknown{color:var(--syntax-unknown-variable)}.hljs-doctag,.hljs-keyword,.hljs-name,.hljs-section,.hljs-selector-class,.hljs-selector-id,.hljs-selector-tag,.hljs-strong,.hljs-tag,.hljs-type{color:var(--syntax-keyword)}.observablehq{margin:17px 0;min-height:1.5rem;position:relative}.observablehq:before{bottom:1px;content:"";left:-14px;position:absolute;top:0;transition:background-color .25s linear;width:4px}.observablehq--changed:before,.observablehq--running:before{background-color:#a9b0bc;transition:none}.observablehq--error:before{background-color:#e7040f}.observablehq:not(.observablehq--running):empty:after{color:var(--syntax-comment);content:"<detached>";font-style:oblique}.observablehq>link:only-child,.observablehq>style:only-child{color:var(--syntax-keyword);visibility:hidden;white-space:nowrap}.observablehq>link:only-child:before{content:"<link>";pointer-events:none;text-decoration:none;visibility:visible}.observablehq>style:only-child:before{content:"<style>";visibility:visible}.observablehq--inspect.observablehq--import{white-space:normal}.observablehq--inspect::-webkit-scrollbar{display:none}.observablehq--string-expand{background:#eee;border-radius:2px;color:var(--syntax-normal);cursor:pointer;font-size:80%;margin-left:6px;padding:2px 6px;position:sticky;right:0;vertical-align:middle}.observablehq--string-expand:active,.observablehq--string-expand:hover{background:#ddd}