@pyscript/core 0.1.18 → 0.1.19

package/dist/error-87e0706c.js

@@ -0,0 +1,2 @@
+import{hooks as e}from"./core.js";function o(e){const o=document.createElement("div");o.className="py-error",o.textContent=e,o.style.cssText="\n    border: 1px solid red;\n    background: #ffdddd;\n    color: black;\n    font-family: courier, monospace;\n    white-space: pre;\n    overflow-x: auto;\n    padding: 8px;\n    margin-top: 8px;\n  ",document.body.append(o)}e.onBeforeRun.add((function n(r){e.onBeforeRun.delete(n);const{stderr:t}=r.io;r.io.stderr=(e,...n)=>(o(e.message||e),t(e,...n)),addEventListener("error",(({message:e})=>{e.startsWith("Uncaught PythonError")&&o(e)}))}));export{o as notify};
+//# sourceMappingURL=error-87e0706c.js.map

package/dist/error-87e0706c.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-87e0706c.js","sources":["../src/plugins/error.js"],"sourcesContent":["// PyScript Error Plugin\nimport { hooks } from \"../core.js\";\n\nhooks.onBeforeRun.add(function override(pyScript) {\n    // be sure this override happens only once\n    hooks.onBeforeRun.delete(override);\n\n    // trap generic `stderr` to propagate to it regardless\n    const { stderr } = pyScript.io;\n\n    // override it with our own logic\n    pyScript.io.stderr = (error, ...rest) => {\n        notify(error.message || error);\n        // let other plugins or stderr hook, if any, do the rest\n        return stderr(error, ...rest);\n    };\n\n    // be sure uncaught Python errors are also visible\n    addEventListener(\"error\", ({ message }) => {\n        if (message.startsWith(\"Uncaught PythonError\")) notify(message);\n    });\n});\n\n// Error hook utilities\n\n// Custom function to show notifications\nexport function notify(message) {\n    const div = document.createElement(\"div\");\n    div.className = \"py-error\";\n    div.textContent = message;\n    div.style.cssText = `\n    border: 1px solid red;\n    background: #ffdddd;\n    color: black;\n    font-family: courier, monospace;\n    white-space: pre;\n    overflow-x: auto;\n    padding: 8px;\n    margin-top: 8px;\n  `;\n    document.body.append(div);\n}\n"],"names":["notify","message","div","document","createElement","className","textContent","style","cssText","body","append","hooks","onBeforeRun","add","override","pyScript","delete","stderr","io","error","rest","addEventListener","startsWith"],"mappings":"kCA0BO,SAASA,EAAOC,GACnB,MAAMC,EAAMC,SAASC,cAAc,OACnCF,EAAIG,UAAY,WAChBH,EAAII,YAAcL,EAClBC,EAAIK,MAAMC,QAAU,6MAUpBL,SAASM,KAAKC,OAAOR,EACzB,CAtCAS,EAAMC,YAAYC,KAAI,SAASC,EAASC,GAEpCJ,EAAMC,YAAYI,OAAOF,GAGzB,MAAMG,OAAEA,GAAWF,EAASG,GAG5BH,EAASG,GAAGD,OAAS,CAACE,KAAUC,KAC5BpB,EAAOmB,EAAMlB,SAAWkB,GAEjBF,EAAOE,KAAUC,IAI5BC,iBAAiB,SAAS,EAAGpB,cACrBA,EAAQqB,WAAW,yBAAyBtB,EAAOC,EAAQ,GAEvE"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pyscript/core",
-    "version": "0.1.18",
+    "version": "0.1.19",
     "type": "module",
     "description": "PyScript",
     "module": "./index.js",
