@book000/pixivts 0.4.3 → 0.6.0

package/dist/types/pixiv-user.d.ts

@@ -10,56 +10,162 @@ export type PixivUserItem = PixivUser & {
      */
     comment: string;
 };
+type Gender = 'male' | 'female' | 'unknown';
 /**
  * pixiv ユーザープロフィール
  */
 export interface PixivUserProfile {
+    /** ウェブサイト */
     webpage: string;
-    gender: string;
+    /** 性別 */
+    gender: Gender;
+    /** 生年月日（YYYY-MM-DD） */
     birth: string;
+    /** 誕生日（MM-DD） */
     birth_day: string;
+    /** 誕生年（YYYY） */
     birth_year: number;
+    /** 住所（国名と公開なら都道府県。スペース区切り） */
     region: string;
+    /**
+     * 都道府県番号
+     *
+     * ・0: 非公開
+     * ・1～47: 都道府県番号
+     * ・48: 日本国外？
+     */
     address_id: number;
+    /**
+     * 国名コード
+     *
+     * ・日本の場合は空文字列
+     * ・ISO 3166-1 alpha-2 形式
+     */
     country_code: string;
+    /** 職業 */
     job: string;
+    /**
+     * 職業ID
+     *
+     * ナンバリングは以下の通り。
+     * 0: 未指定、または非公開
+     * 1: IT関係
+     * 2: 事務系
+     * 3: 技術系
+     * 4: 営業・企画系
+     * 5: クリエーター系
+     * 6: 販売系
+     * 7: サービス業
+     * 8: ガテン系
+     * 9: 役員・管理職
+     * 10: 専門職
+     * 11: 公務員
+     * 12: 教員
+     * 13: 自営業
+     * 14: アーティスト
+     * 15: フリーター
+     * 16: 小学生
+     * 17: 中学生
+     * 18: 高校生
+     * 19: 大学生・院生
+     * 20: 専門学校生
+     * 21: 主婦
+     * 22: 求職中
+     * 23: その他
+     */
     job_id: number;
+    /** フォロー中のユーザ数 */
     total_follow_users: number;
+    /** マイピクのユーザ数 */
     total_mypixiv_users: number;
+    /** 投稿イラスト数 */
     total_illusts: number;
+    /** 投稿マンガ数 */
     total_manga: number;
+    /** 投稿小説数 */
     total_novels: number;
+    /** 公開でのブックマーク数 */
     total_illust_bookmarks_public: number;
+    /** 作成イラストシリーズ数 */
     total_illust_series: number;
+    /** 作成小説シリーズ数 */
     total_novel_series: number;
-    background_image_url?: any;
+    /** 背景画像 URL */
+    background_image_url: string | null;
+    /**
+     * Twitter アカウントのスクリーンネーム
+     *
+     * ・未設定の場合は空文字列
+     * ・@ は含まない
+     * ・連携しているわけではなく手動入力なので、スクリーンネーム変更やアカウント削除などによって存在しない可能性あり
+     * ・Twitter 以外の Instagram や Tumblr などは取得できない
+     */
     twitter_account: string;
+    /** Twitter アカウント URL */
     twitter_url: string;
+    /**
+     * Pawoo アカウント URL
+     *
+     * ・Pawoo でアカウント連携をしており、「Pawooアカウントへのリンクを表示」にチェックが入っている場合のみ。
+     * ・連携していない場合や表示させていない場合は空文字列
+     */
     pawoo_url: string;
+    /** プレミアムアカウントかどうか */
     is_premium: boolean;
+    /** カスタムプロフィール画像を使用しているかどうか */
     is_using_custom_profile_image: boolean;
 }
+type Publicity = 'public' | 'private' | 'mypixiv';
+/**
+ * pixiv ユーザープロフィール公開設定
+ *
+ * 基本として public, private, mypixiv のいずれか。
+ * public は公開、private は非公開、mypixiv はマイピクのみ公開。
+ */
 export interface PixivUserProfilePublicity {
-    gender: string;
-    region: string;
-    birth_day: string;
-    birth_year: string;
-    job: string;
+    /** 性別 */
+    gender: Publicity;
+    /** 住所（都道府県） */
+    region: Publicity;
+    /** 誕生日 */
+    birth_day: Publicity;
+    /** 誕生年 */
+    birth_year: Publicity;
+    /** 職業 */
+    job: Publicity;
+    /** Pawoo アカウントへのリンクを表示するか */
     pawoo: boolean;
 }
