@tencentcloud/web-push 1.0.2 → 1.0.3

package/{src → dist/src}/core/web-push-sdk.d.ts

@@ -3,12 +3,14 @@ export declare class WebPushSDK implements IWebPushSDK {
     static instance: WebPushSDK;
     private eventEmitter;
     private serviceWorkerManager;
+    private messagePopup;
     private isRegistered;
     private registrationID;
     private chat;
     private SDKAppID;
     private appKey;
     private vapidPublicKey;
+    private pendingMessages;
     EVENT: typeof EVENT;
     VERSION: string;
     constructor();
@@ -16,16 +18,36 @@ export declare class WebPushSDK implements IWebPushSDK {
     registerPush(options?: RegisterPushOptions): Promise<string>;
     unRegisterPush(): Promise<boolean>;
     addPushListener(eventName: EVENT, listener: Function): string;
+    /**
+     * 内部方法：向 Service Worker 发送日志级别配置
+     * @param logLevel 日志级别 0-4
+     */
+    private sendLogLevelToServiceWorker;
     removePushListener(eventName: EVENT, listener: Function): boolean;
     private checkBrowserSupport;
     private requestNotificationPermission;
-    private chatLogin;
+    private pushLogin;
+    private onMessageReceived;
+    private onMessageRevoked;
+    private addChatListener;
+    private removeChatListener;
     private getSystemPermissionMessage;
     private showSystemPermissionAlert;
     private getBrowserInstType;
     private setToken;
     private initializeBrowserCompatibility;
+    private setupVisibilityChangeListener;
     private setupInternalListeners;
     private pushStatistics;
     private clearState;
+    /**
+     * 向 service-worker 发送通知消息，使用与 push 事件相同的数据格式
+     * @param webpushInfo webpush 信息，格式与 SW push 事件接收的数据一致
+     */
+    private sendNotificationToServiceWorker;
+    /**
+     * 向 service-worker 发送消息撤回请求
+     * @param messageID 要撤回的消息ID
+     */
+    private sendMessageRevokeToServiceWorker;
 }

package/{src → dist/src}/index.d.ts

@@ -1,5 +1,6 @@
 import { WebPushSDK } from './core/web-push-sdk';
 export * from './types/outer';
+export { MessagePopup } from './components/message-popup';
 declare const webPush: WebPushSDK;
 export { webPush };
 export default webPush;

package/{src → dist/src}/types/inner.d.ts

@@ -1,14 +1,6 @@
-export interface PushMessage {
-    messageID: string;
-    title: string;
-    body: string;
-    icon?: string;
-    tag?: string;
-    data?: any;
-    timestamp: number;
-}
+import { NotificationMessage } from "./outer";
 export interface NotificationClickData {
-    notification: PushMessage;
+    notification: NotificationMessage;
     action?: string;
 }
 export interface StatisticsData {

package/dist/src/types/outer.d.ts

@@ -0,0 +1,120 @@
+export type LogLevel = 0 | 1 | 2 | 3 | 4;
+export declare enum Placement {
+    CENTER = 0,// 中间
+    TOP_LEFT = 1,// 左上
+    TOP_CENTER = 2,// 上中
+    TOP_RIGHT = 3,// 右上
+    MIDDLE_RIGHT = 4,// 右中
+    BOTTOM_RIGHT = 5,// 右下
+    BOTTOM_CENTER = 6,// 下中
+    BOTTOM_LEFT = 7,// 左下
+    MIDDLE_LEFT = 8
+}
+export interface WebPushSDK {
+    registerPush(options?: RegisterPushOptions): Promise<any>;
+    unRegisterPush(): Promise<any>;
+    addPushListener(eventName: EVENT, listener: (data: EventResult) => void): any;
+    removePushListener(eventName: EVENT, listener: (data: EventResult) => void): any;
+}
+export interface RegisterPushOptions {
+    SDKAppID: number;
+    appKey: string;
+    userID: string;
+    serviceWorkerPath?: string;
+    chat?: any;
+    /**
+     * 日志级别：
+     * 0 - 普通级别，日志量较多，接入时建议使用
+     * 1 - release级别，SDK 输出关键信息，生产环境时建议使用（默认）
+     * 2 - 告警级别，SDK 只输出告警和错误级别的日志
+     * 3 - 错误级别，SDK 只输出错误级别的日志
+     * 4 - 无日志级别，SDK 将不打印任何日志
+     */
+    logLevel?: LogLevel;
+}
+export declare enum EVENT {
+    MESSAGE_RECEIVED = "message_received",
+    MESSAGE_REVOKED = "message_revoked",
+    NOTIFICATION_CLICKED = "notification_clicked",
+    CUSTOM_MESSAGE_RECEIVED = "custom_message_received"
+}
+export interface NotificationMessage {
+    messageID: string;
+    title: string;
+    body: string;
+    icon?: string;
+    tag?: string;
+    data?: any;
+    timestamp: number;
+}
+export interface StandardMessage {
+    id: string;
+    MsgType: 'standard';
+    MsgContent: {
+        Text: {
+            Title: string;
+            Desc: string;
+        };
+        Image?: {
+            URL: string;
+            LinkURL: string;
+        };
+        Close: 0 | 1;
+        Placement?: Placement;
+        Duration?: number;
+        Button?: Array<{
+            Text: string;
+            Icon?: string;
+            Url: string;
+        }>;
+    };
+    Ext?: string;
+}
+export interface HtmlMessage {
+    id: string;
+    MsgType: 'html';
+    MsgContent: {
+        Placement?: Placement;
+        Duration?: number;
+        Html: string;
+    };
+    Ext?: string;
+}
+export interface CustomMessage {
+    id: string;
+    MsgType: 'custom';
+    MsgContent: {
+        Data: string | object;
+    };
+    Ext?: string;
+}
+export interface WebPushInfo {
+    Title: string;
+    Desc: string;
+    Icon: string;
+    Image: string;
+    URL: string;
+}
+export interface WebPushExt {
+    WebpushReportUrl: string;
+    OnlineClickExt: string;
+    TaskId: string;
+}
+export type PushMessage = StandardMessage | HtmlMessage | CustomMessage;
+export interface MessageReceivedData {
+    content: string;
+    info: WebPushInfo;
+    extension: WebPushExt;
+}
+export interface MessageReceivedResult {
+    message: PushMessage | NotificationMessage;
+}
+export interface MessageRevokedResult {
+    messageID: String;
+}
+export interface MessageNotificationClickedResult {
+    ext: String;
+}
+export interface EventResult {
+    data: MessageReceivedResult | MessageRevokedResult | MessageNotificationClickedResult;
+}

package/{src → dist/src}/utils/logger.d.ts

@@ -1,10 +1,16 @@
+import { LogLevel } from '../types/outer';
 export declare class Logger {
     private static instance;
+    private logLevel;
     private constructor();
     static getInstance(): Logger;
+    setLogLevel(level: LogLevel): void;
+    getLogLevel(): LogLevel;
+    private shouldLog;
     log(message: string, ...args: any[]): void;
     warn(message: string, ...args: any[]): void;
     error(message: string, ...args: any[]): void;
     info(message: string, ...args: any[]): void;
+    debug(message: string, ...args: any[]): void;
 }
 export declare const logger: Logger;

package/{src → dist/src}/utils/validator.d.ts

@@ -37,21 +37,8 @@ export declare class Validator {
     static validateEventType(eventType: any): void;
     static validateListener(listener: any): void;
     static validateRegisterPushOptions(options: any): void;
-    static validatePushMessage(message: any): void;
-    /**
-     * Validate URL format
-     */
-    static validateURL(url: any, fieldName?: string): void;
     /**
      * Validate Service Worker path
      */
     static validateServiceWorkerPath(path: any): void;
 }
-/**
- * Parameter validation decorator
- */
-export declare function validateParams(schema: ValidationSchema): (_target: any, _propertyName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-/**
- * Single parameter validation decorator
- */
-export declare function validateParam(paramIndex: number, rule: ValidationRule): (_target: any, _propertyName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/sw.js

@@ -0,0 +1 @@
+!function(){"use strict";let t=1;function e(e){return 4!==t&&e>=t}function a(t,...a){e(1)&&console.log(`[WebPush SW] ${t}`,...a)}function i(t,...a){e(2)&&console.warn(`[WebPush SW] ${t}`,...a)}function n(t,...a){e(3)&&console.error(`[WebPush SW] ${t}`,...a)}async function o(t,e={}){const{shouldReport:a=!0,clickEventType:i=2}=e,n={messageID:t.id||Date.now().toString(36)+Math.random().toString(36).substring(2),title:t.title||"New Message",body:t.desc||"You have a new message",icon:t.icon||"",tag:t.tag||t?.id?.slice(-100)||"push-"+Date.now()+"-"+Math.random().toString(36).substring(2,7),data:{url:t.url,image:t.image,rptExt:t.rptExt,rptURL:t.rptURL,clickEventType:i},timestamp:Date.now()},o=self.registration.showNotification(n.title,{body:n.body,icon:n.icon,image:t.image,tag:n.tag,data:n,requireInteraction:!1}),l=r({type:"MESSAGE_RECEIVED",data:s(n)}),d=a&&t.rptURL&&t.rptExt?c({id:t.id,rptURL:t.rptURL,rptExt:t.rptExt,eventType:1}):Promise.resolve();await Promise.all([o,l,d])}function s(t){return{messageID:t.messageID,title:t.title,body:t.body,icon:t.icon,tag:t.tag,data:{url:t.data?.url,image:t.data?.image},timestamp:t.timestamp}}async function r(t){try{(await self.clients.matchAll({includeUncontrolled:!0,type:"window"})).forEach(e=>{e.postMessage(t)})}catch(e){n("Failed to send message to clients",e)}}async function c(t){try{if(!t.rptURL||!t.rptExt)return void i("Missing rptURL or rptExt, skipping report");const e={webpushEvents:[{id:t.id,EventType:t.eventType||1,EventTime:Math.floor(Date.now()/1e3),rptExt:t.rptExt}]};a("Reporting WebPush event",{rptURL:t.rptURL,reportData:e});const n=await fetch(t.rptURL,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)});n.ok?a("WebPush event reported successfully"):i("Failed to report WebPush event",n.status,n.statusText)}catch(e){n("Error reporting WebPush event",e)}}self.addEventListener("install",t=>{a("Service Worker installing..."),self.skipWaiting()}),self.addEventListener("activate",t=>{a("Service Worker activating..."),t.waitUntil(self.clients.claim())}),self.addEventListener("push",t=>{if(a("Push message received",t),t.data)try{const e=function(t){if(!t)throw new Error("No push data available");try{const e=t.json();return a("Push message data (JSON):",e),e}catch{const e=t.text();return a("Push message data (Text):",e),{id:"",title:"WebPush Notification",desc:e||"You have a new message",url:"/",icon:"",tag:"",image:"",rptExt:"",rptURL:""}}}(t.data);t.waitUntil(o(e))}catch(e){n("Failed to process push message",e),t.waitUntil(self.registration.showNotification("WebPush Notification",{body:"You have a new message",tag:"fallback"}))}else i("Push message has no data")}),self.addEventListener("notificationclick",t=>{a("Notification clicked",t);const e=t.notification,o=t.action,l=e.data;if(e.close(),"close"===o)return;const d=r({type:"NOTIFICATION_CLICKED",data:{notification:s(l),action:o}}),u=async function(t="/"){try{a("Attempting to open or focus window with URL:",t);const n=await self.clients.matchAll({type:"window",includeUncontrolled:!0});let o;a("Found clients:",n.length);try{o=t.startsWith("http://")||t.startsWith("https://")?t:new URL(t,self.location.origin).href}catch(e){i("Invalid URL, using origin:",t,e),o=self.location.origin}a("Full target URL:",o);for(const t of n)if(t.url===o&&"focus"in t)return void(await t.focus());self.clients.openWindow&&await self.clients.openWindow(o)}catch(e){n("Failed to open or focus window",e)}}(l?.data?.url||"/"),p=l?.data?.clickEventType||2,f=l?.data?.rptURL&&l?.data?.rptExt?c({id:l.messageID,rptURL:l.data.rptURL,rptExt:l.data.rptExt,eventType:p}):Promise.resolve();t.waitUntil(Promise.all([d,u,f]))}),self.addEventListener("notificationclose",t=>{a("Notification closed",t)}),self.addEventListener("message",e=>{a("Message received from main thread",e.data);const{type:i,payload:s}=e.data;switch(i){case"SHOW_NOTIFICATION":!async function(t){try{const{eventType:e,data:i,options:n}=t;a("Handling show notification request",{eventType:e,data:i,options:n}),await self.registration.showNotification(n.title,{body:n.body,icon:n.icon,badge:n.badge,tag:n.tag,requireInteraction:n.requireInteraction,silent:n.silent,data:n.data}),a("Notification shown successfully",n.title)}catch(e){n("Failed to handle show notification",e)}}(s);break;case"PROCESS_WEBPUSH_DATA":!async function(t){try{a("Handling webpush data from main thread",t),await o(t,{shouldReport:!1,clickEventType:3}),a("WebPush notification processed successfully")}catch(e){n("Failed to handle webpush data",e);try{await self.registration.showNotification("WebPush Notification",{body:"You have a new message",tag:"fallback"})}catch(i){n("Failed to show fallback notification",i)}}}(s);break;case"REVOKE_MESSAGE":!async function(t){try{(await self.registration.getNotifications()).forEach(e=>{e.data&&e.data.messageID===t&&e.close()}),await r({type:"MESSAGE_REVOKED",data:{messageID:t}})}catch(e){n("Failed to handle message revocation",e)}}(s.messageID);break;case"SET_LOG_LEVEL":l=s.logLevel,t=l,a("Log level updated to:",l);break;case"REPORT_WEBPUSH_EVENT":c(s)}var l}),self.addEventListener("error",t=>{n("Service Worker error",t.error)}),self.addEventListener("unhandledrejection",t=>{n("Service Worker unhandled promise rejection",t.reason)})}();

package/package.json

@@ -1,21 +1,41 @@
 {
   "name": "@tencentcloud/web-push",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Tencent Cloud Web Push SDK - Service Worker-based web push notification service",
-  "main": "index.umd.js",
-  "module": "index.esm.js",
-  "types": "index.d.ts",
+  "main": "dist/index.umd.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "import": "./index.esm.js",
-      "require": "./index.umd.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.umd.js"
     },
-    "./sw": "./sw.js"
+    "./sw": "./dist/sw.js"
   },
   "files": [
-    "**/*"
+    "dist",
+    "src"
   ],
+  "scripts": {
+    "dev": "vite",
+    "build": "rm -rf dist && vite build && npm run build:sw && npm run build:types",
+    "build:sw": "vite build --config vite.sw.config.ts",
+    "build:types": "tsc --project tsconfig.build.json",
+    "build:release": "node scripts/build-release.js",
+    "preview": "vite preview",
+    "test": "jest --verbose",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts,.js",
+    "lint:fix": "eslint src --ext .ts,.js --fix",
+    "format": "prettier --write \"src/**/*.{ts,js,json,md}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,js,json,md}\"",
+    "type-check": "tsc --noEmit",
+    "pre-commit": "lint-staged",
+    "prepare": "husky install",
+    "prepublish": "npm run build && npm run lint && npm run build:release",
+    "publish": "cd dist && npm publish --access public"
+  },
   "keywords": [
     "web-push",
     "service-worker",
@@ -24,6 +44,24 @@
   ],
   "author": "Tencent Cloud",
   "license": "MIT",
+  "devDependencies": {
+    "@babel/preset-env": "^7.28.3",
+    "@types/jest": "^29.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.46.1",
+    "@typescript-eslint/parser": "^8.46.1",
+    "chalk": "^5.6.2",
+    "eslint": "^8.50.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "lint-staged": "^16.2.4",
+    "prettier": "^3.6.2",
+    "terser": "^5.44.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.9",
+    "vite-plugin-dts": "^3.6.0"
+  },
   "peerDependencies": {
     "@tencentcloud/lite-chat": "^4.2.0"
   }

package/src/__tests__/index.test.ts

@@ -0,0 +1,120 @@
+/**
+ * 主入口文件测试
+ */
+import webPush, { webPush as namedExport, EVENT } from '../index';
+import type { RegisterPushOptions } from '../index';
+
+describe('主入口文件测试', () => {
+  describe('导出测试', () => {
+    it('应该导出默认的 webPush 实例', () => {
+      expect(webPush).toBeDefined();
+      expect(typeof webPush.registerPush).toBe('function');
+      expect(typeof webPush.unRegisterPush).toBe('function');
+      expect(typeof webPush.addPushListener).toBe('function');
+      expect(typeof webPush.removePushListener).toBe('function');
+    });
+
+    it('应该导出命名的 webPush 实例', () => {
+      expect(namedExport).toBeDefined();
+      expect(namedExport).toBe(webPush);
+    });
+
+    it('应该导出 EVENT 常量', () => {
+      expect(EVENT).toBeDefined();
+      expect(EVENT.MESSAGE_RECEIVED).toBe('message_received');
+      expect(EVENT.MESSAGE_REVOKED).toBe('message_revoked');
+      expect(EVENT.NOTIFICATION_CLICKED).toBe('notification_clicked');
+    });
+
+    it('应该通过实例获取版本号', () => {
+      expect(webPush.VERSION).toBeDefined();
+      expect(typeof webPush.VERSION).toBe('string');
+      expect(webPush.VERSION).toBe('0.1.0');
+    });
+
+    it('应该导出正确的 TypeScript 类型', () => {
+      // 这些测试主要是为了确保类型导出正确，在编译时会检查
+      const options: RegisterPushOptions = {
+        SDKAppID: 123456,
+        appKey: 'test-key',
+        userID: 'test-user',
+      };
+
+      const eventType = EVENT.MESSAGE_RECEIVED;
+
+      const message = {
+        messageID: 'test-id',
+        title: 'Test Title',
+        body: 'Test Body',
+        timestamp: Date.now(),
+      };
+
+      const clickData = {
+        notification: message,
+        action: 'default',
+      };
+
+      // 类型检查通过即可
+      expect(options).toBeDefined();
+      expect(eventType).toBeDefined();
+      expect(message).toBeDefined();
+      expect(clickData).toBeDefined();
+    });
+  });
+
+  describe('单例一致性测试', () => {
+    it('默认导出和命名导出应该是同一个实例', () => {
+      expect(webPush).toBe(namedExport);
+    });
+
+    it('多次导入应该返回同一个实例', () => {
+      // 重新导入模块
+      jest.resetModules();
+      const { default: webPush1, webPush: webPush2 } = require('../index');
+
+      expect(webPush1).toBe(webPush2);
+    });
+  });
+
+  describe('接口一致性测试', () => {
+    it('实例应该实现 IWebPushSDK 接口', () => {
+      // 检查所有必需的方法是否存在
+      expect(typeof webPush.registerPush).toBe('function');
+      expect(typeof webPush.unRegisterPush).toBe('function');
+      expect(typeof webPush.addPushListener).toBe('function');
+      expect(typeof webPush.removePushListener).toBe('function');
+      expect(webPush.EVENT).toBeDefined();
+    });
+
+    it('EVENT 属性应该与导出的 EVENT 常量一致', () => {
+      expect(webPush.EVENT).toEqual(EVENT);
+      expect(webPush.EVENT.MESSAGE_RECEIVED).toBe(EVENT.MESSAGE_RECEIVED);
+      expect(webPush.EVENT.MESSAGE_REVOKED).toBe(EVENT.MESSAGE_REVOKED);
+      expect(webPush.EVENT.NOTIFICATION_CLICKED).toBe(
+        EVENT.NOTIFICATION_CLICKED
+      );
+    });
+  });
+
+  describe('模块稳定性测试', () => {
+    it('应该能够安全地多次导入', () => {
+      expect(() => {
+        require('../index');
+        require('../index');
+        require('../index');
+      }).not.toThrow();
+    });
+
+    it('导出的对象应该是不可变的关键属性', () => {
+      // 验证 EVENT 对象的基本属性
+      expect(EVENT.MESSAGE_RECEIVED).toBe('message_received');
+      expect(EVENT.MESSAGE_REVOKED).toBe('message_revoked');
+      expect(EVENT.NOTIFICATION_CLICKED).toBe('notification_clicked');
+
+      // 验证 EVENT 对象包含所有必需的属性
+      expect(Object.keys(EVENT)).toContain('MESSAGE_RECEIVED');
+      expect(Object.keys(EVENT)).toContain('MESSAGE_REVOKED');
+      expect(Object.keys(EVENT)).toContain('NOTIFICATION_CLICKED');
+    });
+  });
+});