@builder6/rooms 3.0.5 → 3.0.7

package/src/rooms/protocol/BaseUserMeta.ts

@@ -1,28 +0,0 @@
-import type { Json } from '../lib/Json';
-
-/**
- * Represents some constraints for user info. Basically read this as: "any JSON
- * object is fine, but _if_ it has a name field, it _must_ be a string."
- * (Ditto for avatar.)
- */
-export type IUserInfo = {
-  [key: string]: Json | undefined;
-  name?: string;
-  avatar?: string;
-};
-
-/**
- * This type is used by clients to define the metadata for a user.
- */
-export type BaseUserMeta = {
-  /**
-   * The id of the user that has been set in the authentication endpoint.
-   * Useful to get additional information about the connected user.
-   */
-  id?: string;
-
-  /**
-   * Additional user information that has been set in the authentication endpoint.
-   */
-  info?: IUserInfo;
-};

package/src/rooms/protocol/ClientMsg.ts

@@ -1,94 +0,0 @@
-import type { Json, JsonObject } from '../lib/Json';
-import type { Op } from './Op';
-
-export enum ClientMsgCode {
-  // For Presence
-  UPDATE_PRESENCE = 100,
-  BROADCAST_EVENT = 103,
-
-  // For Storage
-  FETCH_STORAGE = 200,
-  UPDATE_STORAGE = 201,
-
-  // For Yjs support
-  FETCH_YDOC = 300,
-  UPDATE_YDOC = 301,
-}
-
-/**
- * Messages that can be sent from the client to the server.
- */
-export type ClientMsg<P extends JsonObject, E extends Json> =
-  // For Presence
-  | BroadcastEventClientMsg<E>
-  | UpdatePresenceClientMsg<P>
-
-  // For Storage
-  | UpdateStorageClientMsg
-  | FetchStorageClientMsg
-
-  // For Yjs support
-  | FetchYDocClientMsg
-  | UpdateYDocClientMsg;
-
-export type BroadcastEventClientMsg<E extends Json> = {
-  type: ClientMsgCode.BROADCAST_EVENT;
-  event: E;
-};
-
-export type UpdatePresenceClientMsg<P extends JsonObject> =
-  //
-  // Full Presence™ message
-  //
-  | {
-      readonly type: ClientMsgCode.UPDATE_PRESENCE;
-      /**
-       * Set this to any number to signify that this is a Full Presence™
-       * update, not a patch.
-       *
-       * The numeric value itself no longer has specific meaning. Historically,
-       * this field was intended so that clients could ignore these broadcasted
-       * full presence messages, but it turned out that getting a full presence
-       * "keyframe" from time to time was useful.
-       *
-       * So nowadays, the presence (pun intended) of this `targetActor` field
-       * is a backward-compatible way of expressing that the `data` contains
-       * all presence fields, and isn't a partial "patch".
-       */
-      readonly targetActor: number;
-      readonly data: P;
-    }
-
-  //
-  // Partial Presence™ message
-  //
-  | {
-      readonly type: ClientMsgCode.UPDATE_PRESENCE;
-      /**
-       * Absence of the `targetActor` field signifies that this is a Partial
-       * Presence™ "patch".
-       */
-      readonly targetActor?: undefined;
-      readonly data: Partial<P>;
-    };
-
-export type UpdateStorageClientMsg = {
-  readonly type: ClientMsgCode.UPDATE_STORAGE;
-  readonly ops: Op[];
-};
-
-export type FetchStorageClientMsg = {
-  readonly type: ClientMsgCode.FETCH_STORAGE;
-};
-
-export type FetchYDocClientMsg = {
-  readonly type: ClientMsgCode.FETCH_YDOC;
-  readonly vector: string; // base64 encoded stateVector a from yjs doc
-  readonly guid?: string; // an optional guid to identify a subdoc
-};
-
-export type UpdateYDocClientMsg = {
-  readonly type: ClientMsgCode.UPDATE_YDOC;
-  readonly update: string; // base64 encoded update from a yjs doc
-  readonly guid?: string; // an optional guid to identify a subdoc
-};

package/src/rooms/protocol/Comments.ts

