Accept username in ProjectMembers#add (#3666)

* Accept username in ProjectMembers#add * Updating the typing of the semi-required arguments * Fix typos in types used --------- Co-authored-by: Justin Dalrymple <[email protected]>
jdalrymple · Dec 31, 2024 · 5d86207 · 5d86207
1 parent 5e70aa3
commit 5d86207
Show file tree

Hide file tree

Showing 11 changed files with 301 additions and 2,955 deletions.
diff --git a/.yarn/releases/yarn-3.5.0.cjs b/.yarn/releases/yarn-3.5.0.cjs
diff --git a/.yarn/releases/yarn-4.0.2.cjs b/.yarn/releases/yarn-4.0.2.cjs
diff --git a/.yarn/releases/yarn-4.1.0.cjs b/.yarn/releases/yarn-4.1.0.cjs
diff --git a/.yarn/releases/yarn-4.5.1.cjs → .yarn/releases/yarn-4.6.0.cjs b/.yarn/releases/yarn-4.5.1.cjs → .yarn/releases/yarn-4.6.0.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -1,3 +1,3 @@
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.5.1.cjs
+yarnPath: .yarn/releases/yarn-4.6.0.cjs
diff --git a/package.json b/package.json
@@ -30,7 +30,6 @@
     "release:next": "auto next",
     "release:canary": "auto canary",
     "release": "auto shipit",
-    "postinstall": "husky init",
     "prepare": "husky"
   },
   "dependencies": {
@@ -67,5 +66,5 @@
     "prettier": "^3.3.2",
     "typescript": "^5.5.3"
   },
-  "packageManager": "yarn@4.5.1"
+  "packageManager": "yarn@4.6.0"
 }
diff --git a/packages/core/src/resources/GroupMembers.ts b/packages/core/src/resources/GroupMembers.ts
@@ -1,7 +1,7 @@
 import type { BaseResourceOptions } from '@gitbeaker/requester-utils';
 import { ResourceMembers } from '../templates';
 import type {
-  AddMemeberOptions,
+  AddMemberOptions,
   AllMembersOptions,
   CondensedMemberSchema,
   IncludeInherited,
@@ -45,9 +45,8 @@ export interface OverrodeGroupMemberSchema extends SimpleMemberSchema {
 export interface GroupMembers<C extends boolean = false> extends ResourceMembers<C> {
   add<E extends boolean = false>(
     projectId: string | number,
-    userId: number,
     accessLevel: Exclude<AccessLevel, AccessLevel.ADMIN>,
-    options?: AddMemeberOptions & Sudo & ShowExpanded<E>,
+    options?: AddMemberOptions & Sudo & ShowExpanded<E>,
   ): Promise<GitlabAPIResponse<MemberSchema, C, E, void>>;
 
   all<E extends boolean = false, P extends PaginationTypes = 'offset'>(

diff --git a/packages/core/src/resources/ProjectMembers.ts b/packages/core/src/resources/ProjectMembers.ts
@@ -1,7 +1,7 @@
 import type { BaseResourceOptions } from '@gitbeaker/requester-utils';
 import { ResourceMembers } from '../templates';
 import type {
-  AddMemeberOptions,
+  AddMemberOptions,
   AllMembersOptions,
   IncludeInherited,
   MemberSchema,
@@ -18,9 +18,8 @@ import { AccessLevel } from '../constants';
 export interface ProjectMembers<C extends boolean = false> extends ResourceMembers<C> {
   add<E extends boolean = false>(
     projectId: string | number,
-    userId: number,
     accessLevel: Exclude<AccessLevel, AccessLevel.ADMIN>,
-    options?: AddMemeberOptions & Sudo & ShowExpanded<E>,
+    options?: AddMemberOptions & Sudo & ShowExpanded<E>,
   ): Promise<GitlabAPIResponse<MemberSchema, C, E, void>>;
 
   all<E extends boolean = false, P extends PaginationTypes = 'offset'>(

diff --git a/packages/core/src/templates/ResourceMembers.ts b/packages/core/src/templates/ResourceMembers.ts
@@ -4,6 +4,7 @@ import { RequestHelper, endpoint } from '../infrastructure';
 import type {
   BaseRequestOptions,
   GitlabAPIResponse,
+  OneOf,
   PaginationRequestOptions,
   PaginationTypes,
   ShowExpanded,
@@ -38,12 +39,12 @@ export interface MemberSchema extends SimpleMemberSchema {
   };
 }
 
-export interface AddMemeberOptions {
+export type AddMemberOptions = OneOf<{ userId: string | number; username: string }> & {
   expiresAt?: string;
   inviteSource?: string;
   tasksToBeDone?: string[];
   tasksProjectId?: number;
-}
+};
 
 export interface AllMembersOptions {
   query?: string;
@@ -59,12 +60,10 @@ export class ResourceMembers<C extends boolean = false> extends BaseResource<C>
 
   add<E extends boolean = false>(
     resourceId: string | number,
-    userId: number,
     accessLevel: Exclude<AccessLevel, AccessLevel.ADMIN>,
-    options?: AddMemeberOptions & Sudo & ShowExpanded<E>,
+    options?: AddMemberOptions & Sudo & ShowExpanded<E>,
   ): Promise<GitlabAPIResponse<MemberSchema, C, E, void>> {
     return RequestHelper.post<MemberSchema>()(this, endpoint`${resourceId}/members`, {
-      userId: String(userId),
       accessLevel,
       ...options,
     });

diff --git a/packages/core/test/unit/resources/GroupMembers.ts b/packages/core/test/unit/resources/GroupMembers.ts
@@ -23,10 +23,19 @@ describe('GroupMembers General', () => {
 
 describe('GroupMembers.add', () => {
   it('should request POST /groups/1/members', async () => {
-    await service.add(1, 2, 10);
+    await service.add(1, 10, { userId: 2 });
 
     expect(RequestHelper.post()).toHaveBeenCalledWith(service, '1/members', {
-      userId: '2',
+      userId: 2,
+      accessLevel: 10,
+    });
+  });
+
+  it('should request POST /groups/user.name/members', async () => {
+    await service.add(1, 10, { username: 'user.name' });
+
+    expect(RequestHelper.post()).toHaveBeenCalledWith(service, '1/members', {
+      username: 'user.name',
       accessLevel: 10,
     });
   });

diff --git a/packages/core/test/unit/templates/ResourceMembers.ts b/packages/core/test/unit/templates/ResourceMembers.ts
@@ -29,11 +29,11 @@ describe('Instantiating ResourceMembers service', () => {
 
 describe('ResourceMembers.add', () => {
   it('should call the correct url for adding a member with a resource id, user id and access level', async () => {
-    await service.add('5', 5, 10);
+    await service.add('5', 10, { userId: 5 });
 
     expect(RequestHelper.post()).toHaveBeenCalledWith(service, '5/members', {
       accessLevel: 10,
-      userId: '5',
+      userId: 5,
     });
   });
 });