@endo/compartment-mapper 1.3.1 → 1.4.0

package/src/parse-cjs-shared-export-wrapper.js

@@ -1,14 +1,12 @@
-/* Provides shared functionality for {@link parse-cjs.js} and {@link
+/**
+ * @module Provides shared functionality for {@link parse-cjs.js} and {@link
  * parse-archive-cjs.js} toward importing or archiving CommonJS as a virtual
  * module source.
  */
 
-import { findInvalidReadNowPowersProps, isReadNowPowers } from './powers.js';
-
-// @ts-check
+/** @import {ReadFn, ReadPowers} from './types.js' */
 
-/** @import {ReadFn} from './types.js' */
-/** @import {ReadPowers} from './types.js' */
+import { findInvalidReadNowPowersProps, isReadNowPowers } from './powers.js';
 
 const { apply } = Reflect;
 const { freeze, keys, create, hasOwnProperty, defineProperty } = Object;
@@ -20,6 +18,9 @@ const { freeze, keys, create, hasOwnProperty, defineProperty } = Object;
  */
 const has = (object, key) => apply(hasOwnProperty, object, [key]);
 
+/**
+ * @param {string} path
+ */
 const noTrailingSlash = path => {
   const l = path.length - 1;
   return path[l] === '\\' || path[l] === '/' ? path.slice(0, -1) : path;

package/src/parse-cjs.d.ts

@@ -1,5 +1,6 @@
-/** @type {import('./types.js').ParseFn} */
-export const parseCjs: import("./types.js").ParseFn;
+/** @type {ParseFn} */
+export const parseCjs: ParseFn;
 declare const _default: import("./types.js").ParserImplementation;
 export default _default;
+import type { ParseFn } from './types.js';
 //# sourceMappingURL=parse-cjs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"parse-cjs.d.ts","sourceRoot":"","sources":["parse-cjs.js"],"names":[],"mappings":"AAaA,2CAA2C;AAC3C,uBADW,OAAO,YAAY,EAAE,OAAO,CAkDrC;wBAES,OAAO,YAAY,EAAE,oBAAoB"}
+{"version":3,"file":"parse-cjs.d.ts","sourceRoot":"","sources":["parse-cjs.js"],"names":[],"mappings":"AAcA,sBAAsB;AACtB,uBADW,OAAO,CA0DhB;wBAES,OAAO,YAAY,EAAE,oBAAoB;;6BArEzB,YAAY"}

package/src/parse-cjs.js

@@ -1,8 +1,9 @@
-/* Provides language behavior (parser) for importing CommonJS as a virtual
- * module source.
+/**
+ * @module Provides language behavior (parser) for importing CommonJS as a
+ * virtual module source.
  */
 
-// @ts-check
+/** @import {ParseFn} from './types.js' */
 
 import { analyzeCommonJS } from '@endo/cjs-module-analyzer';
 import { wrap, getModulePaths } from './parse-cjs-shared-export-wrapper.js';
@@ -11,7 +12,7 @@ const textDecoder = new TextDecoder();
 
 const { freeze } = Object;
 
-/** @type {import('./types.js').ParseFn} */
+/** @type {ParseFn} */
 export const parseCjs = (
   bytes,
   _specifier,
@@ -51,7 +52,15 @@ export const parseCjs = (
       readPowers,
     });
 
-    functor(require, moduleExports, module, filename, dirname);
+    // In CommonJS, the top-level `this` is the `module.exports` object.
+    functor.call(
+      moduleExports,
+      require,
+      moduleExports,
+      module,
+      filename,
+      dirname,
+    );
 
     afterExecute();
   };

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

@@ -1 +1 @@
-{"version":3,"file":"parse-json.d.ts","sourceRoot":"","sources":["parse-json.js"],"names":[],"mappings":"AAoBA,sBAAsB;AACtB,wBADW,OAAO,CAoBhB;wBAES,oBAAoB;;6BArCJ,YAAY;0CACC,YAAY"}
+{"version":3,"file":"parse-json.d.ts","sourceRoot":"","sources":["parse-json.js"],"names":[],"mappings":"AAmBA,sBAAsB;AACtB,wBADW,OAAO,CAqBhB;wBAES,oBAAoB;;6BAtCiB,YAAY;0CAAZ,YAAY"}

package/src/parse-json.js

@@ -1,10 +1,9 @@
-/* Provides language support for importing JSON modules. */
+/** @module Provides language support for importing JSON modules. */
 
