@veltdev/types/app/utils/page-info-store.d.ts

Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.

import type { PageInfo } from "../models/data/page-info.model";
/**
 * Register a resolver that returns the current client document id.
 * Used to pick the right per-document override when no explicit document id is passed.
 */
export declare const registerCurrentClientDocumentIdGetter: (getter: () => string | number | undefined | null) => void;
/**
 * Set client-provided page info.
 * @param pageInfo page info provided by the client
 * @param documentId optional client document id; when omitted, sets the global override
 */
export declare const setClientPageInfo: (pageInfo: Partial<PageInfo> | undefined | null, documentId?: string | number) => void;
/**
 * Clear client-provided page info.
 * @param documentId optional client document id; when omitted, clears the global override
 */
export declare const clearClientPageInfo: (documentId?: string | number) => void;
/**
 * Get the client-provided page info that applies for the given (or current) document.
 * Per-document override wins; otherwise falls back to the global override.
 * @param documentId optional client document id; when omitted, resolves the current document
 * @returns client page info, or undefined when the client has not provided any
 */
export declare const getClientPageInfo: (documentId?: string | number) => Partial<PageInfo> | undefined;
/**
 * Reset all client page info and the registered document-id resolver.
 * Intended for tests.
 */
export declare const resetClientPageInfo: () => void;