narou 0.5.0 → 0.6.2

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "narou",
-  "version": "0.5.0",
+  "version": "0.6.2",
   "description": "Narou API Wrapper",
   "main": "dist/index.js",
+  "browser": "dist/index.browser.js",
   "types": "dist/index.d.ts",
   "typings": "dist/index.d.ts",
   "module": "dist.esm/index.js",
@@ -29,22 +30,20 @@
     "@types/node": "^13.5.0",
     "@types/node-fetch": "^2.5.7",
     "chai": "^4.1.2",
-    "husky": "^4.2.1",
-    "lint-staged": "^10.0.2",
-    "mocha": "^7.0.1",
+    "mocha": "^9.1.3",
     "mocha-typescript": "^1.1.12",
     "npm-run-all": "^4.1.4",
     "nyc": "^15.0.0",
-    "prettier": "^1.15.2",
+    "prettier": "^2.4.1",
     "rimraf": "^3.0.0",
-    "run-sequence": "^2.2.1",
     "touch": "^3.1.0",
-    "ts-node": "^8.6.2",
+    "ts-node": "^10.3.0",
     "tslint": "^6.0.0",
     "tslint-config-prettier": "^1.16.0",
     "tslint-plugin-prettier": "^2.0.1",
-    "typedoc": "^0.19.2",
-    "typescript": "^4.1.3"
+    "typedoc": "^0.22.5",
+    "typescript": "^4.4.4",
+    "node-fetch": "^2.6.1"
   },
   "scripts": {
     "build": "npm-run-all check clean build:tsc",

package/src/index.browser.ts

@@ -0,0 +1,63 @@
+import NarouNovelJsonp from "./narou-jsonp";
+import NarouNovel from "./narou";
+import SearchBuilder from "./search-builder";
+import SearchBuilderR18 from "./search-builder-r18";
+import RankingBuilder from "./ranking";
+import { formatRankingHistory, RankingHistoryResult } from "./ranking-history";
+
+export * from "./index.common";
+export { NarouNovelJsonp };
+
+const narouNovelJsonp = new NarouNovelJsonp();
+
+/**
+ * 検索
+ * @param {string} [word] - 検索ワード
+ * @returns {SearchBuilder}
+ */
+export function search(
+  word: string = "",
+  api: NarouNovel = narouNovelJsonp
+): SearchBuilder {
+  const builder = new SearchBuilder({}, api);
+  if (word != "") builder.word(word);
+  return builder;
+}
+
+/**
+ * 検索
+ * @param {string} [word] - 検索ワード
+ * @returns {SearchBuilder}
+ */
+export function searchR18(
+  word: string = "",
+  api: NarouNovel = narouNovelJsonp
+): SearchBuilderR18 {
+  const builder = new SearchBuilderR18({}, api);
+  if (word != "") builder.word(word);
+  return builder;
+}
+
+export function ranking(api: NarouNovel = narouNovelJsonp): RankingBuilder {
+  const builder = new RankingBuilder({}, api);
+  return builder;
+}
+
+export async function rankingHistory(
+  ncode: string,
+  api: NarouNovel = narouNovelJsonp
+): Promise<RankingHistoryResult[]> {
+  const result = await api.executeRankingHistory({ ncode });
+  if (Array.isArray(result)) {
+    return result.map(formatRankingHistory);
+  } else {
+    throw new Error(result);
+  }
+}
+
+export default {
+  search,
+  ranking,
+  searchR18,
+  rankingHistory,
+};

package/src/index.common.ts

@@ -0,0 +1,17 @@
+import NarouNovel from "./narou";
+import { RankingHistoryResult } from "./ranking-history";
+
+export { NarouNovel, RankingHistoryResult };
+export { RankingType } from "./ranking";
+export {
+  Fields,
+  Order,
+  BigGenre,
+  BigGenreNotation,
+  Genre,
+  GenreNotation,
+  R18Site,
+  R18SiteNotation,
+} from "./params";
+export { NarouSearchResult } from "./narou-search-results";
+export { NarouRankingResult, RankingResult } from "./narou-ranking-results";

package/src/index.ts

@@ -1,31 +1,26 @@
 import NarouNovel from "./narou";
+import NarouNovelFetch from "./narou-fetch";
+import NarouNovelJsonp from "./narou-jsonp";
 import RankingBuilder from "./ranking";
 import { formatRankingHistory, RankingHistoryResult } from "./ranking-history";
 import SearchBuilder from "./search-builder";
 import SearchBuilderR18 from "./search-builder-r18";
 
-export { NarouNovel, RankingHistoryResult };
-export { RankingType } from "./ranking";
-export {
-  Fields,
-  Order,
-  BigGenre,
-  BigGenreNotation,
-  Genre,
-  GenreNotation,
-  R18Site,
-  R18SiteNotation
-} from "./params";
-export { NarouSearchResult } from "./narou-search-results";
-export { NarouRankingResult, RankingResult } from "./narou-ranking-results";
+export * from "./index.common";
+export { NarouNovelFetch, NarouNovelJsonp };
+
+const narouNovelFetch = new NarouNovelFetch();
 
 /**
  * 検索
  * @param {string} [word] - 検索ワード
  * @returns {SearchBuilder}
  */
-export function search(word: string = ""): SearchBuilder {
-  var builder = new SearchBuilder();
+export function search(
+  word: string = "",
+  api: NarouNovel = narouNovelFetch
+): SearchBuilder {
+  const builder = new SearchBuilder({}, api);
   if (word != "") builder.word(word);
   return builder;
 }
@@ -35,21 +30,25 @@ export function search(word: string = ""): SearchBuilder {
  * @param {string} [word] - 検索ワード
  * @returns {SearchBuilder}
  */
-export function searchR18(word: string = ""): SearchBuilderR18 {
-  var builder = new SearchBuilderR18();
+export function searchR18(
+  word: string = "",
+  api: NarouNovel = narouNovelFetch
+): SearchBuilderR18 {
+  const builder = new SearchBuilderR18({}, api);
   if (word != "") builder.word(word);
   return builder;
 }
 
-export function ranking(): RankingBuilder {
-  const builder = new RankingBuilder();
+export function ranking(api: NarouNovel = narouNovelFetch): RankingBuilder {
+  const builder = new RankingBuilder({}, api);
   return builder;
 }
 
 export async function rankingHistory(
-  ncode: string
+  ncode: string,
+  api: NarouNovel = narouNovelFetch
 ): Promise<RankingHistoryResult[]> {
-  const result = await NarouNovel.executeRankingHistory({ ncode });
+  const result = await api.executeRankingHistory({ ncode });
   if (Array.isArray(result)) {
     return result.map(formatRankingHistory);
   } else {
@@ -61,5 +60,5 @@ export default {
   search,
   ranking,
   searchR18,
-  rankingHistory
+  rankingHistory,
 };

package/src/narou-fetch.ts

@@ -0,0 +1,51 @@
+import nodeFetch from "node-fetch";
+import nodeURL from "./util/url";
+
+import { unzipp } from "./util/unzipp";
+import NarouNovel, { NarouParams } from "./narou";
+
+/**
+ * なろう小説APIへのリクエストを実行する
+ * @class NarouNovel
+ * @private
+ */
+export default class NarouNovelFetch extends NarouNovel {
+  constructor(private fetch = nodeFetch) {
+    super();
+  }
+
+  protected async execute<T>(
+    params: NarouParams,
+    endpoint: string
+  ): Promise<T> {
+    const query = { ...params, out: "json" };
+
+    if (query.gzip === undefined) {
+      query.gzip = 5;
+    }
+    const url = new nodeURL(endpoint);
+
+    Object.entries(query).forEach(([key, value]) => {
+      if (value) {
+        url.searchParams.append(key, value.toString());
+      }
+    });
+
+    const res = await this.fetch(url);
+
+    if (query.gzip === 0) {
+      return await res.json();
+    }
+
+    const buffer = await res.buffer();
+    try {
+      return await unzipp(buffer);
+    } catch {
+      try {
+        throw JSON.stringify(buffer.toString());
+      } catch {
+        throw buffer.toString();
+      }
+    }
+  }
+}

package/src/narou-jsonp.ts

@@ -0,0 +1,29 @@
+import nodeURL from "./util/url";
+
+import NarouNovel, { NarouParams } from "./narou";
+import { jsonp } from "./util/jsonp";
+
+/**
+ * なろう小説APIへのリクエストを実行する
+ * @class NarouNovel
+ * @private
+ */
+export default class NarouNovelJsonp extends NarouNovel {
+  protected async execute<T>(
+    params: NarouParams,
+    endpoint: string
+  ): Promise<T> {
+    const query = { ...params, out: "jsonp" };
+    query.gzip = 0;
+
+    const url = new nodeURL(endpoint);
+
+    Object.entries(query).forEach(([key, value]) => {
+      if (value) {
+        url.searchParams.append(key, value.toString());
+      }
+    });
+
+    return await jsonp(url.toString());
+  }
+}

package/src/narou-ranking-results.ts

@@ -1,9 +1,9 @@
-import { NarouSearchResult } from "./narou-search-results";
-
-export interface NarouRankingResult {
-  ncode: string;
-  rank: number;
-  pt: number;
-}
-
-export interface RankingResult extends NarouSearchResult, NarouRankingResult {}
+import { NarouSearchResult } from "./narou-search-results";
+
+export interface NarouRankingResult {
+  ncode: string;
+  rank: number;
+  pt: number;
+}
+
+export interface RankingResult extends NarouSearchResult, NarouRankingResult {}

package/src/narou-search-results.ts

@@ -3,7 +3,7 @@
  * @class NarouSearchResults
  */
 
-import { SearchParams } from "./params";
+import { booleanNumber, Genre, R18Site, SearchParams } from "./params";
 
 export default class NarouSearchResults {
   allcount: number;
@@ -93,23 +93,24 @@ export interface NarouSearchResult {
   userid: number;
   writer: string;
   story: string;
-  genre: number;
+  nocgenre: R18Site;
+  genre: Genre;
   keyword: string;
   general_firstup: string;
   general_lastup: string;
   novel_type: number;
   noveltype: number;
-  end: number;
+  end: booleanNumber;
   general_all_no: number;
   length: number;
   time: number;
-  isstop: number;
-  isr15: number;
-  isbl: number;
-  isgl: number;
-  iszankoku: number;
-  istensei: number;
-  istenni: number;
+  isstop: booleanNumber;
+  isr15: booleanNumber;
+  isbl: booleanNumber;
+  isgl: booleanNumber;
+  iszankoku: booleanNumber;
+  istensei: booleanNumber;
+  istenni: booleanNumber;
   pc_or_k: number;
   global_point: number;
   daily_point: number;

package/src/narou.ts

@@ -1,83 +1,55 @@
-import fetch from "node-fetch";
-import { URL } from "url";
-
 import { NarouRankingResult } from "./narou-ranking-results";
 import NarouSearchResults from "./narou-search-results";
 import { RankingHistoryParams, RankingParams, SearchParams } from "./params";
 import { RankingHistoryRawResult } from "./ranking-history";
-import { unzipp } from "./util/unzipp";
 
-type NarouParams = SearchParams | RankingParams | RankingHistoryParams;
+export type NarouParams = SearchParams | RankingParams | RankingHistoryParams;
 
 /**
  * なろう小説APIへのリクエストを実行する
  * @class NarouNovel
  * @private
  */
-export default class NarouNovel {
+export default abstract class NarouNovel {
   /**
    * なろう小説APIへの検索リクエストを実行する
    * @param params クエリパラメータ
    * @param endpoint APIエンドポイント
    * @returns {Promise<NarouSearchResults>} 検索結果
    */
-  static async execute(
+  protected abstract execute<T>(
     params: NarouParams,
-    endpoint = "http://api.syosetu.com/novelapi/api/"
-  ): Promise<any> {
-    const query = { ...params, out: "json" };
-
-    if (query.gzip === undefined) {
-      query.gzip = 5;
-    }
-    const url = new URL(endpoint);
-
-    Object.entries(query).forEach(([key, value]) => {
-      if (value) {
-        url.searchParams.append(key, value.toString());
-      }
-    });
-
-    const res = await fetch(url);
+    endpoint: string
+  ): Promise<T>;
 
-    if (query.gzip === 0) {
-      return await res.json();
-    }
-
-    const buffer = await res.buffer();
-    try {
-      return await unzipp(buffer);
-    } catch {
-      try {
-        return JSON.stringify(buffer.toString());
-      } catch {
-        return buffer.toString();
-      }
-    }
-  }
-
-  static async executeSearch(
-    params: any,
+  async executeSearch(
+    params: NarouParams,
     endpoint = "http://api.syosetu.com/novelapi/api/"
   ): Promise<NarouSearchResults> {
     return new NarouSearchResults(await this.execute(params, endpoint), params);
   }
 
-  static executeNovel(params: SearchParams): Promise<NarouSearchResults> {
-    return this.executeSearch(params, "http://api.syosetu.com/novelapi/api/");
+  async executeNovel(params: SearchParams): Promise<NarouSearchResults> {
+    return await this.executeSearch(
+      params,
+      "http://api.syosetu.com/novelapi/api/"
+    );
   }
 
-  static executeNovel18(params: SearchParams): Promise<NarouSearchResults> {
-    return this.executeSearch(params, "http://api.syosetu.com/novel18api/api/");
+  async executeNovel18(params: SearchParams): Promise<NarouSearchResults> {
+    return await this.executeSearch(
+      params,
+      "http://api.syosetu.com/novel18api/api/"
+    );
   }
 
-  static executeRanking(params: RankingParams): Promise<NarouRankingResult[]> {
-    return this.execute(params, "http://api.syosetu.com/rank/rankget/");
+  async executeRanking(params: RankingParams): Promise<NarouRankingResult[]> {
+    return await this.execute(params, "http://api.syosetu.com/rank/rankget/");
   }
 
-  static executeRankingHistory(
+  async executeRankingHistory(
     params: RankingHistoryParams
   ): Promise<RankingHistoryRawResult[]> {
-    return this.execute(params, "http://api.syosetu.com/rank/rankin/");
+    return await this.execute(params, "http://api.syosetu.com/rank/rankin/");
   }
 }