{ "$schema": "https://ui.shadcn.com/schema/registry-item.json", "name": "template-docs", "title": "Tern: documentation", "author": "Ballmac ", "description": "A five-page documentation site: search-first landing, a guide with synced language tabs, filterable API reference, search with highlighted matches and a changelog, with ⌘K search in the header.", "dependencies": [ "lucide-react" ], "registryDependencies": [ "utils", "https://ui.ballmac.com/r/command.json", "https://ui.ballmac.com/r/kbd.json", "https://ui.ballmac.com/r/sheet.json", "https://ui.ballmac.com/r/snippet-tabs.json", "https://ui.ballmac.com/r/install-tabs.json", "https://ui.ballmac.com/r/code-block.json", "https://ui.ballmac.com/r/callout.json", "https://ui.ballmac.com/r/copy-button.json", "https://ui.ballmac.com/r/table-of-contents.json", "https://ui.ballmac.com/r/api-endpoint.json" ], "files": [ { "path": "registry/ballmac/components/templates/docs/docs-fonts.ts", "content": "// Ballmac UI: Docs template fonts. https://ui.ballmac.com/templates/template-docs\nimport { Instrument_Sans, JetBrains_Mono, Newsreader } from \"next/font/google\"\n\nexport const docsSerif = Newsreader({ variable: \"--docs-serif\", subsets: [\"latin\"], display: \"swap\", preload: false })\nexport const docsSans = Instrument_Sans({ variable: \"--docs-sans\", subsets: [\"latin\"], display: \"swap\", preload: false })\nexport const docsMono = JetBrains_Mono({ variable: \"--docs-mono\", subsets: [\"latin\"], display: \"swap\", preload: false })\n", "type": "registry:component", "target": "@components/ballmac/templates/docs/docs-fonts.ts" }, { "path": "registry/ballmac/components/templates/docs/docs-data.ts", "content": "// Ballmac UI: Docs template data. https://ui.ballmac.com/templates/template-docs\nexport type DocsKind = \"Guide\" | \"API\" | \"Changelog\"\n\nexport type DocsEntry = { title: string; kind: DocsKind; path: string; summary: string; page: \"guide\" | \"reference\" | \"changelog\" }\n\n/** Everything the search page and the command menu can find. */\nexport const searchIndex: DocsEntry[] = [\n { title: \"Send your first message\", kind: \"Guide\", path: \"Get started\", summary: \"Install the SDK, create a queue, send a message and acknowledge it in about seven minutes.\", page: \"guide\" },\n { title: \"Delivery guarantees\", kind: \"Guide\", path: \"Concepts\", summary: \"At-least-once delivery, visibility timeouts and how a message is retried before it reaches the dead-letter queue.\", page: \"guide\" },\n { title: \"Dead-letter queues\", kind: \"Guide\", path: \"Concepts\", summary: \"Park messages that keep failing, inspect them and replay them back into the queue once the bug is fixed.\", page: \"guide\" },\n { title: \"Idempotent consumers\", kind: \"Guide\", path: \"Guides\", summary: \"Use the message id as an idempotency key so a retried message never charges a card twice.\", page: \"guide\" },\n { title: \"Scheduling and delays\", kind: \"Guide\", path: \"Guides\", summary: \"Deliver a message in thirty seconds or next Tuesday with delay and a cron-style schedule.\", page: \"guide\" },\n { title: \"Verify webhook signatures\", kind: \"Guide\", path: \"Guides\", summary: \"Check the Tern-Signature header with an HMAC before you trust a push delivery.\", page: \"guide\" },\n { title: \"Create a queue\", kind: \"API\", path: \"POST /v1/queues\", summary: \"Creates a queue with a name, a visibility timeout and an optional dead-letter target.\", page: \"reference\" },\n { title: \"List queues\", kind: \"API\", path: \"GET /v1/queues\", summary: \"Returns every queue in the project, newest first, with a cursor for the next page.\", page: \"reference\" },\n { title: \"Send a message\", kind: \"API\", path: \"POST /v1/queues/{queue}/messages\", summary: \"Adds a message to a queue. Pass an idempotency key to make retries safe.\", page: \"reference\" },\n { title: \"Receive messages\", kind: \"API\", path: \"GET /v1/queues/{queue}/messages\", summary: \"Long-polls a queue and hides each message from other consumers until its visibility timeout ends.\", page: \"reference\" },\n { title: \"Acknowledge a message\", kind: \"API\", path: \"DELETE /v1/queues/{queue}/messages/{id}\", summary: \"Deletes a message once it has been processed successfully.\", page: \"reference\" },\n { title: \"Purge a queue\", kind: \"API\", path: \"POST /v1/queues/{queue}/purge\", summary: \"Removes every waiting message. This cannot be undone.\", page: \"reference\" },\n { title: \"3.2: Message replay\", kind: \"Changelog\", path: \"September 2026\", summary: \"Replay any window of the last 14 days into a queue without touching producers.\", page: \"changelog\" },\n { title: \"3.1: Batch receive\", kind: \"Changelog\", path: \"August 2026\", summary: \"Receive up to 50 messages per call and acknowledge them in one request.\", page: \"changelog\" },\n { title: \"3.0: Regions\", kind: \"Changelog\", path: \"June 2026\", summary: \"Queues can now live in Frankfurt, Virginia or Singapore. Breaking: the default region is explicit.\", page: \"changelog\" },\n]\n\nexport type NavSection = { title: string; items: { title: string; page: \"guide\" | \"reference\" | \"changelog\"; current?: boolean }[] }\n\nexport const nav: NavSection[] = [\n { title: \"Get started\", items: [{ title: \"Send your first message\", page: \"guide\", current: true }, { title: \"Core concepts\", page: \"guide\" }, { title: \"Authentication\", page: \"reference\" }] },\n { title: \"Concepts\", items: [{ title: \"Delivery guarantees\", page: \"guide\" }, { title: \"Visibility timeouts\", page: \"guide\" }, { title: \"Dead-letter queues\", page: \"guide\" }] },\n { title: \"Guides\", items: [{ title: \"Idempotent consumers\", page: \"guide\" }, { title: \"Scheduling and delays\", page: \"guide\" }, { title: \"Verify webhook signatures\", page: \"guide\" }, { title: \"Going to production\", page: \"guide\" }] },\n { title: \"API reference\", items: [{ title: \"Queues\", page: \"reference\", current: true }, { title: \"Messages\", page: \"reference\" }, { title: \"Errors and limits\", page: \"reference\" }] },\n { title: \"Releases\", items: [{ title: \"Changelog\", page: \"changelog\", current: true }] },\n]\n\nexport type Release = { version: string; date: string; title: string; tag: \"Added\" | \"Improved\" | \"Fixed\" | \"Breaking\"; body: string; points: string[] }\n\nexport const releases: Release[] = [\n { version: \"3.2.0\", date: \"2026-09-24\", title: \"Message replay\", tag: \"Added\", body: \"Replay a window of past messages into any queue. Useful after a bad deploy, or to seed a new environment with real traffic.\", points: [\"Replay up to 14 days of history by time range or by message id\", \"Replays are rate limited per queue so they never starve live traffic\", \"New `tern replay` command and `POST /v1/queues/{queue}/replays`\"] },\n { version: \"3.1.4\", date: \"2026-09-10\", title: \"Faster long polling\", tag: \"Improved\", body: \"Receive calls now wake within 40 ms of a message arriving instead of waiting for the next poll tick.\", points: [\"Median receive latency fell from 180 ms to 46 ms\", \"No change needed: the improvement applies to every SDK\"] },\n { version: \"3.1.3\", date: \"2026-08-29\", title: \"Visibility timeout on batch receive\", tag: \"Fixed\", body: \"Messages received in a batch of 50 could become visible again early if the first acknowledgement was slow.\", points: [\"The visibility timer now starts per message, not per batch\", \"Affected SDKs: node 3.1.0 to 3.1.2, python 3.1.0 to 3.1.1\"] },\n { version: \"3.1.0\", date: \"2026-08-12\", title: \"Batch receive and acknowledge\", tag: \"Added\", body: \"Receive up to 50 messages per call and acknowledge them in a single request. Throughput on busy queues roughly doubles.\", points: [\"`maxMessages` on receive, `ids` on acknowledge\", \"Partial failures return a per-message result\", \"SDK helpers `queue.consume()` batch for you\"] },\n { version: \"3.0.0\", date: \"2026-06-03\", title: \"Regions are explicit\", tag: \"Breaking\", body: \"Queues now live in a region you choose. The old global endpoint is retired, so clients must set a region.\", points: [\"Set `region` when creating the client: `eu`, `us` or `ap`\", \"Existing queues were migrated to `us` with no downtime\", \"The global endpoint returns 410 on 1 December 2026\"] },\n { version: \"2.9.2\", date: \"2026-05-14\", title: \"Clearer error messages\", tag: \"Improved\", body: \"Every error now includes a stable `code`, a human sentence and a link to the page that explains the fix.\", points: [\"`queue_not_found`, `visibility_expired` and 14 more codes documented\", \"Errors in the dashboard link straight to the docs\"] },\n]\n\nexport const languages = [\"Node\", \"Python\", \"Go\", \"cURL\"] as const\n\nexport const endpointGroups = [\n {\n title: \"Queues\",\n endpoints: [\n {\n method: \"POST\" as const, path: \"/v1/queues\", summary: \"Create a queue\", description: \"Creates a queue in the region of the client. Names are unique per project.\",\n parameters: [\n { name: \"name\", in: \"body\" as const, type: \"string\", required: true, description: \"Lowercase letters, numbers and dashes, up to 64 characters.\" },\n { name: \"visibilityTimeout\", in: \"body\" as const, type: \"integer\", description: \"Seconds a received message stays hidden.\", default: \"30\" },\n { name: \"deadLetter\", in: \"body\" as const, type: \"string\", description: \"Name of the queue that receives messages after maxReceives failures.\" },\n { name: \"maxReceives\", in: \"body\" as const, type: \"integer\", description: \"Receives before a message is moved to the dead-letter queue.\", default: \"5\" },\n ],\n requestExample: `{\\n \"name\": \"invoices\",\\n \"visibilityTimeout\": 60,\\n \"deadLetter\": \"invoices-dead\",\\n \"maxReceives\": 5\\n}`,\n responses: [\n { status: 201, description: \"Queue created\", example: `{\\n \"name\": \"invoices\",\\n \"region\": \"eu\",\\n \"visibilityTimeout\": 60,\\n \"createdAt\": \"2026-09-30T08:14:22Z\"\\n}` },\n { status: 409, description: \"A queue with this name already exists\", example: `{\\n \"code\": \"queue_exists\",\\n \"message\": \"A queue named invoices already exists in eu.\"\\n}` },\n ],\n },\n {\n method: \"GET\" as const, path: \"/v1/queues\", summary: \"List queues\", description: \"Returns the queues in the project, newest first.\",\n parameters: [\n { name: \"limit\", in: \"query\" as const, type: \"integer\", description: \"Queues per page, up to 100.\", default: \"25\" },\n { name: \"cursor\", in: \"query\" as const, type: \"string\", description: \"The `next` value from the previous page.\" },\n ],\n responses: [{ status: 200, description: \"A page of queues\", example: `{\\n \"data\": [{ \"name\": \"invoices\", \"waiting\": 12, \"inFlight\": 3 }],\\n \"next\": null\\n}` }],\n },\n {\n method: \"POST\" as const, path: \"/v1/queues/{queue}/purge\", summary: \"Purge a queue\", description: \"Removes every waiting message. In-flight messages finish normally. This cannot be undone.\",\n parameters: [{ name: \"queue\", in: \"path\" as const, type: \"string\", required: true, description: \"The queue name.\" }],\n responses: [{ status: 202, description: \"Purge accepted\", example: `{ \"removed\": 1204 }` }, { status: 404, description: \"No such queue\", example: `{ \"code\": \"queue_not_found\" }` }],\n },\n ],\n },\n {\n title: \"Messages\",\n endpoints: [\n {\n method: \"POST\" as const, path: \"/v1/queues/{queue}/messages\", summary: \"Send a message\", description: \"Adds a message to the queue. Send an `Idempotency-Key` header and a retry will return the first result instead of adding a duplicate.\",\n parameters: [\n { name: \"queue\", in: \"path\" as const, type: \"string\", required: true, description: \"The queue name.\" },\n { name: \"Idempotency-Key\", in: \"header\" as const, type: \"string\", description: \"Any string up to 255 characters. Keys expire after 24 hours.\" },\n { name: \"body\", in: \"body\" as const, type: \"object\", required: true, description: \"Any JSON up to 256 KB.\" },\n { name: \"delay\", in: \"body\" as const, type: \"integer\", description: \"Seconds before the message becomes visible, up to 15 minutes.\", default: \"0\" },\n ],\n requestExample: `{\\n \"body\": { \"invoice\": \"inv_2041\", \"total\": 4200 },\\n \"delay\": 0\\n}`,\n responses: [{ status: 201, description: \"Message accepted\", example: `{\\n \"id\": \"msg_7Hq2Zc\",\\n \"queue\": \"invoices\",\\n \"visibleAt\": \"2026-09-30T08:14:22Z\"\\n}` }, { status: 413, description: \"Body is larger than 256 KB\", example: `{ \"code\": \"body_too_large\" }` }],\n },\n {\n method: \"GET\" as const, path: \"/v1/queues/{queue}/messages\", summary: \"Receive messages\", description: \"Long-polls for up to `wait` seconds. Each message is hidden from other consumers until its visibility timeout ends.\",\n parameters: [\n { name: \"queue\", in: \"path\" as const, type: \"string\", required: true, description: \"The queue name.\" },\n { name: \"maxMessages\", in: \"query\" as const, type: \"integer\", description: \"Up to 50 per call.\", default: \"1\" },\n { name: \"wait\", in: \"query\" as const, type: \"integer\", description: \"Seconds to wait for a message, up to 20.\", default: \"0\" },\n ],\n responses: [{ status: 200, description: \"Zero or more messages\", example: `{\\n \"data\": [\\n { \"id\": \"msg_7Hq2Zc\", \"receipt\": \"rcpt_91\", \"body\": { \"invoice\": \"inv_2041\" }, \"receives\": 1 }\\n ]\\n}` }],\n },\n {\n method: \"DELETE\" as const, path: \"/v1/queues/{queue}/messages/{id}\", summary: \"Acknowledge a message\", description: \"Deletes a message once it has been processed. Use the receipt from the receive call.\",\n parameters: [\n { name: \"queue\", in: \"path\" as const, type: \"string\", required: true, description: \"The queue name.\" },\n { name: \"id\", in: \"path\" as const, type: \"string\", required: true, description: \"The message id.\" },\n { name: \"receipt\", in: \"query\" as const, type: \"string\", required: true, description: \"Proves you hold the message right now.\" },\n ],\n responses: [{ status: 204, description: \"Deleted\" }, { status: 410, description: \"The visibility timeout ended; the message may already be with another consumer\", example: `{ \"code\": \"visibility_expired\" }` }],\n },\n ],\n },\n]\n\nexport const snippets = {\n install: { Node: \"npm install @tern/sdk\", Python: \"pip install tern\", Go: \"go get github.com/tern/tern-go\", cURL: \"# nothing to install\" },\n}\n", "type": "registry:component", "target": "@components/ballmac/templates/docs/docs-data.ts" }, { "path": "registry/ballmac/components/templates/docs/docs-theme.tsx", "content": "// Ballmac UI: Docs template shell. https://ui.ballmac.com/templates/template-docs\n\"use client\"\n\nimport * as React from \"react\"\nimport { ChevronRight, Menu, Search } from \"lucide-react\"\n\nimport { Command, CommandDialog, CommandEmpty, CommandGroup, CommandInput, CommandItem, CommandList } from \"@/components/ballmac/command\"\nimport { Kbd } from \"@/components/ballmac/kbd\"\nimport { Sheet, SheetContent, SheetDescription, SheetHeader, SheetTitle, SheetTrigger } from \"@/components/ballmac/sheet\"\nimport { nav, searchIndex, type DocsKind } from \"@/components/ballmac/templates/docs/docs-data\"\nimport { docsMono, docsSans, docsSerif } from \"@/components/ballmac/templates/docs/docs-fonts\"\nimport { cn } from \"@/lib/utils\"\n\ntype DocsPage = \"home\" | \"guide\" | \"reference\" | \"search\" | \"changelog\"\ntype DocsHrefs = Record\n\nconst defaultHrefs: DocsHrefs = { home: \"/docs\", guide: \"/docs/guides\", reference: \"/docs/reference\", search: \"/docs/search\", changelog: \"/docs/changelog\" }\n\n/** Tern's palette: a cool, quiet page with deep teal ink. Dark mode is the same page lit by a terminal. */\nconst docsCss = `\n.docs-theme,body:not(:has([data-gallery])):has(.docs-theme){--background:oklch(0.985 0.006 210);--foreground:oklch(0.2 0.025 235);--card:oklch(1 0 0);--card-foreground:oklch(0.2 0.025 235);--popover:oklch(1 0 0);--popover-foreground:oklch(0.2 0.025 235);--primary:oklch(0.4 0.09 200);--primary-foreground:oklch(0.985 0.006 210);--secondary:oklch(0.955 0.012 210);--secondary-foreground:oklch(0.2 0.025 235);--muted:oklch(0.955 0.012 210);--muted-foreground:oklch(0.46 0.03 235);--accent:oklch(0.945 0.02 200);--accent-foreground:oklch(0.2 0.025 235);--border:oklch(0.2 0.025 235 / 12%);--input:oklch(0.2 0.025 235 / 18%);--ring:oklch(0.5 0.11 195);--surface:oklch(0.97 0.01 210);--destructive:oklch(0.52 0.21 27);--chart-1:oklch(0.5 0.11 190);--chart-2:oklch(0.5 0.15 265);--chart-3:oklch(0.62 0.15 75);--chart-4:oklch(0.55 0.15 150);--chart-5:oklch(0.55 0.2 20);--radius:0.75rem}\n.dark .docs-theme,.dark body:not(:has([data-gallery])):has(.docs-theme){--background:oklch(0.165 0.02 235);--foreground:oklch(0.95 0.01 205);--card:oklch(0.2 0.022 235);--card-foreground:oklch(0.95 0.01 205);--popover:oklch(0.22 0.024 235);--popover-foreground:oklch(0.95 0.01 205);--primary:oklch(0.8 0.11 190);--primary-foreground:oklch(0.18 0.03 235);--secondary:oklch(0.25 0.025 235);--secondary-foreground:oklch(0.95 0.01 205);--muted:oklch(0.25 0.025 235);--muted-foreground:oklch(0.72 0.03 215);--accent:oklch(0.28 0.03 225);--accent-foreground:oklch(0.95 0.01 205);--border:oklch(1 0 0 / 10%);--input:oklch(1 0 0 / 15%);--ring:oklch(0.8 0.11 190);--surface:oklch(0.19 0.021 235);--destructive:oklch(0.7 0.19 27);--chart-1:oklch(0.8 0.11 190);--chart-2:oklch(0.76 0.12 265);--chart-3:oklch(0.82 0.13 80);--chart-4:oklch(0.78 0.13 150);--chart-5:oklch(0.74 0.14 20)}\nbody:not(:has([data-gallery])):has(.docs-theme){font-family:var(--docs-sans),ui-sans-serif,system-ui,sans-serif}\n@keyframes docs-packet{0%{transform:translateX(0);opacity:0}10%{opacity:1}90%{opacity:1}100%{transform:translateX(var(--docs-travel,10rem));opacity:0}}\n.docs-packet{animation:docs-packet 2.6s ease-in-out infinite}\n@media (prefers-reduced-motion:reduce){.docs-packet{animation:none;opacity:1}}\n`\n\nconst serif = \"[font-family:var(--docs-serif),ui-serif,Georgia,serif] font-medium tracking-[-0.015em]\"\nconst mono = \"[font-family:var(--docs-mono),ui-monospace,monospace]\"\n\nconst kindStyle: Record = { Guide: \"bg-chart-1/15\", API: \"bg-chart-2/15\", Changelog: \"bg-chart-3/20\" }\n\nfunction Logo({ className }: { className?: string }) {\n return (\n \n \n \n )\n}\n\ntype SidebarProps = { page: DocsPage; hrefs: DocsHrefs; onNavigate?: () => void }\nfunction SidebarNav({ page, hrefs, onNavigate }: SidebarProps) {\n return (\n \n )\n}\n\ntype DocsShellProps = React.ComponentProps<\"div\"> & {\n /** The page being shown, so its nav link is marked current. */\n page: DocsPage\n /** Override where pages live (used by previews). */\n hrefs?: Partial\n /** Show the left navigation. Landing and search pages turn it off. */\n sidebar?: boolean\n}\n\n/** Tern's frame: a sticky header with the ⌘K search, a version picker, a sidebar and a footer. */\nfunction DocsShell({ page, hrefs: overrides, sidebar = true, className, style, children, ...props }: DocsShellProps) {\n const hrefs = { ...defaultHrefs, ...overrides }\n const [searchOpen, setSearchOpen] = React.useState(false)\n const [menuOpen, setMenuOpen] = React.useState(false)\n React.useEffect(() => {\n const classes = [docsSerif.variable, docsSans.variable, docsMono.variable].filter(Boolean)\n document.body.classList.add(...classes)\n return () => document.body.classList.remove(...classes)\n }, [])\n return (\n \n \n
\n
\n {sidebar && (\n \n \n \n Tern docsBrowse every guide and the API reference.\n setMenuOpen(false)} />\n \n \n )}\n \n \n Tern\n \n \n \n
\n \n \n \n
\n
\n
\n\n \n \n \n \n No results. Try “queue” or “retry”.\n {([\"Guide\", \"API\", \"Changelog\"] as const).map((kind) => (\n \n {searchIndex.filter((e) => e.kind === kind).map((e) => (\n { setSearchOpen(false); window.location.href = hrefs[e.page] }}>\n {e.title}{e.path}\n \n ))}\n \n ))}\n \n \n \n\n {sidebar ? (\n
\n \n
{children}
\n
\n ) : (\n children\n )}\n\n
\n
\n
Tern

Queues that never lose a message. Built by people who have been paged at 3 a.m.

\n {[\n [\"Learn\", [[\"Quickstart\", hrefs.guide], [\"Concepts\", hrefs.guide], [\"Guides\", hrefs.guide]]],\n [\"Build\", [[\"API reference\", hrefs.reference], [\"SDKs\", hrefs.reference], [\"Changelog\", hrefs.changelog]]],\n [\"Help\", [[\"Search\", hrefs.search], [\"Status\", hrefs.home], [\"Contact support\", hrefs.home]]],\n ].map(([title, items]) => (\n

{title as string}

    {(items as string[][]).map(([l, h]) =>
  • {l}
    • )}
\n ))}\n
\n

© 2026 Tern Systems. All systems operational.

\n
\n \n )\n}\n\n/** A small crumb row: \"Get started › Send your first message\". */\nfunction Crumbs({ items }: { items: string[] }) {\n return (\n \n )\n}\n\nexport { Crumbs, DocsShell, Logo as DocsLogo, defaultHrefs as docsDefaultHrefs, kindStyle as docsKindStyle, mono as docsMonoClass, serif as docsSerifClass, type DocsHrefs, type DocsPage, type DocsShellProps }\n", "type": "registry:component", "target": "@components/ballmac/templates/docs/docs-theme.tsx" }, { "path": "registry/ballmac/components/templates/docs/docs-home.tsx", "content": "// Ballmac UI: Docs home page. https://ui.ballmac.com/templates/template-docs\n\"use client\"\n\nimport * as React from \"react\"\nimport { ArrowRight, BookOpen, Code2, History, Rocket, Search } from \"lucide-react\"\n\nimport { SnippetTabs } from \"@/components/ballmac/snippet-tabs\"\nimport { releases, searchIndex, snippets } from \"@/components/ballmac/templates/docs/docs-data\"\nimport { DocsShell, docsMonoClass, docsSerifClass, type DocsHrefs } from \"@/components/ballmac/templates/docs/docs-theme\"\nimport { cn } from \"@/lib/utils\"\n\nconst paths = [\n { icon: Rocket, title: \"Quickstart\", body: \"Send and receive your first message in about seven minutes.\", key: \"guide\" as const, tint: \"bg-chart-1/15\" },\n { icon: BookOpen, title: \"Guides\", body: \"Retries, dead letters, schedules and idempotent consumers, explained with code.\", key: \"guide\" as const, tint: \"bg-chart-2/15\" },\n { icon: Code2, title: \"API reference\", body: \"Every endpoint, parameter and error code, with examples in four languages.\", key: \"reference\" as const, tint: \"bg-chart-3/20\" },\n { icon: History, title: \"Changelog\", body: \"What shipped, what changed and what to do about it.\", key: \"changelog\" as const, tint: \"bg-chart-4/15\" },\n]\n\n/** Producer, queue and consumer with packets travelling between them. Decorative; the sentence below carries the meaning. */\nfunction Flow() {\n const box = \"bg-card grid h-20 w-24 shrink-0 place-items-center rounded-xl border text-center text-xs font-semibold shadow-xs sm:w-32 sm:text-sm\"\n return (\n
\n
\n
Produceryour app
\n
\n
Queueinvoices
\n
\n
Consumerworker
\n
\n
A producer sends, Tern holds the message until a consumer acknowledges it.
\n
\n )\n}\n\ntype DocsHomeProps = React.ComponentProps<\"div\"> & { hrefs?: Partial }\n\n/** The Docs landing page: a search-first hero, four paths in, install tabs and the latest releases. */\nfunction DocsHome({ hrefs, ...props }: DocsHomeProps) {\n const link = { ...{ home: \"/docs\", guide: \"/docs/guides\", reference: \"/docs/reference\", search: \"/docs/search\", changelog: \"/docs/changelog\" }, ...hrefs }\n return (\n \n
\n
\n
\n
\n

