@burdenoff/website-sdk 0.0.0-dev

package/dist/content/index.d.mts

@@ -0,0 +1,247 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+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): converts to HTML via {@link renderMarkdown}
+ * - `html`: rendered as-is (assumed already sanitized upstream)
+ * - 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 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;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    caseStudyBasePath?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+}
+interface CaseStudyPageProps {
+    productName?: string;
+    caseStudiesListUrl?: string;
+    /** Back-link label. Default: "Back to Case Studies". */
+    backLabel?: 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 { BlogListPage, type BlogListPageProps, BlogPostPage, type BlogPostPageProps, CaseStudiesListPage, type CaseStudiesListPageProps, CaseStudyPage, type CaseStudyPageProps, type ChangelogEntry, ChangelogPage, type ChangelogPageProps, type ContentPageData, type ContentPageListData, type ContentPageListItem, ContentRenderer, type ContractAsset, ContractsPage, type ContractsPageProps, type PressKitAsset, type PressKitAssetCategory, PressKitPage, type PressKitPageProps, type UseContentPageOptions, useContentPage, useContentPages };

package/dist/content/index.d.ts

@@ -0,0 +1,247 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+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): converts to HTML via {@link renderMarkdown}
+ * - `html`: rendered as-is (assumed already sanitized upstream)
+ * - 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 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;
+    heroTitle?: string;
+    heroSubtitle?: string;
+    caseStudyBasePath?: string;
+    className?: string;
+    seoTitle?: string;
+    seoDescription?: string;
+    seoKeywords?: string;
+}
+interface CaseStudyPageProps {
+    productName?: string;
+    caseStudiesListUrl?: string;
+    /** Back-link label. Default: "Back to Case Studies". */
+    backLabel?: 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 { BlogListPage, type BlogListPageProps, BlogPostPage, type BlogPostPageProps, CaseStudiesListPage, type CaseStudiesListPageProps, CaseStudyPage, type CaseStudyPageProps, type ChangelogEntry, ChangelogPage, type ChangelogPageProps, type ContentPageData, type ContentPageListData, type ContentPageListItem, ContentRenderer, type ContractAsset, ContractsPage, type ContractsPageProps, type PressKitAsset, type PressKitAssetCategory, PressKitPage, type PressKitPageProps, type UseContentPageOptions, useContentPage, useContentPages };