narou 1.1.0 → 2.0.0

package/src/util/jsonp.ts

@@ -13,30 +13,75 @@ declare global {
     [key: CallbackId]: (data: any) => void;
   }
 }
+
+/**
+ * JSONP呼び出しのオプション設定
+ */
 export type JsonpOption = {
+  /**
+   * コールバック関数名のプレフィックス
+   * @default "__jp"
+   */
   prefix?: string;
+  
+  /**
+   * コールバック関数名を指定するURLパラメータ名
+   * @default "callback"
+   */
   param?: string;
+  
+  /**
+   * タイムアウト時間（ミリ秒）
+   * @default 15000
+   */
   timeout?: number;
 };
 
- 
-const noop = function () {};
+const noop = function () { };
 
+/**
+ * JSONPリクエストを実行してデータを取得します。
+ * 
+ * @param url - リクエスト先のURL
+ * @param options - JSONP呼び出しのオプション設定
+ * @returns JSONPリクエストの結果をPromiseで返します
+ * @throws {Error} タイムアウトが発生した場合、"Timeout"メッセージのエラーをスローします
+ * 
+ * @example
+ * ```typescript
+ * // 基本的な使用方法
+ * const data = await jsonp<ResponseType>('https://example.com/api');
+ * 
+ * // オプション指定
+ * const data = await jsonp<ResponseType>('https://example.com/api', {
+ *   prefix: 'customPrefix',
+ *   param: 'callbackParam',
+ *   timeout: 10000
+ * });
+ * ```
+ */
 export function jsonp<T>(
   url: string,
   { prefix = "__jp", param = "callback", timeout = 15000 }: JsonpOption = {}
 ): Promise<T> {
   return new Promise(function (resolve, reject) {
+    // 最初のscriptタグを取得し、そのタグの直前に新しいscriptタグを挿入するための参照を取得
+    // これにより、ページの構造を大きく変えることなくscriptを追加できる
     const targetChild = document.getElementsByTagName("script").item(0);
     const target = targetChild?.parentNode ?? document.head;
 
+    // ユニークなコールバック関数名を生成
     const id: CallbackId = `${prefix}${count++}`;
+    
+    // リソース解放用の関数を定義
+    // スクリプトタグの削除、コールバック関数のクリーンアップ、タイマーのクリアを行う
     const cleanup = function () {
       // Remove the script tag.
       if (script && script.parentNode) {
         script.parentNode.removeChild(script);
       }
 
+      // コールバック関数を空の関数に置き換えてメモリリークを防止
       window[id] = noop;
 
       if (timer) {
@@ -44,25 +89,35 @@ export function jsonp<T>(
       }
     };
 
+    // タイムアウト処理の設定
+    // 指定された時間内にレスポンスがない場合はエラーとして処理
     const timer =
       timeout > 0
         ? setTimeout(() => {
-            cleanup();
-            reject(new Error("Timeout"));
-          }, timeout)
+          cleanup();
+          reject(new Error("Timeout"));
+        }, timeout)
         : undefined;
 
+    // サーバーからのレスポンスを処理するコールバック関数
     const callback = (data: T) => {
       cleanup();
       resolve(data);
     };
+    
+    // グローバルスコープにコールバック関数を登録
+    // これによりJSONPのレスポンスから関数が呼び出せるようになる
     window[id] = callback;
 
-    // Create script.
+    // JSONPリクエスト用のscriptタグを作成
     const script = document.createElement("script");
     const urlObj = new URL(url);
+    
+    // URLにコールバック関数名をパラメータとして追加
     urlObj.searchParams.set(param, id);
     script.setAttribute("src", urlObj.toString());
+    
+    // DOMにscriptタグを挿入し、リクエストを開始
     target.insertBefore(script, targetChild);
   });
 }

package/src/util/type.ts

@@ -1,3 +1,26 @@
+/**
+ * 文字列に変換可能な型を表します。
+ * 
+ * このタイプには以下が含まれます：
+ * - `string`: 文字列プリミティブ
+ * - `number`: 数値
+ * - `bigint`: 任意精度の整数
+ * - `boolean`: 真/偽の値
+ * - `null`: null値
+ * - `undefined`: undefined値
+ * 
+ * これらの型はすべて、文字列連結や文字列変換可能な値を期待する関数で安全に使用できます。
+ */
 type Stringable = string | number | bigint | boolean | null | undefined;
 
