A lexicon-driven AppView for ATProto.
Something went wrong. Try again.
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716import type { ApiKeySummary, CreateApiKeyResponse } from "@/types/api-keys";import type { StatsResponse } from "@/types/stats";import type { LexiconSummary, LexiconDetail } from "@/types/lexicons";import type { NetworkLexiconSummary } from "@/types/network-lexicons";import type { BackfillJob } from "@/types/backfill";import type { UserSummary } from "@/types/users";import type { AdminListRecordsResponse } from "@/types/records";import type { EventsListResponse } from "@/types/events";import type { ScriptVariableSummary } from "@/types/script-variables";import type { LabelerSummary } from "@/types/labelers";import type { ApiClientSummary, CreateApiClientResponse,} from "@/types/api-clients";import type { SettingEntry } from "@/types/settings";import type { ExternalProvider, LinkedAccount, AuthorizeResponse, SyncResponse, UnlinkResponse, ConnectResponse,} from "@/types/external-accounts";import type { DeadLettersListResponse, DeadLetterDetail, DeadLetterCountResponse, BulkActionResponse,} from "@/types/dead-letters";
export type { ApiKeySummary, CreateApiKeyResponse } from "@/types/api-keys";export type { CollectionStat, StatsResponse } from "@/types/stats";export type { LexiconSummary, LexiconDetail } from "@/types/lexicons";export type { NetworkLexiconSummary } from "@/types/network-lexicons";export type { BackfillJob } from "@/types/backfill";export type { UserSummary } from "@/types/users";export type { AdminRecord, AdminListRecordsResponse } from "@/types/records";export type { EventLogEntry, EventsListResponse } from "@/types/events";export type { ScriptVariableSummary } from "@/types/script-variables";export type { LabelerSummary } from "@/types/labelers";export type { RecordLabel } from "@/types/records";export type { ApiClientSummary, CreateApiClientResponse,} from "@/types/api-clients";export type { SettingEntry, InstanceSettings } from "@/types/settings";export { INSTANCE_SETTING_KEYS } from "@/types/settings";export type { ExternalProvider, LinkedAccount, AuthorizeResponse, SyncResponse, UnlinkResponse, ConnectResponse, ConfigSchema, ConfigProperty,} from "@/types/external-accounts";export type { DeadLetterSummary, DeadLetterDetail, DeadLettersListResponse, DeadLetterCountResponse, BulkActionResponse,} from "@/types/dead-letters";
const BASE_PATH = process.env.NEXT_PUBLIC_BASE_PATH || "";
export class ApiError extends Error { status: number; constructor(status: number, message: string) { super(message); this.status = status; }}
async function apiFetch<T = unknown>( path: string, options?: RequestInit,): Promise<T> { const headers: Record<string, string> = {}; if ( options?.method === "POST" || options?.method === "PUT" || options?.method === "PATCH" ) { headers["Content-Type"] = "application/json"; }
const res = await fetch(`${BASE_PATH}${path}`, { ...options, headers: { ...headers, ...options?.headers }, credentials: "same-origin", });
if (!res.ok) { const text = await res.text().catch(() => res.statusText); throw new ApiError(res.status, text); } if (res.status === 204) return null as T; const text = await res.text(); if (!text) return null as T; return JSON.parse(text);}
// Statsexport function getStats() { return apiFetch<StatsResponse>("/admin/stats");}
// Lexiconsexport function getLexicons() { return apiFetch<LexiconSummary[]>("/admin/lexicons");}
export function getLexicon(id: string) { return apiFetch<LexiconDetail>(`/admin/lexicons/${encodeURIComponent(id)}`);}
export function uploadLexicon(body: { lexicon_json: unknown; backfill?: boolean; target_collection?: string; action?: string; script?: string; index_hook?: string; token_cost?: number | null;}) { return apiFetch<{ id: string; revision: number }>("/admin/lexicons", { method: "POST", body: JSON.stringify(body), });}
export function deleteLexicon(id: string) { return apiFetch(`/admin/lexicons/${encodeURIComponent(id)}`, { method: "DELETE", });}
// Network Lexiconsexport function getNetworkLexicons() { return apiFetch<NetworkLexiconSummary[]>("/admin/network-lexicons");}
export function addNetworkLexicon(body: { nsid: string; target_collection?: string;}) { return apiFetch<{ nsid: string; authority_did: string; revision: number }>( "/admin/network-lexicons", { method: "POST", body: JSON.stringify(body) }, );}
export function deleteNetworkLexicon(nsid: string) { return apiFetch(`/admin/network-lexicons/${encodeURIComponent(nsid)}`, { method: "DELETE", });}
// Backfillexport function getBackfillJobs() { return apiFetch<BackfillJob[]>("/admin/backfill/status");}
export function createBackfillJob(body: { collection?: string; did?: string }) { return apiFetch<{ id: string; status: string }>("/admin/backfill", { method: "POST", body: JSON.stringify(body), });}
export function cancelBackfillJob(id: string) { return apiFetch<{ id: string; status: string }>( `/admin/backfill/${id}/cancel`, { method: "POST" }, );}
// Usersexport function getUsers() { return apiFetch<UserSummary[]>("/admin/users");}
export function getUser(id: string) { return apiFetch<UserSummary>(`/admin/users/${encodeURIComponent(id)}`);}
export function addUser(body: { did: string; template?: string; permissions?: string[];}) { return apiFetch<{ id: string; did: string }>("/admin/users", { method: "POST", body: JSON.stringify(body), });}
export function deleteUser(id: string) { return apiFetch(`/admin/users/${encodeURIComponent(id)}`, { method: "DELETE", });}
export function updateUserPermissions( id: string, body: { grant?: string[]; revoke?: string[] },) { return apiFetch(`/admin/users/${encodeURIComponent(id)}/permissions`, { method: "PATCH", body: JSON.stringify(body), });}
export function transferSuper(body: { target_user_id: string }) { return apiFetch("/admin/users/transfer-super", { method: "POST", body: JSON.stringify(body), });}
// Permissions catalogexport type PermissionEntry = { key: string; name: string; description: string; category: string;};
export type PermissionTemplate = { key: string; label: string; permissions: string[];};
export type PermissionsCatalog = { permissions: PermissionEntry[]; templates: PermissionTemplate[];};
export function getPermissions() { return apiFetch<PermissionsCatalog>("/admin/permissions");}
// API Keysexport function getApiKeys() { return apiFetch<ApiKeySummary[]>("/admin/api-keys");}
export function createApiKey(body: { name: string; permissions: string[] }) { return apiFetch<CreateApiKeyResponse>("/admin/api-keys", { method: "POST", body: JSON.stringify(body), });}
export function revokeApiKey(id: string) { return apiFetch(`/admin/api-keys/${encodeURIComponent(id)}`, { method: "DELETE", });}
// XRPC (public, no auth needed)export async function xrpcQuery<T = unknown>( method: string, params?: Record<string, string>,): Promise<T> { const search = params ? `?${new URLSearchParams(params)}` : ""; const res = await fetch( `${BASE_PATH}/xrpc/${encodeURIComponent(method)}${search}`, ); if (!res.ok) { const text = await res.text().catch(() => res.statusText); throw new ApiError(res.status, text); } return res.json();}
// Admin records browsingexport function getAdminRecords( collection: string, limit?: number, cursor?: string,) { const params = new URLSearchParams({ collection }); if (limit) params.set("limit", String(limit)); if (cursor) params.set("cursor", cursor); return apiFetch<AdminListRecordsResponse>(`/admin/records?${params}`);}
export function deleteRecord(uri: string) { return apiFetch(`/admin/records?${new URLSearchParams({ uri })}`, { method: "DELETE", });}
export function deleteCollectionRecords(collection: string) { return apiFetch<{ deleted: number }>( `/admin/records/collection?${new URLSearchParams({ collection })}`, { method: "DELETE" }, );}
// Script Variablesexport function getScriptVariables() { return apiFetch<ScriptVariableSummary[]>("/admin/script-variables");}
export function upsertScriptVariable(body: { key: string; value: string }) { return apiFetch("/admin/script-variables", { method: "POST", body: JSON.stringify(body), });}
export function deleteScriptVariable(key: string) { return apiFetch(`/admin/script-variables/${encodeURIComponent(key)}`, { method: "DELETE", });}
// Settingsexport function getSettings() { return apiFetch<SettingEntry[]>("/admin/settings");}
export function upsertSetting(key: string, value: string) { return apiFetch(`/admin/settings/${encodeURIComponent(key)}`, { method: "PUT", body: JSON.stringify({ value }), });}
export function deleteSetting(key: string) { return apiFetch(`/admin/settings/${encodeURIComponent(key)}`, { method: "DELETE", });}
export async function uploadLogo(file: File) { const formData = new FormData(); formData.append("file", file); const res = await fetch(`${BASE_PATH}/admin/settings/logo`, { method: "PUT", body: formData, credentials: "same-origin", }); if (!res.ok) { const text = await res.text().catch(() => res.statusText); throw new ApiError(res.status, text); }}
export function deleteLogo() { return apiFetch("/admin/settings/logo", { method: "DELETE" });}
// Feature Flagsexport type FeatureFlag = { key: string; name: string; description: string; enabled: boolean;};
export function getFeatureFlags() { return apiFetch<FeatureFlag[]>("/admin/feature-flags");}
export function setFeatureFlag(key: string, enabled: boolean) { if (enabled) { return upsertSetting(key, "true"); } return deleteSetting(key);}
// Proxy configexport type ProxyConfig = { mode: "disabled" | "open" | "allowlist" | "blocklist"; nsids: string[];};
export function getProxyConfig() { return apiFetch<ProxyConfig>("/admin/settings/xrpc-proxy");}
export function updateProxyConfig(config: ProxyConfig) { return apiFetch("/admin/settings/xrpc-proxy", { method: "PUT", body: JSON.stringify(config), });}
// Labelersexport function getLabelers() { return apiFetch<LabelerSummary[]>("/admin/labelers");}
export function addLabeler(body: { did: string }) { return apiFetch("/admin/labelers", { method: "POST", body: JSON.stringify(body), });}
export function updateLabeler(did: string, body: { status: string }) { return apiFetch(`/admin/labelers/${encodeURIComponent(did)}`, { method: "PATCH", body: JSON.stringify(body), });}
export function deleteLabeler(did: string) { return apiFetch(`/admin/labelers/${encodeURIComponent(did)}`, { method: "DELETE", });}
// API Clientsexport function getApiClients() { return apiFetch<ApiClientSummary[]>("/admin/api-clients");}
export function getApiClient(id: string) { return apiFetch<ApiClientSummary>( `/admin/api-clients/${encodeURIComponent(id)}`, );}
export function createApiClient(body: { name: string; client_id_url: string; client_uri: string; redirect_uris: string[]; scopes?: string; client_type?: string; allowed_origins?: string[]; rate_limit_capacity: number | null; rate_limit_refill_rate: number | null;}) { return apiFetch<CreateApiClientResponse>("/admin/api-clients", { method: "POST", body: JSON.stringify(body), });}
export function updateApiClient( id: string, body: { name?: string; client_uri?: string; redirect_uris?: string[]; scopes?: string; allowed_origins?: string[] | null; rate_limit_capacity?: number | null; rate_limit_refill_rate?: number | null; is_active?: boolean; },) { return apiFetch(`/admin/api-clients/${encodeURIComponent(id)}`, { method: "PUT", body: JSON.stringify(body), });}
export function deleteApiClient(id: string) { return apiFetch(`/admin/api-clients/${encodeURIComponent(id)}`, { method: "DELETE", });}
// Event Logsexport function getEvents(params?: { category?: string; severity?: string; subject?: string; cursor?: string; limit?: number;}) { const searchParams = new URLSearchParams(); if (params?.category) searchParams.set("category", params.category); if (params?.severity) searchParams.set("severity", params.severity); if (params?.subject) searchParams.set("subject", params.subject); if (params?.cursor) searchParams.set("cursor", params.cursor); if (params?.limit) searchParams.set("limit", String(params.limit)); const qs = searchParams.toString(); return apiFetch<EventsListResponse>(`/admin/events${qs ? `?${qs}` : ""}`);}
// External Accountsexport function getExternalProviders() { return apiFetch<ExternalProvider[]>("/external-auth/providers");}
export function getLinkedAccounts() { return apiFetch<LinkedAccount[]>("/external-auth/accounts");}
export function authorizeExternal(pluginId: string, redirectUri: string) { const params = new URLSearchParams({ redirect_uri: redirectUri }); return apiFetch<AuthorizeResponse>( `/external-auth/${encodeURIComponent(pluginId)}/authorize?${params}`, );}
export function syncExternal(pluginId: string) { return apiFetch<SyncResponse>( `/external-auth/${encodeURIComponent(pluginId)}/sync`, { method: "POST" }, );}
export function unlinkExternal(pluginId: string) { return apiFetch<UnlinkResponse>( `/external-auth/${encodeURIComponent(pluginId)}/unlink`, { method: "POST" }, );}
export function connectWithConfig( pluginId: string, config: Record<string, unknown>,) { return apiFetch<ConnectResponse>( `/external-auth/${encodeURIComponent(pluginId)}/connect`, { method: "POST", body: JSON.stringify({ config }) }, );}
// Pluginsimport type { PluginSummary, PluginsListResponse, OfficialPluginsListResponse,} from "@/types/plugins";export type { PluginSummary, PluginsListResponse, OfficialPluginSummary, OfficialPluginsListResponse, ReleaseEntry,} from "@/types/plugins";
export function getPlugins() { return apiFetch<PluginsListResponse>("/admin/plugins");}
export function addPlugin(body: { url: string; sha256?: string }) { return apiFetch<PluginSummary>("/admin/plugins", { method: "POST", body: JSON.stringify(body), });}
export function removePlugin(id: string) { return apiFetch(`/admin/plugins/${encodeURIComponent(id)}`, { method: "DELETE", });}
export function reloadPlugin(id: string, body?: { url?: string }) { return apiFetch<PluginSummary>( `/admin/plugins/${encodeURIComponent(id)}/reload`, { method: "POST", body: body ? JSON.stringify(body) : undefined, }, );}
export function getOfficialPlugins() { return apiFetch<OfficialPluginsListResponse>("/admin/plugins/official");}
export function checkPluginUpdate(id: string) { return apiFetch<PluginSummary>( `/admin/plugins/${encodeURIComponent(id)}/check-update`, { method: "POST" }, );}
export interface PluginSecretsResponse { plugin_id: string; secrets: Record<string, string>;}
export function getPluginSecrets(id: string) { return apiFetch<PluginSecretsResponse>( `/admin/plugins/${encodeURIComponent(id)}/secrets`, );}
export function updatePluginSecrets( id: string, secrets: Record<string, string>,) { return apiFetch<void>(`/admin/plugins/${encodeURIComponent(id)}/secrets`, { method: "PUT", body: JSON.stringify({ secrets }), });}
export interface SecretDefinition { key: string; name: string; description: string | null;}
export interface PluginPreview { id: string; name: string; version: string; description: string | null; icon_url: string | null; auth_type: string; required_secrets: SecretDefinition[]; manifest_url: string; wasm_url: string;}
export function previewPlugin(url: string, signal?: AbortSignal) { return apiFetch<PluginPreview>("/admin/plugins/preview", { method: "POST", body: JSON.stringify({ url }), signal, });}
// ---------------------------------------------------------------------------// Dead Letters// ---------------------------------------------------------------------------
export function getDeadLetters(params?: { collection?: string; resolved?: string; cursor?: string; limit?: number;}) { const searchParams = new URLSearchParams(); if (params?.collection) searchParams.set("collection", params.collection); if (params?.resolved) searchParams.set("resolved", params.resolved); if (params?.cursor) searchParams.set("cursor", params.cursor); if (params?.limit) searchParams.set("limit", String(params.limit)); const qs = searchParams.toString(); return apiFetch<DeadLettersListResponse>( `/admin/dead-letters${qs ? `?${qs}` : ""}`, );}
export function getDeadLetterCount(resolved?: string) { const searchParams = new URLSearchParams(); if (resolved) searchParams.set("resolved", resolved); const qs = searchParams.toString(); return apiFetch<DeadLetterCountResponse>( `/admin/dead-letters/count${qs ? `?${qs}` : ""}`, );}
export function getDeadLetter(id: string) { return apiFetch<DeadLetterDetail>( `/admin/dead-letters/${encodeURIComponent(id)}`, );}
export function retryDeadLetter(id: string) { return apiFetch(`/admin/dead-letters/${encodeURIComponent(id)}/retry`, { method: "POST", });}
export function reindexDeadLetter(id: string) { return apiFetch(`/admin/dead-letters/${encodeURIComponent(id)}/reindex`, { method: "POST", });}
export function dismissDeadLetter(id: string) { return apiFetch(`/admin/dead-letters/${encodeURIComponent(id)}/dismiss`, { method: "POST", });}
export function bulkDismissDeadLetters(body: { ids?: string[]; all?: boolean; collection?: string;}) { return apiFetch<BulkActionResponse>("/admin/dead-letters/bulk/dismiss", { method: "POST", body: JSON.stringify(body), });}
export function bulkRetryDeadLetters(body: { ids?: string[]; all?: boolean; collection?: string;}) { return apiFetch<BulkActionResponse>("/admin/dead-letters/bulk/retry", { method: "POST", body: JSON.stringify(body), });}
export function bulkReindexDeadLetters(body: { ids?: string[]; all?: boolean; collection?: string;}) { return apiFetch<BulkActionResponse>("/admin/dead-letters/bulk/reindex", { method: "POST", body: JSON.stringify(body), });}