weseek__growi/apps/app/src/interfaces/websocket.ts

import { ExternalGroupProviderType } from '~/features/external-user-group/interfaces/external-user-group';

const generateGroupSyncEvents = () => {
  const events = {};
  Object.values(ExternalGroupProviderType).forEach((provider) => {
    events[provider] = {
      GroupSyncProgress: `${provider}:groupSyncProgress`,
      GroupSyncCompleted: `${provider}:groupSyncCompleted`,
      GroupSyncFailed: `${provider}:groupSyncFailed`,
    };
  });
  return events as {
    [key in ExternalGroupProviderType]: {
      GroupSyncProgress: string;
      GroupSyncCompleted: string;
      GroupSyncFailed: string;
    };
  };
};

export const SocketEventName = {
  // Update descendantCount
  UpdateDescCount: 'UpdateDescCount',

  // Public migration
  PMStarted: 'PublicMigrationStarted',
  PMMigrating: 'PublicMigrationMigrating',
  PMErrorCount: 'PublicMigrationErrorCount',
  PMEnded: 'PublicMigrationEnded',

  // Page migration
  PageMigrationSuccess: 'PageMigrationSuccess',
  PageMigrationError: 'PageMigrationError',

  // Elasticsearch
  AddPageProgress: 'addPageProgress',
  FinishAddPage: 'finishAddPage',
  RebuildingFailed: 'rebuildingFailed',

  // External user group sync
  externalUserGroup: generateGroupSyncEvents(),

  // room per pageId
  JoinPage: 'join:page',
  LeavePage: 'leave:page',

  // Page Operation
  PageCreated: 'page:create',
  PageUpdated: 'page:update',
  PageDeleted: 'page:delete',
  PageSeenUsersUpdated: 'page:seenUsersUpdated',

  // Yjs
  YjsAwarenessStateSizeUpdated: 'yjs:awareness-state-size-update',
  YjsHasYdocsNewerThanLatestRevisionUpdated:
    'yjs:has-ydocs-newer-than-latest-revision-update',
} as const;
export type SocketEventName =
  (typeof SocketEventName)[keyof typeof SocketEventName];

type PageId = string;
type DescendantCount = number;
/**
 * Data of updateDescCount when used through socket.io. Convert to UpdateDescCountData type when use with swr cache.
 */
export type UpdateDescCountRawData = Record<PageId, DescendantCount>;
export type UpdateDescCountData = Map<PageId, DescendantCount>;

export type PMStartedData = { total: number };
export type PMMigratingData = { count: number };
export type PMErrorCountData = { skip: number };
export type PMEndedData = { isSucceeded: boolean };

export type PageMigrationErrorData = { paths: string[] };