@book000/pixivts 0.51.2 → 0.52.0

package/dist/types/endpoints/v1/search/illust.d.ts

@@ -2,58 +2,58 @@ import { PixivIllustItem } from '../../../pixiv-illust';
 import { OSFilter, SearchSort, SearchTarget } from '../../../../options';
 import { BaseMultipleCheck, CheckFunctions } from '../../../../checks';
 /**
- * GET /v1/search/illust のリクエスト
+ * Request for GET /v1/search/illust
  */
 export interface GetV1SearchIllustRequest {
     /**
-     * 検索ワード
+     * Search word
      */
     word: string;
     /**
-     * 検索対象
+     * Search target
      *
      * @default 'partial_match_for_tags'
      */
     search_target: SearchTarget;
     /**
-     * ソート順
+     * Sort order
      *
      * @default 'date_desc'
      */
     sort: SearchSort;
     /**
-     * 開始日時
+     * Start date and time
      *
      * @default undefined
      */
     start_date?: string;
     /**
-     * 終了日時
+     * End date and time
      *
      * @default undefined
      */
     end_date?: string;
     /**
-     * OSフィルタ
+     * OS filter
      *
      * @default 'for_ios'
      */
     filter?: OSFilter;
     /**
-     * オフセット
+     * Offset
      *
      * @default undefined
      */
     offset?: number;
     /**
-     * プレーンキーワード検索結果をマージするか (?)
+     * Whether to merge plain keyword search results (?)
      *
      * @default true
      * @beta
      */
     merge_plain_keyword_results: boolean;
     /**
-     * 翻訳タグ検索結果を含むか
+     * Whether to include translated tag search results
      *
      * @default true
      * @beta
@@ -61,23 +61,23 @@ export interface GetV1SearchIllustRequest {
     include_translated_tag_results: boolean;
 }
 /**
- * GET /v1/search/illust のレスポンス
+ * Response for GET /v1/search/illust
  */
 export interface GetV1SearchIllustResponse {
     /**
-     * 検索結果のイラスト群
+     * Search result illusts
      */
     illusts: PixivIllustItem[];
     /**
-     * 次回のリクエストに使用する URL。
+     * URL to use for the next request.
      *
      * @see {Pixiv.parseQueryString}
      */
     next_url: string | null;
     /**
-     * 不明
+     * Unknown
      *
-     * 「31536000」固定？1年間？
+     * Fixed at "31536000"? One year?
      *
      * @beta
      */

package/dist/types/endpoints/v1/search/novel.d.ts

@@ -2,58 +2,58 @@ import { BaseMultipleCheck, CheckFunctions } from '../../../../checks';
 import { OSFilter, SearchSort, SearchTarget } from '../../../../options';
 import { PixivNovelItem } from '../../../pixiv-novel';
 /**
- * GET /v1/search/novel のリクエスト
+ * Request for GET /v1/search/novel
  */
 export interface GetV1SearchNovelRequest {
     /**
-     * 検索ワード
+     * Search word
      */
     word: string;
     /**
-     * 検索対象
+     * Search target
      *
      * @default 'partial_match_for_tags'
      */
     search_target: SearchTarget;
     /**
-     * ソート順
+     * Sort order
      *
      * @default 'date_desc'
      */
     sort: SearchSort;
     /**
-     * 開始日時
+     * Start date and time
      *
      * @default undefined
      */
     start_date?: string;
     /**
-     * 終了日時
+     * End date and time
      *
      * @default undefined
      */
     end_date?: string;
     /**
-     * OSフィルタ
+     * OS filter
      *
      * @default 'for_ios'
      */
     filter?: OSFilter;
     /**
-     * オフセット
+     * Offset
      *
      * @default undefined
      */
     offset?: number;
     /**
-     * プレーンキーワード検索結果をマージするか (?)
+     * Whether to merge plain keyword search results (?)
      *
      * @default true
      * @beta
      */
     merge_plain_keyword_results: boolean;
     /**
-     * 翻訳タグ検索結果を含むか
+     * Whether to include translated tag search results
      *
      * @default true
      * @beta
@@ -61,23 +61,23 @@ export interface GetV1SearchNovelRequest {
     include_translated_tag_results: boolean;
 }
 /**
- * GET /v1/search/novel のレスポンス
+ * Response for GET /v1/search/novel
  */
 export interface GetV1SearchNovelResponse {
     /**
-     * 検索結果の小説群
+     * Search result novels
      */
     novels: PixivNovelItem[];
     /**
-     * 次回のリクエストに使用する URL。
+     * URL to use for the next request.
      *
      * @see {Pixiv.parseQueryString}
      */
     next_url: string | null;
     /**
-     * 不明
+     * Unknown
      *
-     * 「31536000」固定？1年間？
+     * Fixed at "31536000"? One year?
      *
      * @beta
      */

package/dist/types/endpoints/v1/user/bookmarks/illust.d.ts

@@ -2,42 +2,42 @@ import { BaseMultipleCheck, CheckFunctions } from '../../../../../checks';
 import { BookmarkRestrict, OSFilter } from '../../../../../options';
 import { PixivIllustItem } from '../../../../pixiv-illust';
 /**
- * GET /v1/user/bookmarks/illust のリクエスト
+ * Request for GET /v1/user/bookmarks/illust
  */
 export interface GetV1UserBookmarksIllustRequest {
     /**
-     * ユーザーID
+     * User ID
      */
     user_id: number;
     /**
-     * ブックマーク公開範囲
+     * Bookmark visibility
      */
     restrict: BookmarkRestrict;
     /**
-     * ブックマークタグ
+     * Bookmark tag
      */
     tag?: string;
     /**
-     * ブックマークIDの最大値（ページネーション？）
+     * Maximum bookmark ID (pagination?)
      *
      * @beta
      */
     max_bookmark_id?: number;
     /**
-     * OSフィルタ
+     * OS filter
      */
     filter?: OSFilter;
 }
 /**
- * GET /v1/user/bookmarks/illust のレスポンス
+ * Response for GET /v1/user/bookmarks/illust
  */
 export interface GetV1UserBookmarksIllustResponse {
     /**
-     * ブックマークしたイラスト群
+     * Bookmarked illusts
      */
     illusts: PixivIllustItem[];
     /**
-     * 次 URL
+     * Next URL
      */
     next_url: string | null;
 }

package/dist/types/endpoints/v1/user/bookmarks/novel.d.ts

@@ -2,38 +2,38 @@ import { BaseMultipleCheck, CheckFunctions } from '../../../../../checks';
 import { BookmarkRestrict } from '../../../../../options';
 import { PixivNovelItem } from '../../../../pixiv-novel';
 /**
- * GET /v1/user/bookmarks/novel のリクエスト
+ * Request for GET /v1/user/bookmarks/novel
  */
 export interface GetV1UserBookmarksNovelRequest {
     /**
-     * ユーザーID
+     * User ID
      */
     user_id: number;
     /**
-     * ブックマーク公開範囲
+     * Bookmark visibility
      */
     restrict: BookmarkRestrict;
     /**
-     * ブックマークタグ
+     * Bookmark tag
      */
     tag?: string;
     /**
-     * ブックマークIDの最大値（ページネーション？）
+     * Maximum bookmark ID (pagination?)
      *
      * @beta
      */
     max_bookmark_id?: number;
 }
 /**
- * GET /v1/user/bookmarks/novel のレスポンス
+ * Response for GET /v1/user/bookmarks/novel
  */
 export interface GetV1UserBookmarksNovelResponse {
     /**
-     * ブックマークした小説群
+     * Bookmarked novels
      */
     novels: PixivNovelItem[];
     /**
-     * 次 URL
+     * Next URL
      */
     next_url: string | null;
 }

package/dist/types/endpoints/v1/user/detail.d.ts

@@ -2,38 +2,38 @@ import { PixivUserItem, PixivUserProfile, PixivUserProfilePublicity, PixivUserPr
 import { OSFilter } from '../../../../options';
 import { BaseMultipleCheck, CheckFunctions } from '../../../../checks';
 /**
- * GET /v1/user/detail のリクエスト
+ * Request for GET /v1/user/detail
  */
 export interface GetV1UserDetailRequest {
     /**
-     * ユーザーID
+     * User ID
      */
     user_id: number;
     /**
-     * OSフィルタ
+     * OS filter
      *
      * @default 'for_ios'
      */
     filter?: OSFilter;
 }
 /**
- * GET /v1/user/detail のレスポンス
+ * Response for GET /v1/user/detail
  */
 export interface GetV1UserDetailResponse {
     /**
-     * ユーザーの詳細情報
+     * User details
      */
     user: PixivUserItem;
     /**
-     * ユーザーのプロフィール情報
+     * User profile information
      */
     profile: PixivUserProfile;
     /**
-     * ユーザーの公開プロフィール情報
+     * User public profile information
      */
     profile_publicity: PixivUserProfilePublicity;
     /**
-     * ユーザーの作業環境情報
+     * User workspace information
      */
     workspace: PixivUserProfileWorkspace;
 }

package/dist/types/endpoints/v1/user/follow/add.d.ts

@@ -0,0 +1,24 @@
+import { FollowRestrict } from '../../../../../options';
+/**
+ * Request for POST /v1/user/follow/add
+ */
+export interface PostV1UserFollowAddRequest {
+    /**
+     * User ID
+     */
+    user_id: number;
+    /**
+     * Visibility setting
+     *
+     * public: Public
+     * private: Private
+     *
+     * @default FollowRestrict.PUBLIC
+     */
+    restrict: FollowRestrict;
+}
+/**
+ * Response for POST /v1/user/follow/add
+ */
+export type PostV1UserFollowAddResponse = Record<string, never>;
+//# sourceMappingURL=add.d.ts.map

package/dist/types/endpoints/v1/user/follow/add.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.d.ts","sourceRoot":"","sources":["../../../../../../src/types/endpoints/v1/user/follow/add.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;;;;OAOG;IACH,QAAQ,EAAE,cAAc,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA"}

package/dist/types/endpoints/v1/user/follow/add.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=add.js.map

package/dist/types/endpoints/v1/user/follow/add.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.js","sourceRoot":"","sources":["../../../../../../src/types/endpoints/v1/user/follow/add.ts"],"names":[],"mappings":""}

package/dist/types/endpoints/v1/user/follow/delete.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request for POST /v1/user/follow/delete
+ */
+export interface PostV1UserFollowDeleteRequest {
+    /**
+     * User ID
+     */
+    user_id: number;
+}
+/**
+ * Response for POST /v1/user/follow/delete
+ */
+export type PostV1UserFollowDeleteResponse = Record<string, never>;
+//# sourceMappingURL=delete.d.ts.map

package/dist/types/endpoints/v1/user/follow/delete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../../../../../src/types/endpoints/v1/user/follow/delete.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA"}

package/dist/types/endpoints/v1/user/follow/delete.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delete.js.map

package/dist/types/endpoints/v1/user/follow/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.js","sourceRoot":"","sources":["../../../../../../src/types/endpoints/v1/user/follow/delete.ts"],"names":[],"mappings":""}

package/dist/types/endpoints/v1/user/following.d.ts

@@ -0,0 +1,38 @@
+import { BaseMultipleCheck, CheckFunctions } from '../../../../checks';
+import { FollowRestrict } from '../../../../options';
+import { PixivUserPreviewItem } from '../../../pixiv-user';
+/**
+ * Request for GET /v1/user/following
+ */
+export interface GetV1UserFollowingRequest {
+    /**
+     * User ID
+     */
+    user_id: number;
+    /**
+     * Visibility of the followed users to retrieve
+     */
+    restrict: FollowRestrict;
+    /**
+     * Offset (for pagination)
+     */
+    offset?: number;
+}
+/**
+ * Response for GET /v1/user/following
+ */
+export interface GetV1UserFollowingResponse {
+    /**
+     * List of followed users
+     */
+    user_previews: PixivUserPreviewItem[];
+    /**
+     * Next URL
+     */
+    next_url: string | null;
+}
+export declare class GetV1UserFollowingCheck extends BaseMultipleCheck<GetV1UserFollowingRequest, GetV1UserFollowingResponse> {
+    requestChecks(): CheckFunctions<GetV1UserFollowingRequest>;
+    responseChecks(): CheckFunctions<GetV1UserFollowingResponse>;
+}
+//# sourceMappingURL=following.d.ts.map

package/dist/types/endpoints/v1/user/following.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"following.d.ts","sourceRoot":"","sources":["../../../../../src/types/endpoints/v1/user/following.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,EAAE,cAAc,EAAuB,MAAM,qBAAqB,CAAA;AACzE,OAAO,EACL,oBAAoB,EAErB,MAAM,qBAAqB,CAAA;AAE5B;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE,oBAAoB,EAAE,CAAA;IAErC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB;AAED,qBAAa,uBAAwB,SAAQ,iBAAiB,CAC5D,yBAAyB,EACzB,0BAA0B,CAC3B;IACC,aAAa,IAAI,cAAc,CAAC,yBAAyB,CAAC;IAU1D,cAAc,IAAI,cAAc,CAAC,0BAA0B,CAAC;CAY7D"}

package/dist/types/endpoints/v1/user/following.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetV1UserFollowingCheck = void 0;
+const checks_1 = require("../../../../checks");
+const options_1 = require("../../../../options");
+const pixiv_user_1 = require("../../../pixiv-user");
+class GetV1UserFollowingCheck extends checks_1.BaseMultipleCheck {
+    requestChecks() {
+        return {
+            user_id: (data) => typeof data.user_id === 'number' && data.user_id > 0,
+            restrict: (data) => new options_1.FollowRestrictCheck().throwIfFailed(data.restrict),
+            offset: (data) => data.offset === undefined || typeof data.offset === 'number',
+        };
+    }
+    responseChecks() {
+        return {
+            user_previews: (data) => Array.isArray(data.user_previews) &&
+                data.user_previews.every((preview) => new pixiv_user_1.PixivUserPreviewItemCheck().throwIfFailed(preview)),
+            next_url: (data) => 
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+            typeof data.next_url === 'string' || data.next_url === null,
+        };
+    }
+}
+exports.GetV1UserFollowingCheck = GetV1UserFollowingCheck;
+//# sourceMappingURL=following.js.map

package/dist/types/endpoints/v1/user/following.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"following.js","sourceRoot":"","sources":["../../../../../src/types/endpoints/v1/user/following.ts"],"names":[],"mappings":";;;AAAA,+CAAsE;AACtE,iDAAyE;AACzE,oDAG4B;AAqC5B,MAAa,uBAAwB,SAAQ,0BAG5C;IACC,aAAa;QACX,OAAO;YACL,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC;YACvE,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CACjB,IAAI,6BAAmB,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxD,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CACf,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;SAC/D,CAAA;IACH,CAAC;IAED,cAAc;QACZ,OAAO;YACL,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CACtB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC;gBACjC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CACnC,IAAI,sCAAyB,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CACvD;YACH,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;YACjB,uEAAuE;YACvE,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;SAC9D,CAAA;IACH,CAAC;CACF;AA1BD,0DA0BC"}

package/dist/types/endpoints/v2/illust/bookmark/add.d.ts

@@ -1,28 +1,28 @@
 import { BookmarkRestrict } from '../../../../../options';
 /**
- * POST /v2/illust/bookmark/add のリクエスト
+ * Request for POST /v2/illust/bookmark/add
  */
 export interface PostV2IllustBookmarkAddRequest {
     /**
-     * イラストID
+     * Illust ID
      */
     illust_id: number;
     /**
-     * 公開設定
+     * Visibility setting
      *
-     * public: 公開
-     * private: 非公開
+     * public: Public
+     * private: Private
      *
      * @default BookmarkRestrict.Public
      */
     restrict: BookmarkRestrict;
     /**
-     * ブックマークタグ群
+     * Bookmark tags
      */
     tags?: string[];
 }
 /**
- * POST /v2/illust/bookmark/add のレスポンス
+ * Response for POST /v2/illust/bookmark/add
  */
 export type PostV2IllustBookmarkAddResponse = Record<string, never>;
 //# sourceMappingURL=add.d.ts.map

package/dist/types/endpoints/v2/illust/related.d.ts

@@ -1,36 +1,36 @@
 import { BaseMultipleCheck, CheckFunctions } from '../../../../checks';
 import { PixivIllustItem } from '../../../pixiv-illust';
 /**
- * GET /v2/illust/related のリクエスト
+ * Request for GET /v2/illust/related
  */
 export interface GetV2IllustRelatedRequest {
     /**
-     * イラストID
+     * Illust ID
      */
     illust_id: number;
     /**
-     * イラストID シード配列 (?)
+     * Array of seed illust IDs (?)
      */
     seed_illust_ids?: number[];
     /**
-     * 閲覧済みイラストID
+     * Viewed illust IDs
      */
     viewed?: number[];
     /**
-     * オフセット
+     * Offset
      */
     offset?: number;
 }
 /**
- * GET /v1/illust/related のレスポンス
+ * Response for GET /v2/illust/related
  */
 export interface GetV2IllustRelatedResponse {
     /**
-     * イラストの詳細情報
+     * Illust details
      */
     illusts: PixivIllustItem[];
     /**
-     * 次のURL
+     * Next URL
      */
     next_url: string;
 }

package/dist/types/endpoints/v2/novel/bookmark/add.d.ts

@@ -1,27 +1,27 @@
 /**
- * POST /v2/novel/bookmark/add のリクエスト
+ * Request for POST /v2/novel/bookmark/add
  */
 export interface PostV2NovelBookmarkAddRequest {
     /**
-     * 小説ID
+     * Novel ID
      */
     novel_id: string;
     /**
-     * 公開設定
+     * Visibility setting
      *
-     * public: 公開
-     * private: 非公開
+     * public: Public
+     * private: Private
      *
      * @default BookmarkRestrict.Public
      */
     restrict: string;
     /**
-     * ブックマークタグ群
+     * Bookmark tags
      */
     tags?: string[];
 }
 /**
- * POST /v2/novel/bookmark/add のレスポンス
+ * Response for POST /v2/novel/bookmark/add
  */
 export type PostV2NovelBookmarkAddResponse = Record<string, never>;
 //# sourceMappingURL=add.d.ts.map

package/dist/types/endpoints/v2/novel/detail.d.ts

@@ -1,20 +1,20 @@
 import { BaseMultipleCheck, CheckFunctions } from '../../../../checks';
 import { PixivNovelItem } from '../../../pixiv-novel';
 /**
- * GET /v2/novel/detail のリクエスト
+ * Request for GET /v2/novel/detail
  */
 export interface GetV2NovelDetailRequest {
     /**
-     * 小説ID
+     * Novel ID
      */
     novel_id: number;
 }
 /**
- * GET /v2/novel/detail のレスポンス
+ * Response for GET /v2/novel/detail
  */
 export interface GetV2NovelDetailResponse {
     /**
-     * 小説の詳細情報
+     * Novel details
      */
     novel: PixivNovelItem;
 }