@n4tzz/n4lyx 2.7.1 → 2.7.3

package/README.MD

@@ -2,13 +2,14 @@
 
 > WhatsApp Web API — multi-device, TypeScript-first, built different.
 
-[![npm](https://img.shields.io/npm/v/n4lyx?color=black&labelColor=000)](https://npmjs.com/package/n4lyx)
+[![npm](https://img.shields.io/npm/v/@n4tzz/n4lyx?color=black&labelColor=000)](https://npmjs.com/package/@n4tzz/n4lyx)
 [![license](https://img.shields.io/badge/license-MIT-black?labelColor=000)](LICENSE)
-[![downloads](https://img.shields.io/npm/dm/n4lyx?color=black&labelColor=000)](https://npmjs.com/package/n4lyx)
+[![downloads](https://img.shields.io/npm/dm/@n4tzz/n4lyx?color=black&labelColor=000)](https://npmjs.com/package/@n4tzz/n4lyx)
+[![node](https://img.shields.io/badge/node-%3E%3D20-black?labelColor=000)](package.json)
 
 ---
 
-**n4lyx** is a WhatsApp Web API library built for real projects. Proper `@lid → @pn` resolution, full multi-device support, clean TypeScript API. Fast, minimal, no bloat.
+**n4lyx** is a WhatsApp Web API library built for real projects. Proper `@lid → @pn` resolution, full multi-device support, clean TypeScript API. Fast, minimal, no bloat. Ships with exclusive features like tag-all and group status v2 that upstream doesn't have.
 
 > Not affiliated with WhatsApp Inc. Don't spam. Don't abuse. You're responsible for how you use this.
 
@@ -17,15 +18,13 @@
 ## Install
 
 ```bash
-npm i n4lyx
-# or latest build
-npm i n4lyx@latest
+npm i @n4tzz/n4lyx
 ```
 
 ```js
-const { default: makeWASocket } = require('n4lyx')
+const { default: makeWASocket } = require('@n4tzz/n4lyx')
 // ESM
-import makeWASocket from 'n4lyx'
+import makeWASocket from '@n4tzz/n4lyx'
 ```
 
 ---
@@ -33,7 +32,11 @@ import makeWASocket from 'n4lyx'
 ## Quick Start
 
 ```js
-const { default: makeWASocket, DisconnectReason, useMultiFileAuthState } = require('n4lyx')
+const {
+  default: makeWASocket,
+  DisconnectReason,
+  useMultiFileAuthState
+} = require('@n4tzz/n4lyx')
 const { Boom } = require('@hapi/boom')
 
 async function connect() {
@@ -49,6 +52,8 @@ async function connect() {
     if (connection === 'close') {
       const code = (lastDisconnect?.error as Boom)?.output?.statusCode
       if (code !== DisconnectReason.loggedOut) connect()
+    } else if (connection === 'open') {
+      console.log('connected')
     }
   })
 
@@ -72,7 +77,7 @@ connect()
 ### QR Code
 
 ```js
-const { default: makeWASocket, Browsers } = require('n4lyx')
+const { default: makeWASocket, Browsers } = require('@n4tzz/n4lyx')
 
 const sock = makeWASocket({
   browser: Browsers.ubuntu('n4lyx'),
@@ -102,7 +107,7 @@ if (!sock.authState.creds.registered) {
 ### Persist Auth
 
 ```js
-const { useMultiFileAuthState } = require('n4lyx')
+const { useMultiFileAuthState } = require('@n4tzz/n4lyx')
 
 const { state, saveCreds } = await useMultiFileAuthState('auth')
 const sock = makeWASocket({ auth: state })
@@ -130,7 +135,6 @@ Required for group-heavy bots. Cuts down repeated API calls significantly.
 
 ```js
 const NodeCache = require('node-cache')
-
 const groupCache = new NodeCache({ stdTTL: 5 * 60, useClones: false })
 
 const sock = makeWASocket({
@@ -171,7 +175,7 @@ const sock = makeWASocket({ markOnlineOnConnect: false })
 n4lyx doesn't ship a default persistent store. A basic in-memory store is available for local dev and testing — not recommended for production.
 
 ```js
-const { makeInMemoryStore } = require('n4lyx')
+const { makeInMemoryStore } = require('@n4tzz/n4lyx')
 
 const store = makeInMemoryStore({})
 store.readFromFile('./store.json')
@@ -215,6 +219,41 @@ await sock.sendMessage(jid, {
 })
 ```
 
+### Tag All — n4lyx exclusive
+
+Mention every member in a group. Automatically fetches participant list — no manual work.
+
+```js
+// Tag all members
+await sock.sendMessage(jid, {
+  text: '@everyone listen up',
+  tagAll: true
+})
+
+// Tag admins only
+await sock.sendMessage(jid, {
+  text: 'admins only',
+  tagAll: true,
+  tagAllScope: 'admins'
+})
+
+// Tag non-admins only
+await sock.sendMessage(jid, {
+  text: 'members',
+  tagAll: true,
+  tagAllScope: 'non_admins'
+})
+```
+
+`tagAllScope` options: `'all'` (default) | `'admins'` | `'non_admins'`
+
+You can also get the jid list directly:
+
+```js
+const jids = await sock.groupTagAll(groupJid, 'all')
+// returns: ['628XXX@s.whatsapp.net', ...]
+```
+
 ### Forward
 
 ```js
@@ -326,7 +365,7 @@ npm i link-preview-js
 
 ```js
 await sock.sendMessage(jid, {
-  text: 'check this out: https://npmjs.com/package/n4lyx'
+  text: 'check this out: https://npmjs.com/package/@n4tzz/n4lyx'
 })
 ```
 
@@ -351,7 +390,7 @@ await sock.sendMessage(jid, {
 ## Downloading Media
 
 ```js
-import { downloadMediaMessage, getContentType } from 'n4lyx'
+import { downloadMediaMessage, getContentType } from '@n4tzz/n4lyx'
 import { createWriteStream } from 'fs'
 
 sock.ev.on('messages.upsert', async ({ messages: [m] }) => {
@@ -476,6 +515,9 @@ await sock.groupToggleEphemeral(jid, 86400)
 // Add mode
 await sock.groupMemberAddMode(jid, 'all_member_add') // or 'admin_add'
 
+// Join approval mode
+await sock.groupJoinApprovalMode(jid, 'on') // or 'off'
+
 // Join requests
 const requests = await sock.groupRequestParticipantsList(jid)
 await sock.groupRequestParticipantsUpdate(jid, ['jid@s.whatsapp.net'], 'approve') // or 'reject'
@@ -484,6 +526,36 @@ await sock.groupRequestParticipantsUpdate(jid, ['jid@s.whatsapp.net'], 'approve'
 const all = await sock.groupFetchAllParticipating()
 ```
 
+### Group Status V2 — n4lyx exclusive
+
+Extended group status with full metadata control.
+
+```js
+// Set group status v2
+await sock.groupSetStatusV2(jid, {
+  duration: 86400,       // seconds (default: 86400 = 24h)
+  allowReply: true,      // allow members to reply (default: true)
+  allowReaction: true,   // allow reactions (default: true)
+  visibility: 'all'      // 'all' | 'admin' (default: 'all')
+})
+
+// Get current group status v2 settings
+const settings = await sock.groupGetStatusV2(jid)
+console.log(settings)
+// { duration: 86400, allowReply: true, allowReaction: true, visibility: 'all' }
+
+// Send message as group status v2
+await sock.sendMessage(jid, {
+  text: 'group announcement',
+  groupStatusV2: {
+    duration: 604800,     // 7 days
+    allowReply: false,
+    allowReaction: true,
+    visibility: 'all'
+  }
+})
+```
+
 ---
 
 ## Presence
@@ -571,7 +643,6 @@ await sock.removeProfilePicture(jid)
 ## Broadcast & Stories
 
 ```js
-// Send to story / broadcast list
 await sock.sendMessage(
   'status@broadcast',
   { image: { url: url }, caption: 'caption' },
@@ -627,7 +698,6 @@ sock.ev.on('messages.update', async (events) => {
 ## Low-Level: WebSocket Callbacks
 
 ```js
-// Intercept raw WA frames
 sock.ws.on('CB:edge_routing', (node) => { })
 sock.ws.on('CB:edge_routing,id:abcd', (node) => { })
 sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node) => { })
@@ -660,15 +730,31 @@ const sock = makeWASocket({ logger: P({ level: 'debug' }) })
 | `getDevice(msg)`              | Returns sender's device info         |
 | `makeCacheableSignalKeyStore` | Speeds up auth key store operations  |
 | `downloadContentFromMessage`  | Downloads raw content from a message |
+| `fetchLatestN4lyxVersion`     | Fetches latest n4lyx version from npm |
+| `fetchLatestWaWebVersion`     | Fetches latest WA Web version        |
+
+---
+
+## n4lyx Exclusive Features
+
+| Feature | Description |
+|---|---|
+| `tagAll` in `sendMessage` | Auto-mention all/admins/non-admins in a group |
+| `groupTagAll(jid, scope)` | Get list of participant jids by scope |
+| `groupSetStatusV2(jid, opts)` | Set group status v2 with full metadata |
+| `groupGetStatusV2(jid)` | Get current group status v2 settings |
+| `N4lyxMeta` in proto | Internal message metadata (version, session, timestamp) |
+| `GroupStatusV2Message` in proto | Extended group status message type |
+| `TagAllMessage` in proto | Tag-all message type with scope support |
 
 ---
 
 ## Optional Dependencies
 
 ```bash
-npm i jimp           # or sharp — thumbnail generation
-npm i link-preview-js  # link previews in text messages
-npm i qrcode-terminal  # QR rendering in terminal
+npm i jimp              # or sharp — thumbnail generation
+npm i link-preview-js   # link previews in text messages
+npm i qrcode-terminal   # QR rendering in terminal
 ```
 
 Video thumbnails require `ffmpeg` on your system.

package/WAProto/WAProto.proto

@@ -537,6 +537,128 @@ message NoiseCertificate {
 }
 
 
+// ─── CLIENT PAYLOAD ──────────────────────────────────────────
+
+message ClientPayload {
+    optional uint64      username      = 1;
+    optional bool        passive       = 3;
+    optional UserAgent   userAgent     = 5;
+    optional WebInfo     webInfo       = 6;
+    optional ConnectType connectType   = 8;
+    optional ConnectReason connectReason = 9;
+    optional bytes       shards        = 11;
+    optional DNSSource   dnsSource     = 12;
+    optional uint32      device        = 15;
+    optional DevicePairingRegistrationData devicePairingData = 16;
+    optional bool        pull          = 17;
+    optional bool        recoverFromCompanionSession = 19;
+    optional bool        recoverFromSessionPairSignedLtkMessage = 20;
+    optional string      productType   = 21;
+    optional bool        fidoBrowserEnabled = 22;
+    optional bool        iosPhoneNumberMigration = 23;
+    optional bool        lidDbMigrated = 24;
+
+    enum ConnectReason {
+        PUSH         = 0;
+        USER_ACTIVATED = 1;
+        SCHEDULED    = 2;
+        ERROR_RECONNECT = 3;
+        NETWORK_SWITCH = 4;
+        PING_RECONNECT = 5;
+    }
+    enum ConnectType {
+        CELLULAR_UNKNOWN = 0;
+        WIFI_UNKNOWN     = 1;
+        CELLULAR_EDGE    = 100;
+        CELLULAR_IDEN    = 101;
+        CELLULAR_UMTS    = 102;
+        CELLULAR_EVDO    = 103;
+        CELLULAR_GPRS    = 104;
+        CELLULAR_HSDPA   = 105;
+        CELLULAR_HSUPA   = 106;
+        CELLULAR_HSPA    = 107;
+        CELLULAR_CDMA    = 108;
+        CELLULAR_1XRTT   = 109;
+        CELLULAR_EHRPD   = 110;
+        CELLULAR_LTE     = 111;
+        CELLULAR_HSPAP   = 112;
+        CELLULAR_NR      = 113;
+    }
+
+    message DevicePairingRegistrationData {
+        optional bytes eRegid   = 1;
+        optional bytes eKeytype = 2;
+        optional bytes eIdent   = 3;
+        optional bytes eSkeyId  = 4;
+        optional bytes eSkeyVal = 5;
+        optional bytes eSkeySig = 6;
+        optional bytes buildHash = 7;
+        optional bytes deviceProps = 8;
+    }
+
+    message DNSSource {
+        optional string dnsMethod = 1;
+        optional bool   appCached = 2;
+    }
+
+    message UserAgent {
+        optional Platform       platform           = 1;
+        optional AppVersion     appVersion         = 3;
+        optional string         mcc                = 4;
+        optional string         mnc                = 5;
+        optional string         osVersion          = 6;
+        optional string         manufacturer       = 7;
+        optional string         device             = 8;
+        optional string         osBuildNumber      = 9;
+        optional string         phoneId            = 10;
+        optional ReleaseChannel releaseChannel     = 11;
+        optional string         localeLanguageIso6391 = 12;
+        optional string         localeCountryIso31661Alpha2 = 13;
+        optional string         deviceBoard        = 14;
+
+        message AppVersion {
+            optional uint32 primary   = 1;
+            optional uint32 secondary = 2;
+            optional uint32 tertiary  = 3;
+            optional uint32 quaternary = 4;
+            optional uint32 quinary   = 5;
+        }
+        enum Platform {
+            ANDROID      = 0;
+            IOS          = 1;
+            WINDOWS_PHONE = 2;
+            BLACKBERRY   = 3;
+            BLACKBERRY10 = 4;
+            WEB          = 5;
+            PORTAL       = 7;
+            FBLITE_ANDROID = 9;
+            MLITE_ANDROID  = 11;
+            IPAD           = 12;
+            FBLITE_IOS     = 16;
+            MLITE_IOS      = 17;
+            OCULUS_MSG     = 18;
+            OCULUS_CALL    = 19;
+            MILAN          = 20;
+            NIOS           = 21;
+        }
+        enum ReleaseChannel { RELEASE = 0; BETA = 1; ALPHA = 2; NIGHTLY = 3; }
+    }
+
+    message WebInfo {
+        optional string      webdPayload    = 1;
+        optional WebSubPlatform webSubPlatform = 2;
+
+        enum WebSubPlatform {
+            WEB_BROWSER = 0;
+            APP_STORE   = 1;
+            WIN_STORE   = 2;
+            DARWIN      = 3;
+            WIN32       = 4;
+        }
+    }
+}
+
+
 // ─── CHAT ────────────────────────────────────────────────────
 
 message ChatLockSettings {