narou 0.6.0 → 0.7.0

package/src/search-builder-r18.ts

@@ -1,29 +1,33 @@
-import SearchBuilder from "./search-builder";
-import INarouSearchResults from "./narou-search-results";
-import { R18Site } from "./params";
+import { SearchBuilderBase } from "./search-builder";
+import NarouSearchResults, {
+  NarouSearchResult,
+  SearchResultR18Fields,
+} from "./narou-search-results";
+import { R18Site, SearchResultFieldNames, R18Fields } from "./params";
+
+export type DefaultR18SearchResultFields = keyof Omit<
+  NarouSearchResult,
+  "weekly_unique" | "noveltype" | "biggenre" | "genre" | "isr15" | "id"
+>;
 
 /**
  * 18禁API検索ヘルパー
  * @class SearchBuilderR18
  */
-export default class SearchBuilderR18 extends SearchBuilder {
+export default class SearchBuilderR18<
+  T extends SearchResultFieldNames = DefaultR18SearchResultFields
+> extends SearchBuilderBase<T> {
   /**
    * なろう小説APIへの検索リクエストを実行する
    * @override
-   * @returns {Promise<INarouSearchResults>} 検索結果
+   * @returns {Promise<NarouSearchResults>} 検索結果
    */
-  execute(): Promise<INarouSearchResults> {
+  execute(): Promise<NarouSearchResults<T>> {
     return this.api.executeNovel18(this.params);
   }
 
   r18Site(sites: R18Site | R18Site[]) {
-    let nocgenre: number | string;
-    if (Array.isArray(sites)) {
-      nocgenre = (<string[]>(<any>sites)).join("-");
-    } else {
-      nocgenre = sites;
-    }
-    this.set({ nocgenre });
+    this.set({ nocgenre: SearchBuilderBase.array2string(sites) });
     return this;
   }
 
@@ -32,13 +36,19 @@ export default class SearchBuilderR18 extends SearchBuilder {
    * @return {SearchBuilder} this
    */
   xid(ids: number | number[]) {
-    let xid: number | string;
-    if (Array.isArray(ids)) {
-      xid = (<string[]>(<any>ids)).join("-");
-    } else {
-      xid = ids;
-    }
-    this.set({ xid });
+    this.set({ xid: SearchBuilderBase.array2string(ids) });
     return this;
   }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  fields<TFields extends R18Fields>(
+    fields: TFields | TFields[]
+  ): SearchBuilderR18<SearchResultR18Fields<R18Fields>> {
+    this.set({ of: SearchBuilderBase.array2string(fields) });
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return this as any;
+  }
 }

package/src/search-builder.ts

@@ -1,30 +1,49 @@
-import { NarouNovel } from ".";
-import api from "./narou";
-import NarouNovelFetch from "./narou-fetch";
-import INarouSearchResults from "./narou-search-results";
-import { BigGenre, Genre } from "./params";
+import NarouNovel from "./narou";
 import {
+  NarouSearchResult,
+  SearchResultFields,
+  SerachResultOptionalFields,
+} from "./narou-search-results";
+import NarouSearchResults from "./narou-search-results";
+import {
+  BigGenre,
+  BooleanNumber,
+  SearchResultFieldNames,
+  Genre,
+  Stop,
   SearchParams,
   Fields,
   Order,
   Buntai,
   NovelType,
   GzipLevel,
+  OptionalFields,
 } from "./params";
+import { Join } from "./util/type";
 
-/**
- * 検索ヘルパー
- * @class SearchBuilder
- */
-export default class SearchBuilder {
+export type DefaultSearchResultFields = keyof Omit<
+  NarouSearchResult,
+  "weekly_unique" | "noveltype" | "nocgenre" | "xid"
+>;
+
+export abstract class SearchBuilderBase<T extends SearchResultFieldNames> {
   /**
    * constructor
    * @private
    */
-  constructor(
-    protected params: SearchParams = {},
-    protected api: NarouNovel = new NarouNovelFetch()
-  ) {}
+  constructor(protected params: SearchParams = {}, protected api: NarouNovel) {}
+
+  static distinct<T>(array: T[]): T[] {
+    return Array.from(new Set(array));
+  }
+
+  static array2string<T extends string | number>(n: T | readonly T[]): Join<T> {
+    if (Array.isArray(n)) {
+      return this.distinct(n).join("-") as Join<T>;
+    } else {
+      return n.toString() as Join<T>;
+    }
+  }
 
   /**
    * a
@@ -48,62 +67,8 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  byTitle(bool: boolean = true): this {
-    this.set({ title: bool ? 1 : 0 });
-    return this;
-  }
-
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  byOutline(bool: boolean = true): this {
-    this.set({ ex: bool ? 1 : 0 });
-    return this;
-  }
-
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  byKeyword(bool: boolean = true): this {
-    this.set({ keyword: bool ? 1 : 0 });
-    return this;
-  }
-
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  byAuthor(bool: boolean = true): this {
-    this.set({ wname: bool ? 1 : 0 });
-    return this;
-  }
-
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  bigGenre(genre: BigGenre | BigGenre[]): this {
-    this.set({ biggenre: array2string(genre) });
-    return this;
-  }
-
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  notBigGenre(genre: BigGenre | BigGenre[]): this {
-    this.set({ notbiggenre: array2string(genre) });
-    return this;
-  }
-
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  genre(genre: Genre | Genre[]): this {
-    this.set({ genre: array2string(genre) });
+  byTitle(bool = true): this {
+    this.set({ title: bool ? BooleanNumber.True : BooleanNumber.False });
     return this;
   }
 
@@ -111,8 +76,8 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  notGenre(genre: Genre | Genre[]): this {
-    this.set({ notgenre: array2string(genre) });
+  byOutline(bool = true): this {
+    this.set({ ex: bool ? BooleanNumber.True : BooleanNumber.False });
     return this;
   }
 
@@ -120,8 +85,8 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  userId(ids: number | number[]): this {
-    this.set({ userid: array2string(ids) });
+  byKeyword(bool = true): this {
+    this.set({ keyword: bool ? BooleanNumber.True : BooleanNumber.False });
     return this;
   }
 
@@ -129,12 +94,8 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isR15(bool: boolean = true): this {
-    if (bool) {
-      this.set({ isr15: 1 });
-    } else {
-      this.set({ notr15: 1 });
-    }
+  byAuthor(bool = true): this {
+    this.set({ wname: bool ? BooleanNumber.True : BooleanNumber.False });
     return this;
   }
 
@@ -142,11 +103,11 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isBL(bool: boolean = true): this {
+  isBL(bool = true): this {
     if (bool) {
-      this.set({ isbl: 1 });
+      this.set({ isbl: BooleanNumber.True });
     } else {
-      this.set({ notbl: 1 });
+      this.set({ notbl: BooleanNumber.True });
     }
     return this;
   }
@@ -155,11 +116,11 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isGL(bool: boolean = true): this {
+  isGL(bool = true): this {
     if (bool) {
-      this.set({ isgl: 1 });
+      this.set({ isgl: BooleanNumber.True });
     } else {
-      this.set({ notgl: 1 });
+      this.set({ notgl: BooleanNumber.True });
     }
     return this;
   }
@@ -168,11 +129,11 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isZankoku(bool: boolean = true): this {
+  isZankoku(bool = true): this {
     if (bool) {
-      this.set({ iszankoku: 1 });
+      this.set({ iszankoku: BooleanNumber.True });
     } else {
-      this.set({ notzankoku: 1 });
+      this.set({ notzankoku: BooleanNumber.True });
     }
     return this;
   }
@@ -181,11 +142,11 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isTensei(bool: boolean = true): this {
+  isTensei(bool = true): this {
     if (bool) {
-      this.set({ istensei: 1 });
+      this.set({ istensei: BooleanNumber.True });
     } else {
-      this.set({ nottensei: 1 });
+      this.set({ nottensei: BooleanNumber.True });
     }
     return this;
   }
@@ -194,11 +155,11 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isTenni(bool: boolean = true): this {
+  isTenni(bool = true): this {
     if (bool) {
-      this.set({ istenni: 1 });
+      this.set({ istenni: BooleanNumber.True });
     } else {
-      this.set({ nottenni: 1 });
+      this.set({ nottenni: BooleanNumber.True });
     }
     return this;
   }
@@ -208,7 +169,7 @@ export default class SearchBuilder {
    * @return {SearchBuilder} this
    */
   isTT(): this {
-    this.set({ istt: 1 });
+    this.set({ istt: BooleanNumber.True });
     return this;
   }
 
@@ -217,7 +178,7 @@ export default class SearchBuilder {
    * @return {SearchBuilder} this
    */
   length(length: number | number[]): this {
-    this.set({ length: array2string(length) });
+    this.set({ length: SearchBuilderBase.array2string(length) });
     return this;
   }
 
@@ -244,7 +205,7 @@ export default class SearchBuilder {
    * @return {SearchBuilder} this
    */
   sasie(num: number | number[]): this {
-    this.set({ sasie: array2string(num) });
+    this.set({ sasie: SearchBuilderBase.array2string(num) });
     return this;
   }
 
@@ -253,7 +214,7 @@ export default class SearchBuilder {
    * @return {SearchBuilder} this
    */
   time(num: number | number[]): this {
-    this.set({ time: array2string(num) });
+    this.set({ time: SearchBuilderBase.array2string(num) });
     return this;
   }
 
@@ -262,7 +223,7 @@ export default class SearchBuilder {
    * @return {SearchBuilder} this
    */
   ncode(ncodes: string | string[]): this {
-    this.set({ ncode: array2string(ncodes) });
+    this.set({ ncode: SearchBuilderBase.array2string(ncodes) });
     return this;
   }
 
@@ -280,7 +241,7 @@ export default class SearchBuilder {
    * @return {SearchBuilder} this
    */
   buntai(buntai: Buntai | Buntai[]): this {
-    this.set({ buntai: array2string(buntai) });
+    this.set({ buntai: SearchBuilderBase.array2string(buntai) });
     return this;
   }
 
@@ -288,8 +249,8 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isStop(bool: boolean = true): this {
-    this.set({ stop: bool ? 1 : 0 });
+  isStop(bool = true): this {
+    this.set({ stop: bool ? Stop.Stopping : Stop.NoStopping });
     return this;
   }
 
@@ -297,8 +258,8 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  isPickup(bool: boolean = true): this {
-    this.set({ ispickup: bool ? 1 : 0 });
+  isPickup(bool = true): this {
+    this.set({ ispickup: bool ? BooleanNumber.True : BooleanNumber.False });
     return this;
   }
 
@@ -326,15 +287,6 @@ export default class SearchBuilder {
     return this;
   }
 
-  /**
-   *
-   * @return {SearchBuilder} this
-   */
-  fields(fields: Fields | Fields[]): this {
-    this.set({ of: array2string(fields) });
-    return this;
-  }
-
   /**
    *
    * @return {SearchBuilder} this
@@ -357,14 +309,10 @@ export default class SearchBuilder {
    *
    * @return {SearchBuilder} this
    */
-  page(no: number, count: number = 20): this {
+  page(no: number, count = 20): this {
     return this.limit(count).start(no * count);
   }
 
-  opt(option: "weekly" | undefined): this {
-    return this.set({ opt: option });
-  }
-
   /**
    * 出力順序を指定する。指定しない場合は新着順となります。
    *
@@ -427,19 +375,92 @@ export default class SearchBuilder {
    * なろう小説APIへの検索リクエストを実行する
    * @returns {Promise<NarouSearchResults>} 検索結果
    */
-  execute(): Promise<INarouSearchResults> {
+  execute(): Promise<NarouSearchResults<T>> {
     return this.api.executeNovel(this.params);
   }
 }
 
-function distinct<T>(array: T[]): T[] {
-  return Array.from(new Set(array));
-}
+/**
+ * 検索ヘルパー
+ * @class SearchBuilder
+ */
+export default class SearchBuilder<
+  T extends keyof NarouSearchResult = DefaultSearchResultFields,
+  TOpt extends keyof NarouSearchResult = never
+> extends SearchBuilderBase<T | TOpt> {
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  bigGenre(genre: BigGenre | BigGenre[]): this {
+    this.set({ biggenre: SearchBuilderBase.array2string(genre) });
+    return this;
+  }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  notBigGenre(genre: BigGenre | BigGenre[]): this {
+    this.set({ notbiggenre: SearchBuilderBase.array2string(genre) });
+    return this;
+  }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  genre(genre: Genre | Genre[]): this {
+    this.set({ genre: SearchBuilderBase.array2string(genre) });
+    return this;
+  }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  notGenre(genre: Genre | Genre[]): this {
+    this.set({ notgenre: SearchBuilderBase.array2string(genre) });
+    return this;
+  }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  userId(ids: number | number[]): this {
+    this.set({ userid: SearchBuilderBase.array2string(ids) });
+    return this;
+  }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  isR15(bool = true): this {
+    if (bool) {
+      this.set({ isr15: 1 });
+    } else {
+      this.set({ notr15: 1 });
+    }
+    return this;
+  }
+
+  /**
+   *
+   * @return {SearchBuilder} this
+   */
+  fields<TFields extends Fields>(
+    fields: TFields | readonly TFields[]
+  ): SearchBuilder<SearchResultFields<TFields>, TOpt> {
+    this.set({ of: SearchBuilderBase.array2string(fields) });
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return this as any;
+  }
 
-function array2string<T extends string | number>(n: T | T[]): string {
-  if (Array.isArray(n)) {
-    return distinct(n).join("-");
-  } else {
-    return n.toString();
+  opt<TFields extends OptionalFields>(
+    option: TFields | TFields[]
+  ): SearchBuilder<T, SerachResultOptionalFields<TFields>> {
+    return this.set({ opt: SearchBuilderBase.array2string(option) }) as any;
   }
 }

package/src/util/jsonp.ts

@@ -10,6 +10,7 @@ type CallbackId<Prefix extends string = string> = `${Prefix}${number}`;
 
 declare global {
   interface Window {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     [key: CallbackId]: (data: any) => void;
   }
 }
@@ -18,6 +19,8 @@ export type JsonpOption = {
   param?: string;
   timeout?: number;
 };
+
+// eslint-disable-next-line @typescript-eslint/no-empty-function
 const noop = function () {};
 
 export function jsonp<T>(

package/src/util/type.ts

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