narou 1.2.0 → 2.0.0

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.
Files changed (165) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +73 -37
  3. package/dist/index.browser.cjs +87 -1359
  4. package/dist/index.browser.cjs.map +1 -1
  5. package/dist/index.browser.d.cts +11 -19
  6. package/dist/index.browser.d.mts +47 -0
  7. package/dist/index.browser.mjs +66 -0
  8. package/dist/index.browser.mjs.map +1 -0
  9. package/dist/index.cjs +147 -1410
  10. package/dist/index.cjs.map +1 -1
  11. package/dist/index.common-8lS2K_1Y.mjs +1166 -0
  12. package/dist/index.common-8lS2K_1Y.mjs.map +1 -0
  13. package/dist/index.common-CYj0n0aU.cjs +1346 -0
  14. package/dist/index.common-CYj0n0aU.cjs.map +1 -0
  15. package/dist/index.d.cts +28 -21
  16. package/dist/index.d.mts +63 -0
  17. package/dist/index.mjs +128 -0
  18. package/dist/index.mjs.map +1 -0
  19. package/dist/user-search-BY6FdEe7.d.cts +1394 -0
  20. package/dist/user-search-Besgk-Hx.d.mts +1394 -0
  21. package/package.json +28 -37
  22. package/pnpm-lock.yaml +1325 -1100
  23. package/src/index.ts +5 -1
  24. package/src/narou-fetch.ts +4 -3
  25. package/src/narou-jsonp.ts +4 -2
  26. package/src/narou.ts +50 -13
  27. package/src/params.ts +1 -1
  28. package/src/ranking.ts +20 -11
  29. package/src/search-builder-r18.ts +6 -2
  30. package/src/search-builder.ts +7 -3
  31. package/src/user-search.ts +9 -2
  32. package/dist/chunk-3A5MHPWL.js +0 -37
  33. package/dist/chunk-3A5MHPWL.js.map +0 -1
  34. package/dist/chunk-4ZP5YNWI.js +0 -1
  35. package/dist/chunk-4ZP5YNWI.js.map +0 -1
  36. package/dist/chunk-5UDKQCPJ.js +0 -407
  37. package/dist/chunk-5UDKQCPJ.js.map +0 -1
  38. package/dist/chunk-6BZWV4ZC.js +0 -75
  39. package/dist/chunk-6BZWV4ZC.js.map +0 -1
  40. package/dist/chunk-BQLSW236.js +0 -117
  41. package/dist/chunk-BQLSW236.js.map +0 -1
  42. package/dist/chunk-DEQICAN3.js +0 -94
  43. package/dist/chunk-DEQICAN3.js.map +0 -1
  44. package/dist/chunk-E2H3AJSQ.js +0 -57
  45. package/dist/chunk-E2H3AJSQ.js.map +0 -1
  46. package/dist/chunk-HOBLKBZ6.js +0 -452
  47. package/dist/chunk-HOBLKBZ6.js.map +0 -1
  48. package/dist/chunk-IPDEGCWU.js +0 -39
  49. package/dist/chunk-IPDEGCWU.js.map +0 -1
  50. package/dist/chunk-LQLNWSWV.js +0 -26
  51. package/dist/chunk-LQLNWSWV.js.map +0 -1
  52. package/dist/chunk-PLEM2AOH.js +0 -44
  53. package/dist/chunk-PLEM2AOH.js.map +0 -1
  54. package/dist/chunk-RNHRR56W.js +0 -25
  55. package/dist/chunk-RNHRR56W.js.map +0 -1
  56. package/dist/chunk-VUZIISP2.js +0 -23
  57. package/dist/chunk-VUZIISP2.js.map +0 -1
  58. package/dist/chunk-VZVUANDN.js +0 -17
  59. package/dist/chunk-VZVUANDN.js.map +0 -1
  60. package/dist/index.browser.d.ts +0 -55
  61. package/dist/index.browser.js +0 -126
  62. package/dist/index.browser.js.map +0 -1
  63. package/dist/index.common.cjs +0 -1187
  64. package/dist/index.common.cjs.map +0 -1
  65. package/dist/index.common.d.cts +0 -6
  66. package/dist/index.common.d.ts +0 -6
  67. package/dist/index.common.js +0 -76
  68. package/dist/index.common.js.map +0 -1
  69. package/dist/index.d.ts +0 -56
  70. package/dist/index.js +0 -131
  71. package/dist/index.js.map +0 -1
  72. package/dist/narou-DBa12V_l.d.ts +0 -404
  73. package/dist/narou-DCp4aGfA.d.cts +0 -404
  74. package/dist/narou-fetch.cjs +0 -164
  75. package/dist/narou-fetch.cjs.map +0 -1
  76. package/dist/narou-fetch.d.cts +0 -20
  77. package/dist/narou-fetch.d.ts +0 -20
  78. package/dist/narou-fetch.js +0 -10
  79. package/dist/narou-fetch.js.map +0 -1
  80. package/dist/narou-jsonp.cjs +0 -162
  81. package/dist/narou-jsonp.cjs.map +0 -1
  82. package/dist/narou-jsonp.d.cts +0 -13
  83. package/dist/narou-jsonp.d.ts +0 -13
  84. package/dist/narou-jsonp.js +0 -10
  85. package/dist/narou-jsonp.js.map +0 -1
  86. package/dist/narou-ranking-results.cjs +0 -19
  87. package/dist/narou-ranking-results.cjs.map +0 -1
  88. package/dist/narou-ranking-results.d.cts +0 -4
  89. package/dist/narou-ranking-results.d.ts +0 -4
  90. package/dist/narou-ranking-results.js +0 -1
  91. package/dist/narou-ranking-results.js.map +0 -1
  92. package/dist/narou-search-results-C21hWrnL.d.cts +0 -727
  93. package/dist/narou-search-results-DT0YdaBn.d.ts +0 -727
  94. package/dist/narou-search-results.cjs +0 -62
  95. package/dist/narou-search-results.cjs.map +0 -1
  96. package/dist/narou-search-results.d.cts +0 -2
  97. package/dist/narou-search-results.d.ts +0 -2
  98. package/dist/narou-search-results.js +0 -11
  99. package/dist/narou-search-results.js.map +0 -1
  100. package/dist/narou.cjs +0 -112
  101. package/dist/narou.cjs.map +0 -1
  102. package/dist/narou.d.cts +0 -4
  103. package/dist/narou.d.ts +0 -4
  104. package/dist/narou.js +0 -8
  105. package/dist/narou.js.map +0 -1
  106. package/dist/params.cjs +0 -448
  107. package/dist/params.cjs.map +0 -1
  108. package/dist/params.d.cts +0 -2
  109. package/dist/params.d.ts +0 -2
  110. package/dist/params.js +0 -41
  111. package/dist/params.js.map +0 -1
  112. package/dist/ranking-history.cjs +0 -47
  113. package/dist/ranking-history.cjs.map +0 -1
  114. package/dist/ranking-history.d.cts +0 -28
  115. package/dist/ranking-history.d.ts +0 -28
  116. package/dist/ranking-history.js +0 -8
  117. package/dist/ranking-history.js.map +0 -1
  118. package/dist/ranking.cjs +0 -783
  119. package/dist/ranking.cjs.map +0 -1
  120. package/dist/ranking.d.cts +0 -108
  121. package/dist/ranking.d.ts +0 -108
  122. package/dist/ranking.js +0 -10
  123. package/dist/ranking.js.map +0 -1
  124. package/dist/search-builder-r18.cjs +0 -547
  125. package/dist/search-builder-r18.cjs.map +0 -1
  126. package/dist/search-builder-r18.d.cts +0 -45
  127. package/dist/search-builder-r18.d.ts +0 -45
  128. package/dist/search-builder-r18.js +0 -9
  129. package/dist/search-builder-r18.js.map +0 -1
  130. package/dist/search-builder.cjs +0 -591
  131. package/dist/search-builder.cjs.map +0 -1
  132. package/dist/search-builder.d.cts +0 -4
  133. package/dist/search-builder.d.ts +0 -4
  134. package/dist/search-builder.js +0 -12
  135. package/dist/search-builder.js.map +0 -1
  136. package/dist/user-search.cjs +0 -325
  137. package/dist/user-search.cjs.map +0 -1
  138. package/dist/user-search.d.cts +0 -66
  139. package/dist/user-search.d.ts +0 -66
  140. package/dist/user-search.js +0 -9
  141. package/dist/user-search.js.map +0 -1
  142. package/dist/util/date.cjs +0 -51
  143. package/dist/util/date.cjs.map +0 -1
  144. package/dist/util/date.d.cts +0 -21
  145. package/dist/util/date.d.ts +0 -21
  146. package/dist/util/date.js +0 -11
  147. package/dist/util/date.js.map +0 -1
  148. package/dist/util/jsonp.cjs +0 -63
  149. package/dist/util/jsonp.cjs.map +0 -1
  150. package/dist/util/jsonp.d.cts +0 -49
  151. package/dist/util/jsonp.d.ts +0 -49
  152. package/dist/util/jsonp.js +0 -7
  153. package/dist/util/jsonp.js.map +0 -1
  154. package/dist/util/type.cjs +0 -19
  155. package/dist/util/type.cjs.map +0 -1
  156. package/dist/util/type.d.cts +0 -27
  157. package/dist/util/type.d.ts +0 -27
  158. package/dist/util/type.js +0 -1
  159. package/dist/util/type.js.map +0 -1
  160. package/dist/util/unzipp.cjs +0 -47
  161. package/dist/util/unzipp.cjs.map +0 -1
  162. package/dist/util/unzipp.d.cts +0 -12
  163. package/dist/util/unzipp.d.ts +0 -12
  164. package/dist/util/unzipp.js +0 -7
  165. package/dist/util/unzipp.js.map +0 -1
