@liveblocks/react 0.17.10-debug2 → 0.17.10

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 +1 @@
1
- b041a8c758a86d19b0562b0ce83856147a5b1661
1
+ 7a145c07616c7ce057d49178c31d7436fb2ab297
package/index.d.ts CHANGED
@@ -183,7 +183,12 @@ declare type RoomContextBundle<TPresence extends JsonObject, TStorage extends Ls
183
183
  * Storage.
184
184
  *
185
185
  * @example
186
- * const [root] = useStorage();
186
+ * const [root] = useStorageRoot();
187
+ */
188
+ useStorageRoot(): [root: LiveObject<TStorage> | null];
189
+ /**
190
+ * @deprecated In the next major version, we're changing the meaning of `useStorage()`.
191
+ * Please use `useStorageRoot()` instead for the current behavior.
187
192
  */
188
193
  useStorage(): [root: LiveObject<TStorage> | null];
189
194
  /**
@@ -332,6 +337,14 @@ declare function useRoom<TPresence extends JsonObject, TStorage extends LsonObje
332
337
  * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
333
338
  */
334
339
  declare function useSelf<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>(): User<TPresence, TUserMeta> | null;
340
+ /**
341
+ * @deprecated Please use `createRoomContext()` instead of importing
342
+ * `useStorageRoot` from `@liveblocks/react` directly. See
343
+ * https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details.
344
+ */
345
+ declare function useStorageRoot<TStorage extends LsonObject>(): [
346
+ root: LiveObject<TStorage> | null
347
+ ];
335
348
  /**
336
349
  * @deprecated Please use `createRoomContext()` instead of importing
337
350
  * `useStorage` from `@liveblocks/react` directly. See
@@ -391,4 +404,4 @@ declare function useObject<TData extends LsonObject>(key: string): LiveObject<TD
391
404
  */
392
405
  declare function useObject<TData extends LsonObject>(key: string, initialData: TData): LiveObject<TData> | null;
393
406
 
394
- export { LiveblocksProvider, RoomProvider, createRoomContext, useBatch, useBroadcastEvent, useClient, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useUndo, useUpdateMyPresence };
407
+ export { LiveblocksProvider, RoomProvider, createRoomContext, useBatch, useBroadcastEvent, useClient, useErrorListener, useEventListener, useHistory, useList, useMap, useMyPresence, useObject, useOthers, useRedo, useRoom, useSelf, useStorage, useStorageRoot, useUndo, useUpdateMyPresence };
package/index.js CHANGED
@@ -221,7 +221,7 @@ function createRoomContext(client) {
221
221
  }, [room, rerender]);
222
222
  return room.getSelf();
223
223
  }
224
- function useStorage2() {
224
+ function useStorageRoot2() {
225
225
  const room = useRoom2();
226
226
  const [root, setState] = React2.useState(null);
227
227
  React2.useEffect(() => {
@@ -241,6 +241,12 @@ function createRoomContext(client) {
241
241
  }, [room]);
242
242
  return [root];
243
243
  }
244
+ function useStorage2() {
245
+ _internal.deprecate.call(void 0,
246
+ "In the upcoming 0.18 version, the name `useStorage()` is going to be repurposed for a new hook. Please use `useStorageRoot()` instead to keep the current behavior."
247
+ );
248
+ return useStorageRoot2();
249
+ }
244
250
  function useMap_deprecated(key, entries) {
245
251
  _internal.errorIf.call(void 0,
246
252
  entries,
@@ -434,7 +440,7 @@ Please see https://bit.ly/3Niy5aP for details.`
434
440
  }
435
441
  function useStorageValue(key, initialValue) {
436
442
  const room = useRoom2();
437
- const [root] = useStorage2();
443
+ const [root] = useStorageRoot2();
438
444
  const rerender = useRerender();
439
445
  const frozenInitialValue = useInitial(initialValue);
440
446
  React2.useEffect(() => {
@@ -500,6 +506,7 @@ Please see https://bit.ly/3Niy5aP for details.`
500
506
  useRedo: useRedo2,
501
507
  useRoom: useRoom2,
502
508
  useSelf: useSelf2,
509
+ useStorageRoot: useStorageRoot2,
503
510
  useStorage: useStorage2,
504
511
  useUndo: useUndo2,
505
512
  useUpdateMyPresence: useUpdateMyPresence2,
@@ -579,6 +586,12 @@ function useSelf() {
579
586
  );
580
587
  return _hooks.useSelf();
581
588
  }
589
+ function useStorageRoot() {
590
+ _internal.deprecate.call(void 0,
591
+ "Please use `createRoomContext()` instead of importing `useStorageRoot` from `@liveblocks/react` directly. See https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details."
592
+ );
593
+ return _hooks.useStorageRoot();
594
+ }
582
595
  function useStorage() {
583
596
  _internal.deprecate.call(void 0,
584
597
  "Please use `createRoomContext()` instead of importing `useStorage` from `@liveblocks/react` directly. See https://liveblocks.io/docs/guides/upgrading#upgrading-from-0-16-to-0-17 for details."
@@ -636,4 +649,5 @@ function useObject(key, initialData) {
636
649
 
637
650
 
638
651
 
639
- exports.LiveblocksProvider = LiveblocksProvider; exports.RoomProvider = RoomProvider; exports.createRoomContext = createRoomContext; exports.useBatch = useBatch; exports.useBroadcastEvent = useBroadcastEvent; exports.useClient = useClient; exports.useErrorListener = useErrorListener; exports.useEventListener = useEventListener; exports.useHistory = useHistory; exports.useList = useList; exports.useMap = useMap; exports.useMyPresence = useMyPresence; exports.useObject = useObject; exports.useOthers = useOthers; exports.useRedo = useRedo; exports.useRoom = useRoom; exports.useSelf = useSelf; exports.useStorage = useStorage; exports.useUndo = useUndo; exports.useUpdateMyPresence = useUpdateMyPresence;
652
+
653
+ exports.LiveblocksProvider = LiveblocksProvider; exports.RoomProvider = RoomProvider; exports.createRoomContext = createRoomContext; exports.useBatch = useBatch; exports.useBroadcastEvent = useBroadcastEvent; exports.useClient = useClient; exports.useErrorListener = useErrorListener; exports.useEventListener = useEventListener; exports.useHistory = useHistory; exports.useList = useList; exports.useMap = useMap; exports.useMyPresence = useMyPresence; exports.useObject = useObject; exports.useOthers = useOthers; exports.useRedo = useRedo; exports.useRoom = useRoom; exports.useSelf = useSelf; exports.useStorage = useStorage; exports.useStorageRoot = useStorageRoot; exports.useUndo = useUndo; exports.useUpdateMyPresence = useUpdateMyPresence;
package/index.mjs CHANGED
@@ -17,6 +17,7 @@ export {
17
17
  useRoom,
18
18
  useSelf,
19
19
  useStorage,
20
+ useStorageRoot,
20
21
  useUndo,
21
22
  useUpdateMyPresence,
22
23
  } from "./index.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@liveblocks/react",
3
- "version": "0.17.10-debug2",
3
+ "version": "0.17.10",
4
4
  "description": "A set of React hooks and providers to use Liveblocks declaratively.",
5
5
  "main": "./index.js",
6
6
  "module": "./index.mjs",
@@ -17,7 +17,7 @@
17
17
  },
18
18
  "license": "Apache-2.0",
19
19
  "peerDependencies": {
20
- "@liveblocks/client": "0.17.10-debug2",
20
+ "@liveblocks/client": "0.17.10",
21
21
  "react": "^16.14.0 || ^17 || ^18"
22
22
  },
23
23
  "repository": {