@book000/pixivts 0.55.1 → 0.56.1

package/dist/pixiv.d.ts

@@ -1,317 +0,0 @@
-import qs from 'qs';
-import { IllustDetailOptions, SearchIllustOptions, RecommendedIllustOptions, IllustBookmarkAddOptions, NovelDetailOptions, SearchNovelOptions, RecommendedNovelOptions, NovelSeriesOptions, UserDetailOptions, IllustSeriesOptions, NovelTextOptions, MangaRecommendedOptions, IllustBookmarkDeleteOptions, NovelBookmarkAddOptions, NovelBookmarkDeleteOptions, UserBookmarksIllustOptions, UserBookmarksNovelOptions, UgoiraDetailOptions, IllustRelatedOptions, NovelRelatedOptions, IllustRankingOptions, NovelRankingOptions, UserFollowingOptions, UserFollowAddOptions, UserFollowDeleteOptions, UserIllustsOptions, UserNovelsOptions } from './options';
-import { PixivApiResponse, PixivHttpClient, PixivRateLimitRetryOptions } from './http-client';
-import { PixivApiError } from './types/error-response';
-import { GetV1IllustDetailResponse } from './types/endpoints/v1/illust/detail';
-import { GetV1SearchIllustResponse } from './types/endpoints/v1/search/illust';
-import { GetV1IllustRecommendedResponse } from './types/endpoints/v1/illust/recommended';
-import { PostV2IllustBookmarkAddResponse } from './types/endpoints/v2/illust/bookmark/add';
-import { GetV1IllustSeriesResponse } from './types/endpoints/v1/illust/series';
-import { GetV2NovelDetailResponse } from './types/endpoints/v2/novel/detail';
-import { GetV1SearchNovelResponse } from './types/endpoints/v1/search/novel';
-import { GetV1NovelRecommendedResponse } from './types/endpoints/v1/novel/recommended';
-import { GetV2NovelSeriesResponse } from './types/endpoints/v2/novel/series';
-import { GetV1UserDetailResponse } from './types/endpoints/v1/user/detail';
-import { GetV1MangaRecommendedResponse } from './types/endpoints/v1/manga/recommended';
-import { PostV1IllustBookmarkDeleteResponse } from './types/endpoints/v1/illust/bookmark/delete';
-import { PostV2NovelBookmarkAddResponse } from './types/endpoints/v2/novel/bookmark/add';
-import { PostV1NovelBookmarkDeleteResponse } from './types/endpoints/v1/novel/bookmark/delete';
-import { GetV1UserBookmarksNovelResponse } from './types/endpoints/v1/user/bookmarks/novel';
-import { GetV1UserBookmarksIllustResponse } from './types/endpoints/v1/user/bookmarks/illust';
-import { GetV1IllustUgoiraMetadataResponse } from './types/endpoints/v1/illust/ugoira/metadata';
-import { ResponseDatabase, ResponseDatabaseOptions } from './saving-responses';
-import { GetV2IllustRelatedResponse } from './types/endpoints/v2/illust/related';
-import { GetV1NovelRelatedResponse } from './types/endpoints/v1/novel/related';
-import { GetV1IllustRankingResponse } from './types/endpoints/v1/illust/ranking';
-import { GetV1NovelRankingResponse } from './types/endpoints/v1/novel/ranking';
-import { GetV1UserFollowingResponse } from './types/endpoints/v1/user/following';
-import { PostV1UserFollowAddResponse } from './types/endpoints/v1/user/follow/add';
-import { PostV1UserFollowDeleteResponse } from './types/endpoints/v1/user/follow/delete';
-import { GetV1UserIllustsResponse } from './types/endpoints/v1/user/illusts';
-import { GetV1UserNovelsResponse } from './types/endpoints/v1/user/novels';
-export interface PixivDebugOutputResponseOptions {
-    enable: boolean;
-    db?: ResponseDatabaseOptions;
-}
-export interface PixivDebugOptions {
-    outputResponse?: PixivDebugOutputResponseOptions;
-}
-export interface PixivTsOptions {
-    debugOptions?: PixivDebugOptions;
-    rateLimitRetryOptions?: PixivRateLimitRetryOptions;
-}
-/**
- * pixiv API
- */
-export default class Pixiv {
-    private static clientId;
-    private static clientSecret;
-    private static hashSecret;
-    private hosts;
-    readonly userId: string;
-    readonly accessToken: string;
-    readonly refreshToken: string;
-    readonly responseDatabase: ResponseDatabase | null;
-    readonly rateLimitRetryOptions: PixivRateLimitRetryOptions | null;
-    readonly http: PixivHttpClient;
-    /**
-     * Constructor. Cannot be instantiated externally; use the `of` method instead.
-     *
-     * @param userId User ID
-     * @param accessToken Access token
-     * @param refreshToken Refresh token
-     * @param responseDatabase Database for saving responses (null if not used)
-     * @param rateLimitRetryOptions Retry settings for 429 errors
-     */
-    private constructor();
-    /**
-     * Creates an instance from a refresh token.
-     *
-     * @param refreshToken Refresh token
-     * @returns Pixiv instance
-     */
-    static of(refreshToken: string, pixivTsOptions?: PixivTsOptions): Promise<Pixiv>;
-    /**
-     * Returns a `Response` for fetching an image.
-     *
-     * The return value is a `Response` object, not the stream itself;
-     * to read it as a stream, refer to `response.body`.
-     * Other `Response` APIs such as `arrayBuffer()` can also be used as needed.
-     *
-     * @param url Image URL
-     * @returns The `Response` from fetching the image
-     */
-    static getImageStream(url: string): Promise<Response>;
-    /**
-     * Gets the details of an illust.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustDetail(options: IllustDetailOptions): Promise<PixivApiResponse<GetV1IllustDetailResponse>>;
-    /**
-     * Gets illusts related to an illust.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustRelated(options: IllustRelatedOptions): Promise<PixivApiResponse<GetV2IllustRelatedResponse>>;
-    /**
-     * Searches for illusts.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    searchIllust(options: SearchIllustOptions): Promise<PixivApiResponse<GetV1SearchIllustResponse>>;
-    /**
-     * Gets the illust ranking.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustRanking(options?: IllustRankingOptions): Promise<PixivApiResponse<GetV1IllustRankingResponse>>;
-    /**
-     * Gets recommended illusts.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustRecommended(options?: RecommendedIllustOptions): Promise<PixivApiResponse<GetV1IllustRecommendedResponse>>;
-    /**
-     * Gets the details of an illust series.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustSeries(options: IllustSeriesOptions): Promise<PixivApiResponse<GetV1IllustSeriesResponse>>;
-    /**
-     * Bookmarks an illust.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustBookmarkAdd(options: IllustBookmarkAddOptions): Promise<PixivApiResponse<PostV2IllustBookmarkAddResponse>>;
-    /**
-     * Removes an illust bookmark.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    illustBookmarkDelete(options: IllustBookmarkDeleteOptions): Promise<PixivApiResponse<PostV1IllustBookmarkDeleteResponse>>;
-    mangaRecommended(options?: MangaRecommendedOptions): Promise<PixivApiResponse<GetV1MangaRecommendedResponse>>;
-    /**
-     * Gets the details of an ugoira.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    ugoiraMetadata(options: UgoiraDetailOptions): Promise<PixivApiResponse<GetV1IllustUgoiraMetadataResponse>>;
-    /**
-     * Gets the details of a novel.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelDetail(options: NovelDetailOptions): Promise<PixivApiResponse<GetV2NovelDetailResponse>>;
-    /**
-     * Gets the text of a novel.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelText(options: NovelTextOptions): Promise<PixivApiResponse<string>>;
-    /**
-     * Gets novels related to a novel.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelRelated(options: NovelRelatedOptions): Promise<PixivApiResponse<GetV1NovelRelatedResponse>>;
-    /**
-     * Searches for novels.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    searchNovel(options: SearchNovelOptions): Promise<PixivApiResponse<GetV1SearchNovelResponse>>;
-    /**
-     * Gets the novel ranking.
-     */
-    novelRanking(options?: NovelRankingOptions): Promise<PixivApiResponse<GetV1NovelRankingResponse>>;
-    /**
-     * Gets recommended novels.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelRecommended(options?: RecommendedNovelOptions): Promise<PixivApiResponse<GetV1NovelRecommendedResponse>>;
-    /**
-     * Gets the details of a novel series.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelSeries(options: NovelSeriesOptions): Promise<PixivApiResponse<GetV2NovelSeriesResponse>>;
-    /**
-     * Bookmarks a novel.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelBookmarkAdd(options: NovelBookmarkAddOptions): Promise<PixivApiResponse<PostV2NovelBookmarkAddResponse>>;
-    /**
-     * Removes a novel bookmark.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    novelBookmarkDelete(options: NovelBookmarkDeleteOptions): Promise<PixivApiResponse<PostV1NovelBookmarkDeleteResponse>>;
-    /**
-     * Gets the details of a user.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userDetail(options: UserDetailOptions): Promise<PixivApiResponse<GetV1UserDetailResponse>>;
-    /**
-     * Gets a user's illusts or manga.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userIllusts(options: UserIllustsOptions): Promise<PixivApiResponse<GetV1UserIllustsResponse>>;
-    /**
-     * Gets a user's novels.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userNovels(options: UserNovelsOptions): Promise<PixivApiResponse<GetV1UserNovelsResponse>>;
-    /**
-     * Gets a user's illust bookmarks.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userBookmarksIllust(options: UserBookmarksIllustOptions): Promise<PixivApiResponse<GetV1UserBookmarksIllustResponse>>;
-    /**
-     * Gets a user's novel bookmarks.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userBookmarksNovel(options: UserBookmarksNovelOptions): Promise<PixivApiResponse<GetV1UserBookmarksNovelResponse>>;
-    /**
-     * Gets the list of users a user is following.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userFollowing(options: UserFollowingOptions): Promise<PixivApiResponse<GetV1UserFollowingResponse>>;
-    /**
-     * Follows a user.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userFollowAdd(options: UserFollowAddOptions): Promise<PixivApiResponse<PostV1UserFollowAddResponse>>;
-    /**
-     * Unfollows a user.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    userFollowDelete(options: UserFollowDeleteOptions): Promise<PixivApiResponse<PostV1UserFollowDeleteResponse>>;
-    /**
-     * Closes the connection.
-     */
-    close(): Promise<void>;
-    /**
-     * Parses a query string.
-     *
-     * @param url URL
-     * @returns The parsed query string object
-     */
-    static parseQueryString(url: string): qs.ParsedQs;
-    /**
-     * Determines whether the response is an error.
-     *
-     * @param response Axios response
-     * @returns Whether it is an error
-     */
-    static isError(response: any): response is PixivApiError;
-    /**
-     * Generates an MD5 hash.
-     *
-     * @param str String
-     * @returns Hash
-     */
-    private static hash;
-    /**
-     * Sends a request.
-     *
-     * The order of generics is T: request, U: response.
-     *
-     * @param options Options
-     * @returns Response
-     */
-    private request;
-    private saveResponse;
-    private isJSON;
-    /**
-     * Checks whether the required options are included.
-     *
-     * @param options Options
-     * @param required Required option keys
-     * @throws If a required option is missing
-     */
-    private checkRequiredOptions;
-    /**
-     * Converts camelCase object keys to snake_case object keys.
-     *
-     * @param object Object
-     * @returns The converted object
-     */
-    private convertCamelToSnake;
-}
-//# sourceMappingURL=pixiv.d.ts.map

