fix: Add missing v1.instance.extendedDescription API (#1212)

neet · web-flow · commit 74681b3ca019 · 2024-10-13T13:32:53.000+09:00
diff --git a/src/mastodon/entities/v1/extended-description.ts b/src/mastodon/entities/v1/extended-description.ts
@@ -0,0 +1,9 @@
+/**
+ * Represents an extended description for the instance, to be shown on its about page.
+ */
+export interface ExtendedDescription {
+  /** The rendered HTML content of the extended description. */
+  content: string;
+  /** A timestamp of when the extended description was last updated. */
+  updatedAt?: string | null;
+}
diff --git a/src/mastodon/entities/v1/index.ts b/src/mastodon/entities/v1/index.ts
@@ -6,6 +6,7 @@ export * from "./application";
 export * from "./context";
 export * from "./conversation";
 export * from "./custom-emoji";
+export * from "./extended-description";
 export * from "./familiar-followers";
 export * from "./featured-tags";
 export * from "./filter";
diff --git a/src/mastodon/rest/v1/instance-repository.ts b/src/mastodon/rest/v1/instance-repository.ts
@@ -1,5 +1,9 @@
 import { type HttpMetaParams } from "../../../interfaces";
-import { type Activity, type Instance } from "../../entities/v1";
+import {
+  type Activity,
+  type ExtendedDescription,
+  type Instance,
+} from "../../entities/v1";
 import { type Paginator } from "../../paginator";
 
 export interface InstanceRepository {
@@ -33,6 +37,13 @@ export interface InstanceRepository {
     list(meta?: HttpMetaParams): Promise<string[]>;
   };
 
+  extendedDescription: {
+    /**
+     * Obtain an extended description of this server
+     */
+    fetch(meta?: HttpMetaParams): Promise<ExtendedDescription>;
+  };
+
   translationLanguages: {
     /** https://github.com/mastodon/mastodon/pull/24037 */
     list(meta?: HttpMetaParams): Promise<Record<string, string[]>>;
diff --git a/tests/rest/v1/instance.spec.ts b/tests/rest/v1/instance.spec.ts
@@ -21,3 +21,14 @@ it("lists translatable languages", async () => {
   const languages = await client.rest.v1.instance.translationLanguages.list();
   expect(languages).toEqual(expect.any(Object));
 });
+
+it("fetches extended description", async () => {
+  await using client = await sessions.acquire();
+  const description = await client.rest.v1.instance.extendedDescription.fetch();
+
+  expect(description).toEqual({
+    content: "",
+    // eslint-disable-next-line unicorn/no-null
+    updatedAt: null,
+  });
+});
