Add fetch options support via execute options bag #208

deflis · 2025-12-09T21:14:11Z

Summary

add an ExecuteOptions bag to Narou client methods to pass fetch settings
propagate optional fetch options through builders and ranking helpers
cover fetch option forwarding with a new NarouNovelFetch test and export the type

Testing

pnpm vitest run test/narou-fetch.test.ts

Codex Task

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2025-12-09T21:16:49Z

src/ranking.ts

    fields: TFields | TFields[] = [],
-    opt?: TOpt
+    opt?: TOpt,
+    options?: ExecuteOptions
  ): Promise<RankingResult<SearchResultFields<TFields>>[]> {
-    const ranking = await this.execute();
+    const ranking = await this.execute(options);


executeWithFields drops ExecuteOptions

executeWithFields advertises overloads that accept an ExecuteOptions bag either as the only argument or as the second argument, but the implementation still treats the second parameter as opt and only forwards the third parameter to execute. If a caller passes ExecuteOptions (with fetchOptions) to rank-with-fields—e.g., executeWithFields(options) or executeWithFields(fields, options)—the options object is instead consumed as fields/opt (polluting the query) and never reaches execute or builder.execute, so the new fetch options support is broken for this helper.

Useful? React with 👍 / 👎.

Copilot

Pull request overview

This PR adds support for passing fetch options to the Narou API client by introducing an ExecuteOptions bag pattern. This enables users to customize fetch behavior (headers, method, etc.) when making API requests in Node.js environments.

Key Changes

Introduced ExecuteOptions type with optional fetchOptions property to wrap RequestInit
Threaded the options parameter through all execute methods in the base NarouNovel class and concrete implementations
Propagated options through all builder classes (search, R18, user, ranking) to maintain the fluent API
Added test coverage for fetch option forwarding with a custom fetch mock

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
src/narou.ts	Added `ExecuteOptions` type and threaded `options` parameter through all execute methods
src/narou-fetch.ts	Updated to pass `options?.fetchOptions` to the fetch implementation
src/narou-jsonp.ts	Added `_options` parameter (intentionally unused for JSONP) for signature compatibility
src/search-builder.ts	Updated `execute()` to accept and forward options
src/search-builder-r18.ts	Updated `execute()` to accept and forward options
src/user-search.ts	Updated `execute()` to accept and forward options
src/ranking.ts	Updated `execute()` and `executeWithFields()` overloads to accept and forward options
src/index.common.ts	Exported `ExecuteOptions` type for public API consumers
test/narou-fetch.test.ts	Added test verifying fetch options are correctly passed to fetch implementation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-09T21:20:18Z

src/search-builder-r18.ts

+  execute(
+    options?: ExecuteOptions
+  ): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>> {


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Update the JSDoc to:

/** * なろう小説APIへの検索リクエストを実行する * @override * @param options 実行オプション（fetchオプションなど） * @returns {Promise<NarouSearchResults>} 検索結果 */

Copilot · 2025-12-09T21:20:19Z

src/user-search.ts

+  execute(
+    options?: ExecuteOptions
+  ): Promise<NarouSearchResults<UserSearchResult, TField>> {


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Update the JSDoc to:

/** * なろう小説APIへのリクエストを実行する * @param options 実行オプション（fetchオプションなど） * @returns ランキング */

Copilot · 2025-12-09T21:20:19Z

src/ranking.ts

+  async executeWithFields(
+    options?: ExecuteOptions
+  ): Promise<RankingResult<DefaultSearchResultFields>[]>;


Missing JSDoc @param documentation for the new options parameter. While this is an overload signature without a body, it should still document the parameter for API consumers.

Add @param documentation:

/** * ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。 * @param options 実行オプション（fetchオプションなど） */

Copilot · 2025-12-09T21:20:19Z

src/narou.ts


+export type ExecuteOptions = {


Missing JSDoc documentation for the ExecuteOptions type. As a public API type that's exported in index.common.ts, it should have documentation explaining its purpose and usage.

Add JSDoc:

/** * なろう小説APIの実行オプション */ export type ExecuteOptions = { /** * fetch APIに渡すオプション (Node.js環境でのみ使用可能) */ fetchOptions?: RequestInit; };

Suggested change

export type ExecuteOptions = {

/**

* なろう小説APIの実行オプション

*/

export type ExecuteOptions = {

/**

* fetch APIに渡すオプション (Node.js環境でのみ使用可能)

*/

Copilot · 2025-12-09T21:20:20Z

src/narou.ts

+  async executeRanking(
+    params: RankingParams,
+    options?: ExecuteOptions
+  ): Promise<NarouRankingResult[]> {


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Add after the @param params line:

* @param options 実行オプション（fetchオプションなど）

Copilot · 2025-12-09T21:20:21Z

src/ranking.ts

  async executeWithFields<TFields extends Fields>(
-    fields: TFields | TFields[]
+    fields: TFields | TFields[],
+    options?: ExecuteOptions
  ): Promise<RankingResult<SearchResultFields<TFields>>[]>;


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Add @param documentation after the @param fields line:

* @param options 実行オプション（fetchオプションなど）

Copilot · 2025-12-09T21:20:21Z

src/ranking.ts

  async executeWithFields(
    fields: never[],
-    opt: OptionalFields | OptionalFields[]
+    opt: OptionalFields | OptionalFields[],
+    options?: ExecuteOptions
  ): Promise<RankingResult<DefaultSearchResultFields | "weekly_unique">[]>;


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Add @param documentation after the @param opt line:

* @param options 実行オプション（fetchオプションなど）

Copilot · 2025-12-09T21:20:22Z

src/narou.ts

  async executeNovel<T extends keyof NarouSearchResult>(
-    params: SearchParams
+    params: SearchParams,
+    options?: ExecuteOptions
  ): Promise<NarouSearchResults<NarouSearchResult, T>> {


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Add after the @param params line:

* @param options 実行オプション（fetchオプションなど）

Copilot · 2025-12-09T21:20:22Z

src/search-builder.ts

+  execute(options?: ExecuteOptions): Promise<
+    NarouSearchResults<NarouSearchResult, T>
+  > {


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Update the JSDoc to:

/** * なろう小説APIへの検索リクエストを実行する * @param options 実行オプション（fetchオプションなど） * @returns {Promise<NarouSearchResults>} 検索結果 */

Copilot · 2025-12-09T21:20:22Z

src/narou.ts

  protected async executeSearch<T extends keyof NarouSearchResult>(
    params: SearchParams,
-    endpoint = "https://api.syosetu.com/novelapi/api/"
+    endpoint = "https://api.syosetu.com/novelapi/api/",
+    options?: ExecuteOptions
  ): Promise<NarouSearchResults<NarouSearchResult, T>> {


Missing JSDoc @param documentation for the new options parameter. The JSDoc should be updated to document this parameter.

Add:

/** * APIへの検索リクエストを実行する * @param params クエリパラメータ * @param endpoint APIエンドポイント * @param options 実行オプション（fetchオプションなど） * @returns 検索結果 */

Add fetch options support via execute options bag

89345cd

Copilot AI review requested due to automatic review settings December 9, 2025 21:14

deflis added the codex label Dec 9, 2025 — with ChatGPT Codex Connector

Copilot started reviewing on behalf of deflis December 9, 2025 21:14 View session

chatgpt-codex-connector bot reviewed Dec 9, 2025

View reviewed changes

Copilot AI reviewed Dec 9, 2025

View reviewed changes

deflis added 2 commits December 10, 2025 12:47

Mock narou API responses in tests

3603f8d

Restore narou tests to external API calls

d8087d1

Add fetch options support via execute options bag #208

Are you sure you want to change the base?

Add fetch options support via execute options bag #208

Uh oh!

Conversation

deflis commented Dec 9, 2025

Summary

Testing

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants