@endo/compartment-mapper 1.3.1 → 1.4.0

package/src/types/powers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"powers.d.ts","sourceRoot":"","sources":["powers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAIlD,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,WAAW,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAClC,UAAU,CAAC,EAAE,YAAY,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG;IACzC,SAAS,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,GAC7D,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG,YAAY,GAAG,cAAc,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEhE,MAAM,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;AAEhF,MAAM,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,UAAU,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAAC;AAE1E,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,MAAM,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,KAAK,MAAM,CAAC;AAEjE,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,CAAC;AAExD,MAAM,MAAM,gBAAgB,GAAG,CAC7B,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EACJ;IACE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,GACD,SAAS,KACV,GAAG,CAAC;AAET,MAAM,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,WAAW,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAIF,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE7E,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;AAInD,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC"}

package/src/types/powers.ts

@@ -0,0 +1,120 @@
+/**
+ * @module The compartment mapper requires certain host capabilities.
+ * These are the platform-neutral types for those capabilities.
+ * For example, {@file node-powers.js} adapts Node.js how modules
+ * to various subsets of these capabilities.
+ */
+
+/* eslint-disable no-use-before-define */
+
+import type { SomeObject } from './typescript.js';
+
+// Read
+
+export type ReadPowers = {
+  canonical: CanonicalFn;
+  read: ReadFn;
+  maybeRead?: MaybeReadFn;
+  readNow?: ReadNowFn;
+  maybeReadNow?: MaybeReadNowFn;
+  computeSha512?: HashFn;
+  fileURLToPath?: FileURLToPathFn;
+  pathToFileURL?: PathToFileURLFn;
+  requireResolve?: RequireResolveFn;
+  isAbsolute?: IsAbsoluteFn;
+};
+
+export type MaybeReadPowers = ReadPowers & {
+  maybeRead: MaybeReadFn;
+};
+
+/**
+ * The extension of {@link ReadPowers} necessary for dynamic require support
+ *
+ * For a `ReadPowers` to be a `ReadNowPowers`:
+ *
+ * 1. It must be an object (not a {@link ReadFn})
+ * 2. Prop `maybeReadNow` is a function
+ * 3. Prop `fileURLToPath` is a function
+ * 4. Prop `isAbsolute` is a function
+ */
+export type ReadNowPowers = Omit<ReadPowers, ReadNowPowersProp> &
+  Required<Pick<ReadPowers, ReadNowPowersProp>>;
+
+/**
+ * These properties are necessary for dynamic require support
+ */
+export type ReadNowPowersProp = 'fileURLToPath' | 'isAbsolute' | 'maybeReadNow';
+
+/**
+ * Returns a canonical URL for a given URL, following redirects or symbolic
+ * links if any exist along the path.
+ * Must return the given logical location if the real location does not exist.
+ */
+export type CanonicalFn = (location: string) => Promise<string>;
+
+export type ReadFn = (location: string) => Promise<Uint8Array>;
+
+/**
+ * A resolution of `undefined` indicates `ENOENT` or the equivalent.
+ */
+export type MaybeReadFn = (location: string) => Promise<Uint8Array | undefined>;
+
+export type ReadNowFn = (location: string) => Uint8Array;
+
+/**
+ * A resolution of `undefined` indicates `ENOENT` or the equivalent.
+ */
+export type MaybeReadNowFn = (location: string) => Uint8Array | undefined;
+
+export type HashFn = (bytes: Uint8Array) => string;
+
+export type FileURLToPathFn = (location: string | URL) => string;
+
+export type PathToFileURLFn = (location: string) => URL;
+
+export type RequireResolveFn = (
+  fromLocation: string,
+  specifier: string,
+  options?:
+    | {
+        paths?: string[];
+      }
+    | undefined,
+) => any;
+
+export type IsAbsoluteFn = (location: string) => boolean;
+
+export type ArchiveReader = {
+  read: ReadFn;
+};
+
+export type HashPowers = {
+  read: ReadFn;
+  canonical: CanonicalFn;
+  computeSha512: HashFn;
+};
+
+// Write
+
+export type WritePowers = {
+  write: WriteFn;
+};
+
+export type WriteFn = (location: string, bytes: Uint8Array) => Promise<void>;
+
+export type ArchiveWriter = {
+  write: WriteFn;
+  snapshot: SnapshotFn;
+};
+
+export type SnapshotFn = () => Promise<Uint8Array>;
+
+// Execute
+
+export type Application = {
+  import: ExecuteFn;
+  sha512?: string | undefined;
+};
+
+export type ExecuteFn = (options?: any) => Promise<SomeObject>;

