@microbit/makecode-embed 0.0.0-alpha.7 → 0.2.0

package/dist/cjs/vanilla/makecode-render-blocks.js

@@ -0,0 +1,217 @@
+"use strict";
+/**
+ * MakeCode handling that does not depend on React.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMakeCodeRenderBlocks = void 0;
+const disposedMessage = 'Disposed';
+const makecodeFailedToLoadMessage = 'Failed to load MakeCode to render blocks.';
+const createMakeCodeRenderBlocks = (options) => {
+    const defaultedOptions = {
+        ...options,
+    };
+    const makecodeOrigin = 'https://makecode.microbit.org';
+    let iframe;
+    let status = 'loading';
+    const requestStatus = {
+        nextRequest: 0,
+        pendingRequests: {},
+    };
+    const pendingRequests = requestStatus.pendingRequests;
+    const failAllPending = (errorMessage) => {
+        Object.keys(requestStatus.pendingRequests).forEach((k) => {
+            const { promise } = pendingRequests[k];
+            delete pendingRequests[k];
+            promise.reject(errorMessage);
+        });
+    };
+    const sendPendingIfReady = () => {
+        if (status === 'ready') {
+            // Possible that dispose has been called by the time we process the message,
+            // in which case do nothing.
+            if (iframe) {
+                Object.values(pendingRequests).forEach((rr) => ensureMessageSent(rr));
+            }
+        }
+        else if (status === 'error') {
+            failAllPending(makecodeFailedToLoadMessage);
+        }
+        else if (status === 'disabled') {
+            failAllPending('renderBlocks will always fail when explicitly disabled');
+        }
+        else {
+            // We're loading, we'll send these when done.
+        }
+    };
+    const ensureMessageSent = (rr) => {
+        if (!rr.sent) {
+            rr.sent = true;
+            const { req } = rr;
+            iframe.contentWindow.postMessage(req, makecodeOrigin);
+        }
+    };
+    const findBestCode = (code, ignoreBlocks) => {
+        if (typeof code === 'string') {
+            return { code, type: 'text' };
+        }
+        if (code.text) {
+            const blocks = code.text['main.blocks'];
+            const text = code.text['main.ts'];
+            if (blocks && !ignoreBlocks) {
+                return {
+                    code: blocks,
+                    type: 'blocks',
+                };
+            }
+            if (text) {
+                return {
+                    code: text,
+                    type: 'text',
+                };
+            }
+        }
+        return { code: '', type: 'text' };
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let errorTimeout;
+    const handleMessage = (ev) => {
+        const msg = ev.data;
+        if (ev.source !== iframe?.contentWindow || msg.source !== 'makecode') {
+            return;
+        }
+        switch (msg.type) {
+            case 'renderready': {
+                window.clearTimeout(errorTimeout);
+                status = 'ready';
+                sendPendingIfReady();
+                break;
+            }
+            case 'renderblocks': {
+                const id = msg.id;
+                const matchingRequest = pendingRequests[id];
+                if (!matchingRequest) {
+                    return;
+                }
+                const result = msg;
+                // This currently happens for extension blocks.
+                // We retry with text based rendering.
+                // MakeCode beta appears to do this internally.
+                if (!result.error &&
+                    !result.width &&
+                    !result.height &&
+                    !result.svg &&
+                    !result.uri) {
+                    if (matchingRequest.type === 'blocks') {
+                        matchingRequest.sent = false;
+                        matchingRequest.type = 'text';
+                        matchingRequest.req.code = findBestCode(matchingRequest.input, true).code;
+                        ensureMessageSent(matchingRequest);
+                        return;
+                    }
+                    else {
+                        result.error = 'Internal MakeCode failure.';
+                    }
+                }
+                delete pendingRequests[id];
+                if (result.error) {
+                    matchingRequest.promise.reject(result.error);
+                }
+                else {
+                    matchingRequest.promise.resolve(msg);
+                }
+                break;
+            }
+        }
+    };
+    return {
+        initialize: () => {
+            if (options.disabled) {
+                return;
+            }
+            window.addEventListener('message', handleMessage);
+            iframe = createIframe(makecodeOrigin, defaultedOptions);
+            errorTimeout = setTimeout(() => {
+                failAllPending(makecodeFailedToLoadMessage);
+                status = 'error';
+            }, 30000);
+        },
+        dispose: () => {
+            window.clearTimeout(errorTimeout);
+            window.removeEventListener('message', handleMessage);
+            if (iframe && iframe.parentNode) {
+                iframe.parentNode.removeChild(iframe);
+            }
+            iframe = undefined;
+            failAllPending(disposedMessage);
+        },
+        renderBlocks: (req) => {
+            const id = requestStatus.nextRequest++ + '';
+            const { code, type } = findBestCode(req.code);
+            const makecodeRequest = {
+                id,
+                code,
+                type: 'renderblocks',
+                options: {
+                    ...req.options,
+                    // To include files to filesystem
+                    assets: typeof req.code === 'object' ? req.code.text : undefined,
+                    package: defaultPackageFromDependencies(req),
+                },
+            };
+            return new Promise((resolve, reject) => {
+                pendingRequests[id] = {
+                    type,
+                    input: req.code,
+                    sent: false,
+                    req: makecodeRequest,
+                    promise: { resolve, reject },
+                };
+                sendPendingIfReady();
+            });
+        },
+    };
+};
+exports.createMakeCodeRenderBlocks = createMakeCodeRenderBlocks;
+function defaultPackageFromDependencies(req) {
+    // Package can encode the extensions used in a comma separated list in this format:
+    // automationbit=github:pimoroni/pxt-automationbit#v0.0.2
+    // We can find that list from the JSON passed (but not from blocks or text)
+    const _package = req.options && req.options.package ? req.options.package : undefined;
+    if (typeof _package === 'undefined' &&
+        typeof req.code === 'object' &&
+        req.code.text['pxt.json']) {
+        const parsed = JSON.parse(req.code.text['pxt.json']);
+        if (typeof parsed === 'object') {
+            // Cope with extensions with spaces in their names. Otherwise pxt rejects
+            // adding the dependency even if it would in normal usage.
+            // https://github.com/microbit-foundation/classroom-management-tool/issues/463
+            const sanitizedName = (s) => s.replace(/[^a-zA-Z0-9_-]/g, '_');
+            const dependencies = parsed.dependencies || {};
+            const result = Object.keys(dependencies)
+                .map((name) => `${sanitizedName(name)}=${dependencies[name]}`)
+                .join(',');
+            return result;
+        }
+    }
+    return _package;
+}
+function createIframe(makecodeOrigin, { lang, version }) {
+    const query = `?render=1${lang ? `&lang=${encodeURIComponent(lang)}` : ''}`;
+    const src = [makecodeOrigin, version, '--docs'].filter(Boolean).join('/') + query;
+    const f = document.createElement('iframe');
+    f.style.position = 'absolute';
+    f.style.width = '1px';
+    f.style.height = '1px';
+    f.style.border = '0';
+    f.style.clip = 'rect(0 0 0 0)';
+    f.style.margin = '-1px';
+    f.style.padding = '0';
+    f.style.overflow = 'hidden';
+    f.style.whiteSpace = 'nowrap';
+    f.setAttribute('loading', 'eager');
+    f.setAttribute('aria-hidden', 'true');
+    f.src = src;
+    document.body.appendChild(f);
+    return f;
+}
+//# sourceMappingURL=makecode-render-blocks.js.map

package/dist/cjs/vanilla/makecode-render-blocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"makecode-render-blocks.js","sourceRoot":"","sources":["../../../src/vanilla/makecode-render-blocks.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH,MAAM,eAAe,GAAG,UAAU,CAAC;AACnC,MAAM,2BAA2B,GAAG,2CAA2C,CAAC;AA2EzE,MAAM,0BAA0B,GAAG,CACxC,OAAoC,EACR,EAAE;IAC9B,MAAM,gBAAgB,GAAgC;QACpD,GAAG,OAAO;KACX,CAAC;IACF,MAAM,cAAc,GAAG,+BAA+B,CAAC;IAEvD,IAAI,MAAqC,CAAC;IAC1C,IAAI,MAAM,GAAkB,SAAS,CAAC;IACtC,MAAM,aAAa,GAAG;QACpB,WAAW,EAAE,CAAC;QACd,eAAe,EAAE,EAAqB;KACvC,CAAC;IACF,MAAM,eAAe,GAAG,aAAa,CAAC,eAAe,CAAC;IAEtD,MAAM,cAAc,GAAG,CAAC,YAAoB,EAAE,EAAE;QAC9C,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvD,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;YACvC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC;YAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;QAC9B,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;YACvB,4EAA4E;YAC5E,4BAA4B;YAC5B,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;YAC9B,cAAc,CAAC,2BAA2B,CAAC,CAAC;QAC9C,CAAC;aAAM,IAAI,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,cAAc,CAAC,wDAAwD,CAAC,CAAC;QAC3E,CAAC;aAAM,CAAC;YACN,6CAA6C;QAC/C,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,EAA+B,EAAE,EAAE;QAC5D,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YACb,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC;YACf,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;YACnB,MAAO,CAAC,aAAc,CAAC,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CACnB,IAA8B,EAC9B,YAAsB,EACoB,EAAE;QAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAClC,IAAI,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC5B,OAAO;oBACL,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,QAAQ;iBACf,CAAC;YACJ,CAAC;YACD,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO;oBACL,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,MAAM;iBACb,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACpC,CAAC,CAAC;IAEF,8DAA8D;IAC9D,IAAI,YAAiB,CAAC;IACtB,MAAM,aAAa,GAAG,CAAC,EAAgB,EAAE,EAAE;QACzC,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;QACpB,IAAI,EAAE,CAAC,MAAM,KAAK,MAAM,EAAE,aAAa,IAAI,GAAG,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACrE,OAAO;QACT,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;gBAClC,MAAM,GAAG,OAAO,CAAC;gBACjB,kBAAkB,EAAE,CAAC;gBACrB,MAAM;YACR,CAAC;YACD,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,MAAM,EAAE,GAAW,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,eAAe,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;gBAC5C,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,OAAO;gBACT,CAAC;gBAED,MAAM,MAAM,GAAG,GAAkC,CAAC;gBAClD,+CAA+C;gBAC/C,sCAAsC;gBACtC,+CAA+C;gBAC/C,IACE,CAAC,MAAM,CAAC,KAAK;oBACb,CAAC,MAAM,CAAC,KAAK;oBACb,CAAC,MAAM,CAAC,MAAM;oBACd,CAAC,MAAM,CAAC,GAAG;oBACX,CAAC,MAAM,CAAC,GAAG,EACX,CAAC;oBACD,IAAI,eAAe,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBACtC,eAAe,CAAC,IAAI,GAAG,KAAK,CAAC;wBAC7B,eAAe,CAAC,IAAI,GAAG,MAAM,CAAC;wBAC9B,eAAe,CAAC,GAAG,CAAC,IAAI,GAAG,YAAY,CACrC,eAAe,CAAC,KAAK,EACrB,IAAI,CACL,CAAC,IAAI,CAAC;wBACP,iBAAiB,CAAC,eAAe,CAAC,CAAC;wBACnC,OAAO;oBACT,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,GAAG,4BAA4B,CAAC;oBAC9C,CAAC;gBACH,CAAC;gBAED,OAAO,eAAe,CAAC,EAAE,CAAC,CAAC;gBAC3B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACjB,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC/C,CAAC;qBAAM,CAAC;oBACN,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,GAAkC,CAAC,CAAC;gBACtE,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,OAAO;QACL,UAAU,EAAE,GAAG,EAAE;YACf,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;YACD,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAClD,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;YACxD,YAAY,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC7B,cAAc,CAAC,2BAA2B,CAAC,CAAC;gBAC5C,MAAM,GAAG,OAAO,CAAC;YACnB,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC;QACD,OAAO,EAAE,GAAG,EAAE;YACZ,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;YAClC,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACrD,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBAChC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACxC,CAAC;YACD,MAAM,GAAG,SAAS,CAAC;YACnB,cAAc,CAAC,eAAe,CAAC,CAAC;QAClC,CAAC;QACD,YAAY,EAAE,CAAC,GAAwB,EAAiC,EAAE;YACxE,MAAM,EAAE,GAAG,aAAa,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC;YAC5C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,eAAe,GAA+B;gBAClD,EAAE;gBACF,IAAI;gBACJ,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE;oBACP,GAAG,GAAG,CAAC,OAAO;oBACd,iCAAiC;oBACjC,MAAM,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;oBAChE,OAAO,EAAE,8BAA8B,CAAC,GAAG,CAAC;iBAC7C;aACF,CAAC;YACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,eAAe,CAAC,EAAE,CAAC,GAAG;oBACpB,IAAI;oBACJ,KAAK,EAAE,GAAG,CAAC,IAAI;oBACf,IAAI,EAAE,KAAK;oBACX,GAAG,EAAE,eAAe;oBACpB,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;iBAC7B,CAAC;gBACF,kBAAkB,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAjLW,QAAA,0BAA0B,8BAiLrC;AAEF,SAAS,8BAA8B,CACrC,GAAwB;IAExB,mFAAmF;IACnF,yDAAyD;IACzD,2EAA2E;IAC3E,MAAM,QAAQ,GACZ,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,IACE,OAAO,QAAQ,KAAK,WAAW;QAC/B,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAC5B,GAAG,CAAC,IAAI,CAAC,IAAK,CAAC,UAAU,CAAC,EAC1B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QACtD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,yEAAyE;YACzE,0DAA0D;YAC1D,8EAA8E;YAC9E,MAAM,aAAa,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;YACvE,MAAM,YAAY,GAA2B,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC;YACvE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;iBACrC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;iBAC7D,IAAI,CAAC,GAAG,CAAC,CAAC;YACb,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,YAAY,CACnB,cAAsB,EACtB,EAAE,IAAI,EAAE,OAAO,EAA+B;IAE9C,MAAM,KAAK,GAAG,YAAY,IAAI,CAAC,CAAC,CAAC,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAC5E,MAAM,GAAG,GACP,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACxE,MAAM,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC;IAC9B,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;IACtB,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;IACvB,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;IACrB,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,eAAe,CAAC;IAC/B,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;IACxB,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,CAAC;IACtB,CAAC,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC5B,CAAC,CAAC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC;IAC9B,CAAC,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACZ,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/{vanilla → cjs/vanilla}/pxt.d.ts

@@ -16,14 +16,13 @@
  * Modifications are Copright (c) Micro:bit Educational Foundation and contributors
  * 2024.
  */
