@marvalt/digivalt-core 0.2.3 → 0.2.6

package/dist/seo.d.ts

@@ -0,0 +1,166 @@
+import React from 'react';
+
+/**
+ * JSON-LD / schema.org payload (loosely typed for extensibility).
+ */
+type StructuredData = Record<string, unknown> & {
+    '@context'?: string;
+    '@type'?: string;
+};
+
+interface SeoDefaults {
+    siteUrl: string;
+    siteName: string;
+    defaultTitle: string;
+    defaultDescription: string;
+    defaultKeywords?: string;
+    defaultImage: string;
+    twitterHandle?: string;
+    facebookAppId?: string;
+    googleSiteVerification?: string;
+    bingSiteVerification?: string;
+}
+/**
+ * SEO defaults from env-backed integration config (see `VITE_SEO_*` in docs).
+ */
+declare function getSeoDefaultsFromEnv(): SeoDefaults;
+
+interface PreconnectLink {
+    rel: 'preconnect';
+    href: string;
+    crossOrigin?: '' | 'anonymous' | 'use-credentials';
+}
+/**
+ * Suggest `<link rel="preconnect">` targets from an image URL (e.g. Cloudflare Images on imagedelivery.net).
+ * Apps may add more hosts (fonts, API) in `index.html` or via Helmet.
+ */
+declare function recommendedPreconnectHosts(imageUrl?: string | null): PreconnectLink[];
+
+interface JsonLdProps {
+    data: StructuredData | StructuredData[];
+    /** Optional id for multiple blocks on one page */
+    id?: string;
+}
+/**
+ * Renders one or more `<script type="application/ld+json">` tags.
+ */
+declare const JsonLd: React.FC<JsonLdProps>;
+
+interface DigiValtSeoHeadProps {
+    title?: string;
+    description?: string;
+    keywords?: string;
+    /** Path only, e.g. `/about` — combined with `VITE_SEO_SITE_URL` for canonical and og:url */
+    pathname?: string;
+    /** Full canonical URL override */
+    canonicalUrl?: string;
+    /** Page URL for og:url when not derivable from siteUrl + pathname */
+    ogUrl?: string;
+    imageUrl?: string;
+    ogType?: 'website' | 'article';
+    noindex?: boolean;
+    children?: React.ReactNode;
+}
+/**
+ * Document head: title, description, canonical, Open Graph, Twitter cards, optional verification meta.
+ * Requires `HelmetProvider` from `react-helmet-async` above this component in the tree.
+ */
+declare const DigiValtSeoHead: React.FC<DigiValtSeoHeadProps>;
+
+interface BuildEventJsonLdOptions {
+    siteUrl: string;
+    /** URL path including leading slash, e.g. `/events/slug` */
+    path: string;
+    fallbackImageUrl?: string;
+    /** Ticket or registration page when not in event meta */
+    defaultOffersUrl?: string;
+    organizerName?: string;
+    organizerUrl?: string;
+}
+/**
+ * Build schema.org Event JSON-LD from a WordPress `eventbrite_event`-style REST object
+ * (title, slug, featured_media_cloudflare_url, event_meta, link, etc.).
+ */
+declare function buildEventJsonLd(event: Record<string, unknown>, options: BuildEventJsonLdOptions): StructuredData;
+
+declare const createOrganizationSchema: (data: {
+    name: string;
+    url: string;
+    logo?: string;
+    description?: string;
+    address?: {
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string;
+        postalCode: string;
+        addressCountry: string;
+    };
+    contactPoint?: {
+        telephone: string;
+        contactType: string;
+    };
+}) => StructuredData;
+declare const createWebSiteSchema: (data: {
+    name: string;
+    url: string;
+    description?: string;
+    publisher?: string;
+}) => StructuredData;
+declare const createArticleSchema: (data: {
+    headline: string;
+    description: string;
+    image?: string;
+    author: string;
+    publisher: string;
+    datePublished: string;
+    dateModified?: string;
+    url: string;
+}) => StructuredData;
+declare const createServiceSchema: (data: {
+    name: string;
+    description: string;
+    provider: string;
+    url: string;
+    areaServed?: string;
+    serviceType?: string;
+}) => StructuredData;
+declare const createBreadcrumbSchema: (breadcrumbs: Array<{
+    name: string;
+    url: string;
+}>) => StructuredData;
+declare const createFAQSchema: (faqs: Array<{
+    question: string;
+    answer: string;
+}>) => StructuredData;
+
+/**
+ * Cloudflare Images URL helpers
+ *
+ * Many endpoints (e.g., cloudflare_image_standardized) return the base URL
+ * without a variant/transform segment. Append a variant at render-time to
+ * control size and improve LCP/SEO.
+ */
+/** Default max width for OG/Twitter share images (~1200px guidelines). */
+declare const DEFAULT_OG_IMAGE_MAX_WIDTH = 1200;
+interface CloudflareVariantOptions {
+    width: number;
+    height?: number;
+}
+declare const isCloudflareImageUrl: (url: string | undefined | null) => boolean;
+/**
+ * Append Cloudflare Images variant to the base URL if not already present.
+ * Example output: https://imagedelivery.net/<account>/<id>/w=1024,h=600
+ */
+declare const getCloudflareVariantUrl: (url: string, options: CloudflareVariantOptions) => string;
+/**
+ * Build a simple srcset for responsive images from a base Cloudflare URL.
+ */
+declare const buildCloudflareSrcSet: (url: string, widths: number[], fixedHeight?: number) => string | undefined;
+/**
+ * Bound social / meta image URLs to a reasonable width (PageSpeed, crawler fetches).
+ * Uses Cloudflare Images variants when applicable; otherwise returns the URL unchanged.
+ */
+declare function boundedShareImageUrl(url: string | undefined | null, maxWidth?: number): string;
+
+export { DEFAULT_OG_IMAGE_MAX_WIDTH, DigiValtSeoHead, JsonLd, boundedShareImageUrl, buildCloudflareSrcSet, buildEventJsonLd, createArticleSchema, createBreadcrumbSchema, createFAQSchema, createOrganizationSchema, createServiceSchema, createWebSiteSchema, getCloudflareVariantUrl, getSeoDefaultsFromEnv, isCloudflareImageUrl, recommendedPreconnectHosts };
+export type { BuildEventJsonLdOptions, DigiValtSeoHeadProps, JsonLdProps, PreconnectLink, SeoDefaults, StructuredData };