@liveblocks/client 0.16.1 → 0.16.4-beta1

package/{lib/internal.d.ts → internal.d.ts}

@@ -1,21 +1,5 @@
-/**
- * Represents an indefinitely deep arbitrary JSON data structure. There are
- * four types that make up the Json family:
- *
- * - Json         any legal JSON value
- * - JsonScalar   any legal JSON leaf value (no lists or objects)
- * - JsonArray    a JSON value whose outer type is an array
- * - JsonObject   a JSON value whose outer type is an object
- *
- */
-declare type Json = JsonScalar | JsonArray | JsonObject;
-declare type JsonScalar = string | number | boolean | null;
-declare type JsonArray = Json[];
-declare type JsonObject = {
-    [key: string]: Json;
-};
-
-declare type Presence = Record<string, unknown>;
+import { J as Json, P as Presence, d as JsonObject } from './shared';
+export { g as Resolve } from './shared';
 
 /**
  * Messages that can be sent from the server to the client.
@@ -284,4 +268,16 @@ declare function posCodes(str: string): number[];
 declare function pos(codes: number[]): string;
 declare function compare(posA: string, posB: string): number;
 
-export { ClientEventMessage, ClientMessage, ClientMessageType, CrdtType, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, EventMessage, FetchStorageClientMessage, InitialDocumentStateMessage, Op, OpType, RoomStateMessage, SerializedCrdt, SerializedCrdtWithId, SerializedList, SerializedMap, SerializedObject, SerializedRegister, ServerMessage, ServerMessageType, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMessage, UpdatePresenceMessage, UpdateStorageClientMessage, UpdateStorageMessage, UserJoinMessage, UserLeftMessage, WebsocketCloseCodes, compare, makePosition, max, min, pos, posCodes };
+/**
+ * Displays a deprecation warning in the dev console. Only in dev mode, and
+ * only once per message/key. In production, this is a no-op.
+ */
+declare function deprecate(message: string, key?: string): void;
+/**
+ * Conditionally displays a deprecation warning in the dev
+ * console if the first argument is truthy. Only in dev mode, and
+ * only once per message/key. In production, this is a no-op.
+ */
+declare function deprecateIf(condition: unknown, message: string, key?: string): void;
+
+export { ClientEventMessage, ClientMessage, ClientMessageType, CrdtType, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, EventMessage, FetchStorageClientMessage, InitialDocumentStateMessage, Op, OpType, RoomStateMessage, SerializedCrdt, SerializedCrdtWithId, SerializedList, SerializedMap, SerializedObject, SerializedRegister, ServerMessage, ServerMessageType, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMessage, UpdatePresenceMessage, UpdateStorageClientMessage, UpdateStorageMessage, UserJoinMessage, UserLeftMessage, WebsocketCloseCodes, compare, deprecate, deprecateIf, makePosition, max, min, pos, posCodes };

package/internal.js

@@ -0,0 +1,36 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var LiveObject = require('./shared.js');
+
+
+
+Object.defineProperty(exports, 'ClientMessageType', {
+	enumerable: true,
+	get: function () { return LiveObject.ClientMessageType; }
+});
+Object.defineProperty(exports, 'CrdtType', {
+	enumerable: true,
+	get: function () { return LiveObject.CrdtType; }
+});
+Object.defineProperty(exports, 'OpType', {
+	enumerable: true,
+	get: function () { return LiveObject.OpType; }
+});
+Object.defineProperty(exports, 'ServerMessageType', {
+	enumerable: true,
+	get: function () { return LiveObject.ServerMessageType; }
+});
+Object.defineProperty(exports, 'WebsocketCloseCodes', {
+	enumerable: true,
+	get: function () { return LiveObject.WebsocketCloseCodes; }
+});
+exports.compare = LiveObject.compare;
+exports.deprecate = LiveObject.deprecate;
+exports.deprecateIf = LiveObject.deprecateIf;
+exports.makePosition = LiveObject.makePosition;
+exports.max = LiveObject.max;
+exports.min = LiveObject.min;
+exports.pos = LiveObject.pos;
+exports.posCodes = LiveObject.posCodes;

package/internal.mjs

@@ -0,0 +1 @@
+export { C as ClientMessageType, n as CrdtType, O as OpType, S as ServerMessageType, W as WebsocketCloseCodes, v as compare, k as deprecate, l as deprecateIf, s as makePosition, q as max, o as min, u as pos, t as posCodes } from './shared.mjs';

package/package.json

@@ -1,27 +1,13 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.16.1",
+  "version": "0.16.4-beta1",
   "description": "A client that lets you interact with Liveblocks servers.",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./index.js",
+  "module": "./index.mjs",
+  "types": "./index.d.ts",
   "files": [
-    "lib/**"
+    "**"
   ],
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./lib/index.d.ts",
-      "module": "./lib/esm/index.js",
-      "import": "./lib/esm/index.mjs",
-      "default": "./lib/index.js"
-    },
-    "./internal": {
-      "types": "./lib/internal.d.ts",
-      "module": "./lib/esm/internal.js",
-      "import": "./lib/esm/internal.mjs",
-      "default": "./lib/internal.js"
-    }
-  },
   "keywords": [
     "liveblocks",
     "multiplayer",
@@ -32,7 +18,8 @@
     "url": "https://github.com/liveblocks/liveblocks/issues"
   },
   "scripts": {
-    "build": "rollup -c",
+    "build": "rollup -c && cp ./package.json ./README.md ./lib",
+    "lint": "eslint src/ test/",
     "test": "jest --watch",
     "test-ci": "jest"
   },