+/**
+ * pixiv ユーザー作業環境情報
+ */
 export interface PixivUserProfileWorkspace {
+    /** コンピュータ */
     pc: string;
+    /** モニター */
     monitor: string;
+    /** ソフト */
     tool: string;
+    /** スキャナー */
     scanner: string;
+    /** タブレット */
     tablet: string;
+    /** マウス */
     mouse: string;
+    /** プリンター */
     printer: string;
+    /** 机の上にあるもの */
     desktop: string;
+    /** 絵を描く時に聴く音楽 */
     music: string;
+    /** 机 */
     desk: string;
+    /** 椅子 */
     chair: string;
+    /** その他 */
     comment: string;
-    workspace_image_url?: any;
+    /** 画像 */
+    workspace_image_url: string | null;
 }
+export {};
 //# sourceMappingURL=pixiv-user.d.ts.map

package/dist/types/pixiv-user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pixiv-user.d.ts","sourceRoot":"","sources":["../../src/types/pixiv-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG;IACtC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,6BAA6B,EAAE,MAAM,CAAA;IACrC,mBAAmB,EAAE,MAAM,CAAA;IAC3B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,oBAAoB,CAAC,EAAE,GAAG,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,6BAA6B,EAAE,OAAO,CAAA;CACvC;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,mBAAmB,CAAC,EAAE,GAAG,CAAA;CAC1B"}
+{"version":3,"file":"pixiv-user.d.ts","sourceRoot":"","sources":["../../src/types/pixiv-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG;IACtC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE3C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa;IACb,OAAO,EAAE,MAAM,CAAA;IAEf,SAAS;IACT,MAAM,EAAE,MAAM,CAAA;IAEd,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;IAEb,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,gBAAgB;IAChB,UAAU,EAAE,MAAM,CAAA;IAElB,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;;OAMG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB,SAAS;IACT,GAAG,EAAE,MAAM,CAAA;IAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd,iBAAiB;IACjB,kBAAkB,EAAE,MAAM,CAAA;IAE1B,gBAAgB;IAChB,mBAAmB,EAAE,MAAM,CAAA;IAE3B,cAAc;IACd,aAAa,EAAE,MAAM,CAAA;IAErB,aAAa;IACb,WAAW,EAAE,MAAM,CAAA;IAEnB,YAAY;IACZ,YAAY,EAAE,MAAM,CAAA;IAEpB,kBAAkB;IAClB,6BAA6B,EAAE,MAAM,CAAA;IAErC,kBAAkB;IAClB,mBAAmB,EAAE,MAAM,CAAA;IAE3B,gBAAgB;IAChB,kBAAkB,EAAE,MAAM,CAAA;IAE1B,eAAe;IACf,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnC;;;;;;;OAOG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB,wBAAwB;IACxB,WAAW,EAAE,MAAM,CAAA;IAEnB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB,qBAAqB;IACrB,UAAU,EAAE,OAAO,CAAA;IAEnB,8BAA8B;IAC9B,6BAA6B,EAAE,OAAO,CAAA;CACvC;AAED,KAAK,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAA;AAEjD;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS;IACT,MAAM,EAAE,SAAS,CAAA;IACjB,eAAe;IACf,MAAM,EAAE,SAAS,CAAA;IACjB,UAAU;IACV,SAAS,EAAE,SAAS,CAAA;IACpB,UAAU;IACV,UAAU,EAAE,SAAS,CAAA;IACrB,SAAS;IACT,GAAG,EAAE,SAAS,CAAA;IACd,6BAA6B;IAC7B,KAAK,EAAE,OAAO,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,aAAa;IACb,EAAE,EAAE,MAAM,CAAA;IACV,WAAW;IACX,OAAO,EAAE,MAAM,CAAA;IACf,UAAU;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,YAAY;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,UAAU;IACV,KAAK,EAAE,MAAM,CAAA;IACb,YAAY;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,eAAe;IACf,OAAO,EAAE,MAAM,CAAA;IACf,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ;IACR,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS;IACT,KAAK,EAAE,MAAM,CAAA;IACb,UAAU;IACV,OAAO,EAAE,MAAM,CAAA;IACf,SAAS;IACT,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@book000/pixivts",
-  "version": "0.4.3",
+  "version": "0.6.0",
   "description": "pixiv Unofficial API Library for TypeScript",
   "homepage": "https://www.npmjs.com/package/@book000/pixivts",
   "bugs": {