@metamask-previews/json-rpc-engine 10.1.1-preview-63ea58af → 10.1.1-preview-0458fe94

package/dist/v2/JsonRpcServer.mjs

@@ -0,0 +1,158 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _JsonRpcServer_instances, _JsonRpcServer_engine, _JsonRpcServer_onError, _JsonRpcServer_coerceRequest;
+import { rpcErrors, serializeError } from "@metamask/rpc-errors";
+import { hasProperty, isObject } from "@metamask/utils";
+import { JsonRpcEngineV2 } from "./JsonRpcEngineV2.mjs";
+import { getUniqueId } from "../getUniqueId.mjs";
+const jsonrpc = '2.0';
+/**
+ * A JSON-RPC server that handles requests and notifications.
+ *
+ * Essentially wraps a {@link JsonRpcEngineV2} in order to create a conformant
+ * yet permissive JSON-RPC 2.0 server.
+ *
+ * @example
+ * ```ts
+ * const server = new JsonRpcServer({
+ *   engine,
+ *   onError,
+ * });
+ *
+ * const response = await server.handle(request);
+ * if ('result' in response) {
+ *   // Handle result
+ * } else {
+ *   // Handle error
+ * }
+ * ```
+ */
+export class JsonRpcServer {
+    /**
+     * Construct a new JSON-RPC server.
+     *
+     * @param options - The options for the server.
+     * @param options.onError - The callback to handle errors thrown by the
+     * engine. Errors always result in a failed response object, containing a
+     * JSON-RPC 2.0 serialized version of the original error. If you need to
+     * access the original error, use the `onError` callback.
+     * @param options.engine - The engine to use. Mutually exclusive with
+     * `middleware`.
+     * @param options.middleware - The middleware to use. Mutually exclusive with
+     * `engine`.
+     */
+    constructor(options) {
+        _JsonRpcServer_instances.add(this);
+        _JsonRpcServer_engine.set(this, void 0);
+        _JsonRpcServer_onError.set(this, void 0);
+        __classPrivateFieldSet(this, _JsonRpcServer_onError, options.onError, "f");
+        if (hasProperty(options, 'engine')) {
+            // @ts-expect-error - hasProperty fails to narrow the type.
+            __classPrivateFieldSet(this, _JsonRpcServer_engine, options.engine, "f");
+        }
+        else {
+            __classPrivateFieldSet(this, _JsonRpcServer_engine, JsonRpcEngineV2.create({ middleware: options.middleware }), "f");
+        }
+    }
+    async handle(rawRequest) {
+        // If rawRequest is not a notification, the originalId will be attached
+        // to the response. We attach our own, trusted id in #coerceRequest()
+        // while the request is being handled.
+        const [originalId, isRequest] = getOriginalId(rawRequest);
+        try {
+            const request = __classPrivateFieldGet(this, _JsonRpcServer_instances, "m", _JsonRpcServer_coerceRequest).call(this, rawRequest, isRequest);
+            const result = await __classPrivateFieldGet(this, _JsonRpcServer_engine, "f").handle(request);
+            if (result !== undefined) {
+                return {
+                    jsonrpc,
+                    // @ts-expect-error - Reassign the original id, regardless of its type.
+                    id: originalId,
+                    result,
+                };
+            }
+        }
+        catch (error) {
+            __classPrivateFieldGet(this, _JsonRpcServer_onError, "f")?.call(this, error);
+            if (isRequest) {
+                return {
+                    jsonrpc,
+                    // @ts-expect-error - Reassign the original id, regardless of its type.
+                    id: originalId,
+                    error: serializeError(error, {
+                        shouldIncludeStack: false,
+                        shouldPreserveMessage: true,
+                    }),
+                };
+            }
+        }
+        return undefined;
+    }
+}
+_JsonRpcServer_engine = new WeakMap(), _JsonRpcServer_onError = new WeakMap(), _JsonRpcServer_instances = new WeakSet(), _JsonRpcServer_coerceRequest = function _JsonRpcServer_coerceRequest(rawRequest, isRequest) {
+    if (!isMinimalRequest(rawRequest)) {
+        throw rpcErrors.invalidRequest({
+            data: {
+                request: rawRequest,
+            },
+        });
+    }
+    const request = {
+        jsonrpc,
+        method: rawRequest.method,
+    };
+    if (hasProperty(rawRequest, 'params')) {
+        request.params = rawRequest.params;
+    }
+    if (isRequest) {
+        request.id = getUniqueId();
+    }
+    return request;
+};
+/**
+ * Check if an unvalidated request is a minimal request.
+ *
+ * @param rawRequest - The raw request to check.
+ * @returns `true` if the request is a {@link MinimalRequest}, `false` otherwise.
+ */
+function isMinimalRequest(rawRequest) {
+    return (isObject(rawRequest) &&
+        hasProperty(rawRequest, 'method') &&
+        typeof rawRequest.method === 'string' &&
+        hasValidParams(rawRequest));
+}
+/**
+ * Check if a request has valid params, i.e. an array or object.
+ * The contents of the params are not inspected.
+ *
+ * @param rawRequest - The request to check.
+ * @returns `true` if the request has valid params, `false` otherwise.
+ */
+function hasValidParams(rawRequest) {
+    if (hasProperty(rawRequest, 'params')) {
+        return Array.isArray(rawRequest.params) || isObject(rawRequest.params);
+    }
+    return true;
+}
+/**
+ * Get the original id from a request.
+ *
+ * @param rawRequest - The request to get the original id from.
+ * @returns The original id and a boolean indicating if the request is a request
+ * (as opposed to a notification).
+ */
+function getOriginalId(rawRequest) {
+    if (isObject(rawRequest) && hasProperty(rawRequest, 'id')) {
+        return [rawRequest.id, true];
+    }
+    return [undefined, false];
+}
+//# sourceMappingURL=JsonRpcServer.mjs.map

