narou 0.6.2 → 0.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narou",
-  "version": "0.6.2",
+  "version": "0.7.2",
   "description": "Narou API Wrapper",
   "main": "dist/index.js",
   "browser": "dist/index.browser.js",
@@ -21,29 +21,26 @@
     "url": "https://github.com/deflis/node-narou.git"
   },
   "dependencies": {
-    "date-fns": "^2.16.1",
-    "node-fetch": "^2.6.1"
+    "date-fns": "^2.16.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.1.2",
-    "@types/mocha": "^5.2.7",
+    "@types/jest": "^28.1.5",
     "@types/node": "^13.5.0",
     "@types/node-fetch": "^2.5.7",
-    "chai": "^4.1.2",
-    "mocha": "^9.1.3",
-    "mocha-typescript": "^1.1.12",
+    "@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",
-    "nyc": "^15.0.0",
-    "prettier": "^2.4.1",
-    "rimraf": "^3.0.0",
-    "touch": "^3.1.0",
-    "ts-node": "^10.3.0",
-    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.16.0",
-    "tslint-plugin-prettier": "^2.0.1",
-    "typedoc": "^0.22.5",
-    "typescript": "^4.4.4",
-    "node-fetch": "^2.6.1"
+    "prettier": "^2.7.1",
+    "ts-jest": "^28.0.6",
+    "typescript": "^4.7.4"
+  },
+  "optionalDependencies": {
+    "node-fetch": "^2.6.7"
   },
   "scripts": {
     "build": "npm-run-all check clean build:tsc",
@@ -52,35 +49,15 @@
     "build:tsc:esm": "tsc -p ./tsconfig.esm.json",
     "build:tsc:es2017": "tsc -p ./tsconfig.es2017.json",
     "check": "npm-run-all --parallel check:lint check:build test",
-    "check:lint": "tslint --project .",
+    "check:lint": "eslint src/** test/**",
     "check:build": "tsc --noEmit",
     "prepare": "npm-run-all format build",
-    "format": "npm-run-all format:prettier format:tslint",
-    "format:prettier": "prettier --write src/**/*.ts",
-    "format:tslint": "tslint --project . --fix",
-    "test": "mocha --recursive --require ts-node/register \"test/**/*.ts\"",
-    "cover": "nyc mocha --recursive --require ts-node/register \"test/**/*.ts\"",
-    "clean": "rimraf dist dist.*",
+    "format": "eslint --fix src/** test/**",
+    "test": "jest",
+    "clean": "npx rimraf dist dist.*",
     "docs": "npm-run-all docs:clean docs:typedoc docs:nojekyll",
-    "docs:clean": "rimraf docs",
-    "docs:typedoc": "typedoc --out ./docs src/index.ts",
-    "docs:nojekyll": "nodetouch ./docs/.nojekyll"
-  },
-  "nyc": {
-    "include": [
-      "src/**/*.js"
-    ],
-    "extension": [
-      ".ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ],
-    "reporter": [
-      "json",
-      "html",
-      "text"
-    ],
-    "sourceMap": true
+    "docs:clean": "npx rimraf docs",
+    "docs:typedoc": "npx typedoc --out ./docs src/index.ts",
+    "docs:nojekyll": "npx touch ./docs/.nojekyll"
   }
 }

package/src/index.browser.ts