@@ -1,202 +0,0 @@
-import type { DM } from '../globals/augmentation';
-import type { DateToString } from '../lib/DateToString';
-
-export type BaseMetadata = Record<
-  string,
-  string | boolean | number | undefined
->;
-
-export type CommentReaction = {
-  emoji: string;
-  createdAt: Date;
-  users: {
-    id: string;
-  }[];
-};
-
-export type CommentAttachment = {
-  type: 'attachment';
-  id: string;
-  name: string;
-  size: number;
-  mimeType: string;
-};
-
-export type CommentLocalAttachmentIdle = {
-  type: 'localAttachment';
-  status: 'idle';
-  id: string;
-  name: string;
-  size: number;
-  mimeType: string;
-  file: File;
-};
-
-export type CommentLocalAttachmentUploading = {
-  type: 'localAttachment';
-  status: 'uploading';
-  id: string;
-  name: string;
-  size: number;
-  mimeType: string;
-  file: File;
-};
-
-export type CommentLocalAttachmentUploaded = {
-  type: 'localAttachment';
-  status: 'uploaded';
-  id: string;
-  name: string;
-  size: number;
-  mimeType: string;
-  file: File;
-};
-
-export type CommentLocalAttachmentError = {
-  type: 'localAttachment';
-  status: 'error';
-  id: string;
-  name: string;
-  size: number;
-  mimeType: string;
-  file: File;
-  error: Error;
-};
-
-export type CommentLocalAttachment =
-  | CommentLocalAttachmentIdle
-  | CommentLocalAttachmentUploading
-  | CommentLocalAttachmentUploaded
-  | CommentLocalAttachmentError;
-
-export type CommentMixedAttachment = CommentAttachment | CommentLocalAttachment;
-
-/**
- * Represents a comment.
- */
-export type CommentData = {
-  type: 'comment';
-  id: string;
-  threadId: string;
-  roomId: string;
-  userId: string;
-  createdAt: Date;
-  editedAt?: Date;
-  reactions: CommentReaction[];
-  attachments: CommentAttachment[];
-} & (
-  | { body: CommentBody; deletedAt?: never }
-  | { body?: never; deletedAt: Date }
-);
-
-export type CommentDataPlain = Omit<
-  DateToString<CommentData>,
-  'reactions' | 'body'
-> & {
-  reactions: DateToString<CommentReaction>[];
-} & (
-    | { body: CommentBody; deletedAt?: never }
-    | { body?: never; deletedAt: string }
-  );
-
-export type CommentBodyBlockElement = CommentBodyParagraph;
-
-export type CommentBodyInlineElement =
-  | CommentBodyText
-  | CommentBodyMention
-  | CommentBodyLink;
-
-export type CommentBodyElement =
-  | CommentBodyBlockElement
-  | CommentBodyInlineElement;
-
-export type CommentBodyParagraph = {
-  type: 'paragraph';
-  children: CommentBodyInlineElement[];
-};
-
-export type CommentBodyMention = {
-  type: 'mention';
-  id: string;
-};
-
-export type CommentBodyLink = {
-  type: 'link';
-  url: string;
-  text?: string;
-};
-
-export type CommentBodyText = {
-  bold?: boolean;
-  italic?: boolean;
-  strikethrough?: boolean;
-  code?: boolean;
-  text: string;
-};
-
-export type CommentBody = {
-  version: 1;
-  content: CommentBodyBlockElement[];
-};
-
-export type CommentUserReaction = {
-  emoji: string;
-  createdAt: Date;
-  userId: string;
-};
-
-export type CommentUserReactionPlain = DateToString<CommentUserReaction>;
-
-/**
- * Represents a thread of comments.
- */
-export type ThreadData<M extends BaseMetadata = DM> = {
-  type: 'thread';
-  id: string;
-  roomId: string;
-  createdAt: Date;
-  updatedAt: Date;
-  comments: CommentData[];
-  metadata: M;
-  resolved: boolean;
-};
-
-export interface ThreadDataWithDeleteInfo<M extends BaseMetadata = DM>
-  extends ThreadData<M> {
-  deletedAt?: Date;
-}
-
-export type ThreadDataPlain<M extends BaseMetadata> = Omit<
-  DateToString<ThreadData<M>>,
-  'comments' | 'metadata'
-> & {
-  comments: CommentDataPlain[];
-  metadata: M;
-};
-
-export type ThreadDeleteInfo = {
-  type: 'deletedThread';
-  id: string;
-  roomId: string;
-  deletedAt: Date;
-};
-
-export type ThreadDeleteInfoPlain = DateToString<ThreadDeleteInfo>;
-
-type StringOperators<T> =
-  | T
-  | {
-      startsWith: string;
-    };
-
-/**
- * This type can be used to build a metadata query string (compatible
- * with `@liveblocks/query-parser`) through a type-safe API.
- *
- * In addition to exact values (`:` in query string), it adds:
- * - to strings:
- *  - `startsWith` (`^` in query string)
- */
-export type QueryMetadata<M extends BaseMetadata> = {
-  [K in keyof M]: string extends M[K] ? StringOperators<M[K]> : M[K];
-};

