@veltdev/react 1.0.120 → 1.0.121

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.
Files changed (34) hide show
  1. package/cjs/index.js +2 -123
  2. package/cjs/index.js.map +1 -1
  3. package/cjs/types/hooks/AutocompleteElement.d.ts +0 -6
  4. package/cjs/types/hooks/Client.d.ts +1 -20
  5. package/cjs/types/hooks/CommentElement.d.ts +0 -18
  6. package/cjs/types/hooks/CursorElement.d.ts +0 -6
  7. package/cjs/types/hooks/HuddleElement.d.ts +0 -3
  8. package/cjs/types/hooks/LiveStateSyncElement.d.ts +0 -24
  9. package/cjs/types/hooks/NotificationElement.d.ts +0 -6
  10. package/cjs/types/hooks/PresenceElement.d.ts +0 -6
  11. package/cjs/types/hooks/RecorderElement.d.ts +0 -6
  12. package/cjs/types/hooks/RewriterElement.d.ts +0 -3
  13. package/cjs/types/hooks/SelectionElement.d.ts +0 -3
  14. package/cjs/types/hooks/TagElement.d.ts +0 -6
  15. package/cjs/types/hooks/ViewsElement.d.ts +0 -9
  16. package/cjs/types/hooks/index.d.ts +1 -1
  17. package/esm/index.js +3 -123
  18. package/esm/index.js.map +1 -1
  19. package/esm/types/hooks/AutocompleteElement.d.ts +0 -6
  20. package/esm/types/hooks/Client.d.ts +1 -20
  21. package/esm/types/hooks/CommentElement.d.ts +0 -18
  22. package/esm/types/hooks/CursorElement.d.ts +0 -6
  23. package/esm/types/hooks/HuddleElement.d.ts +0 -3
  24. package/esm/types/hooks/LiveStateSyncElement.d.ts +0 -24
  25. package/esm/types/hooks/NotificationElement.d.ts +0 -6
  26. package/esm/types/hooks/PresenceElement.d.ts +0 -6
  27. package/esm/types/hooks/RecorderElement.d.ts +0 -6
  28. package/esm/types/hooks/RewriterElement.d.ts +0 -3
  29. package/esm/types/hooks/SelectionElement.d.ts +0 -3
  30. package/esm/types/hooks/TagElement.d.ts +0 -6
  31. package/esm/types/hooks/ViewsElement.d.ts +0 -9
  32. package/esm/types/hooks/index.d.ts +1 -1
  33. package/index.d.ts +3 -118
  34. package/package.json +1 -1
package/cjs/index.js CHANGED
@@ -1696,9 +1696,6 @@ var VeltCommentBubbleCommentsCount = function (props) {
1696
1696
  return (React__default["default"].createElement("velt-comment-bubble-comments-count-wireframe", null, children));
1697
1697
  };
1698
1698
 
1699
- /**
1700
- * @beta This hook is in beta
1701
- */
1702
1699
  function useClient() {
1703
1700
  var client = useVeltClient().client;
1704
1701
  var _a = React__default["default"].useState(), veltClient = _a[0], setVeltClient = _a[1];
@@ -1709,55 +1706,31 @@ function useClient() {
1709
1706
  }, [client, setVeltClient, veltClient]);
1710
1707
  return veltClient;
1711
1708
  }
1712
- /**
1713
- * @beta This hook is in beta
1714
- */
1715
1709
  function useIdentify(user, userOptions) {
1716
1710
  var client = useVeltClient().client;
1717
1711
  React__default["default"].useEffect(function () {
1718
1712
  client && client.identify(user, userOptions);
1719
1713
  }, [client]);
1720
1714
  }
1721
- /**
1722
- * @beta This hook is in beta
1723
- */
1724
1715
  function useSetDocumentId(documentId) {
1725
1716
  var client = useVeltClient().client;
1726
1717
  React__default["default"].useEffect(function () {
1727
1718
  client && client.setDocumentId(documentId);
1728
1719
  }, [client]);
1729
1720
  }
