lynkow 3.2.4 → 3.4.0

package/README.md

@@ -410,7 +410,7 @@ const unsubscribe = lynkow.on('consent-changed', (categories) => {
   console.log('Consent changed:', categories)
 })
 
-// Unsubscribe when done
+// Unsubscribe when done ✅
 unsubscribe()
 ```
 

package/dist/index.d.mts

@@ -763,6 +763,83 @@ interface Tag {
     locale: string;
 }
 
+/**
+ * FAQ item detected from content
+ */
+interface FaqItem {
+    /** Unique ID (8-char MD5 hash of normalized question) */
+    id: string;
+    /** Question text */
+    question: string;
+    /** Answer as HTML */
+    answerHtml: string;
+    /** Answer as plain text */
+    answerText: string;
+    /** Source of the FAQ */
+    source: 'explicit' | 'heading';
+    /** Whether this FAQ is enabled for JSON-LD */
+    enabled: boolean;
+}
+/**
+ * JSON-LD FAQPage schema
+ */
+interface JsonLdFaqPage {
+    '@context': 'https://schema.org';
+    '@type': 'FAQPage';
+    mainEntity: Array<{
+        '@type': 'Question';
+        name: string;
+        acceptedAnswer: {
+            '@type': 'Answer';
+            text: string;
+        };
+    }>;
+}
+/**
+ * JSON-LD Article schema
+ */
+interface JsonLdArticle {
+    '@context': 'https://schema.org';
+    '@type': 'Article';
+    headline: string;
+    description?: string;
+    image?: string;
+    datePublished?: string;
+    dateModified?: string;
+    author?: {
+        '@type': 'Person';
+        name: string;
+    };
+}
+/**
+ * Alternate language version
+ */
+interface StructuredDataAlternate {
+    /** Locale code */
+    locale: string;
+    /** URL to this version */
+    url: string;
+}
+/**
+ * Structured data generated for a content
+ */
+interface StructuredData {
+    /** Format version */
+    version: number;
+    /** FAQ data */
+    faq: {
+        /** All detected FAQ items */
+        items: FaqItem[];
+        /** JSON-LD FAQPage schema (null if no enabled items) */
+        jsonLd: JsonLdFaqPage | null;
+    };
+    /** Article JSON-LD schema */
+    article: {
+        jsonLd: JsonLdArticle;
+    };
+    /** Alternate language versions */
+    alternates: StructuredDataAlternate[];
+}
 /**
  * Content author
  */
@@ -850,7 +927,7 @@ interface Content extends ContentSummary {
     /** Open Graph image */
     ogImage: string | null;
     /** JSON-LD structured data */
-    structuredData: Record<string, unknown> | null;
+    structuredData: StructuredData | null;
     /** Article author */
     author: Author | null;
     /** Associated categories */
@@ -1797,6 +1874,58 @@ declare class BrandingService {
     destroy(): void;
 }
 
+/**
+ * Content Enhancements module for Lynkow SDK
+ *
+ * Browser-only module. Adds interactive features to content rendered from the API:
+ * - Copy button for code blocks
+ * - (Future: lightbox for images, table of contents, etc.)
+ */
+/**
+ * Content Enhancements service
+ *
+ * Browser-only. All methods are no-op on server.
+ *
+ * @example
+ * ```typescript
+ * const lynkow = createClient({ siteId: 'your-site-id' })
+ *
+ * // Enhancements are automatically initialized
+ * // Or manually reinitialize after dynamic content load:
+ * lynkow.enhancements.init()
+ * ```
+ */
+declare class EnhancementsService {
+    private initialized;
+    private observer;
+    /**
+     * Inject styles into document head
+     */
+    private injectStyles;
+    /**
+     * Handle copy button click
+     */
+    private handleCopyClick;
+    /**
+     * Bind copy functionality to all code blocks
+     */
+    private bindCodeBlockCopy;
+    /**
+     * Initialize content enhancements
+     *
+     * Call this after loading dynamic content to bind event handlers.
+     */
+    init(): void;
+    /**
+     * Check if enhancements are initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Clean up resources
+     */
+    destroy(): void;
+}
+
 /**
  * Lynkow SDK Client
  * Main entry point for the SDK
@@ -1873,6 +2002,10 @@ interface Client extends LynkowClient {
      * Branding service (badge for free plan)
      */
     branding: BrandingService;
+    /**
+     * Content enhancements service (code copy, etc.)
+     */
+    enhancements: EnhancementsService;
 }
 /**
  * Creates a Lynkow client instance (SDK v3)
@@ -2022,4 +2155,4 @@ declare function browserOnly<T>(fn: () => T, fallback: T): T;
  */
 declare function browserOnlyAsync<T>(fn: () => Promise<T>, fallback: T): Promise<T>;
 
-export { type Alternate, type ApiErrorDetail, type Author, type BaseRequestOptions, type CategoriesListResponse, type Category, type CategoryDetail, type CategoryDetailResponse, type CategoryOptions, type CategoryResolveResponse, type CategoryTreeNode, type CategoryTreeResponse, type CategoryWithCount, type Client, type ClientConfig, type ConsentCategories, type ConsentLogResponse, type Content, type ContentBody, type ContentResolveResponse, type ContentSummary, type ContentsFilters, type ContentsListResponse, type CookieCategory, type CookieConfig, type CookiePreferences, type CookieTexts, type ErrorCode, type EventData, type EventName, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormSettings, type FormSubmitData, type FormSubmitResponse, type FunnelStepData, type GlobalBlock, type GlobalBlockResponse, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, type Page, type PageSeo, type PageSummary, type PagesListResponse, type PageviewData, type PaginatedResponse, type PaginationMeta, type PaginationOptions, type Path, type PathsListResponse, type Redirect, type ResolveResponse, type Review, type ReviewResponse, type ReviewSettings, type ReviewSubmitData, type ReviewSubmitResponse, type ReviewsFilters, type ReviewsListResponse, type SiteConfig, type SiteConfigResponse, type SortOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, browserOnly, browserOnlyAsync, createClient, createLynkowClient, isBrowser, isCategoryResolve, isContentResolve, isLynkowError, isServer };
+export { type Alternate, type ApiErrorDetail, type Author, type BaseRequestOptions, type CategoriesListResponse, type Category, type CategoryDetail, type CategoryDetailResponse, type CategoryOptions, type CategoryResolveResponse, type CategoryTreeNode, type CategoryTreeResponse, type CategoryWithCount, type Client, type ClientConfig, type ConsentCategories, type ConsentLogResponse, type Content, type ContentBody, type ContentResolveResponse, type ContentSummary, type ContentsFilters, type ContentsListResponse, type CookieCategory, type CookieConfig, type CookiePreferences, type CookieTexts, EnhancementsService, type ErrorCode, type EventData, type EventName, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormSettings, type FormSubmitData, type FormSubmitResponse, type FunnelStepData, type GlobalBlock, type GlobalBlockResponse, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, type Page, type PageSeo, type PageSummary, type PagesListResponse, type PageviewData, type PaginatedResponse, type PaginationMeta, type PaginationOptions, type Path, type PathsListResponse, type Redirect, type ResolveResponse, type Review, type ReviewResponse, type ReviewSettings, type ReviewSubmitData, type ReviewSubmitResponse, type ReviewsFilters, type ReviewsListResponse, type SiteConfig, type SiteConfigResponse, type SortOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, browserOnly, browserOnlyAsync, createClient, createLynkowClient, isBrowser, isCategoryResolve, isContentResolve, isLynkowError, isServer };

package/dist/index.d.ts

@@ -763,6 +763,83 @@ interface Tag {
     locale: string;
 }
 
+/**
+ * FAQ item detected from content
+ */
+interface FaqItem {
+    /** Unique ID (8-char MD5 hash of normalized question) */
+    id: string;
+    /** Question text */
+    question: string;
+    /** Answer as HTML */
+    answerHtml: string;
+    /** Answer as plain text */
+    answerText: string;
+    /** Source of the FAQ */
+    source: 'explicit' | 'heading';
+    /** Whether this FAQ is enabled for JSON-LD */
+    enabled: boolean;
+}
+/**
+ * JSON-LD FAQPage schema
+ */
+interface JsonLdFaqPage {
+    '@context': 'https://schema.org';
+    '@type': 'FAQPage';
+    mainEntity: Array<{
+        '@type': 'Question';
+        name: string;
+        acceptedAnswer: {
+            '@type': 'Answer';
+            text: string;
+        };
+    }>;
+}
+/**
+ * JSON-LD Article schema
+ */
+interface JsonLdArticle {
+    '@context': 'https://schema.org';
+    '@type': 'Article';
+    headline: string;
+    description?: string;
+    image?: string;
+    datePublished?: string;
+    dateModified?: string;
+    author?: {
+        '@type': 'Person';
+        name: string;
+    };
+}
+/**
+ * Alternate language version
+ */
+interface StructuredDataAlternate {
+    /** Locale code */
+    locale: string;
+    /** URL to this version */
+    url: string;
+}
+/**
+ * Structured data generated for a content
+ */
+interface StructuredData {
+    /** Format version */
+    version: number;
+    /** FAQ data */
+    faq: {
+        /** All detected FAQ items */
+        items: FaqItem[];
+        /** JSON-LD FAQPage schema (null if no enabled items) */
+        jsonLd: JsonLdFaqPage | null;
+    };
+    /** Article JSON-LD schema */
+    article: {
+        jsonLd: JsonLdArticle;
+    };
+    /** Alternate language versions */
+    alternates: StructuredDataAlternate[];
+}
 /**
  * Content author
  */
@@ -850,7 +927,7 @@ interface Content extends ContentSummary {
     /** Open Graph image */
     ogImage: string | null;
     /** JSON-LD structured data */
-    structuredData: Record<string, unknown> | null;
+    structuredData: StructuredData | null;
     /** Article author */
     author: Author | null;
     /** Associated categories */
@@ -1797,6 +1874,58 @@ declare class BrandingService {
     destroy(): void;
 }
 
+/**
+ * Content Enhancements module for Lynkow SDK
+ *
+ * Browser-only module. Adds interactive features to content rendered from the API:
+ * - Copy button for code blocks
+ * - (Future: lightbox for images, table of contents, etc.)
+ */
+/**
+ * Content Enhancements service
+ *
+ * Browser-only. All methods are no-op on server.
+ *
+ * @example
+ * ```typescript
+ * const lynkow = createClient({ siteId: 'your-site-id' })
+ *
+ * // Enhancements are automatically initialized
+ * // Or manually reinitialize after dynamic content load:
+ * lynkow.enhancements.init()
+ * ```
+ */
+declare class EnhancementsService {
+    private initialized;
+    private observer;
+    /**
+     * Inject styles into document head
+     */
+    private injectStyles;
+    /**
+     * Handle copy button click
+     */
+    private handleCopyClick;
+    /**
+     * Bind copy functionality to all code blocks
+     */
+    private bindCodeBlockCopy;
+    /**
+     * Initialize content enhancements
+     *
+     * Call this after loading dynamic content to bind event handlers.
+     */
+    init(): void;
+    /**
+     * Check if enhancements are initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Clean up resources
+     */
+    destroy(): void;
+}
+
 /**
  * Lynkow SDK Client
  * Main entry point for the SDK
@@ -1873,6 +2002,10 @@ interface Client extends LynkowClient {
      * Branding service (badge for free plan)
      */
     branding: BrandingService;
+    /**
+     * Content enhancements service (code copy, etc.)
+     */
+    enhancements: EnhancementsService;
 }
 /**
  * Creates a Lynkow client instance (SDK v3)
@@ -2022,4 +2155,4 @@ declare function browserOnly<T>(fn: () => T, fallback: T): T;
  */
 declare function browserOnlyAsync<T>(fn: () => Promise<T>, fallback: T): Promise<T>;
 
-export { type Alternate, type ApiErrorDetail, type Author, type BaseRequestOptions, type CategoriesListResponse, type Category, type CategoryDetail, type CategoryDetailResponse, type CategoryOptions, type CategoryResolveResponse, type CategoryTreeNode, type CategoryTreeResponse, type CategoryWithCount, type Client, type ClientConfig, type ConsentCategories, type ConsentLogResponse, type Content, type ContentBody, type ContentResolveResponse, type ContentSummary, type ContentsFilters, type ContentsListResponse, type CookieCategory, type CookieConfig, type CookiePreferences, type CookieTexts, type ErrorCode, type EventData, type EventName, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormSettings, type FormSubmitData, type FormSubmitResponse, type FunnelStepData, type GlobalBlock, type GlobalBlockResponse, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, type Page, type PageSeo, type PageSummary, type PagesListResponse, type PageviewData, type PaginatedResponse, type PaginationMeta, type PaginationOptions, type Path, type PathsListResponse, type Redirect, type ResolveResponse, type Review, type ReviewResponse, type ReviewSettings, type ReviewSubmitData, type ReviewSubmitResponse, type ReviewsFilters, type ReviewsListResponse, type SiteConfig, type SiteConfigResponse, type SortOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, browserOnly, browserOnlyAsync, createClient, createLynkowClient, isBrowser, isCategoryResolve, isContentResolve, isLynkowError, isServer };
+export { type Alternate, type ApiErrorDetail, type Author, type BaseRequestOptions, type CategoriesListResponse, type Category, type CategoryDetail, type CategoryDetailResponse, type CategoryOptions, type CategoryResolveResponse, type CategoryTreeNode, type CategoryTreeResponse, type CategoryWithCount, type Client, type ClientConfig, type ConsentCategories, type ConsentLogResponse, type Content, type ContentBody, type ContentResolveResponse, type ContentSummary, type ContentsFilters, type ContentsListResponse, type CookieCategory, type CookieConfig, type CookiePreferences, type CookieTexts, EnhancementsService, type ErrorCode, type EventData, type EventName, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormSettings, type FormSubmitData, type FormSubmitResponse, type FunnelStepData, type GlobalBlock, type GlobalBlockResponse, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, type Page, type PageSeo, type PageSummary, type PagesListResponse, type PageviewData, type PaginatedResponse, type PaginationMeta, type PaginationOptions, type Path, type PathsListResponse, type Redirect, type ResolveResponse, type Review, type ReviewResponse, type ReviewSettings, type ReviewSubmitData, type ReviewSubmitResponse, type ReviewsFilters, type ReviewsListResponse, type SiteConfig, type SiteConfigResponse, type SortOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, browserOnly, browserOnlyAsync, createClient, createLynkowClient, isBrowser, isCategoryResolve, isContentResolve, isLynkowError, isServer };