feat: Add Group Invite Link API endpoint (#384)

* feat: Add Group Invite Link API endpoint

- Add GetGroupInviteLink method to group management interface
- Implement business logic in usecase layer
- Add validation for group invite link requests
- Create REST API endpoint: GET /group/{group_id}/invite-link
- Update OpenAPI documentation with new endpoint
- Add .gitignore to exclude plan.md

* fix: Update GetGroupInviteLinkResponse schema to match API consistency pattern

* fix: Add default value and trailing newline to openapi.yaml

* docs: Add Group Invite Link API to README documentation

* fix: Add trailing newline to openapi.yaml to resolve YAML lint error

* feat: Add Group Invite Link UI component and integration

- Add GroupGetInviteLink.js Vue component with full functionality
- Integrate component into index.html with proper imports and registration
- Include auto-correction for group ID input
- Add clipboard copy functionality for invite links
- Implement proper loading states and error handling
- Follow existing code patterns and architecture

* feat: add /user/my/groups/metadata endpoint with enhanced group information

- Add GroupMeta and MyGroupsMetadataResponse structs to domains/user
- Extend IUserListing interface with MyGroupsMetadata method
- Implement MyGroupsMetadata use-case with concurrency controls and context timeout
- Add REST handler UserMyGroupsMetadata with 40s timeout
- Create GroupMetaList.js Vue component with DataTable integration
- Add green card UI following existing group component patterns
- Wire component into index.html Group section
- Update OpenAPI specification with new endpoint and response schema
- Document endpoint in README API table

Features:
- Fetches group_id, name, is_admin status, admin_count, member_count
- Includes invite_link for groups where user is admin
- Bounded concurrency (8 goroutines) for safe WhatsApp API usage
- Proper error handling and loading states in UI
- Follows upstream Whatsmeow library design patterns

* fix: remove unused ctxGroup variable causing build failure

* Revert: Remove accidentally added metadata endpoint functionality

- Remove /user/my/groups/metadata endpoint to prevent WhatsApp rate-limiting
- Delete GroupMeta and MyGroupsMetadataResponse domain structs
- Remove MyGroupsMetadata interface method and usecase implementation
- Delete GroupMetaList.js frontend component and integration
- Remove metadata endpoint route registration and handler
- Update API documentation in README.md and OpenAPI spec

* fix: update OpenAPI version and align documentation style

- Update OpenAPI version from 6.9.0 to 6.10.0
- Fix /group/{group_id}/invite-link endpoint documentation style to match /group/info pattern
  - Change operationId to 'groupInviteLink'
  - Change summary to 'Group Invite Link'
  - Reorder path parameter fields (in: path first)
  - Remove example field from path parameter
- Change copy button color to blue in GroupGetInviteLink component

* refactor(api): change group invite link endpoint to use query parameters

- Change API endpoint from /group/{group_id}/invite-link to /group/invite-link
- Move group_id from path parameter to query parameter for consistency
- Update GetGroupInviteLinkRequest struct tags from form to query
- Modify REST handler to use QueryParser instead of path parameter extraction
- Update OpenAPI documentation to reflect new endpoint structure
- Adjust frontend component to send group_id as query parameter
- Maintain existing validation logic compatibility

Addresses PR #384 owner comments for API style consistency
and OpenAPI documentation updates.

Files changed:
- src/domains/group/group.go
- src/ui/rest/group.go
- docs/openapi.yaml
- src/views/components/GroupGetInviteLink.js

Breaking change: API endpoint structure changed from path to query parameters

* ✅ Fixed frontend response handling in GroupGetInviteLink.js

- Added strict type checking to prevent assigning objects to string fields
- Removed debug logs to follow master branch patterns
- Added safe fallback when no valid string is found

The component now safely handles API responses while maintaining consistency with existing codebase patterns.

---------

Co-authored-by: DTS BBPSDMP Medan <bbpsdmpkemdan@gmail.com>
Co-authored-by: Aldino Kemal <aldinokemal2104@gmail.com>

Author: 3 people

.gitignore

@@ -1,7 +1,7 @@
 openapi: "3.0.0"
 info:
   title: WhatsApp API MultiDevice
-  version: 6.9.0
+  version: 6.10.0
   description: This API is used for sending whatsapp via API
 servers:
   - url: http://localhost:3000
@@ -312,6 +312,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorInternalServer'
+
   /user/my/newsletters:
     get:
       operationId: userMyNewsletter
@@ -2212,6 +2213,45 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorInternalServer'
+  /group/invite-link:
+    get:
+      operationId: groupInviteLink
+      tags:
+        - group
+      summary: Group Invite Link
+      parameters:
+        - name: group_id
+          in: query
+          schema:
+            type: string
+          required: true
+          description: WhatsApp Group ID
+        - name: reset
+          in: query
+          schema:
+            type: boolean
+            default: false
+          example: false
+          description: Reset existing invite link
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetGroupInviteLinkResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorBadRequest'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorInternalServer'
   /newsletter/unfollow:
     post:
       operationId: unfollowNewsletter
@@ -2419,6 +2459,8 @@ components:
                           type: boolean
                         Error:
                           type: number
+
+
     UserInfoResponse:
       type: object
       required:
@@ -3256,4 +3298,24 @@ components:
         results:
           type: object
           description: Group information object (structure may vary)
-          additionalProperties: true
+          additionalProperties: true
+    GetGroupInviteLinkResponse:
+      type: object
+      properties:
+        code:
+          type: string
+          example: SUCCESS
+        message:
+          type: string
+          example: Success get group invite link
+        results:
+          type: object
+          properties:
+            invite_link:
+              type: string
+              example: 'https://chat.whatsapp.com/ABC123...'
+              description: The group invite link
+            group_id:
+              type: string
+              example: '120363025982934543@g.us'
+              description: The group ID

docs/openapi.yaml

@@ -352,6 +352,7 @@ You can fork or edit this source code !
 | ✅       | Set Group Locked                       | POST   | /group/locked                       |
 | ✅       | Set Group Announce                     | POST   | /group/announce                     |
 | ✅       | Set Group Topic                        | POST   | /group/topic                        |
+| ✅       | Get Group Invite Link                  | GET    | /group/:group_id/invite-link        |
 | ✅       | Unfollow Newsletter                    | POST   | /newsletter/unfollow                |
 | ✅       | Get Chat List                          | GET    | /chats                              |
 | ✅       | Get Chat Messages                      | GET    | /chat/:chat_jid/messages            |

readme.md

@@ -99,6 +99,16 @@ type GroupInfoRequest struct {
 	GroupID string `json:"group_id" query:"group_id"`
 }
 
+type GetGroupInviteLinkRequest struct {
+	GroupID string `json:"group_id" query:"group_id"`
+	Reset   bool   `json:"reset" query:"reset"`
+}
+
+type GetGroupInviteLinkResponse struct {
+	InviteLink string `json:"invite_link"`
+	GroupID    string `json:"group_id"`
+}
+
 type GroupInfoResponse struct {
 	Data any `json:"data"`
 }

src/domains/group/group.go

@@ -10,6 +10,7 @@ type IGroupManagement interface {
 	LeaveGroup(ctx context.Context, request LeaveGroupRequest) (err error)
 	CreateGroup(ctx context.Context, request CreateGroupRequest) (groupID string, err error)
 	GetGroupInfoFromLink(ctx context.Context, request GetGroupInfoFromLinkRequest) (response GetGroupInfoFromLinkResponse, err error)
+	GetGroupInviteLink(ctx context.Context, request GetGroupInviteLinkRequest) (response GetGroupInviteLinkResponse, err error)
 	GroupInfo(ctx context.Context, request GroupInfoRequest) (response GroupInfoResponse, err error)
 }
 

src/domains/group/interfaces.go

@@ -34,6 +34,7 @@ func InitRestGroup(app fiber.Router, service domainGroup.IGroupUsecase) Group {
 	app.Post("/group/locked", rest.SetGroupLocked)
 	app.Post("/group/announce", rest.SetGroupAnnounce)
 	app.Post("/group/topic", rest.SetGroupTopic)
+	app.Get("/group/invite-link", rest.GetGroupInviteLink)
 	return rest
 }
 
@@ -339,3 +340,21 @@ func (controller *Group) GroupInfo(c *fiber.Ctx) error {
 		Results: response.Data,
 	})
 }
