@liveblocks/client 0.16.14 → 0.16.17

package/internal.d.ts

@@ -1,5 +1,5 @@
 import { d as JsonObject, J as Json, g as Resolve, e as Lson, A as AbstractCrdt, f as LsonObject, L as LiveObject, S as StorageUpdate } from './shared';
-export { g as Resolve, h as RoomInitializers } from './shared';
+export { g as Resolve, h as RoomInitializers, i as isJsonArray, j as isJsonObject, k as isJsonScalar } from './shared';
 
 declare type IdTuple<T> = [id: string, value: T];
 /**
@@ -317,6 +317,33 @@ declare function throwUsageError(message: string): void;
  */
 declare function errorIf(condition: unknown, message: string): void;
 
+declare const SCOPES: readonly ["websocket:presence", "websocket:storage", "room:read", "room:write", "rooms:read", "rooms:write"];
+declare type Scope = typeof SCOPES[number];
+declare type AppOnlyAuthToken = {
+    appId: string;
+    roomId?: never;
+    scopes: string[];
+};
+declare type RoomAuthToken = {
+    appId: string;
+    roomId: string;
+    scopes: string[];
+    actor: number;
+    maxConnectionsPerRoom?: number;
+    id?: string;
+    info?: Json;
+};
+declare type AuthToken = AppOnlyAuthToken | RoomAuthToken;
+interface JwtMetadata extends JsonObject {
+    iat: number;
+    exp: number;
+}
+declare function isScope(value: unknown): value is Scope;
+declare function isAppOnlyAuthToken(data: JsonObject): data is AppOnlyAuthToken;
+declare function isRoomAuthToken(data: JsonObject): data is RoomAuthToken;
+declare function isAuthToken(data: JsonObject): data is AuthToken;
+declare function parseAuthToken(token: string): AuthToken & JwtMetadata;
+
 declare function lsonToJson(value: Lson | AbstractCrdt): Json;
 declare function patchLiveObjectKey<O extends LsonObject>(liveObject: LiveObject<O>, key: keyof O, prev: unknown, next: unknown): void;
 declare function patchImmutableObject<T>(state: T, updates: StorageUpdate[]): T;
@@ -344,6 +371,9 @@ declare function comparePosition(posA: string, posB: string): number;
  * 🍒 case.
  */
 declare function assertNever(_value: never, errmsg: string): never;
+declare function isPlainObject(blob: unknown): blob is {
+    [key: string]: unknown;
+};
 /**
  * Alternative to JSON.parse() that will not throw in production. If the passed
  * string cannot be parsed, this will return `undefined`.
@@ -354,4 +384,4 @@ declare function tryParseJson(rawMessage: string): Json | undefined;
  */
 declare function b64decode(b64value: string): string;
 
-export { BroadcastEventClientMsg, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, IdTuple, InitialDocumentStateServerMsg, NodeMap, Op, OpCode, ParentToChildNodeMap, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UserJoinServerMsg, WebsocketCloseCodes, assertNever, b64decode, comparePosition, deprecate, deprecateIf, errorIf, isChildCrdt, isRootCrdt, lsonToJson, makePosition, patchImmutableObject, patchLiveObjectKey, throwUsageError, tryParseJson };
+export { AppOnlyAuthToken, AuthToken, BroadcastEventClientMsg, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, IdTuple, InitialDocumentStateServerMsg, NodeMap, Op, OpCode, ParentToChildNodeMap, RoomAuthToken, RoomStateServerMsg, Scope, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UserJoinServerMsg, WebsocketCloseCodes, assertNever, b64decode, comparePosition, deprecate, deprecateIf, errorIf, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isPlainObject, isRoomAuthToken, isRootCrdt, isScope, lsonToJson, makePosition, parseAuthToken, patchImmutableObject, patchLiveObjectKey, throwUsageError, tryParseJson };

package/internal.js

@@ -4,7 +4,37 @@ Object.defineProperty(exports, "__esModule", {
  value: !0
 });
 
