interfaceを個別のファイルに分割

Author: neet

src/client/Gateway.ts

@@ -0,0 +1,134 @@
+import nodeFetch from 'node-fetch';
+import * as querystring from 'querystring';
+
+export class Gateway {
+
+  /** ユーザーのアクセストークンです */
+  private token = '';
+
+  /** Qiitaのホストです */
+  private endpoint = 'https://qiita.com';
+
+  /** APIバージョンを示すロケーションです */
+  private version = '/api/v2';
+
+  /**
+   * @param options Optional params
+   * @param options.url Rest API URL of the instance
+   * @param options.streamingUrl Streaming API URL of the instance
+   * @param options.token API token of the user
+   */
+  constructor (options: { url?: string, streamingUrl?: string, token?: string }) {
+    if (options) {
+      this.url          = options.url || '';
+      this.streamingUrl = options.streamingUrl || '';
+
+      if (options.token) {
+        this.token = options.token;
+      }
+    }
+  }
+
+  /**
+   * Fetch API wrapper function
+   * @param url URL to request
+   * @param options Fetch API options
+   * @param parse Whether parse response before return
+   * @return Parsed response object
+   */
+  protected async request (url: string, options: { [key: string]: any } = {}, parse = true): Promise<any> {
+    if ( !options.headers ) {
+      options.headers = {};
+    }
+
+    options.headers['Content-Type']  = 'application/json';
+
+    if ( !this.url ) {
+      throw new MastodonURLResolveError('REST API URL has not been specified, Use Mastodon.setUrl to set your instance\'s URL');
+    }
+
+    if ( this.token ) {
+      options.headers.Authorization = `Bearer ${this.token}`;
+    }
+
+    const response = typeof window === 'undefined'
+      ? await nodeFetch(url, options)
+      : await fetch(url, options);
+
+    if ( !parse ) {
+      return response;
+    }
+
+    const data = await response.json();
+
+    if (response.ok) {
+      return data;
+    } else {
+      switch (response.status) {
+        case 401:
+          throw new MastodonUnauthorizedError(data.error);
+        case 404:
+          throw new MastodonNotFoundError(data.error);
+        case 429:
+          throw new MastodonRatelimitError(data.error);
+        default:
+          throw new MastodonError('MastodonError', data.error || 'Unexpected error occurred');
+      }
+    }
+  }
+
+  /**
+   * HTTP GET
+   * @param url URL to request
+   * @param params Query strings
+   * @param options Fetch API options
+   * @param parse Whether parse response before return
+   */
+  protected get <T> (url: string, params = {}, options = {}, parse = true): Promise<T> {
+    return this.request(url + (Object.keys(params).length ? '?' + querystring.stringify(params) : ''), { method: 'GET', ...options }, parse);
+  }
+
+  /**
+   * HTTP POST
+   * @param url URL to request
+   * @param body Payload
+   * @param options Fetch API options
+   * @param parse Whether parse response before return
+   */
+  protected post <T> (url: string, body = {}, options = {}, parse = true): Promise<T> {
+    return this.request(url, { method: 'POST', body: JSON.stringify(body), ...options }, parse);
+  }
+
+  /**
+   * HTTP PUT
+   * @param url URL to request
+   * @param body Payload
+   * @param options Fetch API options
+   * @param parse Whether parse response before return
+   */
+  protected put <T> (url: string, body = {}, options = {}, parse = true): Promise<T> {
+    return this.request(url, { method: 'PUT', body: JSON.stringify(body), ...options }, parse);
+  }
+
+  /**
+   * HTTP DELETE
+   * @param url URL to request
+   * @param body Payload
+   * @param options Fetch API options
+   * @param parse Whether parse response before return
+   */
+  protected delete <T> (url: string, body = {}, options = {}, parse = true): Promise<T> {
+    return this.request(url, { method: 'DELETE', body: JSON.stringify(body), ...options }, parse);
+  }
+
+  /**
+   * HTTP PATCH
+   * @param url URL to request
+   * @param body Payload
+   * @param options Fetch API options
+   * @param parse Whether parse response before return
+   */
+  protected patch <T> (url: string, body = {}, options = {}, parse = true): Promise<T> {
+    return this.request(url, { method: 'PATCH', body: JSON.stringify(body), ...options }, parse);
+  }
+}

src/entities/AuthenticatedUser.ts

@@ -0,0 +1,10 @@
+import { User } from './User';
+
+export interface AuthenticatedUser extends User {
+  /** 1ヶ月あたりにQiitaにアップロードできる画像の総容量 */
+  image_monthly_upload_limit: number;
+  /** その月にQiitaにアップロードできる画像の残りの容量 */
+  image_monthly_upload_remaining: number;
+  /** Qiita:Team専用モードに設定されているかどうか */
+  team_only: boolean;
+}

