@book000/pixivts 0.2.2 → 0.4.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './types/endpoints/illust/bookmark/add';
 export * from './types/endpoints/illust/detail';
 export * from './types/endpoints/illust/recommended';
+export * from './types/endpoints/illust/series';
 export * from './types/endpoints/novel/detail';
 export * from './types/endpoints/novel/recommended';
 export * from './types/endpoints/novel/series';
@@ -8,6 +9,7 @@ export * from './types/endpoints/search/illust';
 export * from './types/endpoints/search/novel';
 export * from './types/endpoints/user/detail';
 export * from './types/pixiv-common';
+export * from './types/pixiv-illust-series';
 export * from './types/pixiv-illust';
 export * from './types/pixiv-novel-series';
 export * from './types/pixiv-novel';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAA;AACrD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,sCAAsC,CAAA;AACpD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,qCAAqC,CAAA;AACnD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAA;AACrD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,sCAAsC,CAAA;AACpD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,qCAAqC,CAAA;AACnD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -21,6 +21,7 @@ exports.Pixiv = void 0;
 __exportStar(require("./types/endpoints/illust/bookmark/add"), exports);
 __exportStar(require("./types/endpoints/illust/detail"), exports);
 __exportStar(require("./types/endpoints/illust/recommended"), exports);
+__exportStar(require("./types/endpoints/illust/series"), exports);
 __exportStar(require("./types/endpoints/novel/detail"), exports);
 __exportStar(require("./types/endpoints/novel/recommended"), exports);
 __exportStar(require("./types/endpoints/novel/series"), exports);
@@ -28,6 +29,7 @@ __exportStar(require("./types/endpoints/search/illust"), exports);
 __exportStar(require("./types/endpoints/search/novel"), exports);
 __exportStar(require("./types/endpoints/user/detail"), exports);
 __exportStar(require("./types/pixiv-common"), exports);
