Merge branch 'master' of https://github.com/open-wa/wa-automate-nodejs

CHANGELOG.md

@@ -7,10 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-## [4.55.4](https://github.com/open-wa/wa-automate-nodejs/compare/4.55.2...4.55.4)
-
-### Commits
-
+## [4.57.0](https://github.com/open-wa/wa-automate-nodejs/compare/4.55.4...4.57.0)
+
+### Commits
+
+- 👷 fix ci docs build [`a60898d`](https://github.com/open-wa/wa-automate-nodejs/commit/a60898d6614c2c2cb381cab0359129d3fdd0335b)
+- 🗑️ added deprecation & admonition to status features #3031 [`a044353`](https://github.com/open-wa/wa-automate-nodejs/commit/a044353ab9890c993e4bf71a89f417dfea1995a4)
+- ✨ feat: `getCommunityAdmins` [`2319ff5`](https://github.com/open-wa/wa-automate-nodejs/commit/2319ff5c2889dcdd8aee52586b2ddd4325979360)
+- ✨ feat: `getCommunities` #3024 [`02f2d32`](https://github.com/open-wa/wa-automate-nodejs/commit/02f2d3242f33ff7dcd5af18f7a1a04a72a1680bf)
+- ✨ feat: `getCommunityParticipants` #3024 [`015ed7e`](https://github.com/open-wa/wa-automate-nodejs/commit/015ed7e64050689883e8c8ee2ed1146107030e40)
+- ✨ feat: `getCommunityAdminIds` [`e2d7381`](https://github.com/open-wa/wa-automate-nodejs/commit/e2d73813dd4cd24b0fc01137fa50d8622fd23211)
+- ✨ feat: `getCommunityParticipantIds` #3024 [`230f459`](https://github.com/open-wa/wa-automate-nodejs/commit/230f4598e907a653c7dd28e9a15571e1563158e4)
+- 👷 added docs runner [`0663883`](https://github.com/open-wa/wa-automate-nodejs/commit/06638832b23285f5427c96878b03dd895c74385f)
+- ✨ feat: `getCommunityInfo` #3024 [`6459605`](https://github.com/open-wa/wa-automate-nodejs/commit/64596055aae45a99fc945b9b29afe70715d7816a)
+- ✨ feat: `acceptGroupJoinRequest` #3024 [`2120ea8`](https://github.com/open-wa/wa-automate-nodejs/commit/2120ea852f60a6e64d989a43118d2f30d8f58b5c)
+- 👷 docs ci [`6bb08ab`](https://github.com/open-wa/wa-automate-nodejs/commit/6bb08abafb837823828f4be639be7222d0704610)
+- 💚 docs CI [`401ae31`](https://github.com/open-wa/wa-automate-nodejs/commit/401ae31c7279b3d3255230d08c9334ccb9f3e875)
+- 🏷️ type updates [`4567de3`](https://github.com/open-wa/wa-automate-nodejs/commit/4567de38f36086ba8c34ef282a364fb4a1b8c02e)
+- updated types-only package [`e6d90b2`](https://github.com/open-wa/wa-automate-nodejs/commit/e6d90b29eb1a4c51136ceab9cecb439993b2926a)
+- ✨feat: you can now resize `getSnapshot` #3032 [`40d832f`](https://github.com/open-wa/wa-automate-nodejs/commit/40d832fa13116c65c4248d719e3f148f718acffc)
+- 👷 fix docs ci env [`9dce471`](https://github.com/open-wa/wa-automate-nodejs/commit/9dce47185b9c6b2e3786dffd5a82f349f695d8fc)
+- 👷 set docs ci user and pass [`df645eb`](https://github.com/open-wa/wa-automate-nodejs/commit/df645eb0dc998b9b7d0e488bf1533449e8ddbebc)
+- 🐛 fix type import [`390501c`](https://github.com/open-wa/wa-automate-nodejs/commit/390501ca238295075e20b45d1847977d31c34d3e)
+- 💚 added git details to docs ci [`ec9ef31`](https://github.com/open-wa/wa-automate-nodejs/commit/ec9ef31b145fbb29a567122fc91dfd0fe1bd901e)
+- 👷 fix docs ci name [`04bcd0f`](https://github.com/open-wa/wa-automate-nodejs/commit/04bcd0fa0949e9829827519edefe48a250efbffe)
+- updated types-only package [`80314f9`](https://github.com/open-wa/wa-automate-nodejs/commit/80314f9f1fd5115fe3f16a03c077887ea23e9bdd)
+- 👷 build package in docs ci [`2dffa8a`](https://github.com/open-wa/wa-automate-nodejs/commit/2dffa8a7b5007a87fb25a379da638b5763f88f23)
+
+## [4.55.4](https://github.com/open-wa/wa-automate-nodejs/compare/4.55.2...4.55.4) - 2023-02-10
+
+### Commits
+
+- Release 4.55.4 [`6dcf17e`](https://github.com/open-wa/wa-automate-nodejs/commit/6dcf17e8bc3f2b6d27b44b4c157bf965c9e8e947)
 - ✨ feat: sendPoll quote msg. single select by default #3045 [`46b432f`](https://github.com/open-wa/wa-automate-nodejs/commit/46b432f12fbb112e206556d53e9c7b95ca432b37)
 - updated types-only package [`6dbfcdf`](https://github.com/open-wa/wa-automate-nodejs/commit/6dbfcdf8c12c0cc51571c878e41946a89c7ade7a)
 - 💚 fix ci build for sendPoll #3045 [`34677c4`](https://github.com/open-wa/wa-automate-nodejs/commit/34677c4216a9df7b6ce281c9e4e379e2ee0d3f05)

docs-v3/docs/api/classes/api_Client.Client.md

@@ -32,6 +32,24 @@ Use a raw payload within your open-wa session
 
 ___
 
+### acceptGroupJoinRequest
+
+▸ **acceptGroupJoinRequest**(`messageId`): `Promise`<`boolean`\>
+
+Accepts a request from a recipient to join a group. Takes the message ID of the request message.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageId` | [`MessageId`](/api/types/api_model_aliases.MessageId.md) |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
 ### addLabel
 
 ▸ **addLabel**(`label`, `chatId`): `Promise`<`boolean`\>
@@ -903,6 +921,20 @@ array of [Chat]
 
 ___
 
+### getAllCommunities
+
+▸ **getAllCommunities**(): `Promise`<\`${number}@g.us\`[]\>
+
+Retrieve all commmunity Ids
+
+#### Returns
+
+`Promise`<\`${number}@g.us\`[]\>
+
+array of group ids
+
+___
+
 ### getAllContacts
 
 ▸ **getAllContacts**(): `Promise`<[`Contact`](/api/interfaces/api_model_contact.Contact.md)[]\>
@@ -1164,6 +1196,96 @@ title:string
 
 ___
 
+### getCommunityAdminIds
+
+▸ **getCommunityAdminIds**(`communityId`): `Promise`<{ `admins`: [`ContactId`](/api/types/api_model_aliases.ContactId.md)[] ; `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `subgroup`: `boolean`  }[]\>
+
+Retrieves community admin Ids
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `communityId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | community id |
+
+#### Returns
+
+`Promise`<{ `admins`: [`ContactId`](/api/types/api_model_aliases.ContactId.md)[] ; `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `subgroup`: `boolean`  }[]\>
+
+___
+
+### getCommunityAdmins
+
+▸ **getCommunityAdmins**(`communityId`): `Promise`<{ `admins`: [`Contact`](/api/interfaces/api_model_contact.Contact.md)[] ; `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `subgroup`: `boolean`  }[]\>
+
+Retrieves community admins as Contact objects
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `communityId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | community id |
+
+#### Returns
+
+`Promise`<{ `admins`: [`Contact`](/api/interfaces/api_model_contact.Contact.md)[] ; `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `subgroup`: `boolean`  }[]\>
+
+___
+
+### getCommunityInfo
+
+▸ **getCommunityInfo**(`communityId`): `Promise`<[`GroupMetadata`](/api/interfaces/api_model_group_metadata.GroupMetadata.md) & { `subGroups`: [`GroupMetadata`](/api/interfaces/api_model_group_metadata.GroupMetadata.md)[]  }\>
+
+Returns the community metadata. Like group metadata but with a `subGroups` property which is the group metadata of the community subgroups.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `communityId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | community id |
+
+#### Returns
+
+`Promise`<[`GroupMetadata`](/api/interfaces/api_model_group_metadata.GroupMetadata.md) & { `subGroups`: [`GroupMetadata`](/api/interfaces/api_model_group_metadata.GroupMetadata.md)[]  }\>
+
+___
+
+### getCommunityParticipantIds
+
+▸ **getCommunityParticipantIds**(`communityId`): `Promise`<{ `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `participants`: [`ContactId`](/api/types/api_model_aliases.ContactId.md)[] ; `subgroup`: `boolean`  }[]\>
+
+Retrieves community members Ids
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `communityId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | community id |
+
+#### Returns
+
+`Promise`<{ `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `participants`: [`ContactId`](/api/types/api_model_aliases.ContactId.md)[] ; `subgroup`: `boolean`  }[]\>
+
+___
+
+### getCommunityParticipants
+
+▸ **getCommunityParticipants**(`communityId`): `Promise`<{ `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `participants`: [`Contact`](/api/interfaces/api_model_contact.Contact.md)[] ; `subgroup`: `boolean`  }[]\>
+
+Retrieves community members as Contact objects
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `communityId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | community id |
+
+#### Returns
+
+`Promise`<{ `id`: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) ; `participants`: [`Contact`](/api/interfaces/api_model_contact.Contact.md)[] ; `subgroup`: `boolean`  }[]\>
+
+___
+
 ### getConfig
 
 ▸ **getConfig**(): [`ConfigObject`](/api/interfaces/api_model_config.ConfigObject.md)
@@ -1806,15 +1928,17 @@ ___
 
 ### getSnapshot
 
-▸ **getSnapshot**(`chatId?`): `Promise`<[`DataURL`](/api/types/api_model_aliases.DataURL.md)\>
+▸ **getSnapshot**(`chatId?`, `width?`, `height?`): `Promise`<[`DataURL`](/api/types/api_model_aliases.DataURL.md)\>
 
 Returns a PNG DataURL screenshot of the session
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `chatId?` | [`ChatId`](/api/types/api_model_aliases.ChatId.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `chatId?` | [`ChatId`](/api/types/api_model_aliases.ChatId.md) | Chat ID to open before taking a snapshot |
+| `width?` | `number` | Width of the viewport for the snapshot. Height also required if you want to resize. |
+| `height?` | `number` | Height of the viewport for the snapshot. Width also required if you want to resize. |
 
 #### Returns
 
@@ -2577,6 +2701,14 @@ ___
 
 ▸ **postImageStatus**(`data`, `caption`): `Promise`<`string` \| `boolean` \| [`MessageId`](/api/types/api_model_aliases.MessageId.md)\>
 
+**`Deprecated`**
+
+:::danger
+
+Status features are broken for now. Please join our discord community for updates.
+
+:::
+
 [REQUIRES AN IMAGE STORY LICENSE-KEY](https://gum.co/open-wa)
 
 Posts an image story.
@@ -2600,6 +2732,14 @@ ___
 
 ▸ **postTextStatus**(`text`, `textRgba`, `backgroundRgba`, `font`): `Promise`<`string` \| `boolean` \| [`MessageId`](/api/types/api_model_aliases.MessageId.md)\>
 
+**`Deprecated`**
+
+:::danger
+
+Status features are broken for now. Please join our discord community for updates.
+
+:::
+
 [REQUIRES A TEXT STORY LICENSE-KEY](https://gum.co/open-wa)
 
 Sends a formatted text story.
@@ -2625,6 +2765,14 @@ ___
 
 ▸ **postVideoStatus**(`data`, `caption`): `Promise`<`string` \| `boolean` \| [`MessageId`](/api/types/api_model_aliases.MessageId.md)\>
 
+**`Deprecated`**
+
+:::danger
+
+Status features are broken for now. Please join our discord community for updates.
+
+:::
+
 [REQUIRES A VIDEO STORY LICENSE-KEY](https://gum.co/open-wa)
 
 Posts a video story.
@@ -2909,6 +3057,25 @@ Report a contact for spam, block them and attempt to clear chat.
 
 ___
 
+### resizePage
+
+▸ **resizePage**(`width?`, `height?`): `Promise`<`boolean`\>
+
+Easily resize page on the fly. Useful if you're showing screenshots in a web-app.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `width` | `number` | `1920` |
+| `height` | `number` | `1080` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
 ### revokeGroupInviteLink
 
 ▸ **revokeGroupInviteLink**(`chatId`): `Promise`<`string` \| `boolean`\>
@@ -3463,7 +3630,7 @@ ___
 
 ### sendPoll
 
-▸ **sendPoll**(`to`, `name`, `options`): `Promise`<[`MessageId`](/api/types/api_model_aliases.MessageId.md)\>
+▸ **sendPoll**(`to`, `name`, `options`, `quotedMsgId?`, `allowMultiSelect?`): `Promise`<[`MessageId`](/api/types/api_model_aliases.MessageId.md)\>
 
 Send a poll to a group chat
 
@@ -3474,6 +3641,8 @@ Send a poll to a group chat
 | `to` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | chat id - a group chat is required |
 | `name` | `string` | the name of the poll |
 | `options` | `string`[] | an array of poll options |
+| `quotedMsgId?` | [`MessageId`](/api/types/api_model_aliases.MessageId.md) | A message to quote when sending the poll |
+| `allowMultiSelect?` | `boolean` | Whether or not to allow multiple selections. default false |
 
 #### Returns
 

docs-v3/docs/api/classes/structures_Collector.Collection.md

@@ -70,7 +70,7 @@ BaseCollection<K, V\>.constructor
 
 #### Inherited from
 
-BaseCollection.\_\_@toStringTag@1042
+BaseCollection.\_\_@toStringTag@1043
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Inherited from
 
-BaseCollection.\_\_@species@1951
+BaseCollection.\_\_@species@1952
 
 ___
 

docs-v3/docs/api/interfaces/api_model_message.Message.md

@@ -200,7 +200,7 @@ ___
 
 ### isGroupJoinRequest
 
-• `Optional` **isGroupJoinRequest**: `boolean`
+• `Optional` **isGroupJoinRequest**: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md)
 
 When a user requests to join a group wihtin a community the request is received by the host as a message. This boolean will allow you to easily determine if the incoming message is a request to join a group.
 
@@ -379,7 +379,7 @@ ___
 
 ### quotedParentGroupJid
 
-• `Optional` **quotedParentGroupJid**: `string`
+• `Optional` **quotedParentGroupJid**: [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md)
 
 The parent group ID (community ID - communities are just groups made up of other groups) of the group represented by `quotedRemoteJid`
 

docs-v3/docs/api/modules.md

@@ -28,7 +28,6 @@ custom_edit_url: null
 - [api/model/product](/api/modules/api_model_product.md)
 - [api/model/reactions](/api/modules/api_model_reactions.md)
 - [api/model/sessionInfo](/api/modules/api_model_sessionInfo.md)
-- [controllers/data\_dir\_watcher](/api/modules/controllers_data_dir_watcher.md)
 - [controllers/events](/api/modules/controllers_events.md)
 - [controllers/init\_patch](/api/modules/controllers_init_patch.md)
 - [controllers/initializer](/api/modules/controllers_initializer.md)

docs-v3/docs/api/reference

@@ -1,6 +1,6 @@
 ---
 id: "reference"
-title: "@open-wa/wa-automate - v4.55.0"
+title: "@open-wa/wa-automate - v4.57.0"
 sidebar_label: "Readme"
 sidebar_position: 0
 custom_edit_url: null

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.56.0",
+  "version": "4.57.0",
   "licenseCheckUrl": "https://funcs.openwa.dev/license-check",
   "brokenMethodReportUrl": "https://funcs.openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",

types-only/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.55.4",
+    "version": "4.57.0",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",