feat: Added WPP.contact.subscribePresence (close wppconnect-team#2283)

src/contact/functions/index.ts

@@ -21,3 +21,5 @@ export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
 export { ContactListOptions, list } from './list';
 export { queryExists } from './queryExists';
+export { subscribePresence } from './subscribePresence';
+export { unsubscribePresence } from './unsubscribePresence';

src/contact/functions/subscribePresence.ts

@@ -0,0 +1,52 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { PresenceStore, Wid, WidFactory } from '../../whatsapp';
+import { subscribePresence as sendSubscribePresence } from '../../whatsapp/functions';
+
+/**
+ * Subscribe presente from a contact
+ *
+ * @example
+ * ```javascript
+ * await WPP.contact.subscribePresence('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+
+export async function subscribePresence(
+  ids: string | string[]
+): Promise<Wid[]> {
+  if (!Array.isArray(ids)) {
+    ids = [ids];
+  }
+
+  const result = [];
+  for (const id of ids) {
+    try {
+      const wid = WidFactory.createWid(id);
+      await sendSubscribePresence(wid);
+      if (PresenceStore.get(wid)) {
+        result.push(wid);
+        continue;
+      }
+      await PresenceStore.find(wid);
+      result.push(wid);
+    } catch (error) {}
+  }
+  return result;
+}

src/contact/functions/unsubscribePresence.ts

@@ -0,0 +1,49 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { PresenceStore, Wid, WidFactory } from '../../whatsapp';
+
+/**
+ * Unsubscribe presence of a contact
+ *
+ * @example
+ * ```javascript
+ * await WPP.contact.unsubscribePresence('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+
+export async function unsubscribePresence(
+  ids: string | string[]
+): Promise<Wid[]> {
+  if (!Array.isArray(ids)) {
+    ids = [ids];
+  }
+
+  const result = [];
+  for (const id of ids) {
+    const wid = WidFactory.createWid(id);
+    const presence = PresenceStore.get(wid);
+    if (!presence) {
+      result.push(wid);
+      continue;
+    }
+    presence.delete();
+    result.push(wid);
+  }
+  return result;
+}

src/whatsapp/functions/index.ts

@@ -137,6 +137,7 @@ export * from './setPushname';
 export * from './status';
 export * from './STATUS_JID';
 export * from './statusEnable';
+export * from './subscribePresence';
 export * from './syncABPropsTask';
 export * from './typeAttributeFromProtobuf';
 export * from './unixTime';

src/whatsapp/functions/subscribePresence.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Wid } from '..';
+import { exportModule } from '../exportModule';
+
+/**
+ * @whatsapp WAWebContactPresenceBridge
+ */
+export declare function subscribePresence(id: Wid, tcToken?: any): Promise<any>;
+
+exportModule(
+  exports,
+  {
+    subscribePresence: 'subscribePresence',
+  },
+  (m) => m.subscribePresence
+);