@yannajah/baileys 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 diezy clutch (diezyxhao-baileys, base of this package)
+Copyright (c) 2026 jexkpinkman (Mini App code ported from JexkCode-baileys; see LICENSE.jexkcode)
+Copyright (c) 2026 yannajah (modifications and packaging)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE.jexkcode

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 jexkpinkman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+# @yannajah/baileys
 
-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.
+WhatsApp Web library (Baileys fork, CommonJS, Node.js 20+) with `sock.sendMiniApp`.
+
+Based on `diezyxhao-baileys` 1.4.0 (MIT) with the Mini App feature ported from `JexkCode-baileys` (MIT). Original copyright and license notices are kept in `LICENSE`, `LICENSE.jexkcode` and `THIRD_PARTY_NOTICES.md`.
+
+## Install
+
+```bash
+npm install @yannajah/baileys
+```
+
+```js
+const { makeWASocket, useMultiFileAuthState } = require('@yannajah/baileys')
+```
+
+## Mini App
+
+```js
+await sock.sendMiniApp(jid, {
+  title: 'My Mini App',
+  body: 'Tap the button below',
+  url: 'https://myapp.example.com',          // CTA button
+  params: { ref: 'wa-bot' },                 // appended as ?ref=wa-bot
+  thumbnail: 'https://myapp.example.com/icon.png', // public URL or Buffer
+  // openWebview: true,                      // in-app webview button instead of cta_url
+  // flow: { id: '123456789', cta: 'Fill form', screen: 'WELCOME' }, // needs a published WhatsApp Flow
+  // secret: 'hmac-key', expiresIn: 300,     // sign + expire the opener link
+})
+```
+
+Helpers: `buildMiniAppContent`, `createMiniAppLink`, `parseMiniAppParams`, `verifyMiniAppRequest`, `parseMiniAppResponse`, `createNonceStore`, `buildFlowNavigate`, `buildFlowDataExchange`.
+
+Button rendering is decided by WhatsApp and depends on account type and app version. `npm run test:miniapp` checks message building offline.
+
+## Channels
+
+The developer channel is **not** auto-followed. To follow channels on connect, pass your own: `makeWASocket({ autoFollowChannels: ['<id>@newsletter'] })`.
+
+## Notes
+
+Includes other upstream features (buttons, carousels, channels, Telegram adapter, ...) unchanged from the base. Some upstream helpers (e.g. `reqPairing`, `checkWhatsApp`) can trigger verification requests to other numbers; do not use them on numbers you do not own.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,15 @@
+# Third-party notices
+
+`@yannajah/baileys` is a modified distribution of the projects below. Keep these notices when redistributing.
+
+- **Core**: `diezyxhao-baileys` 1.4.0 (MIT, (c) 2026 diezy clutch). Modified: see "Changes" below.
+- **Mini App feature**: `lib/Utils/mini-app.js` is ported (ESM -> CommonJS) from `@jexkcode/baileys` 1.3.1 (MIT, (c) 2026 jexkpinkman); its license is in `LICENSE.jexkcode`. The `externalAdReply` and `nativeExtraButton` additions in `lib/Utils/messages.js` also originate there.
+- Underlying protocol work: Baileys / WhiskeySockets (MIT).
+
+## Changes relative to diezyxhao-baileys 1.4.0
+1. `lib/Utils/mini-app.js`, `lib/Utils/mini-app.d.ts` (new).
+2. `lib/Utils/messages.js`: direct `externalAdReply` content key; extra native-flow buttons (`webview`, `flow`, `reminder`, `address`, `catalog`, ...).
+3. `lib/Socket/index.js`: adds `sock.sendMiniApp`.
+4. `lib/Utils/index.js`, `lib/Utils/index.d.ts`: export mini-app helpers.
+5. `lib/Socket/newsletter.js`: the developer's channel is no longer auto-followed by default (pass `autoFollowChannels: [...]` to opt in).
+6. Branding cleanup: removed the runtime banner and promotional contact lines from source headers; message-ID prefix changed to `YANNAJAH`; `disclaimerText` in MessageBuilder changed to `Yannajah`. Copyright lines were kept.