1730
- /**
1731
- * @beta This hook is in beta
1732
- */
1733
1721
  function useUnsetDocumentId() {
1734
1722
  var client = useVeltClient().client;
1735
1723
  React__default["default"].useEffect(function () {
1736
1724
  client && client.unsetDocumentId && client.unsetDocumentId();
1737
1725
  }, [client]);
1738
1726
  }
1739
- /**
1740
- * @beta This hook is in beta
1741
- */
1742
- function useSetLocation(location) {
1727
+ function useSetLocation(location, appendLocation) {
1743
1728
  var client = useVeltClient().client;
1744
1729
  React__default["default"].useEffect(function () {
1745
- client && client.setLocation(location);
1746
- }, [client]);
1747
- }
1748
- /**
1749
- * @beta This hook is in beta
1750
- */
1751
- function useAddLocation(location) {
1752
- var client = useVeltClient().client;
1753
- React__default["default"].useEffect(function () {
1754
- client && client.addLocation(location);
1730
+ client && client.setLocation(location, appendLocation);
1755
1731
  }, [client]);
1756
1732
  }
1757
1733
 
1758
- /**
1759
- * @beta This hook is in beta
1760
- */
1761
1734
  function useCommentUtils() {
1762
1735
  var _a = React__default["default"].useState(), commentElement = _a[0], setCommentElement = _a[1];
1763
1736
  var client = useVeltClient().client;
@@ -1769,9 +1742,6 @@ function useCommentUtils() {
1769
1742
  }, [client, setCommentElement, commentElement]);
1770
1743
  return commentElement;
1771
1744
  }
1772
- /**
1773
- * @beta This hook is in beta
1774
- */
1775
1745
  function useCommentAnnotations(documentId, location) {
1776
1746
  var commentElement = useCommentUtils();
1777
1747
  var _a = React__default["default"].useState([]), data = _a[0], setData = _a[1];
@@ -1787,9 +1757,6 @@ function useCommentAnnotations(documentId, location) {
1787
1757
  }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getAllCommentAnnotations]);
1788
1758
  return data;
1789
1759
  }
1790
- /**
1791
- * @beta This hook is in beta
1792
- */
1793
1760
  function useCommentModeState() {
1794
1761
  var commentElement = useCommentUtils();
1795
1762
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -1805,9 +1772,6 @@ function useCommentModeState() {
1805
1772
  }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentModeChange]);
1806
1773
  return data;
1807
1774
  }
1808
- /**
1809
- * @beta This hook is in beta
1810
- */
1811
1775
  function useCommentAddHandler() {
1812
1776
  var commentElement = useCommentUtils();
1813
1777
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -1823,9 +1787,6 @@ function useCommentAddHandler() {
1823
1787
  }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentAdd]);
1824
1788
  return data;
1825
1789
  }
1826
- /**
1827
- * @beta This hook is in beta
1828
- */
1829
1790
  function useCommentUpdateHandler() {
1830
1791
  var commentElement = useCommentUtils();
1831
1792
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -1841,9 +1802,6 @@ function useCommentUpdateHandler() {
1841
1802
  }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentUpdate]);
1842
1803
  return data;
1843
1804
  }
1844
- /**
1845
- * @beta This hook is in beta
1846
- */
1847
1805
  function useCommentDialogSidebarClickHandler() {
1848
1806
  var commentElement = useCommentUtils();
1849
1807
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -1860,9 +1818,6 @@ function useCommentDialogSidebarClickHandler() {
1860
1818
  return data;
1861
1819
  }
1862
1820
 
1863
- /**
1864
- * @beta This hook is in beta
1865
- */
1866
1821
  function useCursorUtils() {
1867
1822
  var _a = React__default["default"].useState(), cursorElement = _a[0], setCursorElement = _a[1];
1868
1823
  var client = useVeltClient().client;
@@ -1874,9 +1829,6 @@ function useCursorUtils() {
1874
1829
  }, [client, setCursorElement, cursorElement]);
1875
1830
  return cursorElement;
1876
1831
  }
