Cavuno
Sign InStart for free

Helper packages

Complete export inventory for formatting, filters, SEO, sitemap, paths, server, and skill subpaths.

Abi Tyas TunggalAJack WalshJ
By Abi Tyas Tunggal and Jack Walsh

The SDK publishes framework-neutral helper entry points. This page lists every public value and type on each helper subpath in version 1.34.0. Use your installed TypeScript declarations as the final authority after an upgrade.

Core helper exports

The root @cavuno/board entry exports the client plus cross-namespace helpers:

  • Errors: BOARD_API_ERROR_CODES, BoardApiError, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError.
  • Storage keys: ACCESS_TOKEN_KEY, BOARD_ACCESS_GRANT_KEY, REFRESH_TOKEN_KEY.
  • Pagination: paginate and type Paginator.
  • Version: SDK_VERSION.
  • Messaging derivations: isColdRule, isOwnMessage, lastOwnMessageId.
  • Apply derivations: isSafeApplicationUrl, resolveApplyAction, and type ApplyAction.
  • Client values and types: createBoardClient, BoardClient, BoardSdk, CreateBoardClientOptions, BoardRequest, FetchOptions, Logger, Awaitable, CustomStorage, and StorageMode.

Resource request and response types are exported from the root and documented on their namespace pages.

@cavuno/board/format

Board-language display derivations for contract and data-shaping helpers. Label-producing helpers take board.context().language as their leading argument.

Values:

  • formatDate, formatMonthYear, formatPublishedRelativeDate.
  • formatSalaryRange.
  • resolveCustomFieldDisplay, COUNTRY_CODES, countryOptions.
  • formatSalaryStat, formatSalaryStatRange, normalizeWebsiteUrl, buildJobBreadcrumbs.

Types (checked against the published type surface):

ts
import type {
  SalaryTimeframeInput,
  SalaryTimeframeValue,
  FormattedSalaryRange,
  CurrencyDisplay,
  NumberNotation,
  CustomFieldDisplayEntry,
  CountryOption,
  IsoCountryCode,
  JobBreadcrumb,
} from '@cavuno/board/format';

Chrome copy (uiCopy, display-label words, salary lexicon) is application-owned and is not exported from the SDK (ADR-0104). Own it in application messages or code.

ts
import {
  formatSalaryRange,
  formatSalaryStat,
  resolveCustomFieldDisplay,
} from '@cavuno/board/format';


const context = await board.context();
const salary = formatSalaryRange(
  context.language,
  jobCard.salaryMin,
  jobCard.salaryMax,
  jobCard.salaryTimeframe,
  jobCard.salaryCurrency,
);
// salary is { text, timeframe, bound } | null.
// timeframe is the wire enum (per_year) — map it through your catalog.
// bound names open-range chrome from your copy (do not hardcode English
// "From " + text joins here; order and particles are locale-owned).
// Saved jobs embed job_card already — map with the same card VM as listings.
const customFields = resolveCustomFieldDisplay(
  context.language,
  context.customFields.job,
  job.customFieldValues,
);
formatSalaryStat(context.language, 90000, detail.currency);

@cavuno/board/filters

Values:

  • Vocabularies: REMOTE_OPTIONS, EMPLOYMENT_TYPES, SENIORITIES, JOB_SORTS, DEFAULT_SORT.
  • Parsing: parseSeniority, parseListingFilters.

Display labels for seniority and sort options are application-owned (not exported).

Type: ListingFilters.

The parsers accept public URL input and drop unsupported filter values instead of throwing.

@cavuno/board/seo

Values:

  • Blog: createAuthorProfileJsonLd, createBlogArticleJsonLd.
  • Breadcrumbs: buildJobBreadcrumbs, createBreadcrumbJsonLd.
  • Jobs: ALL_COUNTRY_CODES, createJobPostingJsonLd, normalizeWebsiteUrl.
  • Listings: listingHead (caller supplies title and description), listingJsonLd.
  • Salaries: buildSalaryFaq (returns FAQ entry kinds + values; app composes prose; pass currency), companyCategorySalaryJsonLd, companySalaryJsonLd (ItemList of categories), crossAxisSalaryJsonLd, faqJsonLd, formatSalaryStat, formatSalaryStatRange, itemListJsonLd, locationSalaryJsonLd (ItemList of top categories), SENIORITY_ORDER, skillSalaryJsonLd, sortBySeniority, titleSalaryJsonLd. Pass seniorityName({ seniority, entity }) for finished per-seniority distribution names (app owns word order); locationSalaryJsonLd / companySalaryJsonLd require occupationUrl.

Types: ArticleJsonLdPost, BreadcrumbItemInput, JobBreadcrumb, JsonLdBoard, JsonLdObject, ListingHeadOptions, FaqItem, SalaryFaqEntry, SalaryJsonLdOptions, SalaryOccupationListOptions.

These helpers return plain objects or head descriptors. Your framework owns the final <meta>, <link>, and safely serialized <script type="application/ld+json"> elements.

@cavuno/board/sitemap

Values:

  • Bucket model: SITEMAP_BUCKETS, SITEMAP_CHUNK_SIZE, MIN_JOBS_PER_INDEXED_PAGE.
  • Filenames and chunks: bucketFilename, parseBucketFilename, chunk.
  • XML: xmlEscape, renderUrlset, renderSitemapIndex.
  • Board walking: listedBuckets, buildBucketUrls.

Types: SitemapBucket, SitemapUrlEntry, SitemapIndexEntry.

buildBucketUrls performs API reads. The filename, chunk, escape, and render helpers are pure.

@cavuno/board/paths

Values:

  • Jobs: jobDetailPath, jobsCategoryPath, jobsSkillPath, jobsLocationPath, jobsLocationCategoryPath, jobsLocationSkillPath.
  • Companies: companyPath, companyMarketPath, companySalaryPath.
  • Salaries: salaryTitlePath, salarySkillPath, salaryLocationPath.
  • Blog: blogPostPath, blogTagPath, blogAuthorPath.
  • Suggestions: suggestionPath (scope-aware resolver; returns null when the selection is a filter, not a navigation).
  • Shared: BOARD_PATHS, boardUrl.

Every path helper returns a leading-slash path. boardUrl adds an origin and removes trailing slashes from that origin.

@cavuno/board/server

Node-runtime-independent server plumbing that accepts and returns strings rather than framework request objects.

Values:

  • Session cookies: SESSION_COOKIE_NAME, sessionCookieName, clearSessionCookie, isExpiringSoon, parseSessionCookie, serializeSessionCookie.
  • Board-access cookies: BOARD_ACCESS_COOKIE_NAME, grantCookieName, clearGrantCookie, parseGrantCookie, serializeGrantCookie.
  • Redirect safety: currentPathFromReferer, safeRedirectPath.
  • Refresh coordination: createSessionRefresher.

Type: BoardSession.

Cookie serializers apply the package’s __Host-, Secure, httpOnly, path, and SameSite contract. createSessionRefresher requires a nostore client and coordinates one in-flight refresh; it does not install automatic retry behavior.

@cavuno/board/skills

This entry is Node-only because it reads the installed package from the filesystem.

Values: resolveFromPackageRoot, loadSkillManifest, loadSkillCorpus.

Types: LoadedSkill, SkillCorpus, SkillManifest, SkillManifestEntry.

resolveFromPackageRoot(relativePath, baseDir?) works from the installed layout. Bundled consumers that relocate the module must pass baseDir.

@cavuno/board/skills/types

Types only: SkillManifest and SkillManifestEntry. Use this subpath in non-Node consumers that need the manifest shape without importing filesystem code.

The package also exports @cavuno/board/skills/* for direct access to shipped skill artifacts named by the manifest.

Verify an import

ts
import { jobDetailPath } from '@cavuno/board/paths';
import { createJobPostingJsonLd } from '@cavuno/board/seo';
import { SDK_VERSION } from '@cavuno/board';


console.log(SDK_VERSION, jobDetailPath('acme', 'staff-engineer'));
void createJobPostingJsonLd;

Run your application typecheck after changing package versions. A missing symbol should fail at the import rather than being replaced with a locally reimplemented fallback.