@@ -16,7 +16,7 @@ const narouNovelJsonp = new NarouNovelJsonp();
  * @returns {SearchBuilder}
  */
 export function search(
-  word: string = "",
+  word = "",
   api: NarouNovel = narouNovelJsonp
 ): SearchBuilder {
   const builder = new SearchBuilder({}, api);
@@ -30,7 +30,7 @@ export function search(
  * @returns {SearchBuilder}
  */
 export function searchR18(
-  word: string = "",
+  word = "",
   api: NarouNovel = narouNovelJsonp
 ): SearchBuilderR18 {
   const builder = new SearchBuilderR18({}, api);

package/src/index.common.ts

@@ -1,10 +1,13 @@
 import NarouNovel from "./narou";
-import { RankingHistoryResult } from "./ranking-history";
+import NarouSearchResults from "./narou-search-results";
 
-export { NarouNovel, RankingHistoryResult };
-export { RankingType } from "./ranking";
+export { NarouNovel, NarouSearchResults };
+
+export { RankingHistoryResult } from "./ranking-history";
 export {
+  RankingType,
   Fields,
+  SearchResultFieldNames,
   Order,
   BigGenre,
   BigGenreNotation,
@@ -12,6 +15,19 @@ export {
   GenreNotation,
   R18Site,
   R18SiteNotation,
+  BuntaiParam,
+  NovelTypeParam,
+  BooleanNumber,
 } from "./params";
-export { NarouSearchResult } from "./narou-search-results";
+export {
+  NarouSearchResult,
+  PickedNarouSearchResult,
+  SearchResultFields,
+  SearchResultR18Fields,
+  PcOrK,
+  NovelType,
+  End,
+} from "./narou-search-results";
 export { NarouRankingResult, RankingResult } from "./narou-ranking-results";
+export { DefaultSearchResultFields } from "./search-builder";
+export { DefaultR18SearchResultFields } from "./search-builder-r18";

package/src/index.ts

@@ -17,7 +17,7 @@ const narouNovelFetch = new NarouNovelFetch();
  * @returns {SearchBuilder}
  */
 export function search(
-  word: string = "",
+  word = "",
   api: NarouNovel = narouNovelFetch
 ): SearchBuilder {
   const builder = new SearchBuilder({}, api);
@@ -31,7 +31,7 @@ export function search(
  * @returns {SearchBuilder}
  */
 export function searchR18(
-  word: string = "",
+  word = "",
   api: NarouNovel = narouNovelFetch
 ): SearchBuilderR18 {
   const builder = new SearchBuilderR18({}, api);

package/src/narou-ranking-results.ts

@@ -1,4 +1,6 @@
-import { NarouSearchResult } from "./narou-search-results";
+import { PickedNarouSearchResult } from "./narou-search-results";
+import { SearchResultFieldNames } from "./params";
+import { DefaultSearchResultFields } from "./search-builder";
 
 export interface NarouRankingResult {
   ncode: string;
@@ -6,4 +8,6 @@ export interface NarouRankingResult {
   pt: number;
 }
 
-export interface RankingResult extends NarouSearchResult, NarouRankingResult {}
+export type RankingResult<
+  T extends SearchResultFieldNames = DefaultSearchResultFields
+> = Partial<PickedNarouSearchResult<T>> & NarouRankingResult;

package/src/narou-search-results.ts

@@ -1,24 +1,35 @@
+import {
+  BooleanNumber as BooleanNumber,
+  Genre,
+  R18Site,
+  SearchParams,
+  Fields,
+  BigGenre,
+  R18Fields,
+  OptionalFields,
+} from "./params";
+
 /**
  * なろう小説API検索結果
  * @class NarouSearchResults
  */
-
-import { booleanNumber, Genre, R18Site, SearchParams } from "./params";
-
-export default class NarouSearchResults {
+export default class NarouSearchResults<T extends keyof NarouSearchResult> {
   allcount: number;
   limit: number;
   start: number;
   page: number;
   length: number;
-  values: NarouSearchResult[];
+  values: PickedNarouSearchResult<T>[];
 
   /**
    * @constractor
    * @private
    */
   constructor(
-    [header, ...result]: [{ allcount: number }, ...NarouSearchResult[]],
+    [header, ...result]: [
+      { allcount: number },
+      ...PickedNarouSearchResult<T>[]
+    ],
     params: SearchParams
   ) {
     const count = header.allcount;
@@ -52,7 +63,7 @@ export default class NarouSearchResults {
     this.length = result.length;
     /**
      * 検索結果
-     * @type {NarouSearchResult[]}
+     * @type {PickedNarouSearchResult<T>[]}
      */
     this.values = result;
   }
@@ -70,7 +81,7 @@ export default class NarouSearchResults {
  * @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 連載の場合は1、短編の場合は2
+ * @property {number} end 短編小説と完結済小説は0となっています。連載中は1です。
  * @property {number} general_all_no 全掲載話数です。短編の場合は1です。
  * @property {number} length 全掲載話数です。短編の場合は1です。
  * @property {number} time 読了時間(分単位)です。読了時間は小説文字数÷500を切り上げした数値です。
@@ -94,24 +105,25 @@ export interface NarouSearchResult {
   writer: string;
   story: string;
   nocgenre: R18Site;
+  biggenre: BigGenre;
   genre: Genre;
   keyword: string;
   general_firstup: string;
   general_lastup: string;
   novel_type: number;
-  noveltype: number;
-  end: booleanNumber;
+  noveltype: NovelType;
+  end: End;
   general_all_no: number;
   length: number;
   time: number;
-  isstop: booleanNumber;
-  isr15: booleanNumber;
-  isbl: booleanNumber;
-  isgl: booleanNumber;
-  iszankoku: booleanNumber;
-  istensei: booleanNumber;
-  istenni: booleanNumber;
-  pc_or_k: number;
+  isstop: BooleanNumber;
+  isr15: BooleanNumber;
+  isbl: BooleanNumber;
+  isgl: BooleanNumber;
+  iszankoku: BooleanNumber;
+  istensei: BooleanNumber;
+  istenni: BooleanNumber;
+  pc_or_k: PcOrK;
   global_point: number;
   daily_point: number;
   weekly_point: number;
@@ -125,7 +137,45 @@ export interface NarouSearchResult {
   all_hyoka_cnt: number;
   sasie_cnt: number;
   kaiwaritu: number;
-  novelupdated_at: number;
-  update_at: number;
+  novelupdated_at: string;
+  updated_at: string;
   weekly_unique: number;
 }
+
+export const PcOrK = {
+  Ketai: 1,
+  Pc: 2,
+  PcAndKetai: 3,
+} as const;
+export type PcOrK = typeof PcOrK[keyof typeof PcOrK];
+
+export const NovelType = {
+  Rensai: 1,
+  Tanpen: 2,
+} as const;
+export type NovelType = typeof NovelType[keyof typeof NovelType];
+
+export const End = {
+  KanketsuOrTanpen: 0,
+  Rensai: 1,
+} as const;
+export type End = typeof End[keyof typeof End];
+
+export type SearchResultFields<T extends Fields> = {
+  [K in keyof typeof Fields]: typeof Fields[K] extends T ? K : never;
+}[keyof typeof Fields];
+
+export type SerachResultOptionalFields<T extends OptionalFields> = {
+  [K in keyof typeof OptionalFields]: typeof OptionalFields[K] extends T
+    ? K
+    : never;
+}[keyof typeof OptionalFields];
+
+export type SearchResultR18Fields<T extends R18Fields> = {
+  [K in keyof typeof R18Fields]: typeof R18Fields[K] extends T ? K : never;
+}[keyof typeof R18Fields];
+
+export type PickedNarouSearchResult<T extends keyof NarouSearchResult> = Pick<
+  NarouSearchResult,
+  T
+>;

package/src/narou.ts

@@ -1,5 +1,5 @@
 import { NarouRankingResult } from "./narou-ranking-results";
-import NarouSearchResults from "./narou-search-results";
+import NarouSearchResults, { NarouSearchResult } from "./narou-search-results";
 import { RankingHistoryParams, RankingParams, SearchParams } from "./params";
 import { RankingHistoryRawResult } from "./ranking-history";
 
@@ -22,21 +22,28 @@ export default abstract class NarouNovel {
     endpoint: string
   ): Promise<T>;
 
-  async executeSearch(
+  async executeSearch<T extends keyof NarouSearchResult>(
     params: NarouParams,
     endpoint = "http://api.syosetu.com/novelapi/api/"
-  ): Promise<NarouSearchResults> {
-    return new NarouSearchResults(await this.execute(params, endpoint), params);
+  ): Promise<NarouSearchResults<T>> {
+    return new NarouSearchResults<T>(
+      await this.execute(params, endpoint),
+      params
+    );
   }
 
-  async executeNovel(params: SearchParams): Promise<NarouSearchResults> {
+  async executeNovel<T extends keyof NarouSearchResult>(
+    params: SearchParams
+  ): Promise<NarouSearchResults<T>> {
     return await this.executeSearch(
       params,
       "http://api.syosetu.com/novelapi/api/"
     );
   }
 
-  async executeNovel18(params: SearchParams): Promise<NarouSearchResults> {
+  async executeNovel18<T extends keyof NarouSearchResult>(
+    params: SearchParams
+  ): Promise<NarouSearchResults<T>> {
     return await this.executeSearch(
       params,
       "http://api.syosetu.com/novel18api/api/"