@yemo-dev/yebail 1.0.0

package/README.md

@@ -0,0 +1,141 @@
+# yebail
+
+**yebails** is a high-performance, WebSocket-based WhatsApp Web API library. It is a specialized distribution of Baileys, optimized for stability and automated version tracking.
+
+> [!TIP]
+> This version is maintained with an **Auto-Update** system that tracks the latest WhatsApp Web revisions to ensure continuous compatibility.
+
+## Important Note
+
+This README is temporary. A new guide is currently in development and this file will be replaced.
+
+## Disclaimer
+
+This project is not affiliated with WhatsApp. Do not spam or use the library in ways that violate WhatsApp terms. Use at your own discretion.
+
+## Install
+
+From npm:
+
+```bash
+npm install yebails
+```
+
+From GitHub:
+
+```bash
+npm install github:yemo-dev/baileys
+```
+
+## Import
+
+After installing from GitHub, const {
+    default: makeWASocket,
+    DisconnectReason,
+    useMultiFileAuthState,
+    fetchLatestWaWebVersion
+} = require('@yemo-dev/yebail')
+
+From a local clone:
+
+```js
+const makeWASocket = require('./lib').default
+```
+
+TypeScript / ESM depends on your bundler.
+
+## Complete send-message examples per feature
+
+See **[EXAMPLES.md](./EXAMPLES.md)** — text, buttons, list, templates, **interactive** (quick reply, URL, copy, call, catalog, **PIX `payment_info`**, **`review_and_pay`**, single select, webview), media, polls, location, contacts, orders/products, payments, pin/keep, and more.
+
+## Quick start
+
+```ts
+import makeWASocket from 'yebail'
+
+const sock = makeWASocket({
+  printQRInTerminal: true
+})
+
+sock.ev.on('creds.update', () => {
+  /* persist auth */
+})
+```
+
+### Authentication storage (filesystem, SQLite, cloud DB)
+
+yebails does **not** mandate where session data lives. Credentials and Signal keys are exposed as JSON via the same `state` / `saveCreds` API whether you use files, SQLite, or a remote database.
+
+| API | Use case |
+| --- | --- |
+| `useMultiFileAuthState(folder)` | Default: one JSON file per key on local disk (same as classic Baileys). |
+| `useSqliteAuthState(pathToDb)` | Single local `.db` file (requires optional `better-sqlite3`). |
+| `useCustomAuthState(adapter)` | **Any** backend: implement `get` / `set` / `remove` for string keys and JSON string values — Redis, MongoDB, Postgres, Supabase, Firebase, your own HTTP API, etc. |
+
+`useCustomAuthState` keys match logical filenames (`creds.json`, `session-….json`, …); `fixAuthStorageKey` applies the same `/` → `__` and `:` → `-` normalization as the file backend.
+
+For **cloud** storage, encrypt sensitive payloads at rest and restrict access to the credential namespace. Longer examples (Redis, HTTP, SQLite install) are in **[EXAMPLES.md](./EXAMPLES.md#authentication--database-persistence)**.
+
+## Index
+
+- [Code examples](./EXAMPLES.md)
+- [Authentication storage (filesystem, SQLite, cloud DB)](#authentication-storage-filesystem-sqlite-cloud-db)
+- [Country code and MCC](#country-code-and-mcc-mobile-country-code)
+- [LID and addressing](#lid-and-addressing)
+- [Import](#import)
+- [Events](#events)
+- [Sending messages](#sending-messages)
+- [Modify messages](#modify-messages)
+- [Newsletter](#newsletter)
+- [Communities](#communities)
+
+### Country code and MCC (mobile country code)
+
+`DEFAULT_CONNECTION_CONFIG` includes `countryCode` (ISO 3166-1 alpha-2, default `US`). The client `UserAgent` `mcc` field is filled using the bundled `phonenumber-mcc.json` mapping: the international calling code is resolved with `libphonenumber-js` (`getCountryCallingCode`), then the MCC is read from `PHONENUMBER_MCC`.
+
+Override explicitly with socket config `mcc` (string or number, digits only normalized to 3 characters). Export `PHONENUMBER_MCC` and `getMccForCountryIso2(iso2)` from the package defaults for custom use.
+
+### LID and addressing
+
+Message keys expose LID-related fields for bots and middleware:
+
+| Field | Role |
+| --- | --- |
+| `key.senderLid` | Sender LID from stanza when present |
+| `key.participantLid` | Group participant LID when present |
+| `key.lid` | Alias: `senderLid \|\| participantLid` |
+| `key.addressingMode` | `lid` or `pn` derived from stanza |
+| `key.remoteJidAlt` | Alternate JID for 1:1 (e.g. PN when chat is LID-addressed) |
+| `key.participantAlt` | Alternate JID for groups (mapped PN/LID context) |
+
+Decryption uses `signalRepository.lidMapping` when available: PN/LID pairs from envelopes and `LID_MIGRATION_MAPPING_SYNC` are stored, sessions can migrate PN to LID, and the event `lid-mapping.update` is emitted with `{ lid, pn }` after migration sync.
+
+Hosted identifiers (`@hosted`, `@hosted.lid`) are recognized in JID utilities and binary decoding.
+
+### Events
+
+Common `sock.ev` events:
+
+- `messages.upsert`, `messages.update`, `messages.reaction`
+- `groups.update`, `group-participants.update`
+- `creds.update`, `call`
+- `lid-mapping.update`
+- `messaging-history.set`, `chats.phoneNumberShare`
+
+Placeholder resend (unavailable messages) caches metadata by message id, merges PDO responses without a delayed duplicate `messages.upsert`, and avoids the previous `PEER_DATA` / `MESSAGE_EDIT` switch fall-through bug.
+
+### Sending messages
+
+Use `sock.sendMessage(jid, content, options)`. Details and per-payload examples are in **[EXAMPLES.md](./EXAMPLES.md)**.
+
+### Modify messages
+
+Send payload keys: `delete`, `edit`, `pin`, `keep`.
+
+### Newsletter
+
+Socket methods include: `subscribeNewsletterUpdates`, `newsletterReactionMode`, `newsletterUpdateDescription`, `newsletterUpdateName`, `newsletterUpdatePicture`, `newsletterRemovePicture`, `newsletterFollow`, `newsletterUnfollow`, `newsletterMute`, `newsletterUnmute`, `newsletterCreate`, `newsletterMetadata`, `newsletterAdminCount`, `newsletterChangeOwner`, `newsletterDemote`, `newsletterDelete`, `newsletterReactMessage`, `newsletterFetchMessages`, `newsletterFetchUpdates`.
+
+### Communities
+
+Socket methods include: `communityMetadata`, `communityCreate`, `communityCreateGroup`, `communityLeave`, `communityUpdateSubject`, `communityLinkGroup`, `communityUnlinkGroup`, `communityFetchLinkedGroups`, `communityRequestParticipantsList`, `communityRequestParticipantsUpdate`, `communityParticipantsUpdate`, `communityUpdateDescription`, `communityInviteCode`, `communityRevokeInvite`, `communityAcceptInvite`, `communityRevokeInviteV4`, `communityAcceptInviteV4`, `communityGetInviteInfo`, `communityToggleEphemeral`, `communitySettingUpdate`, `communityMemberAddMode`, `communityJoinApprovalMode`.

package/WAProto/GenerateStatics.sh

@@ -0,0 +1,4 @@
+yarn pbjs -t static-module -w commonjs -o ./WAProto/index.js ./WAProto/WAProto.proto;
+yarn pbts -o ./WAProto/index.d.ts ./WAProto/index.js;
+
+#protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_opt=env=node,useOptionals=true,forceLong=long --ts_proto_out=. ./src/Binary/WAMessage.proto;