SDK cookbook

Cookbook recipes combine multiple namespaces into complete user journeys. They assume you already created the shared client and understand session ownership.

Unlike the namespace reference, each recipe starts with a user outcome and connects the reads, writes, helpers, and verification needed to deliver it. The examples are framework-neutral TypeScript unless the rendering boundary matters.

Before you begin

• Complete Installing.
• Read Authentication and session ownership before using any board.me.* method.
• Load board.context() and respect its feature flags before exposing an optional journey.
• Keep the same public origin and canonical path rules across page rendering, metadata, and sitemaps.

Recipes

• Job directory and search — URL filters, browse/search, cursor and numbered pagination, formatting, and metadata.
• Custom field filters and badges — job and company custom fields as filter dropdowns and card badges.
• Job detail and applications — canonical routes, native 404s, similar jobs, uploads, and application state.
• Company directory and profiles — browse, search, profiles, open jobs, markets, and salaries.
• Blog and editorial pages — index, tag, author, search, post, adjacent, and related content.
• Talent directory and profiles — visibility gates, search, cursor pagination, profiles, and contact.
• Authentication flow — registration, verification, login, explicit refresh, and logout.
• Candidate account — profile, résumé, matches, weekly alerts, applications, access, and conversations.
• Saved jobs — authenticated save state without local-storage guesses.
• Job matches — signed-in Matches from board.me.recommendedJobs.list.
• Employer workflows — company claims, jobs, applicants, pipelines, billing, and messaging.
• Job posting flow — products, billing verification, submission, and checkout branching.
• Monetization and paywalls — plans, posting products, candidate offers, checkout, and entitlements.
• SEO-complete board — all public routes, canonicals, structured data, redirects, and sitemap membership.

Copy the sequence and boundary decisions, then adapt the components and framework glue. Do not copy example identifiers or origins into production configuration.

Verify a recipe

A recipe is complete only when its observable user path and failure path both work. For every recipe:

1. Exercise it with real development-board data.
2. Exercise the documented empty, denied, or invalid-input branch.
3. Confirm authenticated responses use a private/no-store boundary.
4. Run the project typecheck and production build.
5. With the frontend running, run npx @cavuno/board doctor --frontend http://localhost:3000 from a shell that exports PUBLIC_CAVUNO_BOARD. Set PUBLIC_CAVUNO_API_URL only when Cavuno supplied a non-production override.

Doctor prints each probe as pass, fail, or skip. The observable checkpoint is a summary with no failed checks and no unexplained skips—skipped probes are explicitly not verified.

Next step

Start with Build a job listing page. Ship its /jobs route against your development board, verify a page with jobs and a valid zero-results filter, then run doctor before adding the authentication or posting recipes.