narou 1.2.0 → 2.0.0

package/src/index.ts

@@ -1,4 +1,5 @@
 import type NarouNovel from "./narou.js";
+import type { ExecuteOptions } from "./narou.js";
 import NarouNovelFetch from "./narou-fetch.js";
 import NarouNovelJsonp from "./narou-jsonp.js";
 import RankingBuilder from "./ranking.js";
@@ -67,13 +68,16 @@ export function ranking(api: NarouNovel = narouNovelFetch): RankingBuilder {
 /**
  * なろう殿堂入り API でランキング履歴を取得する
  * @param {string} ncode 小説のNコード
+ * @param {ExecuteOptions} [options] 実行オプション
+ * @param {NarouNovel} [api] API実行クラスのインスタンス
  * @see https://dev.syosetu.com/man/rankinapi/
  */
 export async function rankingHistory(
   ncode: string,
+  options?: ExecuteOptions,
   api: NarouNovel = narouNovelFetch
 ): Promise<RankingHistoryResult[]> {
-  const result = await api.executeRankingHistory({ ncode });
+  const result = await api.executeRankingHistory({ ncode }, options);
   if (Array.isArray(result)) {
     return result.map(formatRankingHistory);
   } else {

package/src/narou-fetch.ts

@@ -1,6 +1,6 @@
 import { unzipp } from "./util/unzipp.js";
 import NarouNovel from "./narou.js";
-import type { NarouParams } from "./narou.js";
+import type { NarouParams, ExecuteOptions } from "./narou.js";
 
 type Fetch = typeof fetch;
 
@@ -18,7 +18,8 @@ export default class NarouNovelFetch extends NarouNovel {
 
   protected async execute<T>(
     params: NarouParams,
-    endpoint: string
+    endpoint: string,
+    options?: ExecuteOptions
   ): Promise<T> {
     const query = { ...params, out: "json" };
 
@@ -36,7 +37,7 @@ export default class NarouNovelFetch extends NarouNovel {
       }
     });
 
-    const res = await (this.fetch ?? fetch)(url);
+    const res = await (this.fetch ?? fetch)(url, options?.fetchOptions);
 
     if (!query.gzip) {
       return (await res.json()) as T;

package/src/narou-jsonp.ts

@@ -1,5 +1,5 @@
 import NarouNovel from "./narou.js";
-import type { NarouParams } from "./narou.js";
+import type { NarouParams, ExecuteOptions } from "./narou.js";
 import { jsonp } from "./util/jsonp.js";
 
 /**
@@ -8,7 +8,9 @@ import { jsonp } from "./util/jsonp.js";
 export default class NarouNovelJsonp extends NarouNovel {
   protected async execute<T>(
     params: NarouParams,
-    endpoint: string
+    endpoint: string,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _options?: ExecuteOptions
   ): Promise<T> {
     const query = { ...params, out: "jsonp" };
     query.gzip = 0;

package/src/narou.ts

@@ -21,6 +21,16 @@ export type NarouParams =
   | RankingHistoryParams
   | UserSearchParams;
 
+/**
+ * なろう小説APIへのリクエストオプション
+ */
+export interface ExecuteOptions {
+  /**
+   * fetch関数のオプション
+   */
+  fetchOptions?: RequestInit;
+}
+
 /**
  * なろう小説APIへのリクエストを実行する
  * @class NarouNovel
@@ -35,7 +45,8 @@ export default abstract class NarouNovel {
    */
   protected abstract execute<T>(
     params: NarouParams,
-    endpoint: string
+    endpoint: string,
+    options?: ExecuteOptions
   ): Promise<T>;
 
   /**
@@ -46,9 +57,13 @@ export default abstract class NarouNovel {
    */
   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>> {
-    return new NarouSearchResults(await this.execute(params, endpoint), params);
+    return new NarouSearchResults(
+      await this.execute(params, endpoint, options),
+      params
+    );
   }
 
   /**
@@ -58,11 +73,13 @@ export default abstract class NarouNovel {
    * @see https://dev.syosetu.com/man/api/
    */
   async executeNovel<T extends keyof NarouSearchResult>(
-    params: SearchParams
+    params: SearchParams,
+    options?: ExecuteOptions
   ): Promise<NarouSearchResults<NarouSearchResult, T>> {
     return await this.executeSearch(
       params,
-      "https://api.syosetu.com/novelapi/api/"
+      "https://api.syosetu.com/novelapi/api/",
+      options
     );
   }
 
@@ -73,11 +90,13 @@ export default abstract class NarouNovel {
    * @see https://dev.syosetu.com/xman/api/
    */
   async executeNovel18<T extends keyof NarouSearchResult>(
-    params: SearchParams
+    params: SearchParams,
+    options?: ExecuteOptions
   ): Promise<NarouSearchResults<NarouSearchResult, T>> {
     return await this.executeSearch(
       params,
-      "https://api.syosetu.com/novel18api/api/"
+      "https://api.syosetu.com/novel18api/api/",
+      options
     );
   }
 
@@ -87,20 +106,33 @@ export default abstract class NarouNovel {
    * @returns ランキング結果
    * @see https://dev.syosetu.com/man/rankapi/
    */
-  async executeRanking(params: RankingParams): Promise<NarouRankingResult[]> {
-    return await this.execute(params, "https://api.syosetu.com/rank/rankget/");
+  async executeRanking(
+    params: RankingParams,
+    options?: ExecuteOptions
+  ): Promise<NarouRankingResult[]> {
+    return await this.execute(
+      params,
+      "https://api.syosetu.com/rank/rankget/",
+      options
+    );
   }
 
   /**
    * 殿堂入りAPiへのリクエストを実行する
    * @param params クエリパラメータ
+   * @param options 実行オプション
    * @returns ランキング履歴結果
    * @see https://dev.syosetu.com/man/rankinapi/
    */
   async executeRankingHistory(
-    params: RankingHistoryParams
+    params: RankingHistoryParams,
+    options?: ExecuteOptions
   ): Promise<RankingHistoryRawResult[]> {
-    return await this.execute(params, "https://api.syosetu.com/rank/rankin/");
+    return await this.execute(
+      params,
+      "https://api.syosetu.com/rank/rankin/",
+      options
+    );
   }
 
   /**
@@ -110,10 +142,15 @@ export default abstract class NarouNovel {
    * @see https://dev.syosetu.com/man/userapi/
    */
   async executeUserSearch<T extends keyof UserSearchResult>(
-    params: UserSearchParams
+    params: UserSearchParams,
+    options?: ExecuteOptions
   ): Promise<NarouSearchResults<UserSearchResult, T>> {
     return new NarouSearchResults<UserSearchResult, T>(
-      await this.execute(params, "https://api.syosetu.com/userapi/api/"),
+      await this.execute(
+        params,
+        "https://api.syosetu.com/userapi/api/",
+        options
+      ),
       params
     );
   }

package/src/params.ts

@@ -372,7 +372,7 @@ export const Order = {
   /** ブックマーク数の多い順 */
   FavoriteNovelCount: "favnovelcnt",
   /** レビュー数の多い順 */
-  ReviewCount: "favnovelcnt",
+  ReviewCount: "reviewcnt",
   /** 総合ポイントの高い順 */
   HyokaDesc: "hyoka",
   /** 総合ポイントの低い順 */

package/src/ranking.ts

@@ -11,6 +11,7 @@ import {
   Fields,
 } from "./params.js";
 import type NarouNovel from "./narou.js";
+import type { ExecuteOptions } from "./narou.js";
 import type { SearchResultFields } from "./narou-search-results.js";
 import { addDays, formatDate } from "./util/date.js";
 
@@ -108,21 +109,24 @@ export default class RankingBuilder {
    * 設定されたパラメータに基づき、なろう小説ランキングAPIへのリクエストを実行します。
    *
    * 返される結果には、Nコード、ポイント、順位が含まれます。
+   * @param options 実行オプション
    * @returns {Promise<NarouRankingResult[]>} ランキング結果の配列
    * @see https://dev.syosetu.com/man/rankapi/#output
    */
-  execute(): Promise<NarouRankingResult[]> {
+  execute(options?: ExecuteOptions): Promise<NarouRankingResult[]> {
     const date = formatDate(this.date$);
     this.set({ rtype: `${date}-${this.type$}` });
-    return this.api.executeRanking(this.params as RankingParams);
+    return this.api.executeRanking(this.params as RankingParams, options);
   }
 
   /**
    * ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
    */
-  async executeWithFields(): Promise<
-    RankingResult<DefaultSearchResultFields>[]
-  >;
+  async executeWithFields(
+    fields?: never[] | undefined,
+    opt?: never[] | undefined,
+    options?: ExecuteOptions
+  ): Promise<RankingResult<DefaultSearchResultFields>[]>;
   /**
    * ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
    *
@@ -131,7 +135,9 @@ export default class RankingBuilder {
    * @returns {Promise<RankingResult<SearchResultFields<TFields>>[]>} 詳細情報を含むランキング結果の配列
    */
   async executeWithFields<TFields extends Fields>(
-    fields: TFields | TFields[]
+    fields: TFields | TFields[],
+    opt?: never | never[],
+    options?: ExecuteOptions
   ): Promise<RankingResult<SearchResultFields<TFields>>[]>;
   /**
    * ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
@@ -141,7 +147,8 @@ export default class RankingBuilder {
    */
   async executeWithFields(
     fields: never[],
-    opt: OptionalFields | OptionalFields[]
+    opt: OptionalFields | OptionalFields[],
+    options?: ExecuteOptions
   ): Promise<RankingResult<DefaultSearchResultFields | "weekly_unique">[]>;
   /**
    * ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
@@ -153,7 +160,8 @@ export default class RankingBuilder {
    */
   async executeWithFields<TFields extends Fields>(
     fields: TFields | TFields[],
-    opt: OptionalFields | OptionalFields[]
+    opt: OptionalFields | OptionalFields[],
+    options?: ExecuteOptions
   ): Promise<RankingResult<SearchResultFields<TFields> | "weekly_unique">[]>;
   /**
    * ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
@@ -169,9 +177,10 @@ export default class RankingBuilder {
     TOpt extends OptionalFields | undefined = undefined
   >(
     fields: TFields | TFields[] = [],
-    opt?: TOpt
+    opt?: TOpt,
+    options?: ExecuteOptions
   ): Promise<RankingResult<SearchResultFields<TFields>>[]> {
-    const ranking = await this.execute();
+    const ranking = await this.execute(options);
     const fields$ = Array.isArray(fields)
       ? fields.length == 0
         ? []
@@ -186,7 +195,7 @@ export default class RankingBuilder {
     }
     builder.ncode(rankingNcodes);
     builder.limit(ranking.length);
-    const result = await builder.execute();
+    const result = await builder.execute(options);
 
     return ranking.map<
       RankingResult<

package/src/search-builder-r18.ts

@@ -1,4 +1,5 @@
 import { NovelSearchBuilderBase } from "./search-builder.js";
+import type { ExecuteOptions } from "./narou.js";
 import type NarouSearchResults from "./narou-search-results.js";
 import type {
   NarouSearchResult,
@@ -28,10 +29,13 @@ export default class SearchBuilderR18<
   /**
    * なろう小説APIへの検索リクエストを実行する
    * @override
+   * @param options 実行オプション
    * @returns {Promise<NarouSearchResults>} 検索結果
    */
-  execute(): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>> {
-    return this.api.executeNovel18(this.params);
+  execute(
+    options?: ExecuteOptions
+  ): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>> {
+    return this.api.executeNovel18(this.params, options);
   }
 
   /**

package/src/search-builder.ts

@@ -1,4 +1,5 @@
 import type NarouNovel from "./narou.js";
+import type { ExecuteOptions } from "./narou.js";
 import type {
   NarouSearchResult,
   SearchResultFields,
@@ -40,7 +41,7 @@ export abstract class SearchBuilderBase<
   constructor(
     protected params: TParams = {} as TParams,
     protected api: NarouNovel
-  ) {}
+  ) { }
 
   /**
    * 配列から重複を除去する
@@ -472,10 +473,13 @@ export abstract class NovelSearchBuilderBase<
 
   /**
    * なろう小説APIへの検索リクエストを実行する
+   * @param options 実行オプション
    * @returns {Promise<NarouSearchResults>} 検索結果
    */
-  execute(): Promise<NarouSearchResults<NarouSearchResult, T>> {
-    return this.api.executeNovel(this.params);
+  execute(
+    options?: ExecuteOptions
+  ): Promise<NarouSearchResults<NarouSearchResult, T>> {
+    return this.api.executeNovel(this.params, options);
   }
 }
 

package/src/user-search.ts

@@ -5,6 +5,7 @@ import type {
 } from "./narou-search-results.js";
 import type { UserFields, UserOrder, UserSearchParams } from "./params.js";
 import { SearchBuilderBase } from "./search-builder.js";
+import type { ExecuteOptions } from "./narou.js";
 
 /**
  * なろうユーザ検索API
@@ -102,9 +103,15 @@ export default class UserSearchBuilder<
 
   /**
    * なろう小説APIへのリクエストを実行する
+   * @param options 実行オプション
    * @returns ランキング
    */
-  execute(): Promise<NarouSearchResults<UserSearchResult, TField>> {
-    return this.api.executeUserSearch(this.params as UserSearchParams);
+  execute(
+    options?: ExecuteOptions
+  ): Promise<NarouSearchResults<UserSearchResult, TField>> {
+    return this.api.executeUserSearch(
+      this.params as UserSearchParams,
+      options
+    );
   }
 }

package/dist/chunk-3A5MHPWL.js

@@ -1,37 +0,0 @@
-// src/narou-search-results.ts
-var NarouSearchResults = class {
-  /**
-   * @constractor
-   * @private
-   */
-  constructor([header, ...result], params) {
-    const count = header.allcount;
-    const limit = params.lim ?? 20;
-    const start = params.st ?? 0;
-    this.allcount = count;
-    this.limit = limit;
-    this.start = start;
-    this.page = start / limit;
-    this.length = result.length;
-    this.values = result;
-  }
-};
-var NovelType = {
-  /** 連載 */
-  Rensai: 1,
-  /** 短編 */
-  Tanpen: 2
-};
-var End = {
-  /** 短編小説と完結済小説 */
-  KanketsuOrTanpen: 0,
-  /** 連載中 */
-  Rensai: 1
-};
-
-export {
-  NarouSearchResults,
-  NovelType,
-  End
-};
-//# sourceMappingURL=chunk-3A5MHPWL.js.map

package/dist/chunk-3A5MHPWL.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/narou-search-results.ts"],"sourcesContent":["import type {\n  BooleanNumber as BooleanNumber,\n  Genre,\n  R18Site,\n  SearchParams,\n  Fields,\n  BigGenre,\n  R18Fields,\n  OptionalFields,\n  UserFields,\n  UserSearchParams,\n} from \"./params.js\";\n\n/**\n * なろう小説API検索結果\n */\nexport default class NarouSearchResults<T, TKey extends keyof T> {\n  /**\n   * 検索結果数\n   */\n  allcount: number;\n  /**\n   * 結果表示上限数\n   */\n  limit: number;\n  /**\n   * 結果表示開始数\n   */\n  start: number;\n  /**\n   * 結果表示の現在ページ(=start/limit)\n   */\n  page: number;\n  /**\n   * 今回取得できた検索結果の数\n   */\n  length: number;\n  /**\n   * 検索結果\n   */\n  values: readonly Pick<T, TKey>[];\n\n  /**\n   * @constractor\n   * @private\n   */\n  constructor(\n    [header, ...result]: [{ allcount: number }, ...Pick<T, TKey>[]],\n    params: SearchParams | UserSearchParams\n  ) {\n    const count = header.allcount;\n    const limit = params.lim ?? 20;\n    const start = params.st ?? 0;\n\n    this.allcount = count;\n    this.limit = limit;\n    this.start = start;\n    this.page = start / limit;\n    this.length = result.length;\n    this.values = result;\n  }\n}\n\n/**\n * 小説情報\n * @see https://dev.syosetu.com/man/api/#output\n * @see https://dev.syosetu.com/xman/api/#output\n */\nexport interface NarouSearchResult {\n  /** 小説名 */\n  title: string;\n  /** Nコード */\n  ncode: string;\n  /** 作者のユーザID(数値) */\n  userid: number;\n  /** 作者名 */\n  writer: string;\n  /** 小説のあらすじ */\n  story: string;\n  /** 掲載サイト */\n  nocgenre: R18Site;\n  /** 大ジャンル */\n  biggenre: BigGenre;\n  /** ジャンル */\n  genre: Genre;\n  /** キーワード */\n  keyword: string;\n  /** 初回掲載日 YYYY-MM-DD HH:MM:SSの形式 */\n  general_firstup: string;\n  /** 最終掲載日 YYYY-MM-DD HH:MM:SSの形式 */\n  general_lastup: string;\n  /** 連載の場合は1、短編の場合は2 */\n  novel_type: NovelType;\n  /** 連載の場合は1、短編の場合は2 */\n  noveltype: NovelType;\n  /** 短編小説と完結済小説は0となっています。連載中は1です。 */\n  end: End;\n  /** 全掲載話数です。短編の場合は1です。 */\n  general_all_no: number;\n  /** 小説文字数です。スペースや改行は文字数としてカウントしません。 */\n  length: number;\n  /** 読了時間(分単位)です。読了時間は小説文字数÷500を切り上げした数値です。 */\n  time: number;\n  /** 長期連載中は1、それ以外は0です。 */\n  isstop: BooleanNumber;\n  /** 登録必須キーワードに「R15」が含まれる場合は1、それ以外は0です。 */\n  isr15: BooleanNumber;\n  /** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */\n  isbl: BooleanNumber;\n  /** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */\n  isgl: BooleanNumber;\n  /** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */\n  iszankoku: BooleanNumber;\n  /** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */\n  istensei: BooleanNumber;\n  /** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */\n  istenni: BooleanNumber;\n  /** 総合得点(=(ブックマーク数×2)+評価点) */\n  global_point: number;\n  /**\n   * 日間ポイント\n   * ランキング集計時点から過去24時間以内で新たに登録されたブックマークや評価が対象\n   */\n  daily_point: number;\n  /**\n   * 週間ポイント\n   * ランキング集計時点から過去7日以内で新たに登録されたブックマークや評価が対象\n   */\n  weekly_point: number;\n  /**\n   * 月間ポイント\n   * ランキング集計時点から過去30日以内で新たに登録されたブックマークや評価が対象\n   */\n  monthly_point: number;\n  /**\n   * 四半期ポイント\n   * ランキング集計時点から過去90日以内で新たに登録されたブックマークや評価が対象\n   */\n  quarter_point: number;\n  /**\n   * 年間ポイント\n   * ランキング集計時点から過去365日以内で新たに登録されたブックマークや評価が対象\n   */\n  yearly_point: number;\n  /** ブックマーク数 */\n  fav_novel_cnt: number;\n  /** 感想数 */\n  impression_cnt: number;\n  /** レビュー数 */\n  review_cnt: number;\n  /** 評価ポイント */\n  all_point: number;\n  /** 評価者数 */\n  all_hyoka_cnt: number;\n  /** 挿絵の数 */\n  sasie_cnt: number;\n  /**\n   * 会話率\n   * @see https://dev.syosetu.com/man/kaiwa/\n   */\n  kaiwaritu: number;\n  /**\n   * 小説の更新日時\n   */\n  novelupdated_at: string;\n  /**\n   * 最終更新日時\n   * システム用で小説更新時とは関係ありません\n   */\n  updated_at: string;\n  /** 週間ユニークユーザー数 */\n  weekly_unique: number;\n}\n\n/**\n * ユーザ情報\n * @see https://dev.syosetu.com/man/userapi/#output\n */\nexport interface UserSearchResult {\n  /** ユーザID */\n  userid: number;\n  /** ユーザ名 */\n  name: string;\n  /** ユーザ名のフリガナ */\n  yomikata: string;\n  /**\n   * ユーザ名のフリガナの頭文字\n   * ひらがな以外の場合はnullまたは空文字となります。\n   */\n  name1st: string;\n  /** 小説投稿数 */\n  novel_cnt: number;\n  /** レビュー投稿数 */\n  review_cnt: number;\n  /**\n   * 小説累計文字数\n   * スペースや改行は文字数としてカウントしません。\n   */\n  novel_length: number;\n  /**\n   * 総合評価ポイントの合計\n   * 投稿済小説でそれぞれ獲得した総合評価ポイントの合計です。\n   */\n  sum_global_point: number;\n}\n\n/**\n * noveltype/novel_typeの値ヘルパー\n */\nexport const NovelType = {\n  /** 連載 */\n  Rensai: 1,\n  /** 短編 */\n  Tanpen: 2,\n} as const;\nexport type NovelType = typeof NovelType[keyof typeof NovelType];\n\n/**\n * endの値ヘルパー\n */\nexport const End = {\n  /** 短編小説と完結済小説 */\n  KanketsuOrTanpen: 0,\n  /** 連載中 */\n  Rensai: 1,\n} as const;\nexport type End = typeof End[keyof typeof End];\n\nexport type SearchResultFields<T extends Fields> = {\n  [K in keyof typeof Fields]: typeof Fields[K] extends T ? K : never;\n}[keyof typeof Fields];\n\nexport type SearchResultOptionalFields<T extends OptionalFields> = {\n  [K in keyof typeof OptionalFields]: typeof OptionalFields[K] extends T\n  ? K\n  : never;\n}[keyof typeof OptionalFields];\n\nexport type SearchResultR18Fields<T extends R18Fields> = {\n  [K in keyof typeof R18Fields]: typeof R18Fields[K] extends T ? K : never;\n}[keyof typeof R18Fields];\n\nexport type UserSearchResultFields<T extends UserFields> = {\n  [K in keyof typeof UserFields]: typeof UserFields[K] extends T ? K : never;\n}[keyof typeof UserFields];\n\nexport type PickedNarouSearchResult<T extends keyof NarouSearchResult> = Pick<\n  NarouSearchResult,\n  T\n>;\n"],"mappings":";AAgBA,IAAqB,qBAArB,MAAiE;AAAA;AAAA;AAAA;AAAA;AAAA,EA8B/D,YACE,CAAC,QAAQ,GAAG,MAAM,GAClB,QACA;AACA,UAAM,QAAQ,OAAO;AACrB,UAAM,QAAQ,OAAO,OAAO;AAC5B,UAAM,QAAQ,OAAO,MAAM;AAE3B,SAAK,WAAW;AAChB,SAAK,QAAQ;AACb,SAAK,QAAQ;AACb,SAAK,OAAO,QAAQ;AACpB,SAAK,SAAS,OAAO;AACrB,SAAK,SAAS;AAAA,EAChB;AACF;AAoJO,IAAM,YAAY;AAAA;AAAA,EAEvB,QAAQ;AAAA;AAAA,EAER,QAAQ;AACV;AAMO,IAAM,MAAM;AAAA;AAAA,EAEjB,kBAAkB;AAAA;AAAA,EAElB,QAAQ;AACV;","names":[]}

package/dist/chunk-4ZP5YNWI.js

@@ -1 +0,0 @@
-//# sourceMappingURL=chunk-4ZP5YNWI.js.map

package/dist/chunk-4ZP5YNWI.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}