@tencentcloud/web-push 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,8 +1,24 @@
 # Changelog
 
+## [1.0.6] - 2025-02-11
+
+### Features
+
+- Added `showSystemPermissionAlert` parameter to control whether to display system permission alert popup
+
+### Changes
+
+- Optimized `serviceWorkerPath` parameter to support same-origin full URLs
+
+## [1.0.5] - 2025-02-02
+
+### Features
+
+- Support for webpushInfo ext pass-through fields
+
 ## [1.0.4] - 2025-01-27
 
-### Added
+### Features
 
 - **Online Push Popup Feature**: Real-time in-app message popup display to enhance user experience
 - **Multiple Message Type Support**: Standard (standard template), HTML (custom HTML), Custom (fully customizable)
@@ -10,17 +26,21 @@
 
 ## [1.0.2] - 2025-01-16
 
-- ✨ Added UMD build support for direct `<script>` tag integration
-- 📚 Enhanced UMD usage documentation and examples
+### Features
+
+- Added UMD build support for direct `<script>` tag integration
+- Enhanced UMD usage documentation and examples
 
 ## [1.0.1] - 2025-12-19
 
-- Optimize subscription logic
+### Changes
+
+- Optimized subscription logic
 - Optimized state persistence logic, only persisting VAPID public key while resetting temporary states each session
 
 ## [1.0.0] - 2025-12-17
 
-### Added
+### Features
 
 - 🎉 Initial release
 - ✨ Service Worker-based push notification support

package/README.md

@@ -125,6 +125,38 @@ In your homepage (for example: `index.js`), add `@tencentcloud/web-push` and reg
 
 <td rowspan="1" colSpan="1" >Register the userID for push services. User's Unique Identifier, defined by you, can only include uppercase and lowercase letters (a-z, A-Z), numbers (0-9), underscores, and hyphens.</td>
 </tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >serviceWorkerPath</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Optional. Custom Service Worker file path, defaults to '/sw.js'. Supports relative paths (e.g., './sw.js', '../sw.js') or same-origin full URLs (e.g., 'https://example.com/sw.js').</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >logLevel</td>