@@ -45,6 +32,7 @@
     "@babel/preset-typescript": "^7.12.16",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-typescript": "^8.3.1",
     "@types/jest": "^26.0.21",
     "@types/node-fetch": "^2.6.1",
@@ -58,8 +46,8 @@
     "msw": "^0.39.1",
     "node-fetch": "2.6.7",
     "rollup": "^2.68.0",
+    "rollup-plugin-command": "^1.1.3",
     "rollup-plugin-dts": "^4.1.0",
-    "rollup-plugin-esbuild": "^4.8.2",
     "typescript": "^4.4.0",
     "whatwg-fetch": "^3.6.2",
     "ws": "^8.5.0"
@@ -68,5 +56,6 @@
     "type": "git",
     "url": "https://github.com/liveblocks/liveblocks.git",
     "directory": "packages/liveblocks-client"
-  }
+  },
+  "sideEffects": false
 }

package/{lib/index.d.ts → shared.d.ts}

@@ -12,7 +12,7 @@ declare type Json = JsonScalar | JsonArray | JsonObject;
 declare type JsonScalar = string | number | boolean | null;
 declare type JsonArray = Json[];
 declare type JsonObject = {
-    [key: string]: Json;
+    [key: string]: Json | undefined;
 };
 
 /**
@@ -83,7 +83,7 @@ declare type Lson = Json | LiveObject<LsonObject> | LiveList<Lson> | LiveMap<str
  * value or a Live storage data structure (LiveMap, LiveList, etc.)
  */
 declare type LsonObject = {
-    [key: string]: Lson;
+    [key: string]: Lson | undefined;
 };
 
 /**
@@ -188,6 +188,31 @@ declare class LiveList<TItem extends Lson = Lson> extends AbstractCrdt {
     [Symbol.iterator](): IterableIterator<TItem>;
 }
 
+/**
+ * This helper type is effectively a no-op, but will force TypeScript to
+ * "evaluate" any named helper types in its definition. This can sometimes make
+ * API signatures clearer in IDEs.
+ *
+ * For example, in:
+ *
+ *   type Payload<T> = { data: T };
+ *
+ *   let r1: Payload<string>;
+ *   let r2: Resolve<Payload<string>>;
+ *
+ * The inferred type of `r1` is going to be `Payload<string>` which shows up in
+ * editor hints, and it may be unclear what's inside if you don't know the
+ * definition of `Payload`.
+ *
+ * The inferred type of `r2` is going to be `{ data: string }`, which may be
+ * more helpful.
+ *
+ * This trick comes from:
+ * https://effectivetypescript.com/2022/02/25/gentips-4-display/
+ */
+declare type Resolve<T> = T extends Function ? T : {
+    [K in keyof T]: T[K];
+};
 declare type MyPresenceCallback<T extends Presence = Presence> = (me: T) => void;
 declare type OthersEventCallback<T extends Presence = Presence> = (others: Others<T>, event: OthersEvent<T>) => void;
 declare type EventCallback = ({ connectionId, event, }: {
@@ -278,9 +303,9 @@ declare type Client = {
      * @param roomId The id of the room
      * @param defaultPresence Optional. Should be serializable to JSON. If omitted, an empty object will be used.
      */
-    enter<TStorageRoot extends Record<string, any> = Record<string, any>>(roomId: string, options?: {
+    enter<TStorage extends Record<string, any> = Record<string, any>>(roomId: string, options?: {
         defaultPresence?: Presence;
-        defaultStorageRoot?: TStorageRoot;
+        defaultStorageRoot?: TStorage;
     }): Room;
     /**
      * Leaves a room.
@@ -660,8 +685,8 @@ declare type Room = {
      * @example
      * const { root } = await room.getStorage();
      */
-    getStorage: <TRoot extends LsonObject>() => Promise<{
-        root: LiveObject<TRoot>;
+    getStorage: <TStorage extends LsonObject>() => Promise<{
+        root: LiveObject<TStorage>;
     }>;
     /**
      * Batches modifications made during the given function.
@@ -725,31 +750,4 @@ declare class LiveObject<O extends LsonObject = LsonObject> extends AbstractCrdt
     update(overrides: Partial<O>): void;
 }
 
-/**
- * Create a client that will be responsible to communicate with liveblocks servers.
- *
- * @example
- * const client = createClient({
- *   authEndpoint: "/api/auth"
- * });
- *
- * // It's also possible to use a function to call your authentication endpoint.
- * // Useful to add additional headers or use an API wrapper (like Firebase functions)
- * const client = createClient({
- *   authEndpoint: async (room) => {
- *     const response = await fetch("/api/auth", {
- *       method: "POST",
- *       headers: {
- *          Authentication: "token",
- *          "Content-Type": "application/json"
- *       },
- *       body: JSON.stringify({ room })
- *     });
- *
- *     return await response.json();
- *   }
- * });
- */
-declare function createClient(options: ClientOptions): Client;
-
-export { BroadcastOptions, Client, History, Json, JsonObject, LiveList, LiveMap, LiveObject, Lson, LsonObject, Others, Presence, Room, StorageUpdate, User, createClient };
+export { 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 };