feat: Add token.revoke to OAuth client

neet · neet · commit 47688e050231 · 2023-11-13T03:31:39.000+09:00
diff --git a/src/mastodon/oauth/client.ts b/src/mastodon/oauth/client.ts
@@ -1,5 +1,26 @@
+import { type HttpMetaParams } from "../../interfaces";
 import { type TokenRepository } from "./token-repository";
 
+export interface RevokeTokenParams {
+  /** The client ID, obtained during app registration. */
+  readonly clientId: string;
+  /** The client secret, obtained during app registration. */
+  readonly clientSecret: string;
+  /** The previously obtained token, to be invalidated. */
+  readonly token: string;
+}
+
 export interface Client {
   readonly token: TokenRepository;
+
+  /**
+   * Revoke an access token to make it no longer valid for use.
+   * @param params Form data parameters
+   * @param meta HTTP metadata
+   * @see https://docs.joinmastodon.org/methods/oauth/#revoke
+   */
+  revoke(
+    params: RevokeTokenParams,
+    meta?: HttpMetaParams<"multipart-form">,
+  ): Promise<void>;
 }
diff --git a/tests/oauth/token.spec.ts b/tests/oauth/token.spec.ts
@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { createOAuthAPIClient } from "../../src";
 
-it("issues token", async () => {
+it("issues and revokes token", async () => {
   const oauth = createOAuthAPIClient({
     url: globalThis.__misc__.url,
   });
@@ -12,8 +12,14 @@ it("issues token", async () => {
     clientSecret: global.__misc__.app.clientSecret!,
     username: "admin@localhost",
     password: "mastodonadmin",
-    scope: "read write follow push admin:read admin:write",
+    scope: "read",
   });
 
   expect(token).toHaveProperty("accessToken");
+
+  await oauth.revoke({
+    clientId: global.__misc__.app.clientId!,
+    clientSecret: global.__misc__.app.clientSecret!,
+    token: token.accessToken!,
+  });
 });