package/src/types/typescript.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @module Helpers relevant to any TypeScript project.
+ */
+/** Any object. All objects. Not `null`, though. */
+export type SomeObject = Record<PropertyKey, any>;
+/**
+ * Matches any {@link
+ * https://developer.mozilla.org/en-US/docs/Glossary/Primitive primitive
+ * value}.
+ */
+export type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+/**
+ * Allows creating a union type by combining primitive types and literal types
+ * without sacrificing auto-completion in IDEs for the literal type part of the
+ * union.
+ *
+ * Currently, when a union type of a primitive type is combined with literal
+ * types, TypeScript loses all information about the combined literals. Thus,
+ * when such a type is used in an IDE with autocompletion, no suggestions are
+ * made for the declared literals.
+ *
+ * This type is a workaround for {@link
+ * https://github.com/Microsoft/TypeScript/issues/29729
+ * Microsoft/TypeScript#29729}. It will be removed as soon as it's not needed
+ * anymore.
+ */
+export type LiteralUnion<LiteralType, PrimitiveType extends Primitive> = LiteralType | (PrimitiveType & Record<never, never>);
+//# sourceMappingURL=typescript.d.ts.map

package/src/types/typescript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["typescript.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AAElD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GACjB,IAAI,GACJ,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,CAAC;AAEX;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,YAAY,CAAC,WAAW,EAAE,aAAa,SAAS,SAAS,IACjE,WAAW,GACX,CAAC,aAAa,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC"}

package/src/types/typescript.ts

@@ -0,0 +1,41 @@
+/**
+ * @module Helpers relevant to any TypeScript project.
+ */
+
+/** Any object. All objects. Not `null`, though. */
+export type SomeObject = Record<PropertyKey, any>;
+
+/**
+ * Matches any {@link
+ * https://developer.mozilla.org/en-US/docs/Glossary/Primitive primitive
+ * value}.
+ */
+export type Primitive =
+  | null
+  | undefined
+  | string
+  | number
+  | boolean
+  | symbol
+  | bigint;
+
+/**
+ * Allows creating a union type by combining primitive types and literal types
+ * without sacrificing auto-completion in IDEs for the literal type part of the
+ * union.
+ *
+ * Currently, when a union type of a primitive type is combined with literal
+ * types, TypeScript loses all information about the combined literals. Thus,
+ * when such a type is used in an IDE with autocompletion, no suggestions are
+ * made for the declared literals.
+ *
+ * This type is a workaround for {@link
+ * https://github.com/Microsoft/TypeScript/issues/29729
+ * Microsoft/TypeScript#29729}. It will be removed as soon as it's not needed
+ * anymore.
+ */
+export type LiteralUnion<LiteralType, PrimitiveType extends Primitive> =
+  | LiteralType
+  | (PrimitiveType & Record<never, never>);
+
+// LiteralUnion is from https://www.npmjs.com/package/type-fest

package/src/types-external.d.ts

@@ -0,0 +1,14 @@
+// ESlint does not understand export *
+/* eslint-disable import/export */
+
+// These type definitions include all of the external types for the compartment
+// mapper that propagate through each of the exported modules of the
+// compartment mapper.
+// See ./types.d.ts for the additional internal types.
+
+export type * from './types/external.js';
+export type * from './types/compartment-map-schema.js';
+export type * from './types/policy-schema.js';
+export type * from './types/policy.js';
+export type * from './types/powers.js';
+export type * from './types/node-powers.js';

package/src/types-external.js

@@ -0,0 +1,2 @@
+// Empty JS file to correspond with its .d.ts twin
+export {};