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

package/dist/v2/JsonRpcEngineV2.cjs

@@ -0,0 +1,213 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _JsonRpcEngineV2_instances, _JsonRpcEngineV2_middleware, _JsonRpcEngineV2_isDestroyed, _JsonRpcEngineV2_handle, _JsonRpcEngineV2_makeNextFactory, _JsonRpcEngineV2_makeMiddlewareIterator, _JsonRpcEngineV2_updateResult, _JsonRpcEngineV2_assertValidNextRequest, _JsonRpcEngineV2_assertIsNotDestroyed;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonRpcEngineV2 = void 0;
+const utils_1 = require("@metamask/utils");
+const deep_freeze_strict_1 = __importDefault(require("deep-freeze-strict"));
+const MiddlewareContext_1 = require("./MiddlewareContext.cjs");
+const utils_2 = require("./utils.cjs");
+const INVALID_ENGINE = Symbol('Invalid engine');
+/**
+ * A JSON-RPC request and response processor.
+ *
+ * Give it a stack of middleware, pass it requests, and get back responses.
+ *
+ * #### Requests vs. notifications
+ *
+ * JSON-RPC requests come in two flavors:
+ *
+ * - [Requests](https://www.jsonrpc.org/specification#request_object), i.e. request objects _with_ an `id`
+ * - [Notifications](https://www.jsonrpc.org/specification#notification), i.e. request objects _without_ an `id`
+ *
+ * For requests, one of the engine's middleware must "end" the request by returning a non-`undefined` result,
+ * or {@link handle} will throw an error:
+ *
+ * For notifications, on the other hand, one of the engine's middleware must return `undefined` to end the request,
+ * and any non-`undefined` return values will cause an error:
+ *
+ * @template Request - The type of request to handle.
+ * @template Result - The type of result to return.
+ *
+ * @example
+ * ```ts
+ * const engine = JsonRpcEngineV2.create({
+ *   middleware,
+ * });
+ *
+ * try {
+ *   const result = await engine.handle(request);
+ *   // Handle result
+ * } catch (error) {
+ *   // Handle error
+ * }
+ * ```
+ */
+class JsonRpcEngineV2 {
+    // See .create() for why this is private.
+    constructor({ middleware }) {
+        _JsonRpcEngineV2_instances.add(this);
+        _JsonRpcEngineV2_middleware.set(this, void 0);
+        _JsonRpcEngineV2_isDestroyed.set(this, false);
+        __classPrivateFieldSet(this, _JsonRpcEngineV2_middleware, [...middleware], "f");
+    }
+    // We use a static factory method in order to construct a supertype of all middleware contexts,
+    // which enables us to instantiate an engine despite different middleware expecting different
+    // context types.
+    /**
+     * Create a new JSON-RPC engine.
+     *
+     * @throws If the middleware array is empty.
+     * @param options - The options for the engine.
+     * @param options.middleware - The middleware to use.
+     * @returns The JSON-RPC engine.
+     */
+    static create({ middleware }) {
+        // We can't use NonEmptyArray for the params because it ruins type inference.
+        if (middleware.length === 0) {
+            throw new utils_2.JsonRpcEngineError('Middleware array cannot be empty');
+        }
+        const mw = middleware;
+        return new JsonRpcEngineV2({
+            middleware: mw,
+        });
+    }
+    async handle(request, { context } = {}) {
+        const isReq = (0, utils_2.isRequest)(request);
+        const { result } = await __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_handle).call(this, request, context);
+        if (isReq && result === undefined) {
+            throw new utils_2.JsonRpcEngineError(`Nothing ended request: ${(0, utils_2.stringify)(request)}`);
+        }
+        return result;
+    }
+    /**
+     * Convert the engine into a JSON-RPC middleware.
+     *
+     * @returns The JSON-RPC middleware.
+     */
+    asMiddleware() {
+        __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_assertIsNotDestroyed).call(this);
+        return async ({ request, context, next }) => {
+            const { result, request: finalRequest } = await __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_handle).call(this, request, context);
+            return result === undefined ? await next(finalRequest) : result;
+        };
+    }
+    /**
+     * Destroy the engine. Calls the `destroy()` method of any middleware that has
+     * one. Attempting to use the engine after destroying it will throw an error.
+     */
+    async destroy() {
+        if (__classPrivateFieldGet(this, _JsonRpcEngineV2_isDestroyed, "f")) {
+            return;
+        }
+        __classPrivateFieldSet(this, _JsonRpcEngineV2_isDestroyed, true, "f");
+        const destructionPromise = Promise.all(__classPrivateFieldGet(this, _JsonRpcEngineV2_middleware, "f").map(async (middleware) => {
+            if (
+            // Intentionally using `in` to walk the prototype chain.
+            'destroy' in middleware &&
+                typeof middleware.destroy === 'function') {
+                return middleware.destroy();
+            }
+            return undefined;
+        }));
+        __classPrivateFieldSet(this, _JsonRpcEngineV2_middleware, [], "f");
+        await destructionPromise;
+    }
+}
+exports.JsonRpcEngineV2 = JsonRpcEngineV2;
+_JsonRpcEngineV2_middleware = new WeakMap(), _JsonRpcEngineV2_isDestroyed = new WeakMap(), _JsonRpcEngineV2_instances = new WeakSet(), _JsonRpcEngineV2_handle = 
+/**
+ * Handle a JSON-RPC request. Throws if a middleware performs an invalid
+ * operation. Permits returning an `undefined` result.
+ *
+ * @param originalRequest - The JSON-RPC request to handle.
+ * @param context - The context to pass to the middleware.
+ * @returns The result from the middleware.
+ */
+async function _JsonRpcEngineV2_handle(originalRequest, context = new MiddlewareContext_1.MiddlewareContext()) {
+    __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_assertIsNotDestroyed).call(this);
+    (0, deep_freeze_strict_1.default)(originalRequest);
+    const state = {
+        request: originalRequest,
+        result: undefined,
+    };
+    const middlewareIterator = __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_makeMiddlewareIterator).call(this);
+    const firstMiddleware = middlewareIterator.next().value;
+    const makeNext = __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_makeNextFactory).call(this, middlewareIterator, state, context);
+    const result = await firstMiddleware({
+        request: originalRequest,
+        context,
+        next: makeNext(),
+    });
+    __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_updateResult).call(this, result, state);
+    return state;
+}, _JsonRpcEngineV2_makeNextFactory = function _JsonRpcEngineV2_makeNextFactory(middlewareIterator, state, context) {
+    const makeNext = () => {
+        let wasCalled = false;
+        const next = async (request = state.request) => {
+            if (wasCalled) {
+                throw new utils_2.JsonRpcEngineError(`Middleware attempted to call next() multiple times for request: ${(0, utils_2.stringify)(request)}`);
+            }
+            wasCalled = true;
+            if (request !== state.request) {
+                __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_assertValidNextRequest).call(this, state.request, request);
+                state.request = (0, deep_freeze_strict_1.default)(request);
+            }
+            const { value: nextMiddleware, done } = middlewareIterator.next();
+            if (done) {
+                // This will cause the last middleware to return `undefined`. See the class
+                // JSDoc or package README for more details.
+                return undefined;
+            }
+            const result = await nextMiddleware({
+                request,
+                context,
+                next: makeNext(),
+            });
+            __classPrivateFieldGet(this, _JsonRpcEngineV2_instances, "m", _JsonRpcEngineV2_updateResult).call(this, result, state);
+            return state.result;
+        };
+        return next;
+    };
+    return makeNext;
+}, _JsonRpcEngineV2_makeMiddlewareIterator = function _JsonRpcEngineV2_makeMiddlewareIterator() {
+    return __classPrivateFieldGet(this, _JsonRpcEngineV2_middleware, "f")[Symbol.iterator]();
+}, _JsonRpcEngineV2_updateResult = function _JsonRpcEngineV2_updateResult(result, state) {
+    if ((0, utils_2.isNotification)(state.request) && result !== undefined) {
+        throw new utils_2.JsonRpcEngineError(`Result returned for notification: ${(0, utils_2.stringify)(state.request)}`);
+    }
+    if (result !== undefined && result !== state.result) {
+        if (typeof result === 'object' && result !== null) {
+            (0, deep_freeze_strict_1.default)(result);
+        }
+        state.result = result;
+    }
+}, _JsonRpcEngineV2_assertValidNextRequest = function _JsonRpcEngineV2_assertValidNextRequest(currentRequest, nextRequest) {
+    if (nextRequest.jsonrpc !== currentRequest.jsonrpc) {
+        throw new utils_2.JsonRpcEngineError(`Middleware attempted to modify readonly property "jsonrpc" for request: ${(0, utils_2.stringify)(currentRequest)}`);
+    }
+    if ((0, utils_1.hasProperty)(nextRequest, 'id') !== (0, utils_1.hasProperty)(currentRequest, 'id') ||
+        // @ts-expect-error - "id" does not exist on notifications, but we can still
+        // check the value of the property at runtime.
+        nextRequest.id !== currentRequest.id) {
+        throw new utils_2.JsonRpcEngineError(`Middleware attempted to modify readonly property "id" for request: ${(0, utils_2.stringify)(currentRequest)}`);
+    }
+}, _JsonRpcEngineV2_assertIsNotDestroyed = function _JsonRpcEngineV2_assertIsNotDestroyed() {
+    if (__classPrivateFieldGet(this, _JsonRpcEngineV2_isDestroyed, "f")) {
+        throw new utils_2.JsonRpcEngineError('Engine is destroyed');
+    }
+};
+//# sourceMappingURL=JsonRpcEngineV2.cjs.map