+/**
+ * ハイフンで結合された2つの文字列変換可能な値、または単一の値を表すユーティリティタイプ。
+ * 
+ * @template T - 文字列に変換可能な型
+ * @returns `${T}-${T}` (ハイフンで結合された2つの値) または `${T}` (単一の値)
+ * 
+ * @example
+ * type Numbers = 1 | 2 | 3;
+ * type JoinedNumbers = Join<Numbers>; // '1' | '2' | '3' | '1-1' | '1-2' | '1-3' | '2-1' | '2-2' | '2-3' | '3-1' | '3-2' | '3-3'
+ */
 export type Join<T extends Stringable> = `${T}-${T}` | `${T}`;

package/src/util/unzipp.ts

@@ -4,6 +4,15 @@ import { promisify } from "util";
 const gunzipAsync = promisify<InputType, Buffer>(gunzip);
 
 const decoder = new TextDecoder()
+/**
+ * 圧縮されたJSONデータを解凍して解析します。
+ * 
+ * @param data - ArrayBuffer形式の圧縮データ
+ * @returns 解凍されたデータからパースされたJSONオブジェクト
+ * @throws {string} データが解凍できない、または解凍されたデータが有効なJSONでない場合、
+ *                  解凍されたデータの文字列表現をスローします。
+ * @throws {string} 解凍中にエラーが発生した場合、元のデータの文字列表現をスローします。
+ */
 export async function unzipp(data: ArrayBuffer) {
   try {
     const buffer = await gunzipAsync(data);

package/dist/chunk-4VC3246A.js

@@ -1,83 +0,0 @@
-import {
-  SearchBuilder
-} from "./chunk-P7QOZBII.js";
-import {
-  Fields,
-  RankingType
-} from "./chunk-CDOBNSCL.js";
-
-// src/ranking.ts
-import { addDays, format } from "date-fns";
-var dateFormat = "yyyyMMdd";
-var RankingBuilder = class {
-  /**
-   * constructor
-   * @private
-   */
-  constructor(params = {}, api) {
-    this.params = params;
-    this.api = api;
-    this.date$ = addDays(Date.now(), -1);
-    this.type$ = RankingType.Daily;
-  }
-  date(date) {
-    this.date$ = date;
-    return this;
-  }
-  type(type) {
-    this.type$ = type;
-    return this;
-  }
-  /**
-   * gzip圧縮する。
-   *
-   * 転送量上限を減らすためにも推奨
-   * @param {GzipLevel} level gzip圧縮レベル(1～5)
-   * @return {RankingBuilder} this
-   */
-  gzip(level) {
-    this.set({ gzip: level });
-    return this;
-  }
-  /**
-   * クエリパラメータをセットする
-   * @private
-   * @return {RankingBuilder} this
-   */
-  set(obj) {
-    Object.assign(this.params, obj);
-    return this;
-  }
-  /**
-   * なろう小説APIへのリクエストを実行する
-   * @returns ランキング
-   */
-  execute() {
-    const date = format(this.date$, dateFormat);
-    this.set({ rtype: `${date}-${this.type$}` });
-    return this.api.executeRanking(this.params);
-  }
-  async executeWithFields(fields = [], opt) {
-    const ranking = await this.execute();
-    const fields$ = Array.isArray(fields) ? fields.length == 0 ? [] : [...fields, Fields.ncode] : [fields, Fields.ncode];
-    const rankingNcodes = ranking.map(({ ncode }) => ncode);
-    const builder = new SearchBuilder({}, this.api);
-    builder.fields(fields$);
-    if (opt) {
-      builder.opt(opt);
-    }
-    builder.ncode(rankingNcodes);
-    builder.limit(ranking.length);
-    const result = await builder.execute();
-    return ranking.map((r) => ({
-      ...r,
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      ...result.values.find((novel) => novel.ncode == r.ncode)
-    }));
-  }
-};
-
-export {
-  RankingBuilder
-};
-//# sourceMappingURL=chunk-4VC3246A.js.map

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/ranking.ts"],"sourcesContent":["import type { NarouRankingResult, RankingResult } from \"./narou-ranking-results.js\";\nimport SearchBuilder from \"./search-builder.js\";\nimport type { DefaultSearchResultFields } from \"./search-builder.js\";\nimport { addDays, format } from \"date-fns\";\nimport type {\n  GzipLevel,\n  OptionalFields,\n} from \"./params.js\";\nimport {\n  RankingParams,\n  RankingType,\n  Fields,\n} from \"./params.js\";\nimport type NarouNovel from \"./narou.js\";\nimport type { SearchResultFields } from \"./narou-search-results.js\";\n\nconst dateFormat = \"yyyyMMdd\";\n\n/**\n * ランキングヘルパー\n * @class Ranking\n */\nexport default class RankingBuilder {\n  protected date$: Date;\n  protected type$: RankingType;\n\n  /**\n   * constructor\n   * @private\n   */\n  constructor(\n    protected params: Partial<RankingParams> = {},\n    protected api: NarouNovel\n  ) {\n    /**\n     * クエリパラメータ\n     * @protected\n     */\n    this.date$ = addDays(Date.now(), -1);\n    this.type$ = RankingType.Daily;\n  }\n\n  date(date: Date) {\n    this.date$ = date;\n    return this;\n  }\n\n  type(type: RankingType) {\n    this.type$ = type;\n    return this;\n  }\n\n  /**\n   * gzip圧縮する。\n   *\n   * 転送量上限を減らすためにも推奨\n   * @param {GzipLevel} level gzip圧縮レベル(1～5)\n   * @return {RankingBuilder} this\n   */\n  gzip(level: GzipLevel) {\n    this.set({ gzip: level });\n    return this;\n  }\n\n  /**\n   * クエリパラメータをセットする\n   * @private\n   * @return {RankingBuilder} this\n   */\n  protected set(obj: Partial<RankingParams>) {\n    Object.assign(this.params, obj);\n    return this;\n  }\n\n  /**\n   * なろう小説APIへのリクエストを実行する\n   * @returns ランキング\n   */\n  execute(): Promise<NarouRankingResult[]> {\n    const date = format(this.date$, dateFormat);\n    this.set({ rtype: `${date}-${this.type$}` });\n    return this.api.executeRanking(this.params as RankingParams);\n  }\n\n  async executeWithFields(): Promise<\n    RankingResult<DefaultSearchResultFields>[]\n  >;\n\n  async executeWithFields<TFields extends Fields>(\n    fields: TFields | TFields[]\n  ): Promise<RankingResult<SearchResultFields<TFields>>[]>;\n\n  async executeWithFields(\n    fields: never[],\n    opt: OptionalFields | OptionalFields[]\n  ): Promise<RankingResult<DefaultSearchResultFields | \"weekly_unique\">[]>;\n\n  async executeWithFields<TFields extends Fields>(\n    fields: TFields | TFields[],\n    opt: OptionalFields | OptionalFields[]\n  ): Promise<RankingResult<SearchResultFields<TFields> | \"weekly_unique\">[]>;\n\n  async executeWithFields<\n    TFields extends Fields,\n    TOpt extends OptionalFields | undefined = undefined\n  >(\n    fields: TFields | TFields[] = [],\n    opt?: TOpt\n  ): Promise<RankingResult<SearchResultFields<TFields>>[]> {\n    const ranking = await this.execute();\n    const fields$ = Array.isArray(fields)\n      ? fields.length == 0\n        ? []\n        : ([...fields, Fields.ncode] as const)\n      : ([fields, Fields.ncode] as const);\n\n    const rankingNcodes = ranking.map(({ ncode }) => ncode);\n    const builder = new SearchBuilder({}, this.api);\n    builder.fields(fields$);\n    if (opt) {\n      builder.opt(opt);\n    }\n    builder.ncode(rankingNcodes);\n    builder.limit(ranking.length);\n    const result = await builder.execute();\n\n    return ranking.map<\n      RankingResult<\n        | SearchResultFields<TFields>\n        | (TOpt extends \"weekly\" ? \"weekly_unique\" : never)\n      >\n    >((r) => ({\n      ...r,\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      ...(result.values.find((novel) => novel.ncode == r.ncode) as any),\n    }));\n  }\n}\n"],"mappings":";;;;;;;;;AAGA,SAAS,SAAS,cAAc;AAahC,IAAM,aAAa;AAMnB,IAAqB,iBAArB,MAAoC;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,YACY,SAAiC,CAAC,GAClC,KACV;AAFU;AACA;AAMV,SAAK,QAAQ,QAAQ,KAAK,IAAI,GAAG,EAAE;AACnC,SAAK,QAAQ,YAAY;AAAA,EAC3B;AAAA,EAEA,KAAK,MAAY;AACf,SAAK,QAAQ;AACb,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,MAAmB;AACtB,SAAK,QAAQ;AACb,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAK,OAAkB;AACrB,SAAK,IAAI,EAAE,MAAM,MAAM,CAAC;AACxB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,IAAI,KAA6B;AACzC,WAAO,OAAO,KAAK,QAAQ,GAAG;AAC9B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAyC;AACvC,UAAM,OAAO,OAAO,KAAK,OAAO,UAAU;AAC1C,SAAK,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,KAAK,KAAK,GAAG,CAAC;AAC3C,WAAO,KAAK,IAAI,eAAe,KAAK,MAAuB;AAAA,EAC7D;AAAA,EAoBA,MAAM,kBAIJ,SAA8B,CAAC,GAC/B,KACuD;AACvD,UAAM,UAAU,MAAM,KAAK,QAAQ;AACnC,UAAM,UAAU,MAAM,QAAQ,MAAM,IAChC,OAAO,UAAU,IACf,CAAC,IACA,CAAC,GAAG,QAAQ,OAAO,KAAK,IAC1B,CAAC,QAAQ,OAAO,KAAK;AAE1B,UAAM,gBAAgB,QAAQ,IAAI,CAAC,EAAE,MAAM,MAAM,KAAK;AACtD,UAAM,UAAU,IAAI,cAAc,CAAC,GAAG,KAAK,GAAG;AAC9C,YAAQ,OAAO,OAAO;AACtB,QAAI,KAAK;AACP,cAAQ,IAAI,GAAG;AAAA,IACjB;AACA,YAAQ,MAAM,aAAa;AAC3B,YAAQ,MAAM,QAAQ,MAAM;AAC5B,UAAM,SAAS,MAAM,QAAQ,QAAQ;AAErC,WAAO,QAAQ,IAKb,CAAC,OAAO;AAAA,MACR,GAAG;AAAA;AAAA,MAEH,GAAI,OAAO,OAAO,KAAK,CAAC,UAAU,MAAM,SAAS,EAAE,KAAK;AAAA,IAC1D,EAAE;AAAA,EACJ;AACF;","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":[]}

