narou 0.8.1 → 0.9.1

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,+CAA4C;AASnC,0BATF,qBAAe,CASE;AARxB,+CAA4C;AAQlB,0BARnB,qBAAe,CAQmB;AAPzC,uCAAuC;AACvC,uDAA+E;AAC/E,qDAA6C;AAC7C,6DAAoD;AACpD,+CAA8C;AAE9C,iDAA+B;AAG/B,MAAM,eAAe,GAAG,IAAI,qBAAe,EAAE,CAAC;AAE9C;;;;GAIG;AACH,SAAgB,MAAM,CACpB,IAAI,GAAG,EAAE,EACT,MAAkB,eAAe;IAEjC,MAAM,OAAO,GAAG,IAAI,wBAAa,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC3C,IAAI,IAAI,IAAI,EAAE;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,OAAO,CAAC;AACjB,CAAC;AAPD,wBAOC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CACvB,IAAI,GAAG,EAAE,EACT,MAAkB,eAAe;IAEjC,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9C,IAAI,IAAI,IAAI,EAAE;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,OAAO,CAAC;AACjB,CAAC;AAPD,8BAOC;AAED;;GAEG;AACH,SAAgB,UAAU,CAAC,IAAI,GAAG,EAAE,EAAE,MAAkB,eAAe;IACrE,MAAM,OAAO,GAAG,IAAI,qBAAiB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC/C,IAAI,IAAI,IAAI,EAAE;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,OAAO,CAAC;AACjB,CAAC;AAJD,gCAIC;AAED;;GAEG;AACH,SAAgB,OAAO,CAAC,MAAkB,eAAe;IACvD,MAAM,OAAO,GAAG,IAAI,iBAAc,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,OAAO,CAAC;AACjB,CAAC;AAHD,0BAGC;AAED;;GAEG;AACI,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,MAAkB,eAAe;IAEjC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,MAAM,CAAC,GAAG,CAAC,sCAAoB,CAAC,CAAC;KACzC;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;AACH,CAAC;AAVD,wCAUC;AAED,kBAAe;IACb,MAAM;IACN,SAAS;IACT,UAAU;IACV,OAAO;IACP,cAAc;CACf,CAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import NarouNovel from \"./narou\";\nimport NarouNovelFetch from \"./narou-fetch\";\nimport NarouNovelJsonp from \"./narou-jsonp\";\nimport RankingBuilder from \"./ranking\";\nimport { formatRankingHistory, RankingHistoryResult } from \"./ranking-history\";\nimport SearchBuilder from \"./search-builder\";\nimport SearchBuilderR18 from \"./search-builder-r18\";\nimport UserSearchBuilder from \"./user-search\";\n\nexport * from \"./index.common\";\nexport { NarouNovelFetch, NarouNovelJsonp };\n\nconst narouNovelFetch = new NarouNovelFetch();\n\n/**\n * なろう小説 API で小説を検索する\n * @param {string} [word] - 検索ワード\n * @returns {SearchBuilder}\n */\nexport function search(\n  word = \"\",\n  api: NarouNovel = narouNovelFetch\n): SearchBuilder {\n  const builder = new SearchBuilder({}, api);\n  if (word != \"\") builder.word(word);\n  return builder;\n}\n\n/**\n * 18禁小説 API で小説を検索する\n * @param {string} [word] - 検索ワード\n * @returns {SearchBuilder}\n */\nexport function searchR18(\n  word = \"\",\n  api: NarouNovel = narouNovelFetch\n): SearchBuilderR18 {\n  const builder = new SearchBuilderR18({}, api);\n  if (word != \"\") builder.word(word);\n  return builder;\n}\n\n/**\n * なろうユーザ検索 API でユーザを検索する\n */\nexport function searchUser(word = \"\", api: NarouNovel = narouNovelFetch) {\n  const builder = new UserSearchBuilder({}, api);\n  if (word != \"\") builder.word(word);\n  return builder;\n}\n\n/**\n * なろう小説ランキング API でランキングを取得する\n */\nexport function ranking(api: NarouNovel = narouNovelFetch): RankingBuilder {\n  const builder = new RankingBuilder({}, api);\n  return builder;\n}\n\n/**\n * なろう殿堂入り API でランキング履歴を取得する\n */\nexport async function rankingHistory(\n  ncode: string,\n  api: NarouNovel = narouNovelFetch\n): Promise<RankingHistoryResult[]> {\n  const result = await api.executeRankingHistory({ ncode });\n  if (Array.isArray(result)) {\n    return result.map(formatRankingHistory);\n  } else {\n    throw new Error(result);\n  }\n}\n\nexport default {\n  search,\n  searchR18,\n  searchUser,\n  ranking,\n  rankingHistory,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,IAAM,kBAAkB,IAAI,gBAAgB;AAOrC,SAAS,OACd,OAAO,IACP,MAAkB,iBACH;AACf,QAAM,UAAU,IAAI,cAAc,CAAC,GAAG,GAAG;AACzC,MAAI,QAAQ;AAAI,YAAQ,KAAK,IAAI;AACjC,SAAO;AACT;AAOO,SAAS,UACd,OAAO,IACP,MAAkB,iBACA;AAClB,QAAM,UAAU,IAAI,iBAAiB,CAAC,GAAG,GAAG;AAC5C,MAAI,QAAQ;AAAI,YAAQ,KAAK,IAAI;AACjC,SAAO;AACT;AAKO,SAAS,WAAW,OAAO,IAAI,MAAkB,iBAAiB;AACvE,QAAM,UAAU,IAAI,kBAAkB,CAAC,GAAG,GAAG;AAC7C,MAAI,QAAQ;AAAI,YAAQ,KAAK,IAAI;AACjC,SAAO;AACT;AAKO,SAAS,QAAQ,MAAkB,iBAAiC;AACzE,QAAM,UAAU,IAAI,eAAe,CAAC,GAAG,GAAG;AAC1C,SAAO;AACT;AAKA,eAAsB,eACpB,OACA,MAAkB,iBACe;AACjC,QAAM,SAAS,MAAM,IAAI,sBAAsB,EAAE,MAAM,CAAC;AACxD,MAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,WAAO,OAAO,IAAI,oBAAoB;AAAA,EACxC,OAAO;AACL,UAAM,IAAI,MAAM,MAAM;AAAA,EACxB;AACF;AAEA,IAAO,cAAQ;AAAA,EACb;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":[]}

