@tencentcloud/web-push 1.0.3 → 1.0.4

package/src/core/web-push-sdk.ts

@@ -1,690 +0,0 @@
-import ChatSDK from '@tencentcloud/lite-chat/professional';
-import { version } from '../../package.json';
-import {
-  WebPushSDK as IWebPushSDK,
-  RegisterPushOptions,
-  EVENT,
-  NotificationMessage,
-  SubscriptionInfo,
-  MessageReceivedData,
-} from '../types';
-import { EventEmitter } from './event-emitter';
-import { ServiceWorkerManager } from './service-worker-manager';
-import { MessagePopup } from '../components/message-popup';
-import { logger } from '../utils/logger';
-import { Validator, ValidationError } from '../utils/validator';
-import { browserSupport } from '../utils/browser-support';
-import { genTestUserSig } from '../debug';
-
-export class WebPushSDK implements IWebPushSDK {
-  static instance: WebPushSDK;
-
-  private eventEmitter: EventEmitter;
-  private serviceWorkerManager: ServiceWorkerManager;
-  private messagePopup: MessagePopup | null = null;
-  private isRegistered: boolean = false;
-  private registrationID: string = '';
-  private chat: any = null;
-  private SDKAppID: number = 0;
-  private appKey: string = '';
-  private vapidPublicKey: string = '';
-  private pendingMessages: any[] = []; // 存储页面隐藏时接收的消息
-
-  public EVENT = EVENT;
-  public VERSION: string = version;
-
-  constructor() {
-    logger.log('version:', version);
-
-    this.eventEmitter = new EventEmitter();
-    this.serviceWorkerManager = ServiceWorkerManager.getInstance(
-      this.eventEmitter
-    );
-
-    this.initializeBrowserCompatibility().catch((error) => {
-      logger.error('Browser compatibility initialization failed', error);
-    });
-
-    this.setupInternalListeners();
-    this.setupVisibilityChangeListener();
-  }
-
-  static getInstance() {
-    if (!this.instance) {
-      this.instance = new WebPushSDK();
-    }
-    return this.instance;
-  }
-
-  async registerPush(options?: RegisterPushOptions) {
-    try {
-      Validator.validateRegisterPushOptions(options);
-
-      const { SDKAppID, appKey, userID, chat, logLevel } = options!;
-
-      // 设置主线程日志级别
-      if (logLevel !== undefined) {
-        logger.setLogLevel(logLevel);
-      }
-
-      if (this.isRegistered) {
-        logger.warn(
-          'Push service already registered, will unregister first and then re-register'
-        );
-        await this.unRegisterPush();
-      }
-
-      this.checkBrowserSupport();
-
-      const permission = await this.requestNotificationPermission();
-      if (permission !== 'granted') {
-        throw new Error('User denied notification permission');
-      }
-
-      this.SDKAppID = SDKAppID;
-      this.appKey = appKey;
-      this.registrationID = userID;
-
-      // 初始化弹窗组件（使用默认配置）
-      this.messagePopup = new MessagePopup({
-        onClick: (message: any, _popup: HTMLElement) => {
-          this.serviceWorkerManager.postMessage({
-            type: 'REPORT_WEBPUSH_EVENT',
-            payload: {
-              ...message,
-              eventType: 3,
-            },
-          });
-        },
-      });
-
-      if (chat) {
-        this.chat = chat;
-      } else {
-        // 检查 ChatSDK 是否可用
-        if (typeof ChatSDK === 'undefined') {
-          throw new Error(
-            'TencentCloudChat SDK is not available. Please ensure you have imported @tencentcloud/lite-chat/professional or provided a chat instance in the options.'
-          );
-        }
-
-        this.chat = ChatSDK.create({
-          SDKAppID: this.SDKAppID,
-          ...options,
-        });
-        if (logLevel !== undefined) {
-          this.chat.setLogLevel(logLevel);
-        }
-      }
-
-      // 启用在线推送监听
-      this.addChatListener();
-
-      await this.serviceWorkerManager.register();
-
-      // 向 Service Worker 发送日志级别配置
-      if (logLevel !== undefined) {
-        await this.sendLogLevelToServiceWorker(logLevel);
-      }
-
-      await this.pushLogin();
-
-      const subscriptionInfo =
-        await this.serviceWorkerManager.getPushSubscription(
-          this.vapidPublicKey
-        );
-
-      await this.setToken(subscriptionInfo);
-
-      this.isRegistered = true;
-
-      logger.log('Push service registration successful', this.registrationID);
-      return this.registrationID;
-    } catch (error) {
-      if (error instanceof ValidationError) {
-        logger.error(
-          'Push service registration parameter validation failed',
-          error.message
-        );
-        throw error;
-      }
-      logger.error('Push service registration failed', error);
-      throw error;
-    }
-  }
-
-  async unRegisterPush() {
-    try {
-      if (!this.isRegistered) {
-        logger.warn('Push service is not registered, no need to unregister');
-        return true;
-      }
-
-      if (this.chat) {
-        this.removeChatListener();
-      }
-
-      // 销毁弹窗组件
-      if (this.messagePopup) {
-        this.messagePopup.destroy();
-        this.messagePopup = null;
-      }
-
-      await this.serviceWorkerManager.unsubscribe();
-      await this.serviceWorkerManager.unregister();
-      await this.chat.callExperimentalAPI('logoutWebPush');
-
-      this.isRegistered = false;
-      this.registrationID = '';
-      this.SDKAppID = 0;
-      this.appKey = '';
-      this.vapidPublicKey = '';
-      this.clearState();
-
-      logger.log('Push service unregistration successful');
-      return true;
-    } catch (error) {
-      logger.error('Push service unregistration failed', error);
-      return false;
-    }
-  }
-
-  addPushListener(eventName: EVENT, listener: Function) {
-    try {
-      Validator.validateEventType(eventName);
-      Validator.validateListener(listener);
-
-      const listenerId = this.eventEmitter.on(eventName, listener);
-      logger.log('Add push listener', eventName, listenerId);
-      return listenerId;
-    } catch (error) {
-      if (error instanceof ValidationError) {
-        logger.error(
-          'Add push listener parameter validation failed',
-          error.message
-        );
-        throw error;
-      }
-      logger.error('Add push listener failed', error);
-      throw new Error('Add push listener failed');
-    }
-  }
-
-  /**
-   * 内部方法：向 Service Worker 发送日志级别配置
-   * @param logLevel 日志级别 0-4
-   */
-  private async sendLogLevelToServiceWorker(
-    logLevel: 0 | 1 | 2 | 3 | 4
-  ): Promise<void> {
-    try {
-      if (this.serviceWorkerManager) {
-        await this.serviceWorkerManager.postMessage({
-          type: 'SET_LOG_LEVEL',
-          payload: { logLevel },
-        });
-        logger.log('Log level sent to Service Worker:', logLevel);
-      }
-    } catch (error) {
-      logger.warn('Failed to send log level to Service Worker', error);
-    }
-  }
-
-  removePushListener(eventName: EVENT, listener: Function) {
-    try {
-      Validator.validateEventType(eventName);
-      Validator.validateListener(listener);
-
-      const result = this.eventEmitter.off(eventName, listener);
-      logger.log('Remove push listener', eventName, result);
-      return result;
-    } catch (error) {
-      if (error instanceof ValidationError) {
-        logger.error(
-          'Remove push listener parameter validation failed',
-          error.message
-        );
-        throw error;
-      }
-      logger.error('Remove push listener failed', error);
-      return false;
-    }
-  }
-
-  private checkBrowserSupport(): void {
-    if (!browserSupport.checkBrowserSupport()) {
-      const capability = browserSupport.detectWebPushCapability();
-      throw new Error(`Browser not supported: ${capability.reason}`);
-    }
-  }
-
-  private async requestNotificationPermission(): Promise<NotificationPermission> {
-    try {
-      const currentPermission =
-        await browserSupport.checkNotificationPermission();
-
-      if (currentPermission === 'granted') {
-        return 'granted';
-      }
-
-      const capability = browserSupport.detectWebPushCapability();
-      const browserName = capability.browserName;
-
-      if (currentPermission === 'denied') {
-        const errorMessage = `Notification permission denied for ${browserName}. Please check your system settings.`;
-        throw new Error(errorMessage);
-      }
-
-      if (browserSupport.requiresUserGesture()) {
-        logger.warn(
-          'Current browser requires user gesture to request notification permission'
-        );
-      }
-
-      const permission = await browserSupport.requestNotificationPermission();
-
-      if (permission !== 'granted') {
-        throw new Error(
-          `User denied notification permission for ${browserName}`
-        );
-      } else {
-        this.showSystemPermissionAlert(browserName);
-      }
-
-      return permission;
-    } catch (error) {
-      logger.error('Request notification permission failed', error);
-      throw error;
-    }
-  }
-
-  private async pushLogin(): Promise<void> {
-    try {
-      const res = await this.chat.callExperimentalAPI('loginWebPush', {
-        userID: this.registrationID,
-        userSig: genTestUserSig({
-          SDKAppID: this.SDKAppID,
-          secretKey: this.appKey,
-          userID: this.registrationID,
-        }).userSig,
-        pushSDKVersion: version,
-      });
-      if (res.data.vapid) {
-        this.vapidPublicKey = res.data.vapid;
-      } else {
-        logger.error('Failed to fetch VAPID public key');
-      }
-    } catch (error: any) {
-      // 处理专业版功能错误码
-      if (error?.code === 2905) {
-        const modifiedError = new Error(
-          'The API you are calling is only available in the Professional edition. Please change your import from @tencentcloud/lite-chat to @tencentcloud/lite-chat/professional to access this feature.'
-        );
-        (modifiedError as any).code = error.code;
-        throw modifiedError;
-      }
-
-      throw error;
-    }
-  }
-
-  private onMessageReceived(event: any) {
-    logger.log('Received message data', event);
-    event.data.forEach((item: any) => {
-      const { webPush } = item;
-      const { content, info, extension } = webPush as MessageReceivedData;
-      const { TaskId, WebpushReportUrl, OnlineClickExt } = extension;
-
-      if (content) {
-        try {
-          const message = JSON.parse(content);
-          const outerMessage = {
-            id: TaskId,
-            ...message,
-          };
-          this.eventEmitter.emit(EVENT.MESSAGE_RECEIVED, outerMessage);
-
-          if (message.MsgType !== 'custom') {
-            const messageWithExtras = {
-              ...outerMessage,
-              rptURL: WebpushReportUrl,
-              rptExt: OnlineClickExt,
-            };
-
-            if (this.messagePopup && document.visibilityState === 'visible') {
-              this.messagePopup.show(messageWithExtras);
-            } else if (this.messagePopup) {
-              this.pendingMessages.push(messageWithExtras);
-              logger.log(
-                'Message added to pending queue (page hidden)',
-                TaskId
-              );
-            }
-          }
-        } catch (error) {
-          logger.error('Failed to parse message content', error);
-          this.eventEmitter.emit(EVENT.MESSAGE_RECEIVED, content);
-        }
-      } else if (info) {
-        try {
-          this.sendNotificationToServiceWorker({
-            id: TaskId,
-            ...info,
-            rptURL: WebpushReportUrl,
-            rptExt: OnlineClickExt,
-          });
-        } catch (error) {
-          logger.error('Failed to send notification to service worker', error);
-          this.eventEmitter.emit(EVENT.MESSAGE_RECEIVED, info);
-        }
-      }
-    });
-  }
-
-  private onMessageRevoked(event: any) {
-    event.data.forEach((item: { ID: any }) => {
-      const { ID } = item;
-      logger.log('Message revoked', ID);
-
-      const isPopupMessage =
-        this.messagePopup && this.messagePopup.hasMessage(ID);
-
-      // 检查待处理消息队列中是否有该消息
-      const pendingIndex = this.pendingMessages.findIndex(
-        (msg) => msg.id === ID
-      );
-      if (pendingIndex !== -1) {
-        this.pendingMessages.splice(pendingIndex, 1);
-        logger.log('Pending message removed from queue', ID);
-
-        this.eventEmitter.emit(EVENT.MESSAGE_REVOKED, {
-          messageID: ID,
-        });
-        return;
-      }
-
-      if (isPopupMessage) {
-        this.messagePopup!.close(ID);
-
-        this.eventEmitter.emit(EVENT.MESSAGE_REVOKED, {
-          messageID: ID,
-        });
-
-        logger.log('Popup message revoked and closed', ID);
-      } else {
-        try {
-          this.sendMessageRevokeToServiceWorker(ID);
-          logger.log('Message revoke sent to service worker', ID);
-        } catch (error) {
-          logger.error(
-            'Failed to send message revoke to service worker',
-            error
-          );
-          this.eventEmitter.emit(EVENT.MESSAGE_REVOKED, {
-            messageID: ID,
-          });
-        }
-      }
-    });
-  }
-
-  private addChatListener() {
-    if (!this.chat) return;
-
-    try {
-      this.chat.on(
-        ChatSDK.EVENT.WEB_PUSH_MESSAGE_RECEIVED,
-        this.onMessageReceived.bind(this)
-      );
-      this.chat.on(
-        ChatSDK.EVENT.MESSAGE_REVOKED,
-        this.onMessageRevoked.bind(this)
-      );
-      logger.log('Chat listeners added for online push');
-    } catch (error) {
-      logger.error('Failed to add chat listeners', error);
-    }
-  }
-
-  private removeChatListener() {
-    if (!this.chat) return;
-
-    try {
-      this.chat.off(
-        ChatSDK.EVENT.WEB_PUSH_MESSAGE_RECEIVED,
-        this.onMessageReceived
-      );
-      this.chat.off(ChatSDK.EVENT.MESSAGE_REVOKED, this.onMessageRevoked);
-      logger.log('Chat listeners removed');
-    } catch (error) {
-      logger.error('Failed to remove chat listeners', error);
-    }
-  }
-
-  private getSystemPermissionMessage(browserName: string): string {
-    const userAgent = navigator.userAgent.toLowerCase();
-    const isMacOS = userAgent.includes('mac os');
-
-    if (isMacOS) {
-      return `For macOS: System Preferences > Notifications > ${browserName}, then enable notifications.`;
-    } else {
-      return `For Windows: Settings > Privacy > Notifications > ${browserName}, then enable notifications.`;
-    }
-  }
-
-  private showSystemPermissionAlert(browserName: string): void {
-    const message = this.getSystemPermissionMessage(browserName);
-    const fullMessage = `System notification permission for ${browserName}.\n\n${message}\n\nPlease refresh the page after enabling notifications.`;
-    alert(fullMessage);
-  }
-
-  private getBrowserInstType(): number {
-    const userAgent = navigator.userAgent.toLowerCase();
-
-    if (userAgent.includes('edg/')) {
-      return 3003; // Edge
-    } else if (userAgent.includes('yabrowser/')) {
-      return 3004; // Yandex
-    } else if (userAgent.includes('opr/') || userAgent.includes('opera/')) {
-      return 3005; // Opera
-    } else if (userAgent.includes('chrome/') && !userAgent.includes('edg/')) {
-      return 3000; // Chrome
-    } else if (userAgent.includes('firefox/')) {
-      return 3001; // Firefox
-    } else if (
-      userAgent.includes('safari/') &&
-      !userAgent.includes('chrome/')
-    ) {
-      return 3002; // Safari
-    } else {
-      return 1; // 未知或其他浏览器
-    }
-  }
-
-  private async setToken(subscriptionInfo: SubscriptionInfo): Promise<void> {
-    try {
-      const capability = browserSupport.detectWebPushCapability();
-      const browserInfo = browserSupport.getBrowserInfo();
-
-      const data = {
-        browserType: this.getBrowserInstType(),
-        pushToken: subscriptionInfo.endpoint,
-        webPushAuthKey: subscriptionInfo.auth,
-        webPushP256: subscriptionInfo.p256dh,
-        pushSDKVersion: version,
-        browserVersion: `${capability.browserName} ${capability.browserVersion}`,
-        browserPlatform: browserInfo.platform,
-        browserLanguage: browserInfo.language,
-      };
-
-      const res = await this.chat.callExperimentalAPI('setWebPushToken', data);
-      return res;
-    } catch (error) {
-      logger.error('Device registration failed', error);
-      throw error;
-    }
-  }
-
-  private async initializeBrowserCompatibility(): Promise<void> {
-    try {
-      const capability = browserSupport.detectWebPushCapability();
-
-      logger.log('Browser Web Push capability initialization completed', {
-        browser: `${capability.browserName} ${capability.browserVersion}`,
-        supported: capability.supported,
-        reason: capability.reason,
-      });
-
-      if (!capability.supported) {
-        logger.warn(
-          '[WebPush] Browser compatibility warning:',
-          capability.reason
-        );
-      }
-    } catch (error) {
-      logger.error('Browser compatibility initialization failed', error);
-    }
-  }
-
-  private setupVisibilityChangeListener(): void {
-    document.addEventListener('visibilitychange', () => {
-      if (
-        document.visibilityState === 'visible' &&
-        this.messagePopup &&
-        this.pendingMessages.length > 0
-      ) {
-        logger.log(
-          'Page became visible, showing pending messages',
-          this.pendingMessages.length
-        );
-
-        const messagesToShow = [...this.pendingMessages];
-        this.pendingMessages = [];
-
-        const timeout = setTimeout(() => {
-          messagesToShow.forEach((message) => {
-            if (this.messagePopup) {
-              this.messagePopup.show(message);
-            }
-          });
-          clearTimeout(timeout);
-        }, 100);
-      }
-    });
-  }
-
-  private setupInternalListeners(): void {
-    this.eventEmitter.on(
-      EVENT.MESSAGE_RECEIVED,
-      (message: NotificationMessage) => {
-        if (this.SDKAppID && this.registrationID && message.messageID) {
-          this.pushStatistics(message.messageID, 'reach');
-        }
-      }
-    );
-
-    this.eventEmitter.on(EVENT.NOTIFICATION_CLICKED, (data: any) => {
-      if (
-        this.SDKAppID &&
-        this.registrationID &&
-        data.notification?.messageID
-      ) {
-        this.pushStatistics(data.notification.messageID, 'click');
-      }
-    });
-  }
-
-  private async pushStatistics(messageID: string, type: string): Promise<void> {
-    try {
-      if (!this.chat) {
-        logger.warn('Chat SDK not initialized, skipping statistics');
-        return;
-      }
-
-      const data = {
-        messageID,
-        type,
-        timestamp: Date.now(),
-        SDKAppID: this.SDKAppID,
-        registrationID: this.registrationID,
-      };
-
-      // Call chat pushStatistics API
-      // await this.chat.callExperimentalAPI('pushStatistics', data);
-      logger.log(`Message ${type} statistics recorded`, data);
-    } catch (error) {
-      logger.error(`Failed to record message ${type} statistics`, error);
-    }
-  }
-
-  private clearState(): void {
-    this.isRegistered = false;
-    this.registrationID = '';
-    this.SDKAppID = 0;
-    this.appKey = '';
-    this.vapidPublicKey = '';
-    this.pendingMessages = []; // 清空待处理消息
-
-    // 清理弹窗
-    if (this.messagePopup) {
-      this.messagePopup.destroy();
-      this.messagePopup = null;
-    }
-  }
-
-  /**
-   * 向 service-worker 发送通知消息，使用与 push 事件相同的数据格式
-   * @param webpushInfo webpush 信息，格式与 SW push 事件接收的数据一致
-   */
-  private async sendNotificationToServiceWorker(
-    webpushInfo: any
-  ): Promise<void> {
-    try {
-      if (!this.serviceWorkerManager) {
-        logger.warn(
-          'ServiceWorkerManager not initialized, skipping notification'
-        );
-        return;
-      }
-
-      // 直接使用 webpushInfo 数据，格式与 push 事件一致
-      // 通过 ServiceWorkerManager 向 service-worker 发送消息，模拟 push 事件的处理
-      await this.serviceWorkerManager.postMessage({
-        type: 'PROCESS_WEBPUSH_DATA',
-        payload: webpushInfo,
-      });
-
-      logger.log('WebPush data sent to service-worker', webpushInfo);
-    } catch (error) {
-      logger.error('Failed to send webpush data to service-worker', error);
-    }
-  }
-
-  /**
-   * 向 service-worker 发送消息撤回请求
-   * @param messageID 要撤回的消息ID
-   */
-  private async sendMessageRevokeToServiceWorker(
-    messageID: string
-  ): Promise<void> {
-    try {
-      if (!this.serviceWorkerManager) {
-        logger.warn(
-          'ServiceWorkerManager not initialized, skipping message revoke'
-        );
-        return;
-      }
-
-      // 向 ServiceWorker 发送消息撤回请求
-      await this.serviceWorkerManager.postMessage({
-        type: 'REVOKE_MESSAGE',
-        payload: { messageID },
-      });
-
-      logger.log('Message revoke sent to service-worker', messageID);
-    } catch (error) {
-      logger.error('Failed to send message revoke to service-worker', error);
-      throw error;
-    }
-  }
-}