@veltdev/react 1.0.68 → 1.0.70

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,8 @@
1
+ import { RecorderElement } from "@veltdev/types";
1
2
  /**
2
3
  * @beta This hook is in beta
3
4
  */
4
- export declare function useRecorderUtils(): any | undefined;
5
+ export declare function useRecorderUtils(): RecorderElement | undefined;
5
6
  /**
6
7
  * @beta This hook is in beta
7
8
  */
@@ -1,4 +1,5 @@
1
+ import { RewriterElement } from "@veltdev/types";
1
2
  /**
2
3
  * @beta This hook is in beta
3
4
  */
4
- export declare function useAIRewriterUtils(): any | undefined;
5
+ export declare function useAIRewriterUtils(): RewriterElement | undefined;
@@ -1,4 +1,5 @@
1
+ import { SelectionElement } from "@veltdev/types";
1
2
  /**
2
3
  * @beta This hook is in beta
3
4
  */
4
- export declare function useLiveSelectionUtils(): any | undefined;
5
+ export declare function useLiveSelectionUtils(): SelectionElement | undefined;
@@ -1,9 +1,9 @@
1
- import { Location } from "@veltdev/types";
1
+ import { Location, TagAnnotation, TagElement } from "@veltdev/types";
2
2
  /**
3
3
  * @beta This hook is in beta
4
4
  */
5
- export declare function useTagUtils(): any | undefined;
5
+ export declare function useTagUtils(): TagElement | undefined;
6
6
  /**
7
7
  * @beta This hook is in beta
8
8
  */
