@localess/react 3.0.1-dev.20260410071322 → 3.0.1-dev.20260412201733

package/dist/index.d.mts

@@ -1,104 +0,0 @@
-export { L as LocalessOptions, f as findLink, g as getComponent, a as getFallbackComponent, b as getLocalessClient, i as isSyncEnabled, l as localessInit, r as registerComponent, c as renderRichTextToReact, d as resolveAsset, s as setComponents, e as setFallbackComponent, u as unregisterComponent } from './richtext-l2BRZFEP.mjs';
-import * as React from 'react';
-import { ContentData, Links, References, ContentFetchParams, Content } from '@localess/client';
-export { Content, ContentAsset, ContentData, ContentDataField, ContentDataSchema, ContentLink, ContentMetadata, ContentReference, ContentRichText, EventCallback, EventToApp, EventToAppType, Links, LocalessClient, LocalessSync, References, Translations, isBrowser, isIframe, isServer, localessEditable, localessEditableField } from '@localess/client';
-
-/**
- * Props for {@link LocalessComponent}.
- *
- * @template T - The content data shape. Defaults to the base {@link ContentData} type.
- */
-type LocalessComponentProps<T extends ContentData = ContentData> = {
-    /**
-     * The content data object to render. Must have a `_schema` field that matches a key
-     * in the component registry configured via `localessInit`.
-     */
-    data: T;
-    /**
-     * Optional map of content links keyed by link ID.
-     * Pass through to child components so they can resolve {@link ContentLink} values with `findLink`.
-     */
-    links?: Links;
-    /**
-     * Optional map of resolved content references keyed by reference ID.
-     * Pass through to child components that consume referenced content.
-     */
-    references?: References;
-};
-/**
- * Dynamic schema-to-component renderer for use in SPA and client-side contexts.
- *
- * Looks up `data._schema` in the component registry (set via `localessInit` or `setComponents`),
- * renders the matched component, and — when Visual Editor sync is active — automatically
- * spreads `localessEditable` attributes on the root element for live targeting.
- *
- * Falls back to the `fallbackComponent` (if registered) when the schema key is not found,
- * or renders an inline error message as a last resort.
- *
- * **Server-safe** — does not include a `'use client'` directive and can be used in
- * React Server Components. For SSR / static-export environments use {@link LocalessServerComponent}
- * from `@localess/react/ssr` instead, which omits the sync attribute injection.
- *
- * @template T - The content data shape. Defaults to {@link ContentData}.
- *
- * @example Basic usage
- * ```tsx
- * import { LocalessComponent } from '@localess/react';
- *
- * <LocalessComponent data={content.data} links={content.links} references={content.references} />
- * ```
- *
- * @example Rendering a list of nested blocks
- * ```tsx
- * {data.body.map(item => (
- *   <LocalessComponent key={item._id} data={item} links={content.links} references={content.references} />
- * ))}
- * ```
- */
-declare const LocalessComponent: React.ForwardRefExoticComponent<LocalessComponentProps<ContentData> & React.RefAttributes<HTMLElement>>;
-
-/**
- * Options for {@link useLocaless}.
- * Extends {@link ContentFetchParams} with any future hook-specific settings.
- */
-type UseLocalessOptions = ContentFetchParams & {};
-/**
- * React hook for fetching Localess content by slug inside a Client Component.
- *
- * Fetches content on mount using `getLocalessClient().getContentBySlug`, stores it in local state,
- * and — when `enableSync` is active and the page is running inside the Visual Editor iframe —
- * automatically subscribes to `input` and `change` events so content updates live without a reload.
- *
- * **Requires `'use client'`** — must be called inside a Client Component.
- *
- * **Recommended pattern:** fetch data server-side and pass it as `initialContent`, then use the
- * hook result with `?? initialContent` to avoid a loading flash:
- * ```tsx
- * const content = useLocaless('home', { locale }) ?? initialContent;
- * ```
- *
- * @template T - The content data shape. Defaults to {@link ContentData}.
- *
- * @param slug - Content slug string, or an array of path segments that will be joined with `/`.
- * @param options - Optional fetch parameters (locale, version, resolveReference, resolveLink).
- * @returns The fetched {@link Content}<T> object, or `undefined` while the initial fetch is in flight.
- *
- * @example Basic usage
- * ```tsx
- * 'use client';
- * import { useLocaless } from '@localess/react/rsc';
- *
- * export function PageClient({ initialContent, locale }) {
- *   const content = useLocaless('home', { locale }) ?? initialContent;
- *   return <LocalessComponent data={content.data} links={content.links} />;
- * }
- * ```
- *
- * @example Array slug (joined as 'blog/my-post')
- * ```tsx
- * const content = useLocaless(['blog', 'my-post'], { locale: 'en' });
- * ```
- */
-declare const useLocaless: <T extends ContentData = ContentData>(slug: string | string[], options?: UseLocalessOptions) => Content<T> | undefined;
-
-export { LocalessComponent, type LocalessComponentProps, type UseLocalessOptions, useLocaless };

