@dotwire/client 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -1,3 +1,312 @@
-# Temporary Holding Version
+# @dotwire/client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+For coding agents adding dotwire to an application, see the [SDK integration guide](https://github.com/pasztor-mark/dotwire/blob/main/docs/SDK_AGENT_GUIDE.md).
+
+Official TypeScript/JavaScript client SDK for **dotwire**, the high-throughput, self-hosted real-time messaging infrastructure.
+
+[![npm version](https://img.shields.io/npm/v/@dotwire/client.svg)](https://www.npmjs.com/package/@dotwire/client)
+[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://github.com/pasztor-mark/dotwire)
+
+## Features
+
+- **Scoped Room Handles:** Fluid, object-oriented API via `client.room(roomId)`.
+- **Real-Time SignalR & NATS Fanout:** Sub-millisecond latency for message delivery, ephemeral typing, and presence.
+- **Intelligent Typing Controller:** Built-in keystroke throttling (`1000ms`), natural auto-stop timeouts (`3000ms`), and auto-expiring typing listeners (`3500ms`).
+- **Resilient Reconnection:** Automatic SignalR reconnect with automatic room group resubscription.
+- **Natural Request Timeouts:** Built-in `AbortSignal.timeout` protection on all network requests.
+- **System & Bot Message Filtering:** Dedicated listeners for system announcements vs. user chat.
+- **Zero-Dependency Core:** Light bundle size built for browsers, Next.js, React, Vue, Svelte, and Node.js.
+
+---
+
+## Installation
+
+```bash
+npm install @dotwire/client
+# or
+pnpm add @dotwire/client
+# or
+yarn add @dotwire/client
+```
+
+---
+
+## Quickstart
+
+```typescript
+import { DotwireClient } from '@dotwire/client';
+
+// 1. Initialize client with either tokenUrl (recommended: the SDK caches and
+//    refreshes the token itself) or a getAccessToken escape hatch.
+const client = new DotwireClient({
+  baseUrl: 'https://chat.yourdomain.com',
+  tokenUrl: '/api/auth/token', // GET, credentials included, expects `{ token }`
+  automaticReconnect: true,
+  autoStopTypingMs: 3000,
+  typingThrottleMs: 1000
+});
+
+// 2. Obtain a scoped room handle
+const room = client.room('a0000000-0000-0000-0000-000000000001');
+
+// 3. Subscribe to real-time events (pass `{ history: 50 }` to also fetch and
+//    deliver the latest page of history as part of subscribing)
+await room.subscribe();
+
+// 4. Listen for incoming messages
+const unsubMessage = room.onMessage((message) => {
+  console.log(`[${message.time}] #${message.seq} ${message.senderId}: ${message.content}`);
+});
+
+// 5. Send a message
+const ack = await room.sendMessage('Hello, world!');
+console.log(`Message persisted at stream sequence ${ack.seq}`);
+
+// 6. Fetch historical messages
+const history = await room.getHistory({ limit: 50 });
+console.log(`Loaded ${history.messages.length} messages (hasMore: ${history.hasMore})`);
+
+// Room membership is a list of user IDs. Resolve profiles in the host app.
+const participantIds = await room.getParticipants();
+
+// 7. Cleanup when finished
+unsubMessage();
+room.dispose();
+await client.disconnect();
+```
+
+---
+
+## Guide & Usage Examples
+
+### 1. Scoped Room Handle (`DotwireRoomHandle`)
+
+Working with rooms is centered around `DotwireRoomHandle`:
+
+```typescript
+const room = client.room('room-uuid');
+
+// Connect & join group
+await room.subscribe();
+
+// Leave room
+await room.unsubscribe();
+
+// Clean up all room listeners and auto-unsubscribe
+room.dispose();
+```
+
+---
+
+### 2. Message History & Gap-Fill Replay
+
+Fetch decrypted history from PostgreSQL/TimescaleDB with monotonic sequence pagination:
+
+```typescript
+// Fetch latest 50 messages
+const latest = await room.getHistory({ limit: 50 });
+
+// Paginate older messages before a sequence number
+const older = await room.getHistory({
+  beforeSeq: latest.messages[0].seq,
+  limit: 50
+});
+
+// Replay missed messages after a reconnection
+const missed = await room.getHistory({
+  afterSeq: lastKnownSeq,
+  limit: 100
+});
+```
+
+---
+
+### 3. Real-Time Typing Indicators
+
+The SDK includes intelligent throttling and auto-expiration so your UI never gets stuck showing a user typing:
+
+```typescript
+// Sending typing events from an input field
+function onUserKeystroke() {
+  // Automatically throttles network dispatch and auto-stops after 3s of inactivity
+  room.notifyTyping();
+}
+
+function onUserSubmit() {
+  // Immediately stops typing
+  room.stopTyping();
+}
+
+// Receiving typing notifications with auto-expiry
+const unsubTyping = room.onTypingWithExpiry((event) => {
+  if (event.isTyping) {
+    showTypingIndicator(event.userId);
+  } else {
+    hideTypingIndicator(event.userId);
+  }
+}, 3500);
+```
+
+---
+
+### 4. User Presence (Joins & Leaves)
+
+Tracks real-time participant changes coalesced by Dotwire's backend:
+
+```typescript
+const unsubPresence = room.onPresence((delta) => {
+  console.log('Joined:', delta.joined);
+  console.log('Left:', delta.left);
+});
+```
+
+---
+
+### 5. System & Bot Messages
+
+Separate automated notifications and maintenance notices from regular user chat:
+
+```typescript
+// Listen ONLY for system announcements
+room.onSystemMessage((message) => {
+  showSystemBanner(message.content);
+});
+
+// Listen ONLY for standard user messages
+room.onUserMessage((message) => {
+  appendUserChatMessage(message);
+});
+```
+
+---
+
+### 6. React / Next.js Hook Pattern
+
+Here is a recommended React hook pattern:
+
+```typescript
+import { useEffect, useState, useRef } from 'react';
+import { DotwireClient, DotwireRoomHandle, ConnectionState, RoomMessage } from '@dotwire/client';
+
+export function useChatRoom(roomId: string, fetchToken: () => Promise<string>) {
+  const [messages, setMessages] = useState<RoomMessage[]>([]);
+  const [connectionState, setConnectionState] = useState<ConnectionState>('disconnected');
+  const [typingUsers, setTypingUsers] = useState<string[]>([]);
+  const roomRef = useRef<DotwireRoomHandle | null>(null);
+
+  useEffect(() => {
+    let active = true;
+    const client = new DotwireClient({
+      baseUrl: process.env.NEXT_PUBLIC_DOTWIRE_URL || '',
+      getAccessToken: fetchToken,
+      automaticReconnect: true
+    });
+
+    const room = client.room(roomId);
+    roomRef.current = room;
+
+    client.onStateChange((state) => {
+      if (active) setConnectionState(state);
+    });
+
+    room.onMessage((message) => {
+      if (!active) return;
+      setMessages((prev) => [...prev, message]);
+    });
+
+    room.onTypingWithExpiry((event) => {
+      if (!active) return;
+      setTypingUsers((prev) =>
+        event.isTyping
+          ? (prev.includes(event.userId) ? prev : [...prev, event.userId])
+          : prev.filter((id) => id !== event.userId)
+      );
+    });
+
+    async function init() {
+      // `history` fetches the latest page and delivers each message through the
+      // onMessage listener above, so there is no separate setMessages call here.
+      await room.subscribe({ history: 50 });
+    }
+
+    init();
+
+    return () => {
+      active = false;
+      room.dispose();
+      client.dispose();
+    };
+  }, [roomId, fetchToken]);
+
+  return {
+    messages,
+    connectionState,
+    typingUsers,
+    sendMessage: (content: string) => roomRef.current?.sendMessage(content),
+    notifyTyping: () => roomRef.current?.notifyTyping(),
+    stopTyping: () => roomRef.current?.stopTyping()
+  };
+}
+```
+
+---
+
+## API Reference
+
+### `DotwireClient`
+
+| Method / Property | Return Type | Description |
+| :--- | :--- | :--- |
+| `new DotwireClient(options)` | `DotwireClient` | Initializes client with baseUrl, token factory, and options. |
+| `room(roomId)` | `DotwireRoomHandle` | Returns a scoped room handle for the specified room UUID. |
+| `connect()` | `Promise<void>` | Manually initiates the SignalR connection. |
+| `disconnect()` | `Promise<void>` | Closes the connection and leaves all rooms. |
+| `getConnectionState()` | `ConnectionState` | Returns `'connected'`, `'connecting'`, `'reconnecting'`, or `'disconnected'`. |
+| `onMessage(handler)` | `() => void` | Global listener for any message on subscribed rooms. Delivers `RoomMessage` (has `seq`; `replayed: true` during reconnect gap-fill). |
+| `onSystemMessage(handler)` | `() => void` | Global listener for system messages only. |
+| `onUserMessage(handler)` | `() => void` | Global listener for user messages only. |
+| `onMessageRetracted(handler)` | `() => void` | Global listener for redacted/retracted messages. |
+| `onMembershipRevoked(handler)` | `() => void` | Global listener fired when the user's membership in a room is revoked; the room is auto-unsubscribed. |
+| `onTyping(handler)` | `() => void` | Global listener for user typing notifications. |
+| `onPresence(handler)` | `() => void` | Global listener for presence changes. |
+| `onStateChange(handler)` | `() => void` | Subscribes to connection state transitions. |
+| `dispose()` | `void` | Cleans up all active room handles and disconnects. |
+
+Per-room seq dedupe (a bounded set of the last 1000 seen sequence numbers) and reconnect
+gap-fill (paging `getHistory({afterSeq, limit: gapFillPageSize})` after an automatic
+reconnect) happen internally; consumers just see `onMessage` fire once per new seq, with
+`replayed: true` on gap-fill deliveries.
+
+### `DotwireRoomHandle`
+
+| Method | Return Type | Description |
+| :--- | :--- | :--- |
+| `subscribe(options?)` | `Promise<HistoryPage \| undefined>` | Subscribes to room events. With `{ history: n }`, also fetches and delivers the latest `n` messages, returning that page. |
+| `unsubscribe()` | `Promise<void>` | Leaves the real-time group. |
+| `sendMessage(content)` | `Promise<SendAck>` | Sends a message to the room. Returns stream sequence and time. |
+| `getHistory(options)` | `Promise<HistoryPage>` | Retrieves paginated message history (`{ messages: RoomMessage[], hasMore }`). |
+| `notifyTyping()` | `Promise<void>` | Throttled typing trigger with automatic 3s auto-stop timer. |
+| `startTyping()` / `stopTyping()` | `Promise<void>` | Explicit typing state modifiers. |
+| `onMessage(handler)` | `() => void` | Room-scoped message listener. Returns unsubscribe function. |
+| `onSystemMessage(handler)` | `() => void` | Room-scoped system message listener. |
+| `onUserMessage(handler)` | `() => void` | Room-scoped user message listener. |
+| `onMessageRetracted(handler)` | `() => void` | Room-scoped retraction listener. |
+| `onMembershipRevoked(handler)` | `() => void` | Room-scoped revocation listener. |
+| `onTyping(handler)` | `() => void` | Room-scoped typing indicator listener. |
+| `onTypingWithExpiry(handler, ms)` | `() => void` | Room-scoped typing listener that auto-resets after inactivity. |
+| `onPresence(handler)` | `() => void` | Room-scoped presence update listener. |
+| `release()` | `void` | Cancels timers, unbinds listeners, and lets the client drop the handle, without leaving the room (for handles that share a subscription). |
+| `dispose()` | `void` | `release()`, then leaves the room. |
+
+### Errors
+
+Failed requests reject with a `DotwireClientError { status, kind, code?, reason?, retryAfterMs? }`,
+where `kind` is one of `BadRequest`, `Unauthorized`, `Forbidden`, `NotFound`, `PresendRejected`,
+`RateLimited`, `Unavailable`, or `Unknown` — the same kinds used by `Dotwire.Host` and
+`@dotwire/host`.
+
+---
+
+## License
+
+Apache-2.0