+
+<td rowspan="1" colSpan="1" >Number</td>
+
+<td rowspan="1" colSpan="1" >Optional. Log level: 0-Normal level, 1-Release level (default), 2-Warning level, 3-Error level, 4-No log level.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >showSystemPermissionAlert</td>
+
+<td rowspan="1" colSpan="1" >Boolean</td>
+
+<td rowspan="1" colSpan="1" >Optional. Whether to show system permission alert popup, defaults to true. Set to false to disable permission setting prompt.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >chat</td>
+
+<td rowspan="1" colSpan="1" >Object</td>
+
+<td rowspan="1" colSpan="1" >Optional. Initialized TencentCloudChat SDK instance, will be created automatically if not provided.</td>
+</tr>
 </table>
 
 ```javascript
@@ -218,16 +250,10 @@ interface RegisterPushOptions {
   SDKAppID: number;
   appKey: string;
   userID: string;
+  serviceWorkerPath?: string;
   chat?: any;
-  /**
-   * Log level:
-   * 0 - Normal level, more logs, recommended for integration
-   * 1 - Release level, SDK outputs key information, recommended for production (default)
-   * 2 - Warning level, SDK only outputs warning and error level logs
-   * 3 - Error level, SDK only outputs error level logs
-   * 4 - No log level, SDK will not print any logs
-   */
   logLevel?: LogLevel;
+  showSystemPermissionAlert?: boolean;
 }
 
 enum EVENT {

package/index.d.ts

@@ -152,6 +152,12 @@ export declare interface RegisterPushOptions {
      * 4 - 无日志级别，SDK 将不打印任何日志
      */
     logLevel?: LogLevel;
+    /**
+     * 是否显示系统权限提示弹窗
+     * true - 显示系统权限设置提示（默认）
+     * false - 不显示系统权限设置提示
+     */
+    showSystemPermissionAlert?: boolean;
 }
 
 export declare interface StandardMessage {
@@ -215,6 +221,7 @@ declare class WebPushSDK_2 implements WebPushSDK {
     private appKey;
     private vapidPublicKey;
     private pendingMessages;
+    private enableSystemPermissionAlert;
     EVENT: typeof EVENT;
     VERSION: string;
     constructor();

package/index.esm.js

@@ -1,5 +1,5 @@
 import ChatSDK from "@tencentcloud/lite-chat/professional";
-const version = "1.0.4";
+const version = "1.0.6";
 var Placement = /* @__PURE__ */ ((Placement2) => {
   Placement2[Placement2["CENTER"] = 0] = "CENTER";
   Placement2[Placement2["TOP_LEFT"] = 1] = "TOP_LEFT";
@@ -322,8 +322,37 @@ class Validator {
     this.validateValue("serviceWorkerPath", path, {
       required: false,
       type: "string",
-      pattern: /^[a-zA-Z0-9_./-]+\.js$/,
-      message: "serviceWorkerPath must be a valid JavaScript file path"
+      custom: (value) => {
+        if (!value || typeof value !== "string") {
+          return true;
+        }
+        let pathWithoutQuery = value;
+        if (value.includes("?")) {
+          pathWithoutQuery = value.split("?")[0];
+        }
+        if (!pathWithoutQuery.endsWith(".js")) {
+          return "serviceWorkerPath must be a JavaScript file (.js)";
+        }
+        if (value.startsWith("http://") || value.startsWith("https://")) {
+          try {
+            const url = new URL(value);
+            if (typeof window !== "undefined") {
+              const currentOrigin = window.location.origin;
+              if (url.origin !== currentOrigin) {
+                return `serviceWorkerPath URL must be same-origin. Expected: ${currentOrigin}, Got: ${url.origin}`;
+              }
+            }
+            return true;
+          } catch {
+            return "serviceWorkerPath must be a valid URL";
+          }
+        }
+        if (!/^[a-zA-Z0-9_./-]+\.js$/.test(pathWithoutQuery)) {
+          return "serviceWorkerPath must be a valid JavaScript file path or same-origin URL";
+        }
+        return true;
+      },
+      message: "serviceWorkerPath must be a valid JavaScript file path or same-origin URL"
     });
   }
 }
@@ -674,6 +703,10 @@ class ServiceWorkerManager {
   }
   async autoDetectServiceWorkerUrl() {
     if (typeof window !== "undefined") {
+      if (this.swUrl !== "/sw.js") {
+        logger.log("Service Worker path already manually set:", this.swUrl);
+        return;
+      }
       const currentPath = window.location.pathname;
       const basePath = currentPath.endsWith("/") ? currentPath : currentPath + "/";
       if (basePath !== "/") {
@@ -720,8 +753,8 @@ class ServiceWorkerManager {
     await this.autoDetectServiceWorkerUrl();
     const possibleUrls = [
       this.swUrl,
-      "./sw.js",
       "/sw.js",
+      "./sw.js",
       "/dist/sw.js",
       "/assets/sw.js"
     ];
@@ -6305,6 +6338,7 @@ class WebPushSDK {
     this.appKey = "";
     this.vapidPublicKey = "";
     this.pendingMessages = [];
+    this.enableSystemPermissionAlert = true;
     this.EVENT = EVENT;
     this.VERSION = version;
     logger.log("version:", version);
@@ -6327,10 +6361,13 @@ class WebPushSDK {
   async registerPush(options) {
     try {
       Validator.validateRegisterPushOptions(options);
-      const { SDKAppID, appKey, userID, chat, logLevel } = options;
+      const { SDKAppID, appKey, userID, chat, logLevel, serviceWorkerPath, showSystemPermissionAlert } = options;
       if (logLevel !== void 0) {
         logger.setLogLevel(logLevel);
       }
+      if (showSystemPermissionAlert !== void 0) {
+        this.enableSystemPermissionAlert = showSystemPermissionAlert;
+      }
       if (this.isRegistered) {
         logger.warn(
           "Push service already registered, will unregister first and then re-register"
@@ -6373,6 +6410,9 @@ class WebPushSDK {
         }
       }
       this.addChatListener();
+      if (serviceWorkerPath) {
+        this.serviceWorkerManager.setServiceWorkerUrl(serviceWorkerPath);
+      }
       await this.serviceWorkerManager.register();
       if (logLevel !== void 0) {
         await this.sendLogLevelToServiceWorker(logLevel);
@@ -6510,7 +6550,9 @@ class WebPushSDK {
           `User denied notification permission for ${browserName}`
         );
       } else {
-        this.showSystemPermissionAlert(browserName);
+        if (this.enableSystemPermissionAlert) {
+          this.showSystemPermissionAlert(browserName);
+        }
       }
       return permission;
     } catch (error) {
@@ -6798,6 +6840,7 @@ Please refresh the page after enabling notifications.`;
     this.appKey = "";
     this.vapidPublicKey = "";
     this.pendingMessages = [];
+    this.enableSystemPermissionAlert = true;
     if (this.messagePopup) {
       this.messagePopup.destroy();
       this.messagePopup = null;