narou 0.7.7 → 0.8.1

package/src/index.browser.ts

@@ -4,6 +4,7 @@ import SearchBuilder from "./search-builder";
 import SearchBuilderR18 from "./search-builder-r18";
 import RankingBuilder from "./ranking";
 import { formatRankingHistory, RankingHistoryResult } from "./ranking-history";
+import UserSearchBuilder from "./user-search";
 
 export * from "./index.common";
 export { NarouNovelJsonp };
@@ -38,6 +39,15 @@ export function searchR18(
   return builder;
 }
 
+/**
+ * ユーザ検索
+ */
+export function searchUser(word = "", api: NarouNovel = narouNovelJsonp) {
+  const builder = new UserSearchBuilder({}, api);
+  if (word != "") builder.word(word);
+  return builder;
+}
+
 export function ranking(api: NarouNovel = narouNovelJsonp): RankingBuilder {
   const builder = new RankingBuilder({}, api);
   return builder;
@@ -57,7 +67,8 @@ export async function rankingHistory(
 
 export default {
   search,
-  ranking,
   searchR18,
+  searchUser,
+  ranking,
   rankingHistory,
 };

package/src/index.common.ts

@@ -1,33 +1,22 @@
 import NarouNovel from "./narou";
 import NarouSearchResults from "./narou-search-results";
+import SearchBuilder from "./search-builder";
+import SearchBuilderR18 from "./search-builder-r18";
+import RankingBuilder from "./ranking";
 
-export { NarouNovel, NarouSearchResults };
-
-export { RankingHistoryResult } from "./ranking-history";
-export {
-  RankingType,
-  Fields,
-  SearchResultFieldNames,
-  Order,
-  BigGenre,
-  BigGenreNotation,
-  Genre,
-  GenreNotation,
-  R18Site,
-  R18SiteNotation,
-  BuntaiParam,
-  NovelTypeParam,
-  BooleanNumber,
-} from "./params";
 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";
+  NarouNovel,
+  NarouSearchResults,
+  SearchBuilder,
+  SearchBuilderR18,
+  RankingBuilder,
+};
+
+export * from "./ranking-history";
+export * from "./params";
+export { NarouParams } from "./narou";
+export * from "./narou-search-results";
+export * from "./narou-ranking-results";
+export * from "./search-builder";
+export * from "./search-builder-r18";
+export * from "./user-search";

package/src/index.ts

@@ -5,6 +5,7 @@ import RankingBuilder from "./ranking";
 import { formatRankingHistory, RankingHistoryResult } from "./ranking-history";
 import SearchBuilder from "./search-builder";
 import SearchBuilderR18 from "./search-builder-r18";
+import UserSearchBuilder from "./user-search";
 
 export * from "./index.common";
 export { NarouNovelFetch, NarouNovelJsonp };
@@ -12,7 +13,7 @@ export { NarouNovelFetch, NarouNovelJsonp };
 const narouNovelFetch = new NarouNovelFetch();
 
 /**
- * 検索
+ * なろう小説 API で小説を検索する
  * @param {string} [word] - 検索ワード
  * @returns {SearchBuilder}
  */
@@ -26,7 +27,7 @@ export function search(
 }
 
 /**
- * 検索
+ * 18禁小説 API で小説を検索する
  * @param {string} [word] - 検索ワード
  * @returns {SearchBuilder}
  */
@@ -39,11 +40,26 @@ export function searchR18(
   return builder;
 }
 
+/**
+ * なろうユーザ検索 API でユーザを検索する
+ */
+export function searchUser(word = "", api: NarouNovel = narouNovelFetch) {
+  const builder = new UserSearchBuilder({}, api);
+  if (word != "") builder.word(word);
+  return builder;
+}
+
+/**
+ * なろう小説ランキング API でランキングを取得する
+ */
 export function ranking(api: NarouNovel = narouNovelFetch): RankingBuilder {
   const builder = new RankingBuilder({}, api);
   return builder;
 }
 
+/**
+ * なろう殿堂入り API でランキング履歴を取得する
+ */
 export async function rankingHistory(
   ncode: string,
   api: NarouNovel = narouNovelFetch
@@ -58,7 +74,8 @@ export async function rankingHistory(
 
 export default {
   search,
-  ranking,
   searchR18,
+  searchUser,
+  ranking,
   rankingHistory,
 };

package/src/narou-search-results.ts

@@ -7,29 +7,27 @@ import {
   BigGenre,
   R18Fields,
   OptionalFields,
+  UserFields,
 } from "./params";
 
 /**
  * なろう小説API検索結果
  * @class NarouSearchResults
  */
-export default class NarouSearchResults<T extends keyof NarouSearchResult> {
+export default class NarouSearchResults<T, TKey extends keyof T> {
   allcount: number;
   limit: number;
   start: number;
   page: number;
   length: number;
-  values: PickedNarouSearchResult<T>[];
+  values: readonly Pick<T, TKey>[];
 
   /**
    * @constractor
    * @private
    */
   constructor(
-    [header, ...result]: [
-      { allcount: number },
-      ...PickedNarouSearchResult<T>[]
-    ],
+    [header, ...result]: [{ allcount: number }, ...Pick<T, TKey>[]],
     params: SearchParams
   ) {
     const count = header.allcount;
@@ -142,6 +140,17 @@ export interface NarouSearchResult {
   weekly_unique: number;
 }
 
+export interface UserSearchResult {
+  userid: number;
+  name: string;
+  yomikata: string;
+  name1st: string;
+  novel_cnt: number;
+  review_cnt: number;
+  novel_length: number;
+  sum_global_point: number;
+}
+
 export const PcOrK = {
   Ketai: 1,
   Pc: 2,
@@ -165,7 +174,7 @@ 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> = {
+export type SearchResultOptionalFields<T extends OptionalFields> = {
   [K in keyof typeof OptionalFields]: typeof OptionalFields[K] extends T
     ? K
     : never;
@@ -175,6 +184,10 @@ export type SearchResultR18Fields<T extends R18Fields> = {
   [K in keyof typeof R18Fields]: typeof R18Fields[K] extends T ? K : never;
 }[keyof typeof R18Fields];
 
+export type UserSearchResultFields<T extends UserFields> = {
+  [K in keyof typeof UserFields]: typeof UserFields[K] extends T ? K : never;
+}[keyof typeof UserFields];
+
 export type PickedNarouSearchResult<T extends keyof NarouSearchResult> = Pick<
   NarouSearchResult,
   T

package/src/narou.ts

@@ -1,9 +1,21 @@
 import { NarouRankingResult } from "./narou-ranking-results";
-import NarouSearchResults, { NarouSearchResult } from "./narou-search-results";
-import { RankingHistoryParams, RankingParams, SearchParams } from "./params";
+import NarouSearchResults, {
+  NarouSearchResult,
+  UserSearchResult,
+} from "./narou-search-results";
+import {
+  RankingHistoryParams,
+  RankingParams,
+  SearchParams,
+  UserSearchParams,
+} from "./params";
 import { RankingHistoryRawResult } from "./ranking-history";
 
-export type NarouParams = SearchParams | RankingParams | RankingHistoryParams;
+export type NarouParams =
+  | SearchParams
+  | RankingParams
+  | RankingHistoryParams
+  | UserSearchParams;
 
 /**
  * なろう小説APIへのリクエストを実行する
@@ -23,18 +35,15 @@ export default abstract class NarouNovel {
   ): Promise<T>;
 
   async executeSearch<T extends keyof NarouSearchResult>(
-    params: NarouParams,
+    params: SearchParams,
     endpoint = "https://api.syosetu.com/novelapi/api/"
-  ): Promise<NarouSearchResults<T>> {
-    return new NarouSearchResults<T>(
-      await this.execute(params, endpoint),
-      params
-    );
+  ): Promise<NarouSearchResults<NarouSearchResult, T>> {
+    return new NarouSearchResults(await this.execute(params, endpoint), params);
   }
 
   async executeNovel<T extends keyof NarouSearchResult>(
     params: SearchParams
-  ): Promise<NarouSearchResults<T>> {
+  ): Promise<NarouSearchResults<NarouSearchResult, T>> {
     return await this.executeSearch(
       params,
       "https://api.syosetu.com/novelapi/api/"
@@ -43,7 +52,7 @@ export default abstract class NarouNovel {
 
   async executeNovel18<T extends keyof NarouSearchResult>(
     params: SearchParams
-  ): Promise<NarouSearchResults<T>> {
+  ): Promise<NarouSearchResults<NarouSearchResult, T>> {
     return await this.executeSearch(
       params,
       "https://api.syosetu.com/novel18api/api/"
@@ -59,4 +68,10 @@ export default abstract class NarouNovel {
   ): Promise<RankingHistoryRawResult[]> {
     return await this.execute(params, "https://api.syosetu.com/rank/rankin/");
   }
+
+  async executeUserSearch<T extends keyof UserSearchResult>(
+    params: UserSearchParams
+  ): Promise<NarouSearchResults<UserSearchResult, T>> {
+    return await this.execute(params, "https://api.syosetu.com/userapi/api/");
+  }
 }

package/src/params.ts

@@ -1,4 +1,4 @@
-import { NarouSearchResult } from "./narou-search-results";
+import { NarouSearchResult, UserSearchResult } from "./narou-search-results";
 import { Join } from "./util/type";
 
 export const RankingType = {
@@ -9,6 +9,18 @@ export const RankingType = {
 } as const;
 export type RankingType = typeof RankingType[keyof typeof RankingType];
 
+export interface ParamsBase {
+  gzip?: GzipLevel;
+  out?: "json" | "jsonp";
+}
+
+export interface ParamsBaseWithOrder<TOrder extends string> extends ParamsBase {
+  of?: string;
+  lim?: number;
+  st?: number;
+  order?: TOrder;
+}
+
 /**
  * {@link SearchBuilder#Fields}メソッドにパラメータを指定する際のヘルパー。
  * @typedef {Object} Fields
@@ -38,14 +50,7 @@ export type RankingType = typeof RankingType[keyof typeof RankingType];
  * @property {string} novelupdated_at 小説の更新日時
  * @property {string} updated_at 最終更新日時(注意：システム用で小説更新時とは関係ありません)
  */
-export interface SearchParams {
-  gzip?: GzipLevel;
-  out?: "json";
-  of?: string;
-  lim?: number;
-  st?: number;
-  order?: Order;
-
+export interface SearchParams extends ParamsBaseWithOrder<Order> {
   word?: string;
   notword?: string;
   title?: BooleanNumber;
@@ -104,16 +109,34 @@ export interface SearchParams {
   opt?: Join<OptionalFields>;
 }
 
-export interface RankingParams {
+export interface RankingParams extends ParamsBase {
   rtype: `${string}-${RankingType}`;
-  gzip?: GzipLevel;
-  out?: "json";
 }
 
-export interface RankingHistoryParams {
+export interface RankingHistoryParams extends ParamsBase {
   ncode: string;
-  gzip?: GzipLevel;
-  out?: "json";
+}
+
+/**
+ * ユーザー検索パラメータ
+ */
+export interface UserSearchParams extends ParamsBaseWithOrder<UserOrder> {
+  /** 単語を指定できます。半角または全角スペースで区切るとAND抽出になります。部分一致でHITします。検索の対象はユーザ名とユーザ名のフリガナです。 */
+  word?: string;
+  /** 含みたくない単語を指定できます。スペースで区切ることにより含ませない単語を増やせます。部分一致で除外されます。除外の対象はユーザ名とユーザ名のフリガナです。 */
+  notword?: string;
+  /** ユーザIDで抽出可能。 */
+  userid?: number;
+  /** 抽出するユーザのユーザ名のフリガナの頭文字を指定できます。頭文字はユーザ名のフリガナをひらがなに変換し、最初の1文字が「ぁ」～「ん」の場合に対象となります。 */
+  name1st?: string;
+  /** 抽出するユーザの小説投稿数の下限を指定できます。小説投稿件数が指定された数値以上のユーザを抽出します。 */
+  minnovel?: number;
+  /** 抽出するユーザの小説投稿数の上限を指定できます。小説投稿件数が指定された数値以下のユーザを抽出します。 */
+  maxnovel?: number;
+  /** 抽出するユーザのレビュー投稿数の下限を指定できます。レビュー投稿件数が指定された数値以上のユーザを抽出します。 */
+  minreview?: number;
+  /** 抽出するユーザのレビュー投稿数の上限を指定できます。レビュー投稿件数が指定された数値以下のユーザを抽出します。 */
+  maxreview?: number;
 }
 
 export const BooleanNumber = {
@@ -216,6 +239,18 @@ export type R18Fields = typeof R18Fields[keyof Omit<
   "novel_type" | "weekly_unique" | "biggenre" | "genre"
 >];
 
+export const UserFields = {
+  userid: "u",
+  name: "n",
+  yomikata: "y",
+  name1st: "1",
+  novel_cnt: "nc",
+  review_cnt: "rc",
+  novel_length: "nl",
+  sum_global_point: "sg",
+} as const;
+export type UserFields = typeof UserFields[keyof UserSearchResult];
+
 export const OptionalFields = {
   weekly_unique: "weekly",
 } as const;
@@ -379,4 +414,14 @@ export const NovelTypeParam = {
 } as const;
 export type NovelTypeParam = typeof NovelTypeParam[keyof typeof NovelTypeParam];
 
+export const UserOrder = {
+  New: "new",
+  NovelCount: "novelcnt",
+  ReviewCount: "reviewcnt",
+  NovelLength: "novellength",
+  SumGlobalPoint: "sumglobalpoint",
+  Old: "old",
+} as const;
+export type UserOrder = typeof UserOrder[keyof typeof UserOrder];
+
 export type GzipLevel = 0 | 1 | 2 | 3 | 4 | 5;

package/src/search-builder-r18.ts

@@ -1,8 +1,8 @@
-import { SearchBuilderBase } from "./search-builder";
+import { NovelSearchBuilderBase } from "./search-builder";
 import NarouSearchResults, {
   NarouSearchResult,
   SearchResultR18Fields,
-  SerachResultOptionalFields,
+  SearchResultOptionalFields,
 } from "./narou-search-results";
 import {
   R18Site,
@@ -23,18 +23,18 @@ export type DefaultR18SearchResultFields = keyof Omit<
 export default class SearchBuilderR18<
   T extends SearchResultFieldNames = DefaultR18SearchResultFields,
   TOpt extends keyof NarouSearchResult = never
-> extends SearchBuilderBase<T | TOpt> {
+> extends NovelSearchBuilderBase<T | TOpt> {
   /**
    * なろう小説APIへの検索リクエストを実行する
    * @override
    * @returns {Promise<NarouSearchResults>} 検索結果
    */
-  execute(): Promise<NarouSearchResults<T | TOpt>> {
+  execute(): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>> {
     return this.api.executeNovel18(this.params);
   }
 
   r18Site(sites: R18Site | readonly R18Site[]) {
-    this.set({ nocgenre: SearchBuilderBase.array2string(sites) });
+    this.set({ nocgenre: NovelSearchBuilderBase.array2string(sites) });
     return this;
   }
 
@@ -43,7 +43,7 @@ export default class SearchBuilderR18<
    * @return {SearchBuilder} this
    */
   xid(ids: number | readonly number[]) {
-    this.set({ xid: SearchBuilderBase.array2string(ids) });
+    this.set({ xid: NovelSearchBuilderBase.array2string(ids) });
     return this;
   }
 
@@ -54,15 +54,15 @@ export default class SearchBuilderR18<
   fields<TFields extends R18Fields>(
     fields: TFields | readonly TFields[]
   ): SearchBuilderR18<SearchResultR18Fields<R18Fields>> {
-    this.set({ of: SearchBuilderBase.array2string(fields) });
+    this.set({ of: NovelSearchBuilderBase.array2string(fields) });
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return this as any;
   }
 
   opt<TFields extends OptionalFields>(
     option: TFields | readonly TFields[]
-  ): SearchBuilderR18<T, SerachResultOptionalFields<TFields>> {
-    this.set({ opt: SearchBuilderBase.array2string(option) });
+  ): SearchBuilderR18<T, SearchResultOptionalFields<TFields>> {
+    this.set({ opt: NovelSearchBuilderBase.array2string(option) });
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return this as any;
   }