@owlmeans/socket 0.1.18-rc.8 → 0.1.18

package/README.md

@@ -12,7 +12,7 @@ Shared WebSocket connection types and message protocol for OwlMeans real-time co
 ## Installation
 
 ```bash
-bun add @owlmeans/socket
+bun add @owlmeans/socket@^0.1.18
 ```
 
 ## Usage
@@ -91,7 +91,7 @@ This package ships embedded agent skills under `agent-meta/`. After installing y
 your project's skill store (`.agents/skills/`):
 
 ```sh
-npx @owlmeans/agent-skills
+npx @owlmeans/agent-skills@^0.1.18
 ```
 
 The embedded files are version-matched to this package release. Do not edit them

package/agent-meta/manifest.json

@@ -1,8 +1,8 @@
 {
-  "schemaVersion": 2,
+  "schemaVersion": 3,
   "package": "@owlmeans/socket",
-  "version": "0.1.18-rc.8",
-  "generatedAt": "2026-09-01T16:28:56.990Z",
+  "version": "0.1.18",
+  "generatedAt": "2026-10-28T00:31:34.737Z",
   "canonicalRepo": "https://github.com/owlmeans/common",
   "entries": [
     {

package/agent-meta/skills/socket/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: socket
-description: How to use @owlmeans/socket — abstract WebSocket protocol model, message types, and socket errors shared between client-socket and server-socket. Auto-invoked when importing socket types or message constants.
+description: How to use @owlmeans/socket — the transport-agnostic Connection model shared by client-socket and server-socket, its message types (call/request/event/auth/system), the type guards, and the socket error classes. Auto-invoked when importing socket types, message constants or the connection model.
 user-invocable: false
 ---
 <!-- AUTO-GENERATED — do not edit. Regenerate via sync-agent-meta. -->
@@ -8,29 +8,131 @@ user-invocable: false
 # @owlmeans/socket
 
 **Layer:** Core
-**Install:** `"@owlmeans/socket": "^0.1.18-rc.8"` in `dependencies`
+**Install:** `"@owlmeans/socket": "^0.1.18"` in `dependencies`
+
+Contracts and one implementation-free connection model. It knows nothing about WebSockets: the
+browser side is `@owlmeans/client-socket`, the Fastify side `@owlmeans/server-socket`, and each
+supplies the members the model leaves abstract — `send`, `close`, `authenticate` and `prepare` —
+that make it concrete. Both halves of an application therefore speak the same frames.
 
 ## Key Exports
 
 | Export | Description |
 |--------|-------------|
-| `Message` types | Wire message shape (envelope, payload, headers) |
-| `SocketEvent` types | Socket lifecycle events |
-| Errors | Typed socket errors (Disconnected, AuthFailed, etc.) |
-| Constants | Message types, channel names |
-| Helpers | Encode/decode messages |
+| `createBasicConnection()` | The connection model — everything below the wire. A carrier assigns `send` / `close` / `authenticate` / `prepare` and feeds bytes to `receive` |
+| `Connection` | What a handler is handed: the messaging verbs, `stage`, `getListeners` |
+| `Message<T>` | The frame — `{ type, payload, id?, sender?, recipient?, dt?, rawData? }` |
+| `CallMessage<T>` / `EventMessage<T>` / `AuthMessage<T>` | The three frames that add a field: `method` + `timeout`, `event`, `stage` |
+| `MessageType` | `Call` `Result` `Error` `Request` `Response` `Event` `Message` `Auth` `System` |
+| `socketMessageHelper` — `.isMessage` / `.isEventMessage` / `.isCallMessage` / `.isAuthMessage` | Type guards — `socketMessageHelper.isMessage(msg, true)` excludes system frames, `.isEventMessage(msg, true)` keeps only them |
+| `ConnectionListener` / `CallHendler` / `RequestHandler` / `CallResolver` | The callback shapes |
+| `SocketSystemEvent` | The `event` values a `MessageType.System` frame carries — see below |
+| `SOCKET_HEARTBEAT_TIMEOUT_CODE` | `4000` — the close code `client-socket`'s carrier uses when it force-closes a socket that has gone silent |
+| `SocketError` and subclasses | `SocketInitializationError`, `SocketConnectionError`, `SocketUnauthorized`, `SocketUnsupported`, `SocketTimeout`, `SocketMessageError`, `SocketMessageMalformed` — all registered with `ResilientError` |
+| `CALL_TIMEOUT` | 60 000 ms, the fallback when neither the message nor `connection.defaultCallTimeout` says |
+
+## The four ways to say something
+
+Pick by who is expected to answer and how often — they are separate registries, and a handler
+bound to one never sees the others.
 
-## Usage
+| Verb | Answered by | Shape |
+|---|---|---|
+| `notify(event, payload)` | `observe(event, handler)` | Fire-and-forget, fanned out to every observer of that event name |
+| `call(method, ...args)` | `perform(method, handler)` | One RPC, resolved with the handler's return value or rejected with its error |
+| `request(payload, observer?)` | `acknowledge(handler)`, answered with `reply(id, payload)` | An open question — acknowledgers run in turn until one takes it |
+| `enqueue(payload, id?)` | `consume(filter?)` | A mailbox the far side drains on its own schedule; `enqueued()` is its depth |
 
 ```typescript
-import type { Message } from '@owlmeans/socket'
+import { MessageType } from '@owlmeans/socket'
+import type { Connection, EventMessage } from '@owlmeans/socket'
+
+connection.observe<Progress>('job-event', async message => render(message.payload))
+await connection.notify('job-event', { id, progress: 0.5 })
+
+connection.perform<Report, [string]>('report', async id => await build(id))
+const report = await connection.call<Report, [string]>('report', id)
+```
+
+A `call` carries an id and a timeout, and the model arms the timer on both sides: the caller
+rejects with `SocketTimeout` when the answer does not arrive, and the performer stops sending one
+once it has elapsed. `timeout: 0` disables it. A performer that throws is answered with a
+`MessageType.Error` frame carrying the marshalled error, so the caller's `call` rejects with the
+original class rather than with a string.
+
+## Frames a listener sees
 
-const msg: Message = { type: 'subscribe', channel: 'projects', payload: { entityId } }
+`listen(listener)` receives EVERY inbound frame after the model has routed it — the escape hatch
+for what the verbs above do not cover. It also receives the frames a carrier synthesises, which is
+how a handler learns the connection is gone:
+
+```typescript
+connection.listen(async message => {
+  if (typeof message !== 'object') {
+    return
+  }
+  const msg = message as EventMessage<void>
+  if (msg.type === MessageType.System && msg.event === 'close') {
+    await cleanUp()
+  }
+})
 ```
 
-Concrete implementations live in `@owlmeans/client-socket` (browser/native) and `@owlmeans/server-socket` (Fastify integration).
+Both carriers emit exactly that frame — `MessageType.System`, `event: 'close'`, payload
+`{ code }` — when the socket closes for good. Nothing else reports a TERMINAL disconnect, so any
+subscription a handler opened is released there.
+
+**`SocketSystemEvent`** is the full vocabulary a `MessageType.System` frame's `event` can carry —
+`client-socket`'s reconnecting carrier is what emits the other four:
+
+| Event | Meaning |
+|---|---|
+| `close` | The connection is gone for good — see above |
+| `disconnected` | The socket dropped and a retry IS scheduled (client-socket only) — `{ code }` |
+| `reconnecting` | Before each retry attempt (client-socket only) — `{ attempt, delay }` |
+| `reconnected` | A retry succeeded, same `Connection` model (client-socket only) — `{ attempts }` |
+| `lost` | The retry budget elapsed with no success (client-socket only). NOT followed by `close`: the connection stays revivable until its owner closes it |
+
+`close` is the only one of the five a plain carrier with no retry logic (like `server-socket`, or
+`client-socket` itself with `reconnect: false`) will ever emit. A listener that must react to a
+reconnecting carrier giving up listens for `lost` — a `close` there comes only from its owner's
+own `close()` or a terminal server code.
+
+## What the model expects of a carrier
+
+- `receive(raw)` takes the raw string. It only parses text that starts with `{` or `[`; anything
+  else is dropped without reaching a listener. The carriers' own heartbeat IS JSON
+  (`{ type: 'ping' }`), so it is parsed: it matches no `MessageType` and routes nowhere, yet it
+  still reaches every `listen` listener — a listener has to recognise the frames it wants.
+- A frame with no `type` is read as `MessageType.Message` and a frame with no `payload` is treated
+  as its own payload, so a plain JSON body from a foreign client still arrives as a message.
+- `prepare(message, isRequest?)` is the carrier's hook for stamping a frame — timestamps,
+  `sender` / `recipient`. It runs on every outbound frame and on every inbound one.
+- `send`, `close` and `authenticate` throw `SyntaxError` until a carrier assigns them, so one that
+  forgets a member fails loudly rather than dropping frames. `prepare` is the exception: it is
+  optional on the interface and simply absent until assigned, and the model calls it defensively —
+  a carrier that omits it stamps nothing.
+
+## Authentication
+
+`auth(stage, payload)` sends an `AuthMessage` and waits. The far side's `authenticate` answers with
+the next stage and its payload, or throws — a rejection travels back as an `AuthMessage` with a
+null stage and is rebuilt by the initiator. `connection.stage` holds the current
+`AuthenticationStage` throughout. Only the server carrier implements a real sequence; see the
+`server-socket` skill.
+
+Raw inbound data is parsed and structurally checked before dispatch. A server connection may accept
+only authentication frames until its carrier marks it authenticated; an unknown call returns a
+typed socket error, and listener failures are isolated and logged so an EventEmitter never receives
+an unhandled rejected promise. Keep sensitive actions behind the carrier's authentication stage.
 
 ## Depends On
 
-- `@owlmeans/error`, `@owlmeans/i18n`
-- `@owlmeans/basic-envelope` — message envelopes
+- `@owlmeans/error` — `ResilientError`, which every socket error registers with
+- `@owlmeans/auth` — `AuthenticationStage`, the vocabulary the auth frames carry
+- `@owlmeans/basic-ids` — `idHelper.uuid` for call and request ids
+
+## Related
+
+- `client-socket` — the browser carrier and `useWs`
+- `server-socket` — the Fastify carrier, guard enforcement and `connection(protocol, callback)`

package/build/consts.d.ts

@@ -10,4 +10,25 @@ export declare enum MessageType {
     System = "system"
 }
 export declare const CALL_TIMEOUT = 60000;
+/**
+ * System frames a carrier synthesises around the lifecycle of the underlying transport.
+ *
+ * `Close` means the connection is gone for good — a client-initiated close, or a terminal server
+ * code. A drop the carrier intends to retry is reported as `Disconnected`, and an exhausted retry
+ * budget as `Lost` alone: a lost connection can still be revived, so it is not closed.
+ */
+export declare enum SocketSystemEvent {
+    Close = "close",
+    Disconnected = "disconnected",
+    Reconnecting = "reconnecting",
+    Reconnected = "reconnected",
+    Lost = "lost"
+}
+/**
+ * The close code a carrier uses when it drops a socket itself — a missed heartbeat pong within
+ * `pongTimeout`, catching a half-open TCP connection long before the OS would notice one.
+ * Reserved in the 4000–4999 private-use range so it is never confused with a code either
+ * endpoint's own WebSocket stack could produce.
+ */
+export declare const SOCKET_HEARTBEAT_TIMEOUT_CODE = 4000;
 //# sourceMappingURL=consts.d.ts.map

package/build/consts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,YAAY,QAAQ,CAAA"}
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,YAAY,QAAQ,CAAA;AAEjC;;;;;;GAMG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,IAAI,SAAS;CACd;AAED;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,OAAO,CAAA"}

package/build/consts.js

@@ -11,4 +11,26 @@ export var MessageType;
     MessageType["System"] = "system";
 })(MessageType || (MessageType = {}));
 export const CALL_TIMEOUT = 60000;
+/**
+ * System frames a carrier synthesises around the lifecycle of the underlying transport.
+ *
+ * `Close` means the connection is gone for good — a client-initiated close, or a terminal server
+ * code. A drop the carrier intends to retry is reported as `Disconnected`, and an exhausted retry
+ * budget as `Lost` alone: a lost connection can still be revived, so it is not closed.
+ */
+export var SocketSystemEvent;
+(function (SocketSystemEvent) {
+    SocketSystemEvent["Close"] = "close";
+    SocketSystemEvent["Disconnected"] = "disconnected";
+    SocketSystemEvent["Reconnecting"] = "reconnecting";
+    SocketSystemEvent["Reconnected"] = "reconnected";
+    SocketSystemEvent["Lost"] = "lost";
+})(SocketSystemEvent || (SocketSystemEvent = {}));
+/**
+ * The close code a carrier uses when it drops a socket itself — a missed heartbeat pong within
+ * `pongTimeout`, catching a half-open TCP connection long before the OS would notice one.
+ * Reserved in the 4000–4999 private-use range so it is never confused with a code either
+ * endpoint's own WebSocket stack could produce.
+ */
+export const SOCKET_HEARTBEAT_TIMEOUT_CODE = 4000;
 //# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -1 +1 @@
-{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,MAAM,CAAN,IAAY,WAUX;AAVD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,4BAAa,CAAA;IACb,gCAAiB,CAAA;AACnB,CAAC,EAVW,WAAW,KAAX,WAAW,QAUtB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAA"}
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,MAAM,CAAN,IAAY,WAUX;AAVD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,4BAAa,CAAA;IACb,gCAAiB,CAAA;AACnB,CAAC,EAVW,WAAW,KAAX,WAAW,QAUtB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAA;AAEjC;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,oCAAe,CAAA;IACf,kDAA6B,CAAA;IAC7B,kDAA6B,CAAA;IAC7B,gDAA2B,CAAA;IAC3B,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,IAAI,CAAA"}

package/build/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,qBAAa,WAAY,SAAQ,cAAc;IAC7C,OAAuB,QAAQ,EAAE,MAAM,CAAgB;gBAE3C,OAAO,GAAE,MAAgB;CAGtC;AAED,qBAAa,yBAA0B,SAAQ,WAAW;IACxD,OAAuB,QAAQ,EAAE,MAAM,CAA0C;gBAErE,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,qBAAsB,SAAQ,WAAW;IACpD,OAAuB,QAAQ,EAAE,MAAM,CAAsC;gBAEjE,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,kBAAmB,SAAQ,qBAAqB;IAC3D,OAAuB,QAAQ,EAAE,MAAM,CAAkD;gBAE7E,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,iBAAkB,SAAQ,qBAAqB;IAC1D,OAAuB,QAAQ,EAAE,MAAM,CAAiD;gBAE5E,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,aAAc,SAAQ,WAAW;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAmC;gBAE9D,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,OAAuB,QAAQ,EAAE,MAAM,CAAmC;gBAE9D,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,sBAAuB,SAAQ,kBAAkB;IAC5D,OAAuB,QAAQ,EAAE,MAAM,CAA4C;gBAEvE,OAAO,GAAE,MAAgB;CAItC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,qBAAa,WAAY,SAAQ,cAAc;IAC7C,OAAuB,QAAQ,EAAE,MAAM,CAAgB;IAEvD,YAAY,OAAO,GAAE,MAAgB,EAEpC;CACF;AAED,qBAAa,yBAA0B,SAAQ,WAAW;IACxD,OAAuB,QAAQ,EAAE,MAAM,CAA0C;IAEjF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,qBAAsB,SAAQ,WAAW;IACpD,OAAuB,QAAQ,EAAE,MAAM,CAAsC;IAE7E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,kBAAmB,SAAQ,qBAAqB;IAC3D,OAAuB,QAAQ,EAAE,MAAM,CAAkD;IAEzF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,iBAAkB,SAAQ,qBAAqB;IAC1D,OAAuB,QAAQ,EAAE,MAAM,CAAiD;IAExF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,aAAc,SAAQ,WAAW;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAmC;IAE1E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,OAAuB,QAAQ,EAAE,MAAM,CAAmC;IAE1E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,sBAAuB,SAAQ,kBAAkB;IAC5D,OAAuB,QAAQ,EAAE,MAAM,CAA4C;IAEnF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF"}

package/build/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,MAAM,OAAO,WAAY,SAAQ,cAAc;IACtC,MAAM,CAAU,QAAQ,GAAW,aAAa,CAAA;IAEvD,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,OAAO,EAAE,CAAC,CAAA;IAClD,CAAC;;AAGH,MAAM,OAAO,yBAA0B,SAAQ,WAAW;IACjD,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,gBAAgB,CAAA;IAEjF,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAA;QAClC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC,QAAQ,CAAA;IAChD,CAAC;;AAGH,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAC7C,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,YAAY,CAAA;IAE7E,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,cAAc,OAAO,EAAE,CAAC,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,QAAQ,CAAA;IAC5C,CAAC;;AAGH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IACpD,MAAM,CAAU,QAAQ,GAAW,GAAG,qBAAqB,CAAC,QAAQ,cAAc,CAAA;IAEzF,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,gBAAgB,OAAO,EAAE,CAAC,CAAA;QAChC,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,qBAAqB;IACnD,MAAM,CAAU,QAAQ,GAAW,GAAG,qBAAqB,CAAC,QAAQ,aAAa,CAAA;IAExF,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,eAAe,OAAO,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,QAAQ,CAAA;IACxC,CAAC;;AAGH,MAAM,OAAO,aAAc,SAAQ,WAAW;IACrC,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,SAAS,CAAA;IAE1E,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,WAAW,OAAO,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAA;IACpC,CAAC;;AAGH,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAC1C,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,SAAS,CAAA;IAE1E,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,WAAW,OAAO,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;;AAGH,MAAM,OAAO,sBAAuB,SAAQ,kBAAkB;IACrD,MAAM,CAAU,QAAQ,GAAW,GAAG,kBAAkB,CAAC,QAAQ,WAAW,CAAA;IAEnF,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,aAAa,OAAO,EAAE,CAAC,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,QAAQ,CAAA;IAC7C,CAAC;;AAGH,cAAc,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;AAC9C,cAAc,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,CAAA;AAC5D,cAAc,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAA;AACxD,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;AACpD,cAAc,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAA;AAChD,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAA"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,MAAM,OAAO,WAAY,SAAQ,cAAc;IACtC,MAAM,CAAU,QAAQ,GAAW,aAAa,CAAA;IAEvD,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,OAAO,EAAE,CAAC,CAAA;IAClD,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,WAAW;IACjD,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,gBAAgB,CAAA;IAEjF,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAA;QAClC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC,QAAQ,CAAA;IAChD,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAC7C,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,YAAY,CAAA;IAE7E,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,cAAc,OAAO,EAAE,CAAC,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,QAAQ,CAAA;IAC5C,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IACpD,MAAM,CAAU,QAAQ,GAAW,GAAG,qBAAqB,CAAC,QAAQ,cAAc,CAAA;IAEzF,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,gBAAgB,OAAO,EAAE,CAAC,CAAA;QAChC,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,qBAAqB;IACnD,MAAM,CAAU,QAAQ,GAAW,GAAG,qBAAqB,CAAC,QAAQ,aAAa,CAAA;IAExF,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,eAAe,OAAO,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,QAAQ,CAAA;IACxC,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,WAAW;IACrC,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,SAAS,CAAA;IAE1E,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,WAAW,OAAO,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAA;IACpC,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAC1C,MAAM,CAAU,QAAQ,GAAW,GAAG,WAAW,CAAC,QAAQ,SAAS,CAAA;IAE1E,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,WAAW,OAAO,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,kBAAkB;IACrD,MAAM,CAAU,QAAQ,GAAW,GAAG,kBAAkB,CAAC,QAAQ,WAAW,CAAA;IAEnF,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,aAAa,OAAO,EAAE,CAAC,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,QAAQ,CAAA;IAC7C,CAAC;CACF;AAED,cAAc,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;AAC9C,cAAc,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,CAAA;AAC5D,cAAc,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAA;AACxD,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;AACpD,cAAc,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAA;AAChD,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAA"}

package/build/helper/types.d.ts

@@ -0,0 +1,13 @@
+import type { AuthMessage, CallMessage, EventMessage, Message } from '../types.js';
+/** Recognizes the kinds of socket message. */
+export interface SocketMessageHelper {
+    /** Whether a received value is a message; `nonSystem` also requires it (not) to be a system one. */
+    isMessage: <P, T extends Message<P>>(msg: string | T, nonSystem?: boolean) => msg is T;
+    /** Whether a message is an event (system events included); `system` also requires it (not) to be a system one. */
+    isEventMessage: <P>(msg: string | Message<P>, system?: boolean) => msg is EventMessage<P>;
+    /** Whether a message is a call. */
+    isCallMessage: <P extends any[]>(msg: string | Message<unknown>) => msg is CallMessage<P>;
+    /** Whether a message is an authentication one. */
+    isAuthMessage: <P>(msg: string | Message<P>) => msg is AuthMessage<P>;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/helper/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/helper/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAElF,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IAClC,oGAAoG;IACpG,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,KAAK,GAAG,IAAI,CAAC,CAAA;IACtF,kHAAkH;IAClH,cAAc,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,OAAO,KAAK,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAA;IACzF,mCAAmC;IACnC,aAAa,EAAE,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAA;IACzF,kDAAkD;IAClD,aAAa,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAA;CACtE"}

package/build/helper/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/helper/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/helper/types.ts"],"names":[],"mappings":""}

package/build/helper.d.ts

@@ -1,6 +1,9 @@
-import type { CallMessage, EventMessage, Message, AuthMessage } from './types.js';
+import type { EventMessage, Message } from './types.js';
+import type { SocketMessageHelper } from './helper/types.js';
+export declare const createSocketMessageHelper: () => SocketMessageHelper;
+export declare const socketMessageHelper: SocketMessageHelper;
+/** @deprecated compat:factory-refactor — use `socketMessageHelper.isMessage(…)` */
 export declare const isMessage: <P, T extends Message<P>>(msg: string | T, nonSystem?: boolean) => msg is T;
+/** @deprecated compat:factory-refactor — use `socketMessageHelper.isEventMessage(…)` */
 export declare const isEventMessage: <P>(msg: string | Message<P>, system?: boolean) => msg is EventMessage<P>;
-export declare const isCallMessage: <P extends any[]>(msg: string | Message<unknown>) => msg is CallMessage<P>;
-export declare const isAuthMessage: <P>(msg: string | Message<P>) => msg is AuthMessage<P>;
 //# sourceMappingURL=helper.d.ts.map

package/build/helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAEjF,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,GAAG,CAAC,EAAE,YAAY,OAAO,KAAG,GAAG,IAAI,CAEhB,CAAA;AAEjF,eAAO,MAAM,cAAc,GAAI,CAAC,EAAE,KAAK,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,OAAO,KAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAEzB,CAAA;AAE3E,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,GAAG,EAAE,EAAE,KAAK,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,KAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CACnD,CAAA;AAEjD,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,KAAK,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,KAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAC/B,CAAA"}
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAe,YAAY,EAAE,OAAO,EAAe,MAAM,YAAY,CAAA;AACjF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAwB5D,eAAO,MAAM,yBAAyB,QAAO,mBAgB5C,CAAA;AAED,eAAO,MAAM,mBAAmB,qBAA8B,CAAA;AAE9D,mFAAmF;AACnF,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,OAAO,MAAM,GAAG,CAAC,cAAc,OAAO,KAAG,GAAG,IAAI,CAAwD,CAAA;AAEzJ,wFAAwF;AACxF,eAAO,MAAM,cAAc,GAAI,CAAC,OAAO,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,WAAW,OAAO,KAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAuD,CAAA"}

package/build/helper.js

@@ -1,10 +1,4 @@
 import { MessageType } from './consts.js';
-export const isMessage = (msg, nonSystem) => typeof msg === 'object' && 'type' in msg && 'payload' in msg
-    && (nonSystem === undefined || nonSystem === (msg.type !== MessageType.System));
-export const isEventMessage = (msg, system) => isMessage(msg) && [MessageType.Event, MessageType.System].includes(msg.type)
-    && (system === undefined || system === (msg.type === MessageType.System));
-export const isCallMessage = (msg) => isMessage(msg) && msg.type === MessageType.Call;
-export const isAuthMessage = (msg) => isMessage(msg) && msg.type === MessageType.Auth;
 // export const prepareLongCalls = (connection: Connection, longTimeout = CALL_TIMEOUT * 10) => {
 //   const _connection = connection as WithLongCalls
 //   if (_connection[long_calls] == null) {
@@ -23,4 +17,18 @@ export const isAuthMessage = (msg) => isMessage(msg) && msg.type === MessageType
 // interface WithLongCalls extends Connection {
 //   [long_calls]: boolean
 // }
+export const createSocketMessageHelper = () => {
+    const isMessage = (msg, nonSystem) => typeof msg === 'object' && 'type' in msg && 'payload' in msg
+        && (nonSystem === undefined || nonSystem === (msg.type !== MessageType.System));
+    const isEventMessage = (msg, system) => isMessage(msg) && [MessageType.Event, MessageType.System].includes(msg.type)
+        && (system === undefined || system === (msg.type === MessageType.System));
+    const isCallMessage = (msg) => isMessage(msg) && msg.type === MessageType.Call;
+    const isAuthMessage = (msg) => isMessage(msg) && msg.type === MessageType.Auth;
+    return { isMessage, isEventMessage, isCallMessage, isAuthMessage };
+};
+export const socketMessageHelper = createSocketMessageHelper();
+/** @deprecated compat:factory-refactor — use `socketMessageHelper.isMessage(…)` */
+export const isMessage = (msg, nonSystem) => socketMessageHelper.isMessage(msg, nonSystem);
+/** @deprecated compat:factory-refactor — use `socketMessageHelper.isEventMessage(…)` */
+export const isEventMessage = (msg, system) => socketMessageHelper.isEventMessage(msg, system);
 //# sourceMappingURL=helper.js.map

package/build/helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.js","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAGzC,MAAM,CAAC,MAAM,SAAS,GAAG,CAA0B,GAAe,EAAE,SAAmB,EAAY,EAAE,CACnG,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG;OACzD,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;AAEjF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAI,GAAwB,EAAE,MAAgB,EAA0B,EAAE,CACtG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;OACzE,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;AAE3E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAkB,GAA8B,EAAyB,EAAE,CACtG,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAA;AAEjD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAI,GAAwB,EAAyB,EAAE,CAClF,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAA;AAGjD,iGAAiG;AACjG,oDAAoD;AACpD,2CAA2C;AAC3C,yCAAyC;AACzC,qDAAqD;AACrD,oDAAoD;AACpD,wCAAwC;AACxC,UAAU;AAEV,wDAAwD;AACxD,QAAQ;AACR,qCAAqC;AACrC,MAAM;AAEN,sBAAsB;AACtB,IAAI;AAEJ,yDAAyD;AACzD,+CAA+C;AAC/C,0BAA0B;AAC1B,IAAI"}
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAIzC,iGAAiG;AACjG,oDAAoD;AACpD,2CAA2C;AAC3C,yCAAyC;AACzC,qDAAqD;AACrD,oDAAoD;AACpD,wCAAwC;AACxC,UAAU;AAEV,wDAAwD;AACxD,QAAQ;AACR,qCAAqC;AACrC,MAAM;AAEN,sBAAsB;AACtB,IAAI;AAEJ,yDAAyD;AACzD,+CAA+C;AAC/C,0BAA0B;AAC1B,IAAI;AAEJ,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAwB,EAAE;IACjE,MAAM,SAAS,GAAG,CAA0B,GAAe,EAAE,SAAmB,EAAY,EAAE,CAC5F,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG;WACzD,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;IAEjF,MAAM,cAAc,GAAG,CAAI,GAAwB,EAAE,MAAgB,EAA0B,EAAE,CAC/F,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;WACzE,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;IAE3E,MAAM,aAAa,GAAG,CAAkB,GAA8B,EAAyB,EAAE,CAC/F,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAA;IAEjD,MAAM,aAAa,GAAG,CAAI,GAAwB,EAAyB,EAAE,CAC3E,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAA;IAEjD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,CAAA;AACpE,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,yBAAyB,EAAE,CAAA;AAE9D,mFAAmF;AACnF,MAAM,CAAC,MAAM,SAAS,GAAG,CAA0B,GAAe,EAAE,SAAmB,EAAY,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAO,GAAG,EAAE,SAAS,CAAC,CAAA;AAEzJ,wFAAwF;AACxF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAI,GAAwB,EAAE,MAAgB,EAA0B,EAAE,CAAC,mBAAmB,CAAC,cAAc,CAAI,GAAG,EAAE,MAAM,CAAC,CAAA"}

package/build/index.d.ts

@@ -1,4 +1,5 @@
 export type * from './types.js';
+export type * from './helper/types.js';
 export * from './consts.js';
 export * from './model.js';
 export * from './errors.js';

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,mBAAmB,YAAY,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,mBAAmB,YAAY,CAAA;AAC/B,mBAAmB,mBAAmB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}

package/build/model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAC2C,UAAU,EAEhE,MAAM,YAAY,CAAA;AAInB,eAAO,MAAM,qBAAqB,QAAO,UA+VxC,CAAA"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAC2C,UAAU,EAEhE,MAAM,YAAY,CAAA;AAOnB,eAAO,MAAM,qBAAqB,QAAO,UA+XxC,CAAA"}