From ac96922bd3df7e97b8d7bebfc1662085ca67eee3 Mon Sep 17 00:00:00 2001
From: Jesse Wierzbinski <contact@cpluspatch.com>
Date: Sun, 25 Aug 2024 18:42:04 +0200
Subject: [PATCH] feat: :sparkles: Add Reports

---
 app/extensions/reports/page.mdx | 53 +++++++++++++++++++++++++++++++++
 components/Navigation.tsx       |  1 +
 2 files changed, 54 insertions(+)
 create mode 100644 app/extensions/reports/page.mdx

diff --git a/app/extensions/reports/page.mdx b/app/extensions/reports/page.mdx
new file mode 100644
index 0000000..48c4de0
--- /dev/null
+++ b/app/extensions/reports/page.mdx
@@ -0,0 +1,53 @@
+export const metadata = {
+    "title": "Reports Extension",
+    "description": "Reporting can be used to report content to moderators or administrators of a remote instance for review."
+}
+
+# Reports Extension
+
+Reporting can be used to report content to moderators or administrators of a remote instance for review. {{ className: 'lead' }}
+
+When an instance receives a report, it *should* be reviewed by a moderator or administrator.
+
+## Entity Definition
+
+<Row>
+    <Col>
+        <Properties>
+            <Property name="type" type="string" required={true}>
+                Must be `pub.versia:reports/Report`.
+            </Property>
+            <Property name="author" type="URI" required={false} typeLink="/types#uri">
+                URI of the reporting [User](/entities/user). Optional if the report is anonymous.
+            </Property>
+            <Property name="reported" type="URI[]" required={true} typeLink="/types#uri">
+                URIs of the content being reported.
+            </Property>
+            <Property name="reason" type="string" required={true}>
+                Reason for the report. Should be concise and clear, such as `spam`, `harassment`, `misinformation`, etc.
+            </Property>
+            <Property name="comment" type="string" required={false}>
+                Additional comments about the report. Can be used to provide more context or details.
+            </Property>
+        </Properties>
+    </Col>
+
+    <Col sticky>
+
+    ```jsonc {{ title: "Example Report" }}
+    {
+        "id": "6f3001a1-641b-4763-a9c4-a089852eec84",
+        "type": "pub.versia:reports/Report",
+        "author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84",
+        "uri": "https://example.com/reports/f7bbf7fc-88d2-47dd-b241-5d1f770a10f0",
+        "reported": [
+            "https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa",
+            "https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
+        ],
+        "reason": "spam",
+        "comment": "This is spam."
+    }
+    ```
+
+    </Col>
+</Row>
\ No newline at end of file
diff --git a/components/Navigation.tsx b/components/Navigation.tsx
index fc9e49f..fe4d12d 100644
--- a/components/Navigation.tsx
+++ b/components/Navigation.tsx
@@ -292,6 +292,7 @@ export const navigation: NavGroup[] = [
             { title: "Likes", href: "/extensions/likes" },
             { title: "Polls", href: "/extensions/polls" },
             { title: "Reactions", href: "/extensions/reactions" },
+            { title: "Reports", href: "/extensions/reports" },
             { title: "Share", href: "/extensions/share" },
             { title: "Vanity", href: "/extensions/vanity" },
             { title: "WebSockets", href: "/extensions/websockets" },