+
+func (controller *Group) GetGroupInviteLink(c *fiber.Ctx) error {
+	var request domainGroup.GetGroupInviteLinkRequest
+	err := c.QueryParser(&request)
+	utils.PanicIfNeeded(err)
+
+	utils.SanitizePhone(&request.GroupID)
+
+	response, err := controller.Service.GetGroupInviteLink(c.UserContext(), request)
+	utils.PanicIfNeeded(err)
+
+	return c.JSON(utils.ResponseData{
+		Status:  200,
+		Code:    "SUCCESS",
+		Message: "Success get group invite link",
+		Results: response,
+	})
+}

src/ui/rest/group.go

@@ -339,3 +339,27 @@ func (service serviceGroup) GroupInfo(ctx context.Context, request domainGroup.G
 
 	return response, nil
 }
+
+func (service serviceGroup) GetGroupInviteLink(ctx context.Context, request domainGroup.GetGroupInviteLinkRequest) (response domainGroup.GetGroupInviteLinkResponse, err error) {
+	if err = validations.ValidateGetGroupInviteLink(ctx, request); err != nil {
+		return response, err
+	}
+	utils.MustLogin(whatsapp.GetClient())
+
+	groupJID, err := utils.ValidateJidWithLogin(whatsapp.GetClient(), request.GroupID)
+	if err != nil {
+		return response, err
+	}
+
+	inviteLink, err := whatsapp.GetClient().GetGroupInviteLink(groupJID, request.Reset)
+	if err != nil {
+		return response, err
+	}
+
+	response = domainGroup.GetGroupInviteLinkResponse{
+		InviteLink: inviteLink,
+		GroupID:    request.GroupID,
+	}
+
+	return response, nil
+}

src/usecase/group.go

@@ -204,3 +204,15 @@ func ValidateGroupInfo(ctx context.Context, request domainGroup.GroupInfoRequest
 
 	return nil
 }
+
+func ValidateGetGroupInviteLink(ctx context.Context, request domainGroup.GetGroupInviteLinkRequest) error {
+	err := validation.ValidateStructWithContext(ctx, &request,
+		validation.Field(&request.GroupID, validation.Required),
+	)
+
+	if err != nil {
+		return pkgError.ValidationError(err.Error())
+	}
+
+	return nil
+}