package/dist/v2/JsonRpcEngineV2.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonRpcEngineV2.cjs","sourceRoot":"","sources":["../../src/v2/JsonRpcEngineV2.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAMyB;AACzB,4EAA4C;AAG5C,+DAAwD;AACxD,uCAKiB;AAmFjB,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAShD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,eAAe;IAY1B,yCAAyC;IACzC,YAAoB,EAAE,UAAU,EAAwC;;QATxE,8CAIE;QAEF,uCAAe,KAAK,EAAC;QAInB,uBAAA,IAAI,+BAAe,CAAC,GAAG,UAAU,CAAC,MAAA,CAAC;IACrC,CAAC;IAED,+FAA+F;IAC/F,6FAA6F;IAC7F,iBAAiB;IACjB;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CASX,EAAE,UAAU,EAAgC;QAC5C,6EAA6E;QAC7E,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,0BAAkB,CAAC,kCAAkC,CAAC,CAAC;SAClE;QAID,MAAM,EAAE,GAAG,UAMV,CAAC;QACF,OAAO,IAAI,eAAe,CAA8B;YACtD,UAAU,EAAE,EAAE;SACf,CAE+C,CAAC;IACnD,CAAC;IAqDD,KAAK,CAAC,MAAM,CACV,OAAgB,EAChB,EAAE,OAAO,KAA6B,EAAE;QAExC,MAAM,KAAK,GAAG,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC;QACjC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,uBAAA,IAAI,2DAAQ,MAAZ,IAAI,EAAS,OAAO,EAAE,OAAO,CAAC,CAAC;QAExD,IAAI,KAAK,IAAI,MAAM,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,0BAAkB,CAC1B,0BAA0B,IAAA,iBAAS,EAAC,OAAO,CAAC,EAAE,CAC/C,CAAC;SACH;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAyJD;;;;OAIG;IACH,YAAY;QAKV,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,CAAwB,CAAC;QAE7B,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;YAC1C,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,MAAM,uBAAA,IAAI,2DAAQ,MAAZ,IAAI,EAClD,OAAO,EACP,OAAO,CACR,CAAC;YACF,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAClE,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,uBAAA,IAAI,oCAAa,EAAE;YACrB,OAAO;SACR;QACD,uBAAA,IAAI,gCAAgB,IAAI,MAAA,CAAC;QAEzB,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CACpC,uBAAA,IAAI,mCAAY,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACxC;YACE,wDAAwD;YACxD,SAAS,IAAI,UAAU;gBACvB,OAAO,UAAU,CAAC,OAAO,KAAK,UAAU,EACxC;gBACA,OAAO,UAAU,CAAC,OAAO,EAAE,CAAC;aAC7B;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CACH,CAAC;QACF,uBAAA,IAAI,+BAAe,EAAW,MAAA,CAAC;QAC/B,MAAM,kBAAkB,CAAC;IAC3B,CAAC;CAOF;AAxUD,0CAwUC;;AA3MC;;;;;;;GAOG;AACH,KAAK,kCACH,eAAwB,EACxB,UAAmB,IAAI,qCAAiB,EAAa;IAErD,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,CAAwB,CAAC;IAE7B,IAAA,4BAAU,EAAC,eAAe,CAAC,CAAC;IAE5B,MAAM,KAAK,GAA0B;QACnC,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,SAAS;KAClB,CAAC;IACF,MAAM,kBAAkB,GAAG,uBAAA,IAAI,2EAAwB,MAA5B,IAAI,CAA0B,CAAC;IAC1D,MAAM,eAAe,GAAG,kBAAkB,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IAExD,MAAM,QAAQ,GAAG,uBAAA,IAAI,oEAAiB,MAArB,IAAI,EAAkB,kBAAkB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAE3E,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC;QACnC,OAAO,EAAE,eAAe;QACxB,OAAO;QACP,IAAI,EAAE,QAAQ,EAAE;KACjB,CAAC,CAAC;IACH,uBAAA,IAAI,iEAAc,MAAlB,IAAI,EAAe,MAAM,EAAE,KAAK,CAAC,CAAC;IAElC,OAAO,KAAK,CAAC;AACf,CAAC,+EAcC,kBAEC,EACD,KAA4B,EAC5B,OAAgB;IAEhB,MAAM,QAAQ,GAAG,GAAkB,EAAE;QACnC,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,MAAM,IAAI,GAAG,KAAK,EAChB,UAAmB,KAAK,CAAC,OAAO,EAC0B,EAAE;YAC5D,IAAI,SAAS,EAAE;gBACb,MAAM,IAAI,0BAAkB,CAC1B,mEAAmE,IAAA,iBAAS,EAAC,OAAO,CAAC,EAAE,CACxF,CAAC;aACH;YACD,SAAS,GAAG,IAAI,CAAC;YAEjB,IAAI,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE;gBAC7B,uBAAA,IAAI,2EAAwB,MAA5B,IAAI,EAAyB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACrD,KAAK,CAAC,OAAO,GAAG,IAAA,4BAAU,EAAC,OAAO,CAAC,CAAC;aACrC;YAED,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,EAAE,CAAC;YAClE,IAAI,IAAI,EAAE;gBACR,2EAA2E;gBAC3E,4CAA4C;gBAC5C,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC;gBAClC,OAAO;gBACP,OAAO;gBACP,IAAI,EAAE,QAAQ,EAAE;aACjB,CAAC,CAAC;YACH,uBAAA,IAAI,iEAAc,MAAlB,IAAI,EAAe,MAAM,EAAE,KAAK,CAAC,CAAC;YAElC,OAAO,KAAK,CAAC,MAAM,CAAC;QACtB,CAAC,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,QAAQ,CAAC;AAClB,CAAC;IAKC,OAAO,uBAAA,IAAI,mCAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC7C,CAAC,yEAUC,MAGQ,EACR,KAA4B;IAE5B,IAAI,IAAA,sBAAc,EAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,KAAK,SAAS,EAAE;QACzD,MAAM,IAAI,0BAAkB,CAC1B,qCAAqC,IAAA,iBAAS,EAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAChE,CAAC;KACH;IAED,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE;QACnD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE;YACjD,IAAA,4BAAU,EAAC,MAAM,CAAC,CAAC;SACpB;QACD,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;KACvB;AACH,CAAC,6FAQuB,cAAuB,EAAE,WAAoB;IACnE,IAAI,WAAW,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,EAAE;QAClD,MAAM,IAAI,0BAAkB,CAC1B,2EAA2E,IAAA,iBAAS,EAAC,cAAc,CAAC,EAAE,CACvG,CAAC;KACH;IACD,IACE,IAAA,mBAAW,EAAC,WAAW,EAAE,IAAI,CAAC,KAAK,IAAA,mBAAW,EAAC,cAAc,EAAE,IAAI,CAAC;QACpE,4EAA4E;QAC5E,8CAA8C;QAC9C,WAAW,CAAC,EAAE,KAAK,cAAc,CAAC,EAAE,EACpC;QACA,MAAM,IAAI,0BAAkB,CAC1B,sEAAsE,IAAA,iBAAS,EAAC,cAAc,CAAC,EAAE,CAClG,CAAC;KACH;AACH,CAAC;IAkDC,IAAI,uBAAA,IAAI,oCAAa,EAAE;QACrB,MAAM,IAAI,0BAAkB,CAAC,qBAAqB,CAAC,CAAC;KACrD;AACH,CAAC","sourcesContent":["import {\n  type Json,\n  type JsonRpcRequest,\n  type JsonRpcNotification,\n  type NonEmptyArray,\n  hasProperty,\n} from '@metamask/utils';\nimport deepFreeze from 'deep-freeze-strict';\n\nimport type { ContextConstraint, MergeContexts } from './MiddlewareContext';\nimport { MiddlewareContext } from './MiddlewareContext';\nimport {\n  isNotification,\n  isRequest,\n  JsonRpcEngineError,\n  stringify,\n} from './utils';\nimport type { JsonRpcCall } from './utils';\n\n// Helper to forbid `id` on notifications\ntype WithoutId<Request extends JsonRpcCall> = Request & { id?: never };\n\n// Helper to enable JsonRpcCall overload of handle()\ntype MixedParam<Request extends JsonRpcCall> = [\n  Extract<Request, JsonRpcRequest>,\n] extends [never]\n  ? never\n  : [Extract<Request, JsonRpcNotification>] extends [never]\n    ? never\n    :\n        | Extract<Request, JsonRpcRequest>\n        | WithoutId<Extract<Request, JsonRpcNotification>>;\n\nexport type ResultConstraint<Request extends JsonRpcCall> =\n  Request extends JsonRpcRequest ? Json : void;\n\nexport type Next<Request extends JsonRpcCall> = (\n  request?: Readonly<Request>,\n) => Promise<Readonly<ResultConstraint<Request>> | undefined>;\n\nexport type MiddlewareParams<\n  Request extends JsonRpcCall,\n  Context extends MiddlewareContext,\n> = {\n  request: Readonly<Request>;\n  context: Context;\n  next: Next<Request>;\n};\n\nexport type JsonRpcMiddleware<\n  Request extends JsonRpcCall = JsonRpcCall,\n  Result extends ResultConstraint<Request> = ResultConstraint<Request>,\n  Context extends ContextConstraint = MiddlewareContext,\n> = (\n  params: MiddlewareParams<Request, Context>,\n) => Readonly<Result> | undefined | Promise<Readonly<Result> | undefined>;\n\ntype RequestState<Request extends JsonRpcCall> = {\n  request: Request;\n  result: Readonly<ResultConstraint<Request>> | undefined;\n};\n\ntype HandleOptions<Context extends MiddlewareContext> = {\n  context?: Context;\n};\n\ntype ConstructorOptions<\n  Request extends JsonRpcCall,\n  Context extends MiddlewareContext,\n> = {\n  middleware: NonEmptyArray<\n    JsonRpcMiddleware<Request, ResultConstraint<Request>, Context>\n  >;\n};\n\ntype RequestOf<Middleware> =\n  Middleware extends JsonRpcMiddleware<\n    infer Request,\n    ResultConstraint<infer Request>,\n    // Non-polluting `any` constraint.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >\n    ? Request\n    : never;\n\ntype ContextOf<Middleware> =\n  // Non-polluting `any` constraint.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  Middleware extends JsonRpcMiddleware<any, ResultConstraint<any>, infer C>\n    ? C\n    : never;\n\ntype MergedContextOf<\n  // Non-polluting `any` constraint.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  Middleware extends JsonRpcMiddleware<any, any, any>,\n> = MergeContexts<ContextOf<Middleware>>;\n\nconst INVALID_ENGINE = Symbol('Invalid engine');\n\n/**\n * An internal type for invalid engines that explains why the engine is invalid.\n *\n * @template Message - The message explaining why the engine is invalid.\n */\ntype InvalidEngine<Message extends string> = { [INVALID_ENGINE]: Message };\n\n/**\n * A JSON-RPC request and response processor.\n *\n * Give it a stack of middleware, pass it requests, and get back responses.\n *\n * #### Requests vs. notifications\n *\n * JSON-RPC requests come in two flavors:\n *\n * - [Requests](https://www.jsonrpc.org/specification#request_object), i.e. request objects _with_ an `id`\n * - [Notifications](https://www.jsonrpc.org/specification#notification), i.e. request objects _without_ an `id`\n *\n * For requests, one of the engine's middleware must \"end\" the request by returning a non-`undefined` result,\n * or {@link handle} will throw an error:\n *\n * For notifications, on the other hand, one of the engine's middleware must return `undefined` to end the request,\n * and any non-`undefined` return values will cause an error:\n *\n * @template Request - The type of request to handle.\n * @template Result - The type of result to return.\n *\n * @example\n * ```ts\n * const engine = JsonRpcEngineV2.create({\n *   middleware,\n * });\n *\n * try {\n *   const result = await engine.handle(request);\n *   // Handle result\n * } catch (error) {\n *   // Handle error\n * }\n * ```\n */\nexport class JsonRpcEngineV2<\n  Request extends JsonRpcCall = JsonRpcCall,\n  Context extends ContextConstraint = MiddlewareContext,\n> {\n  #middleware: Readonly<\n    NonEmptyArray<\n      JsonRpcMiddleware<Request, ResultConstraint<Request>, Context>\n    >\n  >;\n\n  #isDestroyed = false;\n\n  // See .create() for why this is private.\n  private constructor({ middleware }: ConstructorOptions<Request, Context>) {\n    this.#middleware = [...middleware];\n  }\n\n  // We use a static factory method in order to construct a supertype of all middleware contexts,\n  // which enables us to instantiate an engine despite different middleware expecting different\n  // context types.\n  /**\n   * Create a new JSON-RPC engine.\n   *\n   * @throws If the middleware array is empty.\n   * @param options - The options for the engine.\n   * @param options.middleware - The middleware to use.\n   * @returns The JSON-RPC engine.\n   */\n  static create<\n    Middleware extends JsonRpcMiddleware<\n      // Non-polluting `any` constraint.\n      /* eslint-disable @typescript-eslint/no-explicit-any */\n      any,\n      ResultConstraint<any>,\n      any\n      /* eslint-enable @typescript-eslint/no-explicit-any */\n    > = JsonRpcMiddleware,\n  >({ middleware }: { middleware: Middleware[] }) {\n    // We can't use NonEmptyArray for the params because it ruins type inference.\n    if (middleware.length === 0) {\n      throw new JsonRpcEngineError('Middleware array cannot be empty');\n    }\n\n    type MergedContext = MergedContextOf<Middleware>;\n    type InputRequest = RequestOf<Middleware>;\n    const mw = middleware as unknown as NonEmptyArray<\n      JsonRpcMiddleware<\n        InputRequest,\n        ResultConstraint<InputRequest>,\n        MergedContext\n      >\n    >;\n    return new JsonRpcEngineV2<InputRequest, MergedContext>({\n      middleware: mw,\n    }) as MergedContext extends never\n      ? InvalidEngine<'Some middleware have incompatible context types'>\n      : JsonRpcEngineV2<InputRequest, MergedContext>;\n  }\n\n  /**\n   * Handle a JSON-RPC request.\n   *\n   * @param request - The JSON-RPC request to handle.\n   * @param options - The options for the handle operation.\n   * @param options.context - The context to pass to the middleware.\n   * @returns The JSON-RPC response.\n   */\n  async handle(\n    request: Extract<Request, JsonRpcRequest> extends never\n      ? never\n      : Extract<Request, JsonRpcRequest>,\n    options?: HandleOptions<Context>,\n  ): Promise<\n    Extract<Request, JsonRpcRequest> extends never\n      ? never\n      : ResultConstraint<Request>\n  >;\n\n  /**\n   * Handle a JSON-RPC notification. Notifications do not return a result.\n   *\n   * @param notification - The JSON-RPC notification to handle.\n   * @param options - The options for the handle operation.\n   * @param options.context - The context to pass to the middleware.\n   */\n  async handle(\n    notification: Extract<Request, JsonRpcNotification> extends never\n      ? never\n      : WithoutId<Extract<Request, JsonRpcNotification>>,\n    options?: HandleOptions<Context>,\n  ): Promise<\n    Extract<Request, JsonRpcNotification> extends never\n      ? never\n      : ResultConstraint<Request>\n  >;\n\n  /**\n   * Handle a JSON-RPC call, i.e. request or notification. Requests return a\n   * result, notifications do not.\n   *\n   * @param call - The JSON-RPC call to handle.\n   * @param options - The options for the handle operation.\n   * @param options.context - The context to pass to the middleware.\n   * @returns The JSON-RPC response, or `undefined` if the call is a notification.\n   */\n  async handle(\n    call: MixedParam<Request>,\n    options?: HandleOptions<Context>,\n  ): Promise<ResultConstraint<Request> | void>;\n\n  async handle(\n    request: Request,\n    { context }: HandleOptions<Context> = {},\n  ): Promise<Readonly<ResultConstraint<Request>> | void> {\n    const isReq = isRequest(request);\n    const { result } = await this.#handle(request, context);\n\n    if (isReq && result === undefined) {\n      throw new JsonRpcEngineError(\n        `Nothing ended request: ${stringify(request)}`,\n      );\n    }\n    return result;\n  }\n\n  /**\n   * Handle a JSON-RPC request. Throws if a middleware performs an invalid\n   * operation. Permits returning an `undefined` result.\n   *\n   * @param originalRequest - The JSON-RPC request to handle.\n   * @param context - The context to pass to the middleware.\n   * @returns The result from the middleware.\n   */\n  async #handle(\n    originalRequest: Request,\n    context: Context = new MiddlewareContext() as Context,\n  ): Promise<RequestState<Request>> {\n    this.#assertIsNotDestroyed();\n\n    deepFreeze(originalRequest);\n\n    const state: RequestState<Request> = {\n      request: originalRequest,\n      result: undefined,\n    };\n    const middlewareIterator = this.#makeMiddlewareIterator();\n    const firstMiddleware = middlewareIterator.next().value;\n\n    const makeNext = this.#makeNextFactory(middlewareIterator, state, context);\n\n    const result = await firstMiddleware({\n      request: originalRequest,\n      context,\n      next: makeNext(),\n    });\n    this.#updateResult(result, state);\n\n    return state;\n  }\n\n  /**\n   * Create a factory of `next()` functions for use with a particular request.\n   * The factory is recursive, and a new `next()` is created for each middleware\n   * invocation.\n   *\n   * @param middlewareIterator - The iterator of middleware for the current\n   * request.\n   * @param state - The current values of the request and result.\n   * @param context - The context to pass to the middleware.\n   * @returns The `next()` function factory.\n   */\n  #makeNextFactory(\n    middlewareIterator: Iterator<\n      JsonRpcMiddleware<Request, ResultConstraint<Request>, Context>\n    >,\n    state: RequestState<Request>,\n    context: Context,\n  ): () => Next<Request> {\n    const makeNext = (): Next<Request> => {\n      let wasCalled = false;\n\n      const next = async (\n        request: Request = state.request,\n      ): Promise<Readonly<ResultConstraint<Request>> | undefined> => {\n        if (wasCalled) {\n          throw new JsonRpcEngineError(\n            `Middleware attempted to call next() multiple times for request: ${stringify(request)}`,\n          );\n        }\n        wasCalled = true;\n\n        if (request !== state.request) {\n          this.#assertValidNextRequest(state.request, request);\n          state.request = deepFreeze(request);\n        }\n\n        const { value: nextMiddleware, done } = middlewareIterator.next();\n        if (done) {\n          // This will cause the last middleware to return `undefined`. See the class\n          // JSDoc or package README for more details.\n          return undefined;\n        }\n\n        const result = await nextMiddleware({\n          request,\n          context,\n          next: makeNext(),\n        });\n        this.#updateResult(result, state);\n\n        return state.result;\n      };\n      return next;\n    };\n\n    return makeNext;\n  }\n\n  #makeMiddlewareIterator(): Iterator<\n    JsonRpcMiddleware<Request, ResultConstraint<Request>, Context>\n  > {\n    return this.#middleware[Symbol.iterator]();\n  }\n\n  /**\n   * Validate the result from a middleware and, if it's a new value, update the\n   * current result.\n   *\n   * @param result - The result from the middleware.\n   * @param state - The current values of the request and result.\n   */\n  #updateResult(\n    result:\n      | Readonly<ResultConstraint<Request>>\n      | ResultConstraint<Request>\n      | void,\n    state: RequestState<Request>,\n  ): void {\n    if (isNotification(state.request) && result !== undefined) {\n      throw new JsonRpcEngineError(\n        `Result returned for notification: ${stringify(state.request)}`,\n      );\n    }\n\n    if (result !== undefined && result !== state.result) {\n      if (typeof result === 'object' && result !== null) {\n        deepFreeze(result);\n      }\n      state.result = result;\n    }\n  }\n\n  /**\n   * Assert that a request modified by a middleware is valid.\n   *\n   * @param currentRequest - The current request.\n   * @param nextRequest - The next request.\n   */\n  #assertValidNextRequest(currentRequest: Request, nextRequest: Request): void {\n    if (nextRequest.jsonrpc !== currentRequest.jsonrpc) {\n      throw new JsonRpcEngineError(\n        `Middleware attempted to modify readonly property \"jsonrpc\" for request: ${stringify(currentRequest)}`,\n      );\n    }\n    if (\n      hasProperty(nextRequest, 'id') !== hasProperty(currentRequest, 'id') ||\n      // @ts-expect-error - \"id\" does not exist on notifications, but we can still\n      // check the value of the property at runtime.\n      nextRequest.id !== currentRequest.id\n    ) {\n      throw new JsonRpcEngineError(\n        `Middleware attempted to modify readonly property \"id\" for request: ${stringify(currentRequest)}`,\n      );\n    }\n  }\n\n  /**\n   * Convert the engine into a JSON-RPC middleware.\n   *\n   * @returns The JSON-RPC middleware.\n   */\n  asMiddleware(): JsonRpcMiddleware<\n    Request,\n    ResultConstraint<Request>,\n    Context\n  > {\n    this.#assertIsNotDestroyed();\n\n    return async ({ request, context, next }) => {\n      const { result, request: finalRequest } = await this.#handle(\n        request,\n        context,\n      );\n      return result === undefined ? await next(finalRequest) : result;\n    };\n  }\n\n  /**\n   * Destroy the engine. Calls the `destroy()` method of any middleware that has\n   * one. Attempting to use the engine after destroying it will throw an error.\n   */\n  async destroy(): Promise<void> {\n    if (this.#isDestroyed) {\n      return;\n    }\n    this.#isDestroyed = true;\n\n    const destructionPromise = Promise.all(\n      this.#middleware.map(async (middleware) => {\n        if (\n          // Intentionally using `in` to walk the prototype chain.\n          'destroy' in middleware &&\n          typeof middleware.destroy === 'function'\n        ) {\n          return middleware.destroy();\n        }\n        return undefined;\n      }),\n    );\n    this.#middleware = [] as never;\n    await destructionPromise;\n  }\n\n  #assertIsNotDestroyed(): void {\n    if (this.#isDestroyed) {\n      throw new JsonRpcEngineError('Engine is destroyed');\n    }\n  }\n}\n"]}

