@veltdev/tiptap-velt-comments/esm/constants/common.d.ts

Tiptap Extension to add Google Docs-style overlay comments to your Tiptap editor. Works with the Velt Collaboration SDK.

/**
 * Shared constants used throughout the codebase.
 * Extracted from legacy constants.ts for better organization.
 */
export declare const Constants: {
    readonly ATTRIBUTES: {
        readonly EDITOR_ID: "data-editor-id";
        readonly LOCATION_ID: "data-velt-location-id";
        readonly ANNOTATION_ID: "annotation-id";
        readonly MULTI_THREAD_ANNOTATION_ID: "multi-thread-annotation-id";
    };
    /**
     * Mark/extension name constant.
     * Generic constant name, value is Tiptap-specific for this package.
     */
    readonly MARK_NAME: "tiptapVeltComments";
    /**
     * Storage key constant.
     * Generic constant name, value is Tiptap-specific for this package.
     */
    readonly STORAGE_KEY: "tiptapVeltComments";
    /**
     * Default editor ID used when no explicit editor ID is provided.
     * Uses double-underscore convention to avoid collision with user-provided values.
     */
    readonly DEFAULT_EDITOR_ID: "__default__";
    /**
     * HTML tag name for comment elements.
     */
    readonly TAG_NAME: "velt-comment-text";
    /**
     * Default extension name for error messages.
     */
    readonly DEFAULT_EXTENSION_NAME: "VeltComments";
    /**
     * Terminal status type for resolved/closed comments.
     */
    readonly STATUS_TERMINAL: "terminal";
    /**
     * Log prefix for console messages.
     */
    readonly LOG_PREFIX: "TiptapVeltComments: ";
    /**
     * Session storage key for debug mode.
     */
    readonly DEBUG_MODE_KEY: "debugMode";
    /**
     * Session storage key for forced debug mode.
     */
    readonly FORCE_DEBUG_MODE_KEY: "forceDebugMode";
};