@blocklet/editor 2.4.92 → 2.4.94

package/lib/libs/utm.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * 为外部 URL 添加 UTM 追踪参数
+ * @param url - 原始 URL 地址
+ * @returns 添加 UTM 参数后的 URL
+ * @see https://team.arcblock.io/comment/discussions/7504c5ce-7453-4223-a539-27620efcf38e#6fd5adb6-49ab-4ead-9233-240aa53d1058
+ *
+ */
+export declare function getUTMUrl(url: string): string;

package/lib/libs/utm.js

@@ -0,0 +1,43 @@
+import { withQuery, getQuery } from 'ufo';
+function isExternal(url) {
+    try {
+        const u = new URL(url);
+        return u.origin !== window.location.origin;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ *
+ * 为外部 URL 添加 UTM 追踪参数
+ * @param url - 原始 URL 地址
+ * @returns 添加 UTM 参数后的 URL
+ * @see https://team.arcblock.io/comment/discussions/7504c5ce-7453-4223-a539-27620efcf38e#6fd5adb6-49ab-4ead-9233-240aa53d1058
+ *
+ */
+export function getUTMUrl(url) {
+    try {
+        if (!isExternal(url)) {
+            return url;
+        }
+        const type = window.__discussKitPostType__ ?? 'discussion';
+        const existsQueryParams = getQuery(url);
+        const queryParams = {
+            // 自身站点的 hostname
+            utm_source: window.location.hostname,
+            // 标记导航点击
+            utm_medium: `${type}_link`,
+            // 全局导航统一标签
+            utm_campaign: 'default',
+            // 目标站点标识
+            utm_content: new URL(url).hostname,
+            ...existsQueryParams,
+        };
+        return withQuery(url, queryParams);
+    }
+    catch (error) {
+        console.error('Failed to generate UTM URL:', error);
+        return url;
+    }
+}

package/lib/libs/utm.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/libs/utm.spec.js

@@ -0,0 +1,153 @@
+import { describe, expect, it, beforeEach, afterEach, vi } from 'vitest';
+import { getUTMUrl } from './utm';
+// Mock window 对象
+const mockWindow = {
+    location: {
+        origin: 'https://example.com',
+        hostname: 'example.com',
+    },
+    __discussKitPostType__: 'discussion',
+};
+describe('getUTMUrl', () => {
+    beforeEach(() => {
+        // @ts-ignore
+        global.window = mockWindow;
+        vi.clearAllMocks();
+    });
+    afterEach(() => {
+        // @ts-ignore
+        delete global.window;
+    });
+    describe('Internal Link Handling', () => {
+        it('should return original URL when URL is internal link', () => {
+            const internalUrl = 'https://example.com/path';
+            expect(getUTMUrl(internalUrl)).toBe(internalUrl);
+        });
+        it('should return original URL when URL is relative path', () => {
+            const relativeUrl = '/path/to/page';
+            expect(getUTMUrl(relativeUrl)).toBe(relativeUrl);
+        });
+        it('should return original URL when URL format is invalid', () => {
+            const invalidUrl = 'not-a-valid-url';
+            expect(getUTMUrl(invalidUrl)).toBe(invalidUrl);
+        });
+    });
+    describe('External Link UTM Parameter Addition', () => {
+        it('should add UTM parameters to external URL', () => {
+            const externalUrl = 'https://external.com/path';
+            const result = getUTMUrl(externalUrl);
+            expect(result).toContain('utm_source=example.com');
+            expect(result).toContain('utm_medium=discussion_link');
+            expect(result).toContain('utm_campaign=default');
+            expect(result).toContain('utm_content=external.com');
+        });
+        it('should preserve existing query parameters', () => {
+            const urlWithParams = 'https://external.com/path?existing=param&another=value';
+            const result = getUTMUrl(urlWithParams);
+            expect(result).toContain('existing=param');
+            expect(result).toContain('another=value');
+            expect(result).toContain('utm_source=example.com');
+        });
+        it('should handle different port numbers', () => {
+            const urlWithPort = 'https://external.com:8080/path';
+            const result = getUTMUrl(urlWithPort);
+            // URL constructor treats port as part of hostname, but ufo library may only take hostname
+            expect(result).toContain('utm_content=external.com');
+        });
+    });
+    describe('Different Post Type Handling', () => {
+        it('should use default value when __discussKitPostType__ is undefined', () => {
+            // @ts-ignore
+            delete global.window.__discussKitPostType__;
+            const externalUrl = 'https://external.com/path';
+            const result = getUTMUrl(externalUrl);
+            expect(result).toContain('utm_medium=discussion_link');
+        });
+        it('should use specified post type', () => {
+            // @ts-ignore
+            global.window.__discussKitPostType__ = 'blog';
+            const externalUrl = 'https://external.com/path';
+            const result = getUTMUrl(externalUrl);
+            expect(result).toContain('utm_medium=blog_link');
+        });
+    });
+    describe('Error Handling', () => {
+        it('should return original URL when error occurs', () => {
+            const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => { });
+            // Mock scenario that causes error - break window.location.hostname access
+            const originalWindow = global.window;
+            // @ts-ignore
+            global.window = {
+                location: {
+                    origin: 'https://example.com',
+                    get hostname() {
+                        throw new Error('Hostname access error');
+                    },
+                },
+                __discussKitPostType__: 'discussion',
+            };
+            const url = 'https://external.com/path';
+            const result = getUTMUrl(url);
+            expect(result).toBe(url);
+            expect(consoleSpy).toHaveBeenCalledWith('Failed to generate UTM URL:', expect.any(Error));
+            // @ts-ignore
+            global.window = originalWindow;
+            consoleSpy.mockRestore();
+        });
+        it('should handle empty string URL', () => {
+            const result = getUTMUrl('');
+            expect(result).toBe('');
+        });
+    });
+    describe('URL Construction Validation', () => {
+        beforeEach(() => {
+            // Reset window object state
+            // @ts-ignore
+            global.window = {
+                location: {
+                    origin: 'https://example.com',
+                    hostname: 'example.com',
+                },
+                __discussKitPostType__: 'discussion',
+            };
+        });
+        it('should generate valid URL format', () => {
+            const externalUrl = 'https://external.com/path';
+            const result = getUTMUrl(externalUrl);
+            // Verify result is a valid URL
+            expect(() => new URL(result)).not.toThrow();
+            const parsedUrl = new URL(result);
+            expect(parsedUrl.searchParams.get('utm_source')).toBe('example.com');
+            expect(parsedUrl.searchParams.get('utm_medium')).toBe('discussion_link');
+            expect(parsedUrl.searchParams.get('utm_campaign')).toBe('default');
+            expect(parsedUrl.searchParams.get('utm_content')).toBe('external.com');
+        });
+        it('should correctly handle URLs with existing UTM parameters', () => {
+            const urlWithUTM = 'https://external.com/path?utm_source=existing&other=param';
+            const result = getUTMUrl(urlWithUTM);
+            const parsedUrl = new URL(result);
+            // According to code logic, existsQueryParams comes last, overriding new UTM parameters
+            expect(parsedUrl.searchParams.get('utm_source')).toBe('existing');
+            expect(parsedUrl.searchParams.get('other')).toBe('param');
+            // Verify other UTM parameters are correctly added
+            expect(result).toContain('utm_medium=discussion_link');
+            expect(result).toContain('utm_campaign=default');
+            expect(result).toContain('utm_content=external.com');
+        });
+    });
+    describe('Special Character and Encoding Handling', () => {
+        it('should correctly handle hostname with special characters', () => {
+            // @ts-ignore
+            global.window.location.hostname = 'test-site.co.uk';
+            const externalUrl = 'https://external.com/path';
+            const result = getUTMUrl(externalUrl);
+            expect(result).toContain('utm_source=test-site.co.uk');
+        });
+        it('should correctly handle Chinese domain names', () => {
+            const externalUrl = 'https://测试.com/path';
+            const result = getUTMUrl(externalUrl);
+            // Verify result contains encoded content
+            expect(result).toContain('utm_content=xn--');
+        });
+    });
+});

package/lib/main/plugins/ClickableLinkPlugin/index.js

@@ -5,6 +5,7 @@ import { $getNearestNodeFromDOMNode, $getSelection, $isElementNode, $isRangeSele
 import { useEffect } from 'react';
 import { useParams, useNavigate } from 'react-router-dom';
 import { useEditorConfig } from '../../../config';
+import { getUTMUrl } from '../../../libs/utm';
 function findMatchingDOM(startNode, predicate) {
     let node = startNode;
     while (node != null) {
@@ -93,7 +94,7 @@ export default function LexicalClickableLinkPlugin({ newTab = true }) {
                 }
             }
             else {
-                window.open(url, newTab || isMiddle || event.metaKey || event.ctrlKey || urlTarget === '_blank' ? '_blank' : '_self');
+                window.open(getUTMUrl(url), newTab || isMiddle || event.metaKey || event.ctrlKey || urlTarget === '_blank' ? '_blank' : '_self');
             }
             event.preventDefault();
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/editor",
-  "version": "2.4.92",
+  "version": "2.4.94",
   "main": "lib/index.js",
   "sideEffects": false,
   "publishConfig": {
@@ -73,7 +73,7 @@
     "ufo": "^1.5.4",
     "url-join": "^4.0.1",
     "zustand": "^4.5.5",
-    "@blocklet/pdf": "2.4.92"
+    "@blocklet/pdf": "2.4.94"
   },
   "devDependencies": {
     "@babel/core": "^7.25.2",