@antzsoft/chat-core 1.0.5 → 1.0.7

package/docs/integration-guide.html

@@ -132,7 +132,7 @@ li{margin-bottom:4px;color:#c8d0e0}
 
   <div class="section-label">What's New</div>
   <ul>
-    <li><a href="#whats-new">v1.0.5 Release Notes</a></li>
+    <li><a href="#whats-new">v1.0.7 Release Notes</a></li>
   </ul>
 
   <div class="section-label">Getting Started</div>
@@ -218,11 +218,11 @@ li{margin-bottom:4px;color:#c8d0e0}
   <h2>What's New</h2>
   <p style="color:var(--muted);font-size:13px;margin-bottom:20px">Version history and release notes. Click a version to expand.</p>
 
-  <!-- ── v1.0.5 (current) ── -->
-  <div class="wn-version" id="wn-105">
-    <div class="wn-header" onclick="toggleVersion('wn-105')">
+  <!-- ── v1.0.7 (current) ── -->
+  <div class="wn-version open" id="wn-107">
+    <div class="wn-header" onclick="toggleVersion('wn-107')">
       <div class="wn-title">
-        <span class="wn-ver">v1.0.5</span>
+        <span class="wn-ver">v1.0.7</span>
         <span class="wn-badge current">Current</span>
         <span class="wn-date">May 2026</span>
       </div>
@@ -230,8 +230,91 @@ li{margin-bottom:4px;color:#c8d0e0}
     </div>
     <div class="wn-body">
 
-      <div class="wn-item" id="wn-105-1">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-1')">
+      <div class="wn-item" id="wn-107-1">
+        <div class="wn-item-header" onclick="toggleItem('wn-107-1')">
+          <span class="wn-tag new">New</span>
+          <span class="wn-item-title"><code>deliveredTo</code> per-user delivery timestamps on all messages</span>
+          <span class="wn-chevron-sm">▾</span>
+        </div>
+        <div class="wn-item-body">
+          <p>All message responses (REST list, single fetch, send, edit, pin, star, search) now include a <code>deliveredTo</code> array alongside <code>readBy</code>, giving you per-user delivery timestamps for "message info" panels.</p>
+          <pre><code><span class="cm">// Message object — new fields</span>
+{
+  <span class="at">readBy</span>: [{ <span class="at">userId</span>: <span class="str">'user_2'</span>, <span class="at">readAt</span>: <span class="str">'2026-05-18T10:00:00.000Z'</span> }],
+  <span class="at">deliveredTo</span>: [{ <span class="at">userId</span>: <span class="str">'user_2'</span>, <span class="at">deliveredAt</span>: <span class="str">'2026-05-18T09:59:00.000Z'</span> }],
+}</code></pre>
+          <p>The <code>message_delivered</code> socket event payload has also changed — <code>deliveredTo</code> is now <code>Array&lt;{ userId, deliveredAt }&gt;</code> (top-level <code>deliveredAt</code> removed).</p>
+          <p><strong>Breaking change:</strong> <code>Message.readBy</code> type changed from <code>string[]</code> to <code>Array&lt;{ userId: string; readAt: string }&gt;</code>. Update any code reading <code>readBy</code> entries as plain strings.</p>
+          <p class="wn-ref">→ <a href="#step-realtime">Step 10 — Real-time Events</a> (<code>message_delivered</code> event)</p>
+        </div>
+      </div>
+
+      <div class="wn-item" id="wn-107-2">
+        <div class="wn-item-header" onclick="toggleItem('wn-107-2')">
+          <span class="wn-tag new">New</span>
+          <span class="wn-item-title">Audio attachment support for <code>.m4a</code> / <code>audio/x-m4a</code></span>
+          <span class="wn-chevron-sm">▾</span>
+        </div>
+        <div class="wn-item-body">
+          <p>The server now accepts <code>audio/m4a</code> and <code>audio/x-m4a</code> MIME types for audio attachments. Previously only <code>audio/mpeg</code>, <code>audio/ogg</code>, and <code>audio/wav</code> were accepted — uploads of <code>.m4a</code> files returned a <code>400</code> unsupported type error.</p>
+          <p><strong>Action required:</strong> No SDK change needed. If you were filtering <code>.m4a</code> files out in the client before upload, remove that restriction.</p>
+        </div>
+      </div>
+
+      <div class="wn-item" id="wn-107-3">
+        <div class="wn-item-header" onclick="toggleItem('wn-107-3')">
+          <span class="wn-tag new">New</span>
+          <span class="wn-item-title">Participant filter on <code>getMembers</code></span>
+          <span class="wn-chevron-sm">▾</span>
+        </div>
+        <div class="wn-item-body">
+          <p><code>getMembers</code> now accepts a <code>filter</code> parameter to control which participants are returned.</p>
+          <pre><code><span class="cm">// active only (default — same as before)</span>
+<span class="kw">await</span> conversationsApi.<span class="fn">getMembers</span>(conversationId);
+
+<span class="cm">// all participants including removed ones</span>
+<span class="kw">await</span> conversationsApi.<span class="fn">getMembers</span>(conversationId, { <span class="at">filter</span>: <span class="str">'all'</span> });
+
+<span class="cm">// only removed participants</span>
+<span class="kw">await</span> conversationsApi.<span class="fn">getMembers</span>(conversationId, { <span class="at">filter</span>: <span class="str">'deleted'</span> });</code></pre>
+          <p>Default is <code>'active'</code> — no behaviour change for existing callers.</p>
+          <p class="wn-ref">→ <a href="#step-convs">Step 6 — Conversations</a> (participants section)</p>
+        </div>
+      </div>
+
+      <div class="wn-item" id="wn-107-4">
+        <div class="wn-item-header" onclick="toggleItem('wn-107-4')">
+          <span class="wn-tag new">New</span>
+          <span class="wn-item-title">Message character limit — 10,000</span>
+          <span class="wn-chevron-sm">▾</span>
+        </div>
+        <div class="wn-item-body">
+          <p>Text message content is now capped at <strong>10,000 characters</strong>. Sending a message that exceeds this limit returns a <code>400</code> validation error.</p>
+          <p><strong>Action required:</strong> Add client-side length validation before send to give users immediate feedback rather than waiting for a server error.</p>
+          <pre><code><span class="kw">const</span> MAX_LENGTH = <span class="num">10000</span>;
+<span class="kw">if</span> (text.length > MAX_LENGTH) {
+  <span class="fn">showError</span>(<span class="str">`Message too long (${text.length}/${MAX_LENGTH})`</span>);
+  <span class="kw">return</span>;
+}</code></pre>
+        </div>
+      </div>
+
+    </div><!-- /.wn-body -->
+  </div><!-- /.wn-version -->
+
+  <!-- ── v1.0.6 ── -->
+  <div class="wn-version" id="wn-106">
+    <div class="wn-header" onclick="toggleVersion('wn-106')">
+      <div class="wn-title">
+        <span class="wn-ver">v1.0.6</span>
+        <span class="wn-date">May 2026</span>
+      </div>
+      <span class="wn-chevron">▲</span>
+    </div>
+    <div class="wn-body">
+
+      <div class="wn-item" id="wn-106-1">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-1')">
           <span class="wn-tag new">New</span>
           <span class="wn-item-title"><code>externalId</code> on all user responses</span>
           <span class="wn-chevron-sm">▾</span>
@@ -243,8 +326,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-2">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-2')">
+      <div class="wn-item" id="wn-106-2">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-2')">
           <span class="wn-tag new">New</span>
           <span class="wn-item-title">Single unified User List API</span>
           <span class="wn-chevron-sm">▾</span>
@@ -258,8 +341,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-3">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-3')">
+      <div class="wn-item" id="wn-106-3">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-3')">
           <span class="wn-tag new">New</span>
           <span class="wn-item-title">Single unified Conversation List API</span>
           <span class="wn-chevron-sm">▾</span>
@@ -273,8 +356,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-4">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-4')">
+      <div class="wn-item" id="wn-106-4">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-4')">
           <span class="wn-tag fix">Fix</span>
           <span class="wn-item-title">Attachment last-message content preview</span>
           <span class="wn-chevron-sm">▾</span>
@@ -286,8 +369,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-5">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-5')">
+      <div class="wn-item" id="wn-106-5">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-5')">
           <span class="wn-tag fix">Fix</span>
           <span class="wn-item-title">Avatar upload via <code>AntzChatClient</code></span>
           <span class="wn-chevron-sm">▾</span>
@@ -299,8 +382,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-6">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-6')">
+      <div class="wn-item" id="wn-106-6">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-6')">
           <span class="wn-tag fix">Fix</span>
           <span class="wn-item-title"><code>client.connect()</code> on React Native</span>
           <span class="wn-chevron-sm">▾</span>
@@ -312,8 +395,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-7">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-7')">
+      <div class="wn-item" id="wn-106-7">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-7')">
           <span class="wn-tag new">New</span>
           <span class="wn-item-title">Group icon — create &amp; update</span>
           <span class="wn-chevron-sm">▾</span>
@@ -330,8 +413,8 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
-      <div class="wn-item" id="wn-105-8">
-        <div class="wn-item-header" onclick="toggleItem('wn-105-8')">
+      <div class="wn-item" id="wn-106-8">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-8')">
           <span class="wn-tag new">New</span>
           <span class="wn-item-title">Scroll to first unread message</span>
           <span class="wn-chevron-sm">▾</span>
@@ -356,6 +439,53 @@ li{margin-bottom:4px;color:#c8d0e0}
         </div>
       </div>
 
+      <div class="wn-item" id="wn-106-9">
+        <div class="wn-item-header" onclick="toggleItem('wn-106-9')">
+          <span class="wn-tag new">New</span>
+          <span class="wn-item-title">Push notifications — device token registration (RN &amp; Web)</span>
+          <span class="wn-chevron-sm">▾</span>
+        </div>
+        <div class="wn-item-body">
+          <p>Push notification token registration is now fully documented and supported via <code>devicesApi.register()</code>. Both React Native (Expo and FCM) and Web (VAPID/Web Push) teams should register tokens immediately after login on every app launch.</p>
+
+          <h4>React Native — Expo</h4>
+          <pre><code><span class="kw">await</span> devicesApi.<span class="fn">register</span>({
+  deviceId,              <span class="cm">// stable UUID — generate once, store in SecureStore, never regenerate</span>
+  platform: <span class="str">'ios'</span>,       <span class="cm">// or 'android'</span>
+  provider: <span class="str">'expo'</span>,
+  token,                 <span class="cm">// from Notifications.getExpoPushTokenAsync()</span>
+  userAgent: <span class="str">`${Device.modelName} / ${Device.osName} ${Device.osVersion}`</span>,
+});</code></pre>
+
+          <h4>React Native — FCM (Firebase)</h4>
+          <pre><code><span class="kw">await</span> devicesApi.<span class="fn">register</span>({
+  deviceId,
+  platform: <span class="str">'android'</span>, provider: <span class="str">'fcm'</span>,
+  token,                 <span class="cm">// from messaging().getToken()</span>
+});
+<span class="cm">// Re-register whenever Firebase rotates the token</span>
+messaging().<span class="fn">onTokenRefresh</span>(<span class="kw">async</span> (t) => devicesApi.<span class="fn">register</span>({ deviceId, platform: <span class="str">'android'</span>, provider: <span class="str">'fcm'</span>, token: t }));</code></pre>
+
+          <h4>Web — VAPID / Web Push</h4>
+          <pre><code><span class="kw">await</span> devicesApi.<span class="fn">register</span>({
+  deviceId,              <span class="cm">// stable UUID — store in localStorage, never regenerate</span>
+  platform: <span class="str">'web'</span>, provider: <span class="str">'web-push'</span>,
+  endpoint: sub.endpoint,
+  p256dh:   <span class="fn">b64</span>(sub.<span class="fn">getKey</span>(<span class="str">'p256dh'</span>)),
+  auth:     <span class="fn">b64</span>(sub.<span class="fn">getKey</span>(<span class="str">'auth'</span>)),
+  userAgent: navigator.userAgent,
+});</code></pre>
+
+          <p><strong>Key rules for all platforms:</strong></p>
+          <ul style="margin:4px 0 8px 18px;font-size:13px;color:#c8d0e0;line-height:2">
+            <li>Call <code>register()</code> on <strong>every app launch after login</strong> — the call is an upsert, safe to repeat.</li>
+            <li>Call <code>devicesApi.remove(deviceId)</code> on logout to stop push immediately.</li>
+            <li>Never regenerate <code>deviceId</code> — if lost, the old token record becomes an orphan.</li>
+          </ul>
+          <p class="wn-ref">→ <a href="#step-push">Step 17 — Push Notifications</a> for complete code, token lifecycle tables, and service worker setup (web)</p>
+        </div>
+      </div>
+
     </div><!-- /.wn-body -->
   </div><!-- /.wn-version -->
 
@@ -1395,12 +1525,12 @@ socket.<span class="fn">on</span>(<span class="str">'message_deleted'</span>, (e
       </tr>
       <tr>
         <td><code>'message_delivered'</code></td>
-        <td>A single message you sent was delivered to all active recipients</td>
+        <td>A single message you sent was delivered to all active recipients. Payload: <code>{ messageId, conversationId, deliveredTo: Array&lt;{ userId, deliveredAt }&gt; }</code></td>
         <td><strong>Chat detail screen</strong> — add on mount, remove on unmount.</td>
       </tr>
       <tr>
         <td><code>'messages_delivered'</code></td>
-        <td>Batch delivery catch-up when a recipient comes online</td>
+        <td>Batch delivery catch-up when a recipient comes online. Payload: <code>{ conversationId, messageIds[], deliveredTo: string, deliveredAt }</code></td>
         <td><strong>Chat detail screen</strong> — add on mount, remove on unmount.</td>
       </tr>
       <tr>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antzsoft/chat-core",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Platform-agnostic core for Antz Chat — API, socket, stores, types. Works in browser, React Native (Expo or bare), and Node.js.",
   "author": "Antz",
   "license": "MIT",