@endo/compartment-mapper 1.1.5 → 1.2.0

package/README.md

@@ -164,27 +164,15 @@ in a parent directory, under `node_modules`.
 The `main`, `browser`, and `exports` properties determine the modules each
 package exports to other compartments.
 
-The `exports` property describes [package entry points] and can be influenced
-by build _tags_.
-Currently, the only tag supported by the compartment mapper is `import`, which
-indicates that the module map should use ESM modules over CommonJS modules or
-other variants.
-
-> TODO
->
-> A future version may reveal other tags like `browser` to prepare an
-> application for use in a web client.
-> For this case, the compartment mapper would prepare a JSON manifest like an
-> `importmap` (if not precisely an `importmap`).
-> The "compartment map" would be consistent except when the dependency graph
-> changes so updates could be automated with a `postinstall` script.
-> Preparing a web application for production would follow a process similar to
-> creating an archive, but with the `browser` build tag.
-
-The `browser` and `require` tags are well-known but not yet supported.
-The `browser` tag will apply for compartment maps generated for use on the web.
-The `require` tag is a fallback for environments that do not support ESM and
-will never apply.
+The `exports` property describes [package entry points][] and can be influenced
+by build _conditions_.
+Currently, the only conditions supported by the compartment mapper are
+`import`, `browser`, and `endo`.
+The `imports` condition indicates that the module map should use ESM modules
+over CommonJS modules or other variants, and `endo`.
+The `browser` condition also draws in the `browser` property from
+`package.json` instead of `main`.
+The `endo` condition only indicates that this tool is in use.
 
 If no `exports` apply to the root of the compartment namespace (`"."`),
 the `main` property serves as a default.
@@ -284,7 +272,7 @@ Node.js platform.
 > For browser applications, the compartment mapper would use the translator
 > modules in two modes.
 > During development, the compartment mapper would be able to load the
-> translator in the client, with the `browser` tag.
+> translator in the client, with the `browser` condition.
 > The compartment mapper would also be able to run the translator in a separate
 > non-browser compartment during bundling, so the translator can be excluded
 > from the production application and archived applications.
@@ -392,18 +380,19 @@ The compartment map shape:
 // CompartmentMap describes how to prepare compartments
 // to run an application.
 type CompartmentMap = {
-  tags: Tags,
+  tags: Conditions,
   entry: Entry,
   compartments: Record<CompartmentName, Compartment>,
   realms: Record<RealmName, Realm>, // TODO
 };
 
-// Tags are the build tags for the compartment.
+// Conditions influence which modules are selected
+// to represent the implementation of various modules.
 // These may include terms like "browser", meaning
 // each compartment uses the implementation of each
 // module suitable for use in a browser environment.
-type Tags = Array<Tag>;
-type Tag = string;
+type Conditions = Array<Condition>;
+type Condition = string;
 
 // Entry is a reference to the module that is the module to initially import.
 type Entry = CompartmentModule;
@@ -485,7 +474,7 @@ type InternalModuleSpecifier = string;
 // in the namespace of the foreign compartment.
 type ExternalModuleSpecifier = string;
 
-// ParserMap indicates which parser to use to construct static module records
+// ParserMap indicates which parser to use to construct module sources
 // from sources, for each supported file extension.
 // For parity with Node.js, a package with `"type": "module"` in its
 // `package.json` would have a parser map of `{"js": "mjs", "cjs": "cjs",
@@ -500,7 +489,7 @@ type ParserMap = Record<Extension, Parser>;
 // Extension is a file extension such as "js" for "main.js" or "" for "README".
 type Extension = string;
 
-// Parser is a union of built-in parsers for static module records.
+// Parser is a union of built-in parsers for module sources.
 // "mjs" corresponds to ECMAScript modules.
 // "cjs" corresponds to CommonJS modules.
 // "json" corresponds to JSON.

package/archive-lite.d.ts

@@ -0,0 +1,2 @@
+export { makeArchiveFromMap, makeAndHashArchiveFromMap, writeArchiveFromMap, mapFromMap, hashFromMap } from "./src/archive-lite.js";
+//# sourceMappingURL=archive-lite.d.ts.map

