@endo/compartment-mapper 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@endo/compartment-mapper",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "The compartment mapper assembles Node applications in a sandbox",
   "keywords": [
     "node",
@@ -39,6 +39,10 @@
     },
     "./import-archive-all-parsers.js": "./import-archive-all-parsers.js",
     "./bundle.js": "./bundle.js",
+    "./functor.js": "./functor.js",
+    "./functor-lite.js": "./functor-lite.js",
+    "./script.js": "./script.js",
+    "./script-lite.js": "./script-lite.js",
     "./node-powers.js": "./node-powers.js",
     "./node-modules.js": "./node-modules.js",
     "./package.json": "./package.json"
@@ -57,10 +61,10 @@
   },
   "dependencies": {
     "@endo/cjs-module-analyzer": "^1.0.9",
-    "@endo/module-source": "^1.2.0",
+    "@endo/module-source": "^1.3.0",
     "@endo/trampoline": "^1.0.3",
     "@endo/zip": "^1.0.9",
-    "ses": "^1.11.0"
+    "ses": "^1.12.0"
   },
   "devDependencies": {
     "ava": "^6.1.3",
@@ -114,5 +118,5 @@
   "typeCoverage": {
     "atLeast": 86.14
   },
-  "gitHead": "e0683e0bfdbfc84351af332c9e78813d7b67ef89"
+  "gitHead": "9b6784831d37db948cdd61f6da1f3489e8f97906"
 }

package/script-lite.d.ts

@@ -0,0 +1,3 @@
+export * from "./src/types-external.js";
+export { makeScriptFromMap } from "./src/bundle-lite.js";
+//# sourceMappingURL=script-lite.d.ts.map

package/script-lite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-lite.d.ts","sourceRoot":"","sources":["script-lite.js"],"names":[],"mappings":""}

package/script-lite.js

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/export -- just types
+export * from './src/types-external.js';
+
+export { makeScriptFromMap } from './src/bundle-lite.js';

package/script.d.ts

@@ -0,0 +1,3 @@
+export * from "./src/types-external.js";
+export { makeScript } from "./src/bundle.js";
+//# sourceMappingURL=script.d.ts.map

package/script.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["script.js"],"names":[],"mappings":""}

package/script.js

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/export -- just types
+export * from './src/types-external.js';
+
+export { makeScript } from './src/bundle.js';

package/src/archive-lite.js

@@ -176,7 +176,7 @@ const digestFromMap = async (powers, compartmentMap, options = {}) => {
     searchSuffixes,
     entryCompartmentName,
     entryModuleSpecifier,
-    exitModuleImportHook: consolidatedExitModuleImportHook,
+    importHook: consolidatedExitModuleImportHook,
     sourceMapHook,
   });
   // Induce importHook to record all the necessary modules to import the given module specifier.

package/src/bundle-cjs.d.ts

@@ -3,6 +3,6 @@ export default _default;
 export type CjsModuleSource = VirtualModuleSource & {
     cjsFunctor: string;
 };
-import type { BundlerSupport } from './bundle.js';
+import type { BundlerSupport } from './bundle-lite.js';
 import type { VirtualModuleSource } from 'ses';
 //# sourceMappingURL=bundle-cjs.d.ts.map

package/src/bundle-cjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundle-cjs.d.ts","sourceRoot":"","sources":["bundle-cjs.js"],"names":[],"mappings":"wBA4DW,eAAe,eAAe,CAAC;;8BAvD5B,mBAAmB,GAAG;IAAC,UAAU,EAAE,MAAM,CAAA;CAAC;oCAFtB,aAAa;yCADR,KAAK"}
+{"version":3,"file":"bundle-cjs.d.ts","sourceRoot":"","sources":["bundle-cjs.js"],"names":[],"mappings":"wBAyEW,eAAe,eAAe,CAAC;;8BApE5B,mBAAmB,GAAG;IAAC,UAAU,EAAE,MAAM,CAAA;CAAC;oCAFtB,kBAAkB;yCADb,KAAK"}