package/dist/pixiv.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pixiv.d.ts","sourceRoot":"","sources":["../src/pixiv.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAEL,mBAAmB,EACnB,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAKhB,uBAAuB,EACvB,2BAA2B,EAC3B,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EAEpB,mBAAmB,EAEnB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,0BAA0B,EAC3B,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AACtD,OAAO,EAEL,yBAAyB,EAC1B,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAEL,yBAAyB,EAC1B,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAEL,8BAA8B,EAC/B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAEL,+BAA+B,EAChC,MAAM,0CAA0C,CAAA;AACjD,OAAO,EAEL,yBAAyB,EAC1B,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAEL,wBAAwB,EACzB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAEL,wBAAwB,EACzB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAEL,6BAA6B,EAC9B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAEL,wBAAwB,EACzB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAEL,uBAAuB,EACxB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAEL,6BAA6B,EAC9B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAEL,kCAAkC,EACnC,MAAM,6CAA6C,CAAA;AACpD,OAAO,EAEL,8BAA8B,EAC/B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAEL,iCAAiC,EAClC,MAAM,4CAA4C,CAAA;AACnD,OAAO,EAEL,+BAA+B,EAChC,MAAM,2CAA2C,CAAA;AAClD,OAAO,EAEL,gCAAgC,EACjC,MAAM,4CAA4C,CAAA;AACnD,OAAO,EAEL,iCAAiC,EAClC,MAAM,6CAA6C,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAA;AAC9E,OAAO,EAEL,0BAA0B,EAC3B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAEL,yBAAyB,EAC1B,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAEL,0BAA0B,EAC3B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAEL,yBAAyB,EAC1B,MAAM,oCAAoC,CAAA;AAK3C,OAAO,EAEL,0BAA0B,EAC3B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAEL,2BAA2B,EAC5B,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAEL,8BAA8B,EAC/B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAEL,wBAAwB,EACzB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAEL,uBAAuB,EACxB,MAAM,kCAAkC,CAAA;AAgBzC,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,OAAO,CAAA;IAEf,EAAE,CAAC,EAAE,uBAAuB,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,+BAA+B,CAAA;CACjD;AAED,MAAM,WAAW,cAAc;IAC7B,YAAY,CAAC,EAAE,iBAAiB,CAAA;IAChC,qBAAqB,CAAC,EAAE,0BAA0B,CAAA;CACnD;AAED;;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,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAClD,QAAQ,CAAC,qBAAqB,EAAE,0BAA0B,GAAG,IAAI,CAAA;IACjE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAE9B;;;;;;;;OAQG;IACH,OAAO;IA2BP;;;;;OAKG;WACiB,EAAE,CACpB,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,cAAc;IAqEjC;;;;;;;;;OASG;WACiB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYlE;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IActD;;;;;OAKG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB;IAmBxD;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IA2BtD;;;;;OAKG;IACU,aAAa,CAAC,OAAO,GAAE,oBAAyB;IAiB7D;;;;;OAKG;IACU,iBAAiB,CAAC,OAAO,GAAE,wBAA6B;IAwBrE;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAiBtD;;;;;OAKG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB;IAiBhE;;;;;OAKG;IACU,oBAAoB,CAAC,OAAO,EAAE,2BAA2B;IAiBzD,gBAAgB,CAAC,OAAO,GAAE,uBAA4B;IAoBnE;;;;;OAKG;IACU,cAAc,CAAC,OAAO,EAAE,mBAAmB;IAgBxD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAepD;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,gBAAgB;IAehD;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAkBtD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IA0BpD;;OAEG;IACU,YAAY,CAAC,OAAO,GAAE,mBAAwB;IAgB3D;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,GAAE,uBAA4B;IAsBnE;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAiBpD;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB;IAiB9D;;;;;OAKG;IACU,mBAAmB,CAAC,OAAO,EAAE,0BAA0B;IAiBpE;;;;;OAKG;IACU,UAAU,CAAC,OAAO,EAAE,iBAAiB;IAgBlD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAkBpD;;;;;OAKG;IACU,UAAU,CAAC,OAAO,EAAE,iBAAiB;IAiBlD;;;;;OAKG;IACU,mBAAmB,CAAC,OAAO,EAAE,0BAA0B;IAmBpE;;;;;OAKG;IACU,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;IAkBlE;;;;;OAKG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB;IAiBxD;;;;;OAKG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB;IAgBxD;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB;IAiB9D;;OAEG;IACU,KAAK;IAQlB;;;;;OAKG;WACW,gBAAgB,CAAC,GAAG,EAAE,MAAM;IAS1C;;;;;OAKG;WACW,OAAO,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI,aAAa;IAa/D;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAKnB;;;;;;;OAOG;YACW,OAAO;YAyBP,YAAY;IAuC1B,OAAO,CAAC,MAAM;IAYd;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAW5B;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;CAW5B"}