fix: Add missing public domain block API (#1214)

neet · web-flow · commit 884b83d14563 · 2024-10-13T04:50:06.000Z
diff --git a/src/mastodon/entities/v1/domain-block.ts b/src/mastodon/entities/v1/domain-block.ts
@@ -0,0 +1,15 @@
+/**
+ * Represents a domain that is blocked by the instance.
+ */
+export interface DomainBlock {
+  /** The domain which is blocked. This may be obfuscated or partially censored. */
+  domain: string;
+  /** The SHA256 hash digest of the domain string. */
+  digest: string;
+  /** The level to which the domain is blocked. */
+  severity: DomainBlockSeverity;
+  /** An optional reason for the domain block. */
+  comment?: string | null;
+}
+
+export type DomainBlockSeverity = "silence" | "suspend";
diff --git a/src/mastodon/entities/v1/index.ts b/src/mastodon/entities/v1/index.ts
@@ -7,6 +7,7 @@ export * from "./context";
 export * from "./conversation";
 export * from "./custom-emoji";
 export * from "./extended-description";
+export * from "./domain-block";
 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,6 +1,7 @@
 import { type HttpMetaParams } from "../../../interfaces";
 import {
   type Activity,
+  type DomainBlock,
   type ExtendedDescription,
   type Instance,
 } from "../../entities/v1";
@@ -48,4 +49,12 @@ export interface InstanceRepository {
     /** https://github.com/mastodon/mastodon/pull/24037 */
     list(meta?: HttpMetaParams): Promise<Record<string, string[]>>;
   };
+
+  domainBlocks: {
+    /**
+     * Obtain a list of domains that have been blocked.
+     * @see https://docs.joinmastodon.org/methods/instance/#domain_blocks
+     */
+    fetch(meta?: HttpMetaParams): Promise<DomainBlock[]>;
+  };
 }
diff --git a/tests/rest/v1/instance.spec.ts b/tests/rest/v1/instance.spec.ts
@@ -32,3 +32,11 @@ it("fetches extended description", async () => {
     updatedAt: null,
   });
 });
+
+test.todo("lists domain blocks");
+// FIXME: domain blocks publicity setting can only be edited via the admin panel
+// it("lists domain blocks", async () => {
+//   await using client = await sessions.acquire();
+//   const blocks = await client.rest.v1.instance.domainBlocks.fetch();
+//   expect(blocks).toEqual([]);
+// });