1877
- /**
1878
- * @beta This hook is in beta
1879
- */
1880
1832
  function useCursorUsers() {
1881
1833
  var cursorElement = useCursorUtils();
1882
1834
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -1893,9 +1845,6 @@ function useCursorUsers() {
1893
1845
  return data;
1894
1846
  }
1895
1847
 
1896
- /**
1897
- * @beta This hook is in beta
1898
- */
1899
1848
  function useHuddleUtils() {
1900
1849
  var _a = React__default["default"].useState(), huddleElement = _a[0], setHuddleElement = _a[1];
1901
1850
  var client = useVeltClient().client;
@@ -1908,9 +1857,6 @@ function useHuddleUtils() {
1908
1857
  return huddleElement;
1909
1858
  }
1910
1859
 
1911
- /**
1912
- * @beta This hook is in beta
1913
- */
1914
1860
  function useLiveStateSyncUtils() {
1915
1861
  var _a = React__default["default"].useState(), liveStateSyncElement = _a[0], setLiveStateSyncElement = _a[1];
1916
1862
  var client = useVeltClient().client;
@@ -1922,9 +1868,6 @@ function useLiveStateSyncUtils() {
1922
1868
  }, [client, setLiveStateSyncElement, liveStateSyncElement]);
1923
1869
  return liveStateSyncElement;
1924
1870
  }
1925
- /**
1926
- * @beta This hook is in beta
1927
- */
1928
1871
  function useLiveStateData(liveStateDataId) {
1929
1872
  var liveStateSyncElement = useLiveStateSyncUtils();
1930
1873
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -1940,9 +1883,6 @@ function useLiveStateData(liveStateDataId) {
1940
1883
  }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.getLiveStateData]);
1941
1884
  return data;
1942
1885
  }
1943
- /**
1944
- * @beta This hook is in beta
1945
- */
1946
1886
  function useSetLiveStateData(liveStateDataId, liveStateData) {
1947
1887
  var liveStateSyncElement = useLiveStateSyncUtils();
1948
1888
  React__default["default"].useEffect(function () {
@@ -1951,9 +1891,6 @@ function useSetLiveStateData(liveStateDataId, liveStateData) {
1951
1891
  }
1952
1892
  }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.setLiveStateData]);
1953
1893
  }
1954
- /**
1955
- * @beta This hook is in beta
1956
- */
1957
1894
  function useUserEditorState() {
1958
1895
  var liveStateSyncElement = useLiveStateSyncUtils();
1959
1896
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -1969,9 +1906,6 @@ function useUserEditorState() {
1969
1906
  }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isUserEditor]);
1970
1907
  return data;
1971
1908
  }
1972
- /**
1973
- * @beta This hook is in beta
1974
- */
1975
1909
  function useEditor() {
1976
1910
  var liveStateSyncElement = useLiveStateSyncUtils();
1977
1911
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -1987,9 +1921,6 @@ function useEditor() {
1987
1921
  }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.getEditor]);
1988
1922
  return data;
1989
1923
  }
1990
- /**
1991
- * @beta This hook is in beta
1992
- */
1993
1924
  function useEditorAccessTimer() {
1994
1925
  var liveStateSyncElement = useLiveStateSyncUtils();
1995
1926
  var _a = React__default["default"].useState({ state: 'idle' }), data = _a[0], setData = _a[1];
@@ -2005,9 +1936,6 @@ function useEditorAccessTimer() {
2005
1936
  }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.getEditorAccessTimer]);
2006
1937
  return data;
2007
1938
  }
2008
- /**
2009
- * @beta This hook is in beta
2010
- */
2011
1939
  function useEditorAccessRequestHandler() {
2012
1940
  var liveStateSyncElement = useLiveStateSyncUtils();
2013
1941
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -2023,9 +1951,6 @@ function useEditorAccessRequestHandler() {
2023
1951
  }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isEditorAccessRequested]);
