@metamask-previews/json-rpc-middleware-stream 8.0.8-preview-8bfa290fb → 9.0.0-preview-0a30e47

package/CHANGELOG.md

@@ -7,10 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [9.0.0]
+
 ### Changed
 
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
 - Bump `@metamask/utils` from `^11.8.1` to `^11.12.0` ([#7511](https://github.com/MetaMask/core/pull/7511), [#9074](https://github.com/MetaMask/core/pull/9074), [#10076](https://github.com/MetaMask/core/pull/10076))
-- Bump `@metamask/json-rpc-engine` from `^10.1.1` to `^10.5.0` ([#7202](https://github.com/MetaMask/core/pull/7202), [#7642](https://github.com/MetaMask/core/pull/7642), [#7856](https://github.com/MetaMask/core/pull/7856), [#8078](https://github.com/MetaMask/core/pull/8078), [#8317](https://github.com/MetaMask/core/pull/8317), [#8661](https://github.com/MetaMask/core/pull/8661), [#8746](https://github.com/MetaMask/core/pull/8746), [#8753](https://github.com/MetaMask/core/pull/8753))
+- Bump `@metamask/json-rpc-engine` from `^10.1.1` to `^11.0.0` ([#7202](https://github.com/MetaMask/core/pull/7202), [#7642](https://github.com/MetaMask/core/pull/7642), [#7856](https://github.com/MetaMask/core/pull/7856), [#8078](https://github.com/MetaMask/core/pull/8078), [#8317](https://github.com/MetaMask/core/pull/8317), [#8661](https://github.com/MetaMask/core/pull/8661), [#8746](https://github.com/MetaMask/core/pull/8746), [#8753](https://github.com/MetaMask/core/pull/8753), [#10160](https://github.com/MetaMask/core/pull/10160))
 
 ## [8.0.8]
 
@@ -61,7 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ["Are the Types Wrong?"](https://arethetypeswrong.github.io/) tool as
     ["masquerading as CJS"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md).
     All of the ATTW checks now pass.
-- Remove chunk files ([#4648](https://github.com/MetaMask/core/pull/4648)).
+- Remove chunk files. ([#4648](https://github.com/MetaMask/core/pull/4648))
   - Previously, the build tool we used to generate JavaScript files extracted
     common code to "chunk" files. While this was intended to make this package
     more tree-shakeable, it also made debugging more difficult for our
@@ -209,7 +216,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - TypeScript typings ([#11](https://github.com/MetaMask/json-rpc-middleware-stream/pull/11))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/json-rpc-middleware-stream@8.0.8...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/json-rpc-middleware-stream@9.0.0...HEAD
+[9.0.0]: https://github.com/MetaMask/core/compare/@metamask/json-rpc-middleware-stream@8.0.8...@metamask/json-rpc-middleware-stream@9.0.0
 [8.0.8]: https://github.com/MetaMask/core/compare/@metamask/json-rpc-middleware-stream@8.0.7...@metamask/json-rpc-middleware-stream@8.0.8
 [8.0.7]: https://github.com/MetaMask/core/compare/@metamask/json-rpc-middleware-stream@8.0.6...@metamask/json-rpc-middleware-stream@8.0.7
 [8.0.6]: https://github.com/MetaMask/core/compare/@metamask/json-rpc-middleware-stream@8.0.5...@metamask/json-rpc-middleware-stream@8.0.6

package/dist/{createEngineStream.d.mts → createEngineStream.d.ts}

@@ -1,5 +1,5 @@
-import type { JsonRpcEngine } from "@metamask/json-rpc-engine";
-import { Duplex } from "readable-stream";
+import type { JsonRpcEngine } from '@metamask/json-rpc-engine';
+import { Duplex } from 'readable-stream';
 type EngineStreamOptions = {
     engine: JsonRpcEngine;
 };
@@ -12,4 +12,4 @@ type EngineStreamOptions = {
  */
 export default function createEngineStream(opts: EngineStreamOptions): Duplex;
 export {};
-//# sourceMappingURL=createEngineStream.d.mts.map
+//# sourceMappingURL=createEngineStream.d.ts.map

package/dist/createEngineStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEngineStream.d.ts","sourceRoot":"","sources":["../src/createEngineStream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,KAAK,mBAAmB,GAAG;IACzB,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAoC5E"}

package/dist/{createEngineStream.mjs → createEngineStream.js}

@@ -1,4 +1,4 @@
-import { Duplex } from "readable-stream";
+import { Duplex } from 'readable-stream';
 /**
  * Takes a JsonRpcEngine and returns a Duplex stream wrapping it.
  *
@@ -37,4 +37,4 @@ export default function createEngineStream(opts) {
         streamWriteCallback();
     }
 }
-//# sourceMappingURL=createEngineStream.mjs.map
+//# sourceMappingURL=createEngineStream.js.map

package/dist/createEngineStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEngineStream.js","sourceRoot":"","sources":["../src/createEngineStream.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAMzC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAyB;IAClE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,GAAc,EAAE,CAAC,SAAS;QAChC,KAAK;KACN,CAAC,CAAC;IACH,wBAAwB;IACxB,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACd,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,KAAK,CACZ,GAAmB,EACnB,SAAkB,EAClB,mBAAmD;QAEnD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,mBAAmB,EAAE,CAAC;IACxB,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { Duplex } from 'readable-stream';\n\ntype EngineStreamOptions = {\n  engine: JsonRpcEngine;\n};\n\n/**\n * Takes a JsonRpcEngine and returns a Duplex stream wrapping it.\n *\n * @param opts - Options bag.\n * @param opts.engine - The JsonRpcEngine to wrap in a stream.\n * @returns The stream wrapping the engine.\n */\nexport default function createEngineStream(opts: EngineStreamOptions): Duplex {\n  if (!opts?.engine) {\n    throw new Error('Missing engine parameter!');\n  }\n\n  const { engine } = opts;\n  const stream = new Duplex({\n    objectMode: true,\n    read: (): undefined => undefined,\n    write,\n  });\n  // forward notifications\n  if (engine.on) {\n    engine.on('notification', (message) => {\n      stream.push(message);\n    });\n  }\n  return stream;\n\n  /**\n   * Write a JSON-RPC request to the stream.\n   *\n   * @param req - The JSON-rpc request.\n   * @param _encoding - The stream encoding, not used.\n   * @param streamWriteCallback - The stream write callback.\n   */\n  function write(\n    req: JsonRpcRequest,\n    _encoding: unknown,\n    streamWriteCallback: (error?: Error | null) => void,\n  ): void {\n    engine.handle(req, (_err, res) => {\n      stream.push(res);\n    });\n    streamWriteCallback();\n  }\n}\n"]}

package/dist/{createStreamMiddleware.d.cts → createStreamMiddleware.d.ts}

@@ -1,7 +1,6 @@
-/// <reference types="readable-stream" />
-import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
-import SafeEventEmitter from "@metamask/safe-event-emitter";
-import type { JsonRpcParams } from "@metamask/utils";
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import SafeEventEmitter from '@metamask/safe-event-emitter';
+import type { JsonRpcParams } from '@metamask/utils';
 type Options = {
     retryOnMessage?: string;
 };
@@ -20,4 +19,4 @@ export default function createStreamMiddleware(options?: Options): {
     stream: _Readable.Duplex;
 };
 export {};
-//# sourceMappingURL=createStreamMiddleware.d.cts.map
+//# sourceMappingURL=createStreamMiddleware.d.ts.map

package/dist/createStreamMiddleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createStreamMiddleware.d.ts","sourceRoot":"","sources":["../src/createStreamMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AACnC,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAE5D,OAAO,KAAK,EAEV,aAAa,EAGd,MAAM,iBAAiB,CAAC;AAezB,KAAK,OAAO,GAAG;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,OAAO,GAAE,OAAY,GAAG;IACrE,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,EAAE,iBAAiB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAC5D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;CAC1B,CAyHA"}

package/dist/{createStreamMiddleware.mjs → createStreamMiddleware.js}

@@ -1,6 +1,6 @@
-import SafeEventEmitter from "@metamask/safe-event-emitter";
-import { hasProperty } from "@metamask/utils";
-import { Duplex } from "readable-stream";
+import SafeEventEmitter from '@metamask/safe-event-emitter';
+import { hasProperty } from '@metamask/utils';
+import { Duplex } from 'readable-stream';
 /**
  * Creates a JsonRpcEngine middleware with an associated Duplex stream and
  * EventEmitter. The middleware, and by extension stream, assume that middleware
@@ -112,4 +112,4 @@ export default function createStreamMiddleware(options = {}) {
         });
     }
 }
-//# sourceMappingURL=createStreamMiddleware.mjs.map
+//# sourceMappingURL=createStreamMiddleware.js.map

package/dist/createStreamMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createStreamMiddleware.js","sourceRoot":"","sources":["../src/createStreamMiddleware.ts"],"names":[],"mappings":"AAKA,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAO9C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAkBzC;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,OAAO,GAAY,EAAE;IAKlE,MAAM,KAAK,GAAU,EAAE,CAAC,CAAC,gCAAgC;IACzD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,GAAc,EAAE,CAAC,SAAS;QAChC,KAAK,EAAE,cAAc;KACtB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAEtC,MAAM,UAAU,GAAoD,CAClE,GAAG,EACH,GAAG,EACH,IAAI,EACJ,GAAG,EACH,EAAE;QACF,qFAAqF;QACrF,KAAK,CAAC,GAAG,CAAC,EAAuB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC7D,sBAAsB;QACtB,YAAY,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;IAEtC;;;;OAIG;IACH,SAAS,YAAY,CAAC,GAAmB;QACvC,mDAAmD;QACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,SAAS,cAAc,CACrB,GAA0C,EAC1C,SAAkB,EAClB,mBAAmD;QAEnD,IAAI,QAAQ,GAAiB,IAAI,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,cAAc,EAAE,CAAC;gBACnB,mBAAmB,CAAC,GAAqC,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,eAAe,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QAAC,OAAO,IAAI,EAAE,CAAC;YACd,QAAQ,GAAG,IAAa,CAAC;QAC3B,CAAC;QACD,6BAA6B;QAC7B,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,SAAS,eAAe,CAAC,GAA0C;QACjE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;QAC/B,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAClC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,2CAA2C,UAAU,GAAG,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,CAAC;QACzB,mCAAmC;QACnC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChC,+BAA+B;QAC/B,uDAAuD;QACvD,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,SAAS,mBAAmB,CAAC,KAA0B;QACrD,IAAI,OAAO,EAAE,cAAc,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC;YACvE,kBAAkB,EAAE,CAAC;QACvB,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,SAAS,kBAAkB;QACzB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,GAAG,CAAC,EAAE,EAAE,EAAE;YACvD,2GAA2G;YAC3G,qFAAqF;YACrF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,OAAO;YACT,CAAC;YAED,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,2DAA2D,GAAG,CAAC,EAAE,GAAG,CACrE,CAAC;YACJ,CAAC;YACD,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClC,IAAI,WAAW,EAAE,CAAC;gBAChB,WAAW,CAAC,UAAU,GAAG,UAAU,GAAG,CAAC,CAAC;YAC1C,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  JsonRpcEngineNextCallback,\n  JsonRpcEngineEndCallback,\n  JsonRpcMiddleware,\n} from '@metamask/json-rpc-engine';\nimport SafeEventEmitter from '@metamask/safe-event-emitter';\nimport { hasProperty } from '@metamask/utils';\nimport type {\n  JsonRpcNotification,\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { Duplex } from 'readable-stream';\n\ntype IdMapValue = {\n  req: JsonRpcRequest;\n  res: PendingJsonRpcResponse<JsonRpcParams>;\n  next: JsonRpcEngineNextCallback;\n  end: JsonRpcEngineEndCallback;\n  retryCount?: number;\n};\n\ntype IdMap = {\n  [requestId: string]: IdMapValue;\n};\n\ntype Options = {\n  retryOnMessage?: string;\n};\n\n/**\n * Creates a JsonRpcEngine middleware with an associated Duplex stream and\n * EventEmitter. The middleware, and by extension stream, assume that middleware\n * parameters are properly formatted. No runtime type checking or validation is\n * performed.\n *\n * @param options - Configuration options for middleware.\n * @returns The event emitter, middleware, and stream.\n */\nexport default function createStreamMiddleware(options: Options = {}): {\n  events: SafeEventEmitter;\n  middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams>;\n  stream: _Readable.Duplex;\n} {\n  const idMap: IdMap = {}; // TODO: replace with actual Map\n  const stream = new Duplex({\n    objectMode: true,\n    read: (): undefined => undefined,\n    write: processMessage,\n  });\n\n  const events = new SafeEventEmitter();\n\n  const middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams> = (\n    req,\n    res,\n    next,\n    end,\n  ) => {\n    // register request on id map *before* sending it to the stream, to avoid race issues\n    idMap[req.id as unknown as string] = { req, res, next, end };\n    // write req to stream\n    sendToStream(req);\n  };\n\n  return { events, middleware, stream };\n\n  /**\n   * Forwards JSON-RPC request to the stream.\n   *\n   * @param req - The JSON-RPC request object.\n   */\n  function sendToStream(req: JsonRpcRequest): void {\n    // TODO: limiting retries could be implemented here\n    stream.push(req);\n  }\n\n  /**\n   * Writes a JSON-RPC object to the stream.\n   *\n   * @param res - The JSON-RPC response object.\n   * @param _encoding - The stream encoding, not used.\n   * @param streamWriteCallback - The stream write callback.\n   */\n  function processMessage(\n    res: PendingJsonRpcResponse<JsonRpcParams>,\n    _encoding: unknown,\n    streamWriteCallback: (error?: Error | null) => void,\n  ): void {\n    let errorObj: Error | null = null;\n    try {\n      const isNotification = !hasProperty(res, 'id');\n      if (isNotification) {\n        processNotification(res as unknown as JsonRpcNotification);\n      } else {\n        processResponse(res);\n      }\n    } catch (_err) {\n      errorObj = _err as Error;\n    }\n    // continue processing stream\n    streamWriteCallback(errorObj);\n  }\n\n  /**\n   * Processes a JSON-RPC response.\n   *\n   * @param res - The response to process.\n   */\n  function processResponse(res: PendingJsonRpcResponse<JsonRpcParams>): void {\n    const { id: responseId } = res;\n    if (responseId === null) {\n      return;\n    }\n\n    const context = idMap[responseId];\n    if (!context) {\n      console.warn(`StreamMiddleware - Unknown response id \"${responseId}\"`);\n      return;\n    }\n\n    delete idMap[responseId];\n    // copy whole res onto original res\n    Object.assign(context.res, res);\n    // run callback on empty stack,\n    // prevent internal stream-handler from catching errors\n    setTimeout(context.end);\n  }\n\n  /**\n   * Processes a JSON-RPC notification.\n   *\n   * @param notif - The notification to process.\n   */\n  function processNotification(notif: JsonRpcNotification): void {\n    if (options?.retryOnMessage && notif.method === options.retryOnMessage) {\n      retryStuckRequests();\n    }\n    events.emit('notification', notif);\n  }\n\n  /**\n   * Retry pending requests.\n   */\n  function retryStuckRequests(): void {\n    Object.values(idMap).forEach(({ req, retryCount = 0 }) => {\n      // Avoid retrying requests without an id - they cannot have matching responses so retry logic doesn't apply\n      // Check for retry count below ensure that a request is not retried more than 3 times\n      if (!req.id) {\n        return;\n      }\n\n      if (retryCount >= 3) {\n        throw new Error(\n          `StreamMiddleware - Retry limit exceeded for request id \"${req.id}\"`,\n        );\n      }\n      const idMapObject = idMap[req.id];\n      if (idMapObject) {\n        idMapObject.retryCount = retryCount + 1;\n      }\n      sendToStream(req);\n    });\n  }\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import createEngineStream from './createEngineStream.js';
+import createStreamMiddleware from './createStreamMiddleware.js';
+export { createEngineStream, createStreamMiddleware };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,sBAAsB,MAAM,6BAA6B,CAAC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+import createEngineStream from './createEngineStream.js';
+import createStreamMiddleware from './createStreamMiddleware.js';
+export { createEngineStream, createStreamMiddleware };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,sBAAsB,MAAM,6BAA6B,CAAC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC","sourcesContent":["import createEngineStream from './createEngineStream.js';\nimport createStreamMiddleware from './createStreamMiddleware.js';\n\nexport { createEngineStream, createStreamMiddleware };\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/json-rpc-middleware-stream",
-  "version": "8.0.8-preview-8bfa290fb",
+  "version": "9.0.0-preview-0a30e47",
   "description": "A small toolset for streaming JSON-RPC data and matching requests and responses",
   "keywords": [
     "Ethereum",
@@ -18,19 +18,12 @@
   "files": [
     "dist/"
   ],
+  "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -39,9 +32,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
     "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/json-rpc-middleware-stream --tag-prefix-before-package-rename json-rpc-middleware-stream@ --version-before-package-rename 5.0.1",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/json-rpc-middleware-stream --tag-prefix-before-package-rename json-rpc-middleware-stream@ --version-before-package-rename 5.0.1",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
@@ -53,27 +48,28 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/json-rpc-engine": "^10.5.0",
-    "@metamask/safe-event-emitter": "^3.0.0",
+    "@metamask/json-rpc-engine": "^11.0.0",
+    "@metamask/safe-event-emitter": "^3.1.3",
     "@metamask/utils": "^11.12.0",
     "readable-stream": "^3.6.2"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
-    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
     "@types/readable-stream": "^2.3.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "extension-port-stream": "^3.0.0",
     "jest": "^30.4.2",
+    "rimraf": "^5.0.5",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~5.3.3",
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
     "webextension-polyfill-ts": "^0.26.0"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": "^22.14.0 || ^24"
   }
 }

package/dist/createEngineStream.cjs

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const readable_stream_1 = require("readable-stream");
-/**
- * Takes a JsonRpcEngine and returns a Duplex stream wrapping it.
- *
- * @param opts - Options bag.
- * @param opts.engine - The JsonRpcEngine to wrap in a stream.
- * @returns The stream wrapping the engine.
- */
-function createEngineStream(opts) {
-    if (!opts?.engine) {
-        throw new Error('Missing engine parameter!');
-    }
-    const { engine } = opts;
-    const stream = new readable_stream_1.Duplex({
-        objectMode: true,
-        read: () => undefined,
-        write,
-    });
-    // forward notifications
-    if (engine.on) {
-        engine.on('notification', (message) => {
-            stream.push(message);
-        });
-    }
-    return stream;
-    /**
-     * Write a JSON-RPC request to the stream.
-     *
-     * @param req - The JSON-rpc request.
-     * @param _encoding - The stream encoding, not used.
-     * @param streamWriteCallback - The stream write callback.
-     */
-    function write(req, _encoding, streamWriteCallback) {
-        engine.handle(req, (_err, res) => {
-            stream.push(res);
-        });
-        streamWriteCallback();
-    }
-}
-exports.default = createEngineStream;
-//# sourceMappingURL=createEngineStream.cjs.map

package/dist/createEngineStream.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createEngineStream.cjs","sourceRoot":"","sources":["../src/createEngineStream.ts"],"names":[],"mappings":";;AAEA,qDAAyC;AAMzC;;;;;;GAMG;AACH,SAAwB,kBAAkB,CAAC,IAAyB;IAClE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,MAAM,GAAG,IAAI,wBAAM,CAAC;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,GAAc,EAAE,CAAC,SAAS;QAChC,KAAK;KACN,CAAC,CAAC;IACH,wBAAwB;IACxB,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACd,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,KAAK,CACZ,GAAmB,EACnB,SAAkB,EAClB,mBAAmD;QAEnD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,mBAAmB,EAAE,CAAC;IACxB,CAAC;AACH,CAAC;AApCD,qCAoCC","sourcesContent":["import type { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { Duplex } from 'readable-stream';\n\ntype EngineStreamOptions = {\n  engine: JsonRpcEngine;\n};\n\n/**\n * Takes a JsonRpcEngine and returns a Duplex stream wrapping it.\n *\n * @param opts - Options bag.\n * @param opts.engine - The JsonRpcEngine to wrap in a stream.\n * @returns The stream wrapping the engine.\n */\nexport default function createEngineStream(opts: EngineStreamOptions): Duplex {\n  if (!opts?.engine) {\n    throw new Error('Missing engine parameter!');\n  }\n\n  const { engine } = opts;\n  const stream = new Duplex({\n    objectMode: true,\n    read: (): undefined => undefined,\n    write,\n  });\n  // forward notifications\n  if (engine.on) {\n    engine.on('notification', (message) => {\n      stream.push(message);\n    });\n  }\n  return stream;\n\n  /**\n   * Write a JSON-RPC request to the stream.\n   *\n   * @param req - The JSON-rpc request.\n   * @param _encoding - The stream encoding, not used.\n   * @param streamWriteCallback - The stream write callback.\n   */\n  function write(\n    req: JsonRpcRequest,\n    _encoding: unknown,\n    streamWriteCallback: (error?: Error | null) => void,\n  ): void {\n    engine.handle(req, (_err, res) => {\n      stream.push(res);\n    });\n    streamWriteCallback();\n  }\n}\n"]}

package/dist/createEngineStream.d.cts

@@ -1,15 +0,0 @@
-import type { JsonRpcEngine } from "@metamask/json-rpc-engine";
-import { Duplex } from "readable-stream";
-type EngineStreamOptions = {
-    engine: JsonRpcEngine;
-};
-/**
- * Takes a JsonRpcEngine and returns a Duplex stream wrapping it.
- *
- * @param opts - Options bag.
- * @param opts.engine - The JsonRpcEngine to wrap in a stream.
- * @returns The stream wrapping the engine.
- */
-export default function createEngineStream(opts: EngineStreamOptions): Duplex;
-export {};
-//# sourceMappingURL=createEngineStream.d.cts.map

package/dist/createEngineStream.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createEngineStream.d.cts","sourceRoot":"","sources":["../src/createEngineStream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,kCAAkC;AAE/D,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,KAAK,mBAAmB,GAAG;IACzB,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAoC5E"}

package/dist/createEngineStream.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createEngineStream.d.mts","sourceRoot":"","sources":["../src/createEngineStream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,kCAAkC;AAE/D,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,KAAK,mBAAmB,GAAG;IACzB,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,CAoC5E"}

package/dist/createEngineStream.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createEngineStream.mjs","sourceRoot":"","sources":["../src/createEngineStream.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAMzC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,IAAyB;IAClE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,GAAc,EAAE,CAAC,SAAS;QAChC,KAAK;KACN,CAAC,CAAC;IACH,wBAAwB;IACxB,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACd,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,KAAK,CACZ,GAAmB,EACnB,SAAkB,EAClB,mBAAmD;QAEnD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,mBAAmB,EAAE,CAAC;IACxB,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { Duplex } from 'readable-stream';\n\ntype EngineStreamOptions = {\n  engine: JsonRpcEngine;\n};\n\n/**\n * Takes a JsonRpcEngine and returns a Duplex stream wrapping it.\n *\n * @param opts - Options bag.\n * @param opts.engine - The JsonRpcEngine to wrap in a stream.\n * @returns The stream wrapping the engine.\n */\nexport default function createEngineStream(opts: EngineStreamOptions): Duplex {\n  if (!opts?.engine) {\n    throw new Error('Missing engine parameter!');\n  }\n\n  const { engine } = opts;\n  const stream = new Duplex({\n    objectMode: true,\n    read: (): undefined => undefined,\n    write,\n  });\n  // forward notifications\n  if (engine.on) {\n    engine.on('notification', (message) => {\n      stream.push(message);\n    });\n  }\n  return stream;\n\n  /**\n   * Write a JSON-RPC request to the stream.\n   *\n   * @param req - The JSON-rpc request.\n   * @param _encoding - The stream encoding, not used.\n   * @param streamWriteCallback - The stream write callback.\n   */\n  function write(\n    req: JsonRpcRequest,\n    _encoding: unknown,\n    streamWriteCallback: (error?: Error | null) => void,\n  ): void {\n    engine.handle(req, (_err, res) => {\n      stream.push(res);\n    });\n    streamWriteCallback();\n  }\n}\n"]}

package/dist/createStreamMiddleware.cjs

@@ -1,121 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const safe_event_emitter_1 = __importDefault(require("@metamask/safe-event-emitter"));
-const utils_1 = require("@metamask/utils");
-const readable_stream_1 = require("readable-stream");
-/**
- * Creates a JsonRpcEngine middleware with an associated Duplex stream and
- * EventEmitter. The middleware, and by extension stream, assume that middleware
- * parameters are properly formatted. No runtime type checking or validation is
- * performed.
- *
- * @param options - Configuration options for middleware.
- * @returns The event emitter, middleware, and stream.
- */
-function createStreamMiddleware(options = {}) {
-    const idMap = {}; // TODO: replace with actual Map
-    const stream = new readable_stream_1.Duplex({
-        objectMode: true,
-        read: () => undefined,
-        write: processMessage,
-    });
-    const events = new safe_event_emitter_1.default();
-    const middleware = (req, res, next, end) => {
-        // register request on id map *before* sending it to the stream, to avoid race issues
-        idMap[req.id] = { req, res, next, end };
-        // write req to stream
-        sendToStream(req);
-    };
-    return { events, middleware, stream };
-    /**
-     * Forwards JSON-RPC request to the stream.
-     *
-     * @param req - The JSON-RPC request object.
-     */
-    function sendToStream(req) {
-        // TODO: limiting retries could be implemented here
-        stream.push(req);
-    }
-    /**
-     * Writes a JSON-RPC object to the stream.
-     *
-     * @param res - The JSON-RPC response object.
-     * @param _encoding - The stream encoding, not used.
-     * @param streamWriteCallback - The stream write callback.
-     */
-    function processMessage(res, _encoding, streamWriteCallback) {
-        let errorObj = null;
-        try {
-            const isNotification = !(0, utils_1.hasProperty)(res, 'id');
-            if (isNotification) {
-                processNotification(res);
-            }
-            else {
-                processResponse(res);
-            }
-        }
-        catch (_err) {
-            errorObj = _err;
-        }
-        // continue processing stream
-        streamWriteCallback(errorObj);
-    }
-    /**
-     * Processes a JSON-RPC response.
-     *
-     * @param res - The response to process.
-     */
-    function processResponse(res) {
-        const { id: responseId } = res;
-        if (responseId === null) {
-            return;
-        }
-        const context = idMap[responseId];
-        if (!context) {
-            console.warn(`StreamMiddleware - Unknown response id "${responseId}"`);
-            return;
-        }
-        delete idMap[responseId];
-        // copy whole res onto original res
-        Object.assign(context.res, res);
-        // run callback on empty stack,
-        // prevent internal stream-handler from catching errors
-        setTimeout(context.end);
-    }
-    /**
-     * Processes a JSON-RPC notification.
-     *
-     * @param notif - The notification to process.
-     */
-    function processNotification(notif) {
-        if (options?.retryOnMessage && notif.method === options.retryOnMessage) {
-            retryStuckRequests();
-        }
-        events.emit('notification', notif);
-    }
-    /**
-     * Retry pending requests.
-     */
-    function retryStuckRequests() {
-        Object.values(idMap).forEach(({ req, retryCount = 0 }) => {
-            // Avoid retrying requests without an id - they cannot have matching responses so retry logic doesn't apply
-            // Check for retry count below ensure that a request is not retried more than 3 times
-            if (!req.id) {
-                return;
-            }
-            if (retryCount >= 3) {
-                throw new Error(`StreamMiddleware - Retry limit exceeded for request id "${req.id}"`);
-            }
-            const idMapObject = idMap[req.id];
-            if (idMapObject) {
-                idMapObject.retryCount = retryCount + 1;
-            }
-            sendToStream(req);
-        });
-    }
-}
-exports.default = createStreamMiddleware;
-//# sourceMappingURL=createStreamMiddleware.cjs.map

package/dist/createStreamMiddleware.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStreamMiddleware.cjs","sourceRoot":"","sources":["../src/createStreamMiddleware.ts"],"names":[],"mappings":";;;;;AAKA,sFAA4D;AAC5D,2CAA8C;AAO9C,qDAAyC;AAkBzC;;;;;;;;GAQG;AACH,SAAwB,sBAAsB,CAAC,UAAmB,EAAE;IAKlE,MAAM,KAAK,GAAU,EAAE,CAAC,CAAC,gCAAgC;IACzD,MAAM,MAAM,GAAG,IAAI,wBAAM,CAAC;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,GAAc,EAAE,CAAC,SAAS;QAChC,KAAK,EAAE,cAAc;KACtB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,4BAAgB,EAAE,CAAC;IAEtC,MAAM,UAAU,GAAoD,CAClE,GAAG,EACH,GAAG,EACH,IAAI,EACJ,GAAG,EACH,EAAE;QACF,qFAAqF;QACrF,KAAK,CAAC,GAAG,CAAC,EAAuB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC7D,sBAAsB;QACtB,YAAY,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;IAEtC;;;;OAIG;IACH,SAAS,YAAY,CAAC,GAAmB;QACvC,mDAAmD;QACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,SAAS,cAAc,CACrB,GAA0C,EAC1C,SAAkB,EAClB,mBAAmD;QAEnD,IAAI,QAAQ,GAAiB,IAAI,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,CAAC,IAAA,mBAAW,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,cAAc,EAAE,CAAC;gBACnB,mBAAmB,CAAC,GAAqC,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,eAAe,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QAAC,OAAO,IAAI,EAAE,CAAC;YACd,QAAQ,GAAG,IAAa,CAAC;QAC3B,CAAC;QACD,6BAA6B;QAC7B,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,SAAS,eAAe,CAAC,GAA0C;QACjE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;QAC/B,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAClC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,2CAA2C,UAAU,GAAG,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,CAAC;QACzB,mCAAmC;QACnC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChC,+BAA+B;QAC/B,uDAAuD;QACvD,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,SAAS,mBAAmB,CAAC,KAA0B;QACrD,IAAI,OAAO,EAAE,cAAc,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC;YACvE,kBAAkB,EAAE,CAAC;QACvB,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,SAAS,kBAAkB;QACzB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,GAAG,CAAC,EAAE,EAAE,EAAE;YACvD,2GAA2G;YAC3G,qFAAqF;YACrF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,OAAO;YACT,CAAC;YAED,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,2DAA2D,GAAG,CAAC,EAAE,GAAG,CACrE,CAAC;YACJ,CAAC;YACD,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClC,IAAI,WAAW,EAAE,CAAC;gBAChB,WAAW,CAAC,UAAU,GAAG,UAAU,GAAG,CAAC,CAAC;YAC1C,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AA7HD,yCA6HC","sourcesContent":["import type {\n  JsonRpcEngineNextCallback,\n  JsonRpcEngineEndCallback,\n  JsonRpcMiddleware,\n} from '@metamask/json-rpc-engine';\nimport SafeEventEmitter from '@metamask/safe-event-emitter';\nimport { hasProperty } from '@metamask/utils';\nimport type {\n  JsonRpcNotification,\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { Duplex } from 'readable-stream';\n\ntype IdMapValue = {\n  req: JsonRpcRequest;\n  res: PendingJsonRpcResponse<JsonRpcParams>;\n  next: JsonRpcEngineNextCallback;\n  end: JsonRpcEngineEndCallback;\n  retryCount?: number;\n};\n\ntype IdMap = {\n  [requestId: string]: IdMapValue;\n};\n\ntype Options = {\n  retryOnMessage?: string;\n};\n\n/**\n * Creates a JsonRpcEngine middleware with an associated Duplex stream and\n * EventEmitter. The middleware, and by extension stream, assume that middleware\n * parameters are properly formatted. No runtime type checking or validation is\n * performed.\n *\n * @param options - Configuration options for middleware.\n * @returns The event emitter, middleware, and stream.\n */\nexport default function createStreamMiddleware(options: Options = {}): {\n  events: SafeEventEmitter;\n  middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams>;\n  stream: _Readable.Duplex;\n} {\n  const idMap: IdMap = {}; // TODO: replace with actual Map\n  const stream = new Duplex({\n    objectMode: true,\n    read: (): undefined => undefined,\n    write: processMessage,\n  });\n\n  const events = new SafeEventEmitter();\n\n  const middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams> = (\n    req,\n    res,\n    next,\n    end,\n  ) => {\n    // register request on id map *before* sending it to the stream, to avoid race issues\n    idMap[req.id as unknown as string] = { req, res, next, end };\n    // write req to stream\n    sendToStream(req);\n  };\n\n  return { events, middleware, stream };\n\n  /**\n   * Forwards JSON-RPC request to the stream.\n   *\n   * @param req - The JSON-RPC request object.\n   */\n  function sendToStream(req: JsonRpcRequest): void {\n    // TODO: limiting retries could be implemented here\n    stream.push(req);\n  }\n\n  /**\n   * Writes a JSON-RPC object to the stream.\n   *\n   * @param res - The JSON-RPC response object.\n   * @param _encoding - The stream encoding, not used.\n   * @param streamWriteCallback - The stream write callback.\n   */\n  function processMessage(\n    res: PendingJsonRpcResponse<JsonRpcParams>,\n    _encoding: unknown,\n    streamWriteCallback: (error?: Error | null) => void,\n  ): void {\n    let errorObj: Error | null = null;\n    try {\n      const isNotification = !hasProperty(res, 'id');\n      if (isNotification) {\n        processNotification(res as unknown as JsonRpcNotification);\n      } else {\n        processResponse(res);\n      }\n    } catch (_err) {\n      errorObj = _err as Error;\n    }\n    // continue processing stream\n    streamWriteCallback(errorObj);\n  }\n\n  /**\n   * Processes a JSON-RPC response.\n   *\n   * @param res - The response to process.\n   */\n  function processResponse(res: PendingJsonRpcResponse<JsonRpcParams>): void {\n    const { id: responseId } = res;\n    if (responseId === null) {\n      return;\n    }\n\n    const context = idMap[responseId];\n    if (!context) {\n      console.warn(`StreamMiddleware - Unknown response id \"${responseId}\"`);\n      return;\n    }\n\n    delete idMap[responseId];\n    // copy whole res onto original res\n    Object.assign(context.res, res);\n    // run callback on empty stack,\n    // prevent internal stream-handler from catching errors\n    setTimeout(context.end);\n  }\n\n  /**\n   * Processes a JSON-RPC notification.\n   *\n   * @param notif - The notification to process.\n   */\n  function processNotification(notif: JsonRpcNotification): void {\n    if (options?.retryOnMessage && notif.method === options.retryOnMessage) {\n      retryStuckRequests();\n    }\n    events.emit('notification', notif);\n  }\n\n  /**\n   * Retry pending requests.\n   */\n  function retryStuckRequests(): void {\n    Object.values(idMap).forEach(({ req, retryCount = 0 }) => {\n      // Avoid retrying requests without an id - they cannot have matching responses so retry logic doesn't apply\n      // Check for retry count below ensure that a request is not retried more than 3 times\n      if (!req.id) {\n        return;\n      }\n\n      if (retryCount >= 3) {\n        throw new Error(\n          `StreamMiddleware - Retry limit exceeded for request id \"${req.id}\"`,\n        );\n      }\n      const idMapObject = idMap[req.id];\n      if (idMapObject) {\n        idMapObject.retryCount = retryCount + 1;\n      }\n      sendToStream(req);\n    });\n  }\n}\n"]}

package/dist/createStreamMiddleware.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStreamMiddleware.d.cts","sourceRoot":"","sources":["../src/createStreamMiddleware.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAGV,iBAAiB,EAClB,kCAAkC;AACnC,OAAO,gBAAgB,qCAAqC;AAE5D,OAAO,KAAK,EAEV,aAAa,EAGd,wBAAwB;AAezB,KAAK,OAAO,GAAG;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,OAAO,GAAE,OAAY,GAAG;IACrE,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,EAAE,iBAAiB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAC5D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;CAC1B,CAyHA"}

package/dist/createStreamMiddleware.d.mts

@@ -1,23 +0,0 @@
-/// <reference types="readable-stream" />
-import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
-import SafeEventEmitter from "@metamask/safe-event-emitter";
-import type { JsonRpcParams } from "@metamask/utils";
-type Options = {
-    retryOnMessage?: string;
-};
-/**
- * Creates a JsonRpcEngine middleware with an associated Duplex stream and
- * EventEmitter. The middleware, and by extension stream, assume that middleware
- * parameters are properly formatted. No runtime type checking or validation is
- * performed.
- *
- * @param options - Configuration options for middleware.
- * @returns The event emitter, middleware, and stream.
- */
-export default function createStreamMiddleware(options?: Options): {
-    events: SafeEventEmitter;
-    middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams>;
-    stream: _Readable.Duplex;
-};
-export {};
-//# sourceMappingURL=createStreamMiddleware.d.mts.map

package/dist/createStreamMiddleware.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStreamMiddleware.d.mts","sourceRoot":"","sources":["../src/createStreamMiddleware.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAGV,iBAAiB,EAClB,kCAAkC;AACnC,OAAO,gBAAgB,qCAAqC;AAE5D,OAAO,KAAK,EAEV,aAAa,EAGd,wBAAwB;AAezB,KAAK,OAAO,GAAG;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,OAAO,GAAE,OAAY,GAAG;IACrE,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,EAAE,iBAAiB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAC5D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC;CAC1B,CAyHA"}

package/dist/createStreamMiddleware.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStreamMiddleware.mjs","sourceRoot":"","sources":["../src/createStreamMiddleware.ts"],"names":[],"mappings":"AAKA,OAAO,gBAAgB,qCAAqC;AAC5D,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAO9C,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAkBzC;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,UAAmB,EAAE;IAKlE,MAAM,KAAK,GAAU,EAAE,CAAC,CAAC,gCAAgC;IACzD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE,GAAc,EAAE,CAAC,SAAS;QAChC,KAAK,EAAE,cAAc;KACtB,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAEtC,MAAM,UAAU,GAAoD,CAClE,GAAG,EACH,GAAG,EACH,IAAI,EACJ,GAAG,EACH,EAAE;QACF,qFAAqF;QACrF,KAAK,CAAC,GAAG,CAAC,EAAuB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC7D,sBAAsB;QACtB,YAAY,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;IAEtC;;;;OAIG;IACH,SAAS,YAAY,CAAC,GAAmB;QACvC,mDAAmD;QACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,SAAS,cAAc,CACrB,GAA0C,EAC1C,SAAkB,EAClB,mBAAmD;QAEnD,IAAI,QAAQ,GAAiB,IAAI,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,cAAc,EAAE,CAAC;gBACnB,mBAAmB,CAAC,GAAqC,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,eAAe,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QAAC,OAAO,IAAI,EAAE,CAAC;YACd,QAAQ,GAAG,IAAa,CAAC;QAC3B,CAAC;QACD,6BAA6B;QAC7B,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,SAAS,eAAe,CAAC,GAA0C;QACjE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;QAC/B,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAClC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CAAC,2CAA2C,UAAU,GAAG,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,CAAC;QACzB,mCAAmC;QACnC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChC,+BAA+B;QAC/B,uDAAuD;QACvD,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,SAAS,mBAAmB,CAAC,KAA0B;QACrD,IAAI,OAAO,EAAE,cAAc,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC;YACvE,kBAAkB,EAAE,CAAC;QACvB,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,SAAS,kBAAkB;QACzB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,GAAG,CAAC,EAAE,EAAE,EAAE;YACvD,2GAA2G;YAC3G,qFAAqF;YACrF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,OAAO;YACT,CAAC;YAED,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,2DAA2D,GAAG,CAAC,EAAE,GAAG,CACrE,CAAC;YACJ,CAAC;YACD,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClC,IAAI,WAAW,EAAE,CAAC;gBAChB,WAAW,CAAC,UAAU,GAAG,UAAU,GAAG,CAAC,CAAC;YAC1C,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type {\n  JsonRpcEngineNextCallback,\n  JsonRpcEngineEndCallback,\n  JsonRpcMiddleware,\n} from '@metamask/json-rpc-engine';\nimport SafeEventEmitter from '@metamask/safe-event-emitter';\nimport { hasProperty } from '@metamask/utils';\nimport type {\n  JsonRpcNotification,\n  JsonRpcParams,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { Duplex } from 'readable-stream';\n\ntype IdMapValue = {\n  req: JsonRpcRequest;\n  res: PendingJsonRpcResponse<JsonRpcParams>;\n  next: JsonRpcEngineNextCallback;\n  end: JsonRpcEngineEndCallback;\n  retryCount?: number;\n};\n\ntype IdMap = {\n  [requestId: string]: IdMapValue;\n};\n\ntype Options = {\n  retryOnMessage?: string;\n};\n\n/**\n * Creates a JsonRpcEngine middleware with an associated Duplex stream and\n * EventEmitter. The middleware, and by extension stream, assume that middleware\n * parameters are properly formatted. No runtime type checking or validation is\n * performed.\n *\n * @param options - Configuration options for middleware.\n * @returns The event emitter, middleware, and stream.\n */\nexport default function createStreamMiddleware(options: Options = {}): {\n  events: SafeEventEmitter;\n  middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams>;\n  stream: _Readable.Duplex;\n} {\n  const idMap: IdMap = {}; // TODO: replace with actual Map\n  const stream = new Duplex({\n    objectMode: true,\n    read: (): undefined => undefined,\n    write: processMessage,\n  });\n\n  const events = new SafeEventEmitter();\n\n  const middleware: JsonRpcMiddleware<JsonRpcParams, JsonRpcParams> = (\n    req,\n    res,\n    next,\n    end,\n  ) => {\n    // register request on id map *before* sending it to the stream, to avoid race issues\n    idMap[req.id as unknown as string] = { req, res, next, end };\n    // write req to stream\n    sendToStream(req);\n  };\n\n  return { events, middleware, stream };\n\n  /**\n   * Forwards JSON-RPC request to the stream.\n   *\n   * @param req - The JSON-RPC request object.\n   */\n  function sendToStream(req: JsonRpcRequest): void {\n    // TODO: limiting retries could be implemented here\n    stream.push(req);\n  }\n\n  /**\n   * Writes a JSON-RPC object to the stream.\n   *\n   * @param res - The JSON-RPC response object.\n   * @param _encoding - The stream encoding, not used.\n   * @param streamWriteCallback - The stream write callback.\n   */\n  function processMessage(\n    res: PendingJsonRpcResponse<JsonRpcParams>,\n    _encoding: unknown,\n    streamWriteCallback: (error?: Error | null) => void,\n  ): void {\n    let errorObj: Error | null = null;\n    try {\n      const isNotification = !hasProperty(res, 'id');\n      if (isNotification) {\n        processNotification(res as unknown as JsonRpcNotification);\n      } else {\n        processResponse(res);\n      }\n    } catch (_err) {\n      errorObj = _err as Error;\n    }\n    // continue processing stream\n    streamWriteCallback(errorObj);\n  }\n\n  /**\n   * Processes a JSON-RPC response.\n   *\n   * @param res - The response to process.\n   */\n  function processResponse(res: PendingJsonRpcResponse<JsonRpcParams>): void {\n    const { id: responseId } = res;\n    if (responseId === null) {\n      return;\n    }\n\n    const context = idMap[responseId];\n    if (!context) {\n      console.warn(`StreamMiddleware - Unknown response id \"${responseId}\"`);\n      return;\n    }\n\n    delete idMap[responseId];\n    // copy whole res onto original res\n    Object.assign(context.res, res);\n    // run callback on empty stack,\n    // prevent internal stream-handler from catching errors\n    setTimeout(context.end);\n  }\n\n  /**\n   * Processes a JSON-RPC notification.\n   *\n   * @param notif - The notification to process.\n   */\n  function processNotification(notif: JsonRpcNotification): void {\n    if (options?.retryOnMessage && notif.method === options.retryOnMessage) {\n      retryStuckRequests();\n    }\n    events.emit('notification', notif);\n  }\n\n  /**\n   * Retry pending requests.\n   */\n  function retryStuckRequests(): void {\n    Object.values(idMap).forEach(({ req, retryCount = 0 }) => {\n      // Avoid retrying requests without an id - they cannot have matching responses so retry logic doesn't apply\n      // Check for retry count below ensure that a request is not retried more than 3 times\n      if (!req.id) {\n        return;\n      }\n\n      if (retryCount >= 3) {\n        throw new Error(\n          `StreamMiddleware - Retry limit exceeded for request id \"${req.id}\"`,\n        );\n      }\n      const idMapObject = idMap[req.id];\n      if (idMapObject) {\n        idMapObject.retryCount = retryCount + 1;\n      }\n      sendToStream(req);\n    });\n  }\n}\n"]}

package/dist/index.cjs

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createStreamMiddleware = exports.createEngineStream = void 0;
-const createEngineStream_js_1 = __importDefault(require("./createEngineStream.cjs"));
-exports.createEngineStream = createEngineStream_js_1.default;
-const createStreamMiddleware_js_1 = __importDefault(require("./createStreamMiddleware.cjs"));
-exports.createStreamMiddleware = createStreamMiddleware_js_1.default;
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,qFAAyD;AAGhD,6BAHF,+BAAkB,CAGE;AAF3B,6FAAiE;AAEpC,iCAFtB,mCAAsB,CAEsB","sourcesContent":["import createEngineStream from './createEngineStream.js';\nimport createStreamMiddleware from './createStreamMiddleware.js';\n\nexport { createEngineStream, createStreamMiddleware };\n"]}

package/dist/index.d.cts

@@ -1,4 +0,0 @@
-import createEngineStream from "./createEngineStream.cjs";
-import createStreamMiddleware from "./createStreamMiddleware.cjs";
-export { createEngineStream, createStreamMiddleware };
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,iCAAgC;AACzD,OAAO,sBAAsB,qCAAoC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/index.d.mts

@@ -1,4 +0,0 @@
-import createEngineStream from "./createEngineStream.mjs";
-import createStreamMiddleware from "./createStreamMiddleware.mjs";
-export { createEngineStream, createStreamMiddleware };
-//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,iCAAgC;AACzD,OAAO,sBAAsB,qCAAoC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/index.mjs

@@ -1,4 +0,0 @@
-import createEngineStream from "./createEngineStream.mjs";
-import createStreamMiddleware from "./createStreamMiddleware.mjs";
-export { createEngineStream, createStreamMiddleware };
-//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,iCAAgC;AACzD,OAAO,sBAAsB,qCAAoC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC","sourcesContent":["import createEngineStream from './createEngineStream.js';\nimport createStreamMiddleware from './createStreamMiddleware.js';\n\nexport { createEngineStream, createStreamMiddleware };\n"]}