lynkow 3.8.52 → 3.8.60

package/dist/core-CqpK2E3_.d.mts

@@ -0,0 +1,14 @@
+type DataChangeCallback = (blockSlug: string, fieldKey: string, fieldPath: string, value: unknown, allData: Record<string, any>) => void;
+
+interface VisualEditorConfig {
+    cmsOrigin: string;
+}
+interface VisualEditorInstance {
+    destroy: () => void;
+    isPreviewMode: () => boolean;
+    getBlockData: (blockSlug: string) => Record<string, any> | null;
+    onDataChange: (callback: DataChangeCallback) => () => void;
+}
+declare function initVisualEditor(config: VisualEditorConfig): VisualEditorInstance;
+
+export { type DataChangeCallback as D, type VisualEditorConfig as V, type VisualEditorInstance as a, initVisualEditor as i };

package/dist/core-CqpK2E3_.d.ts

@@ -0,0 +1,14 @@
+type DataChangeCallback = (blockSlug: string, fieldKey: string, fieldPath: string, value: unknown, allData: Record<string, any>) => void;
+
+interface VisualEditorConfig {
+    cmsOrigin: string;
+}
+interface VisualEditorInstance {
+    destroy: () => void;
+    isPreviewMode: () => boolean;
+    getBlockData: (blockSlug: string) => Record<string, any> | null;
+    onDataChange: (callback: DataChangeCallback) => () => void;
+}
+declare function initVisualEditor(config: VisualEditorConfig): VisualEditorInstance;
+
+export { type DataChangeCallback as D, type VisualEditorConfig as V, type VisualEditorInstance as a, initVisualEditor as i };

package/dist/index.d.mts

@@ -627,43 +627,44 @@ declare class SeoService extends BaseService {
      */
     llmsFullTxt(options?: BaseRequestOptions): Promise<string>;
     /**
-     * Retrieves a single blog article as Markdown
+     * Retrieves a single content or page as Markdown by its path.
      *
-     * @param slug - The article slug
-     * @returns Article content as Markdown
+     * The path is the same as the content's public URL path (available in
+     * `Content.path` or `Page.path`). The SDK appends `.md` automatically.
+     *
+     * @param contentPath - The content's public path.
+     *   - For blog articles: use `Content.path` directly (includes locale prefix).
+     *   - For pages in mono-language mode: use `Page.path` directly.
+     *   - For pages in multi-language mode: prepend the locale manually,
+     *     e.g., `/${page.locale}${page.path}`.
+     * @returns Markdown content
      *
      * @example
      * ```typescript
-     * // In a Next.js route handler (app/llm/blog/[slug]/route.ts)
-     * export async function GET(_req: Request, { params }: { params: Promise<{ slug: string }> }) {
-     *   const { slug } = await params
-     *   const md = await lynkow.seo.getContentMarkdown(slug)
-     *   return new Response(md, {
-     *     headers: { 'Content-Type': 'text/plain; charset=utf-8' }
-     *   })
-     * }
-     * ```
-     */
-    getContentMarkdown(slug: string, options?: BaseRequestOptions): Promise<string>;
-    /**
-     * Retrieves a single page as Markdown
+     * // Get a blog article as Markdown (path includes locale automatically)
+     * const article = await lynkow.contents.getBySlug('my-article')
+     * const md = await lynkow.seo.getMarkdown(article.path)
      *
-     * @param slug - The page slug
-     * @returns Page content as Markdown
+     * // Get a page as Markdown (mono-language)
+     * const page = await lynkow.pages.getBySlug('about')
+     * const md = await lynkow.seo.getMarkdown(page.path!)
      *
-     * @example
-     * ```typescript
-     * // In a Next.js route handler (app/llm/pages/[slug]/route.ts)
-     * export async function GET(_req: Request, { params }: { params: Promise<{ slug: string }> }) {
-     *   const { slug } = await params
-     *   const md = await lynkow.seo.getPageMarkdown(slug)
+     * // Get a page as Markdown (multi-language — prepend locale)
+     * const page = await lynkow.pages.getBySlug('about')
+     * const md = await lynkow.seo.getMarkdown(`/${page.locale}${page.path}`)
+     *
+     * // In a Next.js catch-all route handler
+     * export async function GET(req: Request) {
+     *   const url = new URL(req.url)
+     *   const path = url.pathname.replace(/\.md$/, '')
+     *   const md = await lynkow.seo.getMarkdown(path)
      *   return new Response(md, {
-     *     headers: { 'Content-Type': 'text/plain; charset=utf-8' }
+     *     headers: { 'Content-Type': 'text/markdown; charset=utf-8' }
      *   })
      * }
      * ```
      */
-    getPageMarkdown(slug: string, options?: BaseRequestOptions): Promise<string>;
+    getMarkdown(contentPath: string, options?: BaseRequestOptions): Promise<string>;
 }
 
 /**
@@ -808,6 +809,72 @@ interface ImageVariants {
     full?: string;
 }
 
+/**
+ * Schema types for structured content.
+ *
+ * Categories in 'structured' mode define a field schema that determines
+ * the custom fields available for content in that category. These types
+ * describe the schema structure returned by the API.
+ */
+/**
+ * Supported field types in a content schema
+ */
+type SchemaFieldType = 'string' | 'text' | 'richtext' | 'number' | 'boolean' | 'select' | 'multiselect' | 'image' | 'file' | 'url' | 'email' | 'date' | 'datetime' | 'color' | 'object' | 'array' | 'dataSource';
+/**
+ * Option for select/multiselect fields
+ */
+interface SchemaFieldOption {
+    value: string;
+    label: string;
+}
+/**
+ * Validation rules for a schema field
+ */
+interface SchemaFieldValidation {
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    pattern?: string;
+}
+/**
+ * A single field definition in a content schema
+ */
+interface SchemaField {
+    /** Unique key (used as the property name in customData) */
+    key: string;
+    /** Field type */
+    type: SchemaFieldType;
+    /** Display label */
+    label: string;
+    /** Whether the field is required */
+    required?: boolean;
+    /** Placeholder text */
+    placeholder?: string;
+    /** Help text shown below the field */
+    helpText?: string;
+    /** Default value */
+    defaultValue?: unknown;
+    /** Validation rules */
+    validation?: SchemaFieldValidation;
+    /** Sub-fields for object/array types */
+    fields?: SchemaField[];
+    /** Label for array items */
+    itemLabel?: string;
+    /** Minimum number of array items */
+    minItems?: number;
+    /** Maximum number of array items */
+    maxItems?: number;
+    /** Options for select/multiselect types */
+    options?: SchemaFieldOption[];
+}
+/**
+ * Complete content schema (list of field definitions)
+ */
+interface ContentSchema {
+    fields: SchemaField[];
+}
+
 /**
  * Content category
  */