+__exportStar(require("./types/pixiv-illust-series"), exports);
 __exportStar(require("./types/pixiv-illust"), exports);
 __exportStar(require("./types/pixiv-novel-series"), exports);
 __exportStar(require("./types/pixiv-novel"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,wEAAqD;AACrD,kEAA+C;AAC/C,uEAAoD;AACpD,iEAA8C;AAC9C,sEAAmD;AACnD,iEAA8C;AAC9C,kEAA+C;AAC/C,iEAA8C;AAC9C,gEAA6C;AAC7C,uDAAoC;AACpC,uDAAoC;AACpC,6DAA0C;AAC1C,sDAAmC;AACnC,qDAAkC;AAClC,4CAAyB;AACzB,iCAA0C;AAAjC,+GAAA,OAAO,OAAS"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,wEAAqD;AACrD,kEAA+C;AAC/C,uEAAoD;AACpD,kEAA+C;AAC/C,iEAA8C;AAC9C,sEAAmD;AACnD,iEAA8C;AAC9C,kEAA+C;AAC/C,iEAA8C;AAC9C,gEAA6C;AAC7C,uDAAoC;AACpC,8DAA2C;AAC3C,uDAAoC;AACpC,6DAA0C;AAC1C,sDAAmC;AACnC,qDAAkC;AAClC,4CAAyB;AACzB,iCAA0C;AAAjC,+GAAA,OAAO,OAAS"}

package/dist/options.d.ts

@@ -1,68 +1,244 @@
+/** 検索対象 */
 export type SearchTargets = 'partial_match_for_tags' | 'exact_match_for_tags' | 'title_and_caption' | 'keyword';
+/** ソート */
 export type SearchSorts = 'date_desc' | 'date_asc' | 'popular_desc';
+/** 対象期間 */
 export type SearchIllustDurations = 'within_last_day' | 'within_last_week' | 'within_last_month';
+/** OSフィルタ */
 export type Filters = 'for_ios' | 'for_android';
+/** コンテンツタイプ */
 export type ContentType = 'illust' | 'manga';
+/** 公開範囲 */
 export type BookmarkRestrict = 'public' | 'private';
+/**
+ * イラスト検索オプション
+ */
 export interface SearchIllustOptions {
+    /**
+     * 検索ワード
+     */
     word: string;
+    /**
+     * 検索対象
+     */
     searchTarget?: SearchTargets;
+    /**
+     * ソート順
+     */
     sort?: SearchSorts;
+    /**
+     * 対象期間
+     */
     duration?: SearchIllustDurations;
+    /**
+     * 開始日時
+     */
     startDate?: string;
+    /**
+     * 終了日時
+     */
     endDate?: string;
+    /**
+     * OSフィルタ
+     */
     filter?: Filters;
+    /**
+     * オフセット
+     */
     offset?: number;
 }
-export interface GetIllustDetailOptions {
+/**
+ * イラスト詳細取得オプション
+ */
+export interface IllustDetailOptions {
+    /**
+     * イラストID
+     */
     illustId: number;
 }
+/**
+ * おすすめイラスト取得オプション
+ */
 export interface RecommendedIllustOptions {
+    /**
+     * コンテンツタイプ (illust or manga)
+     */
     contentType: ContentType;
+    /**
+     * ランキングラベルを含めるか
+     */
     includeRankingLabel?: boolean;
+    /**
+     * OSフィルタ
+     */
     filter?: Filters;
+    /**
+     * おすすめイラストの最大ブックマークID (?)
+     */
     maxBookmarkIdForRecommend?: number;
+    /**
+     * 最近のイラストの最小ブックマークID (?)
+     */
     minBookmarkIdForRecentIllust?: number;
+    /**
+     * オフセット
+     */
     offset?: number;
+    /**
+     * ランキングイラストを含めるか (?)
+     */
     includeRankingIllusts?: boolean;
+    /**
+     * ブックマーク済みのイラストID
+     */
     bookmarkIllustIds?: number[];
+    /**
+     * プライバシーポリシーを含めるか (?)
+     */
     includePrivacyPolicy?: boolean;
 }
+/**
+ * イラストブックマーク追加オプション
+ */
 export interface IllustBookmarkAddOptions {
+    /**
+     * イラストID
+     */
     illustId: number;
+    /**
+     * 公開範囲
+     */
     restrict?: BookmarkRestrict;
+    /**
+     * タグ
+     */
     tags?: string[];
 }
-export interface GetNovelDetailOptions {
+export interface IllustSeriesOptions {
+    /**
+     * イラストシリーズID
+     */
+    illustSeriesId: number;
+    /**
+     * OSフィルタ
+     */
+    filter?: Filters;
+    /**
+     * オフセット
+     */
+    offset?: number;
+}
+/**
+ * 小説詳細取得オプション
+ */
+export interface NovelDetailOptions {
+    /**
+     * 小説ID
+     */
     novelId: number;
 }
+/**
+ * 小説検索オプション
+ */
 export interface SearchNovelOptions {
+    /**
+     * 検索ワード
+     */
     word: string;
+    /**
+     * 検索対象
+     */
     searchTarget?: SearchTargets;
+    /**
+     * ソート順
+     */
     sort?: SearchSorts;
+    /**
+     * プレーンキーワード検索結果をマージするか (?)
+     */
     mergePlainKeywordResults?: boolean;
+    /**
+     * 翻訳タグ検索結果を含むか
+     */
     includeTranslatedTagResults?: boolean;
+    /**
+     * 開始日時
+     */
     startDate?: string;
+    /**
+     * 終了日時
+     */
     endDate?: string;
+    /**
+     * OSフィルタ
+     */
     filter?: Filters;
+    /**
+     * オフセット
+     */
     offset?: number;
 }
+/**
+ * おすすめ小説取得オプション
+ */
 export interface RecommendedNovelOptions {
+    /**
+     * ランキングラベルを含めるか
+     */
     includeRankingLabel?: boolean;
+    /**
+     * OSフィルタ
+     */
     filter?: Filters;
+    /**
+     * オフセット
+     */
     offset?: number;
+    /**
+     * ランキング小説を含めるか (?)
+     */
     includeRankingNovels?: boolean;
+    /**
+     * おすすめ済みの小説ID
+     */
     alreadyRecommended?: number[];
+    /**
+     * おすすめ小説の最大ブックマークID (?)
+     */
     maxBookmarkIdForRecommend?: number;
+    /**
+     * プライバシーポリシーを含めるか (?)
+     */
     includePrivacyPolicy?: boolean;
 }
-export interface GetNovelSeriesOptions {
+/**
+ * 小説シリーズ詳細取得オプション
+ */
+export interface NovelSeriesOptions {
+    /**
+     * 小説シリーズID
+     */
     seriesId: number;
+    /**
+     * OSフィルタ
+     */
     filter?: Filters;
+    /**
+     * (?)
+     */
     lastOrder?: string;
 }
-export interface GetUserDetailOptions {
+/**
+ * ユーザー詳細取得オプション
+ */
+export interface UserDetailOptions {
+    /**
+     * ユーザーID
+     */
     userId: number;
+    /**
+     * OSフィルタ
+     */
     filter?: Filters;
 }
 //# sourceMappingURL=options.d.ts.map

package/dist/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,aAAa,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,mBAAmB,GACnB,SAAS,CAAA;AAEb,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,CAAA;AAEnE,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,CAAA;AAEvB,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,aAAa,CAAA;AAE/C,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE5C,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAKnD,MAAM,WAAW,mBAAmB;IAIlC,IAAI,EAAE,MAAM,CAAA;IAKZ,YAAY,CAAC,EAAE,aAAa,CAAA;IAK5B,IAAI,CAAC,EAAE,WAAW,CAAA;IAKlB,QAAQ,CAAC,EAAE,qBAAqB,CAAA;IAKhC,SAAS,CAAC,EAAE,MAAM,CAAA;IAKlB,OAAO,CAAC,EAAE,MAAM,CAAA;IAKhB,MAAM,CAAC,EAAE,OAAO,CAAA;IAKhB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAKD,MAAM,WAAW,sBAAsB;IAIrC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAKD,MAAM,WAAW,wBAAwB;IAIvC,WAAW,EAAE,WAAW,CAAA;IAKxB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAK7B,MAAM,CAAC,EAAE,OAAO,CAAA;IAKhB,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAKlC,4BAA4B,CAAC,EAAE,MAAM,CAAA;IAKrC,MAAM,CAAC,EAAE,MAAM,CAAA;IAKf,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAK/B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAK5B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAM/B;AAKD,MAAM,WAAW,wBAAwB;IAIvC,QAAQ,EAAE,MAAM,CAAA;IAKhB,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAK3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAKD,MAAM,WAAW,qBAAqB;IAIpC,OAAO,EAAE,MAAM,CAAA;CAChB;AAKD,MAAM,WAAW,kBAAkB;IAIjC,IAAI,EAAE,MAAM,CAAA;IAKZ,YAAY,CAAC,EAAE,aAAa,CAAA;IAK5B,IAAI,CAAC,EAAE,WAAW,CAAA;IAKlB,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAKlC,2BAA2B,CAAC,EAAE,OAAO,CAAA;IAKrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAKlB,OAAO,CAAC,EAAE,MAAM,CAAA;IAKhB,MAAM,CAAC,EAAE,OAAO,CAAA;IAKhB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAKD,MAAM,WAAW,uBAAuB;IAItC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAK7B,MAAM,CAAC,EAAE,OAAO,CAAA;IAKhB,MAAM,CAAC,EAAE,MAAM,CAAA;IAKf,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAK9B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAK7B,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAKlC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAKD,MAAM,WAAW,qBAAqB;IAIpC,QAAQ,EAAE,MAAM,CAAA;IAKhB,MAAM,CAAC,EAAE,OAAO,CAAA;IAKhB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAKD,MAAM,WAAW,oBAAoB;IAInC,MAAM,EAAE,MAAM,CAAA;IAKd,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,MAAM,MAAM,aAAa,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,mBAAmB,GACnB,SAAS,CAAA;AACb,UAAU;AACV,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,CAAA;AACnE,WAAW;AACX,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,CAAA;AACvB,aAAa;AACb,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,aAAa,CAAA;AAC/C,eAAe;AACf,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAA;AAC5C,WAAW;AACX,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,aAAa,CAAA;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,qBAAqB,CAAA;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAElC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAA;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAM/B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,aAAa,CAAA;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAA;IAElB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAElC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAA;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE7B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAElC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB"}

package/dist/pixiv.d.ts

@@ -2,15 +2,18 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
 import { ReadStream } from 'node:fs';
 import qs from 'qs';
-import { GetIllustDetailOptions, SearchIllustOptions, RecommendedIllustOptions, IllustBookmarkAddOptions, GetNovelDetailOptions, SearchNovelOptions, RecommendedNovelOptions, GetNovelSeriesOptions, GetUserDetailOptions } from './options';
-import { IllustBookmarkAddApiResponse } from './types/endpoints/illust/bookmark/add';
-import { GetIllustDetailApiResponse } from './types/endpoints/illust/detail';
-import { RecommendedIllustApiResponse } from './types/endpoints/illust/recommended';
-import { GetNovelDetailApiResponse } from './types/endpoints/novel/detail';
-import { RecommendedNovelApiResponse } from './types/endpoints/novel/recommended';
-import { SearchIllustApiResponse } from './types/endpoints/search/illust';
-import { SearchNovelApiResponse } from './types/endpoints/search/novel';
-import { GetUserDetailApiResponse } from './types/endpoints/user/detail';
+import { IllustDetailOptions, SearchIllustOptions, RecommendedIllustOptions, IllustBookmarkAddOptions, NovelDetailOptions, SearchNovelOptions, RecommendedNovelOptions, NovelSeriesOptions, UserDetailOptions, IllustSeriesOptions } from './options';
+import { PostV2IllustBookmarkAddResponse } from './types/endpoints/illust/bookmark/add';
+import { GetV1IllustDetailResponse } from './types/endpoints/illust/detail';
+import { GetV1RecommendedIllustResponse } from './types/endpoints/illust/recommended';
+import { GetV2NovelDetailResponse } from './types/endpoints/novel/detail';
+import { GetV1RecommendedNovelResponse } from './types/endpoints/novel/recommended';
+import { GetV1SearchIllustResponse } from './types/endpoints/search/illust';
+import { GetV1SearchNovelResponse } from './types/endpoints/search/novel';
+import { GetV1UserDetailResponse } from './types/endpoints/user/detail';
+/**
+ * pixiv API
+ */
 export default class Pixiv {
     private static clientId;
     private static clientSecret;
@@ -20,20 +23,112 @@ export default class Pixiv {
     readonly accessToken: string;
     readonly refreshToken: string;
     readonly axios: AxiosInstance;
+    /**
+     * コンストラクタ。外部からインスタンス化できないので、of メソッドを使うこと。
+     *
+     * @param userId ユーザー ID
+     * @param accessToken アクセストークン
+     * @param refreshToken リフレッシュトークン
+     */
     private constructor();
+    /**
+     * リフレッシュトークンからインスタンスを生成する。
+     *
+     * @param refreshToken リフレッシュトークン
+     * @returns Pixiv インスタンス
+     */
     static of(refreshToken: string): Promise<Pixiv>;
     static getAxiosImageStream(url: string): Promise<AxiosResponse<ReadStream, any>>;
-    getIllustDetail(options: GetIllustDetailOptions): Promise<AxiosResponse<GetIllustDetailApiResponse, any>>;
-    searchIllust(options: SearchIllustOptions): Promise<AxiosResponse<SearchIllustApiResponse, any>>;
-    recommendedIllust(options: RecommendedIllustOptions): Promise<AxiosResponse<RecommendedIllustApiResponse, any>>;
-    illustBookmarkAdd(options: IllustBookmarkAddOptions): Promise<AxiosResponse<IllustBookmarkAddApiResponse, any>>;
-    getNovelDetail(options: GetNovelDetailOptions): Promise<AxiosResponse<GetNovelDetailApiResponse, any>>;
-    searchNovel(options: SearchNovelOptions): Promise<AxiosResponse<SearchNovelApiResponse, any>>;
-    recommendedNovel(options?: RecommendedNovelOptions): Promise<AxiosResponse<RecommendedNovelApiResponse, any>>;
-    getNovelSeries(options: GetNovelSeriesOptions): Promise<AxiosResponse<import(".").PixivNovelSeriesItem, any>>;
-    getUserDetail(options: GetUserDetailOptions): Promise<AxiosResponse<GetUserDetailApiResponse, any>>;
+    /**
+     * イラストの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    getIllustDetail(options: IllustDetailOptions): Promise<AxiosResponse<GetV1IllustDetailResponse, any>>;
+    /**
+     * イラストを検索する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    searchIllust(options: SearchIllustOptions): Promise<AxiosResponse<GetV1SearchIllustResponse, any>>;
+    /**
+     * おすすめイラストを取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    recommendedIllust(options: RecommendedIllustOptions): Promise<AxiosResponse<GetV1RecommendedIllustResponse, any>>;
+    /**
+     * イラストをブックマークする。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    illustBookmarkAdd(options: IllustBookmarkAddOptions): Promise<AxiosResponse<PostV2IllustBookmarkAddResponse, any>>;
+    /**
+     * イラストシリーズの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    illustSeries(options: IllustSeriesOptions): Promise<AxiosResponse<import(".").PixivNovelSeriesItem, any>>;
+    /**
+     * 小説の詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    novelDetail(options: NovelDetailOptions): Promise<AxiosResponse<GetV2NovelDetailResponse, any>>;
+    /**
+     * 小説を検索する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    searchNovel(options: SearchNovelOptions): Promise<AxiosResponse<GetV1SearchNovelResponse, any>>;
+    /**
+     * おすすめ小説を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    recommendedNovel(options?: RecommendedNovelOptions): Promise<AxiosResponse<GetV1RecommendedNovelResponse, any>>;
+    /**
+     * 小説シリーズの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    novelSeries(options: NovelSeriesOptions): Promise<AxiosResponse<import(".").PixivNovelSeriesItem, any>>;
+    /**
+     * ユーザーの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    userDetail(options: UserDetailOptions): Promise<AxiosResponse<GetV1UserDetailResponse, any>>;
+    /**
+     * クエリストリングをパースする。
+     *
+     * @param url URL
+     * @returns パースしたクエリストリングオブジェクト
+     */
     static parseQueryString(url: string): qs.ParsedQs;
+    /**
+     * MD5ハッシュを生成する。
+     *
+     * @param str 文字列
+     * @returns ハッシュ
+     */
     private static hash;
+    /**
+     * リクエストを送信する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     private request;
 }
 //# sourceMappingURL=pixiv.d.ts.map

package/dist/pixiv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pixiv.d.ts","sourceRoot":"","sources":["../src/pixiv.ts"],"names":[],"mappings":";AACA,OAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAA;AACpF,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AAEjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAA;AAYxE,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiC;IACxD,OAAO,CAAC,MAAM,CAAC,YAAY,CAA6C;IACxE,OAAO,CAAC,MAAM,CAAC,UAAU,CAC2C;IAEpE,OAAO,CAAC,KAAK,CAA8B;IAE3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAS7B,OAAO;WA4Ba,EAAE,CAAC,YAAY,EAAE,MAAM;WA2CvB,mBAAmB,CAAC,GAAG,EAAE,MAAM;IAiBtC,eAAe,CAAC,OAAO,EAAE,sBAAsB;IAkB/C,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAyBzC,iBAAiB,CAAC,OAAO,EAAE,wBAAwB;IA8BnD,iBAAiB,CAAC,OAAO,EAAE,wBAAwB;IAoBnD,cAAc,CAAC,OAAO,EAAE,qBAAqB;IAkB7C,WAAW,CAAC,OAAO,EAAE,kBAAkB;IA2BvC,gBAAgB,CAAC,OAAO,GAAE,uBAA4B;IA2BtD,cAAc,CAAC,OAAO,EAAE,qBAAqB;IAoB7C,aAAa,CAAC,OAAO,EAAE,oBAAoB;WAmB1C,gBAAgB,CAAC,GAAG,EAAE,MAAM;IAe1C,OAAO,CAAC,MAAM,CAAC,IAAI;IAWnB,OAAO,CAAC,OAAO;CAahB"}
+{"version":3,"file":"pixiv.d.ts","sourceRoot":"","sources":["../src/pixiv.ts"],"names":[],"mappings":";AACA,OAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAA;AACvF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAA;AAEnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AASvE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiC;IACxD,OAAO,CAAC,MAAM,CAAC,YAAY,CAA6C;IACxE,OAAO,CAAC,MAAM,CAAC,UAAU,CAC2C;IAEpE,OAAO,CAAC,KAAK,CAA8B;IAE3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAE7B;;;;;;OAMG;IACH,OAAO;IAsBP;;;;;OAKG;WACiB,EAAE,CAAC,YAAY,EAAE,MAAM;WA2CvB,mBAAmB,CAAC,GAAG,EAAE,MAAM;IAWnD;;;;;OAKG;IACU,eAAe,CAAC,OAAO,EAAE,mBAAmB;IAYzD;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAmBtD;;;;;OAKG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB;IAwBhE;;;;;OAKG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB;IAchE;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IActD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAYpD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAqBpD;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,GAAE,uBAA4B;IAqBnE;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAcpD;;;;;OAKG;IACU,UAAU,CAAC,OAAO,EAAE,iBAAiB;IAalD;;;;;OAKG;WACW,gBAAgB,CAAC,GAAG,EAAE,MAAM;IAS1C;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAKnB;;;;;OAKG;IACH,OAAO,CAAC,OAAO;CAahB"}

package/dist/pixiv.js

@@ -6,7 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const node_crypto_1 = __importDefault(require("node:crypto"));
 const axios_1 = __importDefault(require("axios"));
 const qs_1 = __importDefault(require("qs"));
+/**
+ * pixiv API
+ */
 class Pixiv {
+    /**
+     * コンストラクタ。外部からインスタンス化できないので、of メソッドを使うこと。
+     *
+     * @param userId ユーザー ID
+     * @param accessToken アクセストークン
+     * @param refreshToken リフレッシュトークン
+     */
     constructor(userId, accessToken, refreshToken) {
         this.hosts = 'https://app-api.pixiv.net';
         this.userId = userId;
@@ -24,7 +34,15 @@ class Pixiv {
             validateStatus: () => true,
         });
     }
+    /**
+     * リフレッシュトークンからインスタンスを生成する。
+     *
+     * @param refreshToken リフレッシュトークン
+     * @returns Pixiv インスタンス
+     */
     static async of(refreshToken) {
+        // @see https://github.com/upbit/pixivpy/blob/master/pixivpy3/api.py#L120
+        // UTCで YYYY-MM-DDTHH:mm:ss+00:00 の形式で現在時刻を取得
         const localTime = new Date().toISOString().replace(/Z$/, '+00:00');
         const headers = {
             'x-client-time': localTime,
@@ -65,6 +83,12 @@ class Pixiv {
             responseType: 'stream',
         });
     }
+    /**
+     * イラストの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     async getIllustDetail(options) {
         const parameters = {
             illust_id: options.illustId,
@@ -75,6 +99,12 @@ class Pixiv {
             params: parameters,
         });
     }
+    /**
+     * イラストを検索する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     async searchIllust(options) {
         const parameters = {
             word: options.word,
@@ -92,6 +122,12 @@ class Pixiv {
             params: parameters,
         });
     }
+    /**
+     * おすすめイラストを取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     async recommendedIllust(options) {
         const parameters = {
             content_type: options.contentType,
@@ -112,6 +148,12 @@ class Pixiv {
             params: parameters,
         });
     }
+    /**
+     * イラストをブックマークする。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     async illustBookmarkAdd(options) {
         const data = {
             illust_id: options.illustId,
@@ -124,7 +166,31 @@ class Pixiv {
             data,
         });
     }
-    async getNovelDetail(options) {
+    /**
+     * イラストシリーズの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    async illustSeries(options) {
+        const parameters = {
+            illust_series_id: options.illustSeriesId,
+            filter: options.filter || 'for_ios',
+            offset: options.offset,
+        };
+        return this.request({
+            method: 'GET',
+            path: '/v1/illust/series',
+            params: parameters,
+        });
+    }
+    /**
+     * 小説の詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    async novelDetail(options) {
         const parameters = {
             novel_id: options.novelId,
         };
@@ -134,6 +200,12 @@ class Pixiv {
             params: parameters,
         });
     }
+    /**
+     * 小説を検索する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     async searchNovel(options) {
         const parameters = {
             word: options.word,
@@ -152,6 +224,12 @@ class Pixiv {
             params: parameters,
         });
     }
+    /**
+     * おすすめ小説を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     async recommendedNovel(options = {}) {
         const parameters = {
             include_ranking_label: options.includeRankingLabel || true,
@@ -170,7 +248,13 @@ class Pixiv {
             params: parameters,
         });
     }
-    async getNovelSeries(options) {
+    /**
+     * 小説シリーズの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    async novelSeries(options) {
         const parameters = {
             series_id: options.seriesId,
             filter: options.filter || 'for_ios',
@@ -182,7 +266,13 @@ class Pixiv {
             params: parameters,
         });
     }
-    async getUserDetail(options) {
+    /**
+     * ユーザーの詳細情報を取得する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
+    async userDetail(options) {
         const parameters = {
             user_id: options.userId,
             filter: options.filter || 'for_ios',
@@ -193,6 +283,12 @@ class Pixiv {
             params: parameters,
         });
     }
+    /**
+     * クエリストリングをパースする。
+     *
+     * @param url URL
+     * @returns パースしたクエリストリングオブジェクト
+     */
     static parseQueryString(url) {
         let query = url;
         if (url.includes('?')) {
@@ -200,10 +296,22 @@ class Pixiv {
         }
         return qs_1.default.parse(query);
     }
+    /**
+     * MD5ハッシュを生成する。
+     *
+     * @param str 文字列
+     * @returns ハッシュ
+     */
     static hash(string_) {
         const hash = node_crypto_1.default.createHash('md5');
         return hash.update(string_ + this.hashSecret).digest('hex');
     }
+    /**
+     * リクエストを送信する。
+     *
+     * @param options オプション
+     * @returns レスポンス
+     */
     request(options) {
         if (options.method === 'GET') {
             return this.axios.get(options.path, { params: options.params });