package/archive-lite.js

@@ -0,0 +1,7 @@
+export {
+  makeArchiveFromMap,
+  makeAndHashArchiveFromMap,
+  writeArchiveFromMap,
+  mapFromMap,
+  hashFromMap,
+} from './src/archive-lite.js';

package/archive-parsers.d.ts

@@ -0,0 +1,2 @@
+export { defaultParserForLanguage } from "./src/archive-parsers.js";
+//# sourceMappingURL=archive-parsers.d.ts.map

package/archive-parsers.js

@@ -0,0 +1 @@
+export { defaultParserForLanguage } from './src/archive-parsers.js';

package/capture-lite.d.ts

@@ -0,0 +1,2 @@
+export { captureFromMap } from "./src/capture-lite.js";
+//# sourceMappingURL=capture-lite.d.ts.map

package/capture-lite.js

@@ -0,0 +1 @@
+export { captureFromMap } from './src/capture-lite.js';

package/import-archive-lite.d.ts

@@ -0,0 +1,2 @@
+export { parseArchive, loadArchive, importArchive } from "./src/import-archive-lite.js";
+//# sourceMappingURL=import-archive-lite.d.ts.map

package/import-archive-lite.js

@@ -0,0 +1,5 @@
+export {
+  parseArchive,
+  loadArchive,
+  importArchive,
+} from './src/import-archive-lite.js';

package/import-archive-parsers.d.ts

@@ -0,0 +1,2 @@
+export { defaultParserForLanguage } from "./src/import-archive-parsers.js";
+//# sourceMappingURL=import-archive-parsers.d.ts.map

package/import-archive-parsers.js

@@ -0,0 +1 @@
+export { defaultParserForLanguage } from './src/import-archive-parsers.js';

package/import-lite.d.ts

@@ -0,0 +1,2 @@
+export { loadFromMap, importFromMap } from "./src/import-lite.js";
+//# sourceMappingURL=import-lite.d.ts.map

package/import-lite.js

@@ -0,0 +1 @@
+export { loadFromMap, importFromMap } from './src/import-lite.js';

package/import-parsers.d.ts

@@ -0,0 +1,2 @@
+export { defaultParserForLanguage } from "./src/import-parsers.js";
+//# sourceMappingURL=import-parsers.d.ts.map

package/import-parsers.js

@@ -0,0 +1 @@
+export { defaultParserForLanguage } from './src/import-parsers.js';

package/node-modules.d.ts

@@ -0,0 +1,2 @@
+export { mapNodeModules } from "./src/node-modules.js";
+//# sourceMappingURL=node-modules.d.ts.map

package/node-modules.js

@@ -0,0 +1 @@
+export { mapNodeModules } from './src/node-modules.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@endo/compartment-mapper",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "description": "The compartment mapper assembles Node applications in a sandbox",
   "keywords": [
     "node",
@@ -28,16 +28,24 @@
       "default": "./index.js"
     },
     "./import.js": "./import.js",
+    "./import-lite.js": "./import-lite.js",
+    "./import-parsers.js": "./import-parsers.js",
     "./archive.js": "./archive.js",
+    "./archive-lite.js": "./archive-lite.js",
+    "./archive-parsers.js": "./archive-parsers.js",
+    "./capture-lite.js": "./capture-lite.js",
     "./import-archive.js": "./import-archive.js",
+    "./import-archive-lite.js": "./import-archive-lite.js",
+    "./import-archive-parsers.js": "./import-archive-parsers.js",
     "./bundle.js": "./bundle.js",
     "./node-powers.js": "./node-powers.js",