@@ -820,6 +887,14 @@ interface Category {
     slug: string;
     /** Locale */
     locale: string;
+    /**
+     * Content mode.
+     * - `'standard'`: articles use the TipTap rich text editor (body field)
+     * - `'structured'`: articles use custom fields defined by the category schema (customData field)
+     *
+     * Only present in detail responses, not in list select projections.
+     */
+    contentMode?: 'standard' | 'structured';
 }
 /**
  * Category with path and counter
@@ -835,6 +910,18 @@ interface CategoryWithCount extends Category {
     contentCount: number;
     /** CDN image variants */
     imageVariants?: ImageVariants;
+    /**
+     * Field schema for structured categories.
+     * Defines the custom fields available for content in this category.
+     * Only present when `contentMode` is `'structured'`.
+     */
+    schema?: ContentSchema | null;
+    /**
+     * Schema source.
+     * - `'own'`: this category defines its own schema
+     * - `'inherit'`: schema is inherited from the parent category
+     */
+    schemaSource?: 'own' | 'inherit' | null;
 }
 /**
  * Detailed category (with all info)
@@ -1039,6 +1126,22 @@ interface Content extends ContentSummary {
     categories: Category[];
     /** Associated tags */
     tags: Tag[];
+    /**
+     * Custom field data for structured content.
+     * Populated when the content belongs to a category with `contentMode: 'structured'`.
+     * Richtext fields are automatically converted to HTML by the API.
+     * `null` for standard content (which uses `body` instead).
+     *
+     * @example
+     * ```typescript
+     * if (content.customData) {
+     *   console.log(content.customData.price)       // number
+     *   console.log(content.customData.description)  // HTML string (richtext)
+     *   console.log(content.customData.gallery)      // array of objects
+     * }
+     * ```
+     */
+    customData?: Record<string, any> | null;
 }
 
 /**
@@ -2405,4 +2508,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, EnhancementsService, type ErrorCode, type EventData, type EventName, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormSettings, type FormSubmitData, type FormSubmitResponse, type GlobalBlock, type GlobalBlockResponse, type ImageVariants, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, MediaHelperService, 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 SrcsetOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, type TransformOptions, 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 ContentSchema, 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 GlobalBlock, type GlobalBlockResponse, type ImageVariants, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, MediaHelperService, 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 SchemaField, type SchemaFieldOption, type SchemaFieldType, type SchemaFieldValidation, type SiteConfig, type SiteConfigResponse, type SortOptions, type SrcsetOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, type TransformOptions, browserOnly, browserOnlyAsync, createClient, createLynkowClient, isBrowser, isCategoryResolve, isContentResolve, isLynkowError, isServer };

package/dist/index.d.ts

@@ -627,43 +627,44 @@ declare class SeoService extends BaseService {
      */
     llmsFullTxt(options?: BaseRequestOptions): Promise<string>;
     /**
-     * Retrieves a single blog article as Markdown
+     * Retrieves a single content or page as Markdown by its path.
      *
-     * @param slug - The article slug
-     * @returns Article content as Markdown
+     * The path is the same as the content's public URL path (available in
+     * `Content.path` or `Page.path`). The SDK appends `.md` automatically.
+     *
+     * @param contentPath - The content's public path.
+     *   - For blog articles: use `Content.path` directly (includes locale prefix).
+     *   - For pages in mono-language mode: use `Page.path` directly.
+     *   - For pages in multi-language mode: prepend the locale manually,
+     *     e.g., `/${page.locale}${page.path}`.
+     * @returns Markdown content
      *
      * @example
      * ```typescript
-     * // In a Next.js route handler (app/llm/blog/[slug]/route.ts)
-     * export async function GET(_req: Request, { params }: { params: Promise<{ slug: string }> }) {
-     *   const { slug } = await params
-     *   const md = await lynkow.seo.getContentMarkdown(slug)
-     *   return new Response(md, {
-     *     headers: { 'Content-Type': 'text/plain; charset=utf-8' }
-     *   })
-     * }
-     * ```
-     */
-    getContentMarkdown(slug: string, options?: BaseRequestOptions): Promise<string>;
-    /**
-     * Retrieves a single page as Markdown
+     * // Get a blog article as Markdown (path includes locale automatically)
+     * const article = await lynkow.contents.getBySlug('my-article')
+     * const md = await lynkow.seo.getMarkdown(article.path)
      *
-     * @param slug - The page slug
-     * @returns Page content as Markdown
+     * // Get a page as Markdown (mono-language)
+     * const page = await lynkow.pages.getBySlug('about')
+     * const md = await lynkow.seo.getMarkdown(page.path!)
      *
-     * @example
-     * ```typescript
-     * // In a Next.js route handler (app/llm/pages/[slug]/route.ts)
-     * export async function GET(_req: Request, { params }: { params: Promise<{ slug: string }> }) {
-     *   const { slug } = await params
-     *   const md = await lynkow.seo.getPageMarkdown(slug)
+     * // Get a page as Markdown (multi-language — prepend locale)
+     * const page = await lynkow.pages.getBySlug('about')
+     * const md = await lynkow.seo.getMarkdown(`/${page.locale}${page.path}`)
+     *
+     * // In a Next.js catch-all route handler
+     * export async function GET(req: Request) {
+     *   const url = new URL(req.url)
+     *   const path = url.pathname.replace(/\.md$/, '')
+     *   const md = await lynkow.seo.getMarkdown(path)
      *   return new Response(md, {
-     *     headers: { 'Content-Type': 'text/plain; charset=utf-8' }
+     *     headers: { 'Content-Type': 'text/markdown; charset=utf-8' }
      *   })
      * }
      * ```
      */
