narou 0.8.1 → 0.9.0

package/dist/util/jsonp.js

@@ -1,46 +1,7 @@
-"use strict";
-/**
- * MIT license
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonp = void 0;
-// Callback index.
-let count = 0;
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = function () { };
-function jsonp(url, { prefix = "__jp", param = "callback", timeout = 15000 } = {}) {
-    return new Promise(function (resolve, reject) {
-        const targetChild = document.getElementsByTagName("script").item(0);
-        const target = targetChild?.parentNode ?? document.head;
-        const id = `${prefix}${count++}`;
-        const cleanup = function () {
-            // Remove the script tag.
-            if (script && script.parentNode) {
-                script.parentNode.removeChild(script);
-            }
-            window[id] = noop;
-            if (timer) {
-                clearTimeout(timer);
-            }
-        };
-        const timer = timeout > 0
-            ? setTimeout(() => {
-                cleanup();
-                reject(new Error("Timeout"));
-            }, timeout)
-            : undefined;
-        const callback = (data) => {
-            cleanup();
-            resolve(data);
-        };
-        window[id] = callback;
-        // Create script.
-        const script = document.createElement("script");
-        const urlObj = new URL(url);
-        urlObj.searchParams.set(param, id);
-        script.setAttribute("src", urlObj.toString());
-        target.insertBefore(script, targetChild);
-    });
-}
-exports.jsonp = jsonp;
-//# sourceMappingURL=jsonp.js.map
+import {
+  jsonp
+} from "../chunk-EQL67JCA.js";
+import "../chunk-IKR7OZGM.js";
+export {
+  jsonp
+};

package/dist/util/type.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/util/type.ts
+var type_exports = {};
+module.exports = __toCommonJS(type_exports);

package/dist/util/type.d.cts

@@ -0,0 +1,4 @@
+type Stringable = string | number | bigint | boolean | null | undefined;
+type Join<T extends Stringable> = `${T}-${T}` | `${T}`;
+
+export { Join };

package/dist/util/type.d.ts

@@ -1,4 +1,4 @@
-declare type Stringable = string | number | bigint | boolean | null | undefined;
-export declare type Join<T extends Stringable> = `${T}-${T}` | `${T}`;
-export {};
-//# sourceMappingURL=type.d.ts.map
+type Stringable = string | number | bigint | boolean | null | undefined;
+type Join<T extends Stringable> = `${T}-${T}` | `${T}`;
+
+export { Join };

package/dist/util/type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=type.js.map

package/dist/util/unzipp.cjs

@@ -0,0 +1,47 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/util/unzipp.ts
+var unzipp_exports = {};
+__export(unzipp_exports, {
+  unzipp: () => unzipp
+});
+module.exports = __toCommonJS(unzipp_exports);
+var import_zlib = require("zlib");
+var import_util = require("util");
+var gunzipAsync = (0, import_util.promisify)(import_zlib.gunzip);
+var decoder = new TextDecoder();
+async function unzipp(data) {
+  try {
+    const buffer = await gunzipAsync(data);
+    try {
+      return JSON.parse(decoder.decode(buffer));
+    } catch {
+      throw decoder.decode(buffer);
+    }
+  } catch (e) {
+    if (typeof e === "string")
+      throw e;
+    throw decoder.decode(data);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  unzipp
+});

package/dist/util/unzipp.d.cts

@@ -0,0 +1,3 @@
+declare function unzipp(data: ArrayBuffer): Promise<any>;
+
+export { unzipp };

package/dist/util/unzipp.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
-import { InputType } from "zlib";
-export declare function unzipp(data: InputType): Promise<any>;
-//# sourceMappingURL=unzipp.d.ts.map
+declare function unzipp(data: ArrayBuffer): Promise<any>;
+
+export { unzipp };

package/dist/util/unzipp.js

@@ -1,12 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unzipp = void 0;
-const zlib_1 = require("zlib");
-const util_1 = require("util");
-const gunzipAsync = (0, util_1.promisify)(zlib_1.gunzip);
-async function unzipp(data) {
-    const buffer = await gunzipAsync(data);
-    return JSON.parse(buffer.toString());
-}
-exports.unzipp = unzipp;
-//# sourceMappingURL=unzipp.js.map
+import {
+  unzipp
+} from "../chunk-OVGZ6RWT.js";
+import "../chunk-IKR7OZGM.js";
+export {
+  unzipp
+};

package/package.json

@@ -1,30 +1,35 @@
 {
   "name": "narou",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Narou API Wrapper",
+  "type": "module",
   "main": "dist/index.js",
-  "types": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
   "exports": {
     ".": {
       "browser": {
         "require": "./dist/index.browser.js",
-        "import": "./dist.esm/index.browser.js"
+        "import": "./dist/index.browser.mjs",
+        "types": "./dist/index.browser.d.ts"
       },
       "node": {
         "require": "./dist/index.js",
-        "import": "./dist.esm/index.js"
+        "import": "./dist/index.mjs",
+        "types": "./dist/index.d.ts"
       }
     }
   },
-  "engines": {
-    "node": ">=16.0.0"
-  },
   "files": [
     "dist",
-    "dist.*",
     "src",
-    "package-lock.json"
+    "package.json",
+    "package-lock.json",
+    "README.md"
   ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "author": "deflis <deflis@gmail.com>",
   "license": "MIT",
   "repository": {
@@ -32,42 +37,39 @@
     "url": "https://github.com/deflis/node-narou.git"
   },
   "dependencies": {
-    "date-fns": "^2.16.1"
+    "date-fns": "^2.30.0"
   },
   "devDependencies": {
-    "@types/jest": "^28.1.5",
-    "@types/node": "^13.5.0",
-    "@types/node-fetch": "^2.5.7",
-    "@typescript-eslint/eslint-plugin": "^5.30.6",
-    "@typescript-eslint/parser": "^5.30.6",
-    "eslint": "^8.19.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^28.1.3",
-    "node-fetch": "^2.6.1",
-    "npm-run-all": "^4.1.4",
-    "prettier": "^2.7.1",
-    "ts-jest": "^28.0.6",
-    "typescript": "^4.7.4"
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.9.0",
+    "@types/node-fetch": "^2.6.9",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "@typescript-eslint/parser": "^6.10.0",
+    "eslint": "^8.53.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "node-fetch": "^2.7.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
   },
   "optionalDependencies": {
     "node-fetch": "^2.6.7"
   },
   "scripts": {
-    "build": "npm-run-all check clean build:tsc",
-    "build:tsc": "npm-run-all --parallel build:tsc:*",
-    "build:tsc:cjs": "tsc -p ./tsconfig.cjs.json",
-    "build:tsc:esm": "tsc -p ./tsconfig.esm.json",
+    "build": "npm-run-all check build:tsc",
+    "build:tsc": "tsup ./src",
     "check": "npm-run-all --parallel check:lint check:build test",
     "check:lint": "eslint src/** test/**",
     "check:build": "tsc --noEmit",
-    "prepare": "npm-run-all format build",
+    "prepack": "npm-run-all format build",
     "format": "eslint --fix src/** test/**",
     "test": "jest",
-    "clean": "npx rimraf dist dist.*",
-    "docs": "npm-run-all docs:clean docs:typedoc docs:nojekyll",
+    "docs": "npm-run-all docs:clean docs:typedoc",
     "docs:clean": "npx rimraf docs",
-    "docs:typedoc": "npx typedoc --out ./docs src/index.ts",
-    "docs:nojekyll": "npx touch ./docs/.nojekyll"
+    "docs:typedoc": "npx typedoc --out ./docs src/index.ts"
   }
 }

package/src/narou-fetch.ts

@@ -1,15 +1,13 @@
-import nodeFetch from "node-fetch";
-
 import { unzipp } from "./util/unzipp";
 import NarouNovel, { NarouParams } from "./narou";
 
+type Fetch = typeof fetch;
+
 /**
  * なろう小説APIへのリクエストを実行する
- * @class NarouNovel
- * @private
  */
 export default class NarouNovelFetch extends NarouNovel {
-  constructor(private fetch = nodeFetch) {
+  constructor(private fetch: Fetch = require('node-fetch')) {
     super();
   }
 
@@ -33,18 +31,10 @@ export default class NarouNovelFetch extends NarouNovel {
     const res = await this.fetch(url);
 
     if (query.gzip === 0) {
-      return await res.json();
+      return (await res.json()) as T;
     }
 
-    const buffer = await res.buffer();
-    try {
-      return await unzipp(buffer);
-    } catch {
-      try {
-        throw JSON.stringify(buffer.toString());
-      } catch {
-        throw buffer.toString();
-      }
-    }
+    const buffer = await res.arrayBuffer();
+    return await unzipp(buffer);
   }
 }

package/src/narou-jsonp.ts

@@ -3,8 +3,6 @@ import { jsonp } from "./util/jsonp";
 
 /**
  * なろう小説APIへのリクエストを実行する
- * @class NarouNovel
- * @private
  */
 export default class NarouNovelJsonp extends NarouNovel {
   protected async execute<T>(

package/src/narou-ranking-results.ts

@@ -2,12 +2,22 @@ import { PickedNarouSearchResult } from "./narou-search-results";
 import { SearchResultFieldNames } from "./params";
 import { DefaultSearchResultFields } from "./search-builder";
 
+/**
+ * ランキングAPIの結果
+ * @see https://dev.syosetu.com/man/rankapi/#output
+ */
 export interface NarouRankingResult {
+  /** Nコード */
   ncode: string;
+  /** 順位 */
   rank: number;
+  /** ポイント */
   pt: number;
 }
 
+/**
+ * ランキングと小説情報をマージした結果
+ */
 export type RankingResult<
   T extends SearchResultFieldNames = DefaultSearchResultFields
 > = Partial<PickedNarouSearchResult<T>> & NarouRankingResult;

package/src/narou-search-results.ts

@@ -12,14 +12,31 @@ import {
 
 /**
  * なろう小説API検索結果
- * @class NarouSearchResults
  */
 export default class NarouSearchResults<T, TKey extends keyof T> {
+  /**
+   * 検索結果数
+   */
   allcount: number;
+  /**
+   * 結果表示上限数
+   */
   limit: number;
+  /**
+   * 結果表示開始数
+   */
   start: number;
+  /**
+   * 結果表示の現在ページ(=start/limit)
+   */
   page: number;
+  /**
+   * 今回取得できた検索結果の数
+   */
   length: number;
+  /**
+   * 検索結果
+   */
   values: readonly Pick<T, TKey>[];
 
   /**
@@ -34,138 +51,176 @@ export default class NarouSearchResults<T, TKey extends keyof T> {
     const limit = params.lim ?? 20;
     const start = params.st ?? 0;
 
-    /**
-     * 検索結果数
-     * @type {number}
-     */
     this.allcount = count;
-    /**
-     * 結果表示上限数
-     * @type {number}
-     */
     this.limit = limit;
-    /**
-     * 結果表示開始数
-     * @type {number}
-     */
     this.start = start;
-    /**
-     * 結果表示ページ数
-     * @type {number}
-     */
     this.page = start / limit;
-    /**
-     * 結果数
-     * @type {number}
-     */
     this.length = result.length;
-    /**
-     * 検索結果
-     * @type {PickedNarouSearchResult<T>[]}
-     */
     this.values = result;
   }
 }
 
 /**
- * @typedef {Object} NarouSearchResult
- * @property {number} title 小説名
- * @property {string} ncode Nコード
- * @property {number} userid 作者のユーザID(数値)
- * @property {string} writer 作者名
- * @property {string} story 小説のあらすじ
- * @property {number} genre ジャンル
- * @property {string} keyword キーワード
- * @property {string} general_firstup 初回掲載日 YYYY-MM-DD HH:MM:SSの形式
- * @property {string} general_lastup 最終掲載日 YYYY-MM-DD HH:MM:SSの形式
- * @property {number} noveltype 連載の場合は1、短編の場合は2
- * @property {number} end 短編小説と完結済小説は0となっています。連載中は1です。
- * @property {number} general_all_no 全掲載話数です。短編の場合は1です。
- * @property {number} length 全掲載話数です。短編の場合は1です。
- * @property {number} time 読了時間(分単位)です。読了時間は小説文字数÷500を切り上げした数値です。
- * @property {number} isstop 長期連載中は1、それ以外は0です。
- * @property {number} pc_or_k 1はケータイのみ、2はPCのみ、3はPCとケータイで投稿された作品です。対象は投稿と次話投稿時のみで、どの端末で執筆されたかを表すものではありません。
- * @property {number} global_point 総合得点(=(ブックマーク数×2)+評価点)
- * @property {number} fav_novel_cnt ブックマーク数
- * @property {number} review_cnt レビュー数
- * @property {number} all_point 評価点
- * @property {number} all_hyoka_cnt 評価者数
- * @property {number} sasie_cnt 挿絵の数
- * @property {number} kaiwaritu 会話率
- * @property {number} novelupdated_at 小説の更新日時
- * @property {number} updated_at 最終更新日時(注意：システム用で小説更新時とは関係ありません)
+ * 小説情報
+ * @see https://dev.syosetu.com/man/api/#output
+ * @see https://dev.syosetu.com/xman/api/#output
  */
-
 export interface NarouSearchResult {
+  /** 小説名 */
   title: string;
+  /** Nコード */
   ncode: string;
+  /** 作者のユーザID(数値) */
   userid: number;
+  /** 作者名 */
   writer: string;
+  /** 小説のあらすじ */
   story: string;
+  /** 掲載サイト */
   nocgenre: R18Site;
+  /** 大ジャンル */
   biggenre: BigGenre;
+  /** ジャンル */
   genre: Genre;
+  /** キーワード */
   keyword: string;
+  /** 初回掲載日 YYYY-MM-DD HH:MM:SSの形式 */
   general_firstup: string;
+  /** 最終掲載日 YYYY-MM-DD HH:MM:SSの形式 */
   general_lastup: string;
-  novel_type: number;
+  /** 連載の場合は1、短編の場合は2 */
+  novel_type: NovelType;
+  /** 連載の場合は1、短編の場合は2 */
   noveltype: NovelType;
+  /** 短編小説と完結済小説は0となっています。連載中は1です。 */
   end: End;
+  /** 全掲載話数です。短編の場合は1です。 */
   general_all_no: number;
+  /** 小説文字数です。スペースや改行は文字数としてカウントしません。 */
   length: number;
+  /** 読了時間(分単位)です。読了時間は小説文字数÷500を切り上げした数値です。 */
   time: number;
+  /** 長期連載中は1、それ以外は0です。 */
   isstop: BooleanNumber;
+  /** 登録必須キーワードに「R15」が含まれる場合は1、それ以外は0です。 */
   isr15: BooleanNumber;
+  /** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
   isbl: BooleanNumber;
+  /** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
   isgl: BooleanNumber;
+  /** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
   iszankoku: BooleanNumber;
+  /** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
   istensei: BooleanNumber;
+  /** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
   istenni: BooleanNumber;
-  pc_or_k: PcOrK;
+  /** 総合得点(=(ブックマーク数×2)+評価点) */
   global_point: number;
+  /**
+   * 日間ポイント
+   * ランキング集計時点から過去24時間以内で新たに登録されたブックマークや評価が対象
+   */
   daily_point: number;
+  /**
+   * 週間ポイント
+   * ランキング集計時点から過去7日以内で新たに登録されたブックマークや評価が対象
+   */
   weekly_point: number;
+  /**
+   * 月間ポイント
+   * ランキング集計時点から過去30日以内で新たに登録されたブックマークや評価が対象
+   */
   monthly_point: number;
+  /**
+   * 四半期ポイント
+   * ランキング集計時点から過去90日以内で新たに登録されたブックマークや評価が対象
+   */
   quarter_point: number;
+  /**
+   * 年間ポイント
+   * ランキング集計時点から過去365日以内で新たに登録されたブックマークや評価が対象
+   */
   yearly_point: number;
+  /** ブックマーク数 */
   fav_novel_cnt: number;
+  /** 感想数 */
   impression_cnt: number;
+  /** レビュー数 */
   review_cnt: number;
+  /** 評価ポイント */
   all_point: number;
+  /** 評価者数 */
   all_hyoka_cnt: number;
+  /** 挿絵の数 */
   sasie_cnt: number;
+  /**
+   * 会話率
+   * @see https://dev.syosetu.com/man/kaiwa/
+   */
   kaiwaritu: number;
+  /**
+   * 小説の更新日時
+   */
   novelupdated_at: string;
+  /**
+   * 最終更新日時
+   * システム用で小説更新時とは関係ありません
+   */
   updated_at: string;
+  /** 週間ユニークユーザー数 */
   weekly_unique: number;
 }
 
+/**
+ * ユーザ情報
+ * @see https://dev.syosetu.com/man/userapi/#output
+ */
 export interface UserSearchResult {
+  /** ユーザID */
   userid: number;
+  /** ユーザ名 */
   name: string;
+  /** ユーザ名のフリガナ */
   yomikata: string;
+  /**
+   * ユーザ名のフリガナの頭文字
+   * ひらがな以外の場合はnullまたは空文字となります。
+   */
   name1st: string;
+  /** 小説投稿数 */
   novel_cnt: number;
+  /** レビュー投稿数 */
   review_cnt: number;
+  /**
+   * 小説累計文字数
+   * スペースや改行は文字数としてカウントしません。
+   */
   novel_length: number;
+  /**
+   * 総合評価ポイントの合計
+   * 投稿済小説でそれぞれ獲得した総合評価ポイントの合計です。
+   */
   sum_global_point: number;
 }
 
-export const PcOrK = {
-  Ketai: 1,
-  Pc: 2,
-  PcAndKetai: 3,
-} as const;
-export type PcOrK = typeof PcOrK[keyof typeof PcOrK];
-
+/**
+ * noveltype/novel_typeの値ヘルパー
+ */
 export const NovelType = {
+  /** 連載 */
   Rensai: 1,
+  /** 短編 */
   Tanpen: 2,
 } as const;
 export type NovelType = typeof NovelType[keyof typeof NovelType];
 
+/**
+ * endの値ヘルパー
+ */
 export const End = {
+  /** 短編小説と完結済小説 */
   KanketsuOrTanpen: 0,
+  /** 連載中 */
   Rensai: 1,
 } as const;
 export type End = typeof End[keyof typeof End];
@@ -176,8 +231,8 @@ export type SearchResultFields<T extends Fields> = {
 
 export type SearchResultOptionalFields<T extends OptionalFields> = {
   [K in keyof typeof OptionalFields]: typeof OptionalFields[K] extends T
-    ? K
-    : never;
+  ? K
+  : never;
 }[keyof typeof OptionalFields];
 
 export type SearchResultR18Fields<T extends R18Fields> = {