Types

Every shape the kit hands you is typed, from a list item to each section's data. This page covers where to import the types from and what the main ones hold. The declarations in the package are the full reference; this is the map.

Where to import them

The root entry is server only, but a type import is erased at build time, so import type { PortfolioResultItem } from '@sonordev/agency-site-kit' is fine in a client component.

Case studies

PortfolioItem

A published case study as the list returns it.

PortfolioItemFull

What getPortfolioItem returns: a PortfolioItem plus

PortfolioListResponse

{ items: PortfolioItem[]; total: number; limit: number; offset: number }, from getPortfolioItems.

Numbers

PortfolioKPI

interface PortfolioKPI {
  label: string;
  value: number;
  suffix: string;
  prefix?: string;
  description: string;
  source: MetricSource;            // 'measured' | 'reported' | 'estimated'
  reportedBy?: MetricAttribution;  // required when source is 'reported'
}

A results card (PortfolioResultItem) carries the same source and reportedBy, with its figure in metric: { value, suffix, prefix? }. MetricAttribution is { name, role?, organization, date }, with date as YYYY-MM-DD. Proof and provenance covers what each source may claim.

MetricsDelta

interface MetricsDelta {
  metric: string;
  baseline: number;
  current: number;
  delta: number;
  deltaPercent: number;
  direction: 'up' | 'down' | 'flat'; // 'up' means improved, even for lower-is-better metrics
  timespan: string;
}

MetricsSnapshot

Four groups of optional numbers: seo (clicks_28d, impressions_28d, avg_position, ctr), cwv (lcp_ms, inp_ms, cls, performance_score), analytics (sessions_28d, page_views_28d, conversion_rate, bounce_rate) and pages (total_indexed, total_crawled, total_pages).

Sections

PortfolioSection<T> is { sectionType, displayName, data }, where data is typed by PortfolioSectionDataMap[sectionType]. PortfolioSectionType is the union of the names in PORTFOLIO_SECTION_TYPES, and PortfolioSectionData is the union of every data shape.

portfolioSpeedComparison, portfolioSiteArchitecture and portfolioDesignSystem have no data type yet.

A few notes that save a bug:

• Image fields carry URLs. avatar, image, thumbnail, before, after and ogImage are typed as SanityImageRef, the older image object, but hold plain URL strings at runtime. Pass them to resolvePortfolioImage, which takes either. The type stays so existing code keeps compiling.
• Performance captions. PortfolioPerformanceData's formFactor, method, measuredAt and measuredUrl say how the scores were taken. State them in the section's caption when they're present (print measuredAt with formatIsoDate, and show only the host of measuredUrl). beforeMethod belongs next to before-and-after scores.
• Before and after. Prefer beforeUrl and afterUrl when they're set. beforeLabel says where the old image came from (for example an archive capture) and belongs in its badge and alt text.

Evidence: ProofRecord

What getProofRecords returns, one per published piece of evidence.

Brand

BrandConfig is the agency brand AgencySiteKitLayout turns into CSS variables: primary, secondary, background, backgroundElevated, surface, surfaceHover, surfaceBorder, textPrimary, textSecondary, textTertiary, fontHeading and fontBody, plus optional logoUrl, logoAlt, radius ({ sm, md, lg }) and darkMode (colour overrides for dark mode). See Brand layout.

PortfolioConfigResponse is the raw brand endpoint's answer: { brand: BrandConfig; orgName: string; orgSlug: string }.

Helper types