Merge pull request #1073 from donmccurdy/fix/trusted-types-lib

fix(trusted-types): Use 'trusted-types/lib'

Author: cure53

dist/purify.cjs.d.ts

@@ -1,6 +1,7 @@
-/// <reference types="trusted-types" />
 /*! @license DOMPurify 3.2.4 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.2.4/LICENSE */
 
+import { TrustedTypePolicy, TrustedHTML, TrustedTypesWindow } from 'trusted-types/lib';
+
 /**
  * Configuration to control DOMPurify behavior.
  */
@@ -433,8 +434,7 @@ interface UponSanitizeAttributeHookEvent {
 type WindowLike = Pick<typeof globalThis, 'DocumentFragment' | 'HTMLTemplateElement' | 'Node' | 'Element' | 'NodeFilter' | 'NamedNodeMap' | 'HTMLFormElement' | 'DOMParser'> & {
     document?: Document;
     MozNamedAttrMap?: typeof window.NamedNodeMap;
-    trustedTypes?: typeof window.trustedTypes;
-};
+} & Pick<TrustedTypesWindow, 'trustedTypes'>;
 
 export { type Config, type DOMPurify, type DocumentFragmentHook, type ElementHook, type HookName, type NodeHook, type RemovedAttribute, type RemovedElement, type UponSanitizeAttributeHook, type UponSanitizeAttributeHookEvent, type UponSanitizeElementHook, type UponSanitizeElementHookEvent, type WindowLike };
 

dist/purify.es.d.mts

@@ -1,6 +1,7 @@
-/// <reference types="trusted-types" />
 /*! @license DOMPurify 3.2.4 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.2.4/LICENSE */
 
+import { TrustedTypePolicy, TrustedHTML, TrustedTypesWindow } from 'trusted-types/lib';
+
 /**
  * Configuration to control DOMPurify behavior.
  */
@@ -433,7 +434,6 @@ interface UponSanitizeAttributeHookEvent {
 type WindowLike = Pick<typeof globalThis, 'DocumentFragment' | 'HTMLTemplateElement' | 'Node' | 'Element' | 'NodeFilter' | 'NamedNodeMap' | 'HTMLFormElement' | 'DOMParser'> & {
     document?: Document;
     MozNamedAttrMap?: typeof window.NamedNodeMap;
-    trustedTypes?: typeof window.trustedTypes;
-};
+} & Pick<TrustedTypesWindow, 'trustedTypes'>;
 
 export { type Config, type DOMPurify, type DocumentFragmentHook, type ElementHook, type HookName, type NodeHook, type RemovedAttribute, type RemovedElement, type UponSanitizeAttributeHook, type UponSanitizeAttributeHookEvent, type UponSanitizeElementHook, type UponSanitizeElementHookEvent, type WindowLike, _default as default };

scripts/fix-types.js

@@ -7,7 +7,6 @@ const path = require('node:path');
   // Note that this script is intended to run on the type declaration file that is
   // output by Rollup, and not the type declaration file generated from TypeScript.
   await fixCjsTypes(path.resolve(__dirname, '../dist/purify.cjs.d.ts'));
-  await fixEsmTypes(path.resolve(__dirname, '../dist/purify.es.d.mts'));
 })().catch((ex) => {
   console.error(ex);
   process.exitCode = 1;
@@ -37,22 +36,5 @@ async function fixCjsTypes(fileName) {
   // for certain configurations, so add a `@ts-ignore` comment before it.
   fixed += '\n// @ts-ignore\nexport = _default;\n';
 
-  await fs.writeFile(fileName, addTrustedTypesReference(fixed));
-}
-
-/**
- * Fixes the ESM type declarations file.
- * @param {string} fileName
- */
-async function fixEsmTypes(fileName) {
-  let types = await fs.readFile(fileName, { encoding: 'utf-8' });
-  await fs.writeFile(fileName, addTrustedTypesReference(types));
-}
-
-function addTrustedTypesReference(types) {
-  // We need to tell TypeScript that we use the type declarations from
-  // `trusted-types` so that it ends up in our type declaration type).
-  // Without this, the references to trusted-types in the type declaration
-  // file can cause compilation errors for certain configurations.
-  return `/// <reference types="trusted-types" />\n${types}`;
+  await fs.writeFile(fileName, fixed);
 }

src/config.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/indent */
 
+import type { TrustedTypePolicy } from 'trusted-types/lib';
+
 /**
  * Configuration to control DOMPurify behavior.
  */

src/purify.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/indent */
 
+import type { TrustedHTML, TrustedTypesWindow } from 'trusted-types/lib';
 import type { Config, UseProfilesConfig } from './config';
 import * as TAGS from './tags.js';
 import * as ATTRS from './attrs.js';
@@ -2006,5 +2007,4 @@ export type WindowLike = Pick<
 > & {
   document?: Document;
   MozNamedAttrMap?: typeof window.NamedNodeMap;
-  trustedTypes?: typeof window.trustedTypes;
-};
+} & Pick<TrustedTypesWindow, 'trustedTypes'>;