v3.2 · message replay is here

\n

Queues that never lose a message.

\n

Everything you need to send, receive and retry messages at any scale, written by the people who run the queues.

\n
\n \n
\n \n \n
\n \n
\n

Popular: {[\"Retries\", \"Dead letters\", \"Idempotency\"].map((t, i) => {i > 0 && \", \"}{t})}

\n
\n
\n
\n\n
\n

Where to start

\n \n
\n\n
\n
\n
\n

One command, then a message.

\n

Official SDKs for Node, Python and Go, and a plain HTTP API for everything else. Pick a language once and every code sample in the docs follows you.

\n
    {[\"Retries and backoff built in\", \"Typed clients, generated from the API\", \"Same behaviour in every language\"].map((t) =>
  • {t}
    • )}
\n
\n ({ label, code, language: \"bash\" }))} />\n
\n
\n\n
\n
\n

Most read

\n
    \n {searchIndex.filter((e) => e.kind === \"Guide\").slice(0, 5).map((e, i) => (\n
  1. \n \n {String(i + 1).padStart(2, \"0\")}\n {e.title}{e.summary}\n \n \n
    2. \n ))}\n
\n
\n
\n

What’s new

All releases
\n
    \n {releases.slice(0, 3).map((r) => (\n
  • \n
    {r.version}{new Date(r.date + \"T00:00:00Z\").toLocaleDateString(\"en-US\", { month: \"short\", day: \"numeric\", year: \"numeric\", timeZone: \"UTC\" })}
    \n

    {r.title}

    \n

    {r.body}

    \n
    • \n ))}\n
\n
\n
\n\n
\n
\n

Stuck? A human will answer.

Average first reply on weekdays is eleven minutes. Bring your message id and we will find it.

\n Ask support \n
\n
\n
\n \n )\n}\n\nexport { DocsHome, type DocsHomeProps }\n", "type": "registry:component", "target": "@components/ballmac/templates/docs/docs-home.tsx" }, { "path": "registry/ballmac/components/templates/docs/docs-guide.tsx", "content": "// Ballmac UI: Docs guide page. https://ui.ballmac.com/templates/template-docs\n\"use client\"\n\nimport * as React from \"react\"\nimport { ArrowLeft, ArrowRight, Check, Clock, ThumbsDown, ThumbsUp } from \"lucide-react\"\n\nimport { Callout } from \"@/components/ballmac/callout\"\nimport { CodeBlock } from \"@/components/ballmac/code-block\"\nimport { CopyButton } from \"@/components/ballmac/copy-button\"\nimport { InstallTabs } from \"@/components/ballmac/install-tabs\"\nimport { SnippetTabs } from \"@/components/ballmac/snippet-tabs\"\nimport { TableOfContents } from \"@/components/ballmac/table-of-contents\"\nimport { Crumbs, DocsShell, docsMonoClass, docsSerifClass, type DocsHrefs } from \"@/components/ballmac/templates/docs/docs-theme\"\nimport { cn } from \"@/lib/utils\"\n\nconst toc = [\n { id: \"before\", title: \"Before you begin\", level: 2 },\n { id: \"install\", title: \"Install the SDK\", level: 2 },\n { id: \"create\", title: \"Create a queue\", level: 2 },\n { id: \"send\", title: \"Send a message\", level: 2 },\n { id: \"receive\", title: \"Receive and acknowledge\", level: 2 },\n { id: \"next\", title: \"Next steps\", level: 2 },\n]\n\nconst createSnippets = [\n { label: \"Node\", language: \"typescript\" as const, code: `const { Tern } = require(\"@tern/sdk\")\\n\\nconst tern = new Tern({ apiKey: process.env.TERN_KEY, region: \"eu\" })\\n\\nawait tern.queues.create({\\n name: \"invoices\",\\n visibilityTimeout: 60,\\n})` },\n { label: \"Python\", language: \"python\" as const, code: `import os\\nfrom tern import Tern\\n\\ntern = Tern(api_key=os.environ[\"TERN_KEY\"], region=\"eu\")\\n\\ntern.queues.create(\\n name=\"invoices\",\\n visibility_timeout=60,\\n)` },\n { label: \"Go\", language: \"go\" as const, code: `client := tern.New(os.Getenv(\"TERN_KEY\"), tern.WithRegion(\"eu\"))\\n\\n_, err := client.Queues.Create(ctx, tern.CreateQueue{\\n Name: \"invoices\",\\n VisibilityTimeout: 60,\\n})` },\n { label: \"cURL\", language: \"bash\" as const, code: `curl https://eu.api.tern.dev/v1/queues \\\\\\n -H \"Authorization: Bearer $TERN_KEY\" \\\\\\n -d '{\"name\":\"invoices\",\"visibilityTimeout\":60}'` },\n]\nconst sendSnippets = [\n { label: \"Node\", language: \"typescript\" as const, code: `const message = await tern.queue(\"invoices\").send(\\n { invoice: \"inv_2041\", total: 4200 },\\n { idempotencyKey: \"inv_2041\" }\\n)\\n\\nconsole.log(message.id) // msg_7Hq2Zc` },\n { label: \"Python\", language: \"python\" as const, code: `message = tern.queue(\"invoices\").send(\\n {\"invoice\": \"inv_2041\", \"total\": 4200},\\n idempotency_key=\"inv_2041\",\\n)\\n\\nprint(message.id) # msg_7Hq2Zc` },\n { label: \"Go\", language: \"go\" as const, code: `msg, _ := client.Queue(\"invoices\").Send(ctx,\\n map[string]any{\"invoice\": \"inv_2041\", \"total\": 4200},\\n tern.IdempotencyKey(\"inv_2041\"))\\n\\nfmt.Println(msg.ID) // msg_7Hq2Zc` },\n { label: \"cURL\", language: \"bash\" as const, code: `curl https://eu.api.tern.dev/v1/queues/invoices/messages \\\\\\n -H \"Authorization: Bearer $TERN_KEY\" \\\\\\n -H \"Idempotency-Key: inv_2041\" \\\\\\n -d '{\"body\":{\"invoice\":\"inv_2041\",\"total\":4200}}'` },\n]\nconst consumeSnippets = [\n { label: \"Node\", language: \"typescript\" as const, code: `for await (const msg of tern.queue(\"invoices\").consume({ wait: 20 })) {\\n await chargeCustomer(msg.body)\\n await msg.ack() // delete it, or it comes back\\n}` },\n { label: \"Python\", language: \"python\" as const, code: `for msg in tern.queue(\"invoices\").consume(wait=20):\\n charge_customer(msg.body)\\n msg.ack() # delete it, or it comes back` },\n { label: \"Go\", language: \"go\" as const, code: `for msg := range client.Queue(\"invoices\").Consume(ctx, tern.Wait(20)) {\\n chargeCustomer(msg.Body)\\n msg.Ack() // delete it, or it comes back\\n}` },\n { label: \"cURL\", language: \"bash\" as const, code: `curl \"https://eu.api.tern.dev/v1/queues/invoices/messages?wait=20\" \\\\\\n -H \"Authorization: Bearer $TERN_KEY\"` },\n]\n\nfunction Step({ n, title, id, children, last }: { n: number; title: string; id: string; children: React.ReactNode; last?: boolean }) {\n return (\n
\n
\n {n}\n {!last && }\n
\n
\n

{title}

\n {children}\n
\n
\n )\n}\n\nfunction Helpful() {\n const [vote, setVote] = React.useState<\"yes\" | \"no\" | null>(null)\n const [note, setNote] = React.useState(\"\")\n const [sent, setSent] = React.useState(false)\n const btn = \"hover:bg-accent focus-visible:ring-ring/50 aria-pressed:border-primary aria-pressed:bg-accent inline-flex h-10 items-center gap-2 rounded-lg border px-4 text-sm font-semibold outline-none focus-visible:ring-[3px]\"\n return (\n
\n

Was this page helpful?

\n {sent || vote === \"yes\" ? (\n

{sent ? \"Thanks. We read every note.\" : \"Glad it helped. Thank you.\"}

\n ) : (\n <>\n
\n \n \n
\n {vote === \"no\" && (\n
{ e.preventDefault(); setSent(true) }}>\n \n