@hyper-fetch/sockets 8.1.1 → 8.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,13 +10,75 @@ export type EmitterInstanceProperties = {
10
10
  hasParams?: boolean;
11
11
  hasPayload?: boolean;
12
12
  };
13
+ /**
14
+ * The **constraint** form of an Emitter type. Mindset: "any Emitter that matches this partial shape".
15
+ *
16
+ * Use `EmitterInstance` when you are writing a **reusable abstraction** that accepts emitters
17
+ * from the outside - generic helpers (`<T extends EmitterInstance>`), reusable UI components /
18
+ * hooks, `sdk.$configure({...})` callbacks, mocking utilities, return types, etc.
19
+ *
20
+ * Unspecified generic parameters default to `any` **on purpose**: an omitted field means
21
+ * "I do not care about that field, the caller picks anything". This is exactly what you want
22
+ * for a constraint - any concrete `Emitter` satisfies it. Partial constraints work too:
23
+ * `EmitterInstance<{ payload: { text: string } }>` accepts every emitter whose payload has a
24
+ * `text` field, regardless of topic, params, etc.
25
+ *
26
+ * For describing a **single topic** inside a socket SDK schema, use {@link EmitterModel} instead.
27
+ * `EmitterModel` uses safe non-`any` defaults (`undefined`, `string`, `false`) so omitted fields
28
+ * stay strict instead of silently collapsing to `any`.
29
+ *
30
+ * @see {@link EmitterModel} - definition counterpart for SDK schema modeling.
31
+ */
13
32
  export type EmitterInstance<EmitterProperties extends EmitterInstanceProperties = {}> = Emitter<TypeWithDefaults<EmitterProperties, "payload", any>, TypeWithDefaults<EmitterProperties, "topic", any>, TypeWithDefaults<EmitterProperties, "socket", SocketInstance>, TypeWithDefaults<EmitterProperties, "hasPayload", any>, TypeWithDefaults<EmitterProperties, "hasParams", any>>;
33
+ /**
34
+ * The **definition** form of an Emitter type. Mindset: "**this** specific topic".
35
+ *
36
+ * Use `EmitterModel` when you are **defining** an emitter inside a socket SDK schema. Unlike
37
+ * {@link EmitterInstance}, every unspecified field stays strict instead of falling back to
38
+ * `any` - because in a definition, an omitted field means "**this topic carries no payload**",
39
+ * not "anything goes". The type system will reject mismatches at the call site instead of
40
+ * silently erasing them.
41
+ *
42
+ * The `socket` field is also injected automatically by `createSocketSdk(socket)` at the SDK
43
+ * boundary, so you never need to repeat it inside schema declarations.
44
+ *
45
+ * ### Defaults for omitted fields
46
+ *
47
+ * | Field | Default | Why |
48
+ * | ------------ | ---------------- | ---------------------------------------------------------------- |
49
+ * | `payload` | `undefined` | "No payload declared." `.setData()` is required for typed bodies.|
50
+ * | `topic` | `string` | Allows literal narrowing without erasure. Pass a string literal. |
51
+ * | `socket` | `SocketInstance` | Injected by `createSocketSdk(socket)`; do not set this manually. |
52
+ * | `hasPayload` | `false` | "Caller must call `.setData()`." Override only when bound. |
53
+ * | `hasParams` | `false` | "Caller must call `.setParams()`." Override only when bound. |
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * // Schema describes shape only - socket is injected by createSocketSdk(socket).
58
+ * type ChatSchema = {
59
+ * chat: {
60
+ * messages: {
61
+ * $emitter: EmitterModel<{
62
+ * payload: { text: string };
63
+ * topic: "chat/messages";
64
+ * }>;
65
+ * };
66
+ * };
67
+ * };
68
+ * ```
69
+ *
70
+ * @see {@link EmitterInstance} - constraint counterpart for accepting any Emitter.
71
+ */
72
+ export type EmitterModel<EmitterProperties extends EmitterInstanceProperties = {}> = Emitter<TypeWithDefaults<EmitterProperties, "payload", undefined>, TypeWithDefaults<EmitterProperties, "topic", string>, TypeWithDefaults<EmitterProperties, "socket", SocketInstance>, TypeWithDefaults<EmitterProperties, "hasPayload", false>, TypeWithDefaults<EmitterProperties, "hasParams", false>>;
14
73
  export type EmitterCloneOptionsType<Payload, Params, Topic extends string, Socket extends SocketInstance> = {
15
74
  payload?: Payload;
16
75
  params?: Params | null;
17
76
  } & Partial<EmitterOptionsType<Topic, ExtractSocketAdapterType<Socket>>>;