package/dist/v2/JsonRpcEngineV2.d.cts

@@ -0,0 +1,122 @@
+import { type Json, type JsonRpcRequest, type JsonRpcNotification } from "@metamask/utils";
+import type { ContextConstraint, MergeContexts } from "./MiddlewareContext.cjs";
+import { MiddlewareContext } from "./MiddlewareContext.cjs";
+import type { JsonRpcCall } from "./utils.cjs";
+type WithoutId<Request extends JsonRpcCall> = Request & {
+    id?: never;
+};
+type MixedParam<Request extends JsonRpcCall> = [
+    Extract<Request, JsonRpcRequest>
+] extends [never] ? never : [Extract<Request, JsonRpcNotification>] extends [never] ? never : Extract<Request, JsonRpcRequest> | WithoutId<Extract<Request, JsonRpcNotification>>;
+export type ResultConstraint<Request extends JsonRpcCall> = Request extends JsonRpcRequest ? Json : void;
+export type Next<Request extends JsonRpcCall> = (request?: Readonly<Request>) => Promise<Readonly<ResultConstraint<Request>> | undefined>;
+export type MiddlewareParams<Request extends JsonRpcCall, Context extends MiddlewareContext> = {
+    request: Readonly<Request>;
+    context: Context;
+    next: Next<Request>;
+};
+export type JsonRpcMiddleware<Request extends JsonRpcCall = JsonRpcCall, Result extends ResultConstraint<Request> = ResultConstraint<Request>, Context extends ContextConstraint = MiddlewareContext> = (params: MiddlewareParams<Request, Context>) => Readonly<Result> | undefined | Promise<Readonly<Result> | undefined>;
+type HandleOptions<Context extends MiddlewareContext> = {
+    context?: Context;
+};
+type RequestOf<Middleware> = Middleware extends JsonRpcMiddleware<infer Request, ResultConstraint<infer Request>, any> ? Request : never;
+type ContextOf<Middleware> = Middleware extends JsonRpcMiddleware<any, ResultConstraint<any>, infer C> ? C : never;
+declare const INVALID_ENGINE: unique symbol;
+/**
+ * An internal type for invalid engines that explains why the engine is invalid.
+ *
+ * @template Message - The message explaining why the engine is invalid.
+ */
+type InvalidEngine<Message extends string> = {
+    [INVALID_ENGINE]: Message;
+};
+/**
+ * A JSON-RPC request and response processor.
+ *
+ * Give it a stack of middleware, pass it requests, and get back responses.
+ *
+ * #### Requests vs. notifications
+ *
+ * JSON-RPC requests come in two flavors:
+ *
+ * - [Requests](https://www.jsonrpc.org/specification#request_object), i.e. request objects _with_ an `id`
+ * - [Notifications](https://www.jsonrpc.org/specification#notification), i.e. request objects _without_ an `id`
+ *
+ * For requests, one of the engine's middleware must "end" the request by returning a non-`undefined` result,
+ * or {@link handle} will throw an error:
+ *
+ * For notifications, on the other hand, one of the engine's middleware must return `undefined` to end the request,
+ * and any non-`undefined` return values will cause an error:
+ *
+ * @template Request - The type of request to handle.
+ * @template Result - The type of result to return.
+ *
+ * @example
+ * ```ts
+ * const engine = JsonRpcEngineV2.create({
+ *   middleware,
+ * });
+ *
+ * try {
+ *   const result = await engine.handle(request);
+ *   // Handle result
+ * } catch (error) {
+ *   // Handle error
+ * }
+ * ```
+ */
+export declare class JsonRpcEngineV2<Request extends JsonRpcCall = JsonRpcCall, Context extends ContextConstraint = MiddlewareContext> {
+    #private;
+    private constructor();
+    /**
+     * Create a new JSON-RPC engine.
+     *
+     * @throws If the middleware array is empty.
+     * @param options - The options for the engine.
+     * @param options.middleware - The middleware to use.
+     * @returns The JSON-RPC engine.
+     */
+    static create<Middleware extends JsonRpcMiddleware<any, ResultConstraint<any>, any> = JsonRpcMiddleware>({ middleware }: {
+        middleware: Middleware[];
+    }): MergeContexts<ContextOf<Middleware>> extends never ? InvalidEngine<"Some middleware have incompatible context types"> : JsonRpcEngineV2<RequestOf<Middleware>, MergeContexts<ContextOf<Middleware>>>;
+    /**
+     * Handle a JSON-RPC request.
+     *
+     * @param request - The JSON-RPC request to handle.
+     * @param options - The options for the handle operation.
+     * @param options.context - The context to pass to the middleware.
+     * @returns The JSON-RPC response.
+     */
+    handle(request: Extract<Request, JsonRpcRequest> extends never ? never : Extract<Request, JsonRpcRequest>, options?: HandleOptions<Context>): Promise<Extract<Request, JsonRpcRequest> extends never ? never : ResultConstraint<Request>>;
+    /**
+     * Handle a JSON-RPC notification. Notifications do not return a result.
+     *
+     * @param notification - The JSON-RPC notification to handle.
+     * @param options - The options for the handle operation.
+     * @param options.context - The context to pass to the middleware.
+     */
+    handle(notification: Extract<Request, JsonRpcNotification> extends never ? never : WithoutId<Extract<Request, JsonRpcNotification>>, options?: HandleOptions<Context>): Promise<Extract<Request, JsonRpcNotification> extends never ? never : ResultConstraint<Request>>;
+    /**
+     * Handle a JSON-RPC call, i.e. request or notification. Requests return a
+     * result, notifications do not.
+     *
+     * @param call - The JSON-RPC call to handle.
+     * @param options - The options for the handle operation.
+     * @param options.context - The context to pass to the middleware.
+     * @returns The JSON-RPC response, or `undefined` if the call is a notification.
+     */
+    handle(call: MixedParam<Request>, options?: HandleOptions<Context>): Promise<ResultConstraint<Request> | void>;
+    /**
+     * Convert the engine into a JSON-RPC middleware.
+     *
+     * @returns The JSON-RPC middleware.
+     */
+    asMiddleware(): JsonRpcMiddleware<Request, ResultConstraint<Request>, Context>;
+    /**
+     * Destroy the engine. Calls the `destroy()` method of any middleware that has
+     * one. Attempting to use the engine after destroying it will throw an error.
+     */
+    destroy(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=JsonRpcEngineV2.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JsonRpcEngineV2.d.cts","sourceRoot":"","sources":["../../src/v2/JsonRpcEngineV2.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAGzB,wBAAwB;AAGzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,gCAA4B;AAC5E,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AAOxD,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAgB;AAG3C,KAAK,SAAS,CAAC,OAAO,SAAS,WAAW,IAAI,OAAO,GAAG;IAAE,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAGvE,KAAK,UAAU,CAAC,OAAO,SAAS,WAAW,IAAI;IAC7C,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC;CACjC,SAAS,CAAC,KAAK,CAAC,GACb,KAAK,GACL,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACrD,KAAK,GAED,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,GAChC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;AAE3D,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,WAAW,IACtD,OAAO,SAAS,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/C,MAAM,MAAM,IAAI,CAAC,OAAO,SAAS,WAAW,IAAI,CAC9C,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,KACxB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;AAE9D,MAAM,MAAM,gBAAgB,CAC1B,OAAO,SAAS,WAAW,EAC3B,OAAO,SAAS,iBAAiB,IAC/B;IACF,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,WAAW,GAAG,WAAW,EACzC,MAAM,SAAS,gBAAgB,CAAC,OAAO,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,EACpE,OAAO,SAAS,iBAAiB,GAAG,iBAAiB,IACnD,CACF,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,KACvC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC;AAO1E,KAAK,aAAa,CAAC,OAAO,SAAS,iBAAiB,IAAI;IACtD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAWF,KAAK,SAAS,CAAC,UAAU,IACvB,UAAU,SAAS,iBAAiB,CAClC,MAAM,OAAO,EACb,gBAAgB,CAAC,MAAM,OAAO,CAAC,EAG/B,GAAG,CACJ,GACG,OAAO,GACP,KAAK,CAAC;AAEZ,KAAK,SAAS,CAAC,UAAU,IAGvB,UAAU,SAAS,iBAAiB,CAAC,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,GACrE,CAAC,GACD,KAAK,CAAC;AAQZ,QAAA,MAAM,cAAc,eAA2B,CAAC;AAEhD;;;;GAIG;AACH,KAAK,aAAa,CAAC,OAAO,SAAS,MAAM,IAAI;IAAE,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,eAAe,CAC1B,OAAO,SAAS,WAAW,GAAG,WAAW,EACzC,OAAO,SAAS,iBAAiB,GAAG,iBAAiB;;IAWrD,OAAO;IAOP;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CACX,UAAU,SAAS,iBAAiB,CAGlC,GAAG,EACH,gBAAgB,CAAC,GAAG,CAAC,EACrB,GAAG,CAEJ,GAAG,iBAAiB,EACrB,EAAE,UAAU,EAAE,EAAE;QAAE,UAAU,EAAE,UAAU,EAAE,CAAA;KAAE;IAsB9C;;;;;;;OAOG;IACG,MAAM,CACV,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,SAAS,KAAK,GACnD,KAAK,GACL,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAC/B,OAAO,CACR,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,SAAS,KAAK,GAC1C,KAAK,GACL,gBAAgB,CAAC,OAAO,CAAC,CAC9B;IAED;;;;;;OAMG;IACG,MAAM,CACV,YAAY,EAAE,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,SAAS,KAAK,GAC7D,KAAK,GACL,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,EACpD,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAC/B,OAAO,CACR,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,SAAS,KAAK,GAC/C,KAAK,GACL,gBAAgB,CAAC,OAAO,CAAC,CAC9B;IAED;;;;;;;;OAQG;IACG,MAAM,CACV,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,EACzB,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAwK5C;;;;OAIG;IACH,YAAY,IAAI,iBAAiB,CAC/B,OAAO,EACP,gBAAgB,CAAC,OAAO,CAAC,EACzB,OAAO,CACR;IAYD;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CA2B/B"}

package/dist/v2/JsonRpcEngineV2.d.mts

@@ -0,0 +1,122 @@
+import { type Json, type JsonRpcRequest, type JsonRpcNotification } from "@metamask/utils";
+import type { ContextConstraint, MergeContexts } from "./MiddlewareContext.mjs";
+import { MiddlewareContext } from "./MiddlewareContext.mjs";
+import type { JsonRpcCall } from "./utils.mjs";
+type WithoutId<Request extends JsonRpcCall> = Request & {
+    id?: never;
+};
+type MixedParam<Request extends JsonRpcCall> = [
+    Extract<Request, JsonRpcRequest>
+] extends [never] ? never : [Extract<Request, JsonRpcNotification>] extends [never] ? never : Extract<Request, JsonRpcRequest> | WithoutId<Extract<Request, JsonRpcNotification>>;
+export type ResultConstraint<Request extends JsonRpcCall> = Request extends JsonRpcRequest ? Json : void;
+export type Next<Request extends JsonRpcCall> = (request?: Readonly<Request>) => Promise<Readonly<ResultConstraint<Request>> | undefined>;
+export type MiddlewareParams<Request extends JsonRpcCall, Context extends MiddlewareContext> = {
+    request: Readonly<Request>;
+    context: Context;
+    next: Next<Request>;
+};
+export type JsonRpcMiddleware<Request extends JsonRpcCall = JsonRpcCall, Result extends ResultConstraint<Request> = ResultConstraint<Request>, Context extends ContextConstraint = MiddlewareContext> = (params: MiddlewareParams<Request, Context>) => Readonly<Result> | undefined | Promise<Readonly<Result> | undefined>;
+type HandleOptions<Context extends MiddlewareContext> = {
+    context?: Context;
+};
+type RequestOf<Middleware> = Middleware extends JsonRpcMiddleware<infer Request, ResultConstraint<infer Request>, any> ? Request : never;
+type ContextOf<Middleware> = Middleware extends JsonRpcMiddleware<any, ResultConstraint<any>, infer C> ? C : never;
+declare const INVALID_ENGINE: unique symbol;
+/**
+ * An internal type for invalid engines that explains why the engine is invalid.
+ *
+ * @template Message - The message explaining why the engine is invalid.
+ */
+type InvalidEngine<Message extends string> = {
+    [INVALID_ENGINE]: Message;
+};
+/**
+ * A JSON-RPC request and response processor.
+ *
+ * Give it a stack of middleware, pass it requests, and get back responses.
+ *
+ * #### Requests vs. notifications
+ *
+ * JSON-RPC requests come in two flavors:
+ *
+ * - [Requests](https://www.jsonrpc.org/specification#request_object), i.e. request objects _with_ an `id`
+ * - [Notifications](https://www.jsonrpc.org/specification#notification), i.e. request objects _without_ an `id`
+ *
+ * For requests, one of the engine's middleware must "end" the request by returning a non-`undefined` result,
+ * or {@link handle} will throw an error:
+ *
+ * For notifications, on the other hand, one of the engine's middleware must return `undefined` to end the request,
+ * and any non-`undefined` return values will cause an error:
+ *
+ * @template Request - The type of request to handle.
+ * @template Result - The type of result to return.
+ *
+ * @example
+ * ```ts
+ * const engine = JsonRpcEngineV2.create({
+ *   middleware,
+ * });
+ *
+ * try {
+ *   const result = await engine.handle(request);
+ *   // Handle result
+ * } catch (error) {
+ *   // Handle error
+ * }
+ * ```
+ */
+export declare class JsonRpcEngineV2<Request extends JsonRpcCall = JsonRpcCall, Context extends ContextConstraint = MiddlewareContext> {
+    #private;
+    private constructor();
+    /**
+     * Create a new JSON-RPC engine.
+     *
+     * @throws If the middleware array is empty.
+     * @param options - The options for the engine.
+     * @param options.middleware - The middleware to use.
+     * @returns The JSON-RPC engine.
+     */
+    static create<Middleware extends JsonRpcMiddleware<any, ResultConstraint<any>, any> = JsonRpcMiddleware>({ middleware }: {
+        middleware: Middleware[];
+    }): MergeContexts<ContextOf<Middleware>> extends never ? InvalidEngine<"Some middleware have incompatible context types"> : JsonRpcEngineV2<RequestOf<Middleware>, MergeContexts<ContextOf<Middleware>>>;
+    /**
+     * Handle a JSON-RPC request.
+     *
+     * @param request - The JSON-RPC request to handle.
+     * @param options - The options for the handle operation.
+     * @param options.context - The context to pass to the middleware.
+     * @returns The JSON-RPC response.
+     */
+    handle(request: Extract<Request, JsonRpcRequest> extends never ? never : Extract<Request, JsonRpcRequest>, options?: HandleOptions<Context>): Promise<Extract<Request, JsonRpcRequest> extends never ? never : ResultConstraint<Request>>;
+    /**
+     * Handle a JSON-RPC notification. Notifications do not return a result.
+     *
+     * @param notification - The JSON-RPC notification to handle.
+     * @param options - The options for the handle operation.
+     * @param options.context - The context to pass to the middleware.
+     */
+    handle(notification: Extract<Request, JsonRpcNotification> extends never ? never : WithoutId<Extract<Request, JsonRpcNotification>>, options?: HandleOptions<Context>): Promise<Extract<Request, JsonRpcNotification> extends never ? never : ResultConstraint<Request>>;
+    /**
+     * Handle a JSON-RPC call, i.e. request or notification. Requests return a
+     * result, notifications do not.
+     *
+     * @param call - The JSON-RPC call to handle.
+     * @param options - The options for the handle operation.
+     * @param options.context - The context to pass to the middleware.
+     * @returns The JSON-RPC response, or `undefined` if the call is a notification.
+     */
+    handle(call: MixedParam<Request>, options?: HandleOptions<Context>): Promise<ResultConstraint<Request> | void>;
+    /**
+     * Convert the engine into a JSON-RPC middleware.
+     *
+     * @returns The JSON-RPC middleware.
+     */
+    asMiddleware(): JsonRpcMiddleware<Request, ResultConstraint<Request>, Context>;
+    /**
+     * Destroy the engine. Calls the `destroy()` method of any middleware that has
+     * one. Attempting to use the engine after destroying it will throw an error.
+     */
+    destroy(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=JsonRpcEngineV2.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JsonRpcEngineV2.d.mts","sourceRoot":"","sources":["../../src/v2/JsonRpcEngineV2.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAGzB,wBAAwB;AAGzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,gCAA4B;AAC5E,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AAOxD,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAgB;AAG3C,KAAK,SAAS,CAAC,OAAO,SAAS,WAAW,IAAI,OAAO,GAAG;IAAE,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAGvE,KAAK,UAAU,CAAC,OAAO,SAAS,WAAW,IAAI;IAC7C,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC;CACjC,SAAS,CAAC,KAAK,CAAC,GACb,KAAK,GACL,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACrD,KAAK,GAED,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,GAChC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;AAE3D,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,WAAW,IACtD,OAAO,SAAS,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/C,MAAM,MAAM,IAAI,CAAC,OAAO,SAAS,WAAW,IAAI,CAC9C,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,KACxB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;AAE9D,MAAM,MAAM,gBAAgB,CAC1B,OAAO,SAAS,WAAW,EAC3B,OAAO,SAAS,iBAAiB,IAC/B;IACF,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,WAAW,GAAG,WAAW,EACzC,MAAM,SAAS,gBAAgB,CAAC,OAAO,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,EACpE,OAAO,SAAS,iBAAiB,GAAG,iBAAiB,IACnD,CACF,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,KACvC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC;AAO1E,KAAK,aAAa,CAAC,OAAO,SAAS,iBAAiB,IAAI;IACtD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAWF,KAAK,SAAS,CAAC,UAAU,IACvB,UAAU,SAAS,iBAAiB,CAClC,MAAM,OAAO,EACb,gBAAgB,CAAC,MAAM,OAAO,CAAC,EAG/B,GAAG,CACJ,GACG,OAAO,GACP,KAAK,CAAC;AAEZ,KAAK,SAAS,CAAC,UAAU,IAGvB,UAAU,SAAS,iBAAiB,CAAC,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,GACrE,CAAC,GACD,KAAK,CAAC;AAQZ,QAAA,MAAM,cAAc,eAA2B,CAAC;AAEhD;;;;GAIG;AACH,KAAK,aAAa,CAAC,OAAO,SAAS,MAAM,IAAI;IAAE,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,eAAe,CAC1B,OAAO,SAAS,WAAW,GAAG,WAAW,EACzC,OAAO,SAAS,iBAAiB,GAAG,iBAAiB;;IAWrD,OAAO;IAOP;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CACX,UAAU,SAAS,iBAAiB,CAGlC,GAAG,EACH,gBAAgB,CAAC,GAAG,CAAC,EACrB,GAAG,CAEJ,GAAG,iBAAiB,EACrB,EAAE,UAAU,EAAE,EAAE;QAAE,UAAU,EAAE,UAAU,EAAE,CAAA;KAAE;IAsB9C;;;;;;;OAOG;IACG,MAAM,CACV,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,SAAS,KAAK,GACnD,KAAK,GACL,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAC/B,OAAO,CACR,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,SAAS,KAAK,GAC1C,KAAK,GACL,gBAAgB,CAAC,OAAO,CAAC,CAC9B;IAED;;;;;;OAMG;IACG,MAAM,CACV,YAAY,EAAE,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,SAAS,KAAK,GAC7D,KAAK,GACL,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,EACpD,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAC/B,OAAO,CACR,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,SAAS,KAAK,GAC/C,KAAK,GACL,gBAAgB,CAAC,OAAO,CAAC,CAC9B;IAED;;;;;;;;OAQG;IACG,MAAM,CACV,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,EACzB,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAwK5C;;;;OAIG;IACH,YAAY,IAAI,iBAAiB,CAC/B,OAAO,EACP,gBAAgB,CAAC,OAAO,CAAC,EACzB,OAAO,CACR;IAYD;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CA2B/B"}