@liveblocks/client - npm Package Compare versions

Comparing version 0.1.0 to 0.1.3

lib/cjs/client.d.ts

@@ -19,19 +19,19 @@ import { Record, List, RecordData } from "./doc";
 export declare function createClient(options: Options): {
-    createRecord<T extends RecordData>(roomId: string, data: any): Record<T>;
-    createList<T_1 extends List<any> | Record<any>>(roomId: string): List<T_1>;
-    updateRecord<T_2 extends RecordData>(roomId: string, record: Record<T_2>, overrides: Partial<T_2>): void;
-    pushItem<T_3 extends List<any> | Record<any>>(roomId: string, list: List<T_3>, item: T_3): void;
-    deleteItem<T_4 extends List<any> | Record<any>>(roomId: string, list: List<T_4>, index: number): void;
-    moveItem<T_5 extends List<any> | Record<any>>(roomId: string, list: List<T_5>, index: number, targetIndex: number): void;
-    observeStorage: <TRoot extends RecordData>(roomId: string, callback: (root: Record<TRoot> | null) => void, initialDocumentState: InitialRootFactory<TRoot>) => void;
-    unobserveStorage: <TRoot_1 extends RecordData>(roomId: string, callback: (root: Record<TRoot_1> | null) => void) => void;
-    getPresence: <TUser extends UserState>(roomId: string) => TUser | null;
-    setPresence: (roomId: string, overrides: Partial<UserState>) => void;
-    observeMyPresence: (roomId: string, callback: OnMyPresenceChange) => void;
-    unobserveMyPresence: (roomId: string, callback: OnMyPresenceChange) => void;
-    observeOthersPresence: (roomId: string, callback: OnOthersPresenceChange) => void;
-    unobserveOthersPresence: (roomId: string, callback: OnOthersPresenceChange) => void;
+    createRecord<T extends RecordData>(room: string, data: any): Record<T>;
+    createList<T_1 extends List<any> | Record<any>>(room: string): List<T_1>;
+    updateRecord<T_2 extends RecordData>(room: string, record: Record<T_2>, overrides: Partial<T_2>): void;
+    pushItem<T_3 extends List<any> | Record<any>>(room: string, list: List<T_3>, item: T_3): void;
+    deleteItem<T_4 extends List<any> | Record<any>>(room: string, list: List<T_4>, index: number): void;
+    moveItem<T_5 extends List<any> | Record<any>>(room: string, list: List<T_5>, index: number, targetIndex: number): void;
+    observeStorage: <TRoot extends RecordData>(room: string, callback: (root: Record<TRoot> | null) => void, initialDocumentState: InitialRootFactory<TRoot>) => void;
+    unobserveStorage: <TRoot_1 extends RecordData>(room: string, callback: (root: Record<TRoot_1> | null) => void) => void;
+    getPresence: <TUser extends UserState>(room: string) => TUser | null;
+    setPresence: (room: string, overrides: Partial<UserState>) => void;
+    observeMyPresence: (room: string, callback: OnMyPresenceChange) => void;
+    unobserveMyPresence: (room: string, callback: OnMyPresenceChange) => void;
+    observeOthersPresence: (room: string, callback: OnOthersPresenceChange) => void;
+    unobserveOthersPresence: (room: string, callback: OnOthersPresenceChange) => void;
 };
 export declare type Room = ReturnType<typeof createRoom>;
