@japofc/baileys 2.1.0

package/lib/Socket/username.d.ts

@@ -0,0 +1,82 @@
+import type { makeCommunitiesSocket } from './communities.js';
+
+/** Mex query IDs captured from live WA Web sessions (may rotate with WA updates). */
+export interface UsernameQueryIds {
+    CHECK: string;
+    CHECK_MULTI: string;
+    SET: string;
+    GET: string;
+    GET_RECOMMENDATIONS: string;
+    PIN_SET: string;
+}
+export declare const USERNAME_QUERY_IDS: UsernameQueryIds;
+/** Type twin of the const above (lets `import('…').USERNAME_QUERY_IDS` resolve in type position). */
+export type USERNAME_QUERY_IDS = UsernameQueryIds;
+
+export interface UsernameCheckResult {
+    SUCCESS: 'SUCCESS';
+    INVALID: 'INVALID';
+}
+export declare const USERNAME_CHECK_RESULT: UsernameCheckResult;
+/** Type twin of the const above. */
+export type USERNAME_CHECK_RESULT = UsernameCheckResult;
+
+export interface UsernameSource {
+    FB: 'FB';
+    IG: 'IG';
+    USER_INPUT: 'USER_INPUT';
+    SUGGESTION: 'SUGGESTION';
+}
+export declare const USERNAME_SOURCE: UsernameSource;
+/** Type twin of the const above. */
+export type USERNAME_SOURCE = UsernameSource;
+
+export interface SetUsernameOptions {
+    source?: string;
+    sessionId?: string;
+    pin?: string;
+    reserved?: boolean;
+}
+
+export interface CheckUsernameResult {
+    available: boolean;
+    username: string;
+    suggestions?: any[];
+    rejectionReasons?: any[];
+    suggestionsEligible?: boolean;
+}
+
+export interface FoundUsernameUser {
+    jid: string;
+    contact: boolean;
+}
+
+/**
+ * WhatsApp Username socket layer: check, set, pin, find, and recommend
+ * usernames. (Method list mirrors the makeWASocket return type in
+ * Socket/index.d.ts — keep both in sync.)
+ */
+export interface UsernameSocketMethods {
+    /** Check username availability (with suggestions when taken). */
+    checkUsername: (username: string, includeSuggestions?: boolean) => Promise<CheckUsernameResult>;
+    /** Check multiple usernames at once. */
+    checkUsernameMulti: (usernames: string[]) => Promise<any>;
+    /** Set own username. */
+    setUsername: (username: string, options?: SetUsernameOptions) => Promise<any>;
+    /** Reserve a username (WA 2026 reservation flow — same endpoint, `reserved: true`). */
+    reserveUsername: (username: string, options?: SetUsernameOptions) => Promise<any>;
+    /** Delete / unset own username. */
+    deleteUsername: () => Promise<any>;
+    /** Get own username (null when unset). */
+    getMyUsername: () => Promise<string | null>;
+    /** Pin/unpin username (requires PIN). */
+    setUsernamePin: (pin: string) => Promise<any>;
+    /** Find a user by username (USync). Null when not found. */
+    findUserByUsername: (username: string, pin?: string) => Promise<FoundUsernameUser | null>;
+    /** Fetch usernames of known contacts (USync). */
+    fetchContactUsernames: (...jids: string[]) => Promise<any[]>;
+    /** Get username recommendations. */
+    getUsernameRecommendations: (source?: string | null) => Promise<any>;
+}
+
+export declare const makeUsernameSocket: (config: any) => ReturnType<typeof makeCommunitiesSocket> & UsernameSocketMethods;

package/lib/Socket/username.js

