+ {tag && (
+
+ );
+}
+
+function CodePanel({
+ children,
+ tag,
+ label,
+ code,
+}: {
+ children: ReactNode;
+ tag?: string;
+ label?: string;
+ code?: string;
+}) {
+ const child = Children.only(children);
+
+ if (isValidElement(child)) {
+ tag = child.props.tag ?? tag;
+ label = child.props.label ?? label;
+ code = child.props.code ?? code;
+ }
+
+ if (!code) {
+ throw new Error(
+ "`CodePanel` requires a `code` prop, or a child with a `code` prop.",
+ );
+ }
+
+ return (
+
+ {tag}
+
+ )}
+ {tag && label && (
+
+ )}
+ {label && (
+ {label}
+ )}
+
+
+ );
+}
+
+function CodeGroupHeader({
+ title,
+ children,
+ selectedIndex,
+}: {
+ title: string;
+ children: ReactNode;
+ selectedIndex: number;
+}) {
+ const hasTabs = Children.count(children) > 1;
+
+ if (!(title || hasTabs)) {
+ return null;
+ }
+
+ return (
+
+
+
+ {children}
+
+
+ {title && (
+
+ {Children.map(children, (child, childIndex) => (
+
+ {getPanelTitle(
+ isValidElement(child) ? child.props : {},
+ )}
+
+ ))}
+
+ )}
+
+ );
+}
+
+function CodeGroupPanels({
+ children,
+ ...props
+}: ComponentPropsWithoutRef+ {title} +
+ )} + {hasTabs && ( +
+ {header}
+ {panels}
+
+
+
+ )}
+
+ {header}
+ {panels}
+
+ {children};
+}
+
+export function Pre({
+ children,
+ ...props
+}: ComponentPropsWithoutRef
-
-
-
-
\ No newline at end of file
diff --git a/components/Feedback.tsx b/components/Feedback.tsx
new file mode 100644
index 0000000..0e65c40
--- /dev/null
+++ b/components/Feedback.tsx
@@ -0,0 +1,110 @@
+"use client";
+
+import { Transition } from "@headlessui/react";
+import {
+ type ComponentPropsWithoutRef,
+ type ElementRef,
+ type FormEvent,
+ forwardRef,
+ useState,
+} from "react";
+
+function CheckIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+function FeedbackButton(
+ props: Omit
-
-
- Made by developers
-- Lysand is designed and maintained by the developers of the Lysand Server, which uses Lysand for - federation. This community could include you! Check out our Git repository to see how you can contribute. -
-
-
-
-
-
-
-
-
- {{ feature.name }}
-{{ feature.description }}
-
+
+ );
+ },
+);
+
+export function Feedback() {
+ const [submitted, setSubmitted] = useState(false);
+
+ function onSubmit(event: FormEvent
+
+
+
+
+
+
+
+ );
+}
diff --git a/components/Footer.tsx b/components/Footer.tsx
new file mode 100644
index 0000000..9e5e14d
--- /dev/null
+++ b/components/Footer.tsx
@@ -0,0 +1,153 @@
+"use client";
+
+import Link from "next/link";
+import { usePathname } from "next/navigation";
+
+import type { ComponentPropsWithoutRef, ComponentType, ReactNode } from "react";
+import { Button } from "./Button";
+import { navigation } from "./Navigation";
+
+function PageLink({
+ label,
+ page,
+ previous = false,
+}: {
+ label: string;
+ page: { href: string; title: string };
+ previous?: boolean;
+}) {
+ return (
+ <>
+
+
+ {page.title}
+
+
+ );
+}
+
+function PageNavigation() {
+ const pathname = usePathname();
+ const allPages = navigation.flatMap((group) => group.links);
+ const currentPageIndex = allPages.findIndex(
+ (page) => page.href === pathname,
+ );
+
+ if (currentPageIndex === -1) {
+ return null;
+ }
+
+ const previousPage = allPages[currentPageIndex - 1];
+ const nextPage = allPages[currentPageIndex + 1];
+
+ if (!(previousPage || nextPage)) {
+ return null;
+ }
+
+ return (
+
+ {previousPage && (
+
+ );
+}
+
+function XIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+function GitHubIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+function DiscordIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+function SocialLink({
+ href,
+ icon: Icon,
+ children,
+}: {
+ href: string;
+ icon: ComponentType<{ className?: string }>;
+ children: ReactNode;
+}) {
+ return (
+
+ {children}
+
+
+ )}
+ {nextPage && (
+
+
+ )}
+
+
+ );
+}
+
+export function Footer() {
+ return (
+
+ );
+}
diff --git a/components/GridPattern.tsx b/components/GridPattern.tsx
new file mode 100644
index 0000000..14fefc8
--- /dev/null
+++ b/components/GridPattern.tsx
@@ -0,0 +1,61 @@
+import { type ComponentPropsWithoutRef, useId } from "react";
+
+export function GridPattern({
+ width,
+ height,
+ x,
+ y,
+ squares,
+ ...props
+}: ComponentPropsWithoutRef<"svg"> & {
+ width: number;
+ height: number;
+ x: string | number;
+ y: string | number;
+ squares: [x: number, y: number][];
+}) {
+ const patternId = useId();
+
+ return (
+
+ );
+}
diff --git a/components/Guides.tsx b/components/Guides.tsx
new file mode 100644
index 0000000..42fac2e
--- /dev/null
+++ b/components/Guides.tsx
@@ -0,0 +1,58 @@
+import { Button } from "./Button";
+import { Heading } from "./Heading";
+
+const guides = [
+ {
+ href: "/authentication",
+ name: "Authentication",
+ description: "Learn how to authenticate your API requests.",
+ },
+ {
+ href: "/pagination",
+ name: "Pagination",
+ description: "Understand how to work with paginated responses.",
+ },
+ {
+ href: "/errors",
+ name: "Errors",
+ description:
+ "Read about the different types of errors returned by the API.",
+ },
+ {
+ href: "/webhooks",
+ name: "Webhooks",
+ description:
+ "Learn how to programmatically configure webhooks for your app.",
+ },
+];
+
+export function Guides() {
+ return (
+ + © Copyright {new Date().getFullYear()}. All rights + reserved. +
+
+
+ Follow us on X
+
+
+ Follow us on GitHub
+
+
+ Join our Discord server
+
+
+
+
+ Guides
+
+
+ );
+}
diff --git a/components/Header.tsx b/components/Header.tsx
new file mode 100644
index 0000000..f12d60c
--- /dev/null
+++ b/components/Header.tsx
@@ -0,0 +1,104 @@
+import clsx from "clsx";
+import { motion, useScroll, useTransform } from "framer-motion";
+import Link from "next/link";
+import {
+ type CSSProperties,
+ type ElementRef,
+ type ReactNode,
+ forwardRef,
+} from "react";
+
+import { Button } from "./Button";
+import { Logo } from "./Logo";
+import {
+ MobileNavigation,
+ useIsInsideMobileNavigation,
+} from "./MobileNavigation";
+import { useMobileNavigationStore } from "./MobileNavigation";
+import { MobileSearch, Search } from "./Search";
+import { ThemeToggle } from "./ThemeToggle";
+
+function TopLevelNavItem({
+ href,
+ children,
+}: {
+ href: string;
+ children: ReactNode;
+}) {
+ return (
+
+ {guides.map((guide) => (
+
+
+
+ ))}
+ + {guide.name} +
++ {guide.description} +
++ +
+
+
+
+
+
+
+
+
+
+
+
+
+ {tag && {tag} }
+ {tag && label && (
+
+ )}
+ {label && (
+ {label}
+ )}
+
+ );
+}
+
+function Anchor({
+ id,
+ inView,
+ children,
+}: {
+ id: string;
+ inView: boolean;
+ children: ReactNode;
+}) {
+ return (
+
+ {inView && (
+
+
+ )}
+ {children}
+
+ );
+}
+
+export function Heading
+
+
+
+ );
+}
diff --git a/components/Layout.tsx b/components/Layout.tsx
new file mode 100644
index 0000000..b07de15
--- /dev/null
+++ b/components/Layout.tsx
@@ -0,0 +1,47 @@
+"use client";
+
+import { motion } from "framer-motion";
+import Link from "next/link";
+import { usePathname } from "next/navigation";
+
+import type { ReactNode } from "react";
+import { Footer } from "./Footer";
+import { Header } from "./Header";
+import { Logo } from "./Logo";
+import { Navigation } from "./Navigation";
+import { type Section, SectionProvider } from "./SectionProvider";
+
+export function Layout({
+ children,
+ allSections,
+}: {
+ children: ReactNode;
+ allSections: Record
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {children}
+
+
+
+
+ Official libraries
+
+
+ );
+}
diff --git a/components/Logo.tsx b/components/Logo.tsx
new file mode 100644
index 0000000..b23dcd8
--- /dev/null
+++ b/components/Logo.tsx
@@ -0,0 +1,16 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function Logo(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/MobileNavigation.tsx b/components/MobileNavigation.tsx
new file mode 100644
index 0000000..73c43f0
--- /dev/null
+++ b/components/MobileNavigation.tsx
@@ -0,0 +1,182 @@
+"use client";
+
+import {
+ Dialog,
+ DialogPanel,
+ Transition,
+ TransitionChild,
+} from "@headlessui/react";
+import { motion } from "framer-motion";
+import { usePathname, useSearchParams } from "next/navigation";
+import {
+ type ComponentPropsWithoutRef,
+ type MouseEvent,
+ Suspense,
+ createContext,
+ useContext,
+ useEffect,
+ useRef,
+} from "react";
+import { create } from "zustand";
+
+import { Header } from "./Header";
+import { Navigation } from "./Navigation";
+
+function MenuIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+function XIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+const IsInsideMobileNavigationContext = createContext(false);
+
+function MobileNavigationDialog({
+ isOpen,
+ close,
+}: {
+ isOpen: boolean;
+ close: () => void;
+}) {
+ const pathname = usePathname();
+ const searchParams = useSearchParams();
+ const initialPathname = useRef(pathname).current;
+ const initialSearchParams = useRef(searchParams).current;
+
+ useEffect(() => {
+ if (
+ pathname !== initialPathname ||
+ searchParams !== initialSearchParams
+ ) {
+ close();
+ }
+ }, [pathname, searchParams, close, initialPathname, initialSearchParams]);
+
+ function onClickDialog(event: MouseEvent
+ {libraries.map((library) => (
+
+
+
+ ))}
+
+
+ + {library.name} +
++ {library.description} +
++ +
+
+
+ {isActiveGroup && (
+
+
+ {isActiveGroup && (
+
+
+ -
+ {group.links.map((link) => (
+
-
+
+ {section.title} + +
+ ))}
+
+
+ );
+}
+
+function ResourcePattern({
+ mouseX,
+ mouseY,
+ ...gridProps
+}: Resource["pattern"] & {
+ mouseX: MotionValue
+
+
+
+ );
+}
+
+function Resource({ resource }: { resource: Resource }) {
+ const mouseX = useMotionValue(0);
+ const mouseY = useMotionValue(0);
+
+ function onMouseMove({
+ currentTarget,
+ clientX,
+ clientY,
+ }: MouseEvent
+
+
+
+ );
+}
+
+export function Resources() {
+ return (
+
+
+ + + + {resource.name} + +
++ {resource.description} +
+
+
+ Resources
+
+
+ );
+}
diff --git a/components/Search.tsx b/components/Search.tsx
new file mode 100644
index 0000000..4d359eb
--- /dev/null
+++ b/components/Search.tsx
@@ -0,0 +1,511 @@
+"use client";
+
+import {
+ type AutocompleteApi,
+ type AutocompleteCollection,
+ type AutocompleteState,
+ createAutocomplete,
+} from "@algolia/autocomplete-core";
+import {
+ Dialog,
+ DialogPanel,
+ Transition,
+ TransitionChild,
+} from "@headlessui/react";
+import clsx from "clsx";
+import { useRouter } from "next/navigation";
+import {
+ type ComponentPropsWithoutRef,
+ type ElementRef,
+ Fragment,
+ type MouseEvent,
+ type KeyboardEvent as ReactKeyboardEvent,
+ Suspense,
+ type SyntheticEvent,
+ forwardRef,
+ useCallback,
+ useEffect,
+ useId,
+ useRef,
+ useState,
+} from "react";
+import Highlighter from "react-highlight-words";
+
+import type { Result } from "@/mdx/search.mjs";
+import { navigation } from "./Navigation";
+
+type EmptyObject = Record
+ {resources.map((resource) => (
+
+
+
+ );
+ }
+
+ return (
+ + Nothing found for{" "} + + ‘{query}’ + + . Please try again. +
+-
+ {collection.items.map((result, resultIndex) => (
+
+
+ );
+});
+
+function SearchDialog({
+ open,
+ setOpen,
+ className,
+}: {
+ open: boolean;
+ setOpen: (open: boolean) => void;
+ className?: string;
+}) {
+ const formRef = useRef
+
+ )}
+
+
+
+
+
+ );
+}
+
+export function MobileSearch() {
+ const { buttonProps, dialogProps } = useSearchProps();
+
+ return (
+
+
+
+
+
+ );
+}
diff --git a/components/SectionProvider.tsx b/components/SectionProvider.tsx
new file mode 100644
index 0000000..f891313
--- /dev/null
+++ b/components/SectionProvider.tsx
@@ -0,0 +1,165 @@
+"use client";
+
+import {
+ type ReactNode,
+ type RefObject,
+ createContext,
+ useContext,
+ useEffect,
+ useLayoutEffect,
+ useState,
+} from "react";
+import { type StoreApi, createStore, useStore } from "zustand";
+
+import { remToPx } from "../lib/remToPx";
+
+export interface Section {
+ id: string;
+ title: string;
+ offsetRem?: number;
+ tag?: string;
+ headingRef?: RefObject
-
-
-
-
diff --git a/components/ThemeToggle.tsx b/components/ThemeToggle.tsx
new file mode 100644
index 0000000..d74c77b
--- /dev/null
+++ b/components/ThemeToggle.tsx
@@ -0,0 +1,46 @@
+import { useTheme } from "next-themes";
+import { type ComponentPropsWithoutRef, useEffect, useState } from "react";
+
+function SunIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+function MoonIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
+
+export function ThemeToggle() {
+ const { resolvedTheme, setTheme } = useTheme();
+ const otherTheme = resolvedTheme === "dark" ? "light" : "dark";
+ const [mounted, setMounted] = useState(false);
+
+ useEffect(() => {
+ setMounted(true);
+ }, []);
+
+ return (
+
+ );
+}
diff --git a/components/icons/BellIcon.tsx b/components/icons/BellIcon.tsx
new file mode 100644
index 0000000..4aaffc1
--- /dev/null
+++ b/components/icons/BellIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function BellIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/BoltIcon.tsx b/components/icons/BoltIcon.tsx
new file mode 100644
index 0000000..fec1340
--- /dev/null
+++ b/components/icons/BoltIcon.tsx
@@ -0,0 +1,13 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function BoltIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/BookIcon.tsx b/components/icons/BookIcon.tsx
new file mode 100644
index 0000000..0de2b9a
--- /dev/null
+++ b/components/icons/BookIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function BookIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/CalendarIcon.tsx b/components/icons/CalendarIcon.tsx
new file mode 100644
index 0000000..8591b83
--- /dev/null
+++ b/components/icons/CalendarIcon.tsx
@@ -0,0 +1,25 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function CalendarIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/CartIcon.tsx b/components/icons/CartIcon.tsx
new file mode 100644
index 0000000..2d94c80
--- /dev/null
+++ b/components/icons/CartIcon.tsx
@@ -0,0 +1,17 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function CartIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/ChatBubbleIcon.tsx b/components/icons/ChatBubbleIcon.tsx
new file mode 100644
index 0000000..c891f18
--- /dev/null
+++ b/components/icons/ChatBubbleIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function ChatBubbleIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/CheckIcon.tsx b/components/icons/CheckIcon.tsx
new file mode 100644
index 0000000..66c075c
--- /dev/null
+++ b/components/icons/CheckIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function CheckIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/ChevronRightLeftIcon.tsx b/components/icons/ChevronRightLeftIcon.tsx
new file mode 100644
index 0000000..759a6f5
--- /dev/null
+++ b/components/icons/ChevronRightLeftIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function ChevronRightLeftIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/ClipboardIcon.tsx b/components/icons/ClipboardIcon.tsx
new file mode 100644
index 0000000..0618e4c
--- /dev/null
+++ b/components/icons/ClipboardIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function ClipboardIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/CogIcon.tsx b/components/icons/CogIcon.tsx
new file mode 100644
index 0000000..d76a6ca
--- /dev/null
+++ b/components/icons/CogIcon.tsx
@@ -0,0 +1,21 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function CogIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/CopyIcon.tsx b/components/icons/CopyIcon.tsx
new file mode 100644
index 0000000..d6a5284
--- /dev/null
+++ b/components/icons/CopyIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function CopyIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/DocumentIcon.tsx b/components/icons/DocumentIcon.tsx
new file mode 100644
index 0000000..d3b1fad
--- /dev/null
+++ b/components/icons/DocumentIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function DocumentIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/EnvelopeIcon.tsx b/components/icons/EnvelopeIcon.tsx
new file mode 100644
index 0000000..c9d93ee
--- /dev/null
+++ b/components/icons/EnvelopeIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function EnvelopeIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/FaceSmileIcon.tsx b/components/icons/FaceSmileIcon.tsx
new file mode 100644
index 0000000..9c1ef2d
--- /dev/null
+++ b/components/icons/FaceSmileIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function FaceSmileIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/FolderIcon.tsx b/components/icons/FolderIcon.tsx
new file mode 100644
index 0000000..45ea24f
--- /dev/null
+++ b/components/icons/FolderIcon.tsx
@@ -0,0 +1,24 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function FolderIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/LinkIcon.tsx b/components/icons/LinkIcon.tsx
new file mode 100644
index 0000000..bf05631
--- /dev/null
+++ b/components/icons/LinkIcon.tsx
@@ -0,0 +1,14 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function LinkIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/ListIcon.tsx b/components/icons/ListIcon.tsx
new file mode 100644
index 0000000..67b5086
--- /dev/null
+++ b/components/icons/ListIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function ListIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/MagnifyingGlassIcon.tsx b/components/icons/MagnifyingGlassIcon.tsx
new file mode 100644
index 0000000..88fe4fd
--- /dev/null
+++ b/components/icons/MagnifyingGlassIcon.tsx
@@ -0,0 +1,15 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function MagnifyingGlassIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/MapPinIcon.tsx b/components/icons/MapPinIcon.tsx
new file mode 100644
index 0000000..80f6b30
--- /dev/null
+++ b/components/icons/MapPinIcon.tsx
@@ -0,0 +1,21 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function MapPinIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/PackageIcon.tsx b/components/icons/PackageIcon.tsx
new file mode 100644
index 0000000..6b40664
--- /dev/null
+++ b/components/icons/PackageIcon.tsx
@@ -0,0 +1,18 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function PackageIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/PaperAirplaneIcon.tsx b/components/icons/PaperAirplaneIcon.tsx
new file mode 100644
index 0000000..c26431f
--- /dev/null
+++ b/components/icons/PaperAirplaneIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function PaperAirplaneIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/PaperClipIcon.tsx b/components/icons/PaperClipIcon.tsx
new file mode 100644
index 0000000..41eb143
--- /dev/null
+++ b/components/icons/PaperClipIcon.tsx
@@ -0,0 +1,14 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function PaperClipIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/ShapesIcon.tsx b/components/icons/ShapesIcon.tsx
new file mode 100644
index 0000000..63c2e61
--- /dev/null
+++ b/components/icons/ShapesIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function ShapesIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/ShirtIcon.tsx b/components/icons/ShirtIcon.tsx
new file mode 100644
index 0000000..1478246
--- /dev/null
+++ b/components/icons/ShirtIcon.tsx
@@ -0,0 +1,13 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function ShirtIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/SquaresPlusIcon.tsx b/components/icons/SquaresPlusIcon.tsx
new file mode 100644
index 0000000..0071df5
--- /dev/null
+++ b/components/icons/SquaresPlusIcon.tsx
@@ -0,0 +1,19 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function SquaresPlusIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/TagIcon.tsx b/components/icons/TagIcon.tsx
new file mode 100644
index 0000000..5b48882
--- /dev/null
+++ b/components/icons/TagIcon.tsx
@@ -0,0 +1,21 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function TagIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/UserIcon.tsx b/components/icons/UserIcon.tsx
new file mode 100644
index 0000000..bacc5e4
--- /dev/null
+++ b/components/icons/UserIcon.tsx
@@ -0,0 +1,26 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function UserIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/icons/UsersIcon.tsx b/components/icons/UsersIcon.tsx
new file mode 100644
index 0000000..934f348
--- /dev/null
+++ b/components/icons/UsersIcon.tsx
@@ -0,0 +1,30 @@
+import type { ComponentPropsWithoutRef } from "react";
+
+export function UsersIcon(props: ComponentPropsWithoutRef<"svg">) {
+ return (
+
+ );
+}
diff --git a/components/mdx.tsx b/components/mdx.tsx
new file mode 100644
index 0000000..cdac80e
--- /dev/null
+++ b/components/mdx.tsx
@@ -0,0 +1,126 @@
+import clsx from "clsx";
+import Link from "next/link";
+
+import type { ComponentPropsWithoutRef, ReactNode } from "react";
+import { Feedback } from "./Feedback";
+import { Heading } from "./Heading";
+import { Prose } from "./Prose";
+
+export const a = Link;
+// biome-ignore lint/performance/noBarrelFile:
-
- Thank you!
-- The Lysand project is made possible by the hard work of our contributors. Here are some of the people - who - have helped make Lysand what it is today. -
--
-
-
-
-
{{ person.name }}
-- {{ - role }} -
--
-
-
-
-
- -
-
- -
-
-
+
+ );
+}
+
+export function Row({ children }: { children: ReactNode }) {
+ return (
+
+ {children}
+
+
+ {children}
+
+ );
+}
+
+export function Col({
+ children,
+ sticky = false,
+}: {
+ children: ReactNode;
+ sticky?: boolean;
+}) {
+ return (
+ :first-child]:mt-0 [&>:last-child]:mb-0",
+ sticky && "xl:sticky xl:top-24",
+ )}
+ >
+ {children}
+
+ );
+}
+
+export function Properties({ children }: { children: ReactNode }) {
+ return (
+
+
+ );
+}
+
+export function Property({
+ name,
+ children,
+ type,
+}: {
+ name: string;
+ children: ReactNode;
+ type?: string;
+}) {
+ return (
+ -
+ {children}
+
-
+
- Name +
-
+
{name}+
+ {type && (
+ <>
+ - Type +
- + {type} + + + )} +
- Description +
- + {children} + +
-```
\ No newline at end of file
diff --git a/docs/extensions/events.md b/docs/extensions/events.md
deleted file mode 100644
index ea0ed86..0000000
--- a/docs/extensions/events.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Events
-
-With the Events extension, users can create events. This is useful for creating gatherings, such as meetups or parties.
-
-This extension is planned but not yet drafted.
\ No newline at end of file
diff --git a/docs/extensions/interactivity.md b/docs/extensions/interactivity.md
deleted file mode 100644
index 2a8cf1b..0000000
--- a/docs/extensions/interactivity.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# Interactivity
-
-> [!WARNING]
-> This extension is a work in progress and is not to be used in any production system. The specification is subject to change.
-
-On platforms like Discord, users can interact with messages with custom fields like buttons or dropdowns. This extension allows you to define these fields in your messages.
-
-
-
-...
\ No newline at end of file
diff --git a/docs/extensions/is-cat.md b/docs/extensions/is-cat.md
deleted file mode 100644
index 9e06169..0000000
--- a/docs/extensions/is-cat.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# IsCat
-
-> [!NOTE]
-> This is a **light-hearted** extension designed for amusement and not intended for serious application.
-
-> [!WARNING]
-> This extension may be superseded by the upcoming [Vanity Profiles](./vanity) extension.
-
-The IsCat feature allows users to communicate their cat status to others, similar to Misskey's "IsCat" feature.
-
-A user, referred to as an Actor, can specify their feline status using the following field:
-
-```json5
-{
- "type": "User",
- // ...
- "extensions": {
- "org.lysand:is_cat": {
- "cat": true,
- // Potential additional fields
- // "dog": true
- }
- }
-}
-```
-
-Clients **SHOULD** display an appropriate graphic to signify a user's cat status, such as adding cat ears to the user's avatar.
\ No newline at end of file
diff --git a/docs/extensions/microblogging.md b/docs/extensions/microblogging.md
deleted file mode 100644
index 4f894ed..0000000
--- a/docs/extensions/microblogging.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# Microblogging
-
-> [!WARNING]
->
-> Before Lysand 3.0, microblogging was directly integrated into the core spec. As of Lysand 3.0, microblogging has been moved to an extension, as part of a larger modularization effort. This document describes the new microblogging extension.
-
-The Microblogging extension allows users to perform certain tasks related to microblogging, such as "boosting" (reposting) posts.
-
-## Announce
-
-The `Announce` action signifies a user's intent to broadcast or share an object with their followers. This action is analogous to the "retweet" function on Twitter.
-
-
-`Announce`s can of course be deleted ("unboosting") with a classic [Undo](../objects/undo) object.
-
-Here's an example of an `Announce` action:
-
-```json5
-{
- "id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
- "type": "Extension",
- "extension_type": "org.lysand:microblogging/Announce",
- "author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
- "uri": "https://example.com/actions/3e7e4750-afd4-4d99-a256-02f0710a0520",
- "created_at": "2021-01-01T00:00:00.000Z",
- "object": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19"
-}
-```
-
-### Fields
-
-#### Author
-
-| Name | Type | Required |
-| :----- | :----- | :------- |
-| author | String | Yes |
-
-URI of the [Actor](../objects/actors) who initiated the action.
-
-#### Object
-
-| Name | Type | Required |
-| :----- | :----- | :------- |
-| object | String | Yes |
-
-URI of the object being announced. Must be of type [Note](../objects/note)
-
-#### Implementation
-
-When a [Note](../objects/note) object is announced, the client **SHOULD** display the original note with an indicator that it has been announced. The client **SHOULD** also display the number of times the note has been announced, such as a number next to a small icon like such on [Mastodon](https://joinmastodon.org/):
-
-
-
-Furthermore, users should be notified when their notes are announced by other users.
-
-
-## Types
-
-```typescript
-interface Announce extends Extension {
- extension_type: "org.lysand:microblogging/Announce";
- author: string;
- object: string;
-}
-```
-
diff --git a/docs/extensions/migration.md b/docs/extensions/migration.md
deleted file mode 100644
index d7591ed..0000000
--- a/docs/extensions/migration.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Migration
-
-Sometimes, users may wish to move from one instance to another. This could be due to a change in administration, a desire to be closer to friends, or any other reason. This document outlines an extension to make the process of moving instances easier.
-
-## User migrations
-
-The following object is used to represent a user migration:
-
-```json5
-{
- "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "type": "Extension",
- "extension_type": "org.lysand:migration/Migration",
- "author": "https://example.com/users/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "uri": "https://example.com/actions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "created_at": "2021-01-01T00:00:00.000Z",
- "destination": "https://otherinstance.social/users/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
-}
-```
-
-### Fields
-
-#### Author
-
-| Name | Type | Required |
-| :----- | :--- | :------- |
-| author | URI | Yes |
-
-URI of the [Actor](../objects/actors) who initiated the action. This Actor will be the user migrating.
-
-#### Destination
-
-| Name | Type | Required |
-| :---------- | :--- | :------- |
-| destination | URI | Yes |
-
-URI of the user's new account.
-
-### Implementation
-
-When an instance receives a `Migration` object, the client **SHOULD** display a notification to all followers of the migrating user. This notification **SHOULD** include a link to the user's new account.
-
-Furthermore, all following relationships of the migrating user **SHOULD** be transferred to the new account. This includes followers, following, and any other relationship that may exist. The old account **SHOULD** be marked as inactive and display a message indicating that the user has migrated to a new account.
-
-#### Server Actors
-
-If the user in question is a server actor, then it should be considered that the entire instance is migrating to a new address. In this case, the above process should be applied to all users on the instance.
\ No newline at end of file
diff --git a/docs/extensions/polls.md b/docs/extensions/polls.md
deleted file mode 100644
index eb3b7e9..0000000
--- a/docs/extensions/polls.md
+++ /dev/null
@@ -1,249 +0,0 @@
-# Polls
-
-The Polls extension enables users to generate polls/surveys, a valuable tool for soliciting feedback or opinions from users, such as "What is your preferred color?".
-
-Polls are incorporated as a new field under the [Note](../objects/note) Extensions, named `polls`. This field is an object that encapsulates the poll details.
-
-```json5
-{
- "id": "f08a124e-fe90-439e-8be4-15a428a72a19",
- "type": "Note",
- // ...
- "extensions": {
- "org.lysand:polls": {
- "poll": {
- "options": [
- {
- "text/plain": {
- "content": "Red"
- }
- },
- {
- "text/plain": {
- "content": "Blue"
- }
- },
- {
- "text/plain": {
- "content": "Green"
- }
- }
- ],
- "votes": [
- 9,
- 5,
- 0
- ],
- "multiple_choice": false,
- "expires_at": "2021-01-04T00:00:00.000Z"
- }
- }
- }
- // ...
-}
-```
-
-The fields are explained below.
-
-> [!NOTE]
-> There is no `question` field, as it is presumed that the question will be included in the `contents` field of the associated [Note](../objects/note). Clients are anticipated to render surveys adjacent to the contents of the [Note](../objects/note) itself.
-
-## Fields
-
-### Options
-
-| Name | Type | Required |
-| :------ | :--------------------- | :------- |
-| options | Array of ContentFormat | Yes |
-
-Displays the various options users can vote for.
-
-**MUST** contain at least 2 options, but does not have an upper limit for the number of options.
-
-> [!NOTE]
-> Servers should limit the number of options to a reasonable number, preferably in a configurable manner, such as 40. This is to prevent abuse of the protocol by sending a large number of options, as they are not paginated.
-
-### Votes
-
-| Name | Type | Required |
-| :---- | :--------------- | :------- |
-| votes | Array of Integer | Yes |
-
-Contains the number of votes cast for each option. The index of the array corresponds to the index of the option in the `options` array.
-
-Votes should not be public: the server should hide the users that casted votes and only show the total amount.
-
-### Multiple Choice
-
-| Name | Type | Required |
-| :-------------- | :------ | :------- |
-| multiple_choice | Boolean | No |
-
-Indicates whether the poll is multiple choice. If true, users can vote for multiple options. If false, users can only vote for one option.
-
-If not provided, it is assumed that the poll is not multiple choice.
-
-### Expiration
-
-| Name | Type | Required |
-| :--------- | :----- | :------- |
-| expires_at | String | Yes |
-
-The date and time when the poll expires. After this time, the poll is closed and no more votes can be cast.
-
-Clients **SHOULD** display the time remaining until the poll expires.
-
-### Integration With Custom Emojis
-
-If you implement both the Polls and the [Custom Emojis](./custom-emojis) extensions, you can use the Custom Emojis extension to add emojis to poll options.
-
-Example:
-```json5
-{
- // ...
- "extensions": {
- "org.lysand:polls": {
- "poll": {
- "options": [
- {
- "text/plain": {
- "content": "Red :red:"
- }
- },
- {
- "text/plain": {
- "content": "Blue :blue:"
- }
- },
- {
- "text/plain": {
- "content": "Green :green:"
- }
- }
- ],
- "votes": [
- 9,
- 5,
- 0
- ],
- "multiple_choice": false,
- "expires_at": "2021-01-04T00:00:00.000Z"
- }
- },
- "org.lysand:custom_emojis": {
- "emojis": [
- {
- "name": "red",
- "url": {
- "image/webp": {
- "content": "https://cdn.example.com/emojis/red.webp"
- }
- }
- },
- {
- "name": "blue",
- "url": {
- "image/webp": {
- "content": "https://cdn.example.com/emojis/blue.webp"
- }
- }
- },
- {
- "name": "green",
- "url": {
- "image/webp": {
- "content": "https://cdn.example.com/emojis/green.webp"
- }
- }
- }
- ]
- }
- }
- // ...
-}
-```
-
-When rendering the poll options, clients **SHOULD** display emojis as recommended by the [Custom Emojis](./custom-emojis) extension.
-
-### Poll Results
-
-Clients **SHOULD** display poll results as a percentage of votes. For example, if 10 users voted for the first option, and 5 users voted for the second option, the first option should be displayed as 66.67%, and the second option should be displayed as 33.33%. (with the third option being 0%)
-
-Clients **SHOULD** display the number of votes for each option, and the total number of votes.
-
-### Sending Votes
-
-Clients **SHOULD** allow users to vote on polls. When a user votes on a poll, the client **MUST** send a `POST` request to the poll's [Note](../objects/note) URI with the following JSON object in the body:
-
-```json5
-{
- "type": "Extension",
- "extension_type": "org.lysand:polls/Vote",
- "id": "6b1586cf-1f83-4d85-8d70-a5dc9f213b3e",
- "uri": "https://example.com/actions/6b1586cf-1f83-4d85-8d70-a5dc9f213b3e",
- "author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
- "poll": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19",
- "option": 0
-}
-```
-
-The `option` field **MUST** be the index of the option in the `options` array that the user is voting for.
-
-In return, the server **MUST** respond with a `200 OK` response code, and a JSON object in the body, unless there is an error. This JSON object **MUST** be a valid `VoteResult` object.
-
-```json5
-{
- "type": "Extension",
- "extension_type": "org.lysand:polls/VoteResult",
- "id": "d6eb84ea-cd13-43f9-9c54-01244da8e5e3",
- "uri": "https://example.com/actions/d6eb84ea-cd13-43f9-9c54-01244da8e5e3",
- "poll": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19",
- "votes": [
- 10,
- 5,
- 0
- ]
-}
-```
-
-Each number in the `votes` array corresponds to the number of votes for each option. The index of the array corresponds to the index of the poll option in the original Poll object.
-
-If the poll is closed, the server **MUST** respond with a `403 Forbidden` response code.
-
-The total amount of votes can be calculated by summing the `votes` array.
-
-This amount **MUST** include the user's vote, and **SHOULD** be displayed to the user after voting.
-
-### Poll Events
-
-When a poll ends, a user that has voted in it **SHOULD** be notified of the results by the server.
-
-The server **MAY** send a `GET` request to the poll's Publication URI to update its internal database.
-
-## Types
-
-```typescript
-interface Poll extends Extension {
- extension_type: "org.lysand:polls/Poll";
- options: ContentFormat[];
- votes: number[]; // unsigned 64-bit integer
- multiple_choice?: boolean;
- expires_at: string;
-}
-```
-
-```typescript
-interface Vote extends Extension {
- extension_type: "org.lysand:polls/Vote";
- poll: string;
- option: number; // unsigned 64-bit integer
-}
-```
-
-```typescript
-interface VoteResult extends Extension {
- extension_type: "org.lysand:polls/VoteResult";
- poll: string;
- votes: number[]; // unsigned 64-bit integer
-}
-```
diff --git a/docs/extensions/reactions.md b/docs/extensions/reactions.md
deleted file mode 100644
index 37bc253..0000000
--- a/docs/extensions/reactions.md
+++ /dev/null
@@ -1,151 +0,0 @@
-# Emoji Reactions
-
-The Emoji Reactions extension allows users to express their responses to objects using emojis, similar to the functionality provided by platforms like Facebook and Discord.
-
-Here's an example of a reaction to a post using this extension:
-
-```json5
-{
- "type": "Extension",
- "extension_type": "org.lysand:reactions/Reaction",
- "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
- "created_at": "2021-01-01T00:00:00.000Z",
- "object": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19",
- "content": "😀",
-}
-```
-## Fields
-
-### Type
-
-The `type` field **MUST BE** `Extension`.
-
-The `extension_type` field **MUST** be `org.lysand:reactions/Reaction`.
-
-### Object
-
-| Name | Type | Required |
-| :----- | :----- | :------- |
-| object | String | Yes |
-
-URI of the object that the user is reacting to. This **MUST** be a [Note](../objects/note) object.
-
-### Content
-
-| Name | Type | Required |
-| :------ | :----- | :------- |
-| content | String | Yes |
-
-Emoji that the user is reacting with.
-
-Clients **SHOULD** check if the value of `content` is an emoji: if it is not an emoji and instead is text, depending on which other extensions are implemented, it **MAY** be a [Custom Emoji](./custom-emojis).
-
-> [!NOTE]
-> If this field is not recognized as an emoji or [Custom Emoji](./custom-emojis), the whole Reaction object can be discarded as it is invalid.
->
-> Please see [Reactions With Custom Emojis](#reactions-with-custom-emojis) for more information about custom emoji reactions.
-
-
-### Retrieving Reactions
-
-Clients can retrieve reactions to an object by sending a `GET` request to the reaction [Collection](../structures/collection)'s URI.
-
-The URI of the reaction [Collection](../structures/collection) **MUST** be specified as follows, inside a [Note](../objects/note):
-```json5
-{
- // ...
- "extensions": {
- "org.lysand:reactions": {
- "reactions": "https://example.com/notes/f08a124e-fe90-439e-8be4-15a428a72a19/reactions"
- }
- }
-}
-```
-
-The `reactions` field is the URI of the reaction `Collection`.
-
-The server **MUST** respond with a [Collection](../structures/collection) object that contains a list of `Reaction` objects, as such:
-
-```json5
-{
- "type": "Collection",
- "first": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19/reactions?page=1",
- "last": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19/reactions?page=1",
- "total_count": 1,
- // "author": ... (for signatures)
- "items": [
- {
- "type": "Extension",
- "extension_type": "org.lysand:reactions/Reaction",
- "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
- "created_at": "2021-01-01T00:00:00.000Z",
- "object": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19",
- "content": "😀",
- }
- ]
-}
-```
-
-### Public Reaction Federation
-
-If a user reacts to a [Note](../objects/note), the user's server **MUST** federate the reaction to all its followers. This is to ensure that all users see the reaction.
-
-Note, however, that this does not mean that the reaction will be displayed to users. If the [Note](../objects/note), that was reacted to is not visible to a user, the reaction **MUST NOT** be displayed to the user, even if the user follows the user that reacted to the [Note](../objects/note),.
-
-### Private Reaction Federation
-
-If a user reacts to a [Note](../objects/note),, the user's server **MUST** federate the reaction to the author of the [Note](../objects/note),. This is to ensure that the author of the [Note](../objects/note), sees the reaction.
-
-### Reactions With Custom Emojis
-
-If you implement both the Reactions and the Custom Emojis extensions, you can use the Custom Emojis extension to react with custom emojis.
-
-The Reaction object needs to be modified as such:
-
-```json5
-{
- "type": "Extension",
- "extension_type": "org.lysand:reactions/Reaction",
- "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
- "created_at": "2021-01-01T00:00:00.000Z",
- "object": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19",
- "content": ":happy_face:",
- "extensions": {
- "org.lysand:custom_emojis": {
- "emojis": [
- {
- "name": "happy_face",
- "url": {
- "image/webp": {
- "content": "https://cdn.example.com/emojis/happy_face.webp",
- }
- }
- },
- // ...
- ]
- }
- }
-}
-```
-
-The only addition to the Reaction object is the `extensions` field, which contains the [Custom Emojis](./custom-emojis) extension.
-
-When rendering the Reaction object, clients **MUST** replace the `:emoji_name:` with the appropriate emoji. If the client does not support custom emojis, it **MUST** display the `:emoji_name:` as-is.
-
-This emoji must be rendered according to the rules of the [Custom Emojis](./custom-emojis) extension.
-
-## Types
-
-```typescript
-interface Reaction extends Extension {
- extension_type: "org.lysand:reactions/Reaction";
- object: string;
- content: string;
-}
-```
\ No newline at end of file
diff --git a/docs/extensions/reports.md b/docs/extensions/reports.md
deleted file mode 100644
index 5ca4823..0000000
--- a/docs/extensions/reports.md
+++ /dev/null
@@ -1,70 +0,0 @@
-# Reports
-
-The Reports extension enables users to flag content or users that violate the server's rules. This feature is important for maintaining a safe community environment.
-
-If the reporting user (reporter) and the reported user (reportee) are on the same server, the report can be handled directly without the need for federation. However, if the reporter and reportee are on different servers, the report **MUST** be federated to the reportee's server.
-
-## Report Object
-
-The report object encapsulates the details of the report. It is structured as follows:
-
-```json5
-{
- "type": "Extension",
- "extension_type": "org.lysand:reports/Report",
- "author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84",
- "id": "6f3001a1-641b-4763-a9c4-a089852eec84",
- "uri": "https://example.com/actions/f7bbf7fc-88d2-47dd-b241-5d1f770a10f0",
- "objects": [
- "https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa",
- "https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
- ],
- "reason": "spam",
- "comment": "This is spam."
-}
-```
-
-Report events **MUST** be sent to the server actor's inbox.
-
-## Fields
-
-### Objects
-
-| Name | Type | Required |
-| :------ | :-------------- | :------- |
-| objects | Array of String | Yes |
-
-URIs of the objects that are being reported.
-
-If `objects` contains Actors, then these Actors **MUST** be treated as the reported users.
-
-If `objects` contains Notes, then these Notes **MUST** be treated as the reported content.
-
-`objects` can contain any URI to any kind of objects, however, typically only Actors or Notes should be reportable.
-
-### Reason
-
-| Name | Type | Required |
-| :----- | :----- | :------- |
-| reason | String | Yes |
-
-The reason for the report. This should be a concise summary of the report, such as `"spam"`, `"hate speech"`, `"tos violation"`, etc.
-
-### Comment
-
-| Name | Type | Required |
-| :------ | :----- | :------- |
-| comment | String | No |
-
-Additional comments about the report. This is meant to provide a more detailed description of the report, such as `"This user has been spamming my inbox with advertisements."`.
-
-## Types
-
-```typescript
-interface Report extends Extension {
- extension_type: "org.lysand:reports/Report";
- objects: string[];
- reason: string;
- comment?: string;
-}
-```
\ No newline at end of file
diff --git a/docs/extensions/server-endorsement.md b/docs/extensions/server-endorsement.md
deleted file mode 100644
index a202b65..0000000
--- a/docs/extensions/server-endorsement.md
+++ /dev/null
@@ -1,78 +0,0 @@
-# Server Endorsement
-
-The Server Endorsement extension provides a mechanism for servers to vouch for the credibility of other servers. This is a valuable alternative to unrestricted federation, enabling servers to endorse those they deem trustworthy. Federation will only occur with endorsed servers and their subsequent endorsements, up to an admin-defined depth.
-
-## Endorsement Entity
-
-The endorsement entity encapsulates the details of an endorsement. It adheres to the following structure:
-
-```json5
-{
- "type": "Extension",
- "extension_type": "org.lysand:server_endorsement/Endorsement",
- "author": "https://example.com/actor", // The endorsing server's actor
- "id": "ed480922-b095-4f09-9da5-c995be8f5960",
- "uri": "https://example.com/actions/ed480922-b095-4f09-9da5-c995be8f5960",
- "server": "https://example.com",
-}
-```
-
-Endorsement entities **MUST** be dispatched to the endorsing server actor's inbox whenever the server administrators create a new endorsement.
-
-### Server
-
-| Name | Type | Required |
-| :----- | :----- | :------- |
-| server | String | Yes |
-
-URI of the endorsed server. This URI **MUST** correspond to the server's root endpoint, such as `https://example.com`.
-
-This URI **MUST NOT** be an IP address, except for development purposes.
-
-### Author
-
-| Name | Type | Required |
-| :----- | :----- | :------- |
-| author | String | Yes |
-
-The `author` field **MUST** represent the endorsing server actor. This requirement ensures that endorsements can be cryptographically signed using the server actor's `public_key`.
-
-## Endorsement Collection
-
-The URI for the endorsement collection can be specified within the server's metadata, under `extensions`:
-
-```json5
-{
- // ...
- "extensions": {
- "org.lysand:server_endorsement": {
- "endorsements": "https://example.com/endorsements"
- }
- }
- // ...
-}
-```
-
-This should return a [Collection](../structures/collection) of `Endorsement` entities.
-
-## Endorsement Protocol Behavior
-
-Upon receiving an endorsement, a server **MUST** validate the endorsement's signature. If the signature is invalid, the server **MUST** disregard the endorsement. This also applies when fetching the endorsement collection.
-
-The server has the discretion to decide how to handle the endorsement. Endorsements are intended to serve as a dynamic whitelist for servers, with administrators initially selecting a few trusted servers and progressively adding more.
-
-Servers **SHOULD** display received endorsements to their administrators, allowing them to accept or reject the endorsement. Ultimately, the decision on how to handle the endorsement lies with the administrators.
-
-Endorsements should be viewed as a seal of trust: If a server endorses another, it is expressing its trust in that server. Servers should refrain from endorsing servers they do not trust.
-
-Lastly, servers **MAY** verify the endorsements of the servers they have endorsed, up to a user-defined depth. This creates a trust chain, where servers endorse those they trust, and those servers, in turn, endorse servers they trust, and so forth.
-
-## Types
-
-```typescript
-interface Endorsement extends Extension {
- extension_type: "org.lysand:server_endorsement/Endorsement";
- author: string;
- server: string;
-}
-```
\ No newline at end of file
diff --git a/docs/extensions/vanity.md b/docs/extensions/vanity.md
deleted file mode 100644
index 3b20094..0000000
--- a/docs/extensions/vanity.md
+++ /dev/null
@@ -1,184 +0,0 @@
-# Vanity
-
-The Vanity extension allows users to customize their profile in a more in-depth manner.
-
-Here is an example object:
-```json5
-{
- // ...
- "type": "User",
- // ...
- "extensions": {
- "org.lysand:vanity": {
- "avatar_overlay": {
- "image/png": {
- "content": "https://cdn.example.com/ab5081cf-b11f-408f-92c2-7c246f290593/cat_ears.png",
- "content_type": "image/png"
- }
- },
- "avatar_mask": {
- "image/png": {
- "content": "https://cdn.example.com/d8c42be1-d0f7-43ef-b4ab-5f614e1beba4/rounded_square.jpeg",
- "content_type": "image/jpeg"
- }
- },
- "background": {
- "image/png": {
- "content": "https://cdn.example.com/6492ddcd-311e-4921-9567-41b497762b09/untitled-file-0019822.png",
- "content_type": "image/png"
- }
- },
- "audio": {
- "audio/mpeg": {
- "content": "https://cdn.example.com/4da2f0d4-4728-4819-83e4-d614e4c5bebc/michael-jackson-thriller.mp3",
- "content_type": "audio/mpeg"
- }
- },
- "pronouns": {
- "en-us": [
- "he/him",
- {
- "subject": "they",
- "object": "them",
- "dependent_possessive": "their",
- "independent_possessive": "theirs",
- "reflexive": "themself"
- },
- ]
- },
- "birthday": "1998-04-12",
- "location": "+40.6894-074.0447/",
- "activitypub": [
- "@erikuden@mastodon.de"
- ],
- "aliases": [
- "https://burger.social/accounts/349ee237-c672-41c1-aadc-677e185f795a",
- "https://social.lysand.org/users/f565ef02-035d-4974-ba5e-f62a8558331d"
- ]
- }
- }
-}
-```
-
-The extension name is `org.lysand:vanity`. All properties are optional.
-
-## Fields
-
-### Avatar Overlay
-
-| Name | Type | Required |
-| :------------- | :------------ | :------- |
-| avatar_overlay | ContentFormat | No |
-
-An overlay to be placed on top of the user's avatar. This can be used to add accessories, such as hats or glasses. Overlay should always be a transparent image.
-
-### Avatar Mask
-
-| Name | Type | Required |
-| :---------- | :------------ | :------- |
-| avatar_mask | ContentFormat | No |
-
-A mask to be applied to the user's avatar. This can be used to change the shape of the avatar, such as making it a circle or a rounded square. Mask should be a fully black (#000000) image with the shape of the mask being transparent. As such, a rounded square mask should have a fully black square with rounded corners.
-
-### Background
-
-| Name | Type | Required |
-| :--------- | :------------ | :------- |
-| background | ContentFormat | No |
-
-A background image to be displayed on the user's profile. This should be a full-width high-resolution image, preferably at least 1920x1080 pixels.
-
-Space-efficient formats such as WebP are recommended.
-
-### Audio
-
-| Name | Type | Required |
-| :---- | :------------ | :------- |
-| audio | ContentFormat | No |
-
-An audio file to be played on the user's profile. This can be used to add a theme song or a voice introduction.
-
-> [!WARNING]
-> Audio files should be muted by default and should not autoplay. Users should have the option to play the audio file, or disable them entirely.
->
-> Furthermore, audio file support in this extension should be toggleable per server, as it can be a potential vector for abuse.
-
-### Pronouns
-
-| Name | Type | Required |
-| :------- | :----------------------------------- | :------- |
-| pronouns | Array of ShortPronoun or LongPronoun | No |
-
-An array of pronouns the user uses. Pronouns can be represented as a string or an object.
-
-See [Types](#types) for a full description of the `ShortPronoun` and `LongPronoun` types.
-
-### Birthday
-
-| Name | Type | Required |
-| :------- | :----- | :------- |
-| birthday | String | No |
-
-The user's birthday. This should be in the format `YYYY-MM-DD` (ISO 8601). If the year is set to `0000`, clients should not display the year.
-
-Clients might choose to display the user's age as well when the year is present.
-
-### Location
-
-| Name | Type | Required |
-| :------- | :----- | :------- |
-| location | String | No |
-
-The user's location. This should be a string of GPS data as defined in [ISO 6709 Annex H](https://en.wikipedia.org/wiki/ISO_6709#String_expression_(Annex_H)), or alternatively a raw string such as "New York, NY". GPS data does not need to be precise, and can be as simple as `+46+002/` (France) or `+48.52+002.20/` (Paris, France).
-
-Clients might choose to display a map of the user's location.
-
-### ActivityPub
-
-| Name | Type | Required |
-| :--------- | :----- | :------- |
-| activitypub | Array of String | No |
-
-The user's ActivityPub profile. This should be an array of strings in the format `@username@domain`.
-
-Servers are expected to use standard WebFinger resolution to fetch the user's ActivityPub profile if needed.
-
-### Aliases
-
-| Name | Type | Required |
-| :------ | :----- | :------- |
-| aliases | Array of String | No |
-
-Aliases to the user's profile on other Lysand-compatible servers. This should be an array of URIs resolving to the user's Lysand object.
-
-## Types
-
-```typescript
-interface VanityExtension {
- avatar_overlay?: ContentFormat;
- avatar_mask?: ContentFormat;
- background?: ContentFormat;
- audio?: ContentFormat;
- pronouns?: {
- [language: string]: (ShortPronoun | LongPronoun)[];
- };
- birthday?: string;
- location?: string;
- activitypub?: string[];
- aliases?: string[];
-}
-```
-
-```typescript
-type ShortPronoun = string;
-```
-
-```typescript
-interface LongPronoun {
- subject: string;
- object: string;
- dependent_possessive: string;
- independent_possessive: string;
- reflexive: string;
-}
-```
\ No newline at end of file
diff --git a/docs/federation/endpoints.md b/docs/federation/endpoints.md
deleted file mode 100644
index f0ac925..0000000
--- a/docs/federation/endpoints.md
+++ /dev/null
@@ -1,198 +0,0 @@
-# Federation
-
-This section explains how federation operates within Lysand.
-
-Lysand's federation is built upon the HTTP stack. Servers interact with each other by exchanging HTTP requests.
-
-These requests are predominantly `POST` requests that carry a JSON object in the body. This JSON object **MUST** conform to the Lysand object schema.
-
-Servers that receive non-conforming Lysand objects **SHOULD** disregard these objects as invalid, and return a `400 Bad Request` response code (these could include debugging information in the response body).
-
-> [!NOTE]
-> Values such as `https://example.com/users/uuid` are example implementations and not a guide on how an implementation should format a URI. These must follow the rules outlined in [the base spec](../spec.md).
->
-## User Actor Endpoints
-
-When a server aims to retrieve the profile of a user on a differentserver, it follows the process outlined in [User Discovery](user-discovery).
-
-Upon discovering the target server's endpoints, the requesting server can issue a `GET` request to the user's endpoint to retrieve the user's actor.
-
-For instance, to fetch user information, the requesting server **MUST** send a `GET` request to the endpoint `https://example.com/users/uuid` with the required headers. The server can use either the [Server Actor](/federation/server-actor) or a requesting user's actor to sign the request, as appropriate depending on which actor the request is associated with.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Actor](../objects/actors) object.
-
-> [!NOTE]
-> While servers are not obligated to implement functionality between certain endpoints such as dislikes or featured notes, they **MUST** at least return an empty collection for these endpoints. Servers may also disregard any objects they do not handle, but should return a success response code.
-
-## User Inbox
-
-After the requesting server has discovered the target server's endpoints, it can issue a `POST` request to the `inbox` endpoint to transmit an object to the user. This process mirrors how objects are sent in ActivityPub.
-
-Typically, the inbox can be found at the same URL as the user's actor, but this is not a requirement. The server **MUST** specify the inbox URL in the actor object.
-
-Example inbox URL: `https://example.com/users/uuid/inbox`
-
-The requesting server **MUST** send a `POST` request to the endpoint `https://example.com/users/uuid/inbox` with the headers `Content-Type: application/json` and `Accept: application/json`.
-
-The body of the request **MUST** contain a valid Lysand object.
-
-Example with cURL (without signature):
-```bash
-curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{ \
- "type":"Publication", \
- "id":"6f27bc77-58ee-4c9b-b804-8cc1c1182fa9", \
- "uri":"https://example.com/publications/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9", \
- "author":"https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", \
- "created_at":"2021-01-01T00:00:00.000Z", \
- "contents":"Hello, world!" \
-}' https://example.com/users/uuid/inbox
-```
-
-The server **MUST** respond with a `201 CREATED` response code if the operation was successful.
-
-## User Outbox
-
-In Lysand, users have an outbox, which is a list of objects that the user has posted. This is akin to the outbox in ActivityPub.
-
-The server **MUST** specify the outbox URL in the actor object.
-
-Example outbox URL: `https://example.com/users/uuid/outbox`
-
-The requesting server **MUST** send a `GET` request to the outbox endpoint (`https://example.com/users/uuid/outbox`) with the headers `Accept: application/json`.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Collection](../structures/collection) object containing [Publications](../objects/publications).
-
-Example:
-
-```json5
-{
- "first": "https://example.com/users/uuid/outbox?page=1",
- "last": "https://example.com/users/uuid/outbox?page=1",
- // No next or prev attribute in this case, but they can exist
- "total_items": 1,
- "items": [
- {
- "type": "Note",
- "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "uri": "https://example.com/publications/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
- "author": "https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755",
- "created_at": "2021-01-01T00:00:00.000Z",
- "contents": [
- {
- "content": "Hello, world!",
- "content_type": "text/plain"
- }
- ],
- }
- ]
-}
-```
-
-These publications **MUST BE** ordered from newest to oldest, in descending order.
-
-## User Followers
-
-Users in Lysand have a list of followers, which is a list of users that follow the user. This is similar to the followers list in ActivityPub.
-
-> [!NOTE]
-> If you prefer not to display this list publicly, you can configure the followers endpoint to return an empty collection.
-
-The server **MUST** specify the followers URL in the actor object.
-
-Example followers URL: `https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/followers`
-
-The requesting server **MUST** send a `GET` request to the followers endpoint (`https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/followers`) with the headers `Accept: application/json`.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Collection](../structures/collection) object containing [Actors](../objects/actors). This collection may be empty.
-
-## User Following
-
-Users in Lysand have a followlist, which is a list of users that the user follows. This is similar to the following list in ActivityPub.
-
-> [!NOTE]
-> If you prefer not to display this list publicly, you can configure the following endpoint to return an empty collection.
-
-The server **MUST** specify the following URL in the actor object.
-
-Example following URL: `https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/following`
-
-The requesting server **MUST** send a `GET` request to the following endpoint (`https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/following`) with the headers `Accept: application/json`.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Collection](../structures/collection) object containing [Actors](../objects/actors). This collection may be empty.
-
-## User Featured Publications
-
-Users in Lysand have a list of featured publications, which is a list of publications that the user has pinned or deemed important. This is similar to the featured publications list in ActivityPub.
-
-> [!NOTE]
-> If you prefer not to display this list publicly, you can configure the featured publications endpoint to return an empty collection.
-
-The server **MUST** specify the featured publications URL in the actor object.
-
-Example featured publications URL: `https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/featured`
-
-The requesting server **MUST** send a `GET` request to the featured publications endpoint (`https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/featured`) with the headers `Accept: application/json`.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Collection](../structures/collection) object containing [Publications](../objects/publications). This collection may be empty.
-
-## User Likes
-
-Users in Lysand have a list of likes, which is a list of posts that the user has liked. This is similar to the likes list in ActivityPub.
-
-> [!NOTE]
-> If you prefer not to display this list publicly, you can configure the likes endpoint to return an empty collection.
-
-The server **MUST** specify the likes URL in the actor object.
-
-Example likes URL: `https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/likes`
-
-The requesting server **MUST** send a `GET` request to the likes endpoint (`https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/likes`) with the headers `Accept: application/json`.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Collection](../structures/collection) object containing [Publications](../objects/publications). This collection may be empty.
-
-
-## User Dislikes
-
-Users in Lysand have a list of dislikes, which is a list of posts that the user has disliked. This is similar to the dislikes list in ActivityPub.
-
-> [!NOTE]
-> If you prefer not to display this list publicly, you can configure the dislikes endpoint to return an empty collection.
-
-The server **MUST** specify the dislikes URL in the actor object.
-
-Example dislikes URL: `https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/dislikes`
-
-The requesting server **MUST** send a `GET` request to the dislikes endpoint (`https://example.com/users/731bae4a-9279-4b11-bd8f-f30af7bec755/dislikes`) with the headers `Accept: application/json`.
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [Collection](../structures/collection) object containing [Publications](../objects/publications). This collection may be empty.
-
-## Server Discovery
-
-> [!NOTE]
-> The terms "the server" and "the requesting server" are used in this section. "The server" refers to the server that is being discovered, and "the requesting server" refers to the server that is attempting to discover the server.
-
-To retrieve the metadata of a server, the requesting server **MUST** send a `GET` request to the endpoint `https://example.com/.well-known/lysand`.
-
-The requesting server **MUST** send the following headers with the request:
-```
-Accept: application/json
-```
-
-The server **MUST** respond with a `200 OK` response code, and a JSON object in the body. This JSON object **MUST** be a valid [ServerMetadata](../objects/server-metadata) object.
-
-Example:
-
-```json5
-{
- "type": "ServerMetadata",
- "name": "Example",
- "uri": "https://example.com",
- "version": "1.0.0",
- "supported_extensions": [
- "org.lysand:reactions",
- "org.lysand:polls",
- "org.lysand:custom_emojis",
- "org.lysand:is_cat"
- ]
-}
-```
diff --git a/docs/federation/server-actor.md b/docs/federation/server-actor.md
deleted file mode 100644
index 7bf937c..0000000
--- a/docs/federation/server-actor.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# Server Actor
-
-Servers **MUST** have an Actor object that represents the server. This Actor object **MUST** be a valid User object.
-
-The Actor object can be found by sending a WebFinger request to the server's WebFinger endpoint for `actor@server.com`. For more information about WebFinger, please see [User Discovery](/federation/user-discovery).
-
-The Actor object **MUST** contain a `public_key` field that contains the public key of the server. This public key **MUST** be used to sign all requests sent by the server when the `author` field of an object is the server actor.
-
-The server actor **MUST** be used to sign all requests sent by the server when the `author` field of an object is the server actor.
-
-The server actor **SHOULD** contain empty data fields, such as `display_name` and `bio`. However, if the server actor does contain data fields, they **MUST** be valid, as with any actor.
\ No newline at end of file
diff --git a/docs/federation/user-discovery.md b/docs/federation/user-discovery.md
deleted file mode 100644
index 96ce849..0000000
--- a/docs/federation/user-discovery.md
+++ /dev/null
@@ -1,78 +0,0 @@
-# User Discovery
-
-> [!NOTE]
-> The terms "the server" and "the requesting server" are used in this section. "The server" refers to the server that is being discovered, and "the requesting server" refers to the server that is trying to discover the server.
-
-Servers **MUST** implement the [WebFinger](https://tools.ietf.org/html/rfc7033) protocol to allow other servers to discover their endpoints. This is done by serving a `host-meta` file at the address `/.well-known/host-meta`.
-
-The document **MUST** contain the following information, as specified by the WebFinger protocol:
-
-```xml
-
-