package/src/rooms/protocol/InboxNotifications.ts

@@ -1,75 +0,0 @@
-import type { DAD } from '../globals/augmentation';
-import type { DateToString } from '../lib/DateToString';
-
-export type InboxNotificationThreadData = {
-  kind: 'thread';
-  id: string;
-  roomId: string;
-  threadId: string;
-  notifiedAt: Date;
-  readAt: Date | null;
-};
-
-export type InboxNotificationTextMentionData = {
-  kind: 'textMention';
-  id: string;
-  roomId: string;
-  notifiedAt: Date;
-  readAt: Date | null;
-  createdBy: string;
-  mentionId: string;
-};
-
-export type InboxNotificationTextMentionDataPlain =
-  DateToString<InboxNotificationTextMentionData>;
-
-export type ActivityData = Record<
-  string,
-  string | boolean | number | undefined
->;
-
-type InboxNotificationActivity<K extends keyof DAD = keyof DAD> = {
-  id: string;
-  createdAt: Date;
-  data: DAD[K];
-};
-
-export type InboxNotificationCustomData<K extends keyof DAD = keyof DAD> = {
-  kind: K;
-  id: string;
-  roomId?: string;
-  subjectId: string;
-  notifiedAt: Date;
-  readAt: Date | null;
-  activities: InboxNotificationActivity<K>[];
-};
-
-export type InboxNotificationData =
-  | InboxNotificationThreadData
-  | InboxNotificationCustomData
-  | InboxNotificationTextMentionData;
-
-export type InboxNotificationThreadDataPlain =
-  DateToString<InboxNotificationThreadData>;
-
-export type InboxNotificationCustomDataPlain = Omit<
-  DateToString<InboxNotificationCustomData>,
-  'activities'
-> & {
-  activities: DateToString<InboxNotificationActivity>[];
-};
-
-export type InboxNotificationDataPlain =
-  | InboxNotificationThreadDataPlain
-  | InboxNotificationCustomDataPlain
-  | InboxNotificationTextMentionDataPlain;
-
-export type InboxNotificationDeleteInfo = {
-  type: 'deletedInboxNotification';
-  id: string;
-  roomId: string;
-  deletedAt: Date;
-};
-
-export type InboxNotificationDeleteInfoPlain =
-  DateToString<InboxNotificationDeleteInfo>;

package/src/rooms/protocol/Op.ts

