@book000/pixivts 0.8.0 → 0.9.1

package/dist/options.d.ts

@@ -1,269 +1,135 @@
-/** 検索対象 */
-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';
+import { GetV1IllustDetailRequest } from './types/endpoints/v1/illust/detail';
+import { SnakeToCamel } from 'snake-camel-types';
+import { GetV1IllustRecommendedRequest } from './types/endpoints/v1/illust/recommended';
+import { GetV1SearchIllustRequest } from './types/endpoints/v1/search/illust';
+import { PostV2IllustBookmarkAddRequest } from './types/endpoints/v2/illust/bookmark/add';
+import { GetV1IllustSeriesRequest } from './types/endpoints/v1/illust/series';
+import { GetV2NovelDetailRequest } from './types/endpoints/v2/novel/detail';
+import { GetV1NovelTextRequest } from './types/endpoints/v1/novel/text';
+import { GetV1NovelRecommendedRequest } from './types/endpoints/v1/novel/recommended';
+import { GetV1SearchNovelRequest } from './types/endpoints/v1/search/novel';
+import { GetV2NovelSeriesRequest } from './types/endpoints/v2/novel/series';
+import { GetV1UserDetailRequest } from './types/endpoints/v1/user/detail';
 /**
- * イラスト検索オプション
+ * 検索対象
  */
