test: add community v2 endpoint coverage

Author: plhery

doc/v2.md

@@ -91,6 +91,9 @@ This is a comprehensive guide of all methods available for the Twitter API v2 on
     - [Search spaces](#search-spaces)
     - [Space buyers](#space-buyers)
     - [Space tweets](#space-tweets)
+  - [Communities](#communities)
+    - [Community by id](#community-by-id)
+    - [Search communities](#search-communities)
   - [Direct messages (DMs)](#direct-messages-dms)
     - [Fetch direct message events (without filter)](#fetch-direct-message-events-without-filter)
     - [Fetch direct message events by participant id](#fetch-direct-message-events-by-participant-id)
@@ -1534,6 +1537,34 @@ const { data: tweets } = await client.v2.spaceTweets('space-id')
 // tweets is a TweetV2[]
 ```
 
+## Communities
+
+### Community by id
+
+Retrieve details of a specific community.
+
+**Method**: `.community(communityId, options?)`
+
+**Endpoint**: `communities/:id`
+
+**Right level**: `Read`
+
+**Returns**: `CommunityV2Result`
+
+### Search communities
+
+Search for communities that match a given query.
+
+**Method**: `.searchCommunities(query, options?)`
+
+**Endpoint**: `communities/search`
+
+**Right level**: `Read`
+
+**Returns**: `CommunitiesV2Result`
+
+The community object includes fields such as `description`, `private`, `member_count`, `moderator_count`, `subscriber_count`, `creator_id` and `rules`.
+
 ## Direct messages (DMs)
 
 ### Fetch direct message events (without filter)

src/types/v2/community.v2.types.ts

@@ -1,7 +1,30 @@
+export interface CommunityRuleV2 {
+  /** Identifier of the rule. */
+  id: string;
+  /** Text of the rule. */
+  text: string;
+  /** Creation date of the rule. */
+  created_at?: string;
+}
+
 export interface CommunityV2 {
   id: string;
   name: string;
+  /** Description of the community. */
+  description?: string;
+  /** Identifier of the community creator. */
+  creator_id?: string;
   created_at: string;
+  /** Indicates if the community is private. */
+  private?: boolean;
+  /** Number of members in the community. */
+  member_count?: number;
+  /** Number of moderators in the community. */
+  moderator_count?: number;
+  /** Number of subscribers of the community. */
+  subscriber_count?: number;
+  /** Rules that apply to the community. */
+  rules?: CommunityRuleV2[];
 }
 
 export interface CommunityErrorV2 {

test/community.v2.test.ts

@@ -0,0 +1,23 @@
+import 'mocha';
+import { expect } from 'chai';
+import { TwitterApi } from '../src';
+import { getAppClient } from '../src/test/utils';
+
+let client: TwitterApi;
+
+describe.skip('Community endpoints for v2 API', () => {
+  before(async () => {
+    client = await getAppClient();
+  });
+
+  it('.community - Lookup community details', async () => {
+    const community = await client.v2.community('1');
+
+    expect(community.data.id).to.be.a('string');
+    expect(community.data.name).to.be.a('string');
+    // Newly documented fields
+    expect(community.data.description).to.be.a('string');
+    expect(community.data.private).to.be.a('boolean');
+    expect(community.data.member_count).to.be.a('number');
+  }).timeout(60 * 1000);
+});