@tencentcloud/web-push 1.0.3 → 1.0.4

package/src/__tests__/types.test.ts

@@ -1,303 +0,0 @@
-/**
- * 类型定义测试
- */
-import {
-  EVENT,
-  RegisterPushOptions,
-  NotificationMessage,
-  NotificationClickData,
-  StatisticsData,
-  Message,
-  MessageReceivedResult,
-  MessageRevokedResult,
-  MessageNotificationClickedResult,
-  EventResult,
-  WebPushSDK,
-  ServiceWorkerMessage,
-  SubscriptionInfo,
-} from '../types';
-
-describe('类型定义测试', () => {
-  describe('EVENT 枚举测试', () => {
-    it('应该包含所有必需的事件类型', () => {
-      expect(EVENT.MESSAGE_RECEIVED).toBe('message_received');
-      expect(EVENT.MESSAGE_REVOKED).toBe('message_revoked');
-      expect(EVENT.NOTIFICATION_CLICKED).toBe('notification_clicked');
-    });
-
-    it('EVENT 应该是只读的', () => {
-      // TypeScript 编译时会检查这个，运行时我们验证值的正确性
-      expect(Object.keys(EVENT)).toHaveLength(3);
-      expect(Object.values(EVENT)).toEqual([
-        'message_received',
-        'message_revoked',
-        'notification_clicked',
-      ]);
-    });
-  });
-
-  describe('Event 类型测试', () => {
-    it('应该接受有效的事件类型', () => {
-      const validEvents: EVENT[] = [
-        EVENT.MESSAGE_RECEIVED,
-        EVENT.MESSAGE_REVOKED,
-        EVENT.NOTIFICATION_CLICKED,
-      ];
-
-      validEvents.forEach((event) => {
-        expect(typeof event).toBe('string');
-        expect(Object.values(EVENT)).toContain(event);
-      });
-    });
-  });
-
-  describe('RegisterPushOptions 接口测试', () => {
-    it('应该包含必需的属性', () => {
-      const options: RegisterPushOptions = {
-        SDKAppID: 123456,
-        appKey: 'test-app-key',
-        userID: 'test-user-id',
-      };
-
-      expect(typeof options.SDKAppID).toBe('number');
-      expect(typeof options.appKey).toBe('string');
-      expect(typeof options.userID).toBe('string');
-    });
-
-    it('应该支持可选的 serviceWorkerPath', () => {
-      const optionsWithSW: RegisterPushOptions = {
-        SDKAppID: 123456,
-        appKey: 'test-app-key',
-        userID: 'test-user-id',
-        serviceWorkerPath: '/custom-sw.js',
-      };
-
-      expect(typeof optionsWithSW.serviceWorkerPath).toBe('string');
-    });
-  });
-
-  describe('NotificationMessage 接口测试', () => {
-    it('应该包含必需的属性', () => {
-      const message: NotificationMessage = {
-        messageID: 'msg-123',
-        title: 'Test Title',
-        body: 'Test Body',
-        timestamp: Date.now(),
-      };
-
-      expect(typeof message.messageID).toBe('string');
-      expect(typeof message.title).toBe('string');
-      expect(typeof message.body).toBe('string');
-      expect(typeof message.timestamp).toBe('number');
-    });
-
-    it('应该支持可选属性', () => {
-      const messageWithOptional: NotificationMessage = {
-        messageID: 'msg-123',
-        title: 'Test Title',
-        body: 'Test Body',
-        timestamp: Date.now(),
-        icon: '/icon.png',
-        tag: 'test-tag',
-        data: { custom: 'data' },
-      };
-
-      expect(typeof messageWithOptional.icon).toBe('string');
-      expect(typeof messageWithOptional.tag).toBe('string');
-      expect(typeof messageWithOptional.data).toBe('object');
-    });
-  });
-
-  describe('NotificationClickData 接口测试', () => {
-    it('应该包含通知对象', () => {
-      const message: NotificationMessage = {
-        messageID: 'msg-123',
-        title: 'Test Title',
-        body: 'Test Body',
-        timestamp: Date.now(),
-      };
-
-      const clickData: NotificationClickData = {
-        notification: message,
-      };
-
-      expect(clickData.notification).toBe(message);
-    });
-
-    it('应该支持可选的 action', () => {
-      const message: NotificationMessage = {
-        messageID: 'msg-123',
-        title: 'Test Title',
-        body: 'Test Body',
-        timestamp: Date.now(),
-      };
-
-      const clickDataWithAction: NotificationClickData = {
-        notification: message,
-        action: 'reply',
-      };
-
-      expect(typeof clickDataWithAction.action).toBe('string');
-    });
-  });
-
-  describe('StatisticsData 接口测试', () => {
-    it('应该包含统计数据的所有属性', () => {
-      const statsData: StatisticsData = {
-        messageID: 'msg-123',
-        type: 'reach',
-        timestamp: Date.now(),
-        SDKAppID: 123456,
-        registrationID: 'reg-123',
-      };
-
-      expect(typeof statsData.messageID).toBe('string');
-      expect(['reach', 'click']).toContain(statsData.type);
-      expect(typeof statsData.timestamp).toBe('number');
-      expect(typeof statsData.SDKAppID).toBe('number');
-      expect(typeof statsData.registrationID).toBe('string');
-    });
-  });
-
-  describe('Message 接口测试', () => {
-    it('应该包含消息的所有必需属性', () => {
-      const message: Message = {
-        ID: 'msg-123',
-        type: 'TIMTextElem',
-        payload: { text: 'Hello' },
-        conversationID: 'conv-123',
-        conversationType: 'C2C',
-        to: 'user-456',
-        from: 'user-123',
-        flow: 'in',
-        time: Date.now(),
-        status: 'success',
-        isRevoked: false,
-        nick: 'Test User',
-        avatar: '/avatar.jpg',
-        isPeerRead: false,
-        nameCard: 'Test Card',
-        atUserList: [],
-        cloudCustomData: '{}',
-        isDeleted: false,
-        isModified: false,
-        needReadReceipt: false,
-        readReceiptInfo: {},
-        isBroadcastMessage: false,
-        isSupportExtension: true,
-        revoker: '',
-        sequence: 1,
-        progress: 100,
-        revokerInfo: {
-          userID: '',
-          nick: '',
-          avatar: '',
-        },
-        revokeReason: '',
-        hasRiskContent: false,
-      };
-
-      expect(typeof message.ID).toBe('string');
-      expect([
-        'TIMTextElem',
-        'TIMImageElem',
-        'TIMSoundElem',
-        'TIMVideoFileElem',
-        'TIMFileElem',
-        'TIMCustomElem',
-        'TIMRelayElem',
-        'TIMLocationElem',
-        'TIMFaceElem',
-      ]).toContain(message.type);
-      expect(['C2C', 'GROUP']).toContain(message.conversationType);
-    });
-  });
-
-  describe('WebPushSDK 接口测试', () => {
-    it('应该定义所有必需的方法', () => {
-      // 这个测试主要是类型检查，确保接口定义正确
-      const mockSDK: WebPushSDK = {
-        registerPush: jest.fn(),
-        unRegisterPush: jest.fn(),
-        addPushListener: jest.fn(),
-        removePushListener: jest.fn(),
-        EVENT: EVENT,
-      };
-
-      expect(typeof mockSDK.registerPush).toBe('function');
-      expect(typeof mockSDK.unRegisterPush).toBe('function');
-      expect(typeof mockSDK.addPushListener).toBe('function');
-      expect(typeof mockSDK.removePushListener).toBe('function');
-      expect(mockSDK.EVENT).toBe(EVENT);
-    });
-  });
-
-  describe('ServiceWorkerMessage 接口测试', () => {
-    it('应该支持所有消息类型', () => {
-      const messages: ServiceWorkerMessage[] = [
-        { type: 'MESSAGE_RECEIVED', data: {} },
-        { type: 'NOTIFICATION_CLICKED', data: {} },
-        { type: 'MESSAGE_REVOKED', data: {} },
-      ];
-
-      messages.forEach((msg) => {
-        expect([
-          'MESSAGE_RECEIVED',
-          'NOTIFICATION_CLICKED',
-          'MESSAGE_REVOKED',
-        ]).toContain(msg.type);
-        expect(msg.data).toBeDefined();
-      });
-    });
-  });
-
-  describe('SubscriptionInfo 接口测试', () => {
-    it('应该包含推送订阅的所有信息', () => {
-      const mockSubscription = {
-        endpoint: 'https://example.com/push',
-        keys: {
-          auth: 'mock-auth',
-          p256dh: 'mock-p256dh',
-        },
-      } as PushSubscription;
-
-      const subscriptionInfo: SubscriptionInfo = {
-        subscription: mockSubscription,
-        token: 'mock-token',
-        auth: 'mock-auth',
-        p256dh: 'mock-p256dh',
-      };
-
-      expect(subscriptionInfo.subscription).toBe(mockSubscription);
-      expect(typeof subscriptionInfo.token).toBe('string');
-      expect(typeof subscriptionInfo.auth).toBe('string');
-      expect(typeof subscriptionInfo.p256dh).toBe('string');
-    });
-  });
-
-  describe('EventResult 联合类型测试', () => {
-    it('应该支持所有事件结果类型', () => {
-      const messageReceived: EventResult = {
-        data: {
-          message: {} as Message,
-        } as MessageReceivedResult,
-      };
-
-      const messageRevoked: EventResult = {
-        data: {
-          messageID: 'msg-123',
-        } as MessageRevokedResult,
-      };
-
-      const notificationClicked: EventResult = {
-        data: {
-          ext: 'extension-data',
-        } as MessageNotificationClickedResult,
-      };
-
-      expect(messageReceived.data).toBeDefined();
-      expect(messageRevoked.data).toBeDefined();
-      expect(notificationClicked.data).toBeDefined();
-    });
-  });
-});