package/dist/richtext-l2BRZFEP.d.mts

@@ -1,218 +0,0 @@
-import React__default from 'react';
-import { LocalessClientOptions, LocalessClient, ContentAsset, Links, ContentLink, ContentRichText } from '@localess/client';
-
-/**
- * Initialization options for {@link localessInit}.
- *
- * Extends {@link LocalessClientOptions} (origin, spaceId, token, version, debug, cacheTTL)
- * with React-specific settings for component mapping and Visual Editor sync.
- */
-type LocalessOptions = LocalessClientOptions & {
-    /**
-     * Map of schema keys to React components used by {@link LocalessComponent} and
-     * {@link LocalessServerComponent} to render content blocks.
-     *
-     * Keys must match the `_schema` field of your Localess content objects.
-     * Use lowercase hyphenated names by convention (e.g. `'hero-section'`).
-     *
-     * @example
-     * ```ts
-     * components: {
-     *   'page': PageComponent,
-     *   'hero-section': HeroSection,
-     *   'nav-menu': NavMenu,
-     * }
-     * ```
-     */
-    components?: Record<string, React__default.ElementType>;
-    /**
-     * Fallback React component rendered when `_schema` has no match in the registry.
-     * Receives the same `data`, `links`, and `references` props as any registered component.
-     * If omitted, an inline error message is rendered instead.
-     */
-    fallbackComponent?: React__default.ElementType;
-    /**
-     * When `true`, injects the Localess Visual Editor sync script (`sync-v1.js`) into
-     * `<head>` so that `input` and `change` events from the editor reach the app.
-     * Only takes effect when the page is running inside the Visual Editor iframe.
-     * Set to `false` (or omit) in production builds to avoid loading the script.
-     *
-     * @default false
-     */
-    enableSync?: boolean;
-};
-
-/**
- * Initialize the Localess SDK.
- *
- * Must be called **once** at application startup (e.g. root layout, `_app.tsx`) before any
- * other SDK function is used. Calling it again overwrites the existing client and state.
- *
- * - Creates the underlying {@link LocalessClient} with the supplied API options.
- * - Registers the component map and optional fallback component.
- * - When `enableSync` is `true` and the page is running inside the Visual Editor iframe,
- *   injects the Localess sync script into `<head>` to enable live editing events.
- *
- * @param options - Initialization options. Extends {@link LocalessClientOptions} with
- *   `components`, `fallbackComponent`, and `enableSync`.
- * @returns The initialized {@link LocalessClient} instance.
- *
- * @example
- * ```ts
- * import { localessInit } from '@localess/react';
- * import { Page, Header, Teaser } from '@/components';
- *
- * localessInit({
- *   origin: 'https://my-localess.web.app',
- *   spaceId: 'YOUR_SPACE_ID',
- *   token: 'YOUR_API_TOKEN',          // keep server-side only
- *   enableSync: process.env.NODE_ENV !== 'production',
- *   components: { page: Page, header: Header, teaser: Teaser },
- * });
- * ```
- */
-declare function localessInit(options: LocalessOptions): LocalessClient;
-/**
- * Returns the initialized {@link LocalessClient} instance.
- *
- * Throws an error if called before {@link localessInit}. Use this in server components,
- * API routes, or server-side data fetching functions to make API calls.
- *
- * @throws {Error} If `localessInit` has not been called yet.
- * @returns The active {@link LocalessClient}.
- *
- * @example
- * ```ts
- * const content = await getLocalessClient().getContentBySlug<MyPage>('home', { locale: 'en' });
- * ```
- */
-declare function getLocalessClient(): LocalessClient;
-/**
- * Adds a single component to the registry under the given schema key.
- *
- * The key must match the `_schema` field of the content objects you want to render.
- * Overwrites any previously registered component for the same key.
- *
- * @param key - The schema key (e.g. `'hero-section'`).
- * @param component - The React component to render for this schema key.
- */
-declare function registerComponent(key: string, component: React__default.ElementType): void;
-/**
- * Removes a component from the registry by schema key.
- * No-op if the key does not exist.
- *
- * @param key - The schema key to remove.
- */
-declare function unregisterComponent(key: string): void;
-/**
- * Replaces the entire component registry with the supplied map.
- *
- * Useful when you need to swap all components at once (e.g. lazy-loaded registry).
- * Any previously registered components (including those set via `localessInit`) are discarded.
- *
- * @param components - A record mapping schema keys to React components.
- */
-declare function setComponents(components: Record<string, React__default.ElementType>): void;
-/**
- * Looks up a React component by its schema key.
- *
- * Returns `undefined` and logs a console error when the key is not found.
- * Called internally by {@link LocalessComponent} and {@link LocalessServerComponent}.
- *
- * @param key - The schema key to look up (matches `content._schema`).
- * @returns The registered React component, or `undefined` if not found.
- */
-declare function getComponent(key: string): React__default.ElementType | undefined;
-/**
- * Sets the fallback component rendered when no registry match is found for a schema key.
- *
- * The fallback receives the same `data`, `links`, and `references` props as any
- * registered component, so it can render a generic placeholder or log the unknown schema.
- *
- * @param fallbackComponent - The React component to use as the fallback.
- */
-declare function setFallbackComponent(fallbackComponent: React__default.ElementType): void;
-/**
- * Returns the currently registered fallback component, or `undefined` if none is set.
- *
- * Called internally by {@link LocalessComponent} and {@link LocalessServerComponent}
- * when a schema key has no matching component in the registry.
- *
- * @returns The fallback React component, or `undefined`.
- */
-declare function getFallbackComponent(): React__default.ElementType | undefined;
-/**
- * Returns `true` when Visual Editor sync was enabled via `enableSync: true` in `localessInit`.
- *
- * Used internally by {@link LocalessComponent}, {@link LocalessDocument}, and {@link useLocaless}
- * to decide whether to inject editable attributes and subscribe to sync events.
- *
- * @returns `true` if sync is enabled, `false` otherwise.
- */
-declare function isSyncEnabled(): boolean;
-/**
- * Resolves a {@link ContentAsset} to its full URL string.
- *
- * Constructs the URL using the `origin` and `spaceId` from `localessInit`:
- * `{origin}/api/v1/spaces/{spaceId}/assets/{asset.uri}`
- *
- * @param asset - The asset reference object containing a `uri` field.
- * @returns The fully qualified asset URL string.
- *
- * @example
- * ```tsx
- * <img src={resolveAsset(data.heroImage)} alt={data.heroImage.alt} />
- * ```
- */
-declare function resolveAsset(asset: ContentAsset): string;
-
-/**
- * Resolves a {@link ContentLink} reference to a navigable URL string.
- *
- * Resolution rules by `link.type`:
- * - `'content'` — looks up `link.uri` in the `links` map and returns `'/' + fullSlug`.
- *   Returns `'/not-found'` when `links` is undefined or the URI is not in the map.
- * - `'url'`     — returns `link.uri` directly (external or absolute URL).
- * - anything else — returns `'no-type'` (indicates a misconfigured link field).
- *
- * @param links - The links map from `content.links` (keyed by link URI). May be `undefined`.
- * @param link  - The content link reference to resolve.
- * @returns A URL string ready to use in an `<a href>` or Next.js `<Link href>`.
- *
- * @example
- * ```tsx
- * import { findLink } from '@localess/react';
- *
- * function NavItem({ data, links }) {
- *   return <a href={findLink(links, data.url)}>{data.label}</a>;
- * }
- * ```
- */
-declare function findLink(links: Links | undefined, link: ContentLink): string;
-
-/**
- * Renders a Localess rich text field to a React node tree.
- *
- * Converts a {@link ContentRichText} value (TipTap ProseMirror document JSON) into
- * `React.ReactNode` using TipTap's static renderer. No browser APIs are required —
- * safe to call in React Server Components and SSR.
- *
- * Supported TipTap extensions: Document, Text, Paragraph, Heading (h1–h6), Bold,
- * Italic, Strike, Underline, History, ListItem, OrderedList, BulletList, Code,
- * CodeBlockLowlight, Link.
- *
- * @param content - The rich text value from a Localess content field (type `ContentRichText`).
- * @returns A `React.ReactNode` ready to render inside JSX.
- *
- * @example
- * ```tsx
- * import { renderRichTextToReact } from '@localess/react';
- *
- * export function Article({ data }: { data: MyContent }) {
- *   return <article>{renderRichTextToReact(data.body)}</article>;
- * }
- * ```
- */
-declare function renderRichTextToReact(content: ContentRichText): React__default.ReactNode;
-
-export { type LocalessOptions as L, getFallbackComponent as a, getLocalessClient as b, renderRichTextToReact as c, resolveAsset as d, setFallbackComponent as e, findLink as f, getComponent as g, isSyncEnabled as i, localessInit as l, registerComponent as r, setComponents as s, unregisterComponent as u };

