feat: search user issues type (#188)

Author: jpb06

README.md

@@ -90,14 +90,14 @@ const [
         octokitUser.events(),
         // Search in user commits (1000 results max)
         octokitUser.searchCommits(''),
-        // Search in user issues (1000 results max)
-        octokitUser.searchIssues(''),
+        // Search in user issues (all, issue or pr) (1000 results max)
+        octokitUser.searchIssues('pr', ''),
         // Search in user merged pull requests (1000 results max)
         octokitUser.searchPullRequests('merged', ''),
         // Get entities count
         octokitUser.getPullRequestsCount('draft'),
         octokitUser.getCommitsCount(),
-        octokitUser.getIssuesCount(),
+        octokitUser.getIssuesCount('pr'),
       ],
       // Fetch all these in parallel
       { concurrency: 'unbounded' }

bun.lock

@@ -29,6 +29,7 @@ import type {
   UserEventsResult,
   UserIssuesCountResult,
   UserIssuesSearchResult,
+  UserIssuesType,
   UserOrgsResult,
   UserProfileResult,
   UserPullRequestsCountResult,
@@ -86,6 +87,7 @@ export type {
   UserPullRequestsCountResult,
   SortDirection,
   IssueState,
+  UserIssuesType,
 };
 
 export * from './layer/errors/api-rate-limit.error.js';

src/index.ts

@@ -8,6 +8,7 @@ import type {
   UserEventsResult,
   UserIssuesCountResult,
   UserIssuesSearchResult,
+  UserIssuesType,
   UserOrgsResult,
   UserProfileResult,
   UserPullRequestsCountResult,
@@ -36,25 +37,30 @@ export const usersApi = (username: string) => ({
    */
   orgs: (): Effect.Effect<UserOrgsResult, LayerErrors, Octokit> =>
     tapLayer(Context, ({ getUserOrgs }) => getUserOrgs(username)),
-  getIssuesCount: (): Effect.Effect<
-    UserIssuesCountResult,
-    LayerErrors,
-    Octokit
-  > =>
+  getIssuesCount: (
+    type: UserIssuesType,
+  ): Effect.Effect<UserIssuesCountResult, LayerErrors, Octokit> =>
     tapLayer(Context, ({ getUserIssuesCount }) =>
-      getUserIssuesCount({ username }),
+      getUserIssuesCount({ username, type }),
     ),
   /**
    * Github documentation:
    * https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-issues-and-pull-requests
    */
   searchIssues: (
+    type: UserIssuesType,
     query: string,
     fetchOnlyFirstPage = false,
     concurrency = defaultConcurrency,
   ): Effect.Effect<UserIssuesSearchResult, LayerErrors, Octokit> =>
     tapLayer(Context, ({ searchUserIssues }) =>
-      searchUserIssues({ username, query, fetchOnlyFirstPage, concurrency }),
+      searchUserIssues({
+        username,
+        type,
+        query,
+        fetchOnlyFirstPage,
+        concurrency,
+      }),
     ),
   getCommitsCount: (): Effect.Effect<
     UserCommitsCountResult,

src/layer/api/users.api.ts

@@ -20,6 +20,7 @@ describe('getUserIssuesCount effect', () => {
   const count = 2000;
   const args: GetUserIssuesCountArgs = {
     username: 'cool',
+    type: 'all',
   };
 
   beforeEach(() => {

src/layer/implementation/current-user/search-issues/get-user-issues-count.test.ts

@@ -2,10 +2,12 @@ import { Effect, pipe } from 'effect';
 
 import type { EffectResultSuccess } from '@types';
 
+import type { UserIssuesType } from './search-user-issues.type.js';
 import { searchUserIssuesPage } from './search-user-issues-page.js';
 
 export interface GetUserIssuesCountArgs {
   username: string;
+  type: UserIssuesType;
 }
 
 export const getUserIssuesCount = ({ ...args }: GetUserIssuesCountArgs) =>

src/layer/implementation/current-user/search-issues/get-user-issues-count.ts

@@ -20,6 +20,7 @@ vi.mock('@octokit/core');
 describe('searchUserIssuesPage effect', () => {
   const args: SearchUserIssuesPageArgs = {
     username: 'cool',
+    type: 'all',
     query: '',
     page: 1,
     perPage: 1,

src/layer/implementation/current-user/search-issues/search-user-issues-page.test.ts

@@ -1,25 +1,29 @@
 import { getOnePage } from '@implementation/generic';
 import type { EffectResultSuccess } from '@types';
 
-export interface SearchUserIssuesPageArgs {
-  username: string;
-  query: string;
+import type { SearchUserIssuesArgs } from './search-user-issues.type.js';
+
+export interface SearchUserIssuesPageArgs extends SearchUserIssuesArgs {
   page: number;
   perPage: number;
 }
 
 export const searchUserIssuesPage = ({
   query,
   username,
+  type,
   page,
   perPage,
-}: SearchUserIssuesPageArgs) =>
-  getOnePage('search-user-issues-page', 'GET /search/issues', {
-    q: `type:issue involves:${username} ${query}`,
+}: SearchUserIssuesPageArgs) => {
+  const typeQuery = type === 'all' ? '' : `type:${type}`;
+
+  return getOnePage('search-user-issues-page', 'GET /search/issues', {
+    q: `${typeQuery} involves:${username} ${query}`,
     page,
     per_page: perPage,
     advanced_search: 'true',
   });
+};
 
 export type SearchUserIssuesPageItems = EffectResultSuccess<
   typeof searchUserIssuesPage

src/layer/implementation/current-user/search-issues/search-user-issues-page.ts

@@ -9,13 +9,14 @@ import {
 } from '@tests/mock-data';
 import { octokitMock } from '@tests/mocks';
 
-import type { SearchUserIssuesArgs } from './search-user-issues.js';
+import type { SearchUserIssuesAggregatorArgs } from './search-user-issues.js';
 
 vi.mock('@octokit/core');
 
 describe('searchUserIssues effect', () => {
-  const args: SearchUserIssuesArgs = {
+  const args: SearchUserIssuesAggregatorArgs = {
     username: 'cool',
+    type: 'all',
     query: '',
   };
 

src/layer/implementation/current-user/search-issues/search-user-issues.test.ts

@@ -3,16 +3,15 @@ import { Effect, pipe } from 'effect';
 import { getAllSearchPages } from '@implementation/generic';
 import type { EffectResultSuccess } from '@types';
 
+import type { SearchUserIssuesArgs } from './search-user-issues.type.js';
 import { searchUserIssuesPage } from './search-user-issues-page.js';
 
-export interface SearchUserIssuesArgs {
-  username: string;
-  query: string;
+export interface SearchUserIssuesAggregatorArgs extends SearchUserIssuesArgs {
   fetchOnlyFirstPage?: boolean;
   concurrency?: number;
 }
 
-const getPage = (args: SearchUserIssuesArgs) => (page: number) =>
+const getPage = (args: SearchUserIssuesAggregatorArgs) => (page: number) =>
   searchUserIssuesPage({
     ...args,
     page,
@@ -22,7 +21,7 @@ const getPage = (args: SearchUserIssuesArgs) => (page: number) =>
 export const searchUserIssues = ({
   fetchOnlyFirstPage,
   ...args
-}: SearchUserIssuesArgs) =>
+}: SearchUserIssuesAggregatorArgs) =>
   pipe(
     Effect.gen(function* () {
       if (fetchOnlyFirstPage === true) {