package/dist/v2/JsonRpcServer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonRpcServer.mjs","sourceRoot":"","sources":["../../src/v2/JsonRpcServer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,6BAA6B;AAQjE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAGxD,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAe7C,MAAM,OAAO,GAAG,KAAc,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,aAAa;IAKxB;;;;;;;;;;;;OAYG;IACH,YAAY,OAAgB;;QAjBnB,wCAAyB;QAEzB,yCAA+B;QAgBtC,uBAAA,IAAI,0BAAY,OAAO,CAAC,OAAO,MAAA,CAAC;QAEhC,IAAI,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;YAClC,2DAA2D;YAC3D,uBAAA,IAAI,yBAAW,OAAO,CAAC,MAAM,MAAA,CAAC;SAC/B;aAAM;YACL,uBAAA,IAAI,yBAAW,eAAe,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,MAAA,CAAC;SAC3E;IACH,CAAC;IAuCD,KAAK,CAAC,MAAM,CAAC,UAAmB;QAC9B,uEAAuE;QACvE,qEAAqE;QACrE,sCAAsC;QACtC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;QAE1D,IAAI;YACF,MAAM,OAAO,GAAG,uBAAA,IAAI,8DAAe,MAAnB,IAAI,EAAgB,UAAU,EAAE,SAAS,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,6BAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAElD,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,OAAO;oBACL,OAAO;oBACP,uEAAuE;oBACvE,EAAE,EAAE,UAAU;oBACd,MAAM;iBACP,CAAC;aACH;SACF;QAAC,OAAO,KAAK,EAAE;YACd,uBAAA,IAAI,8BAAS,EAAE,KAAf,IAAI,EAAY,KAAK,CAAC,CAAC;YAEvB,IAAI,SAAS,EAAE;gBACb,OAAO;oBACL,OAAO;oBACP,uEAAuE;oBACvE,EAAE,EAAE,UAAU;oBACd,KAAK,EAAE,cAAc,CAAC,KAAK,EAAE;wBAC3B,kBAAkB,EAAE,KAAK;wBACzB,qBAAqB,EAAE,IAAI;qBAC5B,CAAC;iBACH,CAAC;aACH;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CA0BF;8LAxBgB,UAAmB,EAAE,SAAkB;IACpD,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,MAAM,SAAS,CAAC,cAAc,CAAC;YAC7B,IAAI,EAAE;gBACJ,OAAO,EAAE,UAAU;aACpB;SACF,CAAC,CAAC;KACJ;IAED,MAAM,OAAO,GAAgB;QAC3B,OAAO;QACP,MAAM,EAAE,UAAU,CAAC,MAAM;KAC1B,CAAC;IAEF,IAAI,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE;QACrC,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAuB,CAAC;KACrD;IAED,IAAI,SAAS,EAAE;QACZ,OAA0B,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC;KAChD;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAWH;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,UAAmB;IAC3C,OAAO,CACL,QAAQ,CAAC,UAAU,CAAC;QACpB,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC;QACjC,OAAO,UAAU,CAAC,MAAM,KAAK,QAAQ;QACrC,cAAc,CAAC,UAAU,CAAC,CAC3B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CACrB,UAAmC;IAEnC,IAAI,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE;QACrC,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;KACxE;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,UAAmB;IACxC,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE;QACzD,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;KAC9B;IAED,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC5B,CAAC","sourcesContent":["import { rpcErrors, serializeError } from '@metamask/rpc-errors';\nimport type {\n  JsonRpcNotification,\n  JsonRpcParams,\n  JsonRpcRequest,\n  JsonRpcResponse,\n  NonEmptyArray,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport type { JsonRpcMiddleware } from './JsonRpcEngineV2';\nimport { JsonRpcEngineV2 } from './JsonRpcEngineV2';\nimport type { JsonRpcCall } from './utils';\nimport { getUniqueId } from '../getUniqueId';\n\ntype OnError = (error: unknown) => void;\n\ntype Options = {\n  onError?: OnError;\n} & (\n  | {\n      engine: JsonRpcEngineV2;\n    }\n  | {\n      middleware: NonEmptyArray<JsonRpcMiddleware>;\n    }\n);\n\nconst jsonrpc = '2.0' as const;\n\n/**\n * A JSON-RPC server that handles requests and notifications.\n *\n * Essentially wraps a {@link JsonRpcEngineV2} in order to create a conformant\n * yet permissive JSON-RPC 2.0 server.\n *\n * @example\n * ```ts\n * const server = new JsonRpcServer({\n *   engine,\n *   onError,\n * });\n *\n * const response = await server.handle(request);\n * if ('result' in response) {\n *   // Handle result\n * } else {\n *   // Handle error\n * }\n * ```\n */\nexport class JsonRpcServer {\n  readonly #engine: JsonRpcEngineV2;\n\n  readonly #onError?: OnError | undefined;\n\n  /**\n   * Construct a new JSON-RPC server.\n   *\n   * @param options - The options for the server.\n   * @param options.onError - The callback to handle errors thrown by the\n   * engine. Errors always result in a failed response object, containing a\n   * JSON-RPC 2.0 serialized version of the original error. If you need to\n   * access the original error, use the `onError` callback.\n   * @param options.engine - The engine to use. Mutually exclusive with\n   * `middleware`.\n   * @param options.middleware - The middleware to use. Mutually exclusive with\n   * `engine`.\n   */\n  constructor(options: Options) {\n    this.#onError = options.onError;\n\n    if (hasProperty(options, 'engine')) {\n      // @ts-expect-error - hasProperty fails to narrow the type.\n      this.#engine = options.engine;\n    } else {\n      this.#engine = JsonRpcEngineV2.create({ middleware: options.middleware });\n    }\n  }\n\n  /**\n   * Handle a JSON-RPC request.\n   *\n   * This method never throws. For requests, a response is always returned.\n   * All errors are passed to the engine's `onError` callback.\n   *\n   * @param request - The request to handle.\n   * @returns The JSON-RPC response.\n   */\n  async handle(request: JsonRpcRequest): Promise<JsonRpcResponse>;\n\n  /**\n   * Handle a JSON-RPC notification.\n   *\n   * This method never throws. For notifications, `undefined` is always returned.\n   * All errors are passed to the engine's `onError` callback.\n   *\n   * @param notification - The notification to handle.\n   */\n  async handle(notification: JsonRpcNotification): Promise<void>;\n\n  /**\n   * Handle an alleged JSON-RPC request or notification. Permits any plain\n   * object with `{ method: string }`, so long as any present JSON-RPC 2.0\n   * properties are valid. If the object has no `id`, it will be treated as\n   * a notification and vice versa.\n   *\n   * This method never throws. All errors are passed to the engine's\n   * `onError` callback. A JSON-RPC response is always returned for requests,\n   * and `undefined` is returned for notifications.\n   *\n   * @param rawRequest - The raw request to handle.\n   * @returns The JSON-RPC response, or `undefined` if the request is a\n   * notification.\n   */\n  async handle(rawRequest: unknown): Promise<JsonRpcResponse | void>;\n\n  async handle(rawRequest: unknown): Promise<JsonRpcResponse | void> {\n    // If rawRequest is not a notification, the originalId will be attached\n    // to the response. We attach our own, trusted id in #coerceRequest()\n    // while the request is being handled.\n    const [originalId, isRequest] = getOriginalId(rawRequest);\n\n    try {\n      const request = this.#coerceRequest(rawRequest, isRequest);\n      const result = await this.#engine.handle(request);\n\n      if (result !== undefined) {\n        return {\n          jsonrpc,\n          // @ts-expect-error - Reassign the original id, regardless of its type.\n          id: originalId,\n          result,\n        };\n      }\n    } catch (error) {\n      this.#onError?.(error);\n\n      if (isRequest) {\n        return {\n          jsonrpc,\n          // @ts-expect-error - Reassign the original id, regardless of its type.\n          id: originalId,\n          error: serializeError(error, {\n            shouldIncludeStack: false,\n            shouldPreserveMessage: true,\n          }),\n        };\n      }\n    }\n    return undefined;\n  }\n\n  #coerceRequest(rawRequest: unknown, isRequest: boolean): JsonRpcCall {\n    if (!isMinimalRequest(rawRequest)) {\n      throw rpcErrors.invalidRequest({\n        data: {\n          request: rawRequest,\n        },\n      });\n    }\n\n    const request: JsonRpcCall = {\n      jsonrpc,\n      method: rawRequest.method,\n    };\n\n    if (hasProperty(rawRequest, 'params')) {\n      request.params = rawRequest.params as JsonRpcParams;\n    }\n\n    if (isRequest) {\n      (request as JsonRpcRequest).id = getUniqueId();\n    }\n\n    return request;\n  }\n}\n\n/**\n * The most minimally conformant request object that we will accept.\n */\ntype MinimalRequest = {\n  method: string;\n  params?: JsonRpcParams;\n} & Record<string, unknown>;\n\n/**\n * Check if an unvalidated request is a minimal request.\n *\n * @param rawRequest - The raw request to check.\n * @returns `true` if the request is a {@link MinimalRequest}, `false` otherwise.\n */\nfunction isMinimalRequest(rawRequest: unknown): rawRequest is MinimalRequest {\n  return (\n    isObject(rawRequest) &&\n    hasProperty(rawRequest, 'method') &&\n    typeof rawRequest.method === 'string' &&\n    hasValidParams(rawRequest)\n  );\n}\n\n/**\n * Check if a request has valid params, i.e. an array or object.\n * The contents of the params are not inspected.\n *\n * @param rawRequest - The request to check.\n * @returns `true` if the request has valid params, `false` otherwise.\n */\nfunction hasValidParams(\n  rawRequest: Record<string, unknown>,\n): rawRequest is { params?: JsonRpcParams } {\n  if (hasProperty(rawRequest, 'params')) {\n    return Array.isArray(rawRequest.params) || isObject(rawRequest.params);\n  }\n\n  return true;\n}\n\n/**\n * Get the original id from a request.\n *\n * @param rawRequest - The request to get the original id from.\n * @returns The original id and a boolean indicating if the request is a request\n * (as opposed to a notification).\n */\nfunction getOriginalId(rawRequest: unknown): [unknown, boolean] {\n  if (isObject(rawRequest) && hasProperty(rawRequest, 'id')) {\n    return [rawRequest.id, true];\n  }\n\n  return [undefined, false];\n}\n"]}

package/dist/v2/MiddlewareContext.cjs

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiddlewareContext = void 0;
+/**
+ * An context object for middleware that attempts to protect against accidental
+ * modifications. Its interface is frozen.
+ *
+ * Map keys may not be directly overridden with {@link set}. Instead, use
+ * {@link delete} to remove a key and then {@link set} to add a new value.
+ *
+ * The override protections are circumvented when using e.g. `Reflect.set`, so
+ * don't do that.
+ *
+ * @template KeyValues - The type of the keys and values in the context.
+ * @example
+ * // By default, the context permits any PropertyKey as a key.
+ * const context = new MiddlewareContext();
+ * context.set('foo', 'bar');
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // undefined
+ * @example
+ * // By specifying an object type, the context permits only the keys of the object.
+ * type Context = MiddlewareContext<{ foo: string }>;
+ * const context = new Context([['foo', 'bar']]);
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // Type error
+ */
+class MiddlewareContext extends Map {
+    constructor(entries) {
+        super(entries);
+        Object.freeze(this);
+    }
+    get(key) {
+        return super.get(key);
+    }
+    /**
+     * Get a value from the context. Throws if the key is not found.
+     *
+     * @param key - The key to get the value for.
+     * @returns The value.
+     */
+    assertGet(key) {
+        if (!super.has(key)) {
+            throw new Error(`Context key "${String(key)}" not found`);
+        }
+        return super.get(key);
+    }
+    /**
+     * Set a value in the context. Throws if the key already exists.
+     * {@link delete} an existing key before setting it to a new value.
+     *
+     * @throws If the key already exists.
+     * @param key - The key to set the value for.
+     * @param value - The value to set.
+     * @returns The context.
+     */
+    set(key, value) {
+        if (super.has(key)) {
+            throw new Error(`MiddlewareContext key "${String(key)}" already exists`);
+        }
+        super.set(key, value);
+        return this;
+    }
+}
+exports.MiddlewareContext = MiddlewareContext;
+//# sourceMappingURL=MiddlewareContext.cjs.map

package/dist/v2/MiddlewareContext.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiddlewareContext.cjs","sourceRoot":"","sources":["../../src/v2/MiddlewareContext.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,iBAEX,SAAQ,GAAgD;IACxD,YACE,OAA0E;QAE1E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,GAAG,CAA4B,GAAM;QACnC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAA6B,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAA4B,GAAM;QACzC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;SAC3D;QACD,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAiB,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAA4B,GAAM,EAAE,KAAmB;QACxD,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;SAC1E;QACD,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA3CD,8CA2CC","sourcesContent":["import type { UnionToIntersection } from './utils';\n\n/**\n * An context object for middleware that attempts to protect against accidental\n * modifications. Its interface is frozen.\n *\n * Map keys may not be directly overridden with {@link set}. Instead, use\n * {@link delete} to remove a key and then {@link set} to add a new value.\n *\n * The override protections are circumvented when using e.g. `Reflect.set`, so\n * don't do that.\n *\n * @template KeyValues - The type of the keys and values in the context.\n * @example\n * // By default, the context permits any PropertyKey as a key.\n * const context = new MiddlewareContext();\n * context.set('foo', 'bar');\n * context.get('foo'); // 'bar'\n * context.get('fizz'); // undefined\n * @example\n * // By specifying an object type, the context permits only the keys of the object.\n * type Context = MiddlewareContext<{ foo: string }>;\n * const context = new Context([['foo', 'bar']]);\n * context.get('foo'); // 'bar'\n * context.get('fizz'); // Type error\n */\nexport class MiddlewareContext<\n  KeyValues extends Record<PropertyKey, unknown> = Record<PropertyKey, unknown>,\n> extends Map<keyof KeyValues, KeyValues[keyof KeyValues]> {\n  constructor(\n    entries?: Iterable<readonly [keyof KeyValues, KeyValues[keyof KeyValues]]>,\n  ) {\n    super(entries);\n    Object.freeze(this);\n  }\n\n  get<K extends keyof KeyValues>(key: K): KeyValues[K] | undefined {\n    return super.get(key) as KeyValues[K] | undefined;\n  }\n\n  /**\n   * Get a value from the context. Throws if the key is not found.\n   *\n   * @param key - The key to get the value for.\n   * @returns The value.\n   */\n  assertGet<K extends keyof KeyValues>(key: K): KeyValues[K] {\n    if (!super.has(key)) {\n      throw new Error(`Context key \"${String(key)}\" not found`);\n    }\n    return super.get(key) as KeyValues[K];\n  }\n\n  /**\n   * Set a value in the context. Throws if the key already exists.\n   * {@link delete} an existing key before setting it to a new value.\n   *\n   * @throws If the key already exists.\n   * @param key - The key to set the value for.\n   * @param value - The value to set.\n   * @returns The context.\n   */\n  set<K extends keyof KeyValues>(key: K, value: KeyValues[K]): this {\n    if (super.has(key)) {\n      throw new Error(`MiddlewareContext key \"${String(key)}\" already exists`);\n    }\n    super.set(key, value);\n    return this;\n  }\n}\n\n/**\n * Infer the KeyValues type from a {@link MiddlewareContext}.\n */\ntype InferKeyValues<T> = T extends MiddlewareContext<infer U> ? U : never;\n\n/**\n * Simplifies an object type by \"merging\" its properties.\n *\n * - Expands intersections into a single object type.\n * - Forces mapped/conditional results to resolve into a readable shape.\n * - No runtime effect; purely a type-level normalization.\n *\n * @example\n * type A = { a: string } & { b: number };\n * type B = Simplify<A>; // { a: string; b: number }\n */\ntype Simplify<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;\n\n/**\n * Rejects record types that contain any `never`-valued property.\n *\n * If any property of `T` resolves to `never`, the result is `never`; otherwise it returns `T` unchanged.\n * Useful as a guard to ensure computed/merged record types didn't collapse any fields to `never`.\n *\n * @example\n * type A = ExcludeNever<{ a: string; b: never }>; // never\n * type B = ExcludeNever<{ a: string; b: number }>; // { a: string; b: number }\n */\ntype ExcludeNever<T extends Record<PropertyKey, unknown>> = {\n  [K in keyof T]-?: [T[K]] extends [never] ? K : never;\n}[keyof T] extends never\n  ? T\n  : never;\n\n/**\n * Merge a union of {@link MiddlewareContext}s into a single {@link MiddlewareContext}\n * supertype.\n *\n * @param Contexts - The union of {@link MiddlewareContext}s to merge.\n * @returns The merged {@link MiddlewareContext} supertype.\n * @example\n * type A = MiddlewareContext<{ a: string }> | MiddlewareContext<{ b: number }>;\n * type B = MergeContexts<A>; // MiddlewareContext<{ a: string, b: number }>\n */\nexport type MergeContexts<Contexts extends ContextConstraint> =\n  ExcludeNever<\n    Simplify<UnionToIntersection<InferKeyValues<Contexts>>>\n  > extends never\n    ? never\n    : MiddlewareContext<\n        ExcludeNever<Simplify<UnionToIntersection<InferKeyValues<Contexts>>>>\n      >;\n\n// Non-polluting `any` constraint.\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ContextConstraint = MiddlewareContext<any>;\n\n/**\n * The empty context type, i.e. `MiddlewareContext<{}>`.\n */\n// The empty object type is literally an empty object in this context.\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type EmptyContext = MiddlewareContext<{}>;\n"]}

package/dist/v2/MiddlewareContext.d.cts

@@ -0,0 +1,95 @@
+import type { UnionToIntersection } from "./utils.cjs";
+/**
+ * An context object for middleware that attempts to protect against accidental
+ * modifications. Its interface is frozen.
+ *
+ * Map keys may not be directly overridden with {@link set}. Instead, use
+ * {@link delete} to remove a key and then {@link set} to add a new value.
+ *
+ * The override protections are circumvented when using e.g. `Reflect.set`, so
+ * don't do that.
+ *
+ * @template KeyValues - The type of the keys and values in the context.
+ * @example
+ * // By default, the context permits any PropertyKey as a key.
+ * const context = new MiddlewareContext();
+ * context.set('foo', 'bar');
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // undefined
+ * @example
+ * // By specifying an object type, the context permits only the keys of the object.
+ * type Context = MiddlewareContext<{ foo: string }>;
+ * const context = new Context([['foo', 'bar']]);
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // Type error
+ */
+export declare class MiddlewareContext<KeyValues extends Record<PropertyKey, unknown> = Record<PropertyKey, unknown>> extends Map<keyof KeyValues, KeyValues[keyof KeyValues]> {
+    constructor(entries?: Iterable<readonly [keyof KeyValues, KeyValues[keyof KeyValues]]>);
+    get<K extends keyof KeyValues>(key: K): KeyValues[K] | undefined;
+    /**
+     * Get a value from the context. Throws if the key is not found.
+     *
+     * @param key - The key to get the value for.
+     * @returns The value.
+     */
+    assertGet<K extends keyof KeyValues>(key: K): KeyValues[K];
+    /**
+     * Set a value in the context. Throws if the key already exists.
+     * {@link delete} an existing key before setting it to a new value.
+     *
+     * @throws If the key already exists.
+     * @param key - The key to set the value for.
+     * @param value - The value to set.
+     * @returns The context.
+     */
+    set<K extends keyof KeyValues>(key: K, value: KeyValues[K]): this;
+}
+/**
+ * Infer the KeyValues type from a {@link MiddlewareContext}.
+ */
+type InferKeyValues<T> = T extends MiddlewareContext<infer U> ? U : never;
+/**
+ * Simplifies an object type by "merging" its properties.
+ *
+ * - Expands intersections into a single object type.
+ * - Forces mapped/conditional results to resolve into a readable shape.
+ * - No runtime effect; purely a type-level normalization.
+ *
+ * @example
+ * type A = { a: string } & { b: number };
+ * type B = Simplify<A>; // { a: string; b: number }
+ */
+type Simplify<T> = T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+/**
+ * Rejects record types that contain any `never`-valued property.
+ *
+ * If any property of `T` resolves to `never`, the result is `never`; otherwise it returns `T` unchanged.
+ * Useful as a guard to ensure computed/merged record types didn't collapse any fields to `never`.
+ *
+ * @example
+ * type A = ExcludeNever<{ a: string; b: never }>; // never
+ * type B = ExcludeNever<{ a: string; b: number }>; // { a: string; b: number }
+ */
+type ExcludeNever<T extends Record<PropertyKey, unknown>> = {
+    [K in keyof T]-?: [T[K]] extends [never] ? K : never;
+}[keyof T] extends never ? T : never;
+/**
+ * Merge a union of {@link MiddlewareContext}s into a single {@link MiddlewareContext}
+ * supertype.
+ *
+ * @param Contexts - The union of {@link MiddlewareContext}s to merge.
+ * @returns The merged {@link MiddlewareContext} supertype.
+ * @example
+ * type A = MiddlewareContext<{ a: string }> | MiddlewareContext<{ b: number }>;
+ * type B = MergeContexts<A>; // MiddlewareContext<{ a: string, b: number }>
+ */
+export type MergeContexts<Contexts extends ContextConstraint> = ExcludeNever<Simplify<UnionToIntersection<InferKeyValues<Contexts>>>> extends never ? never : MiddlewareContext<ExcludeNever<Simplify<UnionToIntersection<InferKeyValues<Contexts>>>>>;
+export type ContextConstraint = MiddlewareContext<any>;
+/**
+ * The empty context type, i.e. `MiddlewareContext<{}>`.
+ */
+export type EmptyContext = MiddlewareContext<{}>;
+export {};
+//# sourceMappingURL=MiddlewareContext.d.cts.map

package/dist/v2/MiddlewareContext.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiddlewareContext.d.cts","sourceRoot":"","sources":["../../src/v2/MiddlewareContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAgB;AAEnD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,iBAAiB,CAC5B,SAAS,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAC7E,SAAQ,GAAG,CAAC,MAAM,SAAS,EAAE,SAAS,CAAC,MAAM,SAAS,CAAC,CAAC;gBAEtD,OAAO,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,SAAS,EAAE,SAAS,CAAC,MAAM,SAAS,CAAC,CAAC,CAAC;IAM5E,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS;IAIhE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAO1D;;;;;;;;OAQG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;CAOlE;AAED;;GAEG;AACH,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE1E;;;;;;;;;;GAUG;AACH,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,KAAK,CAAC;AAExE;;;;;;;;;GASG;AACH,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI;KACzD,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK;CACrD,CAAC,MAAM,CAAC,CAAC,SAAS,KAAK,GACpB,CAAC,GACD,KAAK,CAAC;AAEV;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,iBAAiB,IAC1D,YAAY,CACV,QAAQ,CAAC,mBAAmB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CACxD,SAAS,KAAK,GACX,KAAK,GACL,iBAAiB,CACf,YAAY,CAAC,QAAQ,CAAC,mBAAmB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CACtE,CAAC;AAIR,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;AAEvD;;GAEG;AAGH,MAAM,MAAM,YAAY,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC"}

package/dist/v2/MiddlewareContext.d.mts

@@ -0,0 +1,95 @@
+import type { UnionToIntersection } from "./utils.mjs";
+/**
+ * An context object for middleware that attempts to protect against accidental
+ * modifications. Its interface is frozen.
+ *
+ * Map keys may not be directly overridden with {@link set}. Instead, use
+ * {@link delete} to remove a key and then {@link set} to add a new value.
+ *
+ * The override protections are circumvented when using e.g. `Reflect.set`, so
+ * don't do that.
+ *
+ * @template KeyValues - The type of the keys and values in the context.
+ * @example
+ * // By default, the context permits any PropertyKey as a key.
+ * const context = new MiddlewareContext();
+ * context.set('foo', 'bar');
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // undefined
+ * @example
+ * // By specifying an object type, the context permits only the keys of the object.
+ * type Context = MiddlewareContext<{ foo: string }>;
+ * const context = new Context([['foo', 'bar']]);
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // Type error
+ */
+export declare class MiddlewareContext<KeyValues extends Record<PropertyKey, unknown> = Record<PropertyKey, unknown>> extends Map<keyof KeyValues, KeyValues[keyof KeyValues]> {
+    constructor(entries?: Iterable<readonly [keyof KeyValues, KeyValues[keyof KeyValues]]>);
+    get<K extends keyof KeyValues>(key: K): KeyValues[K] | undefined;
+    /**
+     * Get a value from the context. Throws if the key is not found.
+     *
+     * @param key - The key to get the value for.
+     * @returns The value.
+     */
+    assertGet<K extends keyof KeyValues>(key: K): KeyValues[K];
+    /**
+     * Set a value in the context. Throws if the key already exists.
+     * {@link delete} an existing key before setting it to a new value.
+     *
+     * @throws If the key already exists.
+     * @param key - The key to set the value for.
+     * @param value - The value to set.
+     * @returns The context.
+     */
+    set<K extends keyof KeyValues>(key: K, value: KeyValues[K]): this;
+}
+/**
+ * Infer the KeyValues type from a {@link MiddlewareContext}.
+ */
+type InferKeyValues<T> = T extends MiddlewareContext<infer U> ? U : never;
+/**
+ * Simplifies an object type by "merging" its properties.
+ *
+ * - Expands intersections into a single object type.
+ * - Forces mapped/conditional results to resolve into a readable shape.
+ * - No runtime effect; purely a type-level normalization.
+ *
+ * @example
+ * type A = { a: string } & { b: number };
+ * type B = Simplify<A>; // { a: string; b: number }
+ */
+type Simplify<T> = T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+/**
+ * Rejects record types that contain any `never`-valued property.
+ *
+ * If any property of `T` resolves to `never`, the result is `never`; otherwise it returns `T` unchanged.
+ * Useful as a guard to ensure computed/merged record types didn't collapse any fields to `never`.
+ *
+ * @example
+ * type A = ExcludeNever<{ a: string; b: never }>; // never
+ * type B = ExcludeNever<{ a: string; b: number }>; // { a: string; b: number }
+ */
+type ExcludeNever<T extends Record<PropertyKey, unknown>> = {
+    [K in keyof T]-?: [T[K]] extends [never] ? K : never;
+}[keyof T] extends never ? T : never;
+/**
+ * Merge a union of {@link MiddlewareContext}s into a single {@link MiddlewareContext}
+ * supertype.
+ *
+ * @param Contexts - The union of {@link MiddlewareContext}s to merge.
+ * @returns The merged {@link MiddlewareContext} supertype.
+ * @example
+ * type A = MiddlewareContext<{ a: string }> | MiddlewareContext<{ b: number }>;
+ * type B = MergeContexts<A>; // MiddlewareContext<{ a: string, b: number }>
+ */
+export type MergeContexts<Contexts extends ContextConstraint> = ExcludeNever<Simplify<UnionToIntersection<InferKeyValues<Contexts>>>> extends never ? never : MiddlewareContext<ExcludeNever<Simplify<UnionToIntersection<InferKeyValues<Contexts>>>>>;
+export type ContextConstraint = MiddlewareContext<any>;
+/**
+ * The empty context type, i.e. `MiddlewareContext<{}>`.
+ */
+export type EmptyContext = MiddlewareContext<{}>;
+export {};
+//# sourceMappingURL=MiddlewareContext.d.mts.map

package/dist/v2/MiddlewareContext.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiddlewareContext.d.mts","sourceRoot":"","sources":["../../src/v2/MiddlewareContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAgB;AAEnD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,iBAAiB,CAC5B,SAAS,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAC7E,SAAQ,GAAG,CAAC,MAAM,SAAS,EAAE,SAAS,CAAC,MAAM,SAAS,CAAC,CAAC;gBAEtD,OAAO,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,SAAS,EAAE,SAAS,CAAC,MAAM,SAAS,CAAC,CAAC,CAAC;IAM5E,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS;IAIhE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAO1D;;;;;;;;OAQG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;CAOlE;AAED;;GAEG;AACH,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE1E;;;;;;;;;;GAUG;AACH,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,KAAK,CAAC;AAExE;;;;;;;;;GASG;AACH,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI;KACzD,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK;CACrD,CAAC,MAAM,CAAC,CAAC,SAAS,KAAK,GACpB,CAAC,GACD,KAAK,CAAC;AAEV;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,iBAAiB,IAC1D,YAAY,CACV,QAAQ,CAAC,mBAAmB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CACxD,SAAS,KAAK,GACX,KAAK,GACL,iBAAiB,CACf,YAAY,CAAC,QAAQ,CAAC,mBAAmB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CACtE,CAAC;AAIR,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;AAEvD;;GAEG;AAGH,MAAM,MAAM,YAAY,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC"}

package/dist/v2/MiddlewareContext.mjs

@@ -0,0 +1,62 @@
+/**
+ * An context object for middleware that attempts to protect against accidental
+ * modifications. Its interface is frozen.
+ *
+ * Map keys may not be directly overridden with {@link set}. Instead, use
+ * {@link delete} to remove a key and then {@link set} to add a new value.
+ *
+ * The override protections are circumvented when using e.g. `Reflect.set`, so
+ * don't do that.
+ *
+ * @template KeyValues - The type of the keys and values in the context.
+ * @example
+ * // By default, the context permits any PropertyKey as a key.
+ * const context = new MiddlewareContext();
+ * context.set('foo', 'bar');
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // undefined
+ * @example
+ * // By specifying an object type, the context permits only the keys of the object.
+ * type Context = MiddlewareContext<{ foo: string }>;
+ * const context = new Context([['foo', 'bar']]);
+ * context.get('foo'); // 'bar'
+ * context.get('fizz'); // Type error
+ */
+export class MiddlewareContext extends Map {
+    constructor(entries) {
+        super(entries);
+        Object.freeze(this);
+    }
+    get(key) {
+        return super.get(key);
+    }
+    /**
+     * Get a value from the context. Throws if the key is not found.
+     *
+     * @param key - The key to get the value for.
+     * @returns The value.
+     */
+    assertGet(key) {
+        if (!super.has(key)) {
+            throw new Error(`Context key "${String(key)}" not found`);
+        }
+        return super.get(key);
+    }
+    /**
+     * Set a value in the context. Throws if the key already exists.
+     * {@link delete} an existing key before setting it to a new value.
+     *
+     * @throws If the key already exists.
+     * @param key - The key to set the value for.
+     * @param value - The value to set.
+     * @returns The context.
+     */
+    set(key, value) {
+        if (super.has(key)) {
+            throw new Error(`MiddlewareContext key "${String(key)}" already exists`);
+        }
+        super.set(key, value);
+        return this;
+    }
+}
+//# sourceMappingURL=MiddlewareContext.mjs.map

package/dist/v2/MiddlewareContext.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiddlewareContext.mjs","sourceRoot":"","sources":["../../src/v2/MiddlewareContext.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,iBAEX,SAAQ,GAAgD;IACxD,YACE,OAA0E;QAE1E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,GAAG,CAA4B,GAAM;QACnC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAA6B,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAA4B,GAAM;QACzC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,gBAAgB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;SAC3D;QACD,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAiB,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAA4B,GAAM,EAAE,KAAmB;QACxD,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;SAC1E;QACD,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["import type { UnionToIntersection } from './utils';\n\n/**\n * An context object for middleware that attempts to protect against accidental\n * modifications. Its interface is frozen.\n *\n * Map keys may not be directly overridden with {@link set}. Instead, use\n * {@link delete} to remove a key and then {@link set} to add a new value.\n *\n * The override protections are circumvented when using e.g. `Reflect.set`, so\n * don't do that.\n *\n * @template KeyValues - The type of the keys and values in the context.\n * @example\n * // By default, the context permits any PropertyKey as a key.\n * const context = new MiddlewareContext();\n * context.set('foo', 'bar');\n * context.get('foo'); // 'bar'\n * context.get('fizz'); // undefined\n * @example\n * // By specifying an object type, the context permits only the keys of the object.\n * type Context = MiddlewareContext<{ foo: string }>;\n * const context = new Context([['foo', 'bar']]);\n * context.get('foo'); // 'bar'\n * context.get('fizz'); // Type error\n */\nexport class MiddlewareContext<\n  KeyValues extends Record<PropertyKey, unknown> = Record<PropertyKey, unknown>,\n> extends Map<keyof KeyValues, KeyValues[keyof KeyValues]> {\n  constructor(\n    entries?: Iterable<readonly [keyof KeyValues, KeyValues[keyof KeyValues]]>,\n  ) {\n    super(entries);\n    Object.freeze(this);\n  }\n\n  get<K extends keyof KeyValues>(key: K): KeyValues[K] | undefined {\n    return super.get(key) as KeyValues[K] | undefined;\n  }\n\n  /**\n   * Get a value from the context. Throws if the key is not found.\n   *\n   * @param key - The key to get the value for.\n   * @returns The value.\n   */\n  assertGet<K extends keyof KeyValues>(key: K): KeyValues[K] {\n    if (!super.has(key)) {\n      throw new Error(`Context key \"${String(key)}\" not found`);\n    }\n    return super.get(key) as KeyValues[K];\n  }\n\n  /**\n   * Set a value in the context. Throws if the key already exists.\n   * {@link delete} an existing key before setting it to a new value.\n   *\n   * @throws If the key already exists.\n   * @param key - The key to set the value for.\n   * @param value - The value to set.\n   * @returns The context.\n   */\n  set<K extends keyof KeyValues>(key: K, value: KeyValues[K]): this {\n    if (super.has(key)) {\n      throw new Error(`MiddlewareContext key \"${String(key)}\" already exists`);\n    }\n    super.set(key, value);\n    return this;\n  }\n}\n\n/**\n * Infer the KeyValues type from a {@link MiddlewareContext}.\n */\ntype InferKeyValues<T> = T extends MiddlewareContext<infer U> ? U : never;\n\n/**\n * Simplifies an object type by \"merging\" its properties.\n *\n * - Expands intersections into a single object type.\n * - Forces mapped/conditional results to resolve into a readable shape.\n * - No runtime effect; purely a type-level normalization.\n *\n * @example\n * type A = { a: string } & { b: number };\n * type B = Simplify<A>; // { a: string; b: number }\n */\ntype Simplify<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;\n\n/**\n * Rejects record types that contain any `never`-valued property.\n *\n * If any property of `T` resolves to `never`, the result is `never`; otherwise it returns `T` unchanged.\n * Useful as a guard to ensure computed/merged record types didn't collapse any fields to `never`.\n *\n * @example\n * type A = ExcludeNever<{ a: string; b: never }>; // never\n * type B = ExcludeNever<{ a: string; b: number }>; // { a: string; b: number }\n */\ntype ExcludeNever<T extends Record<PropertyKey, unknown>> = {\n  [K in keyof T]-?: [T[K]] extends [never] ? K : never;\n}[keyof T] extends never\n  ? T\n  : never;\n\n/**\n * Merge a union of {@link MiddlewareContext}s into a single {@link MiddlewareContext}\n * supertype.\n *\n * @param Contexts - The union of {@link MiddlewareContext}s to merge.\n * @returns The merged {@link MiddlewareContext} supertype.\n * @example\n * type A = MiddlewareContext<{ a: string }> | MiddlewareContext<{ b: number }>;\n * type B = MergeContexts<A>; // MiddlewareContext<{ a: string, b: number }>\n */\nexport type MergeContexts<Contexts extends ContextConstraint> =\n  ExcludeNever<\n    Simplify<UnionToIntersection<InferKeyValues<Contexts>>>\n  > extends never\n    ? never\n    : MiddlewareContext<\n        ExcludeNever<Simplify<UnionToIntersection<InferKeyValues<Contexts>>>>\n      >;\n\n// Non-polluting `any` constraint.\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ContextConstraint = MiddlewareContext<any>;\n\n/**\n * The empty context type, i.e. `MiddlewareContext<{}>`.\n */\n// The empty object type is literally an empty object in this context.\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type EmptyContext = MiddlewareContext<{}>;\n"]}

package/dist/v2/asLegacyMiddleware.cjs

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asLegacyMiddleware = void 0;
+const compatibility_utils_1 = require("./compatibility-utils.cjs");
+const __1 = require("../index.cjs");
+/**
+ * Convert a {@link JsonRpcEngineV2} into a legacy middleware.
+ *
+ * @param engine - The engine to convert.
+ * @returns The legacy middleware.
+ */
+function asLegacyMiddleware(engine) {
+    const middleware = engine.asMiddleware();
+    return (0, __1.createAsyncMiddleware)(async (req, res, next) => {
+        const request = (0, compatibility_utils_1.fromLegacyRequest)(req);
+        const context = (0, compatibility_utils_1.makeContext)(req);
+        let modifiedRequest;
+        const result = await middleware({
+            request,
+            context,
+            next: (finalRequest) => {
+                modifiedRequest = finalRequest;
+                return Promise.resolve(undefined);
+            },
+        });
+        if (modifiedRequest !== undefined && modifiedRequest !== request) {
+            Object.assign(req, (0, compatibility_utils_1.deepClone)(modifiedRequest));
+        }
+        (0, compatibility_utils_1.propagateToRequest)(req, context);
+        if (result !== undefined) {
+            // Unclear why the `as unknown` is needed here, but the cast is safe.
+            res.result = (0, compatibility_utils_1.deepClone)(result);
+            return undefined;
+        }
+        return next();
+    });
+}
+exports.asLegacyMiddleware = asLegacyMiddleware;
+//# sourceMappingURL=asLegacyMiddleware.cjs.map

package/dist/v2/asLegacyMiddleware.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asLegacyMiddleware.cjs","sourceRoot":"","sources":["../../src/v2/asLegacyMiddleware.ts"],"names":[],"mappings":";;;AAEA,mEAK+B;AAE/B,oCAA2C;AAG3C;;;;;GAKG;AACH,SAAgB,kBAAkB,CAIhC,MAAgC;IAEhC,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;IACzC,OAAO,IAAA,yBAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACpD,MAAM,OAAO,GAAG,IAAA,uCAAiB,EAAC,GAAc,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,IAAA,iCAAW,EAAC,GAAG,CAAC,CAAC;QACjC,IAAI,eAAoC,CAAC;QAEzC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;YAC9B,OAAO;YACP,OAAO;YACP,IAAI,EAAE,CAAC,YAAY,EAAE,EAAE;gBACrB,eAAe,GAAG,YAAY,CAAC;gBAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,OAAO,EAAE;YAChE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAA,+BAAS,EAAC,eAAe,CAAC,CAAC,CAAC;SAChD;QACD,IAAA,wCAAkB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAEjC,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,qEAAqE;YACrE,GAAG,CAAC,MAAM,GAAG,IAAA,+BAAS,EAAC,MAAM,CAAyC,CAAC;YACvE,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAjCD,gDAiCC","sourcesContent":["import type { JsonRpcParams, JsonRpcRequest } from '@metamask/utils';\n\nimport {\n  deepClone,\n  fromLegacyRequest,\n  makeContext,\n  propagateToRequest,\n} from './compatibility-utils';\nimport type { JsonRpcEngineV2, ResultConstraint } from './JsonRpcEngineV2';\nimport { createAsyncMiddleware } from '..';\nimport type { JsonRpcMiddleware as LegacyMiddleware } from '..';\n\n/**\n * Convert a {@link JsonRpcEngineV2} into a legacy middleware.\n *\n * @param engine - The engine to convert.\n * @returns The legacy middleware.\n */\nexport function asLegacyMiddleware<\n  Params extends JsonRpcParams,\n  Request extends JsonRpcRequest<Params>,\n>(\n  engine: JsonRpcEngineV2<Request>,\n): LegacyMiddleware<Params, ResultConstraint<Request>> {\n  const middleware = engine.asMiddleware();\n  return createAsyncMiddleware(async (req, res, next) => {\n    const request = fromLegacyRequest(req as Request);\n    const context = makeContext(req);\n    let modifiedRequest: Request | undefined;\n\n    const result = await middleware({\n      request,\n      context,\n      next: (finalRequest) => {\n        modifiedRequest = finalRequest;\n        return Promise.resolve(undefined);\n      },\n    });\n\n    if (modifiedRequest !== undefined && modifiedRequest !== request) {\n      Object.assign(req, deepClone(modifiedRequest));\n    }\n    propagateToRequest(req, context);\n\n    if (result !== undefined) {\n      // Unclear why the `as unknown` is needed here, but the cast is safe.\n      res.result = deepClone(result) as unknown as ResultConstraint<Request>;\n      return undefined;\n    }\n    return next();\n  });\n}\n"]}

package/dist/v2/asLegacyMiddleware.d.cts

@@ -0,0 +1,11 @@
+import type { JsonRpcParams, JsonRpcRequest } from "@metamask/utils";
+import type { JsonRpcEngineV2, ResultConstraint } from "./JsonRpcEngineV2.cjs";
+import type { JsonRpcMiddleware as LegacyMiddleware } from "../index.cjs";
+/**
+ * Convert a {@link JsonRpcEngineV2} into a legacy middleware.
+ *
+ * @param engine - The engine to convert.
+ * @returns The legacy middleware.
+ */
+export declare function asLegacyMiddleware<Params extends JsonRpcParams, Request extends JsonRpcRequest<Params>>(engine: JsonRpcEngineV2<Request>): LegacyMiddleware<Params, ResultConstraint<Request>>;
+//# sourceMappingURL=asLegacyMiddleware.d.cts.map

package/dist/v2/asLegacyMiddleware.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asLegacyMiddleware.d.cts","sourceRoot":"","sources":["../../src/v2/asLegacyMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,wBAAwB;AAQrE,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,8BAA0B;AAE3E,OAAO,KAAK,EAAE,iBAAiB,IAAI,gBAAgB,EAAE,qBAAW;AAEhE;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,SAAS,aAAa,EAC5B,OAAO,SAAS,cAAc,CAAC,MAAM,CAAC,EAEtC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,GAC/B,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CA4BrD"}

package/dist/v2/asLegacyMiddleware.d.mts

@@ -0,0 +1,11 @@
+import type { JsonRpcParams, JsonRpcRequest } from "@metamask/utils";
+import type { JsonRpcEngineV2, ResultConstraint } from "./JsonRpcEngineV2.mjs";
+import type { JsonRpcMiddleware as LegacyMiddleware } from "../index.mjs";
+/**
+ * Convert a {@link JsonRpcEngineV2} into a legacy middleware.
+ *
+ * @param engine - The engine to convert.
+ * @returns The legacy middleware.
+ */
+export declare function asLegacyMiddleware<Params extends JsonRpcParams, Request extends JsonRpcRequest<Params>>(engine: JsonRpcEngineV2<Request>): LegacyMiddleware<Params, ResultConstraint<Request>>;
+//# sourceMappingURL=asLegacyMiddleware.d.mts.map

package/dist/v2/asLegacyMiddleware.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asLegacyMiddleware.d.mts","sourceRoot":"","sources":["../../src/v2/asLegacyMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,wBAAwB;AAQrE,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,8BAA0B;AAE3E,OAAO,KAAK,EAAE,iBAAiB,IAAI,gBAAgB,EAAE,qBAAW;AAEhE;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,SAAS,aAAa,EAC5B,OAAO,SAAS,cAAc,CAAC,MAAM,CAAC,EAEtC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,GAC/B,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CA4BrD"}