1- // Type definitions for DOM Purify 2.2
1+ // Type definitions for DOM Purify 3.0
22// Project: https://github.com/cure53/DOMPurify
33// Definitions by: Dave Taylor https://github.com/davetayls
44// Samira Bazuzi <https://github.com/bazuzi>
77// Piotr Błażejewicz <https://github.com/peterblazejewicz>
88// Nicholas Ellul <https://github.com/NicholasEllul>
99// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
10+ // Minimum TypeScript Version: 4.5
1011
1112export as namespace DOMPurify ;
1213export = DOMPurify ;
1314
1415declare const DOMPurify : createDOMPurifyI ;
1516
17+ type WindowLike = Pick <
18+ typeof globalThis ,
19+ | 'NodeFilter'
20+ | 'Node'
21+ | 'Element'
22+ | 'HTMLTemplateElement'
23+ | 'DocumentFragment'
24+ | 'HTMLFormElement'
25+ | 'DOMParser'
26+ | 'NamedNodeMap'
27+ > ;
28+
1629interface createDOMPurifyI extends DOMPurify . DOMPurifyI {
17- ( window ?: Window ) : DOMPurify . DOMPurifyI ;
30+ ( window ?: Window | WindowLike ) : DOMPurify . DOMPurifyI ;
1831}
1932
2033declare namespace DOMPurify {
2134 interface DOMPurifyI {
2235 sanitize ( source : string | Node ) : string ;
2336 sanitize ( source : string | Node , config : Config & { RETURN_TRUSTED_TYPE : true } ) : TrustedHTML ;
24- sanitize ( source : string | Node , config : Config & { RETURN_DOM_FRAGMENT ?: false | undefined ; RETURN_DOM ?: false | undefined } ) : string ;
37+ sanitize (
38+ source : string | Node ,
39+ config : Config & { RETURN_DOM_FRAGMENT ?: false | undefined ; RETURN_DOM ?: false | undefined } ,
40+ ) : string ;
2541 sanitize ( source : string | Node , config : Config & { RETURN_DOM_FRAGMENT : true } ) : DocumentFragment ;
2642 sanitize ( source : string | Node , config : Config & { RETURN_DOM : true } ) : HTMLElement ;
2743 sanitize ( source : string | Node , config : Config ) : string | HTMLElement | DocumentFragment ;
2844
29- addHook ( hook : 'uponSanitizeElement' , cb : ( currentNode : Element , data : SanitizeElementHookEvent , config : Config ) => void ) : void ;
30- addHook ( hook : 'uponSanitizeAttribute' , cb : ( currentNode : Element , data : SanitizeAttributeHookEvent , config : Config ) => void ) : void ;
45+ addHook (
46+ hook : 'uponSanitizeElement' ,
47+ cb : ( currentNode : Element , data : SanitizeElementHookEvent , config : Config ) => void ,
48+ ) : void ;
49+ addHook (
50+ hook : 'uponSanitizeAttribute' ,
51+ cb : ( currentNode : Element , data : SanitizeAttributeHookEvent , config : Config ) => void ,
52+ ) : void ;
3153 addHook ( hook : HookName , cb : ( currentNode : Element , data : HookEvent , config : Config ) => void ) : void ;
3254
3355 setConfig ( cfg : Config ) : void ;
@@ -47,33 +69,54 @@ declare namespace DOMPurify {
4769 ADD_ATTR ?: string [ ] | undefined ;
4870 ADD_DATA_URI_TAGS ?: string [ ] | undefined ;
4971 ADD_TAGS ?: string [ ] | undefined ;
72+ ADD_URI_SAFE_ATTR ?: string [ ] | undefined ;
73+ ALLOW_ARIA_ATTR ?: boolean | undefined ;
5074 ALLOW_DATA_ATTR ?: boolean | undefined ;
75+ ALLOW_UNKNOWN_PROTOCOLS ?: boolean | undefined ;
76+ ALLOW_SELF_CLOSE_IN_ATTR ?: boolean | undefined ;
5177 ALLOWED_ATTR ?: string [ ] | undefined ;
5278 ALLOWED_TAGS ?: string [ ] | undefined ;
79+ ALLOWED_NAMESPACES ?: string [ ] | undefined ;
80+ ALLOWED_URI_REGEXP ?: RegExp | undefined ;
5381 FORBID_ATTR ?: string [ ] | undefined ;
82+ FORBID_CONTENTS ?: string [ ] | undefined ;
5483 FORBID_TAGS ?: string [ ] | undefined ;
5584 FORCE_BODY ?: boolean | undefined ;
85+ IN_PLACE ?: boolean | undefined ;
5686 KEEP_CONTENT ?: boolean | undefined ;
5787 /**
5888 * change the default namespace from HTML to something different
5989 */
6090 NAMESPACE ?: string | undefined ;
61- RETURN_DOM ?: boolean | undefined ;
91+ PARSER_MEDIA_TYPE ?: string | undefined ;
6292 RETURN_DOM_FRAGMENT ?: boolean | undefined ;
6393 /**
6494 * This defaults to `true` starting DOMPurify 2.2.0. Note that setting it to `false`
6595 * might cause XSS from attacks hidden in closed shadowroots in case the browser
6696 * supports Declarative Shadow: DOM https://web.dev/declarative-shadow-dom/
6797 */
6898 RETURN_DOM_IMPORT ?: boolean | undefined ;
99+ RETURN_DOM ?: boolean | undefined ;
69100 RETURN_TRUSTED_TYPE ?: boolean | undefined ;
101+ SAFE_FOR_TEMPLATES ?: boolean | undefined ;
70102 SANITIZE_DOM ?: boolean | undefined ;
103+ /** @default false */
104+ SANITIZE_NAMED_PROPS ?: boolean | undefined ;
105+ USE_PROFILES ?:
106+ | false
107+ | {
108+ mathMl ?: boolean | undefined ;
109+ svg ?: boolean | undefined ;
110+ svgFilters ?: boolean | undefined ;
111+ html ?: boolean | undefined ;
112+ }
113+ | undefined ;
71114 WHOLE_DOCUMENT ?: boolean | undefined ;
72- ALLOWED_URI_REGEXP ?: RegExp | undefined ;
73- SAFE_FOR_TEMPLATES ?: boolean | undefined ;
74- ALLOW_UNKNOWN_PROTOCOLS ?: boolean | undefined ;
75- USE_PROFILES ?: false | { mathMl ?: boolean | undefined ; svg ?: boolean | undefined ; svgFilters ?: boolean | undefined ; html ?: boolean | undefined } | undefined ;
76- IN_PLACE ?: boolean | undefined ;
115+ CUSTOM_ELEMENT_HANDLING ?: {
116+ tagNameCheck ?: RegExp | ( ( tagName : string ) => boolean ) | null | undefined ;
117+ attributeNameCheck ?: RegExp | ( ( lcName : string ) => boolean ) | null | undefined ;
118+ allowCustomizedBuiltInElements ?: boolean | undefined ;
119+ } ;
77120 }
78121
79122 type HookName =
0 commit comments