narou 1.2.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +73 -37
- package/dist/index.browser.cjs +90 -1360
- package/dist/index.browser.cjs.map +1 -1
- package/dist/index.browser.d.cts +14 -20
- package/dist/index.browser.d.mts +49 -0
- package/dist/index.browser.mjs +68 -0
- package/dist/index.browser.mjs.map +1 -0
- package/dist/index.cjs +147 -1410
- package/dist/index.cjs.map +1 -1
- package/dist/index.common-8lS2K_1Y.mjs +1166 -0
- package/dist/index.common-8lS2K_1Y.mjs.map +1 -0
- package/dist/index.common-CYj0n0aU.cjs +1346 -0
- package/dist/index.common-CYj0n0aU.cjs.map +1 -0
- package/dist/index.d.cts +28 -21
- package/dist/index.d.mts +63 -0
- package/dist/index.mjs +128 -0
- package/dist/index.mjs.map +1 -0
- package/dist/user-search-BY6FdEe7.d.cts +1394 -0
- package/dist/user-search-Besgk-Hx.d.mts +1394 -0
- package/package.json +28 -37
- package/pnpm-lock.yaml +1325 -1100
- package/src/index.browser.ts +5 -1
- package/src/index.ts +5 -1
- package/src/narou-fetch.ts +4 -3
- package/src/narou-jsonp.ts +4 -2
- package/src/narou.ts +50 -13
- package/src/params.ts +1 -1
- package/src/ranking.ts +20 -11
- package/src/search-builder-r18.ts +6 -2
- package/src/search-builder.ts +7 -3
- package/src/user-search.ts +9 -2
- package/dist/chunk-3A5MHPWL.js +0 -37
- package/dist/chunk-3A5MHPWL.js.map +0 -1
- package/dist/chunk-4ZP5YNWI.js +0 -1
- package/dist/chunk-4ZP5YNWI.js.map +0 -1
- package/dist/chunk-5UDKQCPJ.js +0 -407
- package/dist/chunk-5UDKQCPJ.js.map +0 -1
- package/dist/chunk-6BZWV4ZC.js +0 -75
- package/dist/chunk-6BZWV4ZC.js.map +0 -1
- package/dist/chunk-BQLSW236.js +0 -117
- package/dist/chunk-BQLSW236.js.map +0 -1
- package/dist/chunk-DEQICAN3.js +0 -94
- package/dist/chunk-DEQICAN3.js.map +0 -1
- package/dist/chunk-E2H3AJSQ.js +0 -57
- package/dist/chunk-E2H3AJSQ.js.map +0 -1
- package/dist/chunk-HOBLKBZ6.js +0 -452
- package/dist/chunk-HOBLKBZ6.js.map +0 -1
- package/dist/chunk-IPDEGCWU.js +0 -39
- package/dist/chunk-IPDEGCWU.js.map +0 -1
- package/dist/chunk-LQLNWSWV.js +0 -26
- package/dist/chunk-LQLNWSWV.js.map +0 -1
- package/dist/chunk-PLEM2AOH.js +0 -44
- package/dist/chunk-PLEM2AOH.js.map +0 -1
- package/dist/chunk-RNHRR56W.js +0 -25
- package/dist/chunk-RNHRR56W.js.map +0 -1
- package/dist/chunk-VUZIISP2.js +0 -23
- package/dist/chunk-VUZIISP2.js.map +0 -1
- package/dist/chunk-VZVUANDN.js +0 -17
- package/dist/chunk-VZVUANDN.js.map +0 -1
- package/dist/index.browser.d.ts +0 -55
- package/dist/index.browser.js +0 -126
- package/dist/index.browser.js.map +0 -1
- package/dist/index.common.cjs +0 -1187
- package/dist/index.common.cjs.map +0 -1
- package/dist/index.common.d.cts +0 -6
- package/dist/index.common.d.ts +0 -6
- package/dist/index.common.js +0 -76
- package/dist/index.common.js.map +0 -1
- package/dist/index.d.ts +0 -56
- package/dist/index.js +0 -131
- package/dist/index.js.map +0 -1
- package/dist/narou-DBa12V_l.d.ts +0 -404
- package/dist/narou-DCp4aGfA.d.cts +0 -404
- package/dist/narou-fetch.cjs +0 -164
- package/dist/narou-fetch.cjs.map +0 -1
- package/dist/narou-fetch.d.cts +0 -20
- package/dist/narou-fetch.d.ts +0 -20
- package/dist/narou-fetch.js +0 -10
- package/dist/narou-fetch.js.map +0 -1
- package/dist/narou-jsonp.cjs +0 -162
- package/dist/narou-jsonp.cjs.map +0 -1
- package/dist/narou-jsonp.d.cts +0 -13
- package/dist/narou-jsonp.d.ts +0 -13
- package/dist/narou-jsonp.js +0 -10
- package/dist/narou-jsonp.js.map +0 -1
- package/dist/narou-ranking-results.cjs +0 -19
- package/dist/narou-ranking-results.cjs.map +0 -1
- package/dist/narou-ranking-results.d.cts +0 -4
- package/dist/narou-ranking-results.d.ts +0 -4
- package/dist/narou-ranking-results.js +0 -1
- package/dist/narou-ranking-results.js.map +0 -1
- package/dist/narou-search-results-C21hWrnL.d.cts +0 -727
- package/dist/narou-search-results-DT0YdaBn.d.ts +0 -727
- package/dist/narou-search-results.cjs +0 -62
- package/dist/narou-search-results.cjs.map +0 -1
- package/dist/narou-search-results.d.cts +0 -2
- package/dist/narou-search-results.d.ts +0 -2
- package/dist/narou-search-results.js +0 -11
- package/dist/narou-search-results.js.map +0 -1
- package/dist/narou.cjs +0 -112
- package/dist/narou.cjs.map +0 -1
- package/dist/narou.d.cts +0 -4
- package/dist/narou.d.ts +0 -4
- package/dist/narou.js +0 -8
- package/dist/narou.js.map +0 -1
- package/dist/params.cjs +0 -448
- package/dist/params.cjs.map +0 -1
- package/dist/params.d.cts +0 -2
- package/dist/params.d.ts +0 -2
- package/dist/params.js +0 -41
- package/dist/params.js.map +0 -1
- package/dist/ranking-history.cjs +0 -47
- package/dist/ranking-history.cjs.map +0 -1
- package/dist/ranking-history.d.cts +0 -28
- package/dist/ranking-history.d.ts +0 -28
- package/dist/ranking-history.js +0 -8
- package/dist/ranking-history.js.map +0 -1
- package/dist/ranking.cjs +0 -783
- package/dist/ranking.cjs.map +0 -1
- package/dist/ranking.d.cts +0 -108
- package/dist/ranking.d.ts +0 -108
- package/dist/ranking.js +0 -10
- package/dist/ranking.js.map +0 -1
- package/dist/search-builder-r18.cjs +0 -547
- package/dist/search-builder-r18.cjs.map +0 -1
- package/dist/search-builder-r18.d.cts +0 -45
- package/dist/search-builder-r18.d.ts +0 -45
- package/dist/search-builder-r18.js +0 -9
- package/dist/search-builder-r18.js.map +0 -1
- package/dist/search-builder.cjs +0 -591
- package/dist/search-builder.cjs.map +0 -1
- package/dist/search-builder.d.cts +0 -4
- package/dist/search-builder.d.ts +0 -4
- package/dist/search-builder.js +0 -12
- package/dist/search-builder.js.map +0 -1
- package/dist/user-search.cjs +0 -325
- package/dist/user-search.cjs.map +0 -1
- package/dist/user-search.d.cts +0 -66
- package/dist/user-search.d.ts +0 -66
- package/dist/user-search.js +0 -9
- package/dist/user-search.js.map +0 -1
- package/dist/util/date.cjs +0 -51
- package/dist/util/date.cjs.map +0 -1
- package/dist/util/date.d.cts +0 -21
- package/dist/util/date.d.ts +0 -21
- package/dist/util/date.js +0 -11
- package/dist/util/date.js.map +0 -1
- package/dist/util/jsonp.cjs +0 -63
- package/dist/util/jsonp.cjs.map +0 -1
- package/dist/util/jsonp.d.cts +0 -49
- package/dist/util/jsonp.d.ts +0 -49
- package/dist/util/jsonp.js +0 -7
- package/dist/util/jsonp.js.map +0 -1
- package/dist/util/type.cjs +0 -19
- package/dist/util/type.cjs.map +0 -1
- package/dist/util/type.d.cts +0 -27
- package/dist/util/type.d.ts +0 -27
- package/dist/util/type.js +0 -1
- package/dist/util/type.js.map +0 -1
- package/dist/util/unzipp.cjs +0 -47
- package/dist/util/unzipp.cjs.map +0 -1
- package/dist/util/unzipp.d.cts +0 -12
- package/dist/util/unzipp.d.ts +0 -12
- package/dist/util/unzipp.js +0 -7
- package/dist/util/unzipp.js.map +0 -1
|
@@ -0,0 +1,1394 @@
|
|
|
1
|
+
//#region src/util/type.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* 文字列に変換可能な型を表します。
|
|
4
|
+
*
|
|
5
|
+
* このタイプには以下が含まれます:
|
|
6
|
+
* - `string`: 文字列プリミティブ
|
|
7
|
+
* - `number`: 数値
|
|
8
|
+
* - `bigint`: 任意精度の整数
|
|
9
|
+
* - `boolean`: 真/偽の値
|
|
10
|
+
* - `null`: null値
|
|
11
|
+
* - `undefined`: undefined値
|
|
12
|
+
*
|
|
13
|
+
* これらの型はすべて、文字列連結や文字列変換可能な値を期待する関数で安全に使用できます。
|
|
14
|
+
*/
|
|
15
|
+
type Stringable = string | number | bigint | boolean | null | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* ハイフンで結合された2つの文字列変換可能な値、または単一の値を表すユーティリティタイプ。
|
|
18
|
+
*
|
|
19
|
+
* @template T - 文字列に変換可能な型
|
|
20
|
+
* @returns `${T}-${T}` (ハイフンで結合された2つの値) または `${T}` (単一の値)
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* type Numbers = 1 | 2 | 3;
|
|
24
|
+
* type JoinedNumbers = Join<Numbers>; // '1' | '2' | '3' | '1-1' | '1-2' | '1-3' | '2-1' | '2-2' | '2-3' | '3-1' | '3-2' | '3-3'
|
|
25
|
+
*/
|
|
26
|
+
type Join<T extends Stringable> = `${T}-${T}` | `${T}`;
|
|
27
|
+
//#endregion
|
|
28
|
+
//#region src/params.d.ts
|
|
29
|
+
declare const RankingType: {
|
|
30
|
+
readonly Daily: "d";
|
|
31
|
+
readonly Weekly: "w";
|
|
32
|
+
readonly Monthly: "m";
|
|
33
|
+
readonly Quarterly: "q";
|
|
34
|
+
};
|
|
35
|
+
type RankingType = (typeof RankingType)[keyof typeof RankingType];
|
|
36
|
+
/**
|
|
37
|
+
* すべてのAPIで共通のクエリパラメータ
|
|
38
|
+
*/
|
|
39
|
+
interface ParamsBase {
|
|
40
|
+
/**
|
|
41
|
+
* gzip圧縮してgzipファイルとして返します。
|
|
42
|
+
* gzip圧縮レベルを1~5で指定できます。
|
|
43
|
+
* 転送量上限を減らすためにも推奨
|
|
44
|
+
*/
|
|
45
|
+
gzip?: GzipLevel;
|
|
46
|
+
/**
|
|
47
|
+
* 出力形式を指定
|
|
48
|
+
* 本ライブラリはJSONとJSONPのみ対応
|
|
49
|
+
*/
|
|
50
|
+
out?: "json" | "jsonp";
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* 検索APIで共通のクエリパラメータ
|
|
54
|
+
*/
|
|
55
|
+
interface ParamsBaseWithOrder<TOrder extends string> extends ParamsBase {
|
|
56
|
+
/**
|
|
57
|
+
* 出力する項目を個別に指定できます。未指定時は全項目出力されます。
|
|
58
|
+
* 転送量軽減のため、このパラメータの使用が推奨されます。
|
|
59
|
+
*/
|
|
60
|
+
of?: string;
|
|
61
|
+
/**
|
|
62
|
+
* 最大出力数を指定できます。指定しない場合は20件になります。
|
|
63
|
+
*/
|
|
64
|
+
lim?: number;
|
|
65
|
+
/** 表示開始位置の指定です。 */
|
|
66
|
+
st?: number;
|
|
67
|
+
/** 出力順序を指定できます。 */
|
|
68
|
+
order?: TOrder;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* メソッドにパラメータを指定する際のヘルパー。
|
|
72
|
+
* @see https://dev.syosetu.com/man/api/
|
|
73
|
+
* @see https://dev.syosetu.com/xman/atom/
|
|
74
|
+
*/
|
|
75
|
+
interface SearchParams extends ParamsBaseWithOrder<Order> {
|
|
76
|
+
word?: string;
|
|
77
|
+
notword?: string;
|
|
78
|
+
title?: BooleanNumber;
|
|
79
|
+
ex?: BooleanNumber;
|
|
80
|
+
keyword?: BooleanNumber;
|
|
81
|
+
wname?: BooleanNumber;
|
|
82
|
+
biggenre?: Join<BigGenre> | BigGenre;
|
|
83
|
+
notbiggenre?: Join<BigGenre> | BigGenre;
|
|
84
|
+
genre?: Join<Genre> | Genre;
|
|
85
|
+
notgenre?: Join<Genre> | Genre;
|
|
86
|
+
userid?: Join<number> | number;
|
|
87
|
+
nocgenre?: Join<R18Site> | R18Site;
|
|
88
|
+
notnocgenre?: Join<R18Site> | R18Site;
|
|
89
|
+
xid?: Join<number> | number;
|
|
90
|
+
isr15?: BooleanNumber;
|
|
91
|
+
isbl?: BooleanNumber;
|
|
92
|
+
isgl?: BooleanNumber;
|
|
93
|
+
iszankoku?: BooleanNumber;
|
|
94
|
+
istensei?: BooleanNumber;
|
|
95
|
+
istenni?: BooleanNumber;
|
|
96
|
+
istt?: BooleanNumber;
|
|
97
|
+
notr15?: BooleanNumber;
|
|
98
|
+
notbl?: BooleanNumber;
|
|
99
|
+
notgl?: BooleanNumber;
|
|
100
|
+
notzankoku?: BooleanNumber;
|
|
101
|
+
nottensei?: BooleanNumber;
|
|
102
|
+
nottenni?: BooleanNumber;
|
|
103
|
+
minlen?: number;
|
|
104
|
+
maxlen?: number;
|
|
105
|
+
length?: number | Join<number | "">;
|
|
106
|
+
kaiwaritu?: number | string;
|
|
107
|
+
sasie?: number | string;
|
|
108
|
+
mintime?: number;
|
|
109
|
+
maxtime?: number;
|
|
110
|
+
time?: number | string;
|
|
111
|
+
ncode?: string | Join<string>;
|
|
112
|
+
type?: NovelTypeParam;
|
|
113
|
+
buntai?: BuntaiParam | Join<BuntaiParam>;
|
|
114
|
+
stop?: StopParam;
|
|
115
|
+
ispickup?: typeof BooleanNumber.True;
|
|
116
|
+
lastup?: string;
|
|
117
|
+
lastupdate?: string;
|
|
118
|
+
opt?: Join<OptionalFields>;
|
|
119
|
+
}
|
|
120
|
+
interface RankingParams extends ParamsBase {
|
|
121
|
+
rtype: `${string}-${RankingType}`;
|
|
122
|
+
}
|
|
123
|
+
interface RankingHistoryParams extends ParamsBase {
|
|
124
|
+
ncode: string;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* ユーザー検索パラメータ
|
|
128
|
+
*/
|
|
129
|
+
interface UserSearchParams extends ParamsBaseWithOrder<UserOrder> {
|
|
130
|
+
/** 単語を指定できます。半角または全角スペースで区切るとAND抽出になります。部分一致でHITします。検索の対象はユーザ名とユーザ名のフリガナです。 */
|
|
131
|
+
word?: string;
|
|
132
|
+
/** 含みたくない単語を指定できます。スペースで区切ることにより含ませない単語を増やせます。部分一致で除外されます。除外の対象はユーザ名とユーザ名のフリガナです。 */
|
|
133
|
+
notword?: string;
|
|
134
|
+
/** ユーザIDで抽出可能。 */
|
|
135
|
+
userid?: number;
|
|
136
|
+
/** 抽出するユーザのユーザ名のフリガナの頭文字を指定できます。頭文字はユーザ名のフリガナをひらがなに変換し、最初の1文字が「ぁ」~「ん」の場合に対象となります。 */
|
|
137
|
+
name1st?: string;
|
|
138
|
+
/** 抽出するユーザの小説投稿数の下限を指定できます。小説投稿件数が指定された数値以上のユーザを抽出します。 */
|
|
139
|
+
minnovel?: number;
|
|
140
|
+
/** 抽出するユーザの小説投稿数の上限を指定できます。小説投稿件数が指定された数値以下のユーザを抽出します。 */
|
|
141
|
+
maxnovel?: number;
|
|
142
|
+
/** 抽出するユーザのレビュー投稿数の下限を指定できます。レビュー投稿件数が指定された数値以上のユーザを抽出します。 */
|
|
143
|
+
minreview?: number;
|
|
144
|
+
/** 抽出するユーザのレビュー投稿数の上限を指定できます。レビュー投稿件数が指定された数値以下のユーザを抽出します。 */
|
|
145
|
+
maxreview?: number;
|
|
146
|
+
}
|
|
147
|
+
declare const BooleanNumber: {
|
|
148
|
+
readonly True: 1;
|
|
149
|
+
readonly False: 0;
|
|
150
|
+
};
|
|
151
|
+
type BooleanNumber = (typeof BooleanNumber)[keyof typeof BooleanNumber];
|
|
152
|
+
type SearchResultFieldNames = keyof NarouSearchResult;
|
|
153
|
+
/**
|
|
154
|
+
* なろう小説APIのofパラメータに指定できる出力する項目
|
|
155
|
+
* @see https://dev.syosetu.com/man/api/#output
|
|
156
|
+
*/
|
|
157
|
+
declare const Fields: {
|
|
158
|
+
/** 小説名 */
|
|
159
|
+
readonly title: "t";
|
|
160
|
+
/** Nコード */
|
|
161
|
+
readonly ncode: "n";
|
|
162
|
+
/** 作者のユーザID(数値) */
|
|
163
|
+
readonly userid: "u";
|
|
164
|
+
/** 作者名 */
|
|
165
|
+
readonly writer: "w";
|
|
166
|
+
/** 小説のあらすじ */
|
|
167
|
+
readonly story: "s";
|
|
168
|
+
/** 大ジャンル */
|
|
169
|
+
readonly biggenre: "bg";
|
|
170
|
+
/** ジャンル */
|
|
171
|
+
readonly genre: "g";
|
|
172
|
+
/** キーワード */
|
|
173
|
+
readonly keyword: "k";
|
|
174
|
+
/** 初回掲載日 */
|
|
175
|
+
readonly general_firstup: "gf";
|
|
176
|
+
/** 最終掲載日 */
|
|
177
|
+
readonly general_lastup: "gl";
|
|
178
|
+
/** 連載の場合は1、短編の場合は2 */
|
|
179
|
+
readonly noveltype: "nt";
|
|
180
|
+
/** 短編小説と完結済小説は0となっています。連載中は1です。 */
|
|
181
|
+
readonly end: "e";
|
|
182
|
+
/** 全掲載部分数 */
|
|
183
|
+
readonly general_all_no: "ga";
|
|
184
|
+
/** 小説文字数 */
|
|
185
|
+
readonly length: "l";
|
|
186
|
+
/** 読了時間(分単位) */
|
|
187
|
+
readonly time: "ti";
|
|
188
|
+
/** 長期連載停止中 */
|
|
189
|
+
readonly isstop: "i";
|
|
190
|
+
/** 登録必須キーワードに「R15」が含まれる場合は1、それ以外は0です。 */
|
|
191
|
+
readonly isr15: "isr";
|
|
192
|
+
/** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
|
|
193
|
+
readonly isbl: "ibl";
|
|
194
|
+
/** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
|
|
195
|
+
readonly isgl: "igl";
|
|
196
|
+
/** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
|
|
197
|
+
readonly iszankoku: "izk";
|
|
198
|
+
/** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
|
|
199
|
+
readonly istensei: "its";
|
|
200
|
+
/** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
|
|
201
|
+
readonly istenni: "iti";
|
|
202
|
+
/** 総合評価ポイント */
|
|
203
|
+
readonly global_point: "gp";
|
|
204
|
+
/** 日間ポイント */
|
|
205
|
+
readonly daily_point: "dp";
|
|
206
|
+
/** 週間ポイント */
|
|
207
|
+
readonly weekly_point: "wp";
|
|
208
|
+
/** 月間ポイント */
|
|
209
|
+
readonly monthly_point: "mp";
|
|
210
|
+
/** 四半期ポイント */
|
|
211
|
+
readonly quarter_point: "qp";
|
|
212
|
+
/** 年間ポイント */
|
|
213
|
+
readonly yearly_point: "yp";
|
|
214
|
+
/** ブックマーク数 */
|
|
215
|
+
readonly fav_novel_cnt: "f";
|
|
216
|
+
/** 感想数 */
|
|
217
|
+
readonly impression_cnt: "imp";
|
|
218
|
+
/** レビュー数 */
|
|
219
|
+
readonly review_cnt: "r";
|
|
220
|
+
/** 評価ポイント */
|
|
221
|
+
readonly all_point: "a";
|
|
222
|
+
/** 評価者数 */
|
|
223
|
+
readonly all_hyoka_cnt: "ah";
|
|
224
|
+
/** 挿絵の数 */
|
|
225
|
+
readonly sasie_cnt: "sa";
|
|
226
|
+
/** 会話率 */
|
|
227
|
+
readonly kaiwaritu: "ka";
|
|
228
|
+
/** 小説の更新日時 */
|
|
229
|
+
readonly novelupdated_at: "nu";
|
|
230
|
+
/**
|
|
231
|
+
* 最終更新日時
|
|
232
|
+
* システム用で小説更新時とは関係ありません
|
|
233
|
+
*/
|
|
234
|
+
readonly updated_at: "ua";
|
|
235
|
+
};
|
|
236
|
+
type Fields = (typeof Fields)[keyof Omit<NarouSearchResult, "novel_type" | "weekly_unique" | "nocgenre">];
|
|
237
|
+
/**
|
|
238
|
+
* なろうR18小説APIのofパラメータに指定できる出力する項目
|
|
239
|
+
* @see https://dev.syosetu.com/xman/api/#output
|
|
240
|
+
*/
|
|
241
|
+
declare const R18Fields: {
|
|
242
|
+
/** 小説名 */
|
|
243
|
+
readonly title: "t";
|
|
244
|
+
/** Nコード */
|
|
245
|
+
readonly ncode: "n";
|
|
246
|
+
/** 作者のユーザID(数値) */
|
|
247
|
+
readonly userid: "u";
|
|
248
|
+
/** 作者名 */
|
|
249
|
+
readonly writer: "w";
|
|
250
|
+
/** 小説のあらすじ */
|
|
251
|
+
readonly story: "s";
|
|
252
|
+
/** 掲載サイト */
|
|
253
|
+
readonly nocgenre: "ng";
|
|
254
|
+
/** キーワード */
|
|
255
|
+
readonly keyword: "k";
|
|
256
|
+
/** 初回掲載日 */
|
|
257
|
+
readonly general_firstup: "gf";
|
|
258
|
+
/** 最終掲載日 */
|
|
259
|
+
readonly general_lastup: "gl";
|
|
260
|
+
/** 連載の場合は1、短編の場合は2 */
|
|
261
|
+
readonly noveltype: "nt";
|
|
262
|
+
/** 短編小説と完結済小説は0となっています。連載中は1です。 */
|
|
263
|
+
readonly end: "e";
|
|
264
|
+
/** 全掲載部分数 */
|
|
265
|
+
readonly general_all_no: "ga";
|
|
266
|
+
/** 小説文字数 */
|
|
267
|
+
readonly length: "l";
|
|
268
|
+
/** 読了時間(分単位) */
|
|
269
|
+
readonly time: "ti";
|
|
270
|
+
/** 長期連載停止中 */
|
|
271
|
+
readonly isstop: "i";
|
|
272
|
+
/** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
|
|
273
|
+
readonly isbl: "ibl";
|
|
274
|
+
/** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
|
|
275
|
+
readonly isgl: "igl";
|
|
276
|
+
/** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
|
|
277
|
+
readonly iszankoku: "izk";
|
|
278
|
+
/** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
|
|
279
|
+
readonly istensei: "its";
|
|
280
|
+
/** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
|
|
281
|
+
readonly istenni: "iti";
|
|
282
|
+
/** 総合評価ポイント */
|
|
283
|
+
readonly global_point: "gp";
|
|
284
|
+
/** 日間ポイント */
|
|
285
|
+
readonly daily_point: "dp";
|
|
286
|
+
/** 週間ポイント */
|
|
287
|
+
readonly weekly_point: "wp";
|
|
288
|
+
/** 月間ポイント */
|
|
289
|
+
readonly monthly_point: "mp";
|
|
290
|
+
/** 四半期ポイント */
|
|
291
|
+
readonly quarter_point: "qp";
|
|
292
|
+
/** 年間ポイント */
|
|
293
|
+
readonly yearly_point: "yp";
|
|
294
|
+
/** R18ブックマーク数 */
|
|
295
|
+
readonly fav_novel_cnt: "f";
|
|
296
|
+
/** 感想数 */
|
|
297
|
+
readonly impression_cnt: "imp";
|
|
298
|
+
/** レビュー数 */
|
|
299
|
+
readonly review_cnt: "r";
|
|
300
|
+
/** 評価ポイント */
|
|
301
|
+
readonly all_point: "a";
|
|
302
|
+
/** 評価者数 */
|
|
303
|
+
readonly all_hyoka_cnt: "ah";
|
|
304
|
+
/** 挿絵の数 */
|
|
305
|
+
readonly sasie_cnt: "sa";
|
|
306
|
+
/** 会話率 */
|
|
307
|
+
readonly kaiwaritu: "ka";
|
|
308
|
+
/** 小説の更新日時 */
|
|
309
|
+
readonly novelupdated_at: "nu";
|
|
310
|
+
/**
|
|
311
|
+
* 最終更新日時
|
|
312
|
+
* システム用で小説更新時とは関係ありません
|
|
313
|
+
*/
|
|
314
|
+
readonly updated_at: "ua";
|
|
315
|
+
};
|
|
316
|
+
type R18Fields = (typeof R18Fields)[keyof Omit<NarouSearchResult, "novel_type" | "weekly_unique" | "biggenre" | "genre" | "isr15">];
|
|
317
|
+
/**
|
|
318
|
+
* オプション項目
|
|
319
|
+
*/
|
|
320
|
+
declare const OptionalFields: {
|
|
321
|
+
/**
|
|
322
|
+
* 週間ユニークユーザ[項目名:weekly_unique]が追加されます。
|
|
323
|
+
* 週間ユニークユーザは前週の日曜日から土曜日分のユニークの合計です。
|
|
324
|
+
* 毎週火曜日早朝に更新されます。
|
|
325
|
+
*/
|
|
326
|
+
readonly weekly_unique: "weekly";
|
|
327
|
+
};
|
|
328
|
+
type OptionalFields = (typeof OptionalFields)[keyof Pick<NarouSearchResult, "weekly_unique">];
|
|
329
|
+
/**
|
|
330
|
+
* ユーザ検索APIのofパラメータに指定できる出力する項目
|
|
331
|
+
* @see https://dev.syosetu.com/man/userapi/#output
|
|
332
|
+
*/
|
|
333
|
+
declare const UserFields: {
|
|
334
|
+
/** ユーザID */
|
|
335
|
+
readonly userid: "u";
|
|
336
|
+
/** ユーザ名 */
|
|
337
|
+
readonly name: "n";
|
|
338
|
+
/** ユーザ名のフリガナ */
|
|
339
|
+
readonly yomikata: "y";
|
|
340
|
+
/** ユーザ名のフリガナの頭文字 */
|
|
341
|
+
readonly name1st: "1";
|
|
342
|
+
/** 小説投稿数 */
|
|
343
|
+
readonly novel_cnt: "nc";
|
|
344
|
+
/** レビュー投稿数 */
|
|
345
|
+
readonly review_cnt: "rc";
|
|
346
|
+
/** 小説累計文字数 */
|
|
347
|
+
readonly novel_length: "nl";
|
|
348
|
+
/** 総合評価ポイントの合計 */
|
|
349
|
+
readonly sum_global_point: "sg";
|
|
350
|
+
};
|
|
351
|
+
type UserFields = (typeof UserFields)[keyof UserSearchResult];
|
|
352
|
+
/**
|
|
353
|
+
* 出力順序
|
|
354
|
+
*/
|
|
355
|
+
declare const Order: {
|
|
356
|
+
/** ブックマーク数の多い順 */
|
|
357
|
+
readonly FavoriteNovelCount: "favnovelcnt";
|
|
358
|
+
/** レビュー数の多い順 */
|
|
359
|
+
readonly ReviewCount: "reviewcnt";
|
|
360
|
+
/** 総合ポイントの高い順 */
|
|
361
|
+
readonly HyokaDesc: "hyoka";
|
|
362
|
+
/** 総合ポイントの低い順 */
|
|
363
|
+
readonly HyokaAsc: "hyokaasc";
|
|
364
|
+
/** 感想の多い順 */
|
|
365
|
+
readonly ImpressionCount: "impressioncnt";
|
|
366
|
+
/** 評価者数の多い順 */
|
|
367
|
+
readonly HyokaCountDesc: "hyokacnt";
|
|
368
|
+
/** 評価者数の少ない順 */
|
|
369
|
+
readonly HyokaCountAsc: "hyokacntasc";
|
|
370
|
+
/** 週間ユニークユーザの多い順 */
|
|
371
|
+
readonly Weekly: "weekly";
|
|
372
|
+
/** 小説本文の文字数が多い順 */
|
|
373
|
+
readonly LengthDesc: "lengthdesc";
|
|
374
|
+
/** 小説本文の文字数が少ない順 */
|
|
375
|
+
readonly LengthAsc: "lengthasc";
|
|
376
|
+
/** Nコードが新しい順 */
|
|
377
|
+
readonly NCodeDesc: "ncodedesc";
|
|
378
|
+
/** 新着更新順 */
|
|
379
|
+
readonly New: "new";
|
|
380
|
+
/** 古い順 */
|
|
381
|
+
readonly Old: "old";
|
|
382
|
+
/** 日間ポイントの高い順 */
|
|
383
|
+
readonly DailyPoint: "dailypoint";
|
|
384
|
+
/** 週間ポイントの高い順 */
|
|
385
|
+
readonly WeeklyPoint: "weeklypoint";
|
|
386
|
+
/** 月間ポイントの高い順 */
|
|
387
|
+
readonly MonthlyPoint: "monthlypoint";
|
|
388
|
+
/** 四半期ポイントの高い順 */
|
|
389
|
+
readonly QuarterPoint: "quarterpoint";
|
|
390
|
+
/** 年間ポイントの高い順 */
|
|
391
|
+
readonly YearlyPoint: "yearlypoint";
|
|
392
|
+
/** 初回掲載順 */
|
|
393
|
+
readonly GeneralFirstUp: "generalfirstup";
|
|
394
|
+
};
|
|
395
|
+
type Order = (typeof Order)[keyof typeof Order];
|
|
396
|
+
/** R18掲載サイト */
|
|
397
|
+
declare const R18Site: {
|
|
398
|
+
/** ノクターンノベルズ(男性向け) */
|
|
399
|
+
readonly Nocturne: 1;
|
|
400
|
+
/** ムーンライトノベルズ(女性向け) */
|
|
401
|
+
readonly MoonLight: 2;
|
|
402
|
+
/** ムーンライトノベルズ(BL) */
|
|
403
|
+
readonly MoonLightBL: 3;
|
|
404
|
+
/** ミッドナイトノベルズ(大人向け) */
|
|
405
|
+
readonly Midnight: 4;
|
|
406
|
+
};
|
|
407
|
+
type R18Site = (typeof R18Site)[keyof typeof R18Site];
|
|
408
|
+
/** R18掲載サイト表記ヘルパー */
|
|
409
|
+
declare const R18SiteNotation: { readonly [K in R18Site]: string };
|
|
410
|
+
/** 大ジャンル */
|
|
411
|
+
declare const BigGenre: {
|
|
412
|
+
/** 恋愛 */
|
|
413
|
+
readonly Renai: 1;
|
|
414
|
+
/** ファンタジー */
|
|
415
|
+
readonly Fantasy: 2;
|
|
416
|
+
/** 文芸 */
|
|
417
|
+
readonly Bungei: 3;
|
|
418
|
+
/** SF */
|
|
419
|
+
readonly Sf: 4;
|
|
420
|
+
/** その他 */
|
|
421
|
+
readonly Sonota: 99;
|
|
422
|
+
/** ノンジャンル */
|
|
423
|
+
readonly NonGenre: 98;
|
|
424
|
+
};
|
|
425
|
+
type BigGenre = (typeof BigGenre)[keyof typeof BigGenre];
|
|
426
|
+
/** 大ジャンル表記ヘルパー */
|
|
427
|
+
declare const BigGenreNotation: { readonly [K in BigGenre]: string };
|
|
428
|
+
/** ジャンル */
|
|
429
|
+
declare const Genre: {
|
|
430
|
+
/** 異世界〔恋愛〕*/
|
|
431
|
+
readonly RenaiIsekai: 101;
|
|
432
|
+
/** 現実世界〔恋愛〕*/
|
|
433
|
+
readonly RenaiGenjitsusekai: 102;
|
|
434
|
+
/** ハイファンタジー〔ファンタジー〕*/
|
|
435
|
+
readonly FantasyHigh: 201;
|
|
436
|
+
/** ローファンタジー〔ファンタジー〕*/
|
|
437
|
+
readonly FantasyLow: 202;
|
|
438
|
+
/** 純文学〔文芸〕*/
|
|
439
|
+
readonly BungeiJyunbungei: 301;
|
|
440
|
+
/** ヒューマンドラマ〔文芸〕*/
|
|
441
|
+
readonly BungeiHumanDrama: 302;
|
|
442
|
+
/** 歴史〔文芸〕*/
|
|
443
|
+
readonly BungeiHistory: 303;
|
|
444
|
+
/** 推理〔文芸〕*/
|
|
445
|
+
readonly BungeiSuiri: 304;
|
|
446
|
+
/** ホラー〔文芸〕*/
|
|
447
|
+
readonly BungeiHorror: 305;
|
|
448
|
+
/** アクション〔文芸〕*/
|
|
449
|
+
readonly BungeiAction: 306;
|
|
450
|
+
/** コメディー〔文芸〕*/
|
|
451
|
+
readonly BungeiComedy: 307;
|
|
452
|
+
/** VRゲーム〔SF〕*/
|
|
453
|
+
readonly SfVrgame: 401;
|
|
454
|
+
/** 宇宙〔SF〕*/
|
|
455
|
+
readonly SfSpace: 402;
|
|
456
|
+
/** 空想科学〔SF〕*/
|
|
457
|
+
readonly SfKuusoukagaku: 403;
|
|
458
|
+
/** パニック〔SF〕*/
|
|
459
|
+
readonly SfPanic: 404;
|
|
460
|
+
/** 童話〔その他〕*/
|
|
461
|
+
readonly SonotaDouwa: 9901;
|
|
462
|
+
/** 詩〔その他〕*/
|
|
463
|
+
readonly SonotaShi: 9902;
|
|
464
|
+
/** エッセイ〔その他〕*/
|
|
465
|
+
readonly SonotaEssei: 9903;
|
|
466
|
+
/** リプレイ〔その他〕*/
|
|
467
|
+
readonly SonotaReplay: 9904;
|
|
468
|
+
/** その他〔その他〕 */
|
|
469
|
+
readonly SonotaSonota: 9999;
|
|
470
|
+
/** ノンジャンル〔ノンジャンル〕*/
|
|
471
|
+
readonly NonGenre: 9801;
|
|
472
|
+
};
|
|
473
|
+
type Genre = (typeof Genre)[keyof typeof Genre];
|
|
474
|
+
/** ジャンル表記ヘルパー */
|
|
475
|
+
declare const GenreNotation: { readonly [K in Genre]: string };
|
|
476
|
+
/** 文体指定 */
|
|
477
|
+
declare const BuntaiParam: {
|
|
478
|
+
/** 字下げされておらず、連続改行が多い作品 */
|
|
479
|
+
readonly NoJisageKaigyouOoi: 1;
|
|
480
|
+
/** 字下げされていないが、改行数は平均な作品 */
|
|
481
|
+
readonly NoJisageKaigyoHutsuu: 2;
|
|
482
|
+
/** 字下げが適切だが、連続改行が多い作品 */
|
|
483
|
+
readonly JisageKaigyoOoi: 4;
|
|
484
|
+
/** 字下げが適切でかつ改行数も平均な作品 */
|
|
485
|
+
readonly JisageKaigyoHutsuu: 6;
|
|
486
|
+
};
|
|
487
|
+
type BuntaiParam = (typeof BuntaiParam)[keyof typeof BuntaiParam];
|
|
488
|
+
/** 連載停止中指定 */
|
|
489
|
+
declare const StopParam: {
|
|
490
|
+
/** 長期連載停止中を除きます */
|
|
491
|
+
readonly NoStopping: 1;
|
|
492
|
+
/** 長期連載停止中のみ取得します */
|
|
493
|
+
readonly Stopping: 2;
|
|
494
|
+
};
|
|
495
|
+
type StopParam = (typeof StopParam)[keyof typeof StopParam];
|
|
496
|
+
/** 小説タイプ指定 */
|
|
497
|
+
declare const NovelTypeParam: {
|
|
498
|
+
/** 短編 */
|
|
499
|
+
readonly Short: "t";
|
|
500
|
+
/** 連載中 */
|
|
501
|
+
readonly RensaiNow: "r";
|
|
502
|
+
/** 完結済連載小説 */
|
|
503
|
+
readonly RensaiEnd: "er";
|
|
504
|
+
/** すべての連載小説(連載中および完結済) */
|
|
505
|
+
readonly Rensai: "re";
|
|
506
|
+
/** 短編と完結済連載小説 */
|
|
507
|
+
readonly ShortAndRensai: "ter";
|
|
508
|
+
};
|
|
509
|
+
type NovelTypeParam = (typeof NovelTypeParam)[keyof typeof NovelTypeParam];
|
|
510
|
+
/** 日付指定パラメータ */
|
|
511
|
+
declare const DateParam: {
|
|
512
|
+
ThisWeek: string;
|
|
513
|
+
LastWeek: string;
|
|
514
|
+
SevenDays: string;
|
|
515
|
+
ThisMonth: string;
|
|
516
|
+
LastMonth: string;
|
|
517
|
+
};
|
|
518
|
+
type DateParam = (typeof DateParam)[keyof typeof DateParam];
|
|
519
|
+
declare const UserOrder: {
|
|
520
|
+
/** ユーザIDの新しい順 */
|
|
521
|
+
readonly New: "new";
|
|
522
|
+
/** 小説投稿数の多い順 */
|
|
523
|
+
readonly NovelCount: "novelcnt";
|
|
524
|
+
/** レビュー投稿数の多い順 */
|
|
525
|
+
readonly ReviewCount: "reviewcnt";
|
|
526
|
+
/** 小説累計文字数の多い順 */
|
|
527
|
+
readonly NovelLength: "novellength";
|
|
528
|
+
/** 総合評価ポイントの合計の多い順 */
|
|
529
|
+
readonly SumGlobalPoint: "sumglobalpoint";
|
|
530
|
+
/** ユーザIDの古い順 */
|
|
531
|
+
readonly Old: "old";
|
|
532
|
+
};
|
|
533
|
+
type UserOrder = (typeof UserOrder)[keyof typeof UserOrder];
|
|
534
|
+
type GzipLevel = 0 | 1 | 2 | 3 | 4 | 5;
|
|
535
|
+
//#endregion
|
|
536
|
+
//#region src/narou-search-results.d.ts
|
|
537
|
+
/**
|
|
538
|
+
* なろう小説API検索結果
|
|
539
|
+
*/
|
|
540
|
+
declare class NarouSearchResults<T, TKey extends keyof T> {
|
|
541
|
+
/**
|
|
542
|
+
* 検索結果数
|
|
543
|
+
*/
|
|
544
|
+
allcount: number;
|
|
545
|
+
/**
|
|
546
|
+
* 結果表示上限数
|
|
547
|
+
*/
|
|
548
|
+
limit: number;
|
|
549
|
+
/**
|
|
550
|
+
* 結果表示開始数
|
|
551
|
+
*/
|
|
552
|
+
start: number;
|
|
553
|
+
/**
|
|
554
|
+
* 結果表示の現在ページ(=start/limit)
|
|
555
|
+
*/
|
|
556
|
+
page: number;
|
|
557
|
+
/**
|
|
558
|
+
* 今回取得できた検索結果の数
|
|
559
|
+
*/
|
|
560
|
+
length: number;
|
|
561
|
+
/**
|
|
562
|
+
* 検索結果
|
|
563
|
+
*/
|
|
564
|
+
values: readonly Pick<T, TKey>[];
|
|
565
|
+
/**
|
|
566
|
+
* @constractor
|
|
567
|
+
* @private
|
|
568
|
+
*/
|
|
569
|
+
constructor([header, ...result]: [{
|
|
570
|
+
allcount: number;
|
|
571
|
+
}, ...Pick<T, TKey>[]], params: SearchParams | UserSearchParams);
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* 小説情報
|
|
575
|
+
* @see https://dev.syosetu.com/man/api/#output
|
|
576
|
+
* @see https://dev.syosetu.com/xman/api/#output
|
|
577
|
+
*/
|
|
578
|
+
interface NarouSearchResult {
|
|
579
|
+
/** 小説名 */
|
|
580
|
+
title: string;
|
|
581
|
+
/** Nコード */
|
|
582
|
+
ncode: string;
|
|
583
|
+
/** 作者のユーザID(数値) */
|
|
584
|
+
userid: number;
|
|
585
|
+
/** 作者名 */
|
|
586
|
+
writer: string;
|
|
587
|
+
/** 小説のあらすじ */
|
|
588
|
+
story: string;
|
|
589
|
+
/** 掲載サイト */
|
|
590
|
+
nocgenre: R18Site;
|
|
591
|
+
/** 大ジャンル */
|
|
592
|
+
biggenre: BigGenre;
|
|
593
|
+
/** ジャンル */
|
|
594
|
+
genre: Genre;
|
|
595
|
+
/** キーワード */
|
|
596
|
+
keyword: string;
|
|
597
|
+
/** 初回掲載日 YYYY-MM-DD HH:MM:SSの形式 */
|
|
598
|
+
general_firstup: string;
|
|
599
|
+
/** 最終掲載日 YYYY-MM-DD HH:MM:SSの形式 */
|
|
600
|
+
general_lastup: string;
|
|
601
|
+
/** 連載の場合は1、短編の場合は2 */
|
|
602
|
+
novel_type: NovelType;
|
|
603
|
+
/** 連載の場合は1、短編の場合は2 */
|
|
604
|
+
noveltype: NovelType;
|
|
605
|
+
/** 短編小説と完結済小説は0となっています。連載中は1です。 */
|
|
606
|
+
end: End;
|
|
607
|
+
/** 全掲載話数です。短編の場合は1です。 */
|
|
608
|
+
general_all_no: number;
|
|
609
|
+
/** 小説文字数です。スペースや改行は文字数としてカウントしません。 */
|
|
610
|
+
length: number;
|
|
611
|
+
/** 読了時間(分単位)です。読了時間は小説文字数÷500を切り上げした数値です。 */
|
|
612
|
+
time: number;
|
|
613
|
+
/** 長期連載中は1、それ以外は0です。 */
|
|
614
|
+
isstop: BooleanNumber;
|
|
615
|
+
/** 登録必須キーワードに「R15」が含まれる場合は1、それ以外は0です。 */
|
|
616
|
+
isr15: BooleanNumber;
|
|
617
|
+
/** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
|
|
618
|
+
isbl: BooleanNumber;
|
|
619
|
+
/** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
|
|
620
|
+
isgl: BooleanNumber;
|
|
621
|
+
/** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
|
|
622
|
+
iszankoku: BooleanNumber;
|
|
623
|
+
/** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
|
|
624
|
+
istensei: BooleanNumber;
|
|
625
|
+
/** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
|
|
626
|
+
istenni: BooleanNumber;
|
|
627
|
+
/** 総合得点(=(ブックマーク数×2)+評価点) */
|
|
628
|
+
global_point: number;
|
|
629
|
+
/**
|
|
630
|
+
* 日間ポイント
|
|
631
|
+
* ランキング集計時点から過去24時間以内で新たに登録されたブックマークや評価が対象
|
|
632
|
+
*/
|
|
633
|
+
daily_point: number;
|
|
634
|
+
/**
|
|
635
|
+
* 週間ポイント
|
|
636
|
+
* ランキング集計時点から過去7日以内で新たに登録されたブックマークや評価が対象
|
|
637
|
+
*/
|
|
638
|
+
weekly_point: number;
|
|
639
|
+
/**
|
|
640
|
+
* 月間ポイント
|
|
641
|
+
* ランキング集計時点から過去30日以内で新たに登録されたブックマークや評価が対象
|
|
642
|
+
*/
|
|
643
|
+
monthly_point: number;
|
|
644
|
+
/**
|
|
645
|
+
* 四半期ポイント
|
|
646
|
+
* ランキング集計時点から過去90日以内で新たに登録されたブックマークや評価が対象
|
|
647
|
+
*/
|
|
648
|
+
quarter_point: number;
|
|
649
|
+
/**
|
|
650
|
+
* 年間ポイント
|
|
651
|
+
* ランキング集計時点から過去365日以内で新たに登録されたブックマークや評価が対象
|
|
652
|
+
*/
|
|
653
|
+
yearly_point: number;
|
|
654
|
+
/** ブックマーク数 */
|
|
655
|
+
fav_novel_cnt: number;
|
|
656
|
+
/** 感想数 */
|
|
657
|
+
impression_cnt: number;
|
|
658
|
+
/** レビュー数 */
|
|
659
|
+
review_cnt: number;
|
|
660
|
+
/** 評価ポイント */
|
|
661
|
+
all_point: number;
|
|
662
|
+
/** 評価者数 */
|
|
663
|
+
all_hyoka_cnt: number;
|
|
664
|
+
/** 挿絵の数 */
|
|
665
|
+
sasie_cnt: number;
|
|
666
|
+
/**
|
|
667
|
+
* 会話率
|
|
668
|
+
* @see https://dev.syosetu.com/man/kaiwa/
|
|
669
|
+
*/
|
|
670
|
+
kaiwaritu: number;
|
|
671
|
+
/**
|
|
672
|
+
* 小説の更新日時
|
|
673
|
+
*/
|
|
674
|
+
novelupdated_at: string;
|
|
675
|
+
/**
|
|
676
|
+
* 最終更新日時
|
|
677
|
+
* システム用で小説更新時とは関係ありません
|
|
678
|
+
*/
|
|
679
|
+
updated_at: string;
|
|
680
|
+
/** 週間ユニークユーザー数 */
|
|
681
|
+
weekly_unique: number;
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
* ユーザ情報
|
|
685
|
+
* @see https://dev.syosetu.com/man/userapi/#output
|
|
686
|
+
*/
|
|
687
|
+
interface UserSearchResult {
|
|
688
|
+
/** ユーザID */
|
|
689
|
+
userid: number;
|
|
690
|
+
/** ユーザ名 */
|
|
691
|
+
name: string;
|
|
692
|
+
/** ユーザ名のフリガナ */
|
|
693
|
+
yomikata: string;
|
|
694
|
+
/**
|
|
695
|
+
* ユーザ名のフリガナの頭文字
|
|
696
|
+
* ひらがな以外の場合はnullまたは空文字となります。
|
|
697
|
+
*/
|
|
698
|
+
name1st: string;
|
|
699
|
+
/** 小説投稿数 */
|
|
700
|
+
novel_cnt: number;
|
|
701
|
+
/** レビュー投稿数 */
|
|
702
|
+
review_cnt: number;
|
|
703
|
+
/**
|
|
704
|
+
* 小説累計文字数
|
|
705
|
+
* スペースや改行は文字数としてカウントしません。
|
|
706
|
+
*/
|
|
707
|
+
novel_length: number;
|
|
708
|
+
/**
|
|
709
|
+
* 総合評価ポイントの合計
|
|
710
|
+
* 投稿済小説でそれぞれ獲得した総合評価ポイントの合計です。
|
|
711
|
+
*/
|
|
712
|
+
sum_global_point: number;
|
|
713
|
+
}
|
|
714
|
+
/**
|
|
715
|
+
* noveltype/novel_typeの値ヘルパー
|
|
716
|
+
*/
|
|
717
|
+
declare const NovelType: {
|
|
718
|
+
/** 連載 */
|
|
719
|
+
readonly Rensai: 1;
|
|
720
|
+
/** 短編 */
|
|
721
|
+
readonly Tanpen: 2;
|
|
722
|
+
};
|
|
723
|
+
type NovelType = typeof NovelType[keyof typeof NovelType];
|
|
724
|
+
/**
|
|
725
|
+
* endの値ヘルパー
|
|
726
|
+
*/
|
|
727
|
+
declare const End: {
|
|
728
|
+
/** 短編小説と完結済小説 */
|
|
729
|
+
readonly KanketsuOrTanpen: 0;
|
|
730
|
+
/** 連載中 */
|
|
731
|
+
readonly Rensai: 1;
|
|
732
|
+
};
|
|
733
|
+
type End = typeof End[keyof typeof End];
|
|
734
|
+
type SearchResultFields<T extends Fields> = { [K in keyof typeof Fields]: typeof Fields[K] extends T ? K : never }[keyof typeof Fields];
|
|
735
|
+
type SearchResultOptionalFields<T extends OptionalFields> = { [K in keyof typeof OptionalFields]: typeof OptionalFields[K] extends T ? K : never }[keyof typeof OptionalFields];
|
|
736
|
+
type SearchResultR18Fields<T extends R18Fields> = { [K in keyof typeof R18Fields]: typeof R18Fields[K] extends T ? K : never }[keyof typeof R18Fields];
|
|
737
|
+
type UserSearchResultFields<T extends UserFields> = { [K in keyof typeof UserFields]: typeof UserFields[K] extends T ? K : never }[keyof typeof UserFields];
|
|
738
|
+
type PickedNarouSearchResult<T extends keyof NarouSearchResult> = Pick<NarouSearchResult, T>;
|
|
739
|
+
//#endregion
|
|
740
|
+
//#region src/search-builder.d.ts
|
|
741
|
+
type DefaultSearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "nocgenre" | "xid">;
|
|
742
|
+
declare abstract class SearchBuilderBase<TParams extends ParamsBaseWithOrder<TOrder>, TOrder extends string> {
|
|
743
|
+
protected params: TParams;
|
|
744
|
+
protected api: NarouNovel;
|
|
745
|
+
/**
|
|
746
|
+
* constructor
|
|
747
|
+
* @private
|
|
748
|
+
* @param params クエリパラメータ
|
|
749
|
+
* @param api NarouNovel インスタンス
|
|
750
|
+
*/
|
|
751
|
+
constructor(params: TParams | undefined, api: NarouNovel);
|
|
752
|
+
/**
|
|
753
|
+
* 配列から重複を除去する
|
|
754
|
+
* @protected
|
|
755
|
+
* @static
|
|
756
|
+
* @param array 配列
|
|
757
|
+
* @returns 重複を除去した配列
|
|
758
|
+
*/
|
|
759
|
+
protected static distinct<T>(array: readonly T[]): T[];
|
|
760
|
+
/**
|
|
761
|
+
* 配列をハイフン区切りの文字列に変換する
|
|
762
|
+
* @protected
|
|
763
|
+
* @static
|
|
764
|
+
* @param n 文字列または数値の配列、あるいは単一の文字列または数値
|
|
765
|
+
* @returns ハイフン区切りの文字列
|
|
766
|
+
*/
|
|
767
|
+
protected static array2string<T extends string | number>(n: T | readonly T[]): Join<T>;
|
|
768
|
+
/**
|
|
769
|
+
* 取得件数を指定する (lim)
|
|
770
|
+
* @param num 取得件数 (1-500)
|
|
771
|
+
* @return {this}
|
|
772
|
+
*/
|
|
773
|
+
limit(num: number): this;
|
|
774
|
+
/**
|
|
775
|
+
* 取得開始位置を指定する (st)
|
|
776
|
+
* @param num 取得開始位置 (1-)
|
|
777
|
+
* @return {this}
|
|
778
|
+
*/
|
|
779
|
+
start(num: number): this;
|
|
780
|
+
/**
|
|
781
|
+
* ページ番号と1ページあたりの件数で取得範囲を指定する
|
|
782
|
+
* @param no ページ番号 (0-)
|
|
783
|
+
* @param count 1ページあたりの件数 (デフォルト: 20)
|
|
784
|
+
* @return {this}
|
|
785
|
+
*/
|
|
786
|
+
page(no: number, count?: number): this;
|
|
787
|
+
/**
|
|
788
|
+
* 出力順序を指定する (order)
|
|
789
|
+
* 指定しない場合は新着順となります。
|
|
790
|
+
* @param {TOrder} order 出力順序
|
|
791
|
+
* @return {this}
|
|
792
|
+
*/
|
|
793
|
+
order(order: TOrder): this;
|
|
794
|
+
/**
|
|
795
|
+
* gzip圧縮レベルを指定する (gzip)
|
|
796
|
+
*
|
|
797
|
+
* 転送量上限を減らすためにも推奨
|
|
798
|
+
* @param {GzipLevel} level gzip圧縮レベル(1~5)
|
|
799
|
+
* @return {this}
|
|
800
|
+
*/
|
|
801
|
+
gzip(level: GzipLevel): this;
|
|
802
|
+
/**
|
|
803
|
+
* クエリパラメータをセットする
|
|
804
|
+
* @protected
|
|
805
|
+
* @param obj セットするパラメータ
|
|
806
|
+
* @return {this}
|
|
807
|
+
*/
|
|
808
|
+
protected set(obj: TParams): this;
|
|
809
|
+
/**
|
|
810
|
+
* クエリパラメータを削除する
|
|
811
|
+
* @protected
|
|
812
|
+
* @param key 削除するパラメータのキー
|
|
813
|
+
* @returns {this}
|
|
814
|
+
*/
|
|
815
|
+
protected unset(key: keyof TParams): this;
|
|
816
|
+
}
|
|
817
|
+
declare abstract class NovelSearchBuilderBase<T extends SearchResultFieldNames> extends SearchBuilderBase<SearchParams, Order> {
|
|
818
|
+
/**
|
|
819
|
+
* 検索語を指定します (word)。
|
|
820
|
+
* 半角または全角スペースで区切るとAND抽出になります。部分一致でHITします。
|
|
821
|
+
* @param word 検索語
|
|
822
|
+
* @return {this}
|
|
823
|
+
*/
|
|
824
|
+
word(word: string): this;
|
|
825
|
+
/**
|
|
826
|
+
* 除外したい単語を指定します (notword)。
|
|
827
|
+
* スペースで区切ることにより除外する単語を増やせます。部分一致で除外されます。
|
|
828
|
+
* @param word 除外語
|
|
829
|
+
* @return {this}
|
|
830
|
+
*/
|
|
831
|
+
notWord(word: string): this;
|
|
832
|
+
/**
|
|
833
|
+
* 検索対象を作品名に限定するかどうかを指定します (title)。
|
|
834
|
+
* @param bool trueの場合、作品名を検索対象とする (デフォルト: true)
|
|
835
|
+
* @return {this}
|
|
836
|
+
*/
|
|
837
|
+
byTitle(bool?: boolean): this;
|
|
838
|
+
/**
|
|
839
|
+
* 検索対象をあらすじに限定するかどうかを指定します (ex)。
|
|
840
|
+
* @param bool trueの場合、あらすじを検索対象とする (デフォルト: true)
|
|
841
|
+
* @return {this}
|
|
842
|
+
*/
|
|
843
|
+
byOutline(bool?: boolean): this;
|
|
844
|
+
/**
|
|
845
|
+
* 検索対象をキーワードに限定するかどうかを指定します (keyword)。
|
|
846
|
+
* @param bool trueの場合、キーワードを検索対象とする (デフォルト: true)
|
|
847
|
+
* @return {this}
|
|
848
|
+
*/
|
|
849
|
+
byKeyword(bool?: boolean): this;
|
|
850
|
+
/**
|
|
851
|
+
* 検索対象を作者名に限定するかどうかを指定します (wname)。
|
|
852
|
+
* @param bool trueの場合、作者名を検索対象とする (デフォルト: true)
|
|
853
|
+
* @return {this}
|
|
854
|
+
*/
|
|
855
|
+
byAuthor(bool?: boolean): this;
|
|
856
|
+
/**
|
|
857
|
+
* ボーイズラブ作品を抽出または除外します (isbl/notbl)。
|
|
858
|
+
* @param bool trueの場合、ボーイズラブ作品を抽出する (デフォルト: true)。falseの場合、除外する。
|
|
859
|
+
* @return {this}
|
|
860
|
+
*/
|
|
861
|
+
isBL(bool?: boolean): this;
|
|
862
|
+
/**
|
|
863
|
+
* ガールズラブ作品を抽出または除外します (isgl/notgl)。
|
|
864
|
+
* @param bool trueの場合、ガールズラブ作品を抽出する (デフォルト: true)。falseの場合、除外する。
|
|
865
|
+
* @return {this}
|
|
866
|
+
*/
|
|
867
|
+
isGL(bool?: boolean): this;
|
|
868
|
+
/**
|
|
869
|
+
* 残酷な描写あり作品を抽出または除外します (iszankoku/notzankoku)。
|
|
870
|
+
* @param bool trueの場合、残酷な描写あり作品を抽出する (デフォルト: true)。falseの場合、除外する。
|
|
871
|
+
* @return {this}
|
|
872
|
+
*/
|
|
873
|
+
isZankoku(bool?: boolean): this;
|
|
874
|
+
/**
|
|
875
|
+
* 異世界転生作品を抽出または除外します (istensei/nottensei)。
|
|
876
|
+
* @param bool trueの場合、異世界転生作品を抽出する (デフォルト: true)。falseの場合、除外する。
|
|
877
|
+
* @return {this}
|
|
878
|
+
*/
|
|
879
|
+
isTensei(bool?: boolean): this;
|
|
880
|
+
/**
|
|
881
|
+
* 異世界転移作品を抽出または除外します (istenni/nottenni)。
|
|
882
|
+
* @param bool trueの場合、異世界転移作品を抽出する (デフォルト: true)。falseの場合、除外する。
|
|
883
|
+
* @return {this}
|
|
884
|
+
*/
|
|
885
|
+
isTenni(bool?: boolean): this;
|
|
886
|
+
/**
|
|
887
|
+
* 異世界転生または異世界転移作品を抽出します (istt)。
|
|
888
|
+
* @return {this}
|
|
889
|
+
*/
|
|
890
|
+
isTT(): this;
|
|
891
|
+
/**
|
|
892
|
+
* 抽出する作品の文字数を指定します (length)。
|
|
893
|
+
* 範囲指定する場合は、最小文字数と最大文字数をハイフン(-)記号で区切ってください。
|
|
894
|
+
* @param length 文字数、または[最小文字数, 最大文字数]
|
|
895
|
+
* @return {this}
|
|
896
|
+
*/
|
|
897
|
+
length(length: number | readonly number[]): this;
|
|
898
|
+
/**
|
|
899
|
+
* 抽出する作品の会話率を%単位で指定します (kaiwaritu)。
|
|
900
|
+
* @param num 会話率(%)
|
|
901
|
+
* @return {this}
|
|
902
|
+
*/
|
|
903
|
+
kaiwaritu(num: number): this;
|
|
904
|
+
/**
|
|
905
|
+
* 抽出する作品の会話率を%単位で範囲指定します (kaiwaritu)。
|
|
906
|
+
* @param min 最低会話率(%)
|
|
907
|
+
* @param max 最高会話率(%)
|
|
908
|
+
* @return {this}
|
|
909
|
+
*/
|
|
910
|
+
kaiwaritu(min: number, max: number): this;
|
|
911
|
+
/**
|
|
912
|
+
* 抽出する作品の挿絵数を指定します (sasie)。
|
|
913
|
+
* @param num 挿絵数、または[最小挿絵数, 最大挿絵数]
|
|
914
|
+
* @return {this}
|
|
915
|
+
*/
|
|
916
|
+
sasie(num: number | readonly number[]): this;
|
|
917
|
+
/**
|
|
918
|
+
* 抽出する作品の予想読了時間を分単位で指定します (time)。
|
|
919
|
+
* @param num 読了時間(分)、または[最小読了時間, 最大読了時間]
|
|
920
|
+
* @return {this}
|
|
921
|
+
*/
|
|
922
|
+
time(num: number | readonly number[]): this;
|
|
923
|
+
/**
|
|
924
|
+
* Nコードを指定して取得します (ncode)。
|
|
925
|
+
* @param ncodes Nコード、またはNコードの配列
|
|
926
|
+
* @return {this}
|
|
927
|
+
*/
|
|
928
|
+
ncode(ncodes: string | readonly string[]): this;
|
|
929
|
+
/**
|
|
930
|
+
* 抽出する小説タイプを指定します (type)。
|
|
931
|
+
* @param type 小説タイプ (t: 短編, r: 連載中, er: 完結済連載小説, ter: 短編と完結済連載小説, re: 連載中と完結済連載小説)
|
|
932
|
+
* @return {this}
|
|
933
|
+
*/
|
|
934
|
+
type(type: NovelTypeParam): this;
|
|
935
|
+
/**
|
|
936
|
+
* 抽出する作品の文体を指定します (buntai)。
|
|
937
|
+
* 複数指定する場合はハイフン(-)で区切ってください。
|
|
938
|
+
* @param buntai 文体コード、または文体コードの配列
|
|
939
|
+
* @return {this}
|
|
940
|
+
*/
|
|
941
|
+
buntai(buntai: BuntaiParam | readonly BuntaiParam[]): this;
|
|
942
|
+
/**
|
|
943
|
+
* 連載停止中作品に関する指定をします (stop)。
|
|
944
|
+
* @param bool trueの場合、長期連載停止中のみ取得する (デフォルト: true)。falseの場合、長期連載停止中を除外する。
|
|
945
|
+
* @return {this}
|
|
946
|
+
*/
|
|
947
|
+
isStop(bool?: boolean): this;
|
|
948
|
+
/**
|
|
949
|
+
* ピックアップ作品のみを取得します (ispickup)。
|
|
950
|
+
* @return {this}
|
|
951
|
+
*/
|
|
952
|
+
isPickup(): this;
|
|
953
|
+
/**
|
|
954
|
+
* 最終更新日時を指定します (lastup)。
|
|
955
|
+
* @param date 最終更新日時 (YYYYMMDDhhmmss形式またはUNIXタイムスタンプ)
|
|
956
|
+
* @return {this}
|
|
957
|
+
*/
|
|
958
|
+
lastUpdate(date: DateParam): this;
|
|
959
|
+
/**
|
|
960
|
+
* 最終更新日時の範囲を指定します (lastup)。
|
|
961
|
+
* @param from 開始日時 (UNIXタイムスタンプ)
|
|
962
|
+
* @param to 終了日時 (UNIXタイムスタンプ)
|
|
963
|
+
* @return {this}
|
|
964
|
+
*/
|
|
965
|
+
lastUpdate(from: number, to: number): this;
|
|
966
|
+
/**
|
|
967
|
+
* 最終更新日時の範囲を指定します (lastup)。
|
|
968
|
+
* @param from 開始日時 (Dateオブジェクト)
|
|
969
|
+
* @param to 終了日時 (Dateオブジェクト)
|
|
970
|
+
* @return {this}
|
|
971
|
+
*/
|
|
972
|
+
lastUpdate(from: Date, to: Date): this;
|
|
973
|
+
/**
|
|
974
|
+
* 作品の更新日時を指定します (lastupdate)。
|
|
975
|
+
* @param date 作品の更新日時 (YYYYMMDDhhmmss形式またはUNIXタイムスタンプ)
|
|
976
|
+
* @return {this}
|
|
977
|
+
*/
|
|
978
|
+
lastNovelUpdate(date: DateParam): this;
|
|
979
|
+
/**
|
|
980
|
+
* 作品の更新日時の範囲を指定します (lastupdate)。
|
|
981
|
+
* @param from 開始日時 (UNIXタイムスタンプ)
|
|
982
|
+
* @param to 終了日時 (UNIXタイムスタンプ)
|
|
983
|
+
* @return {this}
|
|
984
|
+
*/
|
|
985
|
+
lastNovelUpdate(from: number, to: number): this;
|
|
986
|
+
/**
|
|
987
|
+
* 作品の更新日時の範囲を指定します (lastupdate)。
|
|
988
|
+
* @param from 開始日時 (Dateオブジェクト)
|
|
989
|
+
* @param to 終了日時 (Dateオブジェクト)
|
|
990
|
+
* @return {this}
|
|
991
|
+
*/
|
|
992
|
+
lastNovelUpdate(from: Date, to: Date): this;
|
|
993
|
+
/**
|
|
994
|
+
* なろう小説APIへの検索リクエストを実行する
|
|
995
|
+
* @param options 実行オプション
|
|
996
|
+
* @returns {Promise<NarouSearchResults>} 検索結果
|
|
997
|
+
*/
|
|
998
|
+
execute(options?: ExecuteOptions): Promise<NarouSearchResults<NarouSearchResult, T>>;
|
|
999
|
+
}
|
|
1000
|
+
/**
|
|
1001
|
+
* 検索ヘルパー
|
|
1002
|
+
* @class SearchBuilder
|
|
1003
|
+
*/
|
|
1004
|
+
declare class SearchBuilder<T extends keyof NarouSearchResult = DefaultSearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
|
|
1005
|
+
/**
|
|
1006
|
+
* 大ジャンルを指定して取得します (biggenre)。
|
|
1007
|
+
* 複数指定する場合はハイフン(-)で区切ってください。
|
|
1008
|
+
* @param genre 大ジャンルコード、または大ジャンルコードの配列
|
|
1009
|
+
* @return {this}
|
|
1010
|
+
*/
|
|
1011
|
+
bigGenre(genre: BigGenre | readonly BigGenre[]): this;
|
|
1012
|
+
/**
|
|
1013
|
+
* 除外したい大ジャンルを指定します (notbiggenre)。
|
|
1014
|
+
* 複数指定する場合はハイフン(-)で区切ってください。
|
|
1015
|
+
* @param genre 除外する大ジャンルコード、または大ジャンルコードの配列
|
|
1016
|
+
* @return {this}
|
|
1017
|
+
*/
|
|
1018
|
+
notBigGenre(genre: BigGenre | readonly BigGenre[]): this;
|
|
1019
|
+
/**
|
|
1020
|
+
* ジャンルを指定して取得します (genre)。
|
|
1021
|
+
* 複数指定する場合はハイフン(-)で区切ってください。
|
|
1022
|
+
* @param genre ジャンルコード、またはジャンルコードの配列
|
|
1023
|
+
* @return {this}
|
|
1024
|
+
*/
|
|
1025
|
+
genre(genre: Genre | readonly Genre[]): this;
|
|
1026
|
+
/**
|
|
1027
|
+
* 除外したいジャンルを指定します (notgenre)。
|
|
1028
|
+
* 複数指定する場合はハイフン(-)で区切ってください。
|
|
1029
|
+
* @param genre 除外するジャンルコード、またはジャンルコードの配列
|
|
1030
|
+
* @return {this}
|
|
1031
|
+
*/
|
|
1032
|
+
notGenre(genre: Genre | readonly Genre[]): this;
|
|
1033
|
+
/**
|
|
1034
|
+
* ユーザIDを指定して取得します (userid)。
|
|
1035
|
+
* 複数指定する場合はハイフン(-)で区切ってください。
|
|
1036
|
+
* @param ids ユーザID、またはユーザIDの配列
|
|
1037
|
+
* @return {this}
|
|
1038
|
+
*/
|
|
1039
|
+
userId(ids: number | readonly number[]): this;
|
|
1040
|
+
/**
|
|
1041
|
+
* R15作品を抽出または除外します (isr15/notr15)。
|
|
1042
|
+
* @param bool trueの場合、R15作品を抽出する (デフォルト: true)。falseの場合、除外する。
|
|
1043
|
+
* @return {this}
|
|
1044
|
+
*/
|
|
1045
|
+
isR15(bool?: boolean): this;
|
|
1046
|
+
/**
|
|
1047
|
+
* 出力する項目を個別に指定します (of)。
|
|
1048
|
+
* 未指定時は全項目出力されます。転送量軽減のため、このパラメータの使用が推奨されます。
|
|
1049
|
+
* 複数項目を出力する場合はハイフン(-)記号で区切ってください。
|
|
1050
|
+
* @param fields 出力するフィールド名、またはフィールド名の配列
|
|
1051
|
+
* @return {SearchBuilder<SearchResultFields<TFields>, TOpt>} 型が更新されたビルダー
|
|
1052
|
+
*/
|
|
1053
|
+
fields<TFields extends Fields>(fields: TFields | readonly TFields[]): SearchBuilder<SearchResultFields<TFields>, TOpt>;
|
|
1054
|
+
/**
|
|
1055
|
+
* 出力オプション項目を指定します (opt)。
|
|
1056
|
+
* 複数項目を出力する場合はハイフン(-)記号で区切ってください。
|
|
1057
|
+
* @param option 出力するオプションフィールド名、またはオプションフィールド名の配列
|
|
1058
|
+
* @return {SearchBuilder<T, SearchResultOptionalFields<TFields>>} 型が更新されたビルダー
|
|
1059
|
+
*/
|
|
1060
|
+
opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilder<T, SearchResultOptionalFields<TFields>>;
|
|
1061
|
+
}
|
|
1062
|
+
//#endregion
|
|
1063
|
+
//#region src/narou-ranking-results.d.ts
|
|
1064
|
+
/**
|
|
1065
|
+
* ランキングAPIの結果
|
|
1066
|
+
* @see https://dev.syosetu.com/man/rankapi/#output
|
|
1067
|
+
*/
|
|
1068
|
+
interface NarouRankingResult {
|
|
1069
|
+
/** Nコード */
|
|
1070
|
+
ncode: string;
|
|
1071
|
+
/** 順位 */
|
|
1072
|
+
rank: number;
|
|
1073
|
+
/** ポイント */
|
|
1074
|
+
pt: number;
|
|
1075
|
+
}
|
|
1076
|
+
/**
|
|
1077
|
+
* ランキングと小説情報をマージした結果
|
|
1078
|
+
*/
|
|
1079
|
+
type RankingResult<T extends SearchResultFieldNames = DefaultSearchResultFields> = Partial<PickedNarouSearchResult<T>> & NarouRankingResult;
|
|
1080
|
+
//#endregion
|
|
1081
|
+
//#region src/ranking-history.d.ts
|
|
1082
|
+
interface RankingHistoryRawResult {
|
|
1083
|
+
rtype: `${string}-${RankingType}`;
|
|
1084
|
+
pt: number;
|
|
1085
|
+
rank: number;
|
|
1086
|
+
}
|
|
1087
|
+
interface RankingHistoryResult {
|
|
1088
|
+
type: RankingType;
|
|
1089
|
+
date: Date;
|
|
1090
|
+
pt: number;
|
|
1091
|
+
rank: number;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* 生のランキング履歴エントリを構造化された形式にフォーマットします。
|
|
1095
|
+
*
|
|
1096
|
+
* @param rankin - フォーマットする生のランキング履歴データ
|
|
1097
|
+
* @returns 日付とタイプが解析されたフォーマット済みランキング履歴
|
|
1098
|
+
*
|
|
1099
|
+
* @example
|
|
1100
|
+
* const rawData = { rtype: "20230101-daily", pt: 500, rank: 10 };
|
|
1101
|
+
* const formattedData = formatRankingHistory(rawData);
|
|
1102
|
+
* // 返り値: { type: "daily", date: [Dateオブジェクト], pt: 500, rank: 10 }
|
|
1103
|
+
*/
|
|
1104
|
+
declare function formatRankingHistory(rankin: RankingHistoryRawResult): RankingHistoryResult;
|
|
1105
|
+
//#endregion
|
|
1106
|
+
//#region src/narou.d.ts
|
|
1107
|
+
/**
|
|
1108
|
+
* なろう小説APIへのリクエストパラメータ
|
|
1109
|
+
*/
|
|
1110
|
+
type NarouParams = SearchParams | RankingParams | RankingHistoryParams | UserSearchParams;
|
|
1111
|
+
/**
|
|
1112
|
+
* なろう小説APIへのリクエストオプション
|
|
1113
|
+
*/
|
|
1114
|
+
interface ExecuteOptions {
|
|
1115
|
+
/**
|
|
1116
|
+
* fetch関数のオプション
|
|
1117
|
+
*/
|
|
1118
|
+
fetchOptions?: RequestInit;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* なろう小説APIへのリクエストを実行する
|
|
1122
|
+
* @class NarouNovel
|
|
1123
|
+
* @private
|
|
1124
|
+
*/
|
|
1125
|
+
declare abstract class NarouNovel {
|
|
1126
|
+
/**
|
|
1127
|
+
* なろうAPIへのAPIリクエストを実行する
|
|
1128
|
+
* @param params クエリパラメータ
|
|
1129
|
+
* @param endpoint APIエンドポイント
|
|
1130
|
+
* @returns 実行結果
|
|
1131
|
+
*/
|
|
1132
|
+
protected abstract execute<T>(params: NarouParams, endpoint: string, options?: ExecuteOptions): Promise<T>;
|
|
1133
|
+
/**
|
|
1134
|
+
* APIへの検索リクエストを実行する
|
|
1135
|
+
* @param params クエリパラメータ
|
|
1136
|
+
* @param endpoint APIエンドポイント
|
|
1137
|
+
* @returns 検索結果
|
|
1138
|
+
*/
|
|
1139
|
+
protected executeSearch<T extends keyof NarouSearchResult>(params: SearchParams, endpoint?: string, options?: ExecuteOptions): Promise<NarouSearchResults<NarouSearchResult, T>>;
|
|
1140
|
+
/**
|
|
1141
|
+
* 小説APIへの検索リクエストを実行する
|
|
1142
|
+
* @param params クエリパラメータ
|
|
1143
|
+
* @returns 検索結果
|
|
1144
|
+
* @see https://dev.syosetu.com/man/api/
|
|
1145
|
+
*/
|
|
1146
|
+
executeNovel<T extends keyof NarouSearchResult>(params: SearchParams, options?: ExecuteOptions): Promise<NarouSearchResults<NarouSearchResult, T>>;
|
|
1147
|
+
/**
|
|
1148
|
+
* R18小説APIへの検索リクエストを実行する
|
|
1149
|
+
* @param params クエリパラメータ
|
|
1150
|
+
* @returns 検索結果
|
|
1151
|
+
* @see https://dev.syosetu.com/xman/api/
|
|
1152
|
+
*/
|
|
1153
|
+
executeNovel18<T extends keyof NarouSearchResult>(params: SearchParams, options?: ExecuteOptions): Promise<NarouSearchResults<NarouSearchResult, T>>;
|
|
1154
|
+
/**
|
|
1155
|
+
* ランキングAPIへのリクエストを実行する
|
|
1156
|
+
* @param params クエリパラメータ
|
|
1157
|
+
* @returns ランキング結果
|
|
1158
|
+
* @see https://dev.syosetu.com/man/rankapi/
|
|
1159
|
+
*/
|
|
1160
|
+
executeRanking(params: RankingParams, options?: ExecuteOptions): Promise<NarouRankingResult[]>;
|
|
1161
|
+
/**
|
|
1162
|
+
* 殿堂入りAPiへのリクエストを実行する
|
|
1163
|
+
* @param params クエリパラメータ
|
|
1164
|
+
* @param options 実行オプション
|
|
1165
|
+
* @returns ランキング履歴結果
|
|
1166
|
+
* @see https://dev.syosetu.com/man/rankinapi/
|
|
1167
|
+
*/
|
|
1168
|
+
executeRankingHistory(params: RankingHistoryParams, options?: ExecuteOptions): Promise<RankingHistoryRawResult[]>;
|
|
1169
|
+
/**
|
|
1170
|
+
* ユーザー検索APIへのリクエストを実行する
|
|
1171
|
+
* @param params クエリパラメータ
|
|
1172
|
+
* @returns 検索結果
|
|
1173
|
+
* @see https://dev.syosetu.com/man/userapi/
|
|
1174
|
+
*/
|
|
1175
|
+
executeUserSearch<T extends keyof UserSearchResult>(params: UserSearchParams, options?: ExecuteOptions): Promise<NarouSearchResults<UserSearchResult, T>>;
|
|
1176
|
+
}
|
|
1177
|
+
//#endregion
|
|
1178
|
+
//#region src/narou-jsonp.d.ts
|
|
1179
|
+
/**
|
|
1180
|
+
* なろう小説APIへのリクエストを実行する
|
|
1181
|
+
*/
|
|
1182
|
+
declare class NarouNovelJsonp extends NarouNovel {
|
|
1183
|
+
protected execute<T>(params: NarouParams, endpoint: string, _options?: ExecuteOptions): Promise<T>;
|
|
1184
|
+
}
|
|
1185
|
+
//#endregion
|
|
1186
|
+
//#region src/search-builder-r18.d.ts
|
|
1187
|
+
type DefaultR18SearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "biggenre" | "genre" | "isr15" | "id">;
|
|
1188
|
+
/**
|
|
1189
|
+
* 18禁API検索ヘルパー
|
|
1190
|
+
* @class SearchBuilderR18
|
|
1191
|
+
*/
|
|
1192
|
+
declare class SearchBuilderR18<T extends SearchResultFieldNames = DefaultR18SearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
|
|
1193
|
+
/**
|
|
1194
|
+
* なろう小説APIへの検索リクエストを実行する
|
|
1195
|
+
* @override
|
|
1196
|
+
* @param options 実行オプション
|
|
1197
|
+
* @returns {Promise<NarouSearchResults>} 検索結果
|
|
1198
|
+
*/
|
|
1199
|
+
execute(options?: ExecuteOptions): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>>;
|
|
1200
|
+
/**
|
|
1201
|
+
* 抽出するR18サイトを指定します (nocgenre)。
|
|
1202
|
+
* @param sites R18サイトコード、またはR18サイトコードの配列 (1: ノクターンノベルズ, 2: ムーンライトノベルズ(男性向け), 3: ムーンライトノベルズ(BL), 4: ミッドナイトノベルズ)
|
|
1203
|
+
* @return {this}
|
|
1204
|
+
*/
|
|
1205
|
+
r18Site(sites: R18Site | readonly R18Site[]): this;
|
|
1206
|
+
/**
|
|
1207
|
+
* X-IDを指定して取得します (xid)。
|
|
1208
|
+
* @param ids X-ID、またはX-IDの配列
|
|
1209
|
+
* @return {this}
|
|
1210
|
+
*/
|
|
1211
|
+
xid(ids: number | readonly number[]): this;
|
|
1212
|
+
/**
|
|
1213
|
+
* 出力する項目を個別に指定します (of)。
|
|
1214
|
+
* 未指定時は全項目出力されます。転送量軽減のため、このパラメータの使用が推奨されます。
|
|
1215
|
+
* @param fields 出力するR18フィールド名、またはR18フィールド名の配列
|
|
1216
|
+
* @return {SearchBuilderR18<SearchResultR18Fields<R18Fields>>} 型が更新されたビルダー
|
|
1217
|
+
*/
|
|
1218
|
+
fields<TFields extends R18Fields>(fields: TFields | readonly TFields[]): SearchBuilderR18<SearchResultR18Fields<R18Fields>>;
|
|
1219
|
+
/**
|
|
1220
|
+
* 出力オプション項目を指定します (opt)。
|
|
1221
|
+
* @param option 出力するオプションフィールド名、またはオプションフィールド名の配列
|
|
1222
|
+
* @return {SearchBuilderR18<T, SearchResultOptionalFields<TFields>>} 型が更新されたビルダー
|
|
1223
|
+
*/
|
|
1224
|
+
opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilderR18<T, SearchResultOptionalFields<TFields>>;
|
|
1225
|
+
}
|
|
1226
|
+
//#endregion
|
|
1227
|
+
//#region src/ranking.d.ts
|
|
1228
|
+
/**
|
|
1229
|
+
* なろう小説ランキングAPIのヘルパークラス。
|
|
1230
|
+
*
|
|
1231
|
+
* ランキング種別や日付を指定してランキングデータを取得します。
|
|
1232
|
+
* また、取得したランキングデータに含まれるNコードを元に、
|
|
1233
|
+
* なろう小説APIを利用して詳細な小説情報を取得することも可能です。
|
|
1234
|
+
*
|
|
1235
|
+
* @class RankingBuilder
|
|
1236
|
+
* @see https://dev.syosetu.com/man/rankapi/ なろう小説ランキングAPI仕様
|
|
1237
|
+
*/
|
|
1238
|
+
declare class RankingBuilder {
|
|
1239
|
+
protected params: Partial<RankingParams>;
|
|
1240
|
+
protected api: NarouNovel;
|
|
1241
|
+
/**
|
|
1242
|
+
* ランキング集計対象の日付
|
|
1243
|
+
* @protected
|
|
1244
|
+
*/
|
|
1245
|
+
protected date$: Date;
|
|
1246
|
+
/**
|
|
1247
|
+
* ランキング種別
|
|
1248
|
+
* @protected
|
|
1249
|
+
*/
|
|
1250
|
+
protected type$: RankingType;
|
|
1251
|
+
/**
|
|
1252
|
+
* constructor
|
|
1253
|
+
* @param params - 初期クエリパラメータ
|
|
1254
|
+
* @param api - API実行クラスのインスタンス
|
|
1255
|
+
* @private
|
|
1256
|
+
*/
|
|
1257
|
+
constructor(params: Partial<RankingParams> | undefined, api: NarouNovel);
|
|
1258
|
+
/**
|
|
1259
|
+
* ランキング集計対象の日付を指定します。
|
|
1260
|
+
*
|
|
1261
|
+
* - 日間: 任意の日付
|
|
1262
|
+
* - 週間: 火曜日の日付
|
|
1263
|
+
* - 月間・四半期: 1日の日付
|
|
1264
|
+
*
|
|
1265
|
+
* @param date 集計対象の日付
|
|
1266
|
+
* @returns {RankingBuilder} this
|
|
1267
|
+
* @see https://dev.syosetu.com/man/rankapi/
|
|
1268
|
+
*/
|
|
1269
|
+
date(date: Date): this;
|
|
1270
|
+
/**
|
|
1271
|
+
* ランキング種別を指定します。
|
|
1272
|
+
* @param type ランキング種別
|
|
1273
|
+
* @returns {RankingBuilder} this
|
|
1274
|
+
* @see https://dev.syosetu.com/man/rankapi/
|
|
1275
|
+
*/
|
|
1276
|
+
type(type: RankingType): this;
|
|
1277
|
+
/**
|
|
1278
|
+
* gzip圧縮する。
|
|
1279
|
+
*
|
|
1280
|
+
* 転送量上限を減らすためにも推奨
|
|
1281
|
+
* @param {GzipLevel} level gzip圧縮レベル(1~5)
|
|
1282
|
+
* @return {RankingBuilder} this
|
|
1283
|
+
*/
|
|
1284
|
+
gzip(level: GzipLevel): this;
|
|
1285
|
+
/**
|
|
1286
|
+
* クエリパラメータを内部的にセットします。
|
|
1287
|
+
* @param obj - セットするパラメータオブジェクト
|
|
1288
|
+
* @returns {RankingBuilder} this
|
|
1289
|
+
* @private
|
|
1290
|
+
*/
|
|
1291
|
+
protected set(obj: Partial<RankingParams>): this;
|
|
1292
|
+
/**
|
|
1293
|
+
* 設定されたパラメータに基づき、なろう小説ランキングAPIへのリクエストを実行します。
|
|
1294
|
+
*
|
|
1295
|
+
* 返される結果には、Nコード、ポイント、順位が含まれます。
|
|
1296
|
+
* @param options 実行オプション
|
|
1297
|
+
* @returns {Promise<NarouRankingResult[]>} ランキング結果の配列
|
|
1298
|
+
* @see https://dev.syosetu.com/man/rankapi/#output
|
|
1299
|
+
*/
|
|
1300
|
+
execute(options?: ExecuteOptions): Promise<NarouRankingResult[]>;
|
|
1301
|
+
/**
|
|
1302
|
+
* ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
|
|
1303
|
+
*/
|
|
1304
|
+
executeWithFields(fields?: never[] | undefined, opt?: never[] | undefined, options?: ExecuteOptions): Promise<RankingResult<DefaultSearchResultFields>[]>;
|
|
1305
|
+
/**
|
|
1306
|
+
* ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
|
|
1307
|
+
*
|
|
1308
|
+
* @template TFields - 取得する小説情報のフィールド型
|
|
1309
|
+
* @param fields - 取得するフィールドの配列
|
|
1310
|
+
* @returns {Promise<RankingResult<SearchResultFields<TFields>>[]>} 詳細情報を含むランキング結果の配列
|
|
1311
|
+
*/
|
|
1312
|
+
executeWithFields<TFields extends Fields>(fields: TFields | TFields[], opt?: never | never[], options?: ExecuteOptions): Promise<RankingResult<SearchResultFields<TFields>>[]>;
|
|
1313
|
+
/**
|
|
1314
|
+
* ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
|
|
1315
|
+
*
|
|
1316
|
+
* @param opt - オプショナルな取得フィールド (`weekly` など)
|
|
1317
|
+
* @returns {Promise<RankingResult<DefaultSearchResultFields | "weekly_unique">[]>} 詳細情報を含むランキング結果の配列
|
|
1318
|
+
*/
|
|
1319
|
+
executeWithFields(fields: never[], opt: OptionalFields | OptionalFields[], options?: ExecuteOptions): Promise<RankingResult<DefaultSearchResultFields | "weekly_unique">[]>;
|
|
1320
|
+
/**
|
|
1321
|
+
* ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。
|
|
1322
|
+
*
|
|
1323
|
+
* @template TFields - 取得する小説情報のフィールド型
|
|
1324
|
+
* @param fields - 取得するフィールドの配列
|
|
1325
|
+
* @param opt - オプショナルな取得フィールド (`weekly` など)
|
|
1326
|
+
* @returns {Promise<RankingResult<SearchResultFields<TFields> | "weekly_unique">[]>} 詳細情報を含むランキング結果の配列
|
|
1327
|
+
*/
|
|
1328
|
+
executeWithFields<TFields extends Fields>(fields: TFields | TFields[], opt: OptionalFields | OptionalFields[], options?: ExecuteOptions): Promise<RankingResult<SearchResultFields<TFields> | "weekly_unique">[]>;
|
|
1329
|
+
}
|
|
1330
|
+
//#endregion
|
|
1331
|
+
//#region src/user-search.d.ts
|
|
1332
|
+
/**
|
|
1333
|
+
* なろうユーザ検索API
|
|
1334
|
+
* @class UserSearch
|
|
1335
|
+
*/
|
|
1336
|
+
declare class UserSearchBuilder<TField extends keyof UserSearchResult = keyof UserSearchResult> extends SearchBuilderBase<UserSearchParams, UserOrder> {
|
|
1337
|
+
/**
|
|
1338
|
+
* 単語を指定できます。
|
|
1339
|
+
* 半角または全角スペースで区切るとAND抽出になります。
|
|
1340
|
+
* 部分一致でHITします。検索の対象はユーザ名とユーザ名のフリガナです。
|
|
1341
|
+
*/
|
|
1342
|
+
word(word: string): this;
|
|
1343
|
+
/**
|
|
1344
|
+
* 含みたくない単語を指定できます。
|
|
1345
|
+
* スペースで区切ることにより含ませない単語を増やせます。部分一致で除外されます。
|
|
1346
|
+
* 除外の対象はユーザ名とユーザ名のフリガナです。
|
|
1347
|
+
*/
|
|
1348
|
+
notWord(notword: string): this;
|
|
1349
|
+
/**
|
|
1350
|
+
* ユーザIDで抽出可能。
|
|
1351
|
+
*/
|
|
1352
|
+
userId(userid: number): this;
|
|
1353
|
+
/**
|
|
1354
|
+
* 抽出するユーザのユーザ名のフリガナの頭文字を指定できます。
|
|
1355
|
+
* 頭文字はユーザ名のフリガナをひらがなに変換し、最初の1文字が「ぁ」~「ん」の場合に対象となります。
|
|
1356
|
+
* 「ぱ」や「ば」等の半濁音や濁音は清音として扱われます。
|
|
1357
|
+
* 漢字や英数字が頭文字のユーザは対象外です。
|
|
1358
|
+
*/
|
|
1359
|
+
name1st(name1st: string): this;
|
|
1360
|
+
/**
|
|
1361
|
+
* 抽出するユーザの小説投稿数の下限を指定できます。
|
|
1362
|
+
* 小説投稿件数が指定された数値以上のユーザを抽出します。
|
|
1363
|
+
*/
|
|
1364
|
+
minNovel(minnovel: number): this;
|
|
1365
|
+
/**
|
|
1366
|
+
* 抽出するユーザの小説投稿数の上限を指定できます。
|
|
1367
|
+
* 小説投稿件数が指定された数値以下のユーザを抽出します。
|
|
1368
|
+
*/
|
|
1369
|
+
maxNovel(maxnovel: number): this;
|
|
1370
|
+
/**
|
|
1371
|
+
* 抽出するユーザのレビュー投稿数の下限を指定できます。
|
|
1372
|
+
* レビュー投稿件数が指定された数値以上のユーザを抽出します。
|
|
1373
|
+
*/
|
|
1374
|
+
minReview(minreview: number): this;
|
|
1375
|
+
/**
|
|
1376
|
+
* 抽出するユーザのレビュー投稿数の上限を指定できます。
|
|
1377
|
+
* レビュー投稿件数が指定された数値以下のユーザを抽出します。
|
|
1378
|
+
*/
|
|
1379
|
+
maxReview(maxreview: number): this;
|
|
1380
|
+
/**
|
|
1381
|
+
* 出力する項目を個別に指定できます。未指定時は全項目出力されます。転送量軽減のため、このパラメータの使用が推奨されます。
|
|
1382
|
+
* @return {SearchBuilder} this
|
|
1383
|
+
*/
|
|
1384
|
+
fields<TFields extends UserFields>(fields: TFields | readonly TFields[]): UserSearchBuilder<UserSearchResultFields<TFields>>;
|
|
1385
|
+
/**
|
|
1386
|
+
* なろう小説APIへのリクエストを実行する
|
|
1387
|
+
* @param options 実行オプション
|
|
1388
|
+
* @returns ランキング
|
|
1389
|
+
*/
|
|
1390
|
+
execute(options?: ExecuteOptions): Promise<NarouSearchResults<UserSearchResult, TField>>;
|
|
1391
|
+
}
|
|
1392
|
+
//#endregion
|
|
1393
|
+
export { UserSearchParams as $, BooleanNumber as A, ParamsBase as B, SearchResultFields as C, UserSearchResultFields as D, UserSearchResult as E, GenreNotation as F, RankingHistoryParams as G, R18Fields as H, GzipLevel as I, SearchParams as J, RankingParams as K, NovelTypeParam as L, DateParam as M, Fields as N, BigGenre as O, Genre as P, UserOrder as Q, OptionalFields as R, PickedNarouSearchResult as S, SearchResultR18Fields as T, R18Site as U, ParamsBaseWithOrder as V, R18SiteNotation as W, StopParam as X, SearchResultFieldNames as Y, UserFields as Z, SearchBuilderBase as _, NarouNovelJsonp as a, NarouSearchResults as b, NarouParams as c, formatRankingHistory as d, NarouRankingResult as f, SearchBuilder as g, NovelSearchBuilderBase as h, SearchBuilderR18 as i, BuntaiParam as j, BigGenreNotation as k, RankingHistoryRawResult as l, DefaultSearchResultFields as m, RankingBuilder as n, ExecuteOptions as o, RankingResult as p, RankingType as q, DefaultR18SearchResultFields as r, NarouNovel as s, UserSearchBuilder as t, RankingHistoryResult as u, End as v, SearchResultOptionalFields as w, NovelType as x, NarouSearchResult as y, Order as z };
|
|
1394
|
+
//# sourceMappingURL=user-search-BY6FdEe7.d.cts.map
|