package/dist/richtext-l2BRZFEP.d.ts

@@ -1,218 +0,0 @@
-import React__default from 'react';
-import { LocalessClientOptions, LocalessClient, ContentAsset, Links, ContentLink, ContentRichText } from '@localess/client';
-
-/**
- * Initialization options for {@link localessInit}.
- *
- * Extends {@link LocalessClientOptions} (origin, spaceId, token, version, debug, cacheTTL)
- * with React-specific settings for component mapping and Visual Editor sync.
- */
-type LocalessOptions = LocalessClientOptions & {
-    /**
-     * Map of schema keys to React components used by {@link LocalessComponent} and
-     * {@link LocalessServerComponent} to render content blocks.
-     *
-     * Keys must match the `_schema` field of your Localess content objects.
-     * Use lowercase hyphenated names by convention (e.g. `'hero-section'`).
-     *
-     * @example
-     * ```ts
-     * components: {
-     *   'page': PageComponent,
-     *   'hero-section': HeroSection,
-     *   'nav-menu': NavMenu,
-     * }
-     * ```
-     */
-    components?: Record<string, React__default.ElementType>;
-    /**
-     * Fallback React component rendered when `_schema` has no match in the registry.
-     * Receives the same `data`, `links`, and `references` props as any registered component.
-     * If omitted, an inline error message is rendered instead.
-     */
-    fallbackComponent?: React__default.ElementType;
-    /**
-     * When `true`, injects the Localess Visual Editor sync script (`sync-v1.js`) into
-     * `<head>` so that `input` and `change` events from the editor reach the app.
-     * Only takes effect when the page is running inside the Visual Editor iframe.
-     * Set to `false` (or omit) in production builds to avoid loading the script.
-     *
-     * @default false
-     */
-    enableSync?: boolean;
-};
-
-/**
- * Initialize the Localess SDK.
- *
- * Must be called **once** at application startup (e.g. root layout, `_app.tsx`) before any
- * other SDK function is used. Calling it again overwrites the existing client and state.
- *
- * - Creates the underlying {@link LocalessClient} with the supplied API options.
- * - Registers the component map and optional fallback component.
- * - When `enableSync` is `true` and the page is running inside the Visual Editor iframe,
- *   injects the Localess sync script into `<head>` to enable live editing events.
- *
- * @param options - Initialization options. Extends {@link LocalessClientOptions} with
- *   `components`, `fallbackComponent`, and `enableSync`.
- * @returns The initialized {@link LocalessClient} instance.
- *
- * @example
- * ```ts
- * import { localessInit } from '@localess/react';
- * import { Page, Header, Teaser } from '@/components';
- *
- * localessInit({
- *   origin: 'https://my-localess.web.app',
- *   spaceId: 'YOUR_SPACE_ID',
- *   token: 'YOUR_API_TOKEN',          // keep server-side only
- *   enableSync: process.env.NODE_ENV !== 'production',
- *   components: { page: Page, header: Header, teaser: Teaser },
- * });
- * ```
- */
-declare function localessInit(options: LocalessOptions): LocalessClient;
-/**
- * Returns the initialized {@link LocalessClient} instance.
- *
- * Throws an error if called before {@link localessInit}. Use this in server components,
- * API routes, or server-side data fetching functions to make API calls.
- *
- * @throws {Error} If `localessInit` has not been called yet.
- * @returns The active {@link LocalessClient}.
- *
- * @example
- * ```ts
- * const content = await getLocalessClient().getContentBySlug<MyPage>('home', { locale: 'en' });
- * ```
- */
-declare function getLocalessClient(): LocalessClient;
-/**
- * Adds a single component to the registry under the given schema key.
- *
- * The key must match the `_schema` field of the content objects you want to render.
- * Overwrites any previously registered component for the same key.
- *
- * @param key - The schema key (e.g. `'hero-section'`).
- * @param component - The React component to render for this schema key.
- */
-declare function registerComponent(key: string, component: React__default.ElementType): void;
-/**
- * Removes a component from the registry by schema key.
- * No-op if the key does not exist.
- *
- * @param key - The schema key to remove.
- */
-declare function unregisterComponent(key: string): void;
-/**
- * Replaces the entire component registry with the supplied map.
- *
- * Useful when you need to swap all components at once (e.g. lazy-loaded registry).
- * Any previously registered components (including those set via `localessInit`) are discarded.
- *
- * @param components - A record mapping schema keys to React components.
- */
-declare function setComponents(components: Record<string, React__default.ElementType>): void;
-/**
- * Looks up a React component by its schema key.
- *
- * Returns `undefined` and logs a console error when the key is not found.
- * Called internally by {@link LocalessComponent} and {@link LocalessServerComponent}.
- *
- * @param key - The schema key to look up (matches `content._schema`).
- * @returns The registered React component, or `undefined` if not found.
- */
-declare function getComponent(key: string): React__default.ElementType | undefined;
-/**
- * Sets the fallback component rendered when no registry match is found for a schema key.
- *
- * The fallback receives the same `data`, `links`, and `references` props as any
- * registered component, so it can render a generic placeholder or log the unknown schema.
- *
- * @param fallbackComponent - The React component to use as the fallback.
- */
-declare function setFallbackComponent(fallbackComponent: React__default.ElementType): void;
-/**
- * Returns the currently registered fallback component, or `undefined` if none is set.
- *
- * Called internally by {@link LocalessComponent} and {@link LocalessServerComponent}
- * when a schema key has no matching component in the registry.
- *
- * @returns The fallback React component, or `undefined`.
- */
-declare function getFallbackComponent(): React__default.ElementType | undefined;
-/**
- * Returns `true` when Visual Editor sync was enabled via `enableSync: true` in `localessInit`.
- *
- * Used internally by {@link LocalessComponent}, {@link LocalessDocument}, and {@link useLocaless}
- * to decide whether to inject editable attributes and subscribe to sync events.
- *
- * @returns `true` if sync is enabled, `false` otherwise.
- */
-declare function isSyncEnabled(): boolean;
-/**
- * Resolves a {@link ContentAsset} to its full URL string.
- *
- * Constructs the URL using the `origin` and `spaceId` from `localessInit`:
- * `{origin}/api/v1/spaces/{spaceId}/assets/{asset.uri}`
- *
- * @param asset - The asset reference object containing a `uri` field.
- * @returns The fully qualified asset URL string.
- *
- * @example
- * ```tsx
- * <img src={resolveAsset(data.heroImage)} alt={data.heroImage.alt} />
- * ```
- */
-declare function resolveAsset(asset: ContentAsset): string;
-
-/**
- * Resolves a {@link ContentLink} reference to a navigable URL string.
- *
- * Resolution rules by `link.type`:
- * - `'content'` — looks up `link.uri` in the `links` map and returns `'/' + fullSlug`.
- *   Returns `'/not-found'` when `links` is undefined or the URI is not in the map.
- * - `'url'`     — returns `link.uri` directly (external or absolute URL).
- * - anything else — returns `'no-type'` (indicates a misconfigured link field).
- *
- * @param links - The links map from `content.links` (keyed by link URI). May be `undefined`.
- * @param link  - The content link reference to resolve.
- * @returns A URL string ready to use in an `<a href>` or Next.js `<Link href>`.
- *
- * @example
- * ```tsx
- * import { findLink } from '@localess/react';
- *
- * function NavItem({ data, links }) {
- *   return <a href={findLink(links, data.url)}>{data.label}</a>;
- * }
- * ```
- */
-declare function findLink(links: Links | undefined, link: ContentLink): string;
-
-/**
- * Renders a Localess rich text field to a React node tree.
- *
- * Converts a {@link ContentRichText} value (TipTap ProseMirror document JSON) into
- * `React.ReactNode` using TipTap's static renderer. No browser APIs are required —
- * safe to call in React Server Components and SSR.
- *
- * Supported TipTap extensions: Document, Text, Paragraph, Heading (h1–h6), Bold,
- * Italic, Strike, Underline, History, ListItem, OrderedList, BulletList, Code,
- * CodeBlockLowlight, Link.
- *
- * @param content - The rich text value from a Localess content field (type `ContentRichText`).
- * @returns A `React.ReactNode` ready to render inside JSX.
- *
- * @example
- * ```tsx
- * import { renderRichTextToReact } from '@localess/react';
- *
- * export function Article({ data }: { data: MyContent }) {
- *   return <article>{renderRichTextToReact(data.body)}</article>;
- * }
- * ```
- */
-declare function renderRichTextToReact(content: ContentRichText): React__default.ReactNode;
-
-export { type LocalessOptions as L, getFallbackComponent as a, getLocalessClient as b, renderRichTextToReact as c, resolveAsset as d, setFallbackComponent as e, findLink as f, getComponent as g, isSyncEnabled as i, localessInit as l, registerComponent as r, setComponents as s, unregisterComponent as u };