@liveblocks/core 1.0.8 → 1.1.0-fsm1

package/dist/index.d.ts

@@ -129,6 +129,63 @@ declare type UpdateDelta = {
     type: "delete";
 };
 
+/**
+ * "Plain LSON" is a JSON-based format that's used when serializing Live structures
+ * to send them over HTTP (e.g. in the API endpoint to let users upload their initial
+ * Room storage, in the API endpoint to fetch a Room's storage, ...).
+ *
+ * In the client, you would typically create LSON values using:
+ *
+ *    new LiveObject({ x: 0, y: 0 })
+ *
+ * But over HTTP, this has to be serialized somehow. The "Plain LSON" format
+ * is what's used in the POST /init-storage-new endpoint, to allow users to
+ * control which parts of their data structure should be considered "Live"
+ * objects, and which parts are "normal" objects.
+ *
+ * So if they have a structure like:
+ *
+ *    { x: 0, y: 0 }
+ *
+ * And want to make it a Live object, they can serialize it by wrapping it in
+ * a special "annotation":
+ *
+ *    {
+ *      "liveblocksType": "LiveObject",
+ *      "data": { x: 0, y: 0 },
+ *    }
+ *
+ * This "Plain LSON" data format defines exactly those wrappings.
+ *
+ * To summarize:
+ *
+ *   LSON value            |  Plain LSON equivalent
+ *   ----------------------+----------------------------------------------
+ *   42                    |  42
+ *   [1, 2, 3]             |  [1, 2, 3]
+ *   { x: 0, y: 0 }        |  { x: 0, y: 0 }
+ *   ----------------------+----------------------------------------------
+ *   new LiveList(...)     |  { liveblocksType: "LiveList",   data: ... }
+ *   new LiveMap(...)      |  { liveblocksType: "LiveMap",    data: ... }
+ *   new LiveObject(...)   |  { liveblocksType: "LiveObject", data: ... }
+ *
+ */
+
+declare type PlainLsonFields = Record<string, PlainLson>;
+declare type PlainLsonObject = {
+    liveblocksType: "LiveObject";
+    data: PlainLsonFields;
+};
+declare type PlainLsonMap = {
+    liveblocksType: "LiveMap";
+    data: PlainLsonFields;
+};
+declare type PlainLsonList = {
+    liveblocksType: "LiveList";
+    data: PlainLson[];
+};
+declare type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | Json;
+
 declare type LiveObjectUpdateDelta<O extends {
     [key: string]: unknown;
 }> = {
@@ -197,6 +254,10 @@ declare class LiveObject<O extends LsonObject> extends AbstractCrdt {
 declare type ToImmutable<L extends Lson | LsonObject> = L extends LiveList<infer I> ? readonly ToImmutable<I>[] : L extends LiveObject<infer O> ? ToImmutable<O> : L extends LiveMap<infer K, infer V> ? ReadonlyMap<K, ToImmutable<V>> : L extends LsonObject ? {
     readonly [K in keyof L]: ToImmutable<Exclude<L[K], undefined>> | (undefined extends L[K] ? undefined : never);
 } : L extends Json ? L : never;
+/**
+ * Returns PlainLson for a given Json or LiveStructure, suitable for calling the storage init api
+ */
+declare function toPlainLson(lson: Lson): PlainLson;
 
 /**
  * A LiveMap notification that is sent in-client to any subscribers whenever
@@ -268,12 +329,15 @@ declare class LiveMap<TKey extends string, TValue extends Lson> extends Abstract
 }
 
 declare type StorageCallback = (updates: StorageUpdate[]) => void;
+declare type LiveMapUpdate = LiveMapUpdates<string, Lson>;
+declare type LiveObjectUpdate = LiveObjectUpdates<LsonObject>;
+declare type LiveListUpdate = LiveListUpdates<Lson>;
 /**
  * The payload of notifications sent (in-client) when LiveStructures change.
  * Messages of this kind are not originating from the network, but are 100%
  * in-client.
  */
-declare type StorageUpdate = LiveMapUpdates<string, Lson> | LiveObjectUpdates<LsonObject> | LiveListUpdates<Lson>;
+declare type StorageUpdate = LiveMapUpdate | LiveObjectUpdate | LiveListUpdate;
 
 declare abstract class AbstractCrdt {
     get roomId(): string | null;
@@ -1546,63 +1610,6 @@ SerializedCrdt>;
 declare type ParentToChildNodeMap = Map<string, // Parent's node ID
 IdTuple<SerializedChild>[]>;
 
-/**
- * "Plain LSON" is a JSON-based format that's used when serializing Live structures
- * to send them over HTTP (e.g. in the API endpoint to let users upload their initial
- * Room storage, in the API endpoint to fetch a Room's storage, ...).
- *
- * In the client, you would typically create LSON values using:
- *
- *    new LiveObject({ x: 0, y: 0 })
- *
- * But over HTTP, this has to be serialized somehow. The "Plain LSON" format
- * is what's used in the POST /init-storage-new endpoint, to allow users to
- * control which parts of their data structure should be considered "Live"
- * objects, and which parts are "normal" objects.
- *
- * So if they have a structure like:
- *
- *    { x: 0, y: 0 }
- *
- * And want to make it a Live object, they can serialize it by wrapping it in
- * a special "annotation":
- *
- *    {
- *      "liveblocksType": "LiveObject",
- *      "data": { x: 0, y: 0 },
- *    }
- *
- * This "Plain LSON" data format defines exactly those wrappings.
- *
- * To summarize:
- *
- *   LSON value            |  Plain LSON equivalent
- *   ----------------------+----------------------------------------------
- *   42                    |  42
- *   [1, 2, 3]             |  [1, 2, 3]
- *   { x: 0, y: 0 }        |  { x: 0, y: 0 }
- *   ----------------------+----------------------------------------------
- *   new LiveList(...)     |  { liveblocksType: "LiveList",   data: ... }
- *   new LiveMap(...)      |  { liveblocksType: "LiveMap",    data: ... }
- *   new LiveObject(...)   |  { liveblocksType: "LiveObject", data: ... }
- *
- */
-
-declare type PlainLsonFields = Record<string, PlainLson>;
-declare type PlainLsonObject = {
-    liveblocksType: "LiveObject";
-    data: PlainLsonFields;
-};
-declare type PlainLsonMap = {
-    liveblocksType: "LiveMap";
-    data: PlainLsonFields;
-};
-declare type PlainLsonList = {
-    liveblocksType: "LiveList";
-    data: PlainLson[];
-};
-declare type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | Json;
-
 declare type JsonTreeNode = {
     readonly type: "Json";
     readonly id: string;
@@ -1779,4 +1786,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, ConnectionStatus, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveNode, LiveObject, LiveStructure, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, tryParseJson };
+export { AckOp, AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, ConnectionStatus, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson };