@burdenoff/website-sdk 2026.817.2 → 2026.824.2

package/dist/index-CFsUFxYo.d.ts

@@ -0,0 +1,424 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { Components } from 'react-markdown';
+import { W as WebSDKClient } from './graphql-client-Cv6TO6hn.js';
+
+/** A job posting option for the CareersApplyForm dropdown. */
+interface CareersPostingOption {
+    /** Posting ID — sent as `jobPostingId` in the application input. */
+    id: string;
+    /** Display title — also sent as the `position` string. */
+    title: string;
+}
+interface CareersApplyFormProps {
+    /** Product name (falls back to product context / SDK config). */
+    productName?: string;
+    /** reCAPTCHA site key (falls back to SDK config). */
+    recaptchaSiteKey?: string;
+    /**
+     * Position options for the dropdown. When empty, a free-text "position"
+     * input is shown instead so the form works before a postings list exists.
+     */
+    positions?: readonly string[];
+    /**
+     * Job postings for the dropdown (e.g. from `usePublicJobPostings`). When
+     * non-empty this takes precedence over `positions`: the selected posting's
+     * title is sent as `position` and its ID as `jobPostingId` so the
+     * application is linked to the posting.
+     */
+    postings?: readonly CareersPostingOption[];
+    heroTitle?: string;
+    heroDescription?: string;
+    /**
+     * `1` (default) renders a full page hero `<h1>`; `2` renders a compact
+     * `<h2>` section header for embedding under a page that owns the `<h1>`.
+     */
+    headingLevel?: 1 | 2;
+    /** Max resume size in bytes (default 10MB, matches backend). */
+    maxResumeBytes?: number;
+    className?: string;
+    seo?: {
+        title?: string;
+        description?: string;
+        keywords?: string;
+    };
+}
+declare function CareersApplyForm({ productName, recaptchaSiteKey, positions, postings, heroTitle, heroDescription, headingLevel, maxResumeBytes, className, seo, }: CareersApplyFormProps): react_jsx_runtime.JSX.Element;
+
+interface ContentPageData {
+    id: string;
+    title: string;
+    slug: string;
+    content: string;
+    contentFormat: string;
+    seoTitle?: string | null;
+    seoDescription?: string | null;
+    seoKeywords?: string | null;
+    lastUpdated: string;
+    version: number;
+    tags?: string[];
+    excerpt?: string | null;
+    thumbnail?: string | null;
+    author?: string | null;
+    publishedAt?: string | null;
+    readingTime?: number | null;
+    featured?: boolean;
+    category?: string | null;
+}
+interface ContentPageListItem {
+    id: string;
+    title: string;
+    slug: string;
+    lastUpdated: string;
+    tags?: string[];
+    excerpt?: string | null;
+    thumbnail?: string | null;
+    author?: string | null;
+    publishedAt?: string | null;
+    readingTime?: number | null;
+    featured?: boolean;
+    category?: string | null;
+    seoDescription?: string | null;
+}
+interface ContentPageListData {
+    items: ContentPageListItem[];
+    total: number;
+    hasMore: boolean;
+}
+interface UseContentPageOptions {
+    /** Whether to use template variable replacement (resolvedContentPage) */
+    resolve?: boolean;
+}
+/**
+ * Hook to fetch a single public content page by slug.
+ *
+ * @example
+ * ```tsx
+ * const { data, loading, error } = useContentPage('privacy-policy');
+ * ```
+ */
+declare function useContentPage(slug: string, options?: UseContentPageOptions): {
+    data: ContentPageData | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+};
+/**
+ * Hook to fetch a list of public content pages for the current product.
+ *
+ * @example
+ * ```tsx
+ * const { data, loading } = useContentPages({ limit: 10 });
+ * ```
+ */
+declare function useContentPages(options?: {
+    limit?: number;
+    offset?: number;
+}): {
+    data: ContentPageListData | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+};
+/**
+ * Content renderer component.
+ *
+ * - `markdown` (default): renders with the shared {@link Markdown} component
+ *   (react-markdown + remark-gfm + rehype-sanitize).
+ * - `html`: sanitized with DOMPurify before rendering.
+ * - anything else: plain-text fallback
+ *
+ * @example
+ * ```tsx
+ * <ContentRenderer content={page.content} format={page.contentFormat} />
+ * ```
+ */
+declare function ContentRenderer({ content, format, className, }: {
+    content: string;
+    format?: string;
+    className?: string;
+}): react_jsx_runtime.JSX.Element;
+
+interface MarkdownProps {
+    /** Markdown source to render. */
+    children: string;
+    /** Additional classes for the wrapper element. */
+    className?: string;
+    /** Render without a wrapping block element, suitable for inline content. */
+    inline?: boolean;
+    /** Optional react-markdown component overrides. */
+    components?: Components;
+}
+/**
+ * Shared markdown renderer for website content.
+ *
+ * - Uses `react-markdown` for standards-compliant parsing.
+ * - Enables GitHub Flavored Markdown (tables, task lists, strikethrough, autolinks).
+ * - Sanitizes HTML via `rehype-sanitize` so raw markup in markdown is stripped.
+ * - External links open in a new tab with safe rel attributes.
+ */
+declare function Markdown({ children, className, inline, components, }: MarkdownProps): ReactNode;
+
+interface PublicInterviewRoundConfig {
+    roundNumber: number;
+    name: string;
+    /** Round type enum from the backend (PHONE_SCREEN, TECHNICAL, …) as a string. */
+    roundType: string;
+    isRequired: boolean;
+    description?: string | null;
+}
+interface PublicJobPosting {
+    id: string;
+    slug: string;
+    title: string;
+    department?: string | null;
+    location?: string | null;
+    employmentType?: string | null;
+    openings?: number | null;
+    description?: string | null;
+    overview?: string | null;
+    responsibilities: string[];
+    learnings: string[];
+    qualifications: string[];
+    rounds: PublicInterviewRoundConfig[];
+}
+interface UsePublicJobPostingsOptions {
+    /** Product ID override (falls back to product context / SDK config). */
+    productId?: string;
+    limit?: number;
+    offset?: number;
+}
+interface UsePublicJobPostingOptions {
+    /** Product ID override (falls back to product context / SDK config). */
+    productId?: string;
+}
+/**
+ * Fetch the list of public job postings for a product.
+ * Throws on GraphQL/transport errors so callers can settle an error state.
+ */
+declare function fetchPublicJobPostings(client: WebSDKClient, options?: UsePublicJobPostingsOptions): Promise<PublicJobPosting[]>;
+/**
+ * Fetch a single public job posting by slug. Returns `null` when the posting
+ * does not exist; throws on GraphQL/transport errors.
+ */
+declare function fetchPublicJobPosting(client: WebSDKClient, slug: string, options?: UsePublicJobPostingOptions): Promise<PublicJobPosting | null>;
+/**
+ * Fetch OPEN + CLOSED postings (id/title only) for the assignment-submission
+ * position picker. Throws on GraphQL/transport errors so callers can settle
+ * an error state.
+ */
+declare function fetchPublicJobPostingsForSubmission(client: WebSDKClient, options?: UsePublicJobPostingsOptions): Promise<CareersPostingOption[]>;
+/**
+ * Hook to fetch the public job postings for the current product.
+ *
+ * @example
+ * ```tsx
+ * const { postings, loading, error } = usePublicJobPostings({ limit: 20 });
+ * ```
+ */
+declare function usePublicJobPostings(options?: UsePublicJobPostingsOptions): {
+    postings: PublicJobPosting[];
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+};
+/**
+ * Hook to fetch postings (OPEN + CLOSED, id/title only) for the
+ * assignment-submission position picker — a candidate must still be able to
+ * select the role they applied to after it closes to new applicants.
+ *
+ * @example
+ * ```tsx
+ * const { postings, loading, error } = usePublicJobPostingsForSubmission();
+ * ```
+ */
+declare function usePublicJobPostingsForSubmission(options?: UsePublicJobPostingsOptions): {
+    postings: CareersPostingOption[];
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+};
+/**
+ * Hook to fetch a single public job posting by slug.
+ *
+ * @example
+ * ```tsx
+ * const { posting, loading, error } = usePublicJobPosting('senior-engineer');
+ * ```
+ */
+declare function usePublicJobPosting(slug: string, options?: UsePublicJobPostingOptions): {
+    posting: PublicJobPosting | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+};
+
+interface BlogListPageProps {
+    productName?: string;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    blogPostBasePath?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+}
+interface BlogPostPageProps {
+    productName?: string;
+    blogListUrl?: string;
+    /** Back-link label. Default: "Back to Blog". Use e.g. "Back to Press"
+     *  when reusing this renderer for a press release at /press/:slug. */
+    backLabel?: string;
+    className?: string;
+}
+declare function BlogListPage(props: BlogListPageProps): react_jsx_runtime.JSX.Element;
+declare function BlogPostPage(props: BlogPostPageProps): react_jsx_runtime.JSX.Element;
+
+interface CaseStudiesListPageProps {
+    productName?: string;
+    /** Small label above the hero title. Default: "Customer Stories". */
+    eyebrow?: string;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    caseStudyBasePath?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+    /** Where the primary "get in touch" CTA points. Default: "/contact". */
+    contactHref?: string;
+    /** Primary CTA label. Default: "Get in touch". */
+    contactLabel?: string;
+    /** Secondary CTA target (shown in the empty state). Default: "/features". */
+    exploreHref?: string;
+    /** Secondary CTA label. Default: "Explore the product". */
+    exploreLabel?: string;
+    /** Heading for the empty state. Falls back to a product-aware default. */
+    emptyTitle?: string;
+    /** Body copy for the empty state. Falls back to a product-aware default. */
+    emptySubtitle?: string;
+}
+interface CaseStudyPageProps {
+    productName?: string;
+    caseStudiesListUrl?: string;
+    /** Back-link label. Default: "Back to Case Studies". */
+    backLabel?: string;
+    /** Where the closing "get in touch" CTA points. Default: "/contact". */
+    contactHref?: string;
+    /** Closing CTA label. Default: "Get in touch". */
+    contactLabel?: string;
+    className?: string;
+}
+declare function CaseStudiesListPage(props: CaseStudiesListPageProps): react_jsx_runtime.JSX.Element;
+declare function CaseStudyPage(props: CaseStudyPageProps): react_jsx_runtime.JSX.Element;
+
+interface ChangelogEntry {
+    /** Release date as an ISO string. */
+    date: string;
+    /** Version identifier, e.g. "1.2.0". */
+    version: string;
+    /** Entry headline. */
+    title: string;
+    /** Category used for filtering, e.g. "feature", "fix", "improvement". */
+    category: string;
+    /** Entry body — plain text, markdown, or a React node. */
+    content: ReactNode | string;
+    /** Optional tags for search and filtering. */
+    tags?: string[];
+}
+interface ChangelogPageProps {
+    productName?: string;
+    heroEyebrow?: string;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    /** Optional bottom CTA. Rendered only when ctaHref + ctaLabel are provided. */
+    ctaTitle?: string;
+    ctaSubtitle?: string;
+    ctaHref?: string;
+    ctaLabel?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+    /**
+     * Optional prop-driven entries. When provided, the component skips the CMS
+     * fetch and renders these entries with search, category filters, and
+     * pagination.
+     */
+    entries?: ChangelogEntry[];
+    /** Number of entries per page in prop-driven mode. Defaults to 10. */
+    pageSize?: number;
+}
+declare function ChangelogPage(props: ChangelogPageProps): react_jsx_runtime.JSX.Element;
+
+type PressKitAssetCategory = "LOGO" | "BANNER" | "SCREENSHOT" | "BROCHURE" | "DOCUMENT" | "PRESS_RELEASE" | "BRAND_GUIDE";
+interface PressKitAsset {
+    id: string;
+    category: PressKitAssetCategory;
+    title: string;
+    slug: string;
+    description?: string | null;
+    fileUrl: string;
+    fileName?: string | null;
+    fileSize?: number | null;
+    mimeType?: string | null;
+    thumbnailUrl?: string | null;
+    version?: string | null;
+    tags: string[];
+    sortOrder: number;
+    updatedAt: string;
+}
+interface PressKitPageProps {
+    productName?: string;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    /** Media/press contact email shown in the contact block */
+    mediaContactEmail?: string;
+    /** Optional URL for a "Download brand kit" hero CTA (e.g. a zip asset) */
+    brandKitUrl?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+    /**
+     * Show a "Press Releases" section (published content pages tagged
+     * "press") above the downloadable assets. Self-hides when there are
+     * none. Default: true.
+     */
+    showPressReleases?: boolean;
+    /**
+     * Base path for press-release detail links — `${basePath}/${slug}`.
+     * Default: "/press".
+     */
+    pressReleaseBasePath?: string;
+    /** Heading for the press-releases section. Default: "Press Releases". */
+    pressReleasesTitle?: string;
+}
+declare function PressKitPage(props: PressKitPageProps): react_jsx_runtime.JSX.Element;
+
+interface ContractAsset {
+    id: string;
+    title: string;
+    slug: string;
+    description?: string | null;
+    fileUrl: string;
+    fileName?: string | null;
+    fileSize?: number | null;
+    mimeType?: string | null;
+    version?: string | null;
+    tags: string[];
+    sortOrder: number;
+    updatedAt: string;
+}
+interface ContractsPageProps {
+    productName?: string;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+}
+declare function ContractsPage(props: ContractsPageProps): react_jsx_runtime.JSX.Element;
+
+export { fetchPublicJobPosting as A, BlogListPage as B, type CareersPostingOption as C, fetchPublicJobPostings as D, fetchPublicJobPostingsForSubmission as E, useContentPage as F, useContentPages as G, usePublicJobPosting as H, usePublicJobPostings as I, usePublicJobPostingsForSubmission as J, type UseContentPageOptions as K, Markdown as M, type PressKitAsset as P, type UsePublicJobPostingOptions as U, type BlogListPageProps as a, BlogPostPage as b, type BlogPostPageProps as c, CareersApplyForm as d, type CareersApplyFormProps as e, CaseStudiesListPage as f, type CaseStudiesListPageProps as g, CaseStudyPage as h, type CaseStudyPageProps as i, type ChangelogEntry as j, ChangelogPage as k, type ChangelogPageProps as l, type ContentPageData as m, type ContentPageListData as n, type ContentPageListItem as o, ContentRenderer as p, type ContractAsset as q, ContractsPage as r, type ContractsPageProps as s, type MarkdownProps as t, type PressKitAssetCategory as u, PressKitPage as v, type PressKitPageProps as w, type PublicInterviewRoundConfig as x, type PublicJobPosting as y, type UsePublicJobPostingsOptions as z };