@@ -1,727 +0,0 @@
1
- import { Join } from './util/type.cjs';
2
-
3
- declare const RankingType: {
4
- readonly Daily: "d";
5
- readonly Weekly: "w";
6
- readonly Monthly: "m";
7
- readonly Quarterly: "q";
8
- };
9
- type RankingType = (typeof RankingType)[keyof typeof RankingType];
10
- /**
11
- * すべてのAPIで共通のクエリパラメータ
12
- */
13
- interface ParamsBase {
14
- /**
15
- * gzip圧縮してgzipファイルとして返します。
16
- * gzip圧縮レベルを1~5で指定できます。
17
- * 転送量上限を減らすためにも推奨
18
- */
19
- gzip?: GzipLevel;
20
- /**
21
- * 出力形式を指定
22
- * 本ライブラリはJSONとJSONPのみ対応
23
- */
24
- out?: "json" | "jsonp";
25
- }
26
- /**
27
- * 検索APIで共通のクエリパラメータ
28
- */
29
- interface ParamsBaseWithOrder<TOrder extends string> extends ParamsBase {
30
- /**
31
- * 出力する項目を個別に指定できます。未指定時は全項目出力されます。
32
- * 転送量軽減のため、このパラメータの使用が推奨されます。
33
- */
34
- of?: string;
35
- /**
36
- * 最大出力数を指定できます。指定しない場合は20件になります。
37
- */
38
- lim?: number;
39
- /** 表示開始位置の指定です。 */
40
- st?: number;
41
- /** 出力順序を指定できます。 */
42
- order?: TOrder;
43
- }
44
- /**
45
- * メソッドにパラメータを指定する際のヘルパー。
46
- * @see https://dev.syosetu.com/man/api/
47
- * @see https://dev.syosetu.com/xman/atom/
48
- */
49
- interface SearchParams extends ParamsBaseWithOrder<Order> {
50
- word?: string;
51
- notword?: string;
52
- title?: BooleanNumber;
53
- ex?: BooleanNumber;
54
- keyword?: BooleanNumber;
55
- wname?: BooleanNumber;
56
- biggenre?: Join<BigGenre> | BigGenre;
57
- notbiggenre?: Join<BigGenre> | BigGenre;
58
- genre?: Join<Genre> | Genre;
59
- notgenre?: Join<Genre> | Genre;
60
- userid?: Join<number> | number;
61
- nocgenre?: Join<R18Site> | R18Site;
62
- notnocgenre?: Join<R18Site> | R18Site;
63
- xid?: Join<number> | number;
64
- isr15?: BooleanNumber;
65
- isbl?: BooleanNumber;
66
- isgl?: BooleanNumber;
67
- iszankoku?: BooleanNumber;
68
- istensei?: BooleanNumber;
69
- istenni?: BooleanNumber;
70
- istt?: BooleanNumber;
71
- notr15?: BooleanNumber;
72
- notbl?: BooleanNumber;
73
- notgl?: BooleanNumber;
74
- notzankoku?: BooleanNumber;
75
- nottensei?: BooleanNumber;
76
- nottenni?: BooleanNumber;
77
- minlen?: number;
78
- maxlen?: number;
79
- length?: number | Join<number | "">;
80
- kaiwaritu?: number | string;
81
- sasie?: number | string;
82
- mintime?: number;
83
- maxtime?: number;
84
- time?: number | string;
85
- ncode?: string | Join<string>;
86
- type?: NovelTypeParam;
87
- buntai?: BuntaiParam | Join<BuntaiParam>;
88
- stop?: StopParam;
89
- ispickup?: typeof BooleanNumber.True;
90
- lastup?: string;
91
- lastupdate?: string;
92
- opt?: Join<OptionalFields>;
93
- }
94
- interface RankingParams extends ParamsBase {
95
- rtype: `${string}-${RankingType}`;
96
- }
97
- interface RankingHistoryParams extends ParamsBase {
98
- ncode: string;
99
- }
100
- /**
101
- * ユーザー検索パラメータ
102
- */
103
- interface UserSearchParams extends ParamsBaseWithOrder<UserOrder> {
104
- /** 単語を指定できます。半角または全角スペースで区切るとAND抽出になります。部分一致でHITします。検索の対象はユーザ名とユーザ名のフリガナです。 */
105
- word?: string;
106
- /** 含みたくない単語を指定できます。スペースで区切ることにより含ませない単語を増やせます。部分一致で除外されます。除外の対象はユーザ名とユーザ名のフリガナです。 */
107
- notword?: string;
108
- /** ユーザIDで抽出可能。 */
109
- userid?: number;
110
- /** 抽出するユーザのユーザ名のフリガナの頭文字を指定できます。頭文字はユーザ名のフリガナをひらがなに変換し、最初の1文字が「ぁ」~「ん」の場合に対象となります。 */
111
- name1st?: string;
112
- /** 抽出するユーザの小説投稿数の下限を指定できます。小説投稿件数が指定された数値以上のユーザを抽出します。 */
113
- minnovel?: number;
114
- /** 抽出するユーザの小説投稿数の上限を指定できます。小説投稿件数が指定された数値以下のユーザを抽出します。 */
115
- maxnovel?: number;
116
- /** 抽出するユーザのレビュー投稿数の下限を指定できます。レビュー投稿件数が指定された数値以上のユーザを抽出します。 */
117
- minreview?: number;
118
- /** 抽出するユーザのレビュー投稿数の上限を指定できます。レビュー投稿件数が指定された数値以下のユーザを抽出します。 */
119
- maxreview?: number;
120
- }
121
- declare const BooleanNumber: {
122
- readonly True: 1;
123
- readonly False: 0;
124
- };
125
- type BooleanNumber = (typeof BooleanNumber)[keyof typeof BooleanNumber];
126
- type SearchResultFieldNames = keyof NarouSearchResult;
127
- /**
128
- * なろう小説APIのofパラメータに指定できる出力する項目
129
- * @see https://dev.syosetu.com/man/api/#output
130
- */
131
- declare const Fields: {
132
- /** 小説名 */
133
- readonly title: "t";
134
- /** Nコード */
135
- readonly ncode: "n";
136
- /** 作者のユーザID(数値) */
137
- readonly userid: "u";
138
- /** 作者名 */
139
- readonly writer: "w";
140
- /** 小説のあらすじ */
141
- readonly story: "s";
142
- /** 大ジャンル */
143
- readonly biggenre: "bg";
144
- /** ジャンル */
145
- readonly genre: "g";
146
- /** キーワード */
147
- readonly keyword: "k";
148
- /** 初回掲載日 */
149
- readonly general_firstup: "gf";
150
- /** 最終掲載日 */
151
- readonly general_lastup: "gl";
152
- /** 連載の場合は1、短編の場合は2 */
153
- readonly noveltype: "nt";
154
- /** 短編小説と完結済小説は0となっています。連載中は1です。 */
155
- readonly end: "e";
156
- /** 全掲載部分数 */
157
- readonly general_all_no: "ga";
158
- /** 小説文字数 */
159
- readonly length: "l";
160
- /** 読了時間(分単位) */
161
- readonly time: "ti";
162
- /** 長期連載停止中 */
163
- readonly isstop: "i";
164
- /** 登録必須キーワードに「R15」が含まれる場合は1、それ以外は0です。 */
165
- readonly isr15: "isr";
166
- /** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
167
- readonly isbl: "ibl";
168
- /** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
169
- readonly isgl: "igl";
170
- /** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
171
- readonly iszankoku: "izk";
172
- /** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
173
- readonly istensei: "its";
174
- /** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
175
- readonly istenni: "iti";
176
- /** 総合評価ポイント */
177
- readonly global_point: "gp";
178
- /** 日間ポイント */
179
- readonly daily_point: "dp";
180
- /** 週間ポイント */
181
- readonly weekly_point: "wp";
182
- /** 月間ポイント */
183
- readonly monthly_point: "mp";
184
- /** 四半期ポイント */
185
- readonly quarter_point: "qp";
186
- /** 年間ポイント */
187
- readonly yearly_point: "yp";
188
- /** ブックマーク数 */
189
- readonly fav_novel_cnt: "f";
190
- /** 感想数 */
191
- readonly impression_cnt: "imp";
192
- /** レビュー数 */
193
- readonly review_cnt: "r";
194
- /** 評価ポイント */
195
- readonly all_point: "a";
196
- /** 評価者数 */
197
- readonly all_hyoka_cnt: "ah";
198
- /** 挿絵の数 */
199
- readonly sasie_cnt: "sa";
200
- /** 会話率 */
201
- readonly kaiwaritu: "ka";
202
- /** 小説の更新日時 */
203
- readonly novelupdated_at: "nu";
204
- /**
205
- * 最終更新日時
206
- * システム用で小説更新時とは関係ありません
207
- */
208
- readonly updated_at: "ua";
209
- };
210
- type Fields = (typeof Fields)[keyof Omit<NarouSearchResult, "novel_type" | "weekly_unique" | "nocgenre">];
211
- /**
212
- * なろうR18小説APIのofパラメータに指定できる出力する項目
213
- * @see https://dev.syosetu.com/xman/api/#output
214
- */
215
- declare const R18Fields: {
216
- /** 小説名 */
217
- readonly title: "t";
218
- /** Nコード */
219
- readonly ncode: "n";
220
- /** 作者のユーザID(数値) */
221
- readonly userid: "u";
222
- /** 作者名 */
223
- readonly writer: "w";
224
- /** 小説のあらすじ */
225
- readonly story: "s";
226
- /** 掲載サイト */
227
- readonly nocgenre: "ng";
228
- /** キーワード */
229
- readonly keyword: "k";
230
- /** 初回掲載日 */
231
- readonly general_firstup: "gf";
232
- /** 最終掲載日 */
233
- readonly general_lastup: "gl";
234
- /** 連載の場合は1、短編の場合は2 */
235
- readonly noveltype: "nt";
236
- /** 短編小説と完結済小説は0となっています。連載中は1です。 */
237
- readonly end: "e";
238
- /** 全掲載部分数 */
239
- readonly general_all_no: "ga";
240
- /** 小説文字数 */
241
- readonly length: "l";
242
- /** 読了時間(分単位) */
243
- readonly time: "ti";
244
- /** 長期連載停止中 */
245
- readonly isstop: "i";
246
- /** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
247
- readonly isbl: "ibl";
248
- /** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
249
- readonly isgl: "igl";
250
- /** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
251
- readonly iszankoku: "izk";
252
- /** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
253
- readonly istensei: "its";
254
- /** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
255
- readonly istenni: "iti";
256
- /** 総合評価ポイント */
257
- readonly global_point: "gp";
258
- /** 日間ポイント */
259
- readonly daily_point: "dp";
260
- /** 週間ポイント */
261
- readonly weekly_point: "wp";
262
- /** 月間ポイント */
263
- readonly monthly_point: "mp";
264
- /** 四半期ポイント */
265
- readonly quarter_point: "qp";
266
- /** 年間ポイント */
267
- readonly yearly_point: "yp";
268
- /** R18ブックマーク数 */
269
- readonly fav_novel_cnt: "f";
270
- /** 感想数 */
271
- readonly impression_cnt: "imp";
272
- /** レビュー数 */
273
- readonly review_cnt: "r";
274
- /** 評価ポイント */
275
- readonly all_point: "a";
276
- /** 評価者数 */
277
- readonly all_hyoka_cnt: "ah";
278
- /** 挿絵の数 */
279
- readonly sasie_cnt: "sa";
280
- /** 会話率 */
281
- readonly kaiwaritu: "ka";
282
- /** 小説の更新日時 */
283
- readonly novelupdated_at: "nu";
284
- /**
285
- * 最終更新日時
286
- * システム用で小説更新時とは関係ありません
287
- */
288
- readonly updated_at: "ua";
289
- };
290
- type R18Fields = (typeof R18Fields)[keyof Omit<NarouSearchResult, "novel_type" | "weekly_unique" | "biggenre" | "genre" | "isr15">];
291
- /**
292
- * オプション項目
293
- */
294
- declare const OptionalFields: {
295
- /**
296
- * 週間ユニークユーザ[項目名:weekly_unique]が追加されます。
297
- * 週間ユニークユーザは前週の日曜日から土曜日分のユニークの合計です。
298
- * 毎週火曜日早朝に更新されます。
299
- */
300
- readonly weekly_unique: "weekly";
301
- };
302
- type OptionalFields = (typeof OptionalFields)[keyof Pick<NarouSearchResult, "weekly_unique">];
303
- /**
304
- * ユーザ検索APIのofパラメータに指定できる出力する項目
305
- * @see https://dev.syosetu.com/man/userapi/#output
306
- */
307
- declare const UserFields: {
308
- /** ユーザID */
309
- readonly userid: "u";
310
- /** ユーザ名 */
311
- readonly name: "n";
312
- /** ユーザ名のフリガナ */
313
- readonly yomikata: "y";
314
- /** ユーザ名のフリガナの頭文字 */
315
- readonly name1st: "1";
316
- /** 小説投稿数 */
317
- readonly novel_cnt: "nc";
318
- /** レビュー投稿数 */
319
- readonly review_cnt: "rc";
320
- /** 小説累計文字数 */
321
- readonly novel_length: "nl";
322
- /** 総合評価ポイントの合計 */
323
- readonly sum_global_point: "sg";
324
- };
325
- type UserFields = (typeof UserFields)[keyof UserSearchResult];
326
- /**
327
- * 出力順序
328
- */
329
- declare const Order: {
330
- /** ブックマーク数の多い順 */
331
- readonly FavoriteNovelCount: "favnovelcnt";
332
- /** レビュー数の多い順 */
333
- readonly ReviewCount: "favnovelcnt";
334
- /** 総合ポイントの高い順 */
335
- readonly HyokaDesc: "hyoka";
336
- /** 総合ポイントの低い順 */
337
- readonly HyokaAsc: "hyokaasc";
338
- /** 感想の多い順 */
339
- readonly ImpressionCount: "impressioncnt";
340
- /** 評価者数の多い順 */
341
- readonly HyokaCountDesc: "hyokacnt";
342
- /** 評価者数の少ない順 */
343
- readonly HyokaCountAsc: "hyokacntasc";
344
- /** 週間ユニークユーザの多い順 */
345
- readonly Weekly: "weekly";
346
- /** 小説本文の文字数が多い順 */
347
- readonly LengthDesc: "lengthdesc";
348
- /** 小説本文の文字数が少ない順 */
349
- readonly LengthAsc: "lengthasc";
350
- /** Nコードが新しい順 */
351
- readonly NCodeDesc: "ncodedesc";
352
- /** 新着更新順 */
353
- readonly New: "new";
354
- /** 古い順 */
355
- readonly Old: "old";
356
- /** 日間ポイントの高い順 */
357
- readonly DailyPoint: "dailypoint";
358
- /** 週間ポイントの高い順 */
359
- readonly WeeklyPoint: "weeklypoint";
360
- /** 月間ポイントの高い順 */
361
- readonly MonthlyPoint: "monthlypoint";
362
- /** 四半期ポイントの高い順 */
363
- readonly QuarterPoint: "quarterpoint";
364
- /** 年間ポイントの高い順 */
365
- readonly YearlyPoint: "yearlypoint";
366
- /** 初回掲載順 */
367
- readonly GeneralFirstUp: "generalfirstup";
368
- };
369
- type Order = (typeof Order)[keyof typeof Order];
370
- /** R18掲載サイト */
371
- declare const R18Site: {
372
- /** ノクターンノベルズ(男性向け) */
373
- readonly Nocturne: 1;
374
- /** ムーンライトノベルズ(女性向け) */
375
- readonly MoonLight: 2;
376
- /** ムーンライトノベルズ(BL) */
377
- readonly MoonLightBL: 3;
378
- /** ミッドナイトノベルズ(大人向け) */
379
- readonly Midnight: 4;
380
- };
381
- type R18Site = (typeof R18Site)[keyof typeof R18Site];
382
- /** R18掲載サイト表記ヘルパー */
383
- declare const R18SiteNotation: {
384
- readonly [K in R18Site]: string;
385
- };
386
- /** 大ジャンル */
387
- declare const BigGenre: {
388
- /** 恋愛 */
389
- readonly Renai: 1;
390
- /** ファンタジー */
391
- readonly Fantasy: 2;
392
- /** 文芸 */
393
- readonly Bungei: 3;
394
- /** SF */
395
- readonly Sf: 4;
396
- /** その他 */
397
- readonly Sonota: 99;
398
- /** ノンジャンル */
399
- readonly NonGenre: 98;
400
- };
401
- type BigGenre = (typeof BigGenre)[keyof typeof BigGenre];
402
- /** 大ジャンル表記ヘルパー */
403
- declare const BigGenreNotation: {
404
- readonly [K in BigGenre]: string;
405
- };
406
- /** ジャンル */
407
- declare const Genre: {
408
- /** 異世界〔恋愛〕*/
409
- readonly RenaiIsekai: 101;
410
- /** 現実世界〔恋愛〕*/
411
- readonly RenaiGenjitsusekai: 102;
412
- /** ハイファンタジー〔ファンタジー〕*/
413
- readonly FantasyHigh: 201;
414
- /** ローファンタジー〔ファンタジー〕*/
415
- readonly FantasyLow: 202;
416
- /** 純文学〔文芸〕*/
417
- readonly BungeiJyunbungei: 301;
418
- /** ヒューマンドラマ〔文芸〕*/
419
- readonly BungeiHumanDrama: 302;
420
- /** 歴史〔文芸〕*/
421
- readonly BungeiHistory: 303;
422
- /** 推理〔文芸〕*/
423
- readonly BungeiSuiri: 304;
424
- /** ホラー〔文芸〕*/
425
- readonly BungeiHorror: 305;
426
- /** アクション〔文芸〕*/
427
- readonly BungeiAction: 306;
428
- /** コメディー〔文芸〕*/
429
- readonly BungeiComedy: 307;
430
- /** VRゲーム〔SF〕*/
431
- readonly SfVrgame: 401;
432
- /** 宇宙〔SF〕*/
433
- readonly SfSpace: 402;
434
- /** 空想科学〔SF〕*/
435
- readonly SfKuusoukagaku: 403;
436
- /** パニック〔SF〕*/
437
- readonly SfPanic: 404;
438
- /** 童話〔その他〕*/
439
- readonly SonotaDouwa: 9901;
440
- /** 詩〔その他〕*/
441
- readonly SonotaShi: 9902;
442
- /** エッセイ〔その他〕*/
443
- readonly SonotaEssei: 9903;
444
- /** リプレイ〔その他〕*/
445
- readonly SonotaReplay: 9904;
446
- /** その他〔その他〕 */
447
- readonly SonotaSonota: 9999;
448
- /** ノンジャンル〔ノンジャンル〕*/
449
- readonly NonGenre: 9801;
450
- };
451
- type Genre = (typeof Genre)[keyof typeof Genre];
452
- /** ジャンル表記ヘルパー */
453
- declare const GenreNotation: {
454
- readonly [K in Genre]: string;
455
- };
456
- /** 文体指定 */
457
- declare const BuntaiParam: {
458
- /** 字下げされておらず、連続改行が多い作品 */
459
- readonly NoJisageKaigyouOoi: 1;
460
- /** 字下げされていないが、改行数は平均な作品 */
461
- readonly NoJisageKaigyoHutsuu: 2;
462
- /** 字下げが適切だが、連続改行が多い作品 */
463
- readonly JisageKaigyoOoi: 4;
464
- /** 字下げが適切でかつ改行数も平均な作品 */
465
- readonly JisageKaigyoHutsuu: 6;
466
- };
467
- type BuntaiParam = (typeof BuntaiParam)[keyof typeof BuntaiParam];
468
- /** 連載停止中指定 */
469
- declare const StopParam: {
470
- /** 長期連載停止中を除きます */
471
- readonly NoStopping: 1;
472
- /** 長期連載停止中のみ取得します */
473
- readonly Stopping: 2;
474
- };
475
- type StopParam = (typeof StopParam)[keyof typeof StopParam];
476
- /** 小説タイプ指定 */
477
- declare const NovelTypeParam: {
478
- /** 短編 */
479
- readonly Short: "t";
480
- /** 連載中 */
481
- readonly RensaiNow: "r";
482
- /** 完結済連載小説 */
483
- readonly RensaiEnd: "er";
484
- /** すべての連載小説(連載中および完結済) */
485
- readonly Rensai: "re";
486
- /** 短編と完結済連載小説 */
487
- readonly ShortAndRensai: "ter";
488
- };
489
- type NovelTypeParam = (typeof NovelTypeParam)[keyof typeof NovelTypeParam];
490
- /** 日付指定パラメータ */
491
- declare const DateParam: {
492
- ThisWeek: string;
493
- LastWeek: string;
494
- SevenDays: string;
495
- ThisMonth: string;
496
- LastMonth: string;
497
- };
498
- type DateParam = (typeof DateParam)[keyof typeof DateParam];
499
- declare const UserOrder: {
500
- /** ユーザIDの新しい順 */
501
- readonly New: "new";
502
- /** 小説投稿数の多い順 */
503
- readonly NovelCount: "novelcnt";
504
- /** レビュー投稿数の多い順 */
505
- readonly ReviewCount: "reviewcnt";
506
- /** 小説累計文字数の多い順 */
507
- readonly NovelLength: "novellength";
508
- /** 総合評価ポイントの合計の多い順 */
509
- readonly SumGlobalPoint: "sumglobalpoint";
510
- /** ユーザIDの古い順 */
511
- readonly Old: "old";
512
- };
513
- type UserOrder = (typeof UserOrder)[keyof typeof UserOrder];
514
- type GzipLevel = 0 | 1 | 2 | 3 | 4 | 5;
515
-
516
- /**
517
- * なろう小説API検索結果
518
- */
519
- declare class NarouSearchResults<T, TKey extends keyof T> {
520
- /**
521
- * 検索結果数
522
- */
523
- allcount: number;
524
- /**
525
- * 結果表示上限数
526
- */
527
- limit: number;
528
- /**
529
- * 結果表示開始数
530
- */
531
- start: number;
532
- /**
533
- * 結果表示の現在ページ(=start/limit)
534
- */
535
- page: number;
536
- /**
537
- * 今回取得できた検索結果の数
538
- */
539
- length: number;
540
- /**
541
- * 検索結果
542
- */
543
- values: readonly Pick<T, TKey>[];
544
- /**
545
- * @constractor
546
- * @private
547
- */
548
- constructor([header, ...result]: [{
549
- allcount: number;
550
- }, ...Pick<T, TKey>[]], params: SearchParams | UserSearchParams);
551
- }
552
- /**
553
- * 小説情報
554
- * @see https://dev.syosetu.com/man/api/#output
555
- * @see https://dev.syosetu.com/xman/api/#output
556
- */
557
- interface NarouSearchResult {
558
- /** 小説名 */
559
- title: string;
560
- /** Nコード */
561
- ncode: string;
562
- /** 作者のユーザID(数値) */
563
- userid: number;
564
- /** 作者名 */
565
- writer: string;
566
- /** 小説のあらすじ */
567
- story: string;
568
- /** 掲載サイト */
569
- nocgenre: R18Site;
570
- /** 大ジャンル */
571
- biggenre: BigGenre;
572
- /** ジャンル */
573
- genre: Genre;
574
- /** キーワード */
575
- keyword: string;
576
- /** 初回掲載日 YYYY-MM-DD HH:MM:SSの形式 */
577
- general_firstup: string;
578
- /** 最終掲載日 YYYY-MM-DD HH:MM:SSの形式 */
579
- general_lastup: string;
580
- /** 連載の場合は1、短編の場合は2 */
581
- novel_type: NovelType;
582
- /** 連載の場合は1、短編の場合は2 */
583
- noveltype: NovelType;
584
- /** 短編小説と完結済小説は0となっています。連載中は1です。 */
585
- end: End;
586
- /** 全掲載話数です。短編の場合は1です。 */
587
- general_all_no: number;
588
- /** 小説文字数です。スペースや改行は文字数としてカウントしません。 */
589
- length: number;
590
- /** 読了時間(分単位)です。読了時間は小説文字数÷500を切り上げした数値です。 */
591
- time: number;
592
- /** 長期連載中は1、それ以外は0です。 */
593
- isstop: BooleanNumber;
594
- /** 登録必須キーワードに「R15」が含まれる場合は1、それ以外は0です。 */
595
- isr15: BooleanNumber;
596
- /** 登録必須キーワードに「ボーイズラブ」が含まれる場合は1、それ以外は0です。 */
597
- isbl: BooleanNumber;
598
- /** 登録必須キーワードに「ガールズラブ」が含まれる場合は1、それ以外は0です。 */
599
- isgl: BooleanNumber;
600
- /** 登録必須キーワードに「残酷な描写あり」が含まれる場合は1、それ以外は0です。 */
601
- iszankoku: BooleanNumber;
602
- /** 登録必須キーワードに「異世界転生」が含まれる場合は1、それ以外は0です。 */
603
- istensei: BooleanNumber;
604
- /** 登録必須キーワードに「異世界転移」が含まれる場合は1、それ以外は0です。 */
605
- istenni: BooleanNumber;
606
- /** 総合得点(=(ブックマーク数×2)+評価点) */
607
- global_point: number;
608
- /**
609
- * 日間ポイント
610
- * ランキング集計時点から過去24時間以内で新たに登録されたブックマークや評価が対象
611
- */
612
- daily_point: number;
613
- /**
614
- * 週間ポイント
615
- * ランキング集計時点から過去7日以内で新たに登録されたブックマークや評価が対象
616
- */
617
- weekly_point: number;
618
- /**
619
- * 月間ポイント
620
- * ランキング集計時点から過去30日以内で新たに登録されたブックマークや評価が対象
621
- */
622
- monthly_point: number;
623
- /**
624
- * 四半期ポイント
625
- * ランキング集計時点から過去90日以内で新たに登録されたブックマークや評価が対象
626
- */
627
- quarter_point: number;
628
- /**
629
- * 年間ポイント
630
- * ランキング集計時点から過去365日以内で新たに登録されたブックマークや評価が対象
631
- */
632
- yearly_point: number;
633
- /** ブックマーク数 */
634
- fav_novel_cnt: number;
635
- /** 感想数 */
636
- impression_cnt: number;
637
- /** レビュー数 */
638
- review_cnt: number;
639
- /** 評価ポイント */
640
- all_point: number;
641
- /** 評価者数 */
642
- all_hyoka_cnt: number;
643
- /** 挿絵の数 */
644
- sasie_cnt: number;
645
- /**
646
- * 会話率
647
- * @see https://dev.syosetu.com/man/kaiwa/
648
- */
649
- kaiwaritu: number;
650
- /**
651
- * 小説の更新日時
652
- */
653
- novelupdated_at: string;
654
- /**
655
- * 最終更新日時
656
- * システム用で小説更新時とは関係ありません
657
- */
658
- updated_at: string;
659
- /** 週間ユニークユーザー数 */
660
- weekly_unique: number;
661
- }
662
- /**
663
- * ユーザ情報
664
- * @see https://dev.syosetu.com/man/userapi/#output
665
- */
666
- interface UserSearchResult {
667
- /** ユーザID */
668
- userid: number;
669
- /** ユーザ名 */
670
- name: string;
671
- /** ユーザ名のフリガナ */
672
- yomikata: string;
673
- /**
674
- * ユーザ名のフリガナの頭文字
675
- * ひらがな以外の場合はnullまたは空文字となります。
676
- */
677
- name1st: string;
678
- /** 小説投稿数 */
679
- novel_cnt: number;
680
- /** レビュー投稿数 */
681
- review_cnt: number;
682
- /**
683
- * 小説累計文字数
684
- * スペースや改行は文字数としてカウントしません。
685
- */
686
- novel_length: number;
687
- /**
688
- * 総合評価ポイントの合計
689
- * 投稿済小説でそれぞれ獲得した総合評価ポイントの合計です。
690
- */
691
- sum_global_point: number;
692
- }
693
- /**
694
- * noveltype/novel_typeの値ヘルパー
695
- */
696
- declare const NovelType: {
697
- /** 連載 */
698
- readonly Rensai: 1;
699
- /** 短編 */
700
- readonly Tanpen: 2;
701
- };
702
- type NovelType = typeof NovelType[keyof typeof NovelType];
703
- /**
704
- * endの値ヘルパー
705
- */
706
- declare const End: {
707
- /** 短編小説と完結済小説 */
708
- readonly KanketsuOrTanpen: 0;
709
- /** 連載中 */
710
- readonly Rensai: 1;
711
- };
712
- type End = typeof End[keyof typeof End];
713
- type SearchResultFields<T extends Fields> = {
714
- [K in keyof typeof Fields]: typeof Fields[K] extends T ? K : never;
715
- }[keyof typeof Fields];
716
- type SearchResultOptionalFields<T extends OptionalFields> = {
717
- [K in keyof typeof OptionalFields]: typeof OptionalFields[K] extends T ? K : never;
718
- }[keyof typeof OptionalFields];
719
- type SearchResultR18Fields<T extends R18Fields> = {
720
- [K in keyof typeof R18Fields]: typeof R18Fields[K] extends T ? K : never;
721
- }[keyof typeof R18Fields];
722
- type UserSearchResultFields<T extends UserFields> = {
723
- [K in keyof typeof UserFields]: typeof UserFields[K] extends T ? K : never;
724
- }[keyof typeof UserFields];
725
- type PickedNarouSearchResult<T extends keyof NarouSearchResult> = Pick<NarouSearchResult, T>;
726
-
727
- export { BooleanNumber as B, DateParam as D, End as E, Fields as F, Genre as G, NarouSearchResults as N, OptionalFields as O, type ParamsBase as P, RankingType as R, type SearchParams as S, type UserSearchParams as U, type ParamsBaseWithOrder as a, type RankingParams as b, type RankingHistoryParams as c, type SearchResultFieldNames as d, R18Fields as e, UserFields as f, Order as g, R18Site as h, R18SiteNotation as i, BigGenre as j, BigGenreNotation as k, GenreNotation as l, BuntaiParam as m, StopParam as n, NovelTypeParam as o, UserOrder as p, type GzipLevel as q, type NarouSearchResult as r, type UserSearchResult as s, NovelType as t, type SearchResultFields as u, type SearchResultOptionalFields as v, type SearchResultR18Fields as w, type UserSearchResultFields as x, type PickedNarouSearchResult as y };