2024
1952
  return data;
2025
1953
  }
2026
- /**
2027
- * @beta This hook is in beta
2028
- */
2029
1954
  function useLiveState(liveStateDataId, initialValue, options) {
2030
1955
  var liveStateSyncElement = useLiveStateSyncUtils();
2031
1956
  var client = useVeltClient().client;
@@ -2095,9 +2020,6 @@ function useLiveState(liveStateDataId, initialValue, options) {
2095
2020
  return [data, setDataFunction];
2096
2021
  }
2097
2022
 
2098
- /**
2099
- * @beta This hook is in beta
2100
- */
2101
2023
  function usePresenceUtils() {
2102
2024
  var _a = React__default["default"].useState(), presenceElement = _a[0], setPresenceElement = _a[1];
2103
2025
  var client = useVeltClient().client;
@@ -2109,9 +2031,6 @@ function usePresenceUtils() {
2109
2031
  }, [client, setPresenceElement, presenceElement]);
2110
2032
  return presenceElement;
2111
2033
  }
2112
- /**
2113
- * @beta This hook is in beta
2114
- */
2115
2034
  function usePresenceUsers() {
2116
2035
  var presenceElement = usePresenceUtils();
2117
2036
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -2128,9 +2047,6 @@ function usePresenceUsers() {
2128
2047
  return data;
2129
2048
  }
2130
2049
 
2131
- /**
2132
- * @beta This hook is in beta
2133
- */
2134
2050
  function useRecorderUtils() {
2135
2051
  var _a = React__default["default"].useState(), recorderElement = _a[0], setRecorderElement = _a[1];
2136
2052
  var client = useVeltClient().client;
@@ -2142,9 +2058,6 @@ function useRecorderUtils() {
2142
2058
  }, [client, setRecorderElement, recorderElement]);
2143
2059
  return recorderElement;
2144
2060
  }