@@ -0,0 +1,159 @@
+import { USyncQuery, USyncUser } from '../WAUSync/index.js';
+import { makeCommunitiesSocket } from './communities.js';
+import { executeWMexQuery } from './mex.js';
+
+// JAP@Socket ---
+// WhatsApp Username socket layer: check, set, pin, find, and recommend usernames.
+// Query IDs below are captured from live WA Web sessions and may rotate with
+// WA updates — re-capture via the proto-extract tool if a call starts failing
+// with an "unexpected response structure" Boom.
+export const USERNAME_QUERY_IDS = {
+    CHECK: '26124072630599520', // UsernameCheck
+    CHECK_MULTI: '27134626522840290', // UsernameCheckMulti
+    SET: '27108705368767936', // UsernameSet
+    GET: '32618050064506056', // UsernameGet
+    GET_RECOMMENDATIONS: '26077456248616956', // UsernameGetRecommendationsQuery
+    PIN_SET: '25529696019976770' // UsernamePinSet
+};
+
+export const USERNAME_CHECK_RESULT = {
+    SUCCESS: 'SUCCESS',
+    INVALID: 'INVALID'
+};
+
+export const USERNAME_SOURCE = {
+    FB: 'FB',
+    IG: 'IG',
+    USER_INPUT: 'USER_INPUT',
+    SUGGESTION: 'SUGGESTION'
+};
+
+export const makeUsernameSocket = (config) => {
+    const sock = makeCommunitiesSocket(config);
+    const { query, generateMessageTag, executeUSyncQuery } = sock;
+
+    /** Internal helper — wraps executeWMexQuery with this socket's query/tag */
+    const mexQuery = (variables, queryId, dataPath) => executeWMexQuery(variables, queryId, dataPath, query, generateMessageTag);
+
+    // 1. Check username availability
+    const checkUsername = async (username, includeSuggestions = true) => {
+        if (!USERNAME_QUERY_IDS.CHECK) {
+            throw new Error('Username CHECK query_id not configured — capture a live WA session to obtain it');
+        }
+        const data = await mexQuery({ username, include_suggestions: includeSuggestions }, USERNAME_QUERY_IDS.CHECK, 'xwa2_username_check');
+        if (data?.result === USERNAME_CHECK_RESULT.SUCCESS) {
+            return { available: true, username };
+        }
+        return {
+            available: false,
+            username,
+            suggestions: data?.suggestions ?? [],
+            rejectionReasons: data?.rejection_reasons ?? [],
+            suggestionsEligible: data?.suggestions_eligible ?? true
+        };
+    };
+
+    // 2. Check multiple usernames at once
+    const checkUsernameMulti = async (usernames) => {
+        if (!USERNAME_QUERY_IDS.CHECK_MULTI) {
+            throw new Error('Username CHECK_MULTI query_id not configured');
+        }
+        return mexQuery({ usernames }, USERNAME_QUERY_IDS.CHECK_MULTI, 'xwa2_username_check_multi');
+    };
+
+    // 3. Set username
+    const setUsername = async (username, options = {}) => {
+        if (!USERNAME_QUERY_IDS.SET) {
+            throw new Error('Username SET query_id not configured — capture a live WA session to obtain it');
+        }
+        const { source = USERNAME_SOURCE.USER_INPUT, sessionId, pin, reserved = false } = options;
+        const variables = {
+            username,
+            reserved,
+            source,
+            ...(sessionId ? { session_id: sessionId } : {}),
+            ...(pin ? { pin } : {})
+        };
+        return mexQuery(variables, USERNAME_QUERY_IDS.SET, 'xwa2_username_set');
+    };
+
+    // 2b. Reserve a username (WA 2026 reservation flow — same endpoint, `reserved: true`)
+    const reserveUsername = async (username, options = {}) => {
+        return setUsername(username, { ...options, reserved: true });
+    };
+
+    // 4. Delete / unset username
+    const deleteUsername = async () => {
+        if (!USERNAME_QUERY_IDS.SET) {
+            throw new Error('Username SET query_id not configured — capture a live WA session to obtain it');
+        }
+        return mexQuery({ username: null }, USERNAME_QUERY_IDS.SET, 'xwa2_username_delete');
+    };
+
+    // 5. Get own username
+    const getMyUsername = async () => {
+        if (!USERNAME_QUERY_IDS.GET) {
+            throw new Error('Username GET query_id not configured — capture a live WA session to obtain it');
+        }
+        const data = await mexQuery({}, USERNAME_QUERY_IDS.GET, 'xwa2_username_get');
+        return data?.username ?? null;
+    };
+
+    // 6. Pin/unpin username (requires PIN)
+    const setUsernamePin = async (pin) => {
+        if (!USERNAME_QUERY_IDS.PIN_SET) {
+            throw new Error('Username PIN_SET query_id not configured — capture a live WA session to obtain it');
+        }
+        return mexQuery({ pin }, USERNAME_QUERY_IDS.PIN_SET, 'xwa2_username_pin_set');
+    };
+
+    // 7. Find user by username (USync)
+    const findUserByUsername = async (username, pin) => {
+        const usyncQuery = new USyncQuery().withContactProtocol();
+        const user = new USyncUser().withUsername(username);
+        if (pin) user.withUsernameKey(pin);
+        usyncQuery.withUser(user);
+        const result = await executeUSyncQuery(usyncQuery);
+        if (!result?.list?.length) return null;
+        const entry = result.list[0];
+        if (!entry) return null;
+        return {
+            jid: entry.id,
+            contact: Boolean(entry.contact)
+        };
+    };
+
+    // 8. Fetch usernames of known contacts (USync)
+    const fetchContactUsernames = async (...jids) => {
+        const usyncQuery = new USyncQuery().withUsernameProtocol();
+        for (const jid of jids) {
+            usyncQuery.withUser(new USyncUser().withId(jid));
+        }
+        const result = await executeUSyncQuery(usyncQuery);
+        return result?.list ?? [];
+    };
+
+    // 9. Get username recommendations
+    const getUsernameRecommendations = async (source = null) => {
+        const variables = {};
+        if (source) variables.source = source;
+        return mexQuery(variables, USERNAME_QUERY_IDS.GET_RECOMMENDATIONS, 'xwa2_username_get_recommendations');
+    };
+
+    return {
+        ...sock,
+        checkUsername,
+        checkUsernameMulti,
+        setUsername,
+        reserveUsername,
+        deleteUsername,
+        getMyUsername,
+        setUsernamePin,
+        findUserByUsername,
+        fetchContactUsernames,
+        getUsernameRecommendations,
+        USERNAME_QUERY_IDS,
+        USERNAME_CHECK_RESULT,
+        USERNAME_SOURCE
+    };
+};