-    getPageMarkdown(slug: string, options?: BaseRequestOptions): Promise<string>;
+    getMarkdown(contentPath: string, options?: BaseRequestOptions): Promise<string>;
 }
 
 /**
@@ -808,6 +809,72 @@ interface ImageVariants {
     full?: string;
 }
 
+/**
+ * Schema types for structured content.
+ *
+ * Categories in 'structured' mode define a field schema that determines
+ * the custom fields available for content in that category. These types
+ * describe the schema structure returned by the API.
+ */
+/**
+ * Supported field types in a content schema
+ */
+type SchemaFieldType = 'string' | 'text' | 'richtext' | 'number' | 'boolean' | 'select' | 'multiselect' | 'image' | 'file' | 'url' | 'email' | 'date' | 'datetime' | 'color' | 'object' | 'array' | 'dataSource';
+/**
+ * Option for select/multiselect fields
+ */
+interface SchemaFieldOption {
+    value: string;
+    label: string;
+}
+/**
+ * Validation rules for a schema field
+ */
+interface SchemaFieldValidation {
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    pattern?: string;
+}
+/**
+ * A single field definition in a content schema
+ */
+interface SchemaField {
+    /** Unique key (used as the property name in customData) */
+    key: string;
+    /** Field type */
+    type: SchemaFieldType;
+    /** Display label */
+    label: string;
+    /** Whether the field is required */
+    required?: boolean;
+    /** Placeholder text */
+    placeholder?: string;
+    /** Help text shown below the field */
+    helpText?: string;
+    /** Default value */
+    defaultValue?: unknown;
+    /** Validation rules */
+    validation?: SchemaFieldValidation;
+    /** Sub-fields for object/array types */
+    fields?: SchemaField[];
+    /** Label for array items */
+    itemLabel?: string;
+    /** Minimum number of array items */
+    minItems?: number;
+    /** Maximum number of array items */
+    maxItems?: number;
+    /** Options for select/multiselect types */
+    options?: SchemaFieldOption[];
+}
+/**
+ * Complete content schema (list of field definitions)
+ */
+interface ContentSchema {
+    fields: SchemaField[];
+}
+
 /**
  * Content category
  */