-export interface SearchIllustOptions {
-    /**
-     * 検索ワード
-     */
-    word: string;
-    /**
-     * 検索対象
-     */
-    searchTarget?: SearchTargets;
-    /**
-     * ソート順
-     */
-    sort?: SearchSorts;
-    /**
-     * 対象期間
-     */
-    duration?: SearchIllustDurations;
-    /**
-     * 開始日時
-     */
-    startDate?: string;
-    /**
-     * 終了日時
-     */
-    endDate?: string;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-    /**
-     * オフセット
-     */
-    offset?: number;
+export declare enum SearchTarget {
+    /** タグの部分一致 */
+    PARTIAL_MATCH_FOR_TAGS = "partial_match_for_tags",
+    /** タグの完全一致 */
+    EXACT_MATCH_FOR_TAGS = "exact_match_for_tags",
+    /** タイトル、またはキャプション（アプリ内では本文） */
+    TITLE_AND_CAPTION = "title_and_caption",
+    /** キーワード */
+    KEYWORD = "keyword"
 }
 /**
- * イラスト詳細取得オプション
+ * ソート
  */
-export interface IllustDetailOptions {
-    /**
-     * イラストID
-     */
-    illustId: number;
+export declare enum SearchSort {
+    /** 新しい順 */
+    DATE_DESC = "date_desc",
+    /** 古い順 */
+    DATE_ASC = "date_asc",
+    /** 人気順 */
+    POPULAR_DESC = "popular_desc"
 }
 /**
- * おすすめイラスト取得オプション
+ * 対象期間
  */
-export interface RecommendedIllustOptions {
-    /**
-     * コンテンツタイプ (illust or manga)
-     */
-    contentType: ContentType;
-    /**
-     * ランキングラベルを含めるか
-     */
-    includeRankingLabel?: boolean;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-    /**
-     * おすすめイラストの最大ブックマークID (?)
-     *
-     * @beta
-     */
-    maxBookmarkIdForRecommend?: number;
-    /**
-     * 最近のイラストの最小ブックマークID (?)
-     *
-     * @beta
-     */
-    minBookmarkIdForRecentIllust?: number;
-    /**
-     * オフセット
-     */
-    offset?: number;
-    /**
-     * ランキングイラストを含めるか (?)
-     */
-    includeRankingIllusts?: boolean;
-    /**
-     * ブックマーク済みのイラストID
-     */
-    bookmarkIllustIds?: number[];
-    /**
-     * プライバシーポリシーを含めるか (?)
-     *
-     * @beta
-     */
-    includePrivacyPolicy?: boolean;
+export declare enum SearchIllustDuration {
+    /** 1日以内 */
+    WITHIN_LAST_DAY = "within_last_day",
+    /** 1週間以内 */
+    WITHIN_LAST_WEEK = "within_last_week",
+    /** 1ヶ月以内 */
+    WITHIN_LAST_MONTH = "within_last_month"
 }
 /**
- * イラストブックマーク追加オプション
+ * OSフィルタ
  */
-export interface IllustBookmarkAddOptions {
-    /**
-     * イラストID
-     */
-    illustId: number;
-    /**
-     * 公開範囲
-     */
-    restrict?: BookmarkRestrict;
-    /**
-     * タグ
-     */
-    tags?: string[];
+export declare enum Filter {
+    /** iOS */
+    FOR_IOS = "for_ios",
+    /** Android */
+    FOR_ANDROID = "for_android"
 }
-export interface IllustSeriesOptions {
-    /**
-     * イラストシリーズID
-     */
-    illustSeriesId: number;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-    /**
-     * オフセット
-     */
-    offset?: number;
+/**
+ * ブックマーク公開範囲
+ */
+export declare enum BookmarkRestrict {
+    /** 公開 */
+    PUBLIC = "public",
+    /** 非公開 */
+    PRIVATE = "private"
 }
+/**
+ * オブジェクトの一部を必須にする
+ *
+ * @see https://qiita.com/yuu_1st/items/71c4fc9cc95a72fa4df9
+ */
+type SomeRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/**
+ * オブジェクトの特定プロパティを上書きする
+ *
+ * @see https://qiita.com/ibaragi/items/2a6412aeaca5703694b1
+ */
+type Overwrite<T, U extends {
+    [Key in keyof T]?: unknown;
+}> = Omit<T, keyof U> & U;
+/**
+ * イラスト検索オプション
+ */
+export type SearchIllustOptions = SomeRequired<SnakeToCamel<GetV1SearchIllustRequest>, 'word'>;
+/**
+ * イラスト詳細取得オプション
+ */
+export type IllustDetailOptions = SnakeToCamel<GetV1IllustDetailRequest>;
+/**
+ * おすすめイラスト取得オプション
+ */
+export type RecommendedIllustOptions = SnakeToCamel<Partial<GetV1IllustRecommendedRequest>>;
+/**
+ * イラストブックマーク追加オプション
+ */
+export type IllustBookmarkAddOptions = SomeRequired<SnakeToCamel<PostV2IllustBookmarkAddRequest>, 'illustId'>;
+/**
+ * イラストシリーズ取得オプション
+ */
+export type IllustSeriesOptions = SomeRequired<SnakeToCamel<GetV1IllustSeriesRequest>, 'illustSeriesId'>;
 /**
  * 小説詳細取得オプション
  */
-export interface NovelDetailOptions {
-    /**
-     * 小説ID
-     */
-    novelId: number;
-}
+export type NovelDetailOptions = SnakeToCamel<GetV2NovelDetailRequest>;
 /**
  * 小説本文取得オプション
  */
-export interface NovelTextOptions {
-    /**
-     * 小説ID
-     */
-    novelId: number;
-}
+export type NovelTextOptions = SnakeToCamel<GetV1NovelTextRequest>;
 /**
  * 小説検索オプション
  */
-export interface SearchNovelOptions {
-    /**
-     * 検索ワード
-     */
-    word: string;
-    /**
-     * 検索対象
-     */
-    searchTarget?: SearchTargets;
-    /**
-     * ソート順
-     */
-    sort?: SearchSorts;
-    /**
-     * プレーンキーワード検索結果をマージするか (?)
-     *
-     * @beta
-     */
-    mergePlainKeywordResults?: boolean;
-    /**
-     * 翻訳タグ検索結果を含むか
-     */
-    includeTranslatedTagResults?: boolean;
-    /**
-     * 開始日時
-     */
-    startDate?: string;
-    /**
-     * 終了日時
-     */
-    endDate?: string;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-    /**
-     * オフセット
-     */
-    offset?: number;
-}
+export type SearchNovelOptions = SomeRequired<SnakeToCamel<GetV1SearchNovelRequest>, 'word'>;
 /**
  * おすすめ小説取得オプション
  */
-export interface RecommendedNovelOptions {
-    /**
-     * ランキングラベルを含めるか
-     */
-    includeRankingLabel?: boolean;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-    /**
-     * オフセット
-     */
-    offset?: number;
+export type RecommendedNovelOptions = Overwrite<SnakeToCamel<Partial<GetV1NovelRecommendedRequest>>, {
     /**
-     * ランキング小説を含めるか (?)
+     * すでにおすすめした小説ID群 (?)
      *
+     * @default undefined
      * @beta
      */
-    includeRankingNovels?: boolean;
-    /**
-     * おすすめ済みの小説ID
-     */
     alreadyRecommended?: number[];
-    /**
-     * おすすめ小説の最大ブックマークID (?)
-     *
-     * @beta
-     */
-    maxBookmarkIdForRecommend?: number;
-    /**
-     * プライバシーポリシーを含めるか (?)
-     *
-     * @beta
-     */
-    includePrivacyPolicy?: boolean;
-}
+}>;
 /**
  * 小説シリーズ詳細取得オプション
  */
-export interface NovelSeriesOptions {
-    /**
-     * 小説シリーズID
-     */
-    seriesId: number;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-    /**
-     * (?)
-     *
-     * @beta
-     */
-    lastOrder?: string;
-}
+export type NovelSeriesOptions = SomeRequired<SnakeToCamel<GetV2NovelSeriesRequest>, 'seriesId'>;
 /**
  * ユーザー詳細取得オプション
  */
-export interface UserDetailOptions {
-    /**
-     * ユーザーID
-     */
-    userId: number;
-    /**
-     * OSフィルタ
-     */
-    filter?: Filters;
-}
+export type UserDetailOptions = SnakeToCamel<GetV1UserDetailRequest>;
+export {};
 //# 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":"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;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAElC;;;;OAIG;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;;;;OAIG;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,gBAAgB;IAC/B;;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;;;;OAIG;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;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE7B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAElC;;;;OAIG;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;;;;OAIG;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"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAA;AACvF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAA;AAC7E,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAA;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAA;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAA;AACrF,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAA;AAC3E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AAEzE;;GAEG;AACH,oBAAY,YAAY;IACtB,cAAc;IACd,sBAAsB,2BAA2B;IACjD,cAAc;IACd,oBAAoB,yBAAyB;IAC7C,+BAA+B;IAC/B,iBAAiB,sBAAsB;IACvC,YAAY;IACZ,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,WAAW;IACX,SAAS,cAAc;IACvB,UAAU;IACV,QAAQ,aAAa;IACrB,UAAU;IACV,YAAY,iBAAiB;CAC9B;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,WAAW;IACX,eAAe,oBAAoB;IACnC,YAAY;IACZ,gBAAgB,qBAAqB;IACrC,YAAY;IACZ,iBAAiB,sBAAsB;CACxC;AAED;;GAEG;AACH,oBAAY,MAAM;IAChB,UAAU;IACV,OAAO,YAAY;IACnB,cAAc;IACd,WAAW,gBAAgB;CAC5B;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,SAAS;IACT,MAAM,WAAW;IACjB,UAAU;IACV,OAAO,YAAY;CACpB;AACD;;;;GAIG;AACH,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAC3C,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjB,CAAA;AAED;;;;GAIG;AACH,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS;KAAG,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO;CAAE,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAC5E,CAAC,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAC5C,YAAY,CAAC,wBAAwB,CAAC,EACtC,MAAM,CACP,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,wBAAwB,CAAC,CAAA;AAExE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,CACjD,OAAO,CAAC,6BAA6B,CAAC,CACvC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,CACjD,YAAY,CAAC,8BAA8B,CAAC,EAC5C,UAAU,CACX,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAC5C,YAAY,CAAC,wBAAwB,CAAC,EACtC,gBAAgB,CACjB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAA;AAEtE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAElE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAC3C,YAAY,CAAC,uBAAuB,CAAC,EACrC,MAAM,CACP,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAC7C,YAAY,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC,EACnD;IACE;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC9B,CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAC3C,YAAY,CAAC,uBAAuB,CAAC,EACrC,UAAU,CACX,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAA"}

package/dist/options.js

@@ -1,3 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BookmarkRestrict = exports.Filter = exports.SearchIllustDuration = exports.SearchSort = exports.SearchTarget = void 0;
+/**
+ * 検索対象
+ */
+var SearchTarget;
+(function (SearchTarget) {
+    /** タグの部分一致 */
+    SearchTarget["PARTIAL_MATCH_FOR_TAGS"] = "partial_match_for_tags";
+    /** タグの完全一致 */
+    SearchTarget["EXACT_MATCH_FOR_TAGS"] = "exact_match_for_tags";
+    /** タイトル、またはキャプション（アプリ内では本文） */
+    SearchTarget["TITLE_AND_CAPTION"] = "title_and_caption";
+    /** キーワード */
+    SearchTarget["KEYWORD"] = "keyword";
+})(SearchTarget = exports.SearchTarget || (exports.SearchTarget = {}));
+/**
+ * ソート
+ */
+var SearchSort;
+(function (SearchSort) {
+    /** 新しい順 */
+    SearchSort["DATE_DESC"] = "date_desc";
+    /** 古い順 */
+    SearchSort["DATE_ASC"] = "date_asc";
+    /** 人気順 */
+    SearchSort["POPULAR_DESC"] = "popular_desc";
+})(SearchSort = exports.SearchSort || (exports.SearchSort = {}));
+/**
+ * 対象期間
+ */
+var SearchIllustDuration;
+(function (SearchIllustDuration) {
+    /** 1日以内 */
+    SearchIllustDuration["WITHIN_LAST_DAY"] = "within_last_day";
+    /** 1週間以内 */
+    SearchIllustDuration["WITHIN_LAST_WEEK"] = "within_last_week";
+    /** 1ヶ月以内 */
+    SearchIllustDuration["WITHIN_LAST_MONTH"] = "within_last_month";
+})(SearchIllustDuration = exports.SearchIllustDuration || (exports.SearchIllustDuration = {}));
+/**
+ * OSフィルタ
+ */
+var Filter;
+(function (Filter) {
+    /** iOS */
+    Filter["FOR_IOS"] = "for_ios";
+    /** Android */
+    Filter["FOR_ANDROID"] = "for_android";
+})(Filter = exports.Filter || (exports.Filter = {}));
+/**
+ * ブックマーク公開範囲
+ */
+var BookmarkRestrict;
+(function (BookmarkRestrict) {
+    /** 公開 */
+    BookmarkRestrict["PUBLIC"] = "public";
+    /** 非公開 */
+    BookmarkRestrict["PRIVATE"] = "private";
+})(BookmarkRestrict = exports.BookmarkRestrict || (exports.BookmarkRestrict = {}));
 //# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":""}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;AAaA;;GAEG;AACH,IAAY,YASX;AATD,WAAY,YAAY;IACtB,cAAc;IACd,iEAAiD,CAAA;IACjD,cAAc;IACd,6DAA6C,CAAA;IAC7C,+BAA+B;IAC/B,uDAAuC,CAAA;IACvC,YAAY;IACZ,mCAAmB,CAAA;AACrB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB;AAED;;GAEG;AACH,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,WAAW;IACX,qCAAuB,CAAA;IACvB,UAAU;IACV,mCAAqB,CAAA;IACrB,UAAU;IACV,2CAA6B,CAAA;AAC/B,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAED;;GAEG;AACH,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,WAAW;IACX,2DAAmC,CAAA;IACnC,YAAY;IACZ,6DAAqC,CAAA;IACrC,YAAY;IACZ,+DAAuC,CAAA;AACzC,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B;AAED;;GAEG;AACH,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,UAAU;IACV,6BAAmB,CAAA;IACnB,cAAc;IACd,qCAA2B,CAAA;AAC7B,CAAC,EALW,MAAM,GAAN,cAAM,KAAN,cAAM,QAKjB;AAED;;GAEG;AACH,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,SAAS;IACT,qCAAiB,CAAA;IACjB,UAAU;IACV,uCAAmB,CAAA;AACrB,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B"}

package/dist/pixiv.d.ts

@@ -3,16 +3,18 @@ import { AxiosInstance, AxiosResponse } from 'axios';
 import { ReadStream } from 'node:fs';
 import qs from 'qs';
 import { IllustDetailOptions, SearchIllustOptions, RecommendedIllustOptions, IllustBookmarkAddOptions, NovelDetailOptions, SearchNovelOptions, RecommendedNovelOptions, NovelSeriesOptions, UserDetailOptions, IllustSeriesOptions, NovelTextOptions } from './options';
-import { PostV2IllustBookmarkAddResponse } from './types/endpoints/v2/illust/bookmark/add';
+import { PixivApiError } from './types/error-response';
 import { GetV1IllustDetailResponse } from './types/endpoints/v1/illust/detail';
-import { GetV2NovelDetailResponse } from './types/endpoints/v2/novel/detail';
-import { GetV1RecommendedNovelResponse } from './types/endpoints/v1/novel/recommended';
 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 { GetV1NovelTextResponse } from './types/endpoints/v1/novel/text';
 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 { GetV1NovelTextResponse } from './types/endpoints/v1/novel/text';
-import { PixivApiError } from './types/error-response';
-import { GetV1RecommendedIllustResponse } from './types/endpoints/v1/illust/recommended';
 /**
  * pixiv API
  */
@@ -40,6 +42,9 @@ export default class Pixiv {
      * @returns Pixiv インスタンス
      */
     static of(refreshToken: string): Promise<Pixiv>;
+    /**
+     * 画像のaxiosストリームを取得する。
+     */
     static getAxiosImageStream(url: string): Promise<AxiosResponse<ReadStream, any>>;
     /**
      * イラストの詳細情報を取得する。
@@ -61,7 +66,7 @@ export default class Pixiv {
      * @param options オプション
      * @returns レスポンス
      */
-    recommendedIllust(options: RecommendedIllustOptions): Promise<AxiosResponse<GetV1RecommendedIllustResponse, any>>;
+    recommendedIllust(options?: RecommendedIllustOptions): Promise<AxiosResponse<GetV1IllustRecommendedResponse, any>>;
     /**
      * イラストをブックマークする。
      *
@@ -75,7 +80,7 @@ export default class Pixiv {
      * @param options オプション
      * @returns レスポンス
      */
-    illustSeries(options: IllustSeriesOptions): Promise<AxiosResponse<import(".").PixivIllustSeriesItem, any>>;
+    illustSeries(options: IllustSeriesOptions): Promise<AxiosResponse<GetV1IllustSeriesResponse, any>>;
     /**
      * 小説の詳細情報を取得する。
      *
@@ -104,14 +109,14 @@ export default class Pixiv {
      * @param options オプション
      * @returns レスポンス
      */
-    recommendedNovel(options?: RecommendedNovelOptions): Promise<AxiosResponse<GetV1RecommendedNovelResponse, any>>;
+    recommendedNovel(options?: RecommendedNovelOptions): Promise<AxiosResponse<GetV1NovelRecommendedResponse, any>>;
     /**
      * 小説シリーズの詳細情報を取得する。
      *
      * @param options オプション
      * @returns レスポンス
      */
-    novelSeries(options: NovelSeriesOptions): Promise<AxiosResponse<import(".").PixivNovelSeriesItem, any>>;
+    novelSeries(options: NovelSeriesOptions): Promise<AxiosResponse<GetV2NovelSeriesResponse, any>>;
     /**
      * ユーザーの詳細情報を取得する。
      *
@@ -143,9 +148,22 @@ export default class Pixiv {
     /**
      * リクエストを送信する。
      *
+     * ジェネリクスの順番は、T: リクエスト、U: レスポンス。
+     *
      * @param options オプション
      * @returns レスポンス
      */
     private request;
+    /**
+     * 必須のオプションが含まれているかどうかをチェックする。
+     *
+     * @param options オプション
+     * @param required 必須のオプションキー
+     */
+    private checkRequiredOptions;
+    /**
+     * スネークケースのオブジェクトキーをキャメルケースなオブジェクトキーに変換する。
+     */
+    private convertSnakeToCamel;
 }
 //# 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,mBAAmB,EACnB,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EACjB,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAA;AAC1F,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAA;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAA;AAEtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAA;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAA;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AACtD,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAA;AAUxF;;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,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAYtD;;;;;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;;;;;;OAMG;IACU,SAAS,CAAC,OAAO,EAAE,gBAAgB;IAYhD;;;;;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;WACW,OAAO,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI,aAAa;IAS/D;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAKnB;;;;;OAKG;IACH,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,EACnB,gBAAgB,EAKjB,MAAM,WAAW,CAAA;AAClB,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,sBAAsB,EACvB,MAAM,iCAAiC,CAAA;AACxC,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;AAgBzC;;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;IA2C3C;;OAEG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM;IAWnD;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IActD;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAyBtD;;;;;OAKG;IACU,iBAAiB,CAAC,OAAO,GAAE,wBAA6B;IAqBrE;;;;;OAKG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB;IAiBhE;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB;IAiBtD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAepD;;;;;;OAMG;IACU,SAAS,CAAC,OAAO,EAAE,gBAAgB;IAehD;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAyBpD;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,GAAE,uBAA4B;IAsBnE;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB;IAiBpD;;;;;OAKG;IACU,UAAU,CAAC,OAAO,EAAE,iBAAiB;IAgBlD;;;;;OAKG;WACW,gBAAgB,CAAC,GAAG,EAAE,MAAM;IAS1C;;;;;OAKG;WACW,OAAO,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI,aAAa;IAS/D;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAKnB;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO;IAgBf;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAW5B;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAQ5B"}