77
+ /** Configuration options for creating an Emitter instance. */
18
78
  export type EmitterOptionsType<Topic extends string, AdapterType extends SocketAdapterInstance> = {
79
+ /** The topic/channel name to emit messages on */
19
80
  topic: Topic;
81
+ /** Adapter-specific emit options */
20
82
  options?: ExtractAdapterEmitterOptionsType<AdapterType>;
21
83
  };
22
84
  export type EmitterCallbackErrorType = (data: {
@@ -1 +1 @@
1
- {"version":3,"file":"emitter.types.d.ts","sourceRoot":"","sources":["../../src/emitter/emitter.types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpG,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EACV,wBAAwB,EACxB,4BAA4B,EAC5B,2BAA2B,EAC3B,uBAAuB,EACvB,yBAAyB,EACzB,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,iBAAiB,SAAS,yBAAyB,GAAG,EAAE,IAAI,OAAO,CAC7F,gBAAgB,CAAC,iBAAiB,EAAE,SAAS,EAAE,GAAG,CAAC,EACnD,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,EAAE,GAAG,CAAC,EACjD,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC7D,gBAAgB,CAAC,iBAAiB,EAAE,YAAY,EAAE,GAAG,CAAC,EACtD,gBAAgB,CAAC,iBAAiB,EAAE,WAAW,EAAE,GAAG,CAAC,CACtD,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,MAAM,EAAE,MAAM,SAAS,cAAc,IAAI;IAC1G,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GAAG,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEzE,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,MAAM,EAAE,WAAW,SAAS,qBAAqB,IAAI;IAChG,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,CAAC,EAAE,gCAAgC,CAAC,WAAW,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,KAAK,IAAI,CAAC;AAIxE,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,SAAS,OAAO,IAAI,UAAU,SAAS,KAAK,GACvF;IACE,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE1B,MAAM,MAAM,cAAc,CACxB,MAAM,SAAS,UAAU,GAAG,UAAU,EACtC,UAAU,SAAS,OAAO,IACxB,UAAU,SAAS,KAAK,GACxB,MAAM,SAAS,UAAU,GACvB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACnB;IACE,MAAM,EAAE,MAAM,CAAC;CAChB,GACH;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExB,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,qBAAqB,IACjE,gCAAgC,CAAC,OAAO,CAAC,SAAS,GAAG,GACjD,EAAE,GACF,gCAAgC,CAAC,OAAO,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACnE;IAAE,OAAO,CAAC,EAAE,gCAAgC,CAAC,OAAO,CAAC,CAAA;CAAE,GACvD,EAAE,CAAC;AAEX,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,eAAe,IAAI,eAAe,CAClF,yBAAyB,CAAC,OAAO,CAAC,EAClC,4BAA4B,CAAC,OAAO,CAAC,CACtC,GACC,cAAc,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC,CAAC,GACxG,iBAAiB,CAAC,wBAAwB,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjF,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,eAAe,IAClD,4BAA4B,CAAC,OAAO,CAAC,SAAS,KAAK,GAC/C,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GACjD,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,SAAS,UAAU,GACnE,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GAClD,2BAA2B,CAAC,OAAO,CAAC,SAAS,KAAK,GAChD,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GACjD,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;AAE7D,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,eAAe,EACzB,UAAU,SAAS;IACjB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;CAC1B,IACC,OAAO,CACT,gBAAgB,CAAC,UAAU,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC,EACrE,UAAU,CAAC,OAAO,CAAC,SAAS,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,EACrF,UAAU,CAAC,QAAQ,CAAC,SAAS,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,EAChG,UAAU,CAAC,SAAS,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,4BAA4B,CAAC,CAAC,CAAC,EAC3E,UAAU,CAAC,WAAW,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,2BAA2B,CAAC,CAAC,CAAC,CAC7E,CAAC"}
1
+ {"version":3,"file":"emitter.types.d.ts","sourceRoot":"","sources":["../../src/emitter/emitter.types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpG,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EACV,wBAAwB,EACxB,4BAA4B,EAC5B,2BAA2B,EAC3B,uBAAuB,EACvB,yBAAyB,EACzB,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,CAAC,iBAAiB,SAAS,yBAAyB,GAAG,EAAE,IAAI,OAAO,CAC7F,gBAAgB,CAAC,iBAAiB,EAAE,SAAS,EAAE,GAAG,CAAC,EACnD,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,EAAE,GAAG,CAAC,EACjD,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC7D,gBAAgB,CAAC,iBAAiB,EAAE,YAAY,EAAE,GAAG,CAAC,EACtD,gBAAgB,CAAC,iBAAiB,EAAE,WAAW,EAAE,GAAG,CAAC,CACtD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,MAAM,YAAY,CAAC,iBAAiB,SAAS,yBAAyB,GAAG,EAAE,IAAI,OAAO,CAC1F,gBAAgB,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,EACzD,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,EACpD,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC7D,gBAAgB,CAAC,iBAAiB,EAAE,YAAY,EAAE,KAAK,CAAC,EACxD,gBAAgB,CAAC,iBAAiB,EAAE,WAAW,EAAE,KAAK,CAAC,CACxD,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,MAAM,EAAE,MAAM,SAAS,cAAc,IAAI;IAC1G,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GAAG,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEzE,8DAA8D;AAC9D,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,MAAM,EAAE,WAAW,SAAS,qBAAqB,IAAI;IAChG,iDAAiD;IACjD,KAAK,EAAE,KAAK,CAAC;IACb,oCAAoC;IACpC,OAAO,CAAC,EAAE,gCAAgC,CAAC,WAAW,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,KAAK,IAAI,CAAC;AAIxE,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,SAAS,OAAO,IAAI,UAAU,SAAS,KAAK,GACvF;IACE,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE1B,MAAM,MAAM,cAAc,CACxB,MAAM,SAAS,UAAU,GAAG,UAAU,EACtC,UAAU,SAAS,OAAO,IACxB,UAAU,SAAS,KAAK,GACxB,MAAM,SAAS,UAAU,GACvB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACnB;IACE,MAAM,EAAE,MAAM,CAAC;CAChB,GACH;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExB,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,qBAAqB,IACjE,gCAAgC,CAAC,OAAO,CAAC,SAAS,GAAG,GACjD,EAAE,GACF,gCAAgC,CAAC,OAAO,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACnE;IAAE,OAAO,CAAC,EAAE,gCAAgC,CAAC,OAAO,CAAC,CAAA;CAAE,GACvD,EAAE,CAAC;AAEX,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,eAAe,IAAI,eAAe,CAClF,yBAAyB,CAAC,OAAO,CAAC,EAClC,4BAA4B,CAAC,OAAO,CAAC,CACtC,GACC,cAAc,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC,CAAC,GACxG,iBAAiB,CAAC,wBAAwB,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjF,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,eAAe,IAClD,4BAA4B,CAAC,OAAO,CAAC,SAAS,KAAK,GAC/C,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GACjD,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,SAAS,UAAU,GACnE,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GAClD,2BAA2B,CAAC,OAAO,CAAC,SAAS,KAAK,GAChD,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GACjD,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;AAE7D,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,eAAe,EACzB,UAAU,SAAS;IACjB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;CAC1B,IACC,OAAO,CACT,gBAAgB,CAAC,UAAU,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC,EACrE,UAAU,CAAC,OAAO,CAAC,SAAS,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,EACrF,UAAU,CAAC,QAAQ,CAAC,SAAS,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,EAChG,UAAU,CAAC,SAAS,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,4BAA4B,CAAC,CAAC,CAAC,EAC3E,UAAU,CAAC,WAAW,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,2BAA2B,CAAC,CAAC,CAAC,CAC7E,CAAC"}
package/dist/index.mjs CHANGED
@@ -314,6 +314,10 @@ var require_events = /* @__PURE__ */ __commonJSMin(((exports, module) => {
314
314
  }));
315
315
  //#endregion
316
316
  //#region src/listener/listener.ts
317
+ /**
318
+ * Represents a socket message listener bound to a specific topic. Use it to subscribe to
319
+ * typed messages from WebSocket or Server-Sent Events connections via the socket adapter.
320
+ */
317
321
  var Listener = class Listener {
318
322
  topic;
319
323
  params;
@@ -325,12 +329,15 @@ var Listener = class Listener {
325
329
  this.topic = topic;
326
330
  this.options = options;
327
331
  }
332
+ /** Set adapter-specific listener options. */
328
333
  setOptions(options) {
329
334
  return this.clone({ options });
330
335
  }
336
+ /** Set the URL path parameters for the topic (e.g., `:channelId`). */
331
337
  setParams(params) {
332
338
  return this.clone({ params });
333
339
  }
340
+ /** Create a new listener instance with optional configuration overrides. */
334
341
  clone(options) {
335
342
  return new Listener(this.socket, {
336
343
  ...this.listenerOptions,
@@ -338,6 +345,7 @@ var Listener = class Listener {
338
345
  topic: this.paramsMapper(options?.params || this.params)
339
346
  });
340
347
  }
348
+ /** Start listening for messages on the configured topic. Returns a function to unsubscribe. */
341
349
  listen = (callback) => {
342
350
  this.socket.adapter.listen(this, callback);
343
351
  const removeListener = () => {
@@ -358,6 +366,10 @@ var Listener = class Listener {
358
366
  };
359
367
  //#endregion
360
368
  //#region src/emitter/emitter.ts
369
+ /**
370
+ * Represents a socket message emitter bound to a specific topic. Use it to send typed payloads
371
+ * over WebSocket or Server-Sent Events connections via the socket adapter.
372
+ */
361
373
  var Emitter = class Emitter {
362
374
  topic;
363
375
  params;
@@ -374,17 +386,21 @@ var Emitter = class Emitter {
374
386
  this.options = snapshot?.options ?? options;
375
387
  this.params = snapshot?.params;
376
388
  }
389
+ /** Set adapter-specific emit options (e.g., acknowledgment, timeout). */
377
390
  setOptions(options) {
378
391
  return this.clone({ options });
379
392
  }
393
+ /** Set the message payload to be emitted. */
380
394
  setPayload = (payload) => {
381
395
  return this.clone({ payload });
382
396
  };
397
+ /** Set a mapper function that transforms the payload before it is sent. */
383
398
  setPayloadMapper = (payloadMapper) => {
384
399
  const cloned = this.clone(void 0);
385
400
  cloned.unstable_payloadMapper = payloadMapper;
386
401
  return cloned;
387
402
  };
403
+ /** Set the URL path parameters for the topic (e.g., `:channelId`). */
388
404
  setParams(params) {
389
405
  return this.clone({ params });
390
406
  }
@@ -395,6 +411,7 @@ var Emitter = class Emitter {
395
411
  });
396
412
  return topic;
397
413
  };
414
+ /** Create a new emitter instance with optional configuration overrides. */
398
415
  clone(config) {
399
416
  const snapshot = {
400
417
  options: this.options,
@@ -407,6 +424,7 @@ var Emitter = class Emitter {
407
424
  newInstance.unstable_payloadMapper = this.unstable_payloadMapper;
408
425
  return newInstance;
409
426
  }
427
+ /** Send the message through the socket adapter on the configured topic. */
410
428
  emit = (options = {}) => {
411
429
  const typedOptions = options;
412
430
  const instance = this.clone(typedOptions);
@@ -788,6 +806,7 @@ var getSocketError = (event) => {
788
806
  };
789
807
  //#endregion
790
808
  //#region src/adapter-websockets/websocket-adapter.ts
809
+ /** Create a preconfigured socket adapter for native WebSocket connections. */
791
810
  var WebsocketAdapter = () => new SocketAdapter({ name: "websockets" }).setQueryParamsMapper(stringifyQueryParams).setConnector(({ socket, logger, getQueryParams, onConnect, onReconnect, onDisconnect, onListen, onEmit, onConnected, onDisconnected, onError, onEvent }) => {
792
811
  const autoConnect = typeof socket.adapter.adapterOptions?.autoConnect === "boolean" ? socket.adapter.adapterOptions?.autoConnect : true;
793
812
  let websocket;
@@ -1324,6 +1343,7 @@ var getServerSentEventsAdapter = (url, adapterOptions) => {
1324
1343
  };
1325
1344
  //#endregion
1326
1345
  //#region src/adapter-sse/sse-adapter.ts
1346
+ /** Create a preconfigured socket adapter for Server-Sent Events (EventSource) connections. */
1327
1347
  var ServerSentEventsAdapter = () => new SocketAdapter({ name: "sse" }).setQueryParamsMapper(stringifyQueryParams).setConnector(({ socket, adapter, getQueryParams, onConnect, onReconnect, onDisconnect, onListen, onConnected, onDisconnected, onError, onEvent }) => {
1328
1348
  let sse;
1329
1349
  const autoConnect = typeof socket.adapter.adapterOptions?.autoConnect === "boolean" ? socket.adapter.adapterOptions?.autoConnect : true;