@@ -1,143 +0,0 @@
-import type { Json, JsonObject } from '../lib/Json';
-
-export enum OpCode {
-  INIT = 0,
-  SET_PARENT_KEY = 1,
-  CREATE_LIST = 2,
-  UPDATE_OBJECT = 3,
-  CREATE_OBJECT = 4,
-  DELETE_CRDT = 5,
-  DELETE_OBJECT_KEY = 6,
-  CREATE_MAP = 7,
-  CREATE_REGISTER = 8,
-}
-
-/**
- * These operations are the payload for {@link UpdateStorageServerMsg} messages
- * only.
- */
-export type Op =
-  | AckOp
-  | CreateOp
-  | UpdateObjectOp
-  | DeleteCrdtOp
-  | SetParentKeyOp // Only for lists!
-  | DeleteObjectKeyOp;
-
-export type CreateOp =
-  | CreateObjectOp
-  | CreateRegisterOp
-  | CreateMapOp
-  | CreateListOp;
-
-export type UpdateObjectOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly type: OpCode.UPDATE_OBJECT;
-  readonly data: Partial<JsonObject>;
-};
-
-export type CreateObjectOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly intent?: 'set';
-  readonly deletedId?: string;
-  readonly type: OpCode.CREATE_OBJECT;
-  readonly parentId: string;
-  readonly parentKey: string;
-  readonly data: JsonObject;
-};
-
-export type CreateListOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly intent?: 'set';
-  readonly deletedId?: string;
-  readonly type: OpCode.CREATE_LIST;
-  readonly parentId: string;
-  readonly parentKey: string;
-};
-
-export type CreateMapOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly intent?: 'set';
-  readonly deletedId?: string;
-  readonly type: OpCode.CREATE_MAP;
-  readonly parentId: string;
-  readonly parentKey: string;
-};
-
-export type CreateRegisterOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly intent?: 'set';
-  readonly deletedId?: string;
-  readonly type: OpCode.CREATE_REGISTER;
-  readonly parentId: string;
-  readonly parentKey: string;
-  readonly data: Json;
-};
-
-export type DeleteCrdtOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly type: OpCode.DELETE_CRDT;
-};
-
-//
-// HACK:
-// Disguised as a "DeleteCrdtOp" for a nonexisting node "ACK", this Op that the
-// server may return to senders is effectively sent as a backward-compatible
-// way to trigger an acknowledgement for Ops that were seen by the server, but
-// deliberately ignored.
-//
-export type AckOp = {
-  readonly type: OpCode.DELETE_CRDT; // Not a typo!
-  readonly id: 'ACK';
-  readonly opId: string;
-};
-
-/**
- * Create an Op that can be used as an acknowledgement for the given opId, to
- * send back to the originating client in cases where the server decided to
- * ignore the Op and not forward it.
- *
- * Why?
- * It's important for the client to receive an acknowledgement for this, so
- * that it can correctly update its own unacknowledged Ops administration.
- * Otherwise it could get in "synchronizing" state indefinitely.
- *
- * CLEVER HACK
- * Introducing a new Op type for this would not be backward-compatible as
- * receiving such Op would crash old clients :(
- * So the clever backward-compatible hack pulled here is that we codify the
- * acknowledgement as a "deletion Op" for the non-existing node id "ACK". In
- * old clients such Op is accepted, but will effectively be a no-op as that
- * node does not exist, but as a side-effect the Op will get acknowledged.
- */
-export function ackOp(opId: string): AckOp {
-  return {
-    type: OpCode.DELETE_CRDT,
-    id: 'ACK', // (H)ACK
-    opId,
-  };
-}
-
-export function isAckOp(op: Op): op is AckOp {
-  return op.type === OpCode.DELETE_CRDT && op.id === 'ACK';
-}
-
-export type SetParentKeyOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly type: OpCode.SET_PARENT_KEY;
-  readonly parentKey: string;
-};
-
-export type DeleteObjectKeyOp = {
-  readonly opId?: string;
-  readonly id: string;
-  readonly type: OpCode.DELETE_OBJECT_KEY;
-  readonly key: string;
-};

package/src/rooms/protocol/SerializedCrdt.ts

@@ -1,61 +0,0 @@
-import type { Json, JsonObject } from '../lib/Json';
-
-export type IdTuple<T> = [id: string, value: T];
-
-export enum CrdtType {
-  OBJECT = 0,
-  LIST = 1,
-  MAP = 2,
-  REGISTER = 3,
-}
-
-export type SerializedCrdt = SerializedRootObject | SerializedChild;
-
-export type SerializedChild =
-  | SerializedObject
-  | SerializedList
-  | SerializedMap
-  | SerializedRegister;
-
-export type SerializedRootObject = {
-  readonly type: CrdtType.OBJECT;
-  readonly data: JsonObject;
-
-  // Root objects don't have a parent relationship
-  readonly parentId?: never;
-  readonly parentKey?: never;
-};
-
-export type SerializedObject = {
-  readonly type: CrdtType.OBJECT;
-  readonly parentId: string;
-  readonly parentKey: string;
-  readonly data: JsonObject;
-};
-
-export type SerializedList = {
-  readonly type: CrdtType.LIST;
-  readonly parentId: string;
-  readonly parentKey: string;
-};
-
-export type SerializedMap = {
-  readonly type: CrdtType.MAP;
-  readonly parentId: string;
-  readonly parentKey: string;
-};
-
-export type SerializedRegister = {
-  readonly type: CrdtType.REGISTER;
-  readonly parentId: string;
-  readonly parentKey: string;
-  readonly data: Json;
-};
-
-export function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject {
-  return crdt.type === CrdtType.OBJECT && !isChildCrdt(crdt);
-}
-
-export function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild {
-  return crdt.parentId !== undefined && crdt.parentKey !== undefined;
-}