-// @ts-check
-
-/** @import {Harden} from 'ses' */
-/** @import {ParseFn} from './types.js' */
-/** @import {ParserImplementation} from './types.js' */
+/**
+ * @import {Harden} from 'ses'
+ * @import {ParseFn, ParserImplementation} from './types.js'
+ */
 
 import { parseLocatedJson } from './json.js';
 
@@ -21,6 +20,7 @@ const textDecoder = new TextDecoder();
 /** @type {ParseFn} */
 export const parseJson = (bytes, _specifier, location, _packageLocation) => {
   const source = textDecoder.decode(bytes);
+  /** @type {Array<string>} */
   const imports = freeze([]);
 
   /**

package/src/parse-mjs.d.ts

@@ -1,5 +1,6 @@
-/** @type {import('./types.js').ParseFn} */
-export const parseMjs: import("./types.js").ParseFn;
+/** @type {ParseFn} */
+export const parseMjs: ParseFn;
 declare const _default: import("./types.js").ParserImplementation;
 export default _default;
+import type { ParseFn } from './types.js';
 //# sourceMappingURL=parse-mjs.d.ts.map

package/src/parse-mjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-mjs.d.ts","sourceRoot":"","sources":["parse-mjs.js"],"names":[],"mappings":"AAQA,2CAA2C;AAC3C,uBADW,OAAO,YAAY,EAAE,OAAO,CAqBrC;wBAES,OAAO,YAAY,EAAE,oBAAoB"}
+{"version":3,"file":"parse-mjs.d.ts","sourceRoot":"","sources":["parse-mjs.js"],"names":[],"mappings":"AAQA,sBAAsB;AACtB,uBADW,OAAO,CAqBhB;wBAES,OAAO,YAAY,EAAE,oBAAoB;;6BA7BzB,YAAY"}

package/src/parse-mjs.js

@@ -1,12 +1,12 @@
-/* Provides language behavior (a parser) for importing ESM. */
+/** @module Provides language behavior (a parser) for importing ESM. */
 
-// @ts-check
+/** @import {ParseFn} from './types.js' */
 
 import { ModuleSource } from '@endo/module-source';
 
 const textDecoder = new TextDecoder();
 
-/** @type {import('./types.js').ParseFn} */
+/** @type {ParseFn} */
 export const parseMjs = (
   bytes,
   _specifier,

package/src/parse-pre-cjs.d.ts

@@ -1,5 +1,6 @@
-/** @type {import('./types.js').ParseFn} */
-export const parsePreCjs: import("./types.js").ParseFn;
+/** @type {ParseFn} */
+export const parsePreCjs: ParseFn;
 declare const _default: import("./types.js").ParserImplementation;
 export default _default;
+import type { ParseFn } from './types.js';
 //# sourceMappingURL=parse-pre-cjs.d.ts.map

package/src/parse-pre-cjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-pre-cjs.d.ts","sourceRoot":"","sources":["parse-pre-cjs.js"],"names":[],"mappings":"AAaA,2CAA2C;AAC3C,0BADW,OAAO,YAAY,EAAE,OAAO,CA+CrC;wBAES,OAAO,YAAY,EAAE,oBAAoB"}
+{"version":3,"file":"parse-pre-cjs.d.ts","sourceRoot":"","sources":["parse-pre-cjs.js"],"names":[],"mappings":"AAeA,sBAAsB;AACtB,0BADW,OAAO,CAuDhB;wBAES,OAAO,YAAY,EAAE,oBAAoB;;6BAhEzB,YAAY"}

package/src/parse-pre-cjs.js

@@ -1,17 +1,19 @@
-/* Provides language-specific behavior for importing pre-compiled CommonJS.
+/**
+ * @module Provides language-specific behavior for importing pre-compiled
+ * CommonJS.
  * Pre-compiled CommonJS is a module in JSON format that describes its imports,
  * exports, and source to execute in the presence of `require`, `module`, and
  * `exports`.
  */
 
-// @ts-check
+/** @import {ParseFn} from './types.js' */
 
 import { parseLocatedJson } from './json.js';
 import { wrap, getModulePaths } from './parse-cjs-shared-export-wrapper.js';
 
 const textDecoder = new TextDecoder();
 
-/** @type {import('./types.js').ParseFn} */
+/** @type {ParseFn} */
 export const parsePreCjs = (
   bytes,
   _specifier,
@@ -43,7 +45,15 @@ export const parsePreCjs = (
       readPowers,
     });
 
-    functor(require, moduleExports, module, filename, dirname);
+    // In CommonJS, the top-level `this` is the `module.exports` object.
+    functor.call(
+      moduleExports,
+      require,
+      moduleExports,
+      module,
+      filename,
+      dirname,
+    );
 
     afterExecute();
   };

package/src/parse-pre-mjs.d.ts

@@ -1,5 +1,6 @@
-/** @type {import('./types.js').ParseFn} */
-export const parsePreMjs: import("./types.js").ParseFn;
+/** @type {ParseFn} */
+export const parsePreMjs: ParseFn;
 declare const _default: import("./types.js").ParserImplementation;
 export default _default;
+import type { ParseFn } from './types.js';
 //# sourceMappingURL=parse-pre-mjs.d.ts.map

package/src/parse-pre-mjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-pre-mjs.d.ts","sourceRoot":"","sources":["parse-pre-mjs.js"],"names":[],"mappings":"AAYA,2CAA2C;AAC3C,0BADW,OAAO,YAAY,EAAE,OAAO,CAsBrC;wBAES,OAAO,YAAY,EAAE,oBAAoB"}
+{"version":3,"file":"parse-pre-mjs.d.ts","sourceRoot":"","sources":["parse-pre-mjs.js"],"names":[],"mappings":"AAaA,sBAAsB;AACtB,0BADW,OAAO,CAsBhB;wBAES,OAAO,YAAY,EAAE,oBAAoB;;6BA9BzB,YAAY"}

package/src/parse-pre-mjs.js

@@ -1,16 +1,17 @@
-/* Provides language-specific behaviors for importing pre-compiled ESM.
+/**
+ * @module Provides language-specific behaviors for importing pre-compiled ESM.
  * Pre-compiling or translating ESM from a module to a script with a
  * calling-convention is necessary to prepare an archive so that it can be
  * imported by the SES shim without entraining a dependency on Babel.
  */
 
-// @ts-check
+/** @import {ParseFn} from './types.js' */
 
 import { parseLocatedJson } from './json.js';
 
 const textDecoder = new TextDecoder();
 
-/** @type {import('./types.js').ParseFn} */
+/** @type {ParseFn} */
 export const parsePreMjs = (
   bytes,
   _specifier,

package/src/parse-text.d.ts

@@ -1,5 +1,6 @@
-/** @type {import('./types.js').ParseFn} */
-export const parseText: import("./types.js").ParseFn;
+/** @type {ParseFn} */
+export const parseText: ParseFn;
 declare const _default: import("./types.js").ParserImplementation;
 export default _default;
+import type { ParseFn } from './types.js';
 //# sourceMappingURL=parse-text.d.ts.map

package/src/parse-text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-text.d.ts","sourceRoot":"","sources":["parse-text.js"],"names":[],"mappings":"AAiBA,2CAA2C;AAC3C,wBADW,OAAO,YAAY,EAAE,OAAO,CAuBrC;wBAES,OAAO,YAAY,EAAE,oBAAoB"}
+{"version":3,"file":"parse-text.d.ts","sourceRoot":"","sources":["parse-text.js"],"names":[],"mappings":"AAkBA,sBAAsB;AACtB,wBADW,OAAO,CAuBhB;wBAES,OAAO,YAAY,EAAE,oBAAoB;;6BArCzB,YAAY"}

package/src/parse-text.js

@@ -1,9 +1,10 @@
-/* Provides language-behaviors for importing a module as a document that
- * exports itself as a string based on a UTF-8 interpretation of the module's
- * text.
+/**
+ * @module Provides language-behaviors for importing a module as a document
+ * that exports itself as a string based on a UTF-8 interpretation of the
+ * module's text.
  */
 
-// @ts-check
+/** @import {ParseFn} from './types.js' */
 
 /**
  * TypeScript cannot be relied upon to deal with the nuances of Readonly, so we
@@ -15,7 +16,7 @@ const freeze = Object.freeze;
 
 const textDecoder = new TextDecoder();
 
-/** @type {import('./types.js').ParseFn} */
+/** @type {ParseFn} */
 export const parseText = (bytes, _specifier, _location, _packageLocation) => {
   const text = textDecoder.decode(bytes);
 

package/src/policy-format.d.ts

@@ -3,7 +3,7 @@ export function isAllowingEverything(policyValue: unknown): policyValue is impor
 export function isAttenuationDefinition(allegedDefinition: unknown): allegedDefinition is import("./types.js").AttenuationDefinition;
 export function getAttenuatorFromDefinition(attenuationDefinition: import("./types.js").AttenuationDefinition): import("./types.js").UnifiedAttenuationDefinition;
 export function assertPackagePolicy(allegedPackagePolicy: unknown, path: string, url?: string | undefined): asserts allegedPackagePolicy is SomePackagePolicy | undefined;
-export function assertPolicy(allegedPolicy: unknown): asserts allegedPolicy is SomePolicy | undefined;
+export function assertPolicy(allegedPolicy: unknown): asserts allegedPolicy is (SomePolicy | undefined);
 import type { SomePackagePolicy } from './types.js';
 import type { SomePolicy } from './types.js';
 //# sourceMappingURL=policy-format.d.ts.map

package/src/policy-format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"policy-format.d.ts","sourceRoot":"","sources":["policy-format.js"],"names":[],"mappings":"AA6BO,kDALI,OAAO,YAAY,EAAE,aAAa,SAClC,UAAU,GAAC,SAAS,GAAC,UAAU,YAC/B,MAAM,GACJ,OAAO,GAAG,OAAO,YAAY,EAAE,qBAAqB,CAyBhE;AAQM,kDAHI,OAAO,GACL,WAAW,IAAI,OAAO,YAAY,EAAE,cAAc,CAGxB;AAOhC,2DAHI,OAAO,GACL,iBAAiB,IAAI,OAAO,YAAY,EAAE,qBAAqB,CAS3E;AAOM,mEAHI,OAAO,YAAY,EAAE,qBAAqB,GACxC,OAAO,YAAY,EAAE,4BAA4B,CAuB7D;AA0CM,0DALI,OAAO,QACP,MAAM,6BAEJ,QAAQ,oBAAoB,IAAI,iBAAiB,GAAC,SAAS,CA4DvE;AAUM,4CAHI,OAAO,GACL,QAAQ,aAAa,IAAI,UAAU,GAAC,SAAS,CAgCzD;uCA7OoC,YAAY;gCACnB,YAAY"}
+{"version":3,"file":"policy-format.d.ts","sourceRoot":"","sources":["policy-format.js"],"names":[],"mappings":"AA2BO,kDALI,OAAO,YAAY,EAAE,aAAa,SAClC,UAAU,GAAC,SAAS,GAAC,UAAU,YAC/B,MAAM,GACJ,OAAO,GAAG,OAAO,YAAY,EAAE,qBAAqB,CAyBhE;AAQM,kDAHI,OAAO,GACL,WAAW,IAAI,OAAO,YAAY,EAAE,cAAc,CAGxB;AAOhC,2DAHI,OAAO,GACL,iBAAiB,IAAI,OAAO,YAAY,EAAE,qBAAqB,CAS3E;AAOM,mEAHI,OAAO,YAAY,EAAE,qBAAqB,GACxC,OAAO,YAAY,EAAE,4BAA4B,CAuB7D;AA0CM,0DALI,OAAO,QACP,MAAM,6BAEJ,QAAQ,oBAAoB,IAAI,iBAAiB,GAAC,SAAS,CA4DvE;AAUM,4CAHI,OAAO,GACL,QAAQ,aAAa,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAgC7D;uCA5OgD,YAAY;gCAAZ,YAAY"}

package/src/policy-format.js

@@ -1,11 +1,9 @@
-/* Provides functions for enforcing compartment-map linkage and global variable
- * policies for each compartment.
+/**
+ * @module Provides functions for enforcing compartment-map linkage and global
+ * variable policies for each compartment.
  */
 
-// @ts-check
-
-/** @import {SomePackagePolicy} from './types.js' */
-/** @import {SomePolicy} from './types.js' */
+/** @import {SomePackagePolicy, SomePolicy} from './types.js' */
 
 const { entries, keys } = Object;
 const { isArray } = Array;
@@ -209,7 +207,7 @@ export const assertPackagePolicy = (allegedPackagePolicy, path, url) => {
  * It also moonlights as a type guard.
  *
  * @param {unknown} allegedPolicy - Alleged `Policy` to test
- * @returns {asserts allegedPolicy is SomePolicy|undefined}
+ * @returns {asserts allegedPolicy is (SomePolicy | undefined)}
  */
 export const assertPolicy = allegedPolicy => {
   if (allegedPolicy === undefined) {

package/src/policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["policy.js"],"names":[],"mappings":"AA2BA;;GAEG;AACH,sDAAuD;AAyDhD,gEAFM,KAAK,CAAC,MAAM,CAAC,CAezB;AA0BM,qDAJI,gBAAgB,iBAChB,aAAa,GACX,OAAO,CASnB;;;;;;;;;AAKE,+CACQ,gBAAgB,UAChB,UAAU,GACR,iBAAiB,CAC7B;;;;;;;;;AAKE,+CACQ,gBAAgB,oCAEd,iBAAiB,GAAC,SAAS,CACvC;AAkFM,8DAJI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,0BAC3B,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACnC,2BAA2B,CA0CvC;AAoDM,6CARI,MAAM,WACN,MAAM,iBACN,aAAa,eACb,2BAA2B,eAC3B,KAAK,cAAS,SACd,MAAM,GACJ,IAAI,CAgDhB;AA2BM,+CAJI,MAAM,yBACN,qBAAqB,sEAiC/B;AAgDM,+CANI,MAAM,wBACN,OAAO,KAAK,EAAE,+BAA+B,UAC7C,aAAa,eACb,2BAA2B,GACzB,OAAO,CAAC,OAAO,KAAK,EAAE,+BAA+B,CAAC,CAyBlE;;;;;;;;;;;;;;4BA9eyB,YAAY;sCAGF,YAAY;mCAFf,YAAY;gCAMf,YAAY;uCACL,YAAY;2CAHR,YAAY;iDADN,YAAY"}
+{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["policy.js"],"names":[],"mappings":"AAgCA;;GAEG;AACH,sDAAuD;AAyDhD,gEAFM,KAAK,CAAC,MAAM,CAAC,CAezB;AA0BM,qDAJI,gBAAgB,iBAChB,aAAa,GACX,OAAO,CASnB;;;;;;;;;AAKE,+CACQ,gBAAgB,UAChB,UAAU,GACR,iBAAiB,CAC7B;;;;;;;;;AAKE,+CACQ,gBAAgB,oCAEd,iBAAiB,GAAC,SAAS,CACvC;AAkFM,8DAJI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,0BAC3B,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACnC,2BAA2B,CA0CvC;AAoDM,6CARI,MAAM,WACN,MAAM,iBACN,aAAa,eACb,2BAA2B,eAC3B,KAAK,cAAS,SACd,MAAM,GACJ,IAAI,CAgDhB;AA2BM,+CAJI,MAAM,yBACN,qBAAqB,sEAiC/B;AAgDM,+CANI,MAAM,wBACN,OAAO,KAAK,EAAE,+BAA+B,UAC7C,aAAa,eACb,2BAA2B,GACzB,OAAO,CAAC,OAAO,KAAK,EAAE,+BAA+B,CAAC,CAyBlE;;;;;;;;;;;;;;4BAveS,YAAY;sCAAZ,YAAY;mCAAZ,YAAY;gCAAZ,YAAY;uCAAZ,YAAY;2CAAZ,YAAY;iDAAZ,YAAY"}

package/src/policy.js

@@ -1,17 +1,22 @@
-/* Provides mechanisms for interacting with Compartment Map runtime policies.
+/**
+ * @module Provides mechanisms for interacting with Compartment Map runtime policies.
  */
 
 // @ts-check
 
-/** @import {Policy} from './types.js' */
-/** @import {PackagePolicy} from './types.js' */
-/** @import {AttenuationDefinition} from './types.js' */
-/** @import {PackageNamingKit} from './types.js' */
-/** @import {DeferredAttenuatorsProvider} from './types.js' */
-/** @import {CompartmentDescriptor} from './types.js' */
-/** @import {Attenuator} from './types.js' */
-/** @import {SomePolicy} from './types.js' */
-/** @import {SomePackagePolicy} from './types.js' */
+/**
+ * @import {
+ *   Policy,
+ *   PackagePolicy,
+ *   AttenuationDefinition,
+ *   PackageNamingKit,
+ *   DeferredAttenuatorsProvider,
+ *   CompartmentDescriptor,
+ *   Attenuator,
+ *   SomePolicy,
+ *   SomePackagePolicy,
+ * } from './types.js'
+ */
 
 import {
   getAttenuatorFromDefinition,

package/src/powers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"powers.d.ts","sourceRoot":"","sources":["powers.js"],"names":[],"mappings":"AA0BO,yCAHI,MAAM,GAAG,UAAU,GAAG,eAAe,GACnC,eAAe,CAgC3B;AAiBM,uCAHI,UAAU,GAAC,MAAM,GAAC,SAAS,GACzB,KAAK,IAAI,aAAa,CAShC;AAWI,wFAFM,iBAAiB,EAAE,CAS/B;4BAtFyB,YAAY;gCACR,YAAY;qCACP,YAAY;mCAJd,YAAY;uCACR,YAAY"}
+{"version":3,"file":"powers.d.ts","sourceRoot":"","sources":["powers.js"],"names":[],"mappings":"AA6BO,yCAHI,MAAM,GAAG,UAAU,GAAG,eAAe,GACnC,eAAe,CAgC3B;AAiBM,uCAHI,UAAU,GAAC,MAAM,GAAC,SAAS,GACzB,KAAK,IAAI,aAAa,CAShC;AAWI,wFAFM,iBAAiB,EAAE,CAS/B;4BApFS,YAAY;gCAAZ,YAAY;qCAAZ,YAAY;mCAAZ,YAAY;uCAAZ,YAAY"}

package/src/powers.js

@@ -1,19 +1,22 @@
-/* As the interface of the Compartment Mapper evolved, it became necessary to
- * expand some function signatures that accepted a single power to one that
- * accepted a powers object.
+/**
+ * @module As the interface of the Compartment Mapper evolved, it became
+ * necessary to expand some function signatures that accepted a single power to
+ * one that accepted a powers object.
  * This module provides functions for safely unpacking I/O capabilities and
  * maintaining backward-compatibility with older accepted usage patterns.
  */
 
-// @ts-check
-
-/** @import {CanonicalFn} from './types.js' */
-/** @import {ReadNowPowers} from './types.js' */
-/** @import {ReadNowPowersProp} from './types.js' */
-/** @import {ReadFn} from './types.js' */
-/** @import {ReadPowers} from './types.js' */
-/** @import {MaybeReadPowers} from './types.js' */
-/** @import {MaybeReadFn} from './types.js' */
+/**
+ * @import {
+ *   CanonicalFn,
+ *   ReadNowPowers,
+ *   ReadNowPowersProp,
+ *   ReadFn,
+ *   ReadPowers,
+ *   MaybeReadPowers,
+ *   MaybeReadFn,
+ * } from './types.js'
+ */
 
 const { freeze } = Object;
 

package/src/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.js"],"names":[],"mappings":"AAqCO,iCALM,CAAC,YACH,MAAM,uBACN,CAAC,QAAQ,EAAC,MAAM,KAAG,OAAO,CAAC,CAAC,GAAC,SAAS,CAAC,GACrC,OAAO,CAAC;IAAC,IAAI,EAAC,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAC,MAAM,CAAC;IAAC,yBAAyB,EAAE,MAAM,CAAA;CAAC,CAAC,CA0BpG;AAoCM,mCATI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,GACJ,OAAO,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,yBAAyB,EAAE,MAAM,CAAC;IAClC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC,CAoBJ;4BA7GyB,YAAY;gCACR,YAAY;qCACP,YAAY"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.js"],"names":[],"mappings":"AAwCO,iCALM,CAAC,YACH,MAAM,uBACN,CAAC,QAAQ,EAAC,MAAM,KAAG,OAAO,CAAC,CAAC,GAAC,SAAS,CAAC,GACrC,OAAO,CAAC;IAAC,IAAI,EAAC,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAC,MAAM,CAAC;IAAC,yBAAyB,EAAE,MAAM,CAAA;CAAC,CAAC,CA0BpG;AAoCM,mCATI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,GACJ,OAAO,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,yBAAyB,EAAE,MAAM,CAAC;IAClC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC,CAoBJ;4BA5GS,YAAY;gCAAZ,YAAY;qCAAZ,YAAY"}

package/src/search.js

@@ -1,12 +1,15 @@
-/* Provides the behavior for `node-modules.js` to find modules and packages
- * according to the Node.js `node_modules` convention.
+/**
+ * @module Provides the behavior for `node-modules.js` to find modules and
+ * packages according to the Node.js `node_modules` convention.
  */
 
-// @ts-check
-
-/** @import {ReadFn} from './types.js' */
-/** @import {ReadPowers} from './types.js' */
-/** @import {MaybeReadPowers} from './types.js' */
+/**
+ * @import {
+ *   ReadFn,
+ *   ReadPowers,
+ *   MaybeReadPowers,
+ * } from './types.js'
+ */
 
 import { relativize } from './node-module-specifier.js';
 import { relative } from './url.js';

package/src/types/compartment-map-schema.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @module These types describe the schema of a `compartment-map.json`, which
+ * in turn describes how to load and link an application from storage, like a
+ * file system, web host, or zip archive.
+ */
+import type { SomePackagePolicy } from './policy-schema.js';
+import type { LiteralUnion } from './typescript.js';
+/**
+ * A compartment map describes how to construct an application as a graph of
+ * Compartments, each corresponding to Node.js style packaged modules.
+ */
+export type CompartmentMapDescriptor = {
+    tags: Array<string>;
+    entry: EntryDescriptor;
+    compartments: Record<string, CompartmentDescriptor>;
+};
+/**
+ * The entry descriptor of a compartment map denotes the root module of an
+ * application and the compartment that contains it.
+ */
+export type EntryDescriptor = {
+    compartment: string;
+    module: string;
+};
+/**
+ * A compartment descriptor corresponds to a single Compartment
+ * of an assembled Application and describes how to construct
+ * one for a given library or application `package.json`.
+ */
+export type CompartmentDescriptor = {
+    label: string;
+    /** shortest path of dependency names to this compartment */
+    path?: Array<string>;
+    /**
+     * the name of the originating package suitable for constructing a sourceURL
+     * prefix that will match it to files in a developer workspace.
+     */
+    name: string;
+    location: string;
+    /**
+     * whether this compartment was retained by any module in the solution. This
+     * property should never appear in an archived compartment map.
+     */
+    retained?: boolean;
+    modules: Record<string, ModuleDescriptor>;
+    scopes: Record<string, ScopeDescriptor>;
+    /** language for extension */
+    parsers: LanguageForExtension;
+    /** language for module specifier */
+    types: LanguageForModuleSpecifier;
+    /** policy specific to compartment */
+    policy: SomePackagePolicy;
+    /** List of compartment names this Compartment depends upon */
+    compartments: Set<string>;
+};
+/**
+ * For every module explicitly mentioned in an `exports` field of a
+ * `package.json`, there is a corresponding module descriptor.
+ */
+export type ModuleDescriptor = {
+    compartment?: string;
+    module?: string;
+    location?: string;
+    parser?: Language;
+    /** in base 16, hex */
+    sha512?: string;
+    exit?: string;
+    deferredError?: string;
+    retained?: boolean;
+};
+/**
+ * Scope descriptors link all names under a prefix to modules in another
+ * compartment, like a wildcard.
+ * These are employed to link any module not explicitly mentioned
+ * in a `package.json` file, when that `package.json` file does not have
+ * an explicit `exports` map.
+ */
+export type ScopeDescriptor = {
+    compartment: string;
+    module?: string;
+};
+/**
+ * Natively-recognized and custom languages
+ */
+export type Language = LiteralUnion<BuiltinLanguage, string>;
+/**
+ * Languages natively recognized by `compartment-mapper`
+ */
+export type BuiltinLanguage = 'mjs' | 'cjs' | 'json' | 'bytes' | 'text' | 'pre-mjs-json' | 'pre-cjs-json';
+/**
+ * Mapping of file extension to {@link Language Languages}.
+ */
+export type LanguageForExtension = Record<string, Language>;
+/**
+ * Mapping of module specifier to {@link Language Languages}.
+ */
+export type LanguageForModuleSpecifier = Record<string, Language>;
+//# sourceMappingURL=compartment-map-schema.d.ts.map

package/src/types/compartment-map-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compartment-map-schema.d.ts","sourceRoot":"","sources":["compartment-map-schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,KAAK,EAAE,eAAe,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CACrD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC1C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,6BAA6B;IAC7B,OAAO,EAAE,oBAAoB,CAAC;IAC9B,oCAAoC;IACpC,KAAK,EAAE,0BAA0B,CAAC;IAClC,qCAAqC;IACrC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,8DAA8D;IAC9D,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,KAAK,GACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,MAAM,GACN,cAAc,GACd,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC"}