2145
- /**
2146
- * @beta This hook is in beta
2147
- */
2148
2061
  function useRecorderAddHandler() {
2149
2062
  var recorderElement = useRecorderUtils();
2150
2063
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -2161,9 +2074,6 @@ function useRecorderAddHandler() {
2161
2074
  return data;
2162
2075
  }
2163
2076
 
2164
- /**
2165
- * @beta This hook is in beta
2166
- */
2167
2077
  function useAIRewriterUtils() {
2168
2078
  var _a = React__default["default"].useState(), rewriterElement = _a[0], setRewriterElement = _a[1];
2169
2079
  var client = useVeltClient().client;
@@ -2176,9 +2086,6 @@ function useAIRewriterUtils() {
2176
2086
  return rewriterElement;
2177
2087
  }
2178
2088
 
2179
- /**
2180
- * @beta This hook is in beta
2181
- */
2182
2089
  function useLiveSelectionUtils() {
2183
2090
  var _a = React__default["default"].useState(), selectionElement = _a[0], setSelectionElement = _a[1];
2184
2091
  var client = useVeltClient().client;
@@ -2191,9 +2098,6 @@ function useLiveSelectionUtils() {
2191
2098
  return selectionElement;
2192
2099
  }
2193
2100
 
2194
- /**
2195
- * @beta This hook is in beta
2196
- */
2197
2101
  function useTagUtils() {
2198
2102
  var _a = React__default["default"].useState(), tagElement = _a[0], setTagElement = _a[1];
2199
2103
  var client = useVeltClient().client;
@@ -2205,9 +2109,6 @@ function useTagUtils() {
2205
2109
  }, [client, setTagElement, tagElement]);
2206
2110
  return tagElement;
2207
2111
  }
2208
- /**
2209
- * @beta This hook is in beta
2210
- */
2211
2112
  function useTagAnnotations(documentId, location) {
2212
2113
  var tagElement = useTagUtils();
2213
2114
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -2224,9 +2125,6 @@ function useTagAnnotations(documentId, location) {
2224
2125
  return data;
2225
2126
  }
2226
2127
 
2227
- /**
2228
- * @beta This hook is in beta
2229
- */
2230
2128
  function useViewsUtils() {
2231
2129
  var _a = React__default["default"].useState(), viewsElement = _a[0], setViewsElement = _a[1];
2232
2130
  var client = useVeltClient().client;
@@ -2238,9 +2136,6 @@ function useViewsUtils() {
2238
2136
  }, [client, setViewsElement, viewsElement]);
2239
2137
  return viewsElement;
2240
2138
  }
2241
- /**
2242
- * @beta This hook is in beta
2243
- */
2244
2139
  function useUniqueViewsByUser(clientLocationId) {
2245
2140
  var viewsElement = useViewsUtils();
2246
2141
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -2256,9 +2151,6 @@ function useUniqueViewsByUser(clientLocationId) {
2256
2151
  }, [viewsElement === null || viewsElement === void 0 ? void 0 : viewsElement.getUniqueViewsByUser]);
2257
2152
  return data;
2258
2153
  }
2259
- /**
2260
- * @beta This hook is in beta
2261
- */
2262
2154
  function useUniqueViewsByDate(clientLocationId) {
2263
2155
  var viewsElement = useViewsUtils();
2264
2156
  var _a = React__default["default"].useState(null), data = _a[0], setData = _a[1];
@@ -2275,9 +2167,6 @@ function useUniqueViewsByDate(clientLocationId) {
2275
2167
  return data;
2276
2168
  }
2277
2169
 
2278
- /**
2279
- * @beta This hook is in beta
2280
- */
2281
2170
  function useNotificationUtils() {
2282
2171
  var _a = React__default["default"].useState(), notificationElement = _a[0], setNotificationElement = _a[1];
2283
2172
  var client = useVeltClient().client;
@@ -2289,9 +2178,6 @@ function useNotificationUtils() {
2289
2178
  }, [client, setNotificationElement, notificationElement]);
2290
2179
  return notificationElement;
2291
2180
  }
2292
- /**
2293
- * @beta This hook is in beta
2294
- */
2295
2181
  function useNotificationsData() {
2296
2182
  var notificationElement = useNotificationUtils();
2297
2183
  var _a = React__default["default"].useState([]), data = _a[0], setData = _a[1];
@@ -2308,9 +2194,6 @@ function useNotificationsData() {
2308
2194
  return data;
2309
2195
  }
2310
2196
 
2311
- /**
2312
- * @beta This hook is in beta
2313
- */
2314
2197
  function useAutocompleteUtils() {
2315
2198
  var _a = React__default["default"].useState(), autocompleteElement = _a[0], setAutocompleteElement = _a[1];
2316
2199
  var client = useVeltClient().client;
@@ -2322,9 +2205,6 @@ function useAutocompleteUtils() {
2322
2205
  }, [client, setAutocompleteElement, autocompleteElement]);
2323
2206
  return autocompleteElement;
2324
2207
  }
2325
- /**
2326
- * @beta This hook is in beta
2327
- */
2328
2208
  function useAutocompleteChipClick() {
2329
2209
  var autocompleteElement = useAutocompleteUtils();
2330
2210
  var _a = React__default["default"].useState(), data = _a[0], setData = _a[1];
@@ -2477,7 +2357,6 @@ exports.VeltViewAnalytics = VeltViewAnalytics;
2477
2357
  exports.VeltWireframe = VeltWireframe;
2478
2358
  exports.createLiveStateMiddleware = createLiveStateMiddleware;
2479
2359
  exports.useAIRewriterUtils = useAIRewriterUtils;
2480
- exports.useAddLocation = useAddLocation;
2481
2360
  exports.useAutocompleteChipClick = useAutocompleteChipClick;
2482
2361
  exports.useAutocompleteUtils = useAutocompleteUtils;
2483
2362
  exports.useClient = useClient;