package/lib/Store/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./make-in-memory-store.js";
+export * from "./make-ordered-dictionary.js";
+export * from "./object-repository.js";

package/lib/Store/index.js

@@ -0,0 +1,3 @@
+export * from './make-in-memory-store.js';
+export * from './make-ordered-dictionary.js';
+export * from './object-repository.js';

package/lib/Store/make-in-memory-store.d.ts

@@ -0,0 +1,62 @@
+export function waChatKey(pin: any): {
+    key: (c: any) => string;
+    compare: (k1: any, k2: any) => any;
+};
+export function waMessageID(m: any): any;
+export namespace waLabelAssociationKey {
+    function key(la: any): any;
+    function compare(k1: any, k2: any): any;
+}
+export function makeInMemoryStore(config?: {}): {
+    chats: any;
+    contacts: {};
+    messages: {};
+    groupMetadata: {};
+    state: {
+        connection: string;
+    };
+    presences: {};
+    labels: ObjectRepository;
+    labelAssociations: any;
+    bind: (ev: any) => void;
+    /** loads messages from the store, if not found -- uses the legacy connection */
+    loadMessages: (jid: any, count: any, cursor: any) => Promise<any>;
+    /**
+     * Get all available labels for profile
+     *
+     * Keep in mind that the list is formed from predefined tags and tags
+     * that were "caught" during their editing.
+     */
+    getLabels: () => ObjectRepository;
+    /**
+     * Get labels for chat
+     *
+     * @returns Label IDs
+     **/
+    getChatLabels: (chatId: any) => any;
+    /**
+     * Get labels for message
+     *
+     * @returns Label IDs
+     **/
+    getMessageLabels: (messageId: any) => any;
+    loadMessage: (jid: any, id: any) => Promise<any>;
+    mostRecentMessage: (jid: any) => Promise<any>;
+    fetchImageUrl: (jid: any, sock: any) => Promise<any>;
+    fetchGroupMetadata: (jid: any, sock: any) => Promise<any>;
+    fetchMessageReceipts: ({ remoteJid, id }: {
+        remoteJid: any;
+        id: any;
+    }) => Promise<any>;
+    toJSON: () => {
+        chats: any;
+        contacts: {};
+        messages: {};
+        labels: ObjectRepository;
+        labelAssociations: any;
+    };
+    fromJSON: (json: any) => void;
+    writeToFile: (path: any) => void;
+    readFromFile: (path: any) => void;
+};
+import { ObjectRepository } from './object-repository.js';