package/src/bundle-cjs.js

@@ -1,10 +1,12 @@
 /* Provides CommonJS support for `bundle.js`. */
 
 /** @import {VirtualModuleSource} from 'ses' */
-/** @import {BundlerSupport} from './bundle.js' */
+/** @import {BundlerSupport} from './bundle-lite.js' */
 
 /** @typedef {VirtualModuleSource & {cjsFunctor: string}} CjsModuleSource */
 
+import { join } from './node-module-specifier.js';
+
 /** quotes strings */
 const q = JSON.stringify;
 
@@ -21,27 +23,34 @@ const exportsCellRecord = exportsList =>
 
 // This function is serialized and references variables from its destination scope.
 const runtime = `\
-function wrapCjsFunctor(num) {
+function wrapCjsFunctor(index, functor) {
   /* eslint-disable no-undef */
   return ({ imports = {} }) => {
-    const moduleCells = cells[num];
-    const cModule = Object.freeze(
-      Object.defineProperty({}, 'exports', moduleCells.default),
+    const moduleCells = cells[index];
+    const cModule = freeze(
+      defineProperty({}, 'exports', moduleCells.default),
     );
     // TODO: specifier not found handling
     const requireImpl = specifier => cells[imports[specifier]].default.get();
-    functors[num](Object.freeze(requireImpl), cModule.exports, cModule);
+    functor(freeze(requireImpl), cModule.exports, cModule);
     // Update all named cells from module.exports.
-    Object.keys(moduleCells)
-      .filter(k => k !== 'default' && k !== '*')
-      .map(k => moduleCells[k].set(cModule.exports[k]));
+    const names = keys(moduleCells);
+    for (let i = 0; i < names.length; i += 1) {
+      const name = names[i];
+      if (name !== 'default' && name !== '*') {
+        moduleCells[name].set(cModule.exports[name]);
+      }
+    }
     // Add new named cells from module.exports.
-    Object.keys(cModule.exports)
-      .filter(k => k !== 'default' && k !== '*')
-      .filter(k => moduleCells[k] === undefined)
-      .map(k => (moduleCells[k] = cell(k, cModule.exports[k])));
+    const exportNames = keys(cModule.exports);
+    for (let i = 0; i < exportNames.length; i += 1) {
+      const name = exportNames[i];
+      if (name !== 'default' && name !== '*' && moduleCells[name] === undefined) {
+        moduleCells[name] = cell(name, cModule.exports[name]);
+      }
+    }
     // Update the star cell from all cells.
-    const starExports = Object.create(null, {
+    const starExports = create(null, {
       // Make this appear like an ESM module namespace object.
       [Symbol.toStringTag]: {
         value: 'Module',
@@ -50,10 +59,14 @@ function wrapCjsFunctor(num) {
         configurable: false,
       },
     });
-    Object.keys(moduleCells)
-      .filter(k => k !== '*')
-      .map(k => Object.defineProperty(starExports, k, moduleCells[k]));
-    moduleCells['*'].set(Object.freeze(starExports));
+    const allNames = keys(moduleCells);
+    for (let i = 0; i < allNames.length; i += 1) {
+      const name = allNames[i];
+      if (name !== '*') {
+        defineProperty(starExports, name, moduleCells[name]);
+      }
+    }
+    moduleCells['*'].set(freeze(starExports));
   };
   /* eslint-enable no-undef */
 }`;
@@ -61,17 +74,27 @@ function wrapCjsFunctor(num) {
 /** @type {BundlerSupport<CjsModuleSource>} */
 export default {
   runtime,
-  getBundlerKit({
-    index,
-    indexedImports,
-    record: { cjsFunctor, exports: exportsList = {} },
-  }) {
+  getBundlerKit(
+    {
+      index,
+      indexedImports,
+      moduleSpecifier,
+      sourceDirname,
+      record: { cjsFunctor, exports: exportsList = {} },
+    },
+    { useEvaluate = false },
+  ) {
     const importsMap = JSON.stringify(indexedImports);
 
+    let functor = cjsFunctor;
+    if (useEvaluate) {
+      const sourceUrl = join(sourceDirname, moduleSpecifier);
+      functor = JSON.stringify([functor, sourceUrl]);
+    }
+
     return {
       getFunctor: () => `\
-// === functors[${index}] ===
-${cjsFunctor},
+${functor},
 `,
       getCells: () => `\
     {
@@ -79,9 +102,15 @@ ${exportsCellRecord(exportsList)}\
     },
 `,
       getReexportsWiring: () => '',
-      getFunctorCall: () => `\
-  wrapCjsFunctor(${index})({imports: ${importsMap}});
-`,
+      getFunctorCall: () => {
+        let functorExpression = `functors[${index}]`;
+        if (useEvaluate) {
+          functorExpression = `evaluateSource(...${functorExpression})`;
+        }
+        return `\
+  wrapCjsFunctor(${index}, ${functorExpression})({imports: ${importsMap}});
+`;
+      },
     };
   },
 };

package/src/bundle-json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundle-json.d.ts","sourceRoot":"","sources":["bundle-json.js"],"names":[],"mappings":";;IAME;;;;;;;;;MAgBC"}
+{"version":3,"file":"bundle-json.d.ts","sourceRoot":"","sources":["bundle-json.js"],"names":[],"mappings":";;IAME;;;;;;;;;MAeC"}

package/src/bundle-json.js

@@ -9,15 +9,14 @@ export default {
     const json = JSON.stringify(JSON.parse(textDecoder.decode(bytes)));
     return {
       getFunctor: () => `\
-// === functors[${index}] ===
-(set) => set(${json}),
+${json},
 `,
       getCells: () => `\
     { default: cell('default') },
 `,
       getReexportsWiring: () => '',
       getFunctorCall: () => `\
-  functors[${index}](cells[${index}].default.set);
+  cells[${index}].default.set(functors[${index}]);
 `,
     };
   },

package/src/bundle-lite.d.ts

@@ -0,0 +1,91 @@
+export function makeFunctorFromMap(readPowers: ReadFn | ReadPowers | MaybeReadPowers, compartmentMap: CompartmentMapDescriptor, options?: BundleOptions | undefined): Promise<string>;
+export function makeScriptFromMap(readPowers: ReadFn | ReadPowers | MaybeReadPowers, compartmentMap: CompartmentMapDescriptor, options?: BundleOptions | undefined): Promise<string>;
+/**
+ * The bundler kit defines a language-specific behavior for injecting a module
+ * into a bundle.
+ * Each module must allocate cells for its imports and exports, link those cells
+ * to the cells of dependencies, and provide both the linker and evaluation behavior
+ * for the module.
+ * The linker behavior gets injected in a lexical scope with the linker runtime
+ * and has access to the cells of all modules, whereas the evaluation behavior
+ * gets injected in the generated script's top level lexical scope, so has
+ * no accidental visibility into the linkage runtime.
+ *
+ * For example, JSON modules produce a single "default" cell ("getCells"):
+ *
+ *   { default: cell('default') },
+ *
+ * Then, the JSON gets injected verbatim for the evaluation behavior ("getFunctor").
+ * The linker simply sets the cell to the value.
+ *
+ *   functors[0]['default'].set(modules[0]);
+ *
+ * For an ECMAScript or CommonJS module, the evaluation behavior is a function
+ * that the linker runtime can call to inject it with the cells it needs by
+ * the names it sees for them.
+ */
+export type BundlerKit = {
+    /**
+     * Produces a JavaScript string consisting of
+     * a function expression followed by a comma delimiter that will be evaluated in
+     * a lexical scope with no free variables except the globals.
+     * In the generated bundle runtime, the function will receive an environment
+     * record: a record mapping every name of the corresponding module's internal
+     * namespace to a "cell" it can use to get, set, or observe the linked
+     * variable.
+     */
+    getFunctor: () => string;
+    /**
+     * Produces a JavaScript string consisting of
+     * a JavaScript object and a trailing comma.
+     * The string is evaluated in the linker runtime's lexical context.
+     */
+    getCells: () => string;
+    /**
+     * Produces a JavaScript string,
+     * a statement that effects the module's evaluation behavior using the cells
+     * it imports and exports and the evaluated "functor".
+     */
+    getFunctorCall: () => string;
+    /**
+     * Produces a JavaScript string
+     * that may include statements that bind the cells reexported by this module.
+     */
+    getReexportsWiring: () => string;
+};
+export type BundleModule<SpecificModuleSource extends unknown> = {
+    key: string;
+    exit: string;
+    compartmentName: string;
+    moduleSpecifier: string;
+    sourceDirname: string;
+    parser: string;
+    record: StaticModuleType & SpecificModuleSource;
+    resolvedImports: Record<string, string>;
+    indexedImports: Record<string, number>;
+    bytes: Uint8Array;
+    index: number;
+    bundlerKit: BundlerKit;
+};
+export type BundleExit = {
+    exit: string;
+    index: number;
+    bundlerKit: BundlerKit;
+    indexedImports: Record<string, number>;
+    resolvedImports: Record<string, string>;
+};
+export type GetBundlerKit<SpecificModuleSource extends unknown> = (module: BundleModule<SpecificModuleSource>, params: {
+    useEvaluate?: boolean | undefined;
+    sourceUrlPrefix?: string | undefined;
+}) => BundlerKit;
+export type BundlerSupport<SpecificModuleSource extends unknown> = {
+    runtime: string;
+    getBundlerKit: GetBundlerKit<SpecificModuleSource>;
+};
+import type { ReadFn } from './types.js';
+import type { ReadPowers } from './types.js';
+import type { MaybeReadPowers } from './types.js';
+import type { CompartmentMapDescriptor } from './types.js';
+import type { BundleOptions } from './types.js';
+import type { StaticModuleType } from 'ses';
+//# sourceMappingURL=bundle-lite.d.ts.map

package/src/bundle-lite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle-lite.d.ts","sourceRoot":"","sources":["bundle-lite.js"],"names":[],"mappings":"AA4TO,+CALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,wBAAwB,wCAEtB,OAAO,CAAC,MAAM,CAAC,CAgV3B;AAQM,8CALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,wBAAwB,wCAEtB,OAAO,CAAC,MAAM,CAAC,CAW3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA/mBa,MAAM,MAAM;;;;;;cAOZ,MAAM,MAAM;;;;;;oBAGZ,MAAM,MAAM;;;;;wBAGZ,MAAM,MAAM;;yBAKH,oBAAoB,SAA9B,OAAS;SAER,MAAM;UACN,MAAM;qBACN,MAAM;qBACN,MAAM;mBACN,MAAM;YACN,MAAM;YACN,gBAAgB,GAAG,oBAAoB;qBACvC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;oBACtB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;WACtB,UAAU;WACV,MAAM;gBACN,UAAU;;;UAKV,MAAM;WACN,MAAM;gBACN,UAAU;oBACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;qBACtB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;0BAIb,oBAAoB,SAA9B,OAAS,aAEX,YAAY,CAAC,oBAAoB,CAAC,UAE1C;IAAyB,WAAW;IACZ,eAAe;CACvC,KAAU,UAAU;2BAIA,oBAAoB,SAA9B,OAAS;aAER,MAAM;mBACN,aAAa,CAAC,oBAAoB,CAAC;;4BArFvC,YAAY;gCAAZ,YAAY;qCAAZ,YAAY;8CAAZ,YAAY;mCAAZ,YAAY;sCAVZ,KAAK"}