+    "./node-modules.js": "./node-modules.js",
     "./package.json": "./package.json"
   },
   "scripts": {
     "build": "exit 0",
-    "build:types": "tsc --build tsconfig.build.json",
-    "clean:types": "git clean -f '*.d.ts*'",
+    "prepack": "tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.ts*'",
     "cover": "c8 ava",
     "lint": "yarn lint:types && yarn lint:eslint",
     "lint-fix": "eslint --fix .",
@@ -47,22 +55,22 @@
     "test": "ava"
   },
   "dependencies": {
-    "@endo/cjs-module-analyzer": "^1.0.5",
-    "@endo/static-module-record": "^1.1.2",
-    "@endo/zip": "^1.0.5",
-    "ses": "^1.5.0"
+    "@endo/cjs-module-analyzer": "^1.0.6",
+    "@endo/module-source": "^1.0.0",
+    "@endo/zip": "^1.0.6",
+    "ses": "^1.6.0"
   },
   "devDependencies": {
-    "ava": "^6.1.2",
-    "babel-eslint": "^10.0.3",
+    "ava": "^6.1.3",
+    "babel-eslint": "^10.1.0",
     "c8": "^7.14.0",
     "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.29.1",
     "prettier": "^3.2.5",
-    "typescript": "~5.5.0-dev.20240327"
+    "typescript": "5.5.2"
   },
   "files": [
     "LICENSE*",
@@ -93,12 +101,13 @@
   },
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/test-*.*",
+      "test/**/*.test.*"
     ],
     "timeout": "2m"
   },
   "typeCoverage": {
     "atLeast": 86.14
   },
-  "gitHead": "08e59bc0d262565165636c2e3875bbe3dcb91cf8"
+  "gitHead": "681b813ccb1fa177905dabf2ed3f5f248cb33ce7"
 }

package/src/archive-lite.d.ts

@@ -0,0 +1,20 @@
+export function makeArchiveCompartmentMap(compartmentMap: CompartmentMapDescriptor, sources: Sources): {
+    archiveCompartmentMap: CompartmentMapDescriptor;
+    archiveSources: Sources;
+};
+export function makeAndHashArchiveFromMap(powers: ReadFn | ReadPowers, compartmentMap: CompartmentMapDescriptor, options?: ArchiveOptions | undefined): Promise<{
+    bytes: Uint8Array;
+    sha512?: string;
+}>;
+export function makeArchiveFromMap(powers: ReadFn | ReadPowers, compartmentMap: CompartmentMapDescriptor, options?: ArchiveOptions | undefined): Promise<Uint8Array>;
+export function mapFromMap(powers: ReadFn | ReadPowers, compartmentMap: CompartmentMapDescriptor, options?: ArchiveOptions | undefined): Promise<Uint8Array>;
+export function hashFromMap(powers: HashPowers, compartmentMap: CompartmentMapDescriptor, options?: ArchiveOptions | undefined): Promise<string>;
+export function writeArchiveFromMap(write: WriteFn, readPowers: ReadFn | ReadPowers, archiveLocation: string, compartmentMap: CompartmentMapDescriptor, options?: ArchiveOptions | undefined): Promise<void>;
+import type { CompartmentMapDescriptor } from './types.js';
+import type { Sources } from './types.js';
+import type { ReadFn } from './types.js';
+import type { ReadPowers } from './types.js';
+import type { ArchiveOptions } from './types.js';
+import type { HashPowers } from './types.js';
+import type { WriteFn } from './types.js';
+//# sourceMappingURL=archive-lite.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"archive-lite.d.ts","sourceRoot":"","sources":["archive-lite.js"],"names":[],"mappings":"AA2QO,0DAJI,wBAAwB,WACxB,OAAO,GACL;IAAC,qBAAqB,EAAE,wBAAwB,CAAC;IAAC,cAAc,EAAE,OAAO,CAAA;CAAC,CAmCtF;AA6GM,kDALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,yCAEtB,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC,CAmBzD;AAQM,2CALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,yCAEtB,OAAO,CAAC,UAAU,CAAC,CAS/B;AAQM,mCALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,yCAEtB,OAAO,CAAC,UAAU,CAAC,CAS/B;AAQM,oCALI,UAAU,kBACV,wBAAwB,yCAEtB,OAAO,CAAC,MAAM,CAAC,CAU3B;AASM,2CANI,OAAO,cACP,MAAM,GAAG,UAAU,mBACnB,MAAM,kBACN,wBAAwB,uDAgBlC;8CA1c2C,YAAY;6BAM7B,YAAY;4BAJb,YAAY;gCAER,YAAY;oCAPR,YAAY;gCAQhB,YAAY;6BAEf,YAAY"}