DOMPurify 3.1.7版本在Angular项目中的构建问题分析与解决方案

DOMPurify作为一款广泛使用的HTML净化库，在3.1.7版本更新后，部分TypeScript项目（特别是Angular项目）出现了构建错误。本文将深入分析问题原因，并提供多种解决方案。

问题现象

当开发者将DOMPurify升级到3.1.7版本后，在Angular 18项目中运行时会出现以下错误：

Error: export 'sanitize' (imported as 'DOMPurify') was not found in 'dompurify' (possible exports: default)

类似问题也出现在Angular 14和17版本中，表明这是一个与TypeScript模块系统相关的普遍性问题。

根本原因分析

问题的根源在于3.1.7版本中引入的模块导出方式变更。具体来说：

1. 在3.1.7版本中，DOMPurify添加了针对ES模块的导出方式，但这一变更与TypeScript类型定义(@types/dompurify)不完全兼容。

2. TypeScript类型定义中使用了export = DOMPurify这种CommonJS风格的导出方式，而实际代码采用了ES模块导出方式，导致类型检查与实际运行时行为不一致。

3. Angular项目通常配置了严格的类型检查，这使得这种不一致性立即显现为构建错误。

解决方案

临时解决方案

对于急需修复的项目，可以暂时锁定DOMPurify版本为3.1.6：

"dompurify": "3.1.6"

长期解决方案

1. 修改导入方式
   将原有的命名空间导入：

   import * as DOMPurify from 'dompurify';
   

   改为默认导入：

   import DOMPurify from 'dompurify';
   

2. TypeScript配置调整
   在tsconfig.json中添加以下配置：

   {
     "compilerOptions": {
       "allowSyntheticDefaultImports": true,
       "paths": {
         "dompurify": ["node_modules/dompurify/dist/purify.es.d.mts"]
       },
       "types": ["trusted-types"]
     }
   }
   

   同时需要安装@types/trusted-types作为开发依赖。

3. 等待官方修复
   DOMPurify团队已经在3.2.0版本中解决了这一问题，建议升级到最新版本。

技术背景

这个问题实际上反映了JavaScript模块系统的演变过程。从CommonJS到ES模块的过渡中，各种工具链和框架对模块解析的处理方式存在差异。TypeScript作为静态类型检查器，对模块解析有严格要求，而Angular等框架又在此基础上添加了自己的模块解析逻辑，导致这类兼容性问题时有发生。

最佳实践建议

1. 对于库开发者：在发布新版本时，应该全面测试各种导入方式，包括CommonJS和ES模块两种风格。

2. 对于应用开发者：保持依赖项更新，但升级前应该在隔离环境中测试兼容性。

3. 对于团队项目：考虑使用锁文件(package-lock.json或yarn.lock)来确保所有开发者使用相同的依赖版本。

通过理解这些底层机制，开发者可以更好地应对类似问题，并在遇到构建错误时快速定位解决方案。