@veltdev/react 1.0.1

package/index.d.ts

@@ -0,0 +1,295 @@
+/// <reference types="react" />
+import React from 'react';
+import { Config, Snippyly } from '@snippyly/types';
+
+interface IVeltProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    apiKey: string;
+    config?: Config;
+    user?: any;
+    documentId?: string;
+    onClientLoad?: (snippylyClient?: Snippyly) => any;
+}
+declare const SnippylyProvider: React.FC<IVeltProps>;
+
+interface IVeltCommentBubbleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    targetCommentElementId?: string;
+    /**
+     * @deprecated Use `avatar` instead
+     */
+    showAvatar?: boolean;
+    avatar?: boolean;
+    commentBubbleTargetPinHover?: boolean;
+}
+declare const SnippylyCommentBubble: React.FC<IVeltCommentBubbleProps>;
+
+interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    streamViewContainerId?: string;
+    /**
+     * @deprecated
+     */
+    pinHighlighterClass?: string;
+    /**
+     * @deprecated
+     */
+    textHighlighterClass?: string;
+    autoCategorize?: boolean;
+    /**
+     * @deprecated Use `onSignIn` instead
+     */
+    signIn?: Function;
+    onSignIn?: Function;
+    textMode?: boolean;
+    popoverMode?: boolean;
+    /**
+     * @deprecated Use `floatingMode` instead
+     */
+    floatingCommentsMode?: boolean;
+    floatingMode?: boolean;
+    moderatorMode?: boolean;
+    streamMode?: boolean;
+    signInButton?: boolean;
+    /**
+     * @deprecated Use `attachments` instead
+     */
+    allowAttachments?: boolean;
+    attachments?: boolean;
+    /**
+     * @deprecated Use `deviceInfo` instead
+     */
+    showDeviceInfo?: boolean;
+    deviceInfo?: boolean;
+    /**
+     * @deprecated Use `commentIndex` instead
+     */
+    showCommentIndex?: boolean;
+    commentIndex?: boolean;
+    dialogOnHover?: boolean;
+    dialogOnTargetElementClick?: boolean;
+    /**
+     * @deprecated Use `priority` instead
+     */
+    showPriority?: boolean;
+    priority?: boolean;
+    /**
+     * @deprecated Use `status` instead
+     */
+    showStatus?: boolean;
+    status?: boolean;
+    /**
+     * @deprecated Use `resolveButton` instead
+     */
+    showResolveButton?: boolean;
+    resolveButton?: boolean;
+    inboxMode?: boolean;
+    suggestionMode?: boolean;
+    ghostComments?: boolean;
+    /**
+     * @deprecated Use `ghostCommentsIndicator` instead
+     */
+    ghostCommentsMessage?: boolean;
+    ghostCommentsIndicator?: boolean;
+    allowedElementIds?: string[];
+    commentAdded?: Function;
+    onCustomPinInject?: Function;
+    onCommentUpdate?: Function;
+    /**
+     * @deprecated Use `onCommentAccept` instead
+     */
+    commentAccepted?: Function;
+    onCommentAccept?: Function;
+    /**
+     * @deprecated Use `onCommentReject` instead
+     */
+    commentRejected?: Function;
+    onCommentReject?: Function;
+    /**
+     * @deprecated Use `customStatus` instead
+     */
+    customStatuses?: {
+        id: string;
+        color: string;
+        name: string;
+        type: 'default' | 'ongoing' | 'terminal';
+        lightColor?: string;
+        svg?: string;
+        iconUrl?: string;
+    }[];
+    customStatus?: {
+        id: string;
+        color: string;
+        name: string;
+        type: 'default' | 'ongoing' | 'terminal';
+        lightColor?: string;
+        svg?: string;
+        iconUrl?: string;
+    }[];
+    /**
+     * @deprecated Use `customPriority` instead
+     */
+    customPriorities?: {
+        id: string;
+        color: string;
+        name: string;
+        lightColor?: string;
+    }[];
+    customPriority?: {
+        id: string;
+        color: string;
+        name: string;
+        lightColor?: string;
+    }[];
+    /**
+     * @deprecated Use `customCategory` instead
+     */
+    customCategories?: {
+        id: string;
+        color: string;
+        name: string;
+    }[];
+    customCategory?: {
+        id: string;
+        color: string;
+        name: string;
+    }[];
+    darkMode?: boolean;
+}
+declare const SnippylyComments: React.FC<IVeltCommentsProps>;
+
+interface IVeltCommentsSidebarProps {
+    embedMode?: boolean;
+    /**
+     * @deprecated Use `urlNavigation` instead
+     */
+    enableUrlNavigation?: boolean;
+    urlNavigation?: boolean;
+    /**
+     * @deprecated Use `onSidebarOpen` instead
+     */
+    openSidebar?: Function;
+    onSidebarOpen?: Function;
+    onSidebarCommentClick?: Function;
+}
+declare const SnippylyCommentsSidebar: React.FC<IVeltCommentsSidebarProps>;
+
+interface IVeltCommentToolProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    targetCommentElementId?: string;
+}
+declare const SnippylyCommentTool: React.FC<IVeltCommentToolProps>;
+
+interface IVeltCursorProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    avatarMode?: boolean;
+    inactivityTime?: number;
+    allowedElementIds?: string;
+    /**
+     * @deprecated Use `onCursorUserChange` instead
+     */
+    onCursorUsersChanged?: Function;
+    onCursorUserChange?: Function;
+}
+declare const SnippylyCursor: React.FC<IVeltCursorProps>;
+
+interface IVeltHuddleProps {
+}
+declare const SnippylyHuddle: React.FC<IVeltHuddleProps>;
+
+interface IVeltHuddleToolProps {
+    type?: string;
+}
+declare const SnippylyHuddleTool: React.FC<IVeltHuddleToolProps>;
+
+interface IVeltPresenceProps {
+    maxUsers?: number;
+    inactivityTime?: number;
+    documentParams?: any;
+    location?: any;
+    /**
+     * @deprecated Use `onPresenceUserChange` instead
+     */
+    onUsersChanged?: Function;
+    onPresenceUserChange?: Function;
+    flockMode?: boolean;
+    /**
+     * @deprecated Use `defaultFlockNavigation` instead
+     */
+    disableFlockNavigation?: boolean;
+    defaultFlockNavigation?: boolean;
+    onNavigate?: (pageInfo: {
+        path: string;
+        url: string;
+        baseUrl: string;
+    }) => void;
+}
+declare const SnippylyPresence: React.FC<IVeltPresenceProps>;
+
+interface IVeltRecorderControlPanelProps {
+    mode?: string;
+    panelId?: string;
+    onRecordedData?: Function;
+}
+declare const SnippylyRecorderControlPanel: React.FC<IVeltRecorderControlPanelProps>;
+
+interface IVeltRecorderNotesProps {
+}
+declare const SnippylyRecorderNotes: React.FC<IVeltRecorderNotesProps>;
+
+interface IVeltRecorderPlayerProps {
+    recorderId?: string;
+    onDelete?: Function;
+    /**
+     * @deprecated Use `summary` instead.
+     */
+    showSummary?: boolean;
+    summary?: boolean;
+}
+declare const SnippylyRecorderPlayer: React.FC<IVeltRecorderPlayerProps>;
+
+interface IVeltRecorderToolProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    type?: string;
+    panelId?: string;
+    buttonLabel?: string;
+}
+declare const SnippylyRecorderTool: React.FC<IVeltRecorderToolProps>;
+
+interface IVeltSidebarButtonProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    tooltipText?: string;
+}
+declare const SnippylySidebarButton: React.FC<IVeltSidebarButtonProps>;
+
+interface IVeltTagsProps {
+    pinHighlighterClass?: string;
+}
+declare const SnippylyTags: React.FC<IVeltTagsProps>;
+
+interface IVeltTagToolProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    targetTagElementId?: string;
+}
+declare const SnippylyTagTool: React.FC<IVeltTagToolProps>;
+
+declare const SnippylyArrows: React.FC<any>;
+
+declare const SnippylyArrowTool: React.FC<any>;
+
+interface IVeltUserInviteToolProps {
+    type?: string;
+    source?: string;
+    title?: string;
+    placeholder?: string;
+    accessControlDropdown?: boolean;
+}
+declare const SnippylyUserInviteTool: React.FC<IVeltUserInviteToolProps>;
+
+interface IVeltUserRequestToolProps {
+    /**
+     * Allowed values: 'feedback', 'reportBug', 'contactUs'
+     *
+     * Default value: 'feedback'
+     */
+    type?: string;
+}
+declare const SnippylyUserRequestTool: React.FC<IVeltUserRequestToolProps>;
+
+declare function useVeltClient(): {
+    client: Snippyly;
+};
+
+export { SnippylyArrowTool as VeltArrowTool, SnippylyArrows as VeltArrows, SnippylyCommentBubble as VeltCommentBubble, SnippylyCommentTool as VeltCommentTool, SnippylyComments as VeltComments, SnippylyCommentsSidebar as VeltCommentsSidebar, SnippylyCursor as VeltCursor, SnippylyHuddle as VeltHuddle, SnippylyHuddleTool as VeltHuddleTool, SnippylyPresence as VeltPresence, SnippylyProvider as VeltProvider, SnippylyRecorderControlPanel as VeltRecorderControlPanel, SnippylyRecorderNotes as VeltRecorderNotes, SnippylyRecorderPlayer as VeltRecorderPlayer, SnippylyRecorderTool as VeltRecorderTool, SnippylySidebarButton as VeltSidebarButton, SnippylyTagTool as VeltTagTool, SnippylyTags as VeltTags, SnippylyUserInviteTool as VeltUserInviteTool, SnippylyUserRequestTool as VeltUserRequestTool, useVeltClient };

package/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "@veltdev/react",
+    "version": "1.0.1",
+    "description": "",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "version:update": "npm version patch",
+        "publish:sdk-react": "npm publish --access public"
+    },
+    "author": "",
+    "license": "ISC",
+    "main": "cjs/index.js",
+    "module": "esm/index.js",
+    "types": "index.d.ts",
+    "peerDependencies": {
+        "react": "^18.0.0 || ^17.0.0 || ^16.0.0",
+        "react-dom": "^18.0.0 || ^17.0.0 || ^16.0.0"
+    }
+}