package/dist/narou-61329eea.d.ts

@@ -0,0 +1,298 @@
+import { r as NarouSearchResult, a as ParamsBaseWithOrder, q as GzipLevel, d as SearchResultFieldNames, S as SearchParams, g as Order, o as NovelTypeParam, m as BuntaiParam, N as NarouSearchResults, j as BigGenre, G as Genre, F as Fields, u as SearchResultFields, O as OptionalFields, v as SearchResultOptionalFields, y as PickedNarouSearchResult, b as RankingParams, c as RankingHistoryParams, U as UserSearchParams, s as UserSearchResult } from './narou-search-results-b7c10db0.js';
+import { RankingHistoryRawResult } from './ranking-history.js';
+import { Join } from './util/type.js';
+
+type DefaultSearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "nocgenre" | "xid">;
+declare abstract class SearchBuilderBase<TParams extends ParamsBaseWithOrder<TOrder>, TOrder extends string> {
+    protected params: TParams;
+    protected api: NarouNovel;
+    /**
+     * constructor
+     * @private
+     */
+    constructor(params: TParams, api: NarouNovel);
+    protected static distinct<T>(array: readonly T[]): T[];
+    protected static array2string<T extends string | number>(n: T | readonly T[]): Join<T>;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    limit(num: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    start(num: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    page(no: number, count?: number): this;
+    /**
+     * 出力順序を指定する。指定しない場合は新着順となります。
+     * old	古い順
+     * @param {TOrder} order 出力順序
+     * @return {SearchBuilder} this
+     */
+    order(order: TOrder): this;
+    /**
+     * gzip圧縮する。
+     *
+     * 転送量上限を減らすためにも推奨
+     * @param {GzipLevel} level gzip圧縮レベル(1～5)
+     * @return {SearchBuilder} this
+     */
+    gzip(level: GzipLevel): this;
+    /**
+     * クエリパラメータをセットする
+     * @private
+     * @return {SearchBuilder} this
+     */
+    protected set(obj: TParams): this;
+    /**
+     * クエリパラメータを削除する
+     */
+    protected unset(key: keyof TParams): this;
+}
+declare abstract class NovelSearchBuilderBase<T extends SearchResultFieldNames> extends SearchBuilderBase<SearchParams, Order> {
+    /**
+     * a
+     * @return {SearchBuilder} this
+     */
+    word(word: string): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notWord(word: string): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byTitle(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byOutline(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byKeyword(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byAuthor(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isBL(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isGL(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isZankoku(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTensei(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTenni(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTT(): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    length(length: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    kaiwaritu(num: number): this;
+    kaiwaritu(min: number, max: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    sasie(num: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    time(num: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    ncode(ncodes: string | readonly string[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    type(type: NovelTypeParam): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    buntai(buntai: BuntaiParam | readonly BuntaiParam[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isStop(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isPickup(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    lastUpdate(date: string): this;
+    lastUpdate(from: number, to: number): this;
+    lastUpdate(from: Date, to: Date): this;
+    /**
+     * なろう小説APIへの検索リクエストを実行する
+     * @returns {Promise<NarouSearchResults>} 検索結果
+     */
+    execute(): Promise<NarouSearchResults<NarouSearchResult, T>>;
+}
+/**
+ * 検索ヘルパー
+ * @class SearchBuilder
+ */
+declare class SearchBuilder<T extends keyof NarouSearchResult = DefaultSearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    bigGenre(genre: BigGenre | readonly BigGenre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notBigGenre(genre: BigGenre | readonly BigGenre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    genre(genre: Genre | readonly Genre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notGenre(genre: Genre | readonly Genre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    userId(ids: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isR15(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    fields<TFields extends Fields>(fields: TFields | readonly TFields[]): SearchBuilder<SearchResultFields<TFields>, TOpt>;
+    opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilder<T, SearchResultOptionalFields<TFields>>;
+}
+
+/**
+ * ランキングAPIの結果
+ * @see https://dev.syosetu.com/man/rankapi/#output
+ */
+interface NarouRankingResult {
+    /** Nコード */
+    ncode: string;
+    /** 順位 */
+    rank: number;
+    /** ポイント */
+    pt: number;
+}
+/**
+ * ランキングと小説情報をマージした結果
+ */
+type RankingResult<T extends SearchResultFieldNames = DefaultSearchResultFields> = Partial<PickedNarouSearchResult<T>> & NarouRankingResult;
+
+/**
+ * なろう小説APIへのリクエストパラメータ
+ */
+type NarouParams = SearchParams | RankingParams | RankingHistoryParams | UserSearchParams;
+/**
+ * なろう小説APIへのリクエストを実行する
+ * @class NarouNovel
+ * @private
+ */
+declare abstract class NarouNovel {
+    /**
+     * なろうAPIへのAPIリクエストを実行する
+     * @param params クエリパラメータ
+     * @param endpoint APIエンドポイント
+     * @returns 実行結果
+     */
+    protected abstract execute<T>(params: NarouParams, endpoint: string): Promise<T>;
+    /**
+     * APIへの検索リクエストを実行する
+     * @param params クエリパラメータ
+     * @param endpoint APIエンドポイント
+     * @returns 検索結果
+     */
+    protected executeSearch<T extends keyof NarouSearchResult>(params: SearchParams, endpoint?: string): Promise<NarouSearchResults<NarouSearchResult, T>>;
+    /**
+     * 小説APIへの検索リクエストを実行する
+     * @param params クエリパラメータ
+     * @returns 検索結果
+     * @see https://dev.syosetu.com/man/api/
+     */
+    executeNovel<T extends keyof NarouSearchResult>(params: SearchParams): Promise<NarouSearchResults<NarouSearchResult, T>>;
+    /**
+     * R18小説APIへの検索リクエストを実行する
+     * @param params クエリパラメータ
+     * @returns 検索結果
+     * @see https://dev.syosetu.com/xman/api/
+     */
+    executeNovel18<T extends keyof NarouSearchResult>(params: SearchParams): Promise<NarouSearchResults<NarouSearchResult, T>>;
+    /**
+     * ランキングAPIへのリクエストを実行する
+     * @param params クエリパラメータ
+     * @returns ランキング結果
+     * @see https://dev.syosetu.com/man/rankapi/
+     */
+    executeRanking(params: RankingParams): Promise<NarouRankingResult[]>;
+    /**
+     * 殿堂入りAPiへのリクエストを実行する
+     * @param params クエリパラメータ
+     * @returns ランキング履歴結果
+     * @see https://dev.syosetu.com/man/rankinapi/
+     */
+    executeRankingHistory(params: RankingHistoryParams): Promise<RankingHistoryRawResult[]>;
+    /**
+     * ユーザー検索APIへのリクエストを実行する
+     * @param params クエリパラメータ
+     * @returns 検索結果
+     * @see https://dev.syosetu.com/man/userapi/
+     */
+    executeUserSearch<T extends keyof UserSearchResult>(params: UserSearchParams): Promise<NarouSearchResults<UserSearchResult, T>>;
+}
+
+export { DefaultSearchResultFields as D, NarouNovel as N, RankingResult as R, SearchBuilder as S, NarouParams as a, NarouRankingResult as b, SearchBuilderBase as c, NovelSearchBuilderBase as d };

package/dist/narou-98ededc8.d.ts

@@ -0,0 +1,298 @@
+import { r as NarouSearchResult, a as ParamsBaseWithOrder, q as GzipLevel, d as SearchResultFieldNames, S as SearchParams, g as Order, o as NovelTypeParam, m as BuntaiParam, N as NarouSearchResults, j as BigGenre, G as Genre, F as Fields, u as SearchResultFields, O as OptionalFields, v as SearchResultOptionalFields, y as PickedNarouSearchResult, b as RankingParams, c as RankingHistoryParams, U as UserSearchParams, s as UserSearchResult } from './narou-search-results-6727b1ce.js';
+import { RankingHistoryRawResult } from './ranking-history.cjs';
+import { Join } from './util/type.cjs';
+
+type DefaultSearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "nocgenre" | "xid">;
+declare abstract class SearchBuilderBase<TParams extends ParamsBaseWithOrder<TOrder>, TOrder extends string> {
+    protected params: TParams;
+    protected api: NarouNovel;
+    /**
+     * constructor
+     * @private
+     */
+    constructor(params: TParams, api: NarouNovel);
+    protected static distinct<T>(array: readonly T[]): T[];
+    protected static array2string<T extends string | number>(n: T | readonly T[]): Join<T>;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    limit(num: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    start(num: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    page(no: number, count?: number): this;
+    /**
+     * 出力順序を指定する。指定しない場合は新着順となります。
+     * old	古い順
+     * @param {TOrder} order 出力順序
+     * @return {SearchBuilder} this
+     */
+    order(order: TOrder): this;
+    /**
+     * gzip圧縮する。
+     *
+     * 転送量上限を減らすためにも推奨
+     * @param {GzipLevel} level gzip圧縮レベル(1～5)
+     * @return {SearchBuilder} this
+     */
+    gzip(level: GzipLevel): this;
+    /**
+     * クエリパラメータをセットする
+     * @private
+     * @return {SearchBuilder} this
+     */
+    protected set(obj: TParams): this;
+    /**
+     * クエリパラメータを削除する
+     */
+    protected unset(key: keyof TParams): this;
+}
+declare abstract class NovelSearchBuilderBase<T extends SearchResultFieldNames> extends SearchBuilderBase<SearchParams, Order> {
+    /**
+     * a
+     * @return {SearchBuilder} this
+     */
+    word(word: string): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notWord(word: string): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byTitle(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byOutline(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byKeyword(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byAuthor(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isBL(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isGL(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isZankoku(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTensei(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTenni(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTT(): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    length(length: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    kaiwaritu(num: number): this;
+    kaiwaritu(min: number, max: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    sasie(num: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    time(num: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    ncode(ncodes: string | readonly string[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    type(type: NovelTypeParam): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    buntai(buntai: BuntaiParam | readonly BuntaiParam[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isStop(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isPickup(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    lastUpdate(date: string): this;
+    lastUpdate(from: number, to: number): this;
+    lastUpdate(from: Date, to: Date): this;
+    /**
+     * なろう小説APIへの検索リクエストを実行する
+     * @returns {Promise<NarouSearchResults>} 検索結果
+     */
+    execute(): Promise<NarouSearchResults<NarouSearchResult, T>>;
+}
+/**
+ * 検索ヘルパー
+ * @class SearchBuilder
+ */
+declare class SearchBuilder<T extends keyof NarouSearchResult = DefaultSearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    bigGenre(genre: BigGenre | readonly BigGenre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notBigGenre(genre: BigGenre | readonly BigGenre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    genre(genre: Genre | readonly Genre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notGenre(genre: Genre | readonly Genre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    userId(ids: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isR15(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    fields<TFields extends Fields>(fields: TFields | readonly TFields[]): SearchBuilder<SearchResultFields<TFields>, TOpt>;
+    opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilder<T, SearchResultOptionalFields<TFields>>;
+}
+
+/**
+ * ランキングAPIの結果
+ * @see https://dev.syosetu.com/man/rankapi/#output
+ */
+interface NarouRankingResult {
+    /** Nコード */
+    ncode: string;
+    /** 順位 */
+    rank: number;
+    /** ポイント */
+    pt: number;
+}
+/**
+ * ランキングと小説情報をマージした結果
+ */
+type RankingResult<T extends SearchResultFieldNames = DefaultSearchResultFields> = Partial<PickedNarouSearchResult<T>> & NarouRankingResult;
+
+/**
+ * なろう小説APIへのリクエストパラメータ
+ */
+type NarouParams = SearchParams | RankingParams | RankingHistoryParams | UserSearchParams;
+/**
+ * なろう小説APIへのリクエストを実行する
+ * @class NarouNovel
+ * @private
+ */
+declare abstract class NarouNovel {
+    /**
+     * なろうAPIへのAPIリクエストを実行する
+     * @param params クエリパラメータ
+     * @param endpoint APIエンドポイント
+     * @returns 実行結果
+     */
+    protected abstract execute<T>(params: NarouParams, endpoint: string): Promise<T>;
+    /**
+     * APIへの検索リクエストを実行する
+     * @param params クエリパラメータ
+     * @param endpoint APIエンドポイント
+     * @returns 検索結果
+     */
+    protected executeSearch<T extends keyof NarouSearchResult>(params: SearchParams, endpoint?: string): Promise<NarouSearchResults<NarouSearchResult, T>>;
+    /**
+     * 小説APIへの検索リクエストを実行する
+     * @param params クエリパラメータ
+     * @returns 検索結果
+     * @see https://dev.syosetu.com/man/api/
+     */
+    executeNovel<T extends keyof NarouSearchResult>(params: SearchParams): Promise<NarouSearchResults<NarouSearchResult, T>>;
+    /**
+     * R18小説APIへの検索リクエストを実行する
+     * @param params クエリパラメータ
+     * @returns 検索結果
+     * @see https://dev.syosetu.com/xman/api/
+     */
+    executeNovel18<T extends keyof NarouSearchResult>(params: SearchParams): Promise<NarouSearchResults<NarouSearchResult, T>>;
+    /**
+     * ランキングAPIへのリクエストを実行する
+     * @param params クエリパラメータ
+     * @returns ランキング結果
+     * @see https://dev.syosetu.com/man/rankapi/
+     */
+    executeRanking(params: RankingParams): Promise<NarouRankingResult[]>;
+    /**
+     * 殿堂入りAPiへのリクエストを実行する
+     * @param params クエリパラメータ
+     * @returns ランキング履歴結果
+     * @see https://dev.syosetu.com/man/rankinapi/
+     */
+    executeRankingHistory(params: RankingHistoryParams): Promise<RankingHistoryRawResult[]>;
+    /**
+     * ユーザー検索APIへのリクエストを実行する
+     * @param params クエリパラメータ
+     * @returns 検索結果
+     * @see https://dev.syosetu.com/man/userapi/
+     */
+    executeUserSearch<T extends keyof UserSearchResult>(params: UserSearchParams): Promise<NarouSearchResults<UserSearchResult, T>>;
+}
+
+export { DefaultSearchResultFields as D, NarouNovel as N, RankingResult as R, SearchBuilder as S, NarouParams as a, NarouRankingResult as b, SearchBuilderBase as c, NovelSearchBuilderBase as d };