9
- export declare function useTagAnnotations(documentId?: string, location?: Location): any;
9
+ export declare function useTagAnnotations(documentId?: string, location?: Location): TagAnnotation[] | null;
@@ -2,7 +2,7 @@ export { useAddLocation, useSetLocation, useSetDocumentId, useIdentify, useClien
2
2
  export { useCommentUtils, useCommentAnnotations, useCommentAddHandler, useCommentModeState, useCommentUpdateHandler, useCommentDialogSidebarClickHandler, } from './CommentElement';
3
3
  export { useCursorUtils, useCursorUsers, } from './CursorElement';
4
4
  export { useHuddleUtils, } from './HuddleElement';
5
- export { useLiveStateSyncUtils, useLiveStateData, useSetLiveStateData, useUserEditorState, useEditor, useEditorAccessRequestHandler, } from './LiveStateSyncElement';
5
+ export { useLiveStateSyncUtils, useLiveStateData, useSetLiveStateData, useUserEditorState, useEditor, useEditorAccessRequestHandler, useLiveState, } from './LiveStateSyncElement';
6
6
  export { usePresenceUtils, usePresenceUsers, } from './PresenceElement';
7
7
  export { useRecorderUtils, useRecorderAddHandler, } from './RecorderElement';
8
8
  export { useAIRewriterUtils, } from './RewriterElement';
package/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  import React from 'react';
3
- import { Config, Velt, User, UserOptions, Location as Location$1 } from '@veltdev/types';
3
+ import { Config, Velt, User, UserOptions, Location as Location$1, CommentElement, CommentAnnotation, CursorElement, CursorUser, LiveStateSyncElement, UserEditorAccess, PresenceElement, PresenceUser, RecorderElement, RewriterElement, SelectionElement, TagElement, TagAnnotation } from '@veltdev/types';
4
4
 
5
5
  interface IVeltProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
6
6
  apiKey: string;
@@ -318,15 +318,15 @@ declare function useAddLocation(location: Location$1): void;
318
318
  /**
319
319
  * @beta This hook is in beta
320
320
  */
321
- declare function useCommentUtils(): any;
321
+ declare function useCommentUtils(): CommentElement | undefined;
322
322
  /**
323
323
  * @beta This hook is in beta
324
324
  */
325
- declare function useCommentAnnotations(documentId?: string, location?: Location$1): any;
325
+ declare function useCommentAnnotations(documentId?: string, location?: Location$1): CommentAnnotation[] | null;
326
326
  /**
327
327
  * @beta This hook is in beta
328
328
  */
329
- declare function useCommentModeState(): any;
329
+ declare function useCommentModeState(): boolean | undefined;
330
330
  /**
331
331
  * @beta This hook is in beta
332
332
  */
@@ -343,11 +343,11 @@ declare function useCommentDialogSidebarClickHandler(): any;
343
343
  /**
344
344
  * @beta This hook is in beta
345
345
  */
346
- declare function useCursorUtils(): any | undefined;
346
+ declare function useCursorUtils(): CursorElement | undefined;
347
347
  /**
348
348
  * @beta This hook is in beta
349
349
  */
350
- declare function useCursorUsers(): any;
350
+ declare function useCursorUsers(): CursorUser[] | null;
351
351
 
352
352
  /**
353
353
  * @beta This hook is in beta
@@ -357,7 +357,7 @@ declare function useHuddleUtils(): any | undefined;
357
357
  /**
358
358
  * @beta This hook is in beta
359
359
  */
360
- declare function useLiveStateSyncUtils(): any | undefined;
360
+ declare function useLiveStateSyncUtils(): LiveStateSyncElement | undefined;
361
361
  /**
362
362
  * @beta This hook is in beta
363
363
  */
@@ -369,29 +369,36 @@ declare function useSetLiveStateData(liveStateDataId: string, liveStateData: any
369
369
  /**
370
370
  * @beta This hook is in beta
371
371
  */
372
- declare function useUserEditorState(): any;
372
+ declare function useUserEditorState(): UserEditorAccess | null;
373
373
  /**
374
374
  * @beta This hook is in beta
375
375
  */
376
- declare function useEditor(): any;
376
+ declare function useEditor(): User | null;
377
377
  /**
378
378
  * @beta This hook is in beta
379
379
  */
380
- declare function useEditorAccessRequestHandler(): any;
380
+ declare function useEditorAccessRequestHandler(): {
381
+ requestStatus: string;
382
+ requestedBy: User;
383
+ } | null;
384
+ /**
385
+ * @beta This hook is in beta
386
+ */
387
+ declare function useLiveState<T>(liveStateDataId: string, initialValue?: any, debounceTime?: number): [T, (value: T) => void];
381
388
 
382
389
  /**
383
390
  * @beta This hook is in beta
384
391
  */
385
- declare function usePresenceUtils(): any | undefined;
392
+ declare function usePresenceUtils(): PresenceElement | undefined;
386
393
  /**
387
394
  * @beta This hook is in beta
388
395
  */
389
- declare function usePresenceUsers(): any;
396
+ declare function usePresenceUsers(): PresenceUser[] | null;
390
397
 
391
398
  /**
392
399
  * @beta This hook is in beta
393
400
  */
394
- declare function useRecorderUtils(): any | undefined;
401
+ declare function useRecorderUtils(): RecorderElement | undefined;
395
402
  /**
396
403
  * @beta This hook is in beta
397
404
  */
@@ -400,20 +407,20 @@ declare function useRecorderAddHandler(): any;
400
407
  /**
401
408
  * @beta This hook is in beta
402
409
  */
403
- declare function useAIRewriterUtils(): any | undefined;
410
+ declare function useAIRewriterUtils(): RewriterElement | undefined;
404
411
 
405
412
  /**
406
413
  * @beta This hook is in beta
407
414
  */
408
- declare function useLiveSelectionUtils(): any | undefined;
415
+ declare function useLiveSelectionUtils(): SelectionElement | undefined;
409
416
 
410
417
  /**
411
418
  * @beta This hook is in beta
412
419
  */
413
- declare function useTagUtils(): any | undefined;
420
+ declare function useTagUtils(): TagElement | undefined;
414
421
  /**
415
422
  * @beta This hook is in beta
416
423
  */
417
- declare function useTagAnnotations(documentId?: string, location?: Location$1): any;
424
+ declare function useTagAnnotations(documentId?: string, location?: Location$1): TagAnnotation[] | null;
418
425
 
419
- export { SnippylyArrowTool as VeltArrowTool, SnippylyArrows as VeltArrows, SnippylyCommentBubble as VeltCommentBubble, VeltCommentPlayerTimeline, 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, VeltVideoPlayer, useAIRewriterUtils, useAddLocation, useClient, useCommentAddHandler, useCommentAnnotations, useCommentDialogSidebarClickHandler, useCommentModeState, useCommentUpdateHandler, useCommentUtils, useCursorUsers, useCursorUtils, useEditor, useEditorAccessRequestHandler, useHuddleUtils, useIdentify, useLiveSelectionUtils, useLiveStateData, useLiveStateSyncUtils, usePresenceUsers, usePresenceUtils, useRecorderAddHandler, useRecorderUtils, useSetDocumentId, useSetLiveStateData, useSetLocation, useTagAnnotations, useTagUtils, useUserEditorState, useVeltClient };
426
+ export { SnippylyArrowTool as VeltArrowTool, SnippylyArrows as VeltArrows, SnippylyCommentBubble as VeltCommentBubble, VeltCommentPlayerTimeline, 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, VeltVideoPlayer, useAIRewriterUtils, useAddLocation, useClient, useCommentAddHandler, useCommentAnnotations, useCommentDialogSidebarClickHandler, useCommentModeState, useCommentUpdateHandler, useCommentUtils, useCursorUsers, useCursorUtils, useEditor, useEditorAccessRequestHandler, useHuddleUtils, useIdentify, useLiveSelectionUtils, useLiveState, useLiveStateData, useLiveStateSyncUtils, usePresenceUsers, usePresenceUtils, useRecorderAddHandler, useRecorderUtils, useSetDocumentId, useSetLiveStateData, useSetLocation, useTagAnnotations, useTagUtils, useUserEditorState, useVeltClient };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/react",
3
- "version": "1.0.68",
3
+ "version": "1.0.70",
4
4
  "description": "",
5
5
  "scripts": {
6
6
  "test": "echo \"Error: no test specified\" && exit 1",