-var LiveObject = require("./shared.js");
+var LiveObject = require("./shared.js"), SCOPES = [ "websocket:presence", "websocket:storage", "room:read", "room:write", "rooms:read", "rooms:write" ];
+
+function isStringList(value) {
+ return Array.isArray(value) && value.every((function(i) {
+  return "string" == typeof i;
+ }));
+}
+
+function isAppOnlyAuthToken(data) {
+ return "string" == typeof data.appId && void 0 === data.roomId && isStringList(data.scopes);
+}
+
+function isRoomAuthToken(data) {
+ return "string" == typeof data.appId && "string" == typeof data.roomId && "number" == typeof data.actor && (void 0 === data.id || "string" == typeof data.id) && isStringList(data.scopes) && (void 0 === data.maxConnectionsPerRoom || "number" == typeof data.maxConnectionsPerRoom);
+}
+
+function isAuthToken(data) {
+ return isAppOnlyAuthToken(data) || isRoomAuthToken(data);
+}
+
+function parseJwtToken(token) {
+ var tokenParts = token.split(".");
+ if (3 !== tokenParts.length) throw new Error("Authentication error: invalid JWT token");
+ var data = LiveObject.tryParseJson(LiveObject.b64decode(tokenParts[1]));
+ if (data && function(data) {
+  if (!LiveObject.isPlainObject(data)) return !1;
+  var iat = data.iat, exp = data.exp;
+  return "number" == typeof iat && "number" == typeof exp;
+ }(data)) return data;
+ throw new Error("Authentication error: missing JWT metadata");
+}
 
 function lsonObjectToJson(obj) {
  var result = {};
@@ -168,10 +198,18 @@ Object.defineProperty(exports, "ClientMsgCode", {
 }), exports.assertNever = LiveObject.assertNever, exports.b64decode = LiveObject.b64decode, 
 exports.comparePosition = LiveObject.comparePosition, exports.deprecate = LiveObject.deprecate, 
 exports.deprecateIf = LiveObject.deprecateIf, exports.errorIf = LiveObject.errorIf, 
-exports.isChildCrdt = LiveObject.isChildCrdt, exports.isRootCrdt = LiveObject.isRootCrdt, 
+exports.isChildCrdt = LiveObject.isChildCrdt, exports.isJsonArray = LiveObject.isJsonArray, 
+exports.isJsonObject = LiveObject.isJsonObject, exports.isJsonScalar = LiveObject.isJsonScalar, 
+exports.isPlainObject = LiveObject.isPlainObject, exports.isRootCrdt = LiveObject.isRootCrdt, 
 exports.makePosition = LiveObject.makePosition, exports.throwUsageError = LiveObject.throwUsageError, 
-exports.tryParseJson = LiveObject.tryParseJson, exports.lsonToJson = lsonToJson, 
-exports.patchImmutableObject = function(state, updates) {
+exports.tryParseJson = LiveObject.tryParseJson, exports.isAppOnlyAuthToken = isAppOnlyAuthToken, 
+exports.isAuthToken = isAuthToken, exports.isRoomAuthToken = isRoomAuthToken, exports.isScope = function(value) {
+ return SCOPES.includes(value);
+}, exports.lsonToJson = lsonToJson, exports.parseAuthToken = function(token) {
+ var data = parseJwtToken(token);
+ if (data && isAuthToken(data)) return data;
+ throw new Error("Authentication error. Liveblocks could not parse the response of your authentication endpoint");
+}, exports.patchImmutableObject = function(state, updates) {
  return updates.reduce((function(state, update) {
   return function(state, update) {
    var path = function(node) {

package/internal.mjs

@@ -1,6 +1,46 @@
-import { L as LiveObject, b as LiveList, k as LiveMap, l as LiveRegister, A as AbstractCrdt, n as findNonSerializableValue } from "./shared.mjs";
+import { t as tryParseJson, e as b64decode, l as isPlainObject$1, L as LiveObject, b as LiveList, k as LiveMap, n as LiveRegister, A as AbstractCrdt, o as findNonSerializableValue } from "./shared.mjs";
 
-export { C as ClientMsgCode, s as CrdtType, O as OpCode, S as ServerMsgCode, W as WebsocketCloseCodes, x as assertNever, e as b64decode, u as comparePosition, o as deprecate, j as deprecateIf, p as errorIf, w as isChildCrdt, h as isRootCrdt, v as makePosition, q as throwUsageError, t as tryParseJson } from "./shared.mjs";
+export { C as ClientMsgCode, u as CrdtType, O as OpCode, S as ServerMsgCode, W as WebsocketCloseCodes, y as assertNever, e as b64decode, v as comparePosition, p as deprecate, j as deprecateIf, q as errorIf, x as isChildCrdt, c as isJsonArray, f as isJsonObject, z as isJsonScalar, l as isPlainObject, h as isRootCrdt, w as makePosition, s as throwUsageError, t as tryParseJson } from "./shared.mjs";
+
+const SCOPES = [ "websocket:presence", "websocket:storage", "room:read", "room:write", "rooms:read", "rooms:write" ];
+
+function isScope(value) {
+ return SCOPES.includes(value);
+}
+
+function isStringList(value) {
+ return Array.isArray(value) && value.every((i => "string" == typeof i));
+}
+
+function isAppOnlyAuthToken(data) {
+ return "string" == typeof data.appId && void 0 === data.roomId && isStringList(data.scopes);
+}
+
+function isRoomAuthToken(data) {
+ return "string" == typeof data.appId && "string" == typeof data.roomId && "number" == typeof data.actor && (void 0 === data.id || "string" == typeof data.id) && isStringList(data.scopes) && (void 0 === data.maxConnectionsPerRoom || "number" == typeof data.maxConnectionsPerRoom);
+}
+
+function isAuthToken(data) {
+ return isAppOnlyAuthToken(data) || isRoomAuthToken(data);
+}
+
+function parseJwtToken(token) {
+ const tokenParts = token.split(".");
+ if (3 !== tokenParts.length) throw new Error("Authentication error: invalid JWT token");
+ const data = tryParseJson(b64decode(tokenParts[1]));
+ if (data && function(data) {
+  if (!isPlainObject$1(data)) return !1;
+  const {iat: iat, exp: exp} = data;
+  return "number" == typeof iat && "number" == typeof exp;
+ }(data)) return data;
+ throw new Error("Authentication error: missing JWT metadata");
+}
+
+function parseAuthToken(token) {
+ const data = parseJwtToken(token);
+ if (data && isAuthToken(data)) return data;
+ throw new Error("Authentication error. Liveblocks could not parse the response of your authentication endpoint");
+}
 
 function lsonObjectToJson(obj) {
  const result = {};
@@ -145,4 +185,4 @@ function patchImmutableNode(state, path, update) {
  });
 }
 
-export { lsonToJson, patchImmutableObject, patchLiveObjectKey };
+export { isAppOnlyAuthToken, isAuthToken, isRoomAuthToken, isScope, lsonToJson, parseAuthToken, patchImmutableObject, patchLiveObjectKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.16.14",
+  "version": "0.16.17",
   "description": "A client that lets you interact with Liveblocks servers.",
   "main": "./index.js",
   "module": "./index.mjs",

package/shared.d.ts

@@ -14,6 +14,9 @@ declare type JsonArray = Json[];
 declare type JsonObject = {
     [key: string]: Json | undefined;
 };
+declare function isJsonScalar(data: Json): data is JsonScalar;
+declare function isJsonArray(data: Json): data is JsonArray;
+declare function isJsonObject(data: Json): data is JsonObject;
 
 /**
  * The LiveMap class is similar to a JavaScript Map that is synchronized on all clients.
@@ -780,4 +783,4 @@ declare class LiveObject<O extends LsonObject = LsonObject> extends AbstractCrdt
     update(overrides: Partial<O>): void;
 }
 
-export { AbstractCrdt as A, BroadcastOptions as B, ClientOptions as C, History as H, Json as J, LiveObject as L, Others as O, Presence as P, Room as R, StorageUpdate as S, User as U, Client as a, LiveMap as b, LiveList as c, JsonObject as d, Lson as e, LsonObject as f, Resolve as g, RoomInitializers as h };
+export { AbstractCrdt as A, BroadcastOptions as B, ClientOptions as C, History as H, Json as J, LiveObject as L, Others as O, Presence as P, Room as R, StorageUpdate as S, User as U, Client as a, LiveMap as b, LiveList as c, JsonObject as d, Lson as e, LsonObject as f, Resolve as g, RoomInitializers as h, isJsonArray as i, isJsonObject as j, isJsonScalar as k };

package/shared.js

@@ -197,12 +197,16 @@ var AbstractCrdt = function() {
  } ]), AbstractCrdt;
 }();
 
+function isJsonScalar(data) {
+ return null === data || "string" == typeof data || "number" == typeof data || "boolean" == typeof data;
+}
+
 function isJsonArray(data) {
  return Array.isArray(data);
 }
 
 function isJsonObject(data) {
- return null !== data && "object" == typeof data && !isJsonArray(data);
+ return !isJsonScalar(data) && !isJsonArray(data);
 }
 
 var _Symbol$iterator$1, _Symbol$iterator2, LiveRegister = function(_AbstractCrdt) {
@@ -940,14 +944,11 @@ function selfOrRegister(obj) {
 
 function isPlain(value) {
  var type = typeof value;
- return "undefined" === type || null === value || "string" === type || "boolean" === type || "number" === type || Array.isArray(value) || function(value) {
-  if ("object" != typeof value || null === value) return !1;
-  var proto = Object.getPrototypeOf(value);
-  if (null === proto) return !0;
-  var baseProto = proto;
-  for (;null !== Object.getPrototypeOf(baseProto); ) baseProto = Object.getPrototypeOf(baseProto);
-  return proto === baseProto;
- }(value);
+ return "undefined" === type || null === value || "string" === type || "boolean" === type || "number" === type || Array.isArray(value) || isPlainObject(value);
+}
+
+function isPlainObject(blob) {
+ return null !== blob && "object" == typeof blob && "[object Object]" === Object.prototype.toString.call(blob);
 }
 
 function entries(obj) {
@@ -1366,7 +1367,7 @@ exports.errorIf = function(condition, message) {
   }
  })), ops;
 }, exports.isChildCrdt = isChildCrdt, exports.isJsonArray = isJsonArray, exports.isJsonObject = isJsonObject, 
-exports.isRootCrdt = function(crdt) {
+exports.isJsonScalar = isJsonScalar, exports.isPlainObject = isPlainObject, exports.isRootCrdt = function(crdt) {
  return crdt.type === exports.CrdtType.OBJECT && !isChildCrdt(crdt);
 }, exports.isSameNodeOrChildOf = function isSameNodeOrChildOf(node, parent) {
  return node === parent || !!node._parent && isSameNodeOrChildOf(node._parent, parent);

package/shared.mjs

@@ -70,12 +70,16 @@ class AbstractCrdt {
  }
 }
 
+function isJsonScalar(data) {
+ return null === data || "string" == typeof data || "number" == typeof data || "boolean" == typeof data;
+}
+
 function isJsonArray(data) {
  return Array.isArray(data);
 }
 
 function isJsonObject(data) {
- return null !== data && "object" == typeof data && !isJsonArray(data);
+ return !isJsonScalar(data) && !isJsonArray(data);
 }
 
 class LiveRegister extends AbstractCrdt {
@@ -909,14 +913,11 @@ function mergeStorageUpdates(first, second) {
 
 function isPlain(value) {
  const type = typeof value;
- return "undefined" === type || null === value || "string" === type || "boolean" === type || "number" === type || Array.isArray(value) || function(value) {
-  if ("object" != typeof value || null === value) return !1;
-  const proto = Object.getPrototypeOf(value);
-  if (null === proto) return !0;
-  let baseProto = proto;
-  for (;null !== Object.getPrototypeOf(baseProto); ) baseProto = Object.getPrototypeOf(baseProto);
-  return proto === baseProto;
- }(value);
+ return "undefined" === type || null === value || "string" === type || "boolean" === type || "number" === type || Array.isArray(value) || isPlainObject(value);
+}
+
+function isPlainObject(blob) {
+ return null !== blob && "object" == typeof blob && "[object Object]" === Object.prototype.toString.call(blob);
 }
 
 function findNonSerializableValue(value, path = "") {
@@ -1273,4 +1274,4 @@ class LiveObject extends AbstractCrdt {
  }
 }
 
-export { AbstractCrdt as A, ClientMsgCode as C, LiveObject as L, OpCode as O, ServerMsgCode as S, WebsocketCloseCodes as W, isSameNodeOrChildOf as a, LiveList as b, isJsonArray as c, compact as d, b64decode as e, isJsonObject as f, getTreesDiffOperations as g, isRootCrdt as h, isTokenValid as i, deprecateIf as j, LiveMap as k, LiveRegister as l, mergeStorageUpdates as m, findNonSerializableValue as n, deprecate as o, errorIf as p, throwUsageError as q, remove as r, CrdtType as s, tryParseJson as t, comparePosition as u, makePosition as v, isChildCrdt as w, assertNever as x };
+export { AbstractCrdt as A, ClientMsgCode as C, LiveObject as L, OpCode as O, ServerMsgCode as S, WebsocketCloseCodes as W, isSameNodeOrChildOf as a, LiveList as b, isJsonArray as c, compact as d, b64decode as e, isJsonObject as f, getTreesDiffOperations as g, isRootCrdt as h, isTokenValid as i, deprecateIf as j, LiveMap as k, isPlainObject as l, mergeStorageUpdates as m, LiveRegister as n, findNonSerializableValue as o, deprecate as p, errorIf as q, remove as r, throwUsageError as s, tryParseJson as t, CrdtType as u, comparePosition as v, makePosition as w, isChildCrdt as x, assertNever as y, isJsonScalar as z };