@endo/compartment-mapper 1.5.0 → 1.6.0

package/src/bundle-mjs.js

@@ -1,7 +1,9 @@
 /* Provides ESM support for `bundle.js`. */
 
 /** @import {PrecompiledModuleSource} from 'ses' */
-/** @import {BundlerSupport} from './bundle.js' */
+/** @import {BundlerSupport} from './bundle-lite.js' */
+
+import { join } from './node-module-specifier.js';
 
 /** quotes strings */
 const q = JSON.stringify;
@@ -41,7 +43,7 @@ function observeImports(map, importName, importIndex) {
   for (const [name, observers] of map.get(importName)) {
     const cell = cells[importIndex][name];
     if (cell === undefined) {
-      throw new ReferenceError(\`Cannot import name \${name}\`);
+      throw new ReferenceError(\`Cannot import name \${name} (has \${Object.getOwnPropertyNames(cells[importIndex]).join(', ')})\`);
     }
     for (const observer of observers) {
       cell.observe(observer);
@@ -53,21 +55,30 @@ function observeImports(map, importName, importIndex) {
 /** @type {BundlerSupport<PrecompiledModuleSource>} */
 export default {
   runtime,
-  getBundlerKit({
-    index,
-    indexedImports,
-    record: {
-      __syncModuleProgram__,
-      __fixedExportMap__ = {},
-      __liveExportMap__ = {},
-      __reexportMap__ = {},
-      reexports,
+  getBundlerKit(
+    {
+      index,
+      indexedImports,
+      moduleSpecifier,
+      sourceDirname,
+      record: {
+        __syncModuleProgram__,
+        __fixedExportMap__ = {},
+        __liveExportMap__ = {},
+        __reexportMap__ = {},
+        reexports,
+      },
     },
-  }) {
+    { useEvaluate = false },
+  ) {
+    let functor = __syncModuleProgram__;
+    if (useEvaluate) {
+      const sourceUrl = join(sourceDirname, moduleSpecifier);
+      functor = JSON.stringify([functor, sourceUrl]);
+    }
     return {
       getFunctor: () => `\
-// === functors[${index}] ===
-${__syncModuleProgram__},
+${functor},
 `,
       getCells: () => `\
     {
@@ -79,14 +90,14 @@ ${exportsCellRecord(__fixedExportMap__)}${exportsCellRecord(
       getReexportsWiring: () => {
         const mappings = reexports.map(
           importSpecifier => `\
-  Object.defineProperties(cells[${index}], Object.getOwnPropertyDescriptors(cells[${indexedImports[importSpecifier]}]));
+  defineProperties(cells[${index}], getOwnPropertyDescriptors(cells[${indexedImports[importSpecifier]}]));
 `,
         );
         // Create references for export name as newname
         const namedReexportsToProcess = Object.entries(__reexportMap__);
         if (namedReexportsToProcess.length > 0) {
           mappings.push(`
-  Object.defineProperties(cells[${index}], {${namedReexportsToProcess.map(
+  defineProperties(cells[${index}], {${namedReexportsToProcess.map(
     ([specifier, renames]) => {
       return renames.map(
         ([localName, exportedName]) =>
@@ -100,8 +111,13 @@ ${exportsCellRecord(__fixedExportMap__)}${exportsCellRecord(
         }
         return mappings.join('');
       },
-      getFunctorCall: () => `\
-  functors[${index}]({
+      getFunctorCall: () => {
+        let functorExpression = `functors[${index}]`;
+        if (useEvaluate) {
+          functorExpression = `evaluateSource(...${functorExpression})`;
+        }
+        return `\
+  ${functorExpression}({
     imports(entries) {
       const map = new Map(entries);
   ${''.concat(
@@ -120,7 +136,8 @@ ${importsCellSetter(__fixedExportMap__, index)}\
     },
     importMeta: {},
   });
-`,
+`;
+      },
     };
   },
 };

package/src/bundle.d.ts

@@ -1,5 +1,32 @@
-export function makeBundle(readPowers: ReadFn | ReadPowers | MaybeReadPowers, moduleLocation: string, options?: ArchiveOptions | undefined): Promise<string>;
-export function writeBundle(write: WriteFn, read: ReadFn, bundleLocation: string, moduleLocation: string, options?: ArchiveOptions | undefined): Promise<void>;
+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>;
+export function makeFunctor(readPowers: ReadFn | ReadPowers | MaybeReadPowers, moduleLocation: string, options?: BundleOptions | undefined): Promise<string>;
+export function makeScript(readPowers: ReadFn | ReadPowers | MaybeReadPowers, moduleLocation: string, options?: BundleOptions | undefined): Promise<string>;
+export function writeScript(write: WriteFn, read: ReadFn, bundleLocation: string, moduleLocation: string, options?: BundleOptions | undefined): Promise<void>;
+/**
+ * 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
@@ -14,15 +41,13 @@ export type BundlerKit = {
     /**
      * Produces a JavaScript string consisting of
      * a JavaScript object and a trailing comma.
-     * The string is evaluated in a lexical context with a `cell` maker, the `cells`
-     * array of every module's internal environment record.
+     * The string is evaluated in the linker runtime's lexical context.
      */
     getCells: () => string;
     /**
-     * Produces a JavaScript string may
-     * be a statement that calls this module's functor with the calling convention
-     * appropriate for its language, injecting whatever cells it needs to link to
-     * other module namespaces.
+     * 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;
     /**
@@ -33,8 +58,10 @@ export type BundlerKit = {
 };
 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>;
@@ -43,7 +70,17 @@ export type BundleModule<SpecificModuleSource extends unknown> = {
     index: number;
     bundlerKit: BundlerKit;
 };
-export type GetBundlerKit<SpecificModuleSource extends unknown> = (module: BundleModule<SpecificModuleSource>) => 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>;
@@ -51,7 +88,8 @@ export type BundlerSupport<SpecificModuleSource extends unknown> = {
 import type { ReadFn } from './types.js';
 import type { ReadPowers } from './types.js';
 import type { MaybeReadPowers } from './types.js';
-import type { ArchiveOptions } from './types.js';
+import type { CompartmentMapDescriptor } from './types.js';
+import type { BundleOptions } from './types.js';
 import type { WriteFn } from './types.js';
 import type { StaticModuleType } from 'ses';
 //# sourceMappingURL=bundle.d.ts.map

package/src/bundle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["bundle.js"],"names":[],"mappings":"AAsOO,uCALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,yCAEJ,OAAO,CAAC,MAAM,CAAC,CAgN3B;AASM,mCANI,OAAO,QACP,MAAM,kBACN,MAAM,kBACN,MAAM,uDAahB;;;;;;;;;;;gBAlba,MAAM,MAAM;;;;;;;cAOZ,MAAM,MAAM;;;;;;;oBAIZ,MAAM,MAAM;;;;;wBAIZ,MAAM,MAAM;;yBAKH,oBAAoB,SAA9B,OAAS;SAER,MAAM;qBACN,MAAM;qBACN,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;;0BAID,oBAAoB,SAA9B,OAAS,aAEX,YAAY,CAAC,oBAAoB,CAAC,KAChC,UAAU;2BAIA,oBAAoB,SAA9B,OAAS;aAER,MAAM;mBACN,aAAa,CAAC,oBAAoB,CAAC;;4BAlDvC,YAAY;gCAAZ,YAAY;qCAAZ,YAAY;oCAAZ,YAAY;6BAAZ,YAAY;sCAVZ,KAAK"}
+{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["bundle.js"],"names":[],"mappings":"AAgUO,+CALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,wBAAwB,wCAEtB,OAAO,CAAC,MAAM,CAAC,CAiV3B;AAQM,8CALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,wBAAwB,wCAEtB,OAAO,CAAC,MAAM,CAAC,CAW3B;AAQM,wCALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,wCAEJ,OAAO,CAAC,MAAM,CAAC,CAS3B;AAQM,uCALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,wCAEJ,OAAO,CAAC,MAAM,CAAC,CAS3B;AASM,mCANI,OAAO,QACP,MAAM,kBACN,MAAM,kBACN,MAAM,sDAahB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBApqBa,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;6BAAZ,YAAY;sCAXZ,KAAK"}