Release 4.59.0

open-wa · Mar 23, 2023 · 275bb69 · 275bb69
1 parent 8dea0fa
commit 275bb69
Show file tree

Hide file tree

Showing 12 changed files with 170 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,10 +7,27 @@ 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.58.0](https://github.com/open-wa/wa-automate-nodejs/compare/4.57.0...4.58.0)
+## [4.59.0](https://github.com/open-wa/wa-automate-nodejs/compare/4.58.0...4.59.0)
 
 ### Commits
 
+- 🐛bug: fix accented filenames breaking file send #3071 [`2973a77`](https://github.com/open-wa/wa-automate-nodejs/commit/2973a77a89fe79dc72fb08672989286f66c484ac)
+- ✨ feat: `onGroupApprovalRequest` #3070 [`5c7f4e0`](https://github.com/open-wa/wa-automate-nodejs/commit/5c7f4e08262c5aed11a0780bc1a666163a0b9266)
+- ✨ feat: `getGroupApprovalRequests` #3070 [`785a51f`](https://github.com/open-wa/wa-automate-nodejs/commit/785a51fbcbe1bea8f5a385c4853e0e28065ce39f)
+- ✨ feat: `setGroupApprovalMode` #3070 [`dabc15b`](https://github.com/open-wa/wa-automate-nodejs/commit/dabc15b6065f754052f87bb306fd6b8f05f07a4f)
+- ✨ feat: `rejectGroupJoinRequest` #3070 [`480e1dc`](https://github.com/open-wa/wa-automate-nodejs/commit/480e1dc4a7ba3e7d1638f91d866198c83b5bfa77)
+- ✨ feat: `approveGroupJoinRequest` #3070 [`f7d039a`](https://github.com/open-wa/wa-automate-nodejs/commit/f7d039a684d0705f7a262496c9846fa9015bb1f6)
+- 👔 biz logic: wait for internal sync to complete before registering listeners [`2f43c08`](https://github.com/open-wa/wa-automate-nodejs/commit/2f43c0819fb2e811d20f7b1ec9306f3a8af6ff61)
+- 🏷️ type: `Chat.pic` to get chat icon #3069 [`2329632`](https://github.com/open-wa/wa-automate-nodejs/commit/23296323cedaeb616494f9b3178da70c5862297d)
+- 🔧 config: block dit as a crashlog [`27687ee`](https://github.com/open-wa/wa-automate-nodejs/commit/27687ee4683aa58e5b3fb622da3af547c1ec21fe)
+- updated types-only package [`aab334d`](https://github.com/open-wa/wa-automate-nodejs/commit/aab334db956a6703f23d492bf136367f4bb2c3ea)
+- 💚 fix CI [`8dea0fa`](https://github.com/open-wa/wa-automate-nodejs/commit/8dea0fab973a607b5cd87995b422cdf1cf726bff)
+
+## [4.58.0](https://github.com/open-wa/wa-automate-nodejs/compare/4.57.0...4.58.0) - 2023-03-04
+
+### Commits
+
+- Release 4.58.0 [`168cc32`](https://github.com/open-wa/wa-automate-nodejs/commit/168cc32d0f6c814d624eea588514bbe40ad38915)
 - ✨ feat: EXPERIMENTAL `editMessage` #3058 [`b31fd2b`](https://github.com/open-wa/wa-automate-nodejs/commit/b31fd2bf6cab47dc8ac7a360d55ee01c2da0544c)
 - updated types-only package [`3645050`](https://github.com/open-wa/wa-automate-nodejs/commit/3645050e66df0ef4cc5faae9e1a34b649dc0d388)
 

diff --git a/bin/oas-type-schemas.json b/bin/oas-type-schemas.json
diff --git a/docs-v3/docs/api/classes/api_Client.Client.md b/docs-v3/docs/api/classes/api_Client.Client.md
@@ -96,6 +96,27 @@ If the host account is not an administrator, returns `INSUFFICIENT_PERMISSIONS`
 
 ___
 
+### approveGroupJoinRequest
+
+▸ **approveGroupJoinRequest**(`groupChatId`, `contactId`): `Promise`<`string` \| `boolean`\>
+
+Approves a group join request
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupChatId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | The group chat id |
+| `contactId` | [`ContactId`](/api/types/api_model_aliases.ContactId.md) | The contact id of the person who is requesting to join the group |
+
+#### Returns
+
+`Promise`<`string` \| `boolean`\>
+
+`Promise<boolean>`
+
+___
+
 ### archiveChat
 
 ▸ **archiveChat**(`id`, `archive`): `Promise`<`boolean`\>
@@ -1419,6 +1440,26 @@ Get Admins of a Group
 
 ___
 
+### getGroupApprovalRequests
+
+▸ **getGroupApprovalRequests**(`groupChatId`): `Promise`<[`ContactId`](/api/types/api_model_aliases.ContactId.md)[]\>
+
+Gets the contact IDs of members requesting approval to join the group
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `groupChatId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) |
+
+#### Returns
+
+`Promise`<[`ContactId`](/api/types/api_model_aliases.ContactId.md)[]\>
+
+`Promise<ContactId[]>`
+
+___
+
 ### getGroupInfo
 
 ▸ **getGroupInfo**(`groupId`): `Promise`<`any`\>
@@ -1669,6 +1710,7 @@ If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue
 | `onChatState` | `default`<`default`, `DefaultAddOptions`\> |
 | `onContactAdded` | `default`<`default`, `DefaultAddOptions`\> |
 | `onGlobalParticipantsChanged` | `default`<`default`, `DefaultAddOptions`\> |
+| `onGroupApprovalRequest` | `default`<`default`, `DefaultAddOptions`\> |
 | `onGroupChange` | `default`<`default`, `DefaultAddOptions`\> |
 | `onIncomingCall` | `default`<`default`, `DefaultAddOptions`\> |
 | `onLabel` | `default`<`default`, `DefaultAddOptions`\> |
@@ -2915,6 +2957,28 @@ A webhook object. This will include a webhook ID and an array of all successfull
 
 ___
 
+### rejectGroupJoinRequest
+
+▸ **rejectGroupJoinRequest**(`groupChatId`, `contactId`): `Promise`<`string` \| `boolean`\>
+
+Rejects a group join request
+ *
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupChatId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | The group chat id  * |
+| `contactId` | [`ContactId`](/api/types/api_model_aliases.ContactId.md) | The contact id of the person who is requesting to join the group  * |
+
+#### Returns
+
+`Promise`<`string` \| `boolean`\>
+
+`Promise<boolean>`
+
+___
+
 ### removeAllListeners
 
 ▸ **removeAllListeners**(): `boolean`
@@ -4037,6 +4101,27 @@ Sets the chat state
 
 ___
 
+### setGroupApprovalMode
+
+▸ **setGroupApprovalMode**(`groupId`, `requireApproval`): `Promise`<`boolean`\>
+
+Turn on or off the approval requirement for new members to join a group
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupId` | [`GroupChatId`](/api/types/api_model_aliases.GroupChatId.md) | '0000000000-00000000@g.us' the group id. |
+| `requireApproval` | `boolean` | set to true to turn on the approval requirement, false to turn off |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+boolean true if action completed successfully.
+
+___
+
 ### setGroupDescription
 
 ▸ **setGroupDescription**(`groupId`, `description`): `Promise`<`boolean`\>
@@ -4761,6 +4846,26 @@ Listens to add and remove events on Groups on a global level. It is memory effic
 
 ___
 
+### onGroupApprovalRequest
+
+▸ **onGroupApprovalRequest**(`fn`): `Promise`<`boolean` \| `Listener`\>
+
+Listents to group approval requests. Emits a message object. Use it with `message.isGroupApprovalRequest()` to check if it is a group approval request.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fn` | (`groupApprovalRequestMessage`: [`Message`](/api/interfaces/api_model_message.Message.md)) => `void` | callback function that handles a Message as the first and only parameter. |
+
+#### Returns
+
+`Promise`<`boolean` \| `Listener`\>
+
+`true` if the callback was registered
+
+___
+
 ### onGroupChange
 
 ▸ **onGroupChange**(`fn`): `Promise`<`boolean` \| `Listener`\>

diff --git a/docs-v3/docs/api/classes/structures_Collector.Collection.md b/docs-v3/docs/api/classes/structures_Collector.Collection.md
@@ -70,7 +70,7 @@ BaseCollection<K, V\>.constructor
 
 #### Inherited from
 
-BaseCollection.\_\_@toStringTag@1043
+BaseCollection.\_\_@toStringTag@1044
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Inherited from
 
-BaseCollection.\_\_@species@1952
+BaseCollection.\_\_@species@1954
 
 ___
 

diff --git a/docs-v3/docs/api/enums/api_model_events.SimpleListener.md b/docs-v3/docs/api/enums/api_model_events.SimpleListener.md
@@ -108,6 +108,14 @@ Represents onGlobalParticipantsChanged
 
 ___
 
+### GroupApprovalRequest
+
+• **GroupApprovalRequest** = ``"onGroupApprovalRequest"``
+
+Represents onGroupApprovalRequest
+
+___
+
 ### GroupChange
 
 • **GroupChange** = ``"onGroupChange"``

diff --git a/docs-v3/docs/api/interfaces/api_model_chat.BaseChat.md b/docs-v3/docs/api/interfaces/api_model_chat.BaseChat.md
@@ -177,6 +177,14 @@ Messages that are pending to be sent
 
 ___
 
+### pic
+
+• `Optional` **pic**: `string`
+
+URL of the chat picture if available
+
+___
+
 ### pin
 
 • **pin**: `number`

diff --git a/docs-v3/docs/api/interfaces/api_model_chat.GroupChat.md b/docs-v3/docs/api/interfaces/api_model_chat.GroupChat.md
@@ -275,6 +275,18 @@ Messages that are pending to be sent
 
 ___
 
+### pic
+
+• `Optional` **pic**: `string`
+
+URL of the chat picture if available
+
+#### Inherited from
+
+[BaseChat](/api/interfaces/api_model_chat.BaseChat.md).[pic](/api/interfaces/api_model_chat.BaseChat.md#pic)
+
+___
+
 ### pin
 
 • **pin**: `number`

diff --git a/docs-v3/docs/api/interfaces/api_model_chat.SingleChat.md b/docs-v3/docs/api/interfaces/api_model_chat.SingleChat.md
@@ -275,6 +275,18 @@ Messages that are pending to be sent
 
 ___
 
+### pic
+
+• `Optional` **pic**: `string`
+
+URL of the chat picture if available
+
+#### Inherited from
+
+[BaseChat](/api/interfaces/api_model_chat.BaseChat.md).[pic](/api/interfaces/api_model_chat.BaseChat.md#pic)
+
+___
+
 ### pin
 
 • **pin**: `number`

diff --git a/docs-v3/docs/api/reference b/docs-v3/docs/api/reference
@@ -1,6 +1,6 @@
 ---
 id: "reference"
-title: "@open-wa/wa-automate - v4.58.0"
+title: "@open-wa/wa-automate - v4.59.0"
 sidebar_label: "Readme"
 sidebar_position: 0
 custom_edit_url: null

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.58.0",
+  "version": "4.59.0",
   "licenseCheckUrl": "https://funcs.openwa.dev/license-check",
   "brokenMethodReportUrl": "https://funcs.openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",

diff --git a/release.png b/release.png