package/src/__tests__/web-push-sdk.test.ts

@@ -1,257 +0,0 @@
-/**
- * WebPushSDK 简化单元测试
- */
-import { WebPushSDK } from '../core/web-push-sdk';
-import { EVENT, RegisterPushOptions } from '../types';
-import { ValidationError } from '../utils/validator';
-
-describe('WebPushSDK 对外接口测试', () => {
-  let webPushSDK: WebPushSDK;
-
-  beforeEach(() => {
-    // 重置单例实例
-    (WebPushSDK as unknown as { instance: undefined }).instance = undefined;
-    webPushSDK = WebPushSDK.getInstance();
-
-    // 清除所有 mock
-    jest.clearAllMocks();
-  });
-
-  describe('单例模式测试', () => {
-    it('应该返回同一个实例', () => {
-      const instance1 = WebPushSDK.getInstance();
-      const instance2 = WebPushSDK.getInstance();
-
-      expect(instance1).toBe(instance2);
-      expect(instance1).toBeInstanceOf(WebPushSDK);
-    });
-  });
-
-  describe('EVENT 常量测试', () => {
-    it('应该暴露正确的事件常量', () => {
-      expect(webPushSDK.EVENT).toEqual(EVENT);
-      expect(webPushSDK.EVENT.MESSAGE_RECEIVED).toBe('message_received');
-      expect(webPushSDK.EVENT.MESSAGE_REVOKED).toBe('message_revoked');
-      expect(webPushSDK.EVENT.NOTIFICATION_CLICKED).toBe(
-        'notification_clicked'
-      );
-    });
-  });
-
-  describe('registerPush() 接口测试', () => {
-    const validOptions: RegisterPushOptions = {
-      SDKAppID: 123456,
-      appKey: 'test-app-key',
-      userID: 'test-user-id',
-    };
-
-    it('应该成功注册推送服务', async () => {
-      const registrationID = await webPushSDK.registerPush(validOptions);
-
-      expect(registrationID).toBe(validOptions.userID);
-    });
-
-    it('应该验证必需参数', async () => {
-      await expect(webPushSDK.registerPush()).rejects.toThrow(ValidationError);
-
-      await expect(
-        webPushSDK.registerPush({} as RegisterPushOptions)
-      ).rejects.toThrow(ValidationError);
-
-      await expect(
-        webPushSDK.registerPush({
-          SDKAppID: 123456,
-          appKey: '',
-          userID: 'test-user',
-        })
-      ).rejects.toThrow(ValidationError);
-    });
-
-    it('应该处理重复注册的情况', async () => {
-      // 第一次注册
-      await webPushSDK.registerPush(validOptions);
-
-      // 第二次注册应该先注销再重新注册
-      const registrationID = await webPushSDK.registerPush({
-        ...validOptions,
-        userID: 'new-user-id',
-      });
-
-      expect(registrationID).toBe('new-user-id');
-    });
-  });
-
-  describe('unRegisterPush() 接口测试', () => {
-    beforeEach(async () => {
-      // 先注册一个推送服务
-      await webPushSDK.registerPush({
-        SDKAppID: 123456,
-        appKey: 'test-app-key',
-        userID: 'test-user-id',
-      });
-    });
-
-    it('应该成功反注册推送服务', async () => {
-      const result = await webPushSDK.unRegisterPush();
-
-      expect(result).toBe(true);
-    });
-
-    it('应该处理未注册状态的反注册', async () => {
-      // 先反注册一次
-      await webPushSDK.unRegisterPush();
-
-      // 再次反注册应该仍然返回 true
-      const result = await webPushSDK.unRegisterPush();
-      expect(result).toBe(true);
-    });
-  });
-
-  describe('addPushListener() 接口测试', () => {
-    const mockListener = jest.fn();
-
-    beforeEach(() => {
-      mockListener.mockClear();
-    });
-
-    it('应该成功添加推送监听器', () => {
-      const listenerId = webPushSDK.addPushListener(
-        EVENT.MESSAGE_RECEIVED,
-        mockListener
-      );
-
-      expect(typeof listenerId).toBe('string');
-      expect(listenerId.length).toBeGreaterThan(0);
-    });
-
-    it('应该验证事件类型参数', () => {
-      expect(() => {
-        webPushSDK.addPushListener('invalid_event' as EVENT, mockListener);
-      }).toThrow(ValidationError);
-    });
-
-    it('应该验证监听器参数', () => {
-      expect(() => {
-        webPushSDK.addPushListener(
-          EVENT.MESSAGE_RECEIVED,
-          null as unknown as () => void
-        );
-      }).toThrow(ValidationError);
-
-      expect(() => {
-        webPushSDK.addPushListener(
-          EVENT.MESSAGE_RECEIVED,
-          'not_a_function' as unknown as () => void
-        );
-      }).toThrow(ValidationError);
-    });
-
-    it('应该支持所有事件类型', () => {
-      const listener1 = webPushSDK.addPushListener(
-        EVENT.MESSAGE_RECEIVED,
-        mockListener
-      );
-      const listener2 = webPushSDK.addPushListener(
-        EVENT.MESSAGE_REVOKED,
-        mockListener
-      );
-      const listener3 = webPushSDK.addPushListener(
-        EVENT.NOTIFICATION_CLICKED,
-        mockListener
-      );
-
-      expect(listener1).toBeTruthy();
-      expect(listener2).toBeTruthy();
-      expect(listener3).toBeTruthy();
-    });
-
-    it('应该支持同一事件添加多个监听器', () => {
-      const listener1 = jest.fn();
-      const listener2 = jest.fn();
-
-      const id1 = webPushSDK.addPushListener(EVENT.MESSAGE_RECEIVED, listener1);
-      const id2 = webPushSDK.addPushListener(EVENT.MESSAGE_RECEIVED, listener2);
-
-      expect(id1).not.toBe(id2);
-    });
-  });
-
-  describe('removePushListener() 接口测试', () => {
-    const mockListener = jest.fn();
-
-    beforeEach(() => {
-      mockListener.mockClear();
-    });
-
-    it('应该成功移除推送监听器', () => {
-      webPushSDK.addPushListener(EVENT.MESSAGE_RECEIVED, mockListener);
-
-      const result = webPushSDK.removePushListener(
-        EVENT.MESSAGE_RECEIVED,
-        mockListener
-      );
-      expect(result).toBe(true);
-    });
-
-    it('应该验证事件类型参数', () => {
-      expect(() => {
-        webPushSDK.removePushListener('invalid_event' as EVENT, mockListener);
-      }).toThrow(ValidationError);
-    });
-
-    it('应该验证监听器参数', () => {
-      expect(() => {
-        webPushSDK.removePushListener(
-          EVENT.MESSAGE_RECEIVED,
-          null as unknown as () => void
-        );
-      }).toThrow(ValidationError);
-
-      expect(() => {
-        webPushSDK.removePushListener(
-          EVENT.MESSAGE_RECEIVED,
-          'not_a_function' as unknown as () => void
-        );
-      }).toThrow(ValidationError);
-    });
-
-    it('应该处理移除不存在的监听器', () => {
-      const nonExistentListener = jest.fn();
-
-      const result = webPushSDK.removePushListener(
-        EVENT.MESSAGE_RECEIVED,
-        nonExistentListener
-      );
-      expect(result).toBe(false);
-    });
-
-    it('应该只移除指定的监听器', () => {
-      const listener1 = jest.fn();
-      const listener2 = jest.fn();
-
-      webPushSDK.addPushListener(EVENT.MESSAGE_RECEIVED, listener1);
-      webPushSDK.addPushListener(EVENT.MESSAGE_RECEIVED, listener2);
-
-      const result1 = webPushSDK.removePushListener(
-        EVENT.MESSAGE_RECEIVED,
-        listener1
-      );
-      expect(result1).toBe(true);
-
-      // listener2 应该仍然存在
-      const result2 = webPushSDK.removePushListener(
-        EVENT.MESSAGE_RECEIVED,
-        listener2
-      );
-      expect(result2).toBe(true);
-    });
-  });
-
-  describe('错误处理测试', () => {
-    it('应该正确处理 ValidationError', async () => {
-      await expect(
-        webPushSDK.registerPush({} as RegisterPushOptions)
-      ).rejects.toBeInstanceOf(ValidationError);
-    });
-  });
-});