src/entities/Comment.ts

@@ -0,0 +1,16 @@
+import { User } from './User';
+
+export interface Comment {
+  /** コメントの内容を表すMarkdown形式の文字列 */
+  body: string;
+  /** データが作成された日時 */
+  created_at: string;
+  /** コメントの一意なID */
+  id: string;
+  /** コメントの内容を表すHTML形式の文字列 */
+  rendered_body: string;
+  /** データが最後に更新された日時 */
+  updated_at: string;
+  /** Qiita上のユーザを表します。 */
+  user: User;
+}

src/entities/ExpandedTemplate.ts

@@ -0,0 +1,10 @@
+import { Tagging } from './Tagging';
+
+export interface ExpandedTemplate {
+  /** 変数を展開した状態の本文 */
+  expanded_body: string;
+  /** 変数を展開した状態のタグ一覧 */
+  expanded_tags: Tagging[];
+  /** 変数を展開した状態のタイトル */
+  expanded_title: string;
+}

src/entities/Group.ts

@@ -0,0 +1,14 @@
+export interface Group {
+  /** データが作成された日時 */
+  created_at: string;
+  /** グループの一意なIDを表します。 */
+  id: number;
+  /** グループに付けられた表示用の名前を表します。 */
+  name: string;
+  /** 非公開グループかどうかを表します。 */
+  private: boolean;
+  /** データが最後に更新された日時 */
+  updated_at: string;
+  /** グループのチーム上での一意な名前を表します。 */
+  url_name: string;
+}

src/entities/Item.ts

@@ -0,0 +1,36 @@
+import { Group } from './Group';
+import { Tagging } from './Tagging';
+import { User } from './User';
+
+export interface Item {
+  /** HTML形式の本文 */
+  rendered_body: string;
+  /** Markdown形式の本文 */
+  body: string;
+  /** この投稿が共同更新状態かどうか (Qiita:Teamでのみ有効) */
+  coediting: boolean;
+  /** この投稿へのコメントの数 */
+  comments_count: number;
+  /** データが作成された日時 */
+  created_at: string;
+  /** Qiita:Teamのグループを表します。 */
+  group: Group;
+  /** 投稿の一意なID */
+  id: string;
+  /** この投稿への「いいね！」の数（Qiitaでのみ有効） */
+  likes_count: number;
+  /** 限定共有状態かどうかを表すフラグ (Qiita:Teamでは無効) */
+  private: boolean;
+  /** 投稿に付いたタグ一覧 */
+  tags: Tagging[];
+  /** 投稿のタイトル */
+  title: string;
+  /** データが最後に更新された日時 */
+  updated_at: string;
+  /** 投稿のURL */
+  url: string;
+  /** Qiita上のユーザを表します。 */
+  user: User;
+  /** 閲覧数 */
+  page_views_count: number;
+}

src/entities/Like.ts

@@ -0,0 +1,8 @@
+import { User } from './User';
+
+export interface Like {
+  /** データが作成された日時 */
+  created_at: string;
+  /** Qiita上のユーザを表します。 */
+  user: User;
+}

src/entities/Project.ts

@@ -0,0 +1,18 @@
+export interface Project {
+  /** HTML形式の本文 */
+  rendered_body: string;
+  /** このプロジェクトが進行中かどうか */
+  archived: boolean;
+  /** Markdown形式の本文 */
+  body: string;
+  /** データが作成された日時 */
+  created_at: string;
+  /** プロジェクトのチーム上での一意なID */
+  id: number;
+  /** プロジェクト名 */
+  name: string;
+  /** 絵文字リアクション数 */
+  reactions_count: number;
+  /** データが最後に更新された日時 */
+  updated_at: string;
+}

src/entities/Reaction.ts

@@ -0,0 +1,12 @@
+import { User } from './User';
+
+export interface Reaction {
+  /** データが作成された日時 */
+  created_at: string;
+  /** 絵文字画像のURL */
+  image_url: string;
+  /** 絵文字の識別子 */
+  name: string;
+  /** Qiita上のユーザを表します。 */
+  user: User;
+}

src/entities/Tag.ts

@@ -0,0 +1,10 @@
+export interface Tag {
+  /** このタグをフォローしているユーザの数 */
+  followers_count: number;
+  /** このタグに設定されたアイコン画像のURL */
+  icon_url?: string;
+  /** タグを特定するための一意な名前 */
+  id: string;
+  /** このタグが付けられた投稿の数 */
+  items_count: number;
+}