-declare function createRoom(id: string, options: Options): {
+declare function createRoom(name: string, options: Options): {
     createRecord: <T extends RecordData>(data: any) => Record<T>;
@@ -38,0 +38,0 @@ createList: <T_1 extends List<any> | Record<any>>() => List<T_1>;

lib/cjs/client.js

@@ -38,3 +38,3 @@ "use strict";
 }
-function authorize(endpoint, roomId) {
+function authorize(endpoint, room) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -47,3 +47,3 @@ const res = yield fetch(endpoint, {
             body: JSON.stringify({
-                roomId,
+                room,
             }),
@@ -64,7 +64,7 @@ });
     const rooms = new Map();
-    function getRoomOrInit(id) {
-        let room = rooms.get(id);
+    function getRoomOrInit(name) {
+        let room = rooms.get(name);
         if (room == null) {
-            room = createRoom(id, options);
-            rooms.set(id, room);
+            room = createRoom(name, options);
+            rooms.set(name, room);
         }
@@ -77,25 +77,25 @@ return room;
         /////////////
-        createRecord(roomId, data) {
-            return getRoomOrInit(roomId).createRecord(data);
+        createRecord(room, data) {
+            return getRoomOrInit(room).createRecord(data);
         },
-        createList(roomId) {
-            return getRoomOrInit(roomId).createList();
+        createList(room) {
+            return getRoomOrInit(room).createList();
         },
-        updateRecord(roomId, record, overrides) {
-            getRoomOrInit(roomId).updateRecord(record, overrides);
+        updateRecord(room, record, overrides) {
+            getRoomOrInit(room).updateRecord(record, overrides);
         },
-        pushItem(roomId, list, item) {
-            getRoomOrInit(roomId).pushItem(list, item);
+        pushItem(room, list, item) {
+            getRoomOrInit(room).pushItem(list, item);
         },
-        deleteItem(roomId, list, index) {
-            getRoomOrInit(roomId).deleteItem(list, index);
+        deleteItem(room, list, index) {
+            getRoomOrInit(room).deleteItem(list, index);
         },
-        moveItem(roomId, list, index, targetIndex) {
-            getRoomOrInit(roomId).moveItem(list, index, targetIndex);
+        moveItem(room, list, index, targetIndex) {
+            getRoomOrInit(room).moveItem(list, index, targetIndex);
         },
-        observeStorage: (roomId, callback, initialDocumentState) => {
-            getRoomOrInit(roomId).observeStorage(callback, initialDocumentState);
+        observeStorage: (room, callback, initialDocumentState) => {
+            getRoomOrInit(room).observeStorage(callback, initialDocumentState);
         },
-        unobserveStorage: (roomId, callback) => {
-            getRoomOrInit(roomId).unobserveStorage(callback);
+        unobserveStorage: (room, callback) => {
+            getRoomOrInit(room).unobserveStorage(callback);
         },
@@ -105,19 +105,19 @@ //////////////
         //////////////
-        getPresence: (roomId) => {
-            return getRoomOrInit(roomId).getPresence();
+        getPresence: (room) => {
+            return getRoomOrInit(room).getPresence();
         },
-        setPresence: (roomId, overrides) => {
-            return getRoomOrInit(roomId).setPresence(overrides);
+        setPresence: (room, overrides) => {
+            return getRoomOrInit(room).setPresence(overrides);
         },
-        observeMyPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).observeMyPresence(callback);
+        observeMyPresence: (room, callback) => {
+            return getRoomOrInit(room).observeMyPresence(callback);
         },
-        unobserveMyPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).unobserveMyPresence(callback);
+        unobserveMyPresence: (room, callback) => {
+            return getRoomOrInit(room).unobserveMyPresence(callback);
         },
-        observeOthersPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).observeOthersPresence(callback);
+        observeOthersPresence: (room, callback) => {
+            return getRoomOrInit(room).observeOthersPresence(callback);
         },
-        unobserveOthersPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).unobserveOthersPresence(callback);
+        unobserveOthersPresence: (room, callback) => {
+            return getRoomOrInit(room).unobserveOthersPresence(callback);
         },
@@ -133,3 +133,3 @@ };
 })(RoomState || (RoomState = {}));
-function createRoom(id, options) {
+function createRoom(name, options) {
     const liveblocksServer = options.liveblocksServer;
@@ -252,3 +252,3 @@ const authEndpoint = options.authEndpoint;
             state = RoomState.Connecting;
-            const { token, actor } = yield authorize(authEndpoint, id);
+            const { token, actor } = yield authorize(authEndpoint, name);
             _idFactory = makeIdFactory(actor);
@@ -255,0 +255,0 @@ _socket = new WebSocket(`${liveblocksServer}/?token=${token}`);

lib/esm/client.d.ts

@@ -19,19 +19,19 @@ import { Record, List, RecordData } from "./doc";
 export declare function createClient(options: Options): {
-    createRecord<T extends RecordData>(roomId: string, data: any): Record<T>;
-    createList<T_1 extends List<any> | Record<any>>(roomId: string): List<T_1>;
-    updateRecord<T_2 extends RecordData>(roomId: string, record: Record<T_2>, overrides: Partial<T_2>): void;
-    pushItem<T_3 extends List<any> | Record<any>>(roomId: string, list: List<T_3>, item: T_3): void;
-    deleteItem<T_4 extends List<any> | Record<any>>(roomId: string, list: List<T_4>, index: number): void;
-    moveItem<T_5 extends List<any> | Record<any>>(roomId: string, list: List<T_5>, index: number, targetIndex: number): void;
-    observeStorage: <TRoot extends RecordData>(roomId: string, callback: (root: Record<TRoot> | null) => void, initialDocumentState: InitialRootFactory<TRoot>) => void;
-    unobserveStorage: <TRoot_1 extends RecordData>(roomId: string, callback: (root: Record<TRoot_1> | null) => void) => void;
-    getPresence: <TUser extends UserState>(roomId: string) => TUser | null;
-    setPresence: (roomId: string, overrides: Partial<UserState>) => void;
-    observeMyPresence: (roomId: string, callback: OnMyPresenceChange) => void;
-    unobserveMyPresence: (roomId: string, callback: OnMyPresenceChange) => void;
-    observeOthersPresence: (roomId: string, callback: OnOthersPresenceChange) => void;
-    unobserveOthersPresence: (roomId: string, callback: OnOthersPresenceChange) => void;
+    createRecord<T extends RecordData>(room: string, data: any): Record<T>;
+    createList<T_1 extends List<any> | Record<any>>(room: string): List<T_1>;
+    updateRecord<T_2 extends RecordData>(room: string, record: Record<T_2>, overrides: Partial<T_2>): void;
+    pushItem<T_3 extends List<any> | Record<any>>(room: string, list: List<T_3>, item: T_3): void;
+    deleteItem<T_4 extends List<any> | Record<any>>(room: string, list: List<T_4>, index: number): void;
+    moveItem<T_5 extends List<any> | Record<any>>(room: string, list: List<T_5>, index: number, targetIndex: number): void;
+    observeStorage: <TRoot extends RecordData>(room: string, callback: (root: Record<TRoot> | null) => void, initialDocumentState: InitialRootFactory<TRoot>) => void;
+    unobserveStorage: <TRoot_1 extends RecordData>(room: string, callback: (root: Record<TRoot_1> | null) => void) => void;
+    getPresence: <TUser extends UserState>(room: string) => TUser | null;
+    setPresence: (room: string, overrides: Partial<UserState>) => void;
+    observeMyPresence: (room: string, callback: OnMyPresenceChange) => void;
+    unobserveMyPresence: (room: string, callback: OnMyPresenceChange) => void;
+    observeOthersPresence: (room: string, callback: OnOthersPresenceChange) => void;
+    unobserveOthersPresence: (room: string, callback: OnOthersPresenceChange) => void;
 };
 export declare type Room = ReturnType<typeof createRoom>;
-declare function createRoom(id: string, options: Options): {
+declare function createRoom(name: string, options: Options): {
     createRecord: <T extends RecordData>(data: any) => Record<T>;
@@ -38,0 +38,0 @@ createList: <T_1 extends List<any> | Record<any>>() => List<T_1>;

lib/esm/client.js

@@ -35,3 +35,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 }
-function authorize(endpoint, roomId) {
+function authorize(endpoint, room) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -44,3 +44,3 @@ const res = yield fetch(endpoint, {
             body: JSON.stringify({
-                roomId,
+                room,
             }),
@@ -61,7 +61,7 @@ });
     const rooms = new Map();
-    function getRoomOrInit(id) {
-        let room = rooms.get(id);
+    function getRoomOrInit(name) {
+        let room = rooms.get(name);
         if (room == null) {
-            room = createRoom(id, options);
-            rooms.set(id, room);
+            room = createRoom(name, options);
+            rooms.set(name, room);
         }
@@ -74,25 +74,25 @@ return room;
         /////////////
-        createRecord(roomId, data) {
-            return getRoomOrInit(roomId).createRecord(data);
+        createRecord(room, data) {
+            return getRoomOrInit(room).createRecord(data);
         },
-        createList(roomId) {
-            return getRoomOrInit(roomId).createList();
+        createList(room) {
+            return getRoomOrInit(room).createList();
         },
-        updateRecord(roomId, record, overrides) {
-            getRoomOrInit(roomId).updateRecord(record, overrides);
+        updateRecord(room, record, overrides) {
+            getRoomOrInit(room).updateRecord(record, overrides);
         },
-        pushItem(roomId, list, item) {
-            getRoomOrInit(roomId).pushItem(list, item);
+        pushItem(room, list, item) {
+            getRoomOrInit(room).pushItem(list, item);
         },
-        deleteItem(roomId, list, index) {
-            getRoomOrInit(roomId).deleteItem(list, index);
+        deleteItem(room, list, index) {
+            getRoomOrInit(room).deleteItem(list, index);
         },
-        moveItem(roomId, list, index, targetIndex) {
-            getRoomOrInit(roomId).moveItem(list, index, targetIndex);
+        moveItem(room, list, index, targetIndex) {
+            getRoomOrInit(room).moveItem(list, index, targetIndex);
         },
-        observeStorage: (roomId, callback, initialDocumentState) => {
-            getRoomOrInit(roomId).observeStorage(callback, initialDocumentState);
+        observeStorage: (room, callback, initialDocumentState) => {
+            getRoomOrInit(room).observeStorage(callback, initialDocumentState);
         },
-        unobserveStorage: (roomId, callback) => {
-            getRoomOrInit(roomId).unobserveStorage(callback);
+        unobserveStorage: (room, callback) => {
+            getRoomOrInit(room).unobserveStorage(callback);
         },
@@ -102,19 +102,19 @@ //////////////
         //////////////
-        getPresence: (roomId) => {
-            return getRoomOrInit(roomId).getPresence();
+        getPresence: (room) => {
+            return getRoomOrInit(room).getPresence();
         },
-        setPresence: (roomId, overrides) => {
-            return getRoomOrInit(roomId).setPresence(overrides);
+        setPresence: (room, overrides) => {
+            return getRoomOrInit(room).setPresence(overrides);
         },
-        observeMyPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).observeMyPresence(callback);
+        observeMyPresence: (room, callback) => {
+            return getRoomOrInit(room).observeMyPresence(callback);
         },
-        unobserveMyPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).unobserveMyPresence(callback);
+        unobserveMyPresence: (room, callback) => {
+            return getRoomOrInit(room).unobserveMyPresence(callback);
         },
-        observeOthersPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).observeOthersPresence(callback);
+        observeOthersPresence: (room, callback) => {
+            return getRoomOrInit(room).observeOthersPresence(callback);
         },
-        unobserveOthersPresence: (roomId, callback) => {
-            return getRoomOrInit(roomId).unobserveOthersPresence(callback);
+        unobserveOthersPresence: (room, callback) => {
+            return getRoomOrInit(room).unobserveOthersPresence(callback);
         },
@@ -129,3 +129,3 @@ };
 })(RoomState || (RoomState = {}));
-function createRoom(id, options) {
+function createRoom(name, options) {
     const liveblocksServer = options.liveblocksServer;
@@ -248,3 +248,3 @@ const authEndpoint = options.authEndpoint;
             state = RoomState.Connecting;
-            const { token, actor } = yield authorize(authEndpoint, id);
+            const { token, actor } = yield authorize(authEndpoint, name);
             _idFactory = makeIdFactory(actor);
@@ -251,0 +251,0 @@ _socket = new WebSocket(`${liveblocksServer}/?token=${token}`);

package.json

 {
   "name": "@liveblocks/client",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "",
@@ -5,0 +5,0 @@ "main": "./lib/cjs/index.js",

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

76548

decreased by-0.19%

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes