@salesforce/jsonrpc 10.11.1 → 10.12.0

package/dist/index.js

@@ -1,41 +1,41 @@
-function o(s) {
-  return typeof s == "object" && s !== null && !Array.isArray(s);
+function o(e) {
+  return typeof e == "object" && e !== null && !Array.isArray(e);
 }
-function c(s) {
-  return typeof s.id == "number" && Number.isInteger(s.id) && s.id >= 0;
+function c(e) {
+  return typeof e.id == "number" && Number.isInteger(e.id) && e.id >= 0;
 }
-function i(s) {
-  return o(s) && s.jsonrpc === "2.0";
+function i(e) {
+  return o(e) && e.jsonrpc === "2.0";
 }
-function m(s) {
-  if (!i(s)) return !1;
-  const t = s;
+function m(e) {
+  if (!i(e)) return !1;
+  const t = e;
   return c(t) && typeof t.method == "string";
 }
-function d(s) {
-  if (!i(s)) return !1;
-  const t = s;
+function d(e) {
+  if (!i(e)) return !1;
+  const t = e;
   return !("id" in t) && typeof t.method == "string";
 }
-function p(s) {
-  if (!i(s)) return !1;
-  const t = s;
+function p(e) {
+  if (!i(e)) return !1;
+  const t = e;
   return c(t) && "result" in t && !("error" in t) && !("method" in t);
 }
-function f(s) {
-  if (!i(s)) return !1;
-  const t = s;
+function u(e) {
+  if (!i(e)) return !1;
+  const t = e;
   if (!c(t) || "result" in t || "method" in t) return !1;
-  const e = t.error;
-  return o(e) && typeof e.code == "number";
+  const s = t.error;
+  return o(s) && typeof s.code == "number";
 }
-function g(s) {
-  return p(s) || f(s);
+function g(e) {
+  return p(e) || u(e);
 }
-function y(s) {
-  return o(s) && typeof s.code == "number";
+function M(e) {
+  return o(e) && typeof e.code == "number";
 }
-class M {
+class b {
   nextRequestId = 1;
   pending = /* @__PURE__ */ new Map();
   notificationHandlers = /* @__PURE__ */ new Map();
@@ -64,8 +64,8 @@ class M {
    *   this.handleHostContextChanged(params);
    * });
    */
-  registerNotificationHandler(t, e) {
-    this.notificationHandlers.has(t) || this.notificationHandlers.set(t, /* @__PURE__ */ new Set()), this.notificationHandlers.get(t).add(e);
+  registerNotificationHandler(t, s) {
+    this.notificationHandlers.has(t) || this.notificationHandlers.set(t, /* @__PURE__ */ new Set()), this.notificationHandlers.get(t).add(s);
   }
   /**
    * Handle inbound JSON-RPC messages from the transport.
@@ -76,15 +76,21 @@ class M {
    */
   onMessage = (t) => {
     if (g(t)) {
-      const e = this.pending.get(t.id);
-      if (!e)
+      const s = this.pending.get(t.id);
+      if (!s)
         return;
-      this.pending.delete(t.id), f(t) ? e.reject(new Error(t.error.message || "Request failed")) : e.resolve(t.result);
+      this.pending.delete(t.id), this.onInboundMeta(t, t._meta), u(t) ? s.reject(new Error(t.error.message || "Request failed")) : s.resolve(t.result);
       return;
     }
     if (d(t)) {
-      const e = this.notificationHandlers.get(t.method);
-      e && e.forEach((r) => r(t.params));
+      this.onInboundMeta(t, t._meta);
+      const s = this.notificationHandlers.get(t.method);
+      if (s) {
+        const n = t._meta;
+        s.forEach((r) => {
+          r(t.params, n);
+        });
+      }
     }
   };
   /**
@@ -100,18 +106,18 @@ class M {
    *   content: { type: "text", text: "Hello" }
    * });
    */
-  request(t, e) {
-    const r = this.nextRequestId++, n = {
+  request(t, s) {
+    const n = this.nextRequestId++, r = {
       jsonrpc: "2.0",
-      id: r,
+      id: n,
       method: t,
-      params: e
+      params: s
     };
-    return new Promise((h, u) => {
-      this.pending.set(r, {
-        resolve: h,
-        reject: u
-      }), this.transport.post(n);
+    return this.applyOutboundMeta(r, t), new Promise((f, h) => {
+      this.pending.set(n, {
+        resolve: f,
+        reject: h
+      }), this.transport.post(r);
     });
   }
   /**
@@ -137,16 +143,38 @@ class M {
    *   height: 600
    * });
    */
-  sendNotification(t, e) {
-    const r = {
+  sendNotification(t, s) {
+    const n = {
       jsonrpc: "2.0",
       method: t,
-      params: e
+      params: s
     };
-    this.transport.post(r);
+    this.applyOutboundMeta(n, t), this.transport.post(n);
+  }
+  /**
+   * Outbound `_meta` hook. Override to attach protocol-meta (e.g. a
+   * per-message `traceId`) to every outgoing request and notification.
+   *
+   * Default returns `undefined` so the envelope ships without `_meta`,
+   * matching JSON-RPC 2.0 baseline behavior.
+   */
+  getOutboundMeta(t) {
+  }
+  /**
+   * Inbound `_meta` hook. Invoked once per validated inbound frame
+   * (response or notification) before the value is dispatched to the
+   * pending-request resolver or notification handlers.
+   *
+   * Default is a no-op. Override to feed log correlation, tracing, etc.
+   */
+  onInboundMeta(t, s) {
+  }
+  applyOutboundMeta(t, s) {
+    const n = this.getOutboundMeta(s);
+    n !== void 0 && (t._meta = n);
   }
 }
-class S {
+class y {
   targetOrigin;
   /**
    * @param targetOrigin - origin passed as the second argument to
@@ -159,21 +187,21 @@ class S {
     window.parent?.postMessage(t, this.targetOrigin);
   }
   onMessage(t) {
-    const e = (r) => {
-      t(r.data);
+    const s = (n) => {
+      t(n.data);
     };
-    return window.addEventListener("message", e), () => window.removeEventListener("message", e);
+    return window.addEventListener("message", s), () => window.removeEventListener("message", s);
   }
 }
 function R() {
 }
-class T {
+class O {
   #t;
-  #e = /* @__PURE__ */ new Set();
-  #n = !1;
+  #s = /* @__PURE__ */ new Set();
   #r = !1;
+  #n = !1;
   /** Messages queued before `port.start()` has been called. Flushed on first subscribe. */
-  #s = [];
+  #e = [];
   constructor(t) {
     this.#t = t;
   }
@@ -186,9 +214,9 @@ class T {
    * flushed on first subscription.
    */
   post(t) {
-    if (!this.#r) {
-      if (!this.#n) {
-        this.#s.push(t);
+    if (!this.#n) {
+      if (!this.#r) {
+        this.#e.push(t);
         return;
       }
       try {
@@ -208,12 +236,12 @@ class T {
    * Returns an unsubscribe function. Calling it is idempotent.
    */
   onMessage(t) {
-    if (this.#r)
+    if (this.#n)
       return R;
-    this.#e.add(t), this.#n || this.#o();
-    let e = !1;
+    this.#s.add(t), this.#r || this.#o();
+    let s = !1;
     return () => {
-      e || (e = !0, this.#e.delete(t));
+      s || (s = !0, this.#s.delete(t));
     };
   }
   /**
@@ -225,13 +253,13 @@ class T {
    *  - subsequent `onMessage` calls return a no-op unsubscribe
    */
   dispose() {
-    if (!this.#r) {
-      this.#r = !0;
+    if (!this.#n) {
+      this.#n = !0;
       try {
         this.#t.removeEventListener("message", this.#i);
       } catch {
       }
-      this.#e.clear(), this.#s.length = 0;
+      this.#s.clear(), this.#e.length = 0;
       try {
         this.#t.close();
       } catch {
@@ -239,26 +267,26 @@ class T {
     }
   }
   #o() {
-    this.#n = !0, this.#t.addEventListener("message", this.#i);
+    this.#r = !0, this.#t.addEventListener("message", this.#i);
     try {
       this.#t.start();
     } catch {
     }
-    if (this.#s.length > 0) {
-      const t = this.#s;
-      this.#s = [];
-      for (const e of t)
+    if (this.#e.length > 0) {
+      const t = this.#e;
+      this.#e = [];
+      for (const s of t)
         try {
-          this.#t.postMessage(e);
+          this.#t.postMessage(s);
         } catch {
         }
     }
   }
   #i = (t) => {
-    const e = [...this.#e];
-    for (const r of e)
+    const s = [...this.#s];
+    for (const n of s)
       try {
-        r(t.data);
+        n(t.data);
       } catch {
       }
   };
@@ -281,30 +309,30 @@ const a = {
   BACKPRESSURE: -32019,
   /** Terminal response to a $/cancel-ed request. */
   REQUEST_CANCELLED: -32024
-}, E = /* @__PURE__ */ new Set([
+}, l = /* @__PURE__ */ new Set([
   a.REQUEST_TIMEOUT,
   a.BACKPRESSURE
 ]);
-function l(s) {
-  return !!E.has(s);
+function E(e) {
+  return !!l.has(e);
 }
-function b(s, t = {}) {
-  const r = { retryable: t.retryable ?? l(s) };
-  t.details !== void 0 && (r.details = t.details);
-  const n = { code: s };
-  return t.message !== void 0 && (n.message = t.message), n.data = r, n;
+function I(e, t = {}) {
+  const n = { retryable: t.retryable ?? E(e) };
+  t.details !== void 0 && (n.details = t.details);
+  const r = { code: e };
+  return t.message !== void 0 && (r.message = t.message), r.data = n, r;
 }
 export {
-  M as JsonRpcClient,
-  T as MessageChannelTransport,
+  b as JsonRpcClient,
+  O as MessageChannelTransport,
   a as StandardErrorCode,
-  S as WindowPostMessageTransport,
+  y as WindowPostMessageTransport,
   i as isJsonRpcBase,
-  y as isJsonRpcError,
-  f as isJsonRpcErrorResponse,
+  M as isJsonRpcError,
+  u as isJsonRpcErrorResponse,
   d as isJsonRpcNotification,
   m as isJsonRpcRequest,
   g as isJsonRpcResponse,
   p as isJsonRpcSuccessResponse,
-  b as makeJsonRpcError
+  I as makeJsonRpcError
 };

package/dist/jsonrpc-client.d.ts

@@ -1,3 +1,4 @@
+import { JsonRpcFrame, JsonRpcMeta } from './jsonrpc';
 import { Transport } from './transport';
 /**
  * Base class for JSON-RPC 2.0 clients.
@@ -61,7 +62,7 @@ export declare class JsonRpcClient {
      *   this.handleHostContextChanged(params);
      * });
      */
-    protected registerNotificationHandler(method: string, handler: (params: unknown) => void): void;
+    protected registerNotificationHandler(method: string, handler: (params: unknown, meta?: JsonRpcMeta) => void): void;
     /**
      * Handle inbound JSON-RPC messages from the transport.
      *
@@ -108,5 +109,22 @@ export declare class JsonRpcClient {
      * });
      */
     protected sendNotification<TParams = unknown>(method: string, params?: TParams): void;
+    /**
+     * Outbound `_meta` hook. Override to attach protocol-meta (e.g. a
+     * per-message `traceId`) to every outgoing request and notification.
+     *
+     * Default returns `undefined` so the envelope ships without `_meta`,
+     * matching JSON-RPC 2.0 baseline behavior.
+     */
+    protected getOutboundMeta(_method: string): JsonRpcMeta | undefined;
+    /**
+     * Inbound `_meta` hook. Invoked once per validated inbound frame
+     * (response or notification) before the value is dispatched to the
+     * pending-request resolver or notification handlers.
+     *
+     * Default is a no-op. Override to feed log correlation, tracing, etc.
+     */
+    protected onInboundMeta(_frame: JsonRpcFrame, _meta: JsonRpcMeta | undefined): void;
+    private applyOutboundMeta;
 }
 //# sourceMappingURL=jsonrpc-client.d.ts.map

package/dist/jsonrpc-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jsonrpc-client.d.ts","sourceRoot":"","sources":["../src/jsonrpc-client.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,aAAa;IACzB,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,OAAO,CAAuC;IACtD,OAAO,CAAC,oBAAoB,CAAqD;IACjF,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IAEtC;;;;OAIG;gBACS,SAAS,EAAE,SAAS;IAMhC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;IAO/F;;;;;;OAMG;IACH,OAAO,CAAC,SAAS,CA0Bf;IAEF;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,EACrD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC;IAkBnB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;CAQrF"}
+{"version":3,"file":"jsonrpc-client.d.ts","sourceRoot":"","sources":["../src/jsonrpc-client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EAIX,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,aAAa;IACzB,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,OAAO,CAAuC;IACtD,OAAO,CAAC,oBAAoB,CAGxB;IACJ,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IAEtC;;;;OAIG;gBACS,SAAS,EAAE,SAAS;IAMhC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,2BAA2B,CACpC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,IAAI,GACpD,IAAI;IAOP;;;;;;OAMG;IACH,OAAO,CAAC,SAAS,CAgCf;IAEF;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,EACrD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAUrF;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAInE;;;;;;OAMG;IACH,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAInF,OAAO,CAAC,iBAAiB;CAMzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/jsonrpc",
-  "version": "10.11.1",
+  "version": "10.12.0",
   "description": "Shareable JSON-RPC 2.0 primitives for cross-realm communication: envelope types and runtime guards, the request/response engine (JsonRpcClient), and transport adapters.",
   "license": "SEE LICENSE IN LICENSE.txt",
   "type": "module",