package/dist/chunk-AZT2OXBZ.js

@@ -1,26 +0,0 @@
-import {
-  jsonp
-} from "./chunk-XVH2CU2Q.js";
-import {
-  NarouNovel
-} from "./chunk-UN3W2CT3.js";
-
-// src/narou-jsonp.ts
-var NarouNovelJsonp = class extends NarouNovel {
-  async execute(params, endpoint) {
-    const query = { ...params, out: "jsonp" };
-    query.gzip = 0;
-    const url = new URL(endpoint);
-    Object.entries(query).forEach(([key, value]) => {
-      if (value !== void 0) {
-        url.searchParams.append(key, value.toString());
-      }
-    });
-    return await jsonp(url.toString());
-  }
-};
-
-export {
-  NarouNovelJsonp
-};
-//# sourceMappingURL=chunk-AZT2OXBZ.js.map

package/dist/chunk-AZT2OXBZ.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/narou-jsonp.ts"],"sourcesContent":["import NarouNovel from \"./narou.js\";\nimport type { NarouParams } from \"./narou.js\";\nimport { jsonp } from \"./util/jsonp.js\";\n\n/**\n * なろう小説APIへのリクエストを実行する\n */\nexport default class NarouNovelJsonp extends NarouNovel {\n  protected async execute<T>(\n    params: NarouParams,\n    endpoint: string\n  ): Promise<T> {\n    const query = { ...params, out: \"jsonp\" };\n    query.gzip = 0;\n\n    const url = new URL(endpoint);\n\n    Object.entries(query).forEach(([key, value]) => {\n      if (value !== undefined) {\n        url.searchParams.append(key, value.toString());\n      }\n    });\n\n    return await jsonp(url.toString());\n  }\n}\n"],"mappings":";;;;;;;;AAOA,IAAqB,kBAArB,cAA6C,WAAW;AAAA,EACtD,MAAgB,QACd,QACA,UACY;AACZ,UAAM,QAAQ,EAAE,GAAG,QAAQ,KAAK,QAAQ;AACxC,UAAM,OAAO;AAEb,UAAM,MAAM,IAAI,IAAI,QAAQ;AAE5B,WAAO,QAAQ,KAAK,EAAE,QAAQ,CAAC,CAAC,KAAK,KAAK,MAAM;AAC9C,UAAI,UAAU,QAAW;AACvB,YAAI,aAAa,OAAO,KAAK,MAAM,SAAS,CAAC;AAAA,MAC/C;AAAA,IACF,CAAC;AAED,WAAO,MAAM,MAAM,IAAI,SAAS,CAAC;AAAA,EACnC;AACF;","names":[]}