✨ Implemented

Author: takker99

mod.ts

@@ -0,0 +1,74 @@
+/// <reference no-default-lib="true" />
+/// <reference lib="esnext" />
+/// <reference lib="dom" />
+
+import type { Socket } from "./socket.ts";
+import type { DataOf, EventMap, ListenEventMap, ResponseOf } from "./types.ts";
+export * from "./types.ts";
+export * from "./socket.ts";
+
+export function wrap(
+  socket: Socket,
+  timeout = 90000,
+) {
+  function request<EventName extends keyof EventMap>(
+    event: EventName,
+    data: DataOf<EventName>,
+  ): Promise<
+    EventName extends "cursor" ? void
+      : ResponseOf<"socket.io-request">["data"]
+  > {
+    let id: number | undefined;
+    type ResolveType = EventName extends "cursor" ? void
+      : ResponseOf<"socket.io-request">["data"];
+    return new Promise((resolve, reject) => {
+      const onDisconnect = (message: string) => {
+        clearTimeout(id);
+        reject(new Error(message));
+      };
+      socket.emit(event, data, (response: ResponseOf<EventName>) => {
+        clearTimeout(id);
+        socket.off("disconnect", onDisconnect);
+        if (response.error) {
+          reject(
+            new Error(JSON.stringify(response.error)),
+          );
+        }
+        if ("data" in response) {
+          resolve(response?.data as ResolveType);
+        } else {
+          resolve(undefined as ResolveType);
+        }
+      });
+      id = setTimeout(() => {
+        socket.off("disconnect", onDisconnect);
+        reject(new Error(`Timeout: exceeded ${timeout}ms`));
+      }, timeout);
+      socket.once("disconnect", onDisconnect);
+    });
+  }
+
+  async function* response<EventName extends keyof ListenEventMap>(
+    event: EventName,
+  ) {
+    type Data = Parameters<ListenEventMap[EventName]>[0];
+    let _resolve: ((data: Data) => void) | undefined;
+    const waitForEvent = () => new Promise<Data>((res) => _resolve = res);
+    const resolve = (data: Data) => {
+      _resolve?.(data);
+    };
+
+    socket.on(
+      event,
+      // @ts-ignore 何故か型推論に失敗する
+      resolve,
+    );
+    try {
+      yield await waitForEvent();
+    } finally {
+      socket.off(event, resolve);
+    }
+  }
+
+  return { request, response };
+}

socket.ts

@@ -6,7 +6,7 @@ import type {
   ManagerOptions,
   Socket,
   SocketOptions,
-} from "https://cdn.esm.sh/v54/socket.io-client@4.2.0/build/index.d.ts";
+} from "./types/socketIO/index.ts";
 export type { Manager, ManagerOptions, Socket, SocketOptions };
 
 declare function io(

types.ts

@@ -0,0 +1,151 @@
+export type JoinRoomData = {
+  pageId: string | null;
+  projectId: string;
+  projectUpdatesStream: false;
+} | {
+  pageId: null;
+  projectId: string;
+  projectUpdatesStream: true;
+};
+
+export interface JoinRoomResponse {
+  data: {
+    success: true;
+    pageId: string | null;
+    projectId: string;
+  };
+}
+
+export interface ProjectUpdatesStreamCommit {
+  kind: "page";
+  id: string;
+  parentId: string;
+  projectId: string;
+  pageId: string;
+  userId: string;
+  changes: (Change[] | [Delete]);
+  cursor: null;
+  freeze: true;
+}
+export type ProjectUpdatesStreamEvent =
+  & {
+    id: string;
+    pageId: string;
+    userId: string;
+    projectId: string;
+    created: number;
+    updated: number;
+  }
+  & ({
+    type: "member.join" | "invitation.reset";
+  } | {
+    type: "page.delete";
+    data: {
+      titleLc: string;
+    };
+  } | {
+    type: "admin.add" | "admin.delete" | "owner.set";
+    targetUserId: string;
+  });
+
+export interface CommitNotification {
+  kind: "page";
+  id: string;
+  parentId: string;
+  projectId: string;
+  pageId: string;
+  userId: string;
+  changes: (Change[] | [Pin] | [Delete]);
+  cursor: null;
+  freeze: true;
+}
+export type CommitData = Omit<CommitNotification, "id">;
+export interface CommitResponse {
+  data: {
+    commitId: string;
+  };
+}
+export interface EventMap {
+  "socket.io-request": (
+    data: CommitData | JoinRoomData,
+    callback: (
+      response: (CommitResponse | JoinRoomResponse) & { error?: unknown },
+    ) => void,
+  ) => void;
+  cursor: (
+    data: Omit<MoveCursorData, "socketId">,
+    callback: (response: { error?: unknown }) => void,
+  ) => void;
+}
+export interface ListenEventMap {
+  "projectUpdatesStream:commit": (
+    data: ProjectUpdatesStreamCommit,
+  ) => void;
+  "projectUpdatesStream:event": (
+    data: ProjectUpdatesStreamEvent,
+  ) => void;
+  commit: (data: CommitNotification) => void;
+  cursor: (data: MoveCursorData) => void;
+}
+export type DataOf<Event extends keyof EventMap> = Parameters<
+  EventMap[Event]
+>[0];
+export type ResponseOf<Event extends keyof EventMap> = Parameters<
+  Parameters<
+    EventMap[Event]
+  >[1]
+>[0];
+
+export interface MoveCursorData {
+  user: {
+    id: string;
+    displayName: string;
+  };
+  pageId: string;
+  position: {
+    line: number;
+    char: number;
+  };
+  visible: boolean;
+  socketId: string;
+}
+
+export type Change =
+  | InsertCommit
+  | UpdateCommit
+  | DeleteCommit
+  | LinksCommit
+  | DescriptionsCommit
+  | TitleCommit;
+export interface InsertCommit {
+  _insert: string;
+  lines: {
+    id: string;
+    text: string;
+  };
+}
+export interface UpdateCommit {
+  _update: string;
+  lines: {
+    text: string;
+  };
+}
+export interface DeleteCommit {
+  _delete: string;
+  lines: -1;
+}
+export interface LinksCommit {
+  links: string[];
+}
+export interface DescriptionsCommit {
+  descriptions: string[];
+}
+export interface TitleCommit {
+  title: string;
+}
+export interface Pin {
+  pin: number;
+}
+export interface Delete {
+  delete: true;
+}