@@ -820,6 +887,14 @@ interface Category {
     slug: string;
     /** Locale */
     locale: string;
+    /**
+     * Content mode.
+     * - `'standard'`: articles use the TipTap rich text editor (body field)
+     * - `'structured'`: articles use custom fields defined by the category schema (customData field)
+     *
+     * Only present in detail responses, not in list select projections.
+     */
+    contentMode?: 'standard' | 'structured';
 }
 /**
  * Category with path and counter
@@ -835,6 +910,18 @@ interface CategoryWithCount extends Category {
     contentCount: number;
     /** CDN image variants */
     imageVariants?: ImageVariants;
+    /**
+     * Field schema for structured categories.
+     * Defines the custom fields available for content in this category.
+     * Only present when `contentMode` is `'structured'`.
+     */
+    schema?: ContentSchema | null;
+    /**
+     * Schema source.
+     * - `'own'`: this category defines its own schema
+     * - `'inherit'`: schema is inherited from the parent category
+     */
+    schemaSource?: 'own' | 'inherit' | null;
 }
 /**
  * Detailed category (with all info)
@@ -1039,6 +1126,22 @@ interface Content extends ContentSummary {
     categories: Category[];
     /** Associated tags */
     tags: Tag[];
+    /**
+     * Custom field data for structured content.
+     * Populated when the content belongs to a category with `contentMode: 'structured'`.
+     * Richtext fields are automatically converted to HTML by the API.
+     * `null` for standard content (which uses `body` instead).
+     *
+     * @example
+     * ```typescript
+     * if (content.customData) {
+     *   console.log(content.customData.price)       // number
+     *   console.log(content.customData.description)  // HTML string (richtext)
+     *   console.log(content.customData.gallery)      // array of objects
+     * }
+     * ```
+     */
+    customData?: Record<string, any> | null;
 }
 
 /**
@@ -2405,4 +2508,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, EnhancementsService, type ErrorCode, type EventData, type EventName, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormSettings, type FormSubmitData, type FormSubmitResponse, type GlobalBlock, type GlobalBlockResponse, type ImageVariants, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, MediaHelperService, 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 SrcsetOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, type TransformOptions, 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 ContentSchema, 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 GlobalBlock, type GlobalBlockResponse, type ImageVariants, type LegalDocument, type LynkowClient, type LynkowConfig, LynkowError, type LynkowEvents, MediaHelperService, 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 SchemaField, type SchemaFieldOption, type SchemaFieldType, type SchemaFieldValidation, type SiteConfig, type SiteConfigResponse, type SortOptions, type SrcsetOptions, type SubmitOptions, type Tag, type TagsListResponse, type TipTapMark, type TipTapNode, type TransformOptions, browserOnly, browserOnlyAsync, createClient, createLynkowClient, isBrowser, isCategoryResolve, isContentResolve, isLynkowError, isServer };