refs #125 Add registerApp method for misskey

src/misskey.ts

@@ -0,0 +1,121 @@
+import MisskeyAPI from './misskey/api_client'
+import { NO_REDIRECT, DEFAULT_UA } from './default'
+import { ProxyConfig } from './proxy_config'
+import OAuth from './oauth'
+import Response from './response'
+
+export default class Misskey {
+  public client: MisskeyAPI.Client
+  public baseUrl: string
+  public proxyConfig: ProxyConfig | false
+
+  /**
+   * @param baseUrl hostname or base URL
+   * @param accessToken access token from OAuth2 authorization
+   * @param userAgent UserAgent is specified in header on request.
+   * @param proxyConfig Proxy setting, or set false if don't use proxy.
+   */
+  constructor(
+    baseUrl: string,
+    accessToken: string | null = null,
+    userAgent: string | null = DEFAULT_UA,
+    proxyConfig: ProxyConfig | false = false
+  ) {
+    let token: string = ''
+    if (accessToken) {
+      token = accessToken
+    }
+    let agent: string = DEFAULT_UA
+    if (userAgent) {
+      agent = userAgent
+    }
+    this.client = new MisskeyAPI.Client(baseUrl, token, agent, proxyConfig)
+    this.baseUrl = baseUrl
+    this.proxyConfig = proxyConfig
+  }
+
+  public cancel(): void {
+    return this.client.cancel()
+  }
+
+  public async registerApp(
+    client_name: string,
+    options: Partial<{ scopes: Array<string>; redirect_uris: string; website: string }> = {
+      scopes: MisskeyAPI.DEFAULT_SCOPE,
+      redirect_uris: NO_REDIRECT
+    }
+  ): Promise<OAuth.AppData> {
+    return this.createApp(client_name, options).then(async appData => {
+      return this.generateAuthUrlAndToken(appData.client_secret).then(session => {
+        appData.url = session.url
+        appData.session_token = session.token
+        return appData
+      })
+    })
+  }
+
+  /**
+   * POST /api/app/create
+   *
+   * Create an application.
+   * @param client_name Your application's name.
+   * @param options Form data.
+   */
+  public async createApp(
+    client_name: string,
+    options: Partial<{ redirect_uris: string; scopes: Array<string>; website: string }> = {
+      redirect_uris: NO_REDIRECT,
+      scopes: MisskeyAPI.DEFAULT_SCOPE
+    }
+  ): Promise<OAuth.AppData> {
+    const redirect_uris = options.redirect_uris || NO_REDIRECT
+    const scopes = options.scopes || MisskeyAPI.DEFAULT_SCOPE
+
+    const params: {
+      name: string
+      description: string
+      permission: Array<string>
+      callbackUrl: string
+    } = {
+      name: client_name,
+      description: '',
+      permission: scopes,
+      callbackUrl: redirect_uris
+    }
+
+    /**
+     * The response is:
+     {
+       "id": "xxxxxxxxxx",
+       "name": "string",
+       "callbackUrl": "string",
+       "permission": [
+         "string"
+       ],
+       "secret": "string"
+     }
+    */
+    return MisskeyAPI.Client.post<MisskeyAPI.App>('/api/app/create', params, this.baseUrl, this.proxyConfig).then(
+      (res: Response<MisskeyAPI.App>) => {
+        const appData: OAuth.AppDataFromServer = {
+          id: res.data.id,
+          name: res.data.name,
+          website: null,
+          redirect_uri: res.data.callbackUrl,
+          client_id: '',
+          client_secret: res.data.secret
+        }
+        return OAuth.AppData.from(appData)
+      }
+    )
+  }
+
+  /**
+   * POST /api/auth/session/generate
+   */
+  public async generateAuthUrlAndToken(clientSecret: string): Promise<MisskeyAPI.Session> {
+    return MisskeyAPI.Client.post<MisskeyAPI.Session>('/api/auth/session/generate', {
+      appSecret: clientSecret
+    }).then((res: Response<MisskeyAPI.Session>) => res.data)
+  }
+}

src/misskey/api_client.ts

@@ -4,6 +4,27 @@ import proxyAgent, { ProxyConfig } from '@/proxy_config'
 import Response from '@/response'
 
 namespace MisskeyAPI {
+  export const DEFAULT_SCOPE = [
+    'read:account',
+    'write:account',
+    'read:blocks',
+    'write:blocks',
+    'read:favourites',
+    'write:favourites',
+    'read:following',
+    'write:following',
+    'read:messaging',
+    'write:messaging',
+    'read:mute',
+    'write:mute',
+    'write:note',
+    'read:notifications',
+    'write:notifications',
+    'read:reactions',
+    'write:reactions',
+    'write:votes'
+  ]
+
   /**
    * Interface
    */
@@ -44,7 +65,6 @@ namespace MisskeyAPI {
      * @param baseUrl base URL of the target
      * @param proxyConfig Proxy setting, or set false if don't use proxy.
      */
-
     public static async post<T>(
       path: string,
       params = {},
@@ -99,6 +119,27 @@ namespace MisskeyAPI {
         return res
       })
     }
+
+    /**
+     * Cancel all requests in this instance.
+     * @returns void
+     */
+    public cancel(): void {
+      return this.cancelTokenSource.cancel('Request is canceled by user')
+    }
+  }
+
+  export type App = {
+    id: string
+    name: string
+    callbackUrl: string
+    permission: Array<string>
+    secret: string
+  }
+
+  export type Session = {
+    token: string
+    url: string
   }
 }
 

src/oauth.ts

@@ -4,7 +4,7 @@
  **/
 namespace OAuth {
   export type AppDataFromServer = {
-    id: number
+    id: string
     name: string
     website: string | null
     redirect_uri: string
@@ -23,8 +23,9 @@ namespace OAuth {
 
   export class AppData {
     public url: string | null
+    public session_token: string | null
     constructor(
-      public id: number,
+      public id: string,
       public name: string,
       public website: string | null,
       public redirect_uri: string,
@@ -32,6 +33,7 @@ namespace OAuth {
       public client_secret: string
     ) {
       this.url = null
+      this.session_token = null
     }
 
     /**