-export interface JsonScriptMeta {
-    blocksWidth?: number;
-    blocksHeight?: number;
-    versions?: TargetVersions;
-}
 export interface InstallHeader {
     name: string;
-    meta: JsonScriptMeta;
+    meta: {
+        blocksWidth?: number;
+        blocksHeight?: number;
+        versions?: TargetVersions;
+    };
     editor: string;
     board?: string;
     temporary?: boolean;
@@ -31,14 +30,20 @@ export interface InstallHeader {
     targetVersion: string;
     pubId: string;
     pubCurrent: boolean;
-    pubVersions?: PublishVersion[];
+    pubVersions?: {
+        id: string;
+        type: 'snapshot' | 'permalink';
+    }[];
     pubPermalink?: string;
     anonymousSharePreference?: boolean;
     githubId?: string;
     githubTag?: string;
     githubCurrent?: boolean;
     tutorial?: TutorialOptions;
-    tutorialCompleted?: TutorialCompletionInfo;
+    tutorialCompleted?: {
+        id: string;
+        steps: number;
+    };
     extensionUnderTest?: string;
     cloudUserId?: string;
     isSkillmapProject?: boolean;
@@ -58,12 +63,8 @@ export interface Header extends InstallHeader {
     isBackup?: boolean;
     _rev: string;
 }
-interface PublishVersion {
-    id: string;
-    type: 'snapshot' | 'permalink';
-}
 export type ScriptText = Record<string, string>;
-export interface Project {
+export interface MakeCodeProject {
     header?: Header;
     text?: ScriptText;
 }
@@ -213,16 +214,16 @@ export interface EditorSyncState {
     searchBar?: boolean;
 }
 export interface EditorWorkspaceSyncResponse extends EditorMessageResponse {
-    projects: Project[];
+    projects: MakeCodeProject[];
     editor?: EditorSyncState;
     controllerId?: string;
 }
 export interface EditorWorkspaceSaveRequest extends EditorMessageRequest {
     action: 'workspacesave';
-    project: Project;
+    project: MakeCodeProject;
 }
 export interface ImportProjectOptions {
-    project: Project;
+    project: MakeCodeProject;
     filters?: ProjectFilters;
     searchBar?: boolean;
 }
@@ -230,7 +231,7 @@ export interface EditorMessageImportProjectRequest extends EditorMessageRequest,
     action: 'importproject';
 }
 export interface ImportExternalProjectOptions {
-    project: Project;
+    project: MakeCodeProject;
 }
 export interface EditorMessageImportExternalProjectRequest extends EditorMessageRequest, ImportExternalProjectOptions {
     action: 'importexternalproject';
@@ -395,7 +396,7 @@ export interface EditorMessageServiceWorkerRegisteredRequest extends EditorMessa
 export interface EditorMessageGetToolboxCategoriesResponse {
     categories: ToolboxCategoryDefinition[];
 }
-interface ProjectTemplate {
+export interface ProjectTemplate {
     id: string;
     config: PackageConfig;
     files: Record<string, string>;
@@ -555,21 +556,12 @@ export interface ToolboxBlockDefinition {
     blockId?: string;
 }
 export type CloudStatus = 'none' | 'synced' | 'justSynced' | 'offline' | 'syncing' | 'conflict' | 'localEdits';
-interface TargetVersions {
-    target: string;
-    targetId?: string;
-    targetWebsite?: string;
-    pxt?: string;
-    tag?: string;
-    branch?: string;
-    commits?: string;
-}
-type CodeCardType = 'file' | 'example' | 'codeExample' | 'tutorial' | 'side' | 'template' | 'package' | 'hw' | 'forumUrl' | 'forumExample' | 'sharedExample' | 'link';
-type CodeCardEditorType = 'blocks' | 'js' | 'py';
-interface Map<T> {
+export type CodeCardType = 'file' | 'example' | 'codeExample' | 'tutorial' | 'side' | 'template' | 'package' | 'hw' | 'forumUrl' | 'forumExample' | 'sharedExample' | 'link';
+export type CodeCardEditorType = 'blocks' | 'js' | 'py';
+export interface DependencyMap<T> {
     [index: string]: T;
 }
-interface TargetVersions {
+export interface TargetVersions {
     target: string;
     targetId?: string;
     targetWebsite?: string;
@@ -578,11 +570,7 @@ interface TargetVersions {
     branch?: string;
     commits?: string;
 }
-interface Size {
-    width: number;
-    height: number;
-}
-interface CodeCardAction {
+export interface CodeCardAction {
     url: string;
     editor?: CodeCardEditorType;
     cardType?: CodeCardType;
@@ -590,20 +578,20 @@ interface CodeCardAction {
 /**
  * The schema for the pxt.json package files
  */
-interface PackageConfig {
+export interface PackageConfig {
     name: string;
     version?: string;
     icon?: string;
     documentation?: string;
     targetVersions?: TargetVersions;
     description?: string;
-    dependencies: Map<string>;
+    dependencies: DependencyMap<string>;
     license?: string;
     authors?: string[];
     files: string[];
     simFiles?: string[];
     testFiles?: string[];
-    fileDependencies?: Map<string>;
+    fileDependencies?: DependencyMap<string>;
     preferredEditor?: string;
     languageRestriction?: LanguageRestriction;
     testDependencies?: Record<string, string>;
@@ -611,14 +599,21 @@ interface PackageConfig {
     public?: boolean;
     partial?: boolean;
     binaryonly?: boolean;
-    platformio?: PlatformIOConfig;
+    platformio?: {
+        dependencies?: DependencyMap<string>;
+    };
     compileServiceVariant?: string;
     palette?: string[];
     paletteNames?: string[];
-    screenSize?: Size;
+    screenSize?: {
+        width: number;
+        height: number;
+    };
     yotta?: YottaConfig;
-    codal?: CodalConfig;
-    npmDependencies?: Map<string>;
+    codal?: {
+        libraries?: string[];
+    };
+    npmDependencies?: DependencyMap<string>;
     card?: CodeCard;
     additionalFilePath?: string;
     additionalFilePaths?: string[];
@@ -647,9 +642,9 @@ interface PackageConfig {
     disableTargetTemplateFiles?: boolean;
     theme?: string | Record<string, string>;
     assetPack?: boolean;
-    assetPacks?: Map<boolean>;
+    assetPacks?: DependencyMap<boolean>;
 }
-interface PackageExtension {
+export interface PackageExtension {
     namespace?: string;
     group?: string;
     label?: string;
@@ -658,28 +653,21 @@ interface PackageExtension {
     url?: string;
     localUrl?: string;
 }
-interface PlatformIOConfig {
-    dependencies?: Map<string>;
-}
-interface CompilationConfig {
-    description: string;
-    config: any;
-}
-interface CodalConfig {
-    libraries?: string[];
-}
-interface YottaConfig {
-    dependencies?: Map<string>;
+export interface YottaConfig {
+    dependencies?: DependencyMap<string>;
     config?: any;
     /**
      * Overridable config flags
      */
     optionalConfig?: any;
-    userConfigs?: CompilationConfig[];
+    userConfigs?: {
+        description: string;
+        config: any;
+    }[];
     configIsJustDefaults?: boolean;
     ignoreConflicts?: boolean;
 }
-interface CodeCard {
+export interface CodeCard {
     name?: string;
     shortName?: string;
     title?: string;
@@ -726,65 +714,55 @@ interface CodeCard {
     className?: string;
     variant?: string;
 }
-type SnippetOutputType = 'blocks';
-type SnippetOutputBehavior = /*assumed default*/ 'merge' | 'replace';
-interface SnippetConfig {
+export interface SnippetConfig {
     name: string;
     namespace: string;
     group?: string;
     label: string;
-    outputType: SnippetOutputType;
-    outputBehavior?: SnippetOutputBehavior;
+    outputType: 'blocks';
+    outputBehavior?: /*assumed default*/ 'merge' | 'replace';
     initialOutput?: string;
     questions: SnippetQuestions[];
 }
-type SnippetAnswerTypes = 'number' | 'text' | 'variableName' | 'dropdown' | 'spriteEditor' | 'yesno' | string;
-interface SnippetGoToOptions {
+export type SnippetAnswerTypes = 'number' | 'text' | 'variableName' | 'dropdown' | 'spriteEditor' | 'yesno' | string;
+export interface SnippetGoToOptions {
     question?: number;
-    validate?: SnippetValidate;
+    validate?: {
+        regex?: {
+            token: string;
+            regex: string;
+            match?: SnippetParameters;
+            noMatch?: SnippetParameters;
+        };
+    };
     parameters?: SnippetParameters[];
 }
-interface SnippetParameters {
+export interface SnippetParameters {
     token?: string;
     answer?: string;
     question: number;
 }
-interface SnippetInputAnswerSingular {
+export type SnippetQuestionInput = {
+    label?: string;
+} & ({
     answerToken: string;
     defaultAnswer: SnippetAnswerTypes;
-}
-interface SnippetInputAnswerPlural {
+} | {
     answerTokens: string[];
     defaultAnswers: SnippetAnswerTypes[];
-}
-interface SnippetInputOtherType {
+}) & ({
     type: string;
-}
-interface SnippetInputNumberType {
+} | {
     type: 'number' | 'positionPicker';
     max?: number;
     min?: number;
-}
-interface SnippetInputDropdownType {
+} | {
     type: 'dropdown';
     options: Record<string, string>;
-}
-interface SnippetInputYesNoType {
+} | {
     type: 'yesno';
-}
-type SnippetQuestionInput = {
-    label?: string;
-} & (SnippetInputAnswerSingular | SnippetInputAnswerPlural) & (SnippetInputOtherType | SnippetInputNumberType | SnippetInputDropdownType | SnippetInputYesNoType);
-interface SnippetValidateRegex {
-    token: string;
-    regex: string;
-    match?: SnippetParameters;
-    noMatch?: SnippetParameters;
-}
-interface SnippetValidate {
-    regex?: SnippetValidateRegex;
-}
-interface SnippetQuestions {
+});
+export interface SnippetQuestions {
     title: string;
     output?: string;
     outputConditionalOnAnswer?: string;
@@ -793,7 +771,7 @@ interface SnippetQuestions {
     inputs: SnippetQuestionInput[];
     hint?: string;
 }
-interface TutorialOptions {
+export interface TutorialOptions {
     tutorial?: string;
     tutorialName?: string;
     tutorialReportId?: string;
@@ -820,7 +798,7 @@ interface TutorialOptions {
     globalValidationConfig?: CodeValidationConfig;
     simTheme?: Partial<PackageConfig>;
 }
-interface TutorialStepInfo {
+export interface TutorialStepInfo {
     showHint?: boolean;
     showDialog?: boolean;
     resetDiff?: boolean;
@@ -833,19 +811,14 @@ interface TutorialStepInfo {
     localBlockConfig?: TutorialBlockConfig;
     localValidationConfig?: CodeValidationConfig;
 }
-interface TutorialCompletionInfo {
-    id: string;
-    steps: number;
-}
-interface TutorialBlockConfigEntry {
-    blockId?: string;
-    xml?: string;
-}
-interface TutorialBlockConfig {
+export interface TutorialBlockConfig {
     md?: string;
-    blocks?: TutorialBlockConfigEntry[];
+    blocks?: {
+        blockId?: string;
+        xml?: string;
+    }[];
 }
-interface TutorialMetadata {
+export interface TutorialMetadata {
     activities?: boolean;
     explicitHints?: boolean;
     flyoutOnly?: boolean;
@@ -857,19 +830,16 @@ interface TutorialMetadata {
     autoexpandOff?: boolean;
     preferredEditor?: string;
 }
-interface TutorialActivityInfo {
+export interface TutorialActivityInfo {
     name: string;
     step: number;
 }
-interface CodeValidatorBaseProperties {
-    enabled?: string;
-    markers?: string;
-}
-interface CodeValidatorMetadata {
-    validatorType: string;
-    properties: CodeValidatorBaseProperties;
-}
-interface CodeValidationConfig {
-    validatorsMetadata: CodeValidatorMetadata[];
+export interface CodeValidationConfig {
+    validatorsMetadata: {
+        validatorType: string;
+        properties: {
+            enabled?: string;
+            markers?: string;
+        };
+    }[];
 }
-export {};

package/dist/cjs/vanilla/pxt.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * MakeCode/pxt types needed for the iframe messages.
+ *
+ * These are substantially derived from the PXT project. The types are hard to use
+ * directly due to logical splits that make sense for MakeCode internally, but not
+ * for this interface, and TypeScript features that make them hard to reuse in a
+ * library context: namespaces and const enums.
+ *
+ * We've also extracted interfaces for the request parameters separately from the
+ * request metadata and corrected some types that don't appear to behave as
+ * described.
+ *
+ * Original is Copyright (c) Microsoft Corporation
+ * MIT licensed: https://github.com/microsoft/pxt/blob/master/LICENSE
+ *
+ * Modifications are Copright (c) Micro:bit Educational Foundation and contributors
+ * 2024.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockLayout = exports.FilterState = void 0;
+var FilterState;
+(function (FilterState) {
+    FilterState[FilterState["Hidden"] = 0] = "Hidden";
+    FilterState[FilterState["Visible"] = 1] = "Visible";
+    FilterState[FilterState["Disabled"] = 2] = "Disabled";
+})(FilterState || (exports.FilterState = FilterState = {}));
+var BlockLayout;
+(function (BlockLayout) {
+    BlockLayout[BlockLayout["None"] = 0] = "None";
+    BlockLayout[BlockLayout["Align"] = 1] = "Align";
+    // Shuffle deprecated
+    BlockLayout[BlockLayout["Clean"] = 3] = "Clean";
+    BlockLayout[BlockLayout["Flow"] = 4] = "Flow";
+})(BlockLayout || (exports.BlockLayout = BlockLayout = {}));
+//# sourceMappingURL=pxt.js.map

package/dist/cjs/vanilla/pxt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pxt.js","sourceRoot":"","sources":["../../../src/vanilla/pxt.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AA6mBH,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,iDAAU,CAAA;IACV,mDAAW,CAAA;IACX,qDAAY,CAAA;AACd,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAED,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,6CAAQ,CAAA;IACR,+CAAS,CAAA;IACT,qBAAqB;IACrB,+CAAS,CAAA;IACT,6CAAQ,CAAA;AACV,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB"}

package/dist/esm/index.d.ts

@@ -0,0 +1,10 @@
+export { default as MakeCodeFrame, type MakeCodeFrameProps, } from './react/MakeCodeFrame.js';
+export { default as useMakeCodeRenderBlocks, type UseMakeCodeRenderBlocksReturn, } from './react/useMakeCodeRenderBlocks.js';
+export { MakeCodeRenderBlocksProvider } from './react/MakeCodeRenderBlocksProvider.js';
+export { default as MakeCodeBlocksRendering, type MakeCodeBlocksRenderingProps, } from './react/MakeCodeBlocksRendering.js';
+export { defaultMakeCodeProject, emptyMakeCodeProject, } from './vanilla/examples.js';
+export { MakeCodeFrameDriver, createMakeCodeURL, } from './vanilla/makecode-frame-driver.js';
+export { BlockLayout } from './vanilla/pxt.js';
+export { createMakeCodeRenderBlocks } from './vanilla/makecode-render-blocks.js';
+export type { MakeCodeRenderBlocksOptions, MakeCodeRenderBlocksReturn, RenderBlocksResponse, RenderBlocksRequest, } from './vanilla/makecode-render-blocks.js';
+export type { CreateEvent, EditorContentLoadedRequest, EditorEvent, EditorMessageTutorialCompletedEventRequest, EditorMessageTutorialEventRequest, EditorMessageTutorialExitEventRequest, EditorMessageTutorialLoadedEventRequest, EditorMessageTutorialProgressEventRequest, EditorWorkspaceSaveRequest, EditorWorkspaceSyncRequest, ImportExternalProjectOptions, ImportFileOptions, ImportProjectOptions, InfoMessage, LanguageRestriction, MakeCodeProject, ProjectCreationOptions, ProjectFilters, RenderBlocksOptions, RenderByBlockIdOptions, RenderXmlOptions, ShareResult, StartActivityOptions, ToolboxBlockDefinition, ToolboxCategoryDefinition, UIEvent, } from './vanilla/pxt.js';

package/dist/esm/index.js

@@ -0,0 +1,9 @@
+export { default as MakeCodeFrame, } from './react/MakeCodeFrame.js';
+export { default as useMakeCodeRenderBlocks, } from './react/useMakeCodeRenderBlocks.js';
+export { MakeCodeRenderBlocksProvider } from './react/MakeCodeRenderBlocksProvider.js';
+export { default as MakeCodeBlocksRendering, } from './react/MakeCodeBlocksRendering.js';
+export { defaultMakeCodeProject, emptyMakeCodeProject, } from './vanilla/examples.js';
+export { MakeCodeFrameDriver, createMakeCodeURL, } from './vanilla/makecode-frame-driver.js';
+export { BlockLayout } from './vanilla/pxt.js';
+export { createMakeCodeRenderBlocks } from './vanilla/makecode-render-blocks.js';
+//# sourceMappingURL=index.js.map