@@ -21,6 +21,7 @@
     "scripts": {
         "server": "npx static-handler --cors --coep --coop --corp .",
         "build": "node rollup/stdlib.cjs && node rollup/plugins.cjs && rm -rf dist && rollup --config rollup/core.config.js && npm run ts",
+        "size": "echo -e \"\\033[1mdist/*.js file size\\033[0m\"; for js in $(ls dist/*.js); do echo -e \"\\033[2m$js:\\033[0m $(cat $js | brotli | wc -c) bytes\"; done",
         "ts": "tsc -p ."
     },
     "keywords": [

package/src/config.js

@@ -0,0 +1,102 @@
+/**
+ * This file parses a generic <py-config> or config attribute
+ * to use as base config for all py-script elements, importing
+ * also a queue of plugins *before* the interpreter (if any) resolves.
+ */
+import { $ } from "basic-devtools";
+
+import allPlugins from "./plugins.js";
+import { robustFetch as fetch, getText } from "./fetch.js";
+import { ErrorCode } from "./exceptions.js";
+
+const badURL = (url, expected = "") => {
+    let message = `(${ErrorCode.BAD_CONFIG}): Invalid URL: ${url}`;
+    if (expected) message += `\nexpected ${expected} content`;
+    throw new Error(message);
+};
+
+/**
+ * Given a string, returns its trimmed content as text,
+ * fetching it from a file if the content is a URL.
+ * @param {string} config either JSON, TOML, or a file to fetch
+ * @returns {{json: boolean, toml: boolean, text: string}}
+ */
+const configDetails = async (config) => {
+    let text = config?.trim();
+    // we only support an object as root config
+    let url = "",
+        toml = false,
+        json = /^{/.test(text) && /}$/.test(text);
+    // handle files by extension (relaxing urls parts after)
+    if (!json && /\.(\w+)(?:\?\S*)?$/.test(text)) {
+        const ext = RegExp.$1;
+        if (ext === "json" && type !== "toml") json = true;
+        else if (ext === "toml" && type !== "json") toml = true;
+        else badURL(text, type);
+        url = text;
+        text = (await fetch(url).then(getText)).trim();
+    }
+    return { json, toml: toml || (!json && !!text), text, url };
+};
+
+const syntaxError = (type, url, { message }) => {
+    let str = `(${ErrorCode.BAD_CONFIG}): Invalid ${type}`;
+    if (url) str += ` @ ${url}`;
+    return new SyntaxError(`${str}\n${message}`);
+};
+
+// find the shared config for all py-script elements
+let config, plugins, parsed, error, type;
+let pyConfig = $("py-config");
+if (pyConfig) config = pyConfig.getAttribute("src") || pyConfig.textContent;
+else {
+    pyConfig = $('script[type="py"][config]');
+    if (pyConfig) config = pyConfig.getAttribute("config");
+}
+if (pyConfig) type = pyConfig.getAttribute("type");
+
+// catch possible fetch errors
+try {
+    const { json, toml, text, url } = await configDetails(config);
+    config = text;
+    if (json || type === "json") {
+        try {
+            parsed = JSON.parse(text);
+        } catch (e) {
+            error = syntaxError("JSON", url, e);
+        }
+    } else if (toml || type === "toml") {
+        try {
+            const { parse } = await import(
+                /* webpackIgnore: true */
+                "https://cdn.jsdelivr.net/npm/@webreflection/toml-j0.4/toml.js"
+            );
+            parsed = parse(text);
+        } catch (e) {
+            error = syntaxError("TOML", url, e);
+        }
+    }
+} catch (e) {
+    error = e;
+}
+
+// parse all plugins and optionally ignore only
+// those flagged as "undesired" via `!` prefix
+const toBeAwaited = [];
+for (const [key, value] of Object.entries(allPlugins)) {
+    if (error) {
+        if (key === "error") {
+            // show on page the config is broken, meaning that
+            // it was not possible to disable error plugin neither
+            // as that part wasn't correctly parsed anyway
+            value().then(({ notify }) => notify(error.message));
+        }
+    } else if (!parsed?.plugins?.includes(`!${key}`)) {
+        toBeAwaited.push(value());
+    }
+}
+
+// assign plugins as Promise.all only if needed
+if (toBeAwaited.length) plugins = Promise.all(toBeAwaited);
+
+export { config, plugins, error };

package/src/core.js

@@ -1,12 +1,7 @@
 /*! (c) PyScript Development Team */
 
 import "@ungap/with-resolvers";
-import { $ } from "basic-devtools";
 import { define, XWorker } from "polyscript";
-import sync from "./sync.js";
-
-import stdlib from "./stdlib.js";
-import plugins from "./plugins.js";
 
 // TODO: this is not strictly polyscript related but handy ... not sure
 //       we should factor this utility out a part but this works anyway.
@@ -14,29 +9,21 @@ import { queryTarget } from "../node_modules/polyscript/esm/script-handler.js";
 import { dedent, dispatch } from "../node_modules/polyscript/esm/utils.js";
 import { Hook } from "../node_modules/polyscript/esm/worker/hooks.js";
 
-import { robustFetch as fetch } from "./fetch.js";
+import sync from "./sync.js";
+import stdlib from "./stdlib.js";
+import { config, plugins, error } from "./config.js";
+import { robustFetch as fetch, getText } from "./fetch.js";
 
 const { assign, defineProperty, entries } = Object;
 
-const getText = (body) => body.text();
+const TYPE = "py";
 
 // allows lazy element features on code evaluation
 let currentElement;
 
 // create a unique identifier when/if needed
 let id = 0;
-const getID = (prefix = "py") => `${prefix}-${id++}`;
-
-// find the shared config for all py-script elements
-let config;
-let pyConfig = $("py-config");
-if (pyConfig) config = pyConfig.getAttribute("src") || pyConfig.textContent;
-else {
-    pyConfig = $('script[type="py"]');
-    config = pyConfig?.getAttribute("config");
-}
-
-if (/^https?:\/\//.test(config)) config = await fetch(config).then(getText);
+const getID = (prefix = TYPE) => `${prefix}-${id++}`;
 
 // generic helper to disambiguate between custom element and script
 const isScript = ({ tagName }) => tagName === "SCRIPT";
@@ -70,7 +57,7 @@ const fetchSource = async (tag, io, asText) => {
     if (asText) return dedent(tag.textContent);
 
     console.warn(
-        'Deprecated: use <script type="py"> for an always safe content parsing:\n',
+        `Deprecated: use <script type="${TYPE}"> for an always safe content parsing:\n`,
         tag.innerHTML,
     );
 
@@ -140,92 +127,82 @@ const workerHooks = {
         [...hooks.codeAfterRunWorkerAsync].map(dedent).join("\n"),
 };
 
-// avoid running further script if the previous one had
-// some import that would inevitably delay its execution
-let queuePlugins;
-
 // define the module as both `<script type="py">` and `<py-script>`
-define("py", {
-    config,
-    env: "py-script",
-    interpreter: "pyodide",
-    ...workerHooks,
-    onWorkerReady(_, xworker) {
-        assign(xworker.sync, sync);
-    },
-    onBeforeRun(pyodide, element) {
-        currentElement = element;
-        bootstrapNodeAndPlugins(pyodide, element, before, "onBeforeRun");
-    },
-    onBeforeRunAsync(pyodide, element) {
-        currentElement = element;
-        bootstrapNodeAndPlugins(pyodide, element, before, "onBeforeRunAsync");
-    },
-    onAfterRun(pyodide, element) {
-        bootstrapNodeAndPlugins(pyodide, element, after, "onAfterRun");
-    },
-    onAfterRunAsync(pyodide, element) {
-        bootstrapNodeAndPlugins(pyodide, element, after, "onAfterRunAsync");
-    },
-    async onInterpreterReady(pyodide, element) {
-        if (shouldRegister) {
-            shouldRegister = false;
-            registerModule(pyodide);
-        }
-
-        // load plugins unless specified otherwise
-        const toBeAwaited = [];
-        for (const [key, value] of entries(plugins)) {
-            if (!pyodide.config?.plugins?.includes(`!${key}`))
-                toBeAwaited.push(value());
-        }
-
-        // this grants queued results when first script/tag has plugins
-        // and the second one *might* rely on first tag execution
-        if (toBeAwaited.length) {
-            const all = Promise.all(toBeAwaited);
-            queuePlugins = queuePlugins ? queuePlugins.then(() => all) : all;
-        }
-
-        if (queuePlugins) await queuePlugins;
-
-        // allows plugins to do whatever they want with the element
-        // before regular stuff happens in here
-        for (const callback of hooks.onInterpreterReady)
-            callback(pyodide, element);
-
-        if (isScript(element)) {
-            const {
-                attributes: { async: isAsync, target },
-            } = element;
-            const hasTarget = !!target?.value;
-            const show = hasTarget
-                ? queryTarget(target.value)
-                : document.createElement("script-py");
-
-            if (!hasTarget) {
-                const { head, body } = document;
-                if (head.contains(element)) body.append(show);
-                else element.after(show);
+// but only if the config didn't throw an error
+error ||
+    define(TYPE, {
+        config,
+        env: `${TYPE}-script`,
+        interpreter: "pyodide",
+        ...workerHooks,
+        onWorkerReady(_, xworker) {
+            assign(xworker.sync, sync);
+        },
+        onBeforeRun(pyodide, element) {
+            currentElement = element;
+            bootstrapNodeAndPlugins(pyodide, element, before, "onBeforeRun");
+        },
+        onBeforeRunAsync(pyodide, element) {
+            currentElement = element;
+            bootstrapNodeAndPlugins(
+                pyodide,
+                element,
+                before,
+                "onBeforeRunAsync",
+            );
+        },
+        onAfterRun(pyodide, element) {
+            bootstrapNodeAndPlugins(pyodide, element, after, "onAfterRun");
+        },
+        onAfterRunAsync(pyodide, element) {
+            bootstrapNodeAndPlugins(pyodide, element, after, "onAfterRunAsync");
+        },
+        async onInterpreterReady(pyodide, element) {
+            if (shouldRegister) {
+                shouldRegister = false;
+                registerModule(pyodide);
             }
-            if (!show.id) show.id = getID();
 
-            // allows the code to retrieve the target element via
-            // document.currentScript.target if needed
-            defineProperty(element, "target", { value: show });
-
-            // notify before the code runs
-            dispatch(element, "py");
-            pyodide[`run${isAsync ? "Async" : ""}`](
-                await fetchSource(element, pyodide.io, true),
-            );
-        } else {
-            // resolve PyScriptElement to allow connectedCallback
-            element._pyodide.resolve(pyodide);
-        }
-        console.debug("[pyscript/main] PyScript Ready");
-    },
-});
+            // ensure plugins are bootstrapped already
+            if (plugins) await plugins;
+
+            // allows plugins to do whatever they want with the element
+            // before regular stuff happens in here
+            for (const callback of hooks.onInterpreterReady)
+                callback(pyodide, element);
+
+            if (isScript(element)) {
+                const {
+                    attributes: { async: isAsync, target },
+                } = element;
+                const hasTarget = !!target?.value;
+                const show = hasTarget
+                    ? queryTarget(target.value)
+                    : document.createElement("script-py");
+
+                if (!hasTarget) {
+                    const { head, body } = document;
+                    if (head.contains(element)) body.append(show);
+                    else element.after(show);
+                }
+                if (!show.id) show.id = getID();
+
+                // allows the code to retrieve the target element via
+                // document.currentScript.target if needed
+                defineProperty(element, "target", { value: show });
+
+                // notify before the code runs
+                dispatch(element, TYPE);
+                pyodide[`run${isAsync ? "Async" : ""}`](
+                    await fetchSource(element, pyodide.io, true),
+                );
+            } else {
+                // resolve PyScriptElement to allow connectedCallback
+                element._pyodide.resolve(pyodide);
+            }
+            console.debug("[pyscript/main] PyScript Ready");
+        },
+    });
 
 class PyScriptElement extends HTMLElement {
     constructor() {
@@ -249,14 +226,15 @@ class PyScriptElement extends HTMLElement {
             this.srcCode = await fetchSource(this, io, !this.childElementCount);
             this.replaceChildren();
             // notify before the code runs
-            dispatch(this, "py");
+            dispatch(this, TYPE);
             runner(this.srcCode);
             this.style.display = "block";
         }
     }
 }
 
-customElements.define("py-script", PyScriptElement);
+// define py-script only if the config didn't throw an error
+error || customElements.define("py-script", PyScriptElement);
 
 /**
  * A `Worker` facade able to bootstrap on the worker thread only a PyScript module.

package/src/fetch.js

@@ -1,4 +1,7 @@
 import { FetchError, ErrorCode } from "./exceptions.js";
+import { getText } from "../node_modules/polyscript/esm/fetch-utils.js";
+
+export { getText };
 
 /**
  * This is a fetch wrapper that handles any non 200 responses and throws a

package/src/plugins/error.js

@@ -24,7 +24,7 @@ hooks.onBeforeRun.add(function override(pyScript) {
 // Error hook utilities
 
 // Custom function to show notifications
-function notify(message) {
+export function notify(message) {
     const div = document.createElement("div");
     div.className = "py-error";
     div.textContent = message;

package/src/plugins.js

@@ -1,4 +1,4 @@
 // ⚠️ This file is an artifact: DO NOT MODIFY
 export default {
-    error: () => import("./plugins/error.js"),
+    error: () => import(/* webpackIgnore: true */ "./plugins/error.js"),
 };

package/types/config.d.ts

@@ -0,0 +1,3 @@
+export let config: any;
+export let plugins: any;
+export let error: any;

package/types/core.d.ts

@@ -21,6 +21,5 @@ export namespace hooks {
     let codeAfterRunWorker: Set<string>;
     let codeAfterRunWorkerAsync: Set<string>;
 }
-declare let config: any;
+import { config } from "./config.js";
 import sync from "./sync.js";
-export {};

package/types/fetch.d.ts

@@ -8,3 +8,4 @@
  * @returns {Promise<Response>}
  */
 export function robustFetch(url: string, options?: Request): Promise<Response>;
+export { getText };

package/types/plugins/error.d.ts

@@ -1 +1 @@
-export {};
+export function notify(message: any): void;

package/dist/error-91f1c2f6.js

@@ -1,2 +0,0 @@
-import{hooks as e}from"./core.js";function n(e){const n=document.createElement("div");n.className="py-error",n.textContent=e,n.style.cssText="\n    border: 1px solid red;\n    background: #ffdddd;\n    color: black;\n    font-family: courier, monospace;\n    white-space: pre;\n    overflow-x: auto;\n    padding: 8px;\n    margin-top: 8px;\n  ",document.body.append(n)}e.onBeforeRun.add((function o(r){e.onBeforeRun.delete(o);const{stderr:t}=r.io;r.io.stderr=(e,...o)=>(n(e.message||e),t(e,...o)),addEventListener("error",(({message:e})=>{e.startsWith("Uncaught PythonError")&&n(e)}))}));
-//# sourceMappingURL=error-91f1c2f6.js.map

package/dist/error-91f1c2f6.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-91f1c2f6.js","sources":["../src/plugins/error.js"],"sourcesContent":["// PyScript Error Plugin\nimport { hooks } from \"../core.js\";\n\nhooks.onBeforeRun.add(function override(pyScript) {\n    // be sure this override happens only once\n    hooks.onBeforeRun.delete(override);\n\n    // trap generic `stderr` to propagate to it regardless\n    const { stderr } = pyScript.io;\n\n    // override it with our own logic\n    pyScript.io.stderr = (error, ...rest) => {\n        notify(error.message || error);\n        // let other plugins or stderr hook, if any, do the rest\n        return stderr(error, ...rest);\n    };\n\n    // be sure uncaught Python errors are also visible\n    addEventListener(\"error\", ({ message }) => {\n        if (message.startsWith(\"Uncaught PythonError\")) notify(message);\n    });\n});\n\n// Error hook utilities\n\n// Custom function to show notifications\nfunction notify(message) {\n    const div = document.createElement(\"div\");\n    div.className = \"py-error\";\n    div.textContent = message;\n    div.style.cssText = `\n    border: 1px solid red;\n    background: #ffdddd;\n    color: black;\n    font-family: courier, monospace;\n    white-space: pre;\n    overflow-x: auto;\n    padding: 8px;\n    margin-top: 8px;\n  `;\n    document.body.append(div);\n}\n"],"names":["notify","message","div","document","createElement","className","textContent","style","cssText","body","append","hooks","onBeforeRun","add","override","pyScript","delete","stderr","io","error","rest","addEventListener","startsWith"],"mappings":"kCA0BA,SAASA,EAAOC,GACZ,MAAMC,EAAMC,SAASC,cAAc,OACnCF,EAAIG,UAAY,WAChBH,EAAII,YAAcL,EAClBC,EAAIK,MAAMC,QAAU,6MAUpBL,SAASM,KAAKC,OAAOR,EACzB,CAtCAS,EAAMC,YAAYC,KAAI,SAASC,EAASC,GAEpCJ,EAAMC,YAAYI,OAAOF,GAGzB,MAAMG,OAAEA,GAAWF,EAASG,GAG5BH,EAASG,GAAGD,OAAS,CAACE,KAAUC,KAC5BpB,EAAOmB,EAAMlB,SAAWkB,GAEjBF,EAAOE,KAAUC,IAI5BC,iBAAiB,SAAS,EAAGpB,cACrBA,EAAQqB,WAAW,yBAAyBtB,EAAOC,EAAQ,GAEvE"}