@tencentcloud/web-push 1.0.2 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/web-push",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Tencent Cloud Web Push SDK - Service Worker-based web push notification service",
   "main": "index.umd.js",
   "module": "index.esm.js",

package/src/components/message-popup.d.ts

@@ -0,0 +1,63 @@
+import { StandardMessage, HtmlMessage } from '../types';
+export interface PopupConfig {
+    /** 是否启用弹窗 */
+    enabled?: boolean;
+    /** 弹窗显示时长（毫秒），0 表示不自动关闭 */
+    duration?: number;
+    /** 弹窗位置 */
+    position?: 'center' | 'top-left' | 'top-center' | 'top-right' | 'right-center' | 'bottom-right' | 'bottom-center' | 'bottom-left' | 'left-center';
+    /** 最大显示数量 */
+    maxCount?: number;
+    /** 是否显示关闭按钮 */
+    showCloseButton?: boolean;
+    /** 是否允许点击弹窗 */
+    clickable?: boolean;
+    /** 自定义渲染函数 */
+    customRender?: (message: any, container: HTMLElement) => HTMLElement;
+    /** 点击回调 */
+    onClick?: (message: any, popup: HTMLElement) => void;
+    /** 关闭回调 */
+    onClose?: (message: any, popup: HTMLElement) => void;
+}
+export declare class MessagePopup {
+    private container;
+    private popups;
+    private timers;
+    private messageHandlers;
+    private animationTimers;
+    private adjustHeightTimers;
+    private config;
+    private readonly defaultConfig;
+    constructor(config?: PopupConfig);
+    private init;
+    private createContainer;
+    private injectStyles;
+    show(message: StandardMessage | HtmlMessage): void;
+    private createStandardPopup;
+    private createHtmlPopup;
+    private addPopup;
+    private removeOldestPopup;
+    close(messageId: string): void;
+    /**
+     * 检查指定消息是否正在显示弹窗
+     * @param messageId 消息ID
+     * @returns 是否正在显示
+     */
+    hasMessage(messageId: string): boolean;
+    closeAll(): void;
+    updateConfig(newConfig: Partial<PopupConfig>): void;
+    destroy(): void;
+    /**
+     * 根据 Placement 值应用容器位置
+     * 0-中间，1-左上，2-上中，3-右上，4-右中，5-右下，6-下中，7-左下，8-左中
+     */
+    private applyPlacement;
+    /**
+     * 调整iframe高度以适应内容
+     */
+    private adjustIframeHeight;
+    /**
+     * 创建iframe的完整HTML文档
+     */
+    private createIframeHtml;
+}

package/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/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/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/src/types/outer.d.ts

@@ -1,3 +1,15 @@
+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>;
@@ -10,50 +22,92 @@ export interface RegisterPushOptions {
     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"
+    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 Message {
-    ID: String;
-    type: 'TIMTextElem' | 'TIMImageElem' | 'TIMSoundElem' | 'TIMVideoFileElem' | 'TIMFileElem' | 'TIMCustomElem' | 'TIMRelayElem' | 'TIMLocationElem' | 'TIMFaceElem';
-    payload: any;
-    conversationID: String;
-    conversationType: 'C2C' | 'GROUP';
-    to: String;
-    from: String;
-    flow: String;
-    time: Number;
-    status: String;
-    isRevoked: Boolean;
-    nick: String;
-    avatar: String;
-    isPeerRead: Boolean;
-    nameCard: String;
-    atUserList: String[];
-    cloudCustomData: String;
-    isDeleted: Boolean;
-    isModified: Boolean;
-    needReadReceipt: Boolean;
-    readReceiptInfo: any;
-    isBroadcastMessage: Boolean;
-    isSupportExtension: Boolean;
-    receiverList?: String[];
-    revoker: String;
-    sequence: Number;
-    progress: Number;
-    revokerInfo: {
-        userID: String;
-        nick: String;
-        avatar: String;
+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;
+        }>;
     };
-    revokeReason: String;
-    hasRiskContent: Boolean;
+    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: Message;
+    message: PushMessage | NotificationMessage;
 }
 export interface MessageRevokedResult {
     messageID: String;

package/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/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/sw.js

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