/
index.d.ts
138 lines (124 loc) · 4.96 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/// <reference types="trusted-types"/>
export as namespace DOMPurify;
export = DOMPurify;
declare const DOMPurify: createDOMPurifyI;
type WindowLike = Pick<
typeof globalThis,
| "NodeFilter"
| "Node"
| "Element"
| "HTMLTemplateElement"
| "DocumentFragment"
| "HTMLFormElement"
| "DOMParser"
| "NamedNodeMap"
>;
interface createDOMPurifyI extends DOMPurify.DOMPurifyI {
(window?: Window | WindowLike): DOMPurify.DOMPurifyI;
}
declare namespace DOMPurify {
interface DOMPurifyI {
sanitize(source: string | Node): string;
sanitize(source: string | Node, config: Config & { RETURN_TRUSTED_TYPE: true }): TrustedHTML;
sanitize(
source: string | Node,
config: Config & { RETURN_DOM_FRAGMENT?: false | undefined; RETURN_DOM?: false | undefined },
): string;
sanitize(source: string | Node, config: Config & { RETURN_DOM_FRAGMENT: true }): DocumentFragment;
sanitize(source: string | Node, config: Config & { RETURN_DOM: true }): HTMLElement;
sanitize(source: string | Node, config: Config): string | HTMLElement | DocumentFragment;
addHook(
hook: "uponSanitizeElement",
cb: (currentNode: Element, data: SanitizeElementHookEvent, config: Config) => void,
): void;
addHook(
hook: "uponSanitizeAttribute",
cb: (currentNode: Element, data: SanitizeAttributeHookEvent, config: Config) => void,
): void;
addHook(hook: HookName, cb: (currentNode: Element, data: HookEvent, config: Config) => void): void;
setConfig(cfg: Config): void;
clearConfig(): void;
isValidAttribute(tag: string, attr: string, value: string): boolean;
removeHook(entryPoint: HookName): void;
removeHooks(entryPoint: HookName): void;
removeAllHooks(): void;
version: string;
removed: any[];
isSupported: boolean;
}
interface Config {
ADD_ATTR?: string[] | undefined;
ADD_DATA_URI_TAGS?: string[] | undefined;
ADD_TAGS?: string[] | undefined;
ADD_URI_SAFE_ATTR?: string[] | undefined;
ALLOW_ARIA_ATTR?: boolean | undefined;
ALLOW_DATA_ATTR?: boolean | undefined;
ALLOW_UNKNOWN_PROTOCOLS?: boolean | undefined;
ALLOW_SELF_CLOSE_IN_ATTR?: boolean | undefined;
ALLOWED_ATTR?: string[] | undefined;
ALLOWED_TAGS?: string[] | undefined;
ALLOWED_NAMESPACES?: string[] | undefined;
ALLOWED_URI_REGEXP?: RegExp | undefined;
FORBID_ATTR?: string[] | undefined;
FORBID_CONTENTS?: string[] | undefined;
FORBID_TAGS?: string[] | undefined;
FORCE_BODY?: boolean | undefined;
IN_PLACE?: boolean | undefined;
KEEP_CONTENT?: boolean | undefined;
/**
* change the default namespace from HTML to something different
*/
NAMESPACE?: string | undefined;
PARSER_MEDIA_TYPE?: string | undefined;
RETURN_DOM_FRAGMENT?: boolean | undefined;
/**
* This defaults to `true` starting DOMPurify 2.2.0. Note that setting it to `false`
* might cause XSS from attacks hidden in closed shadowroots in case the browser
* supports Declarative Shadow: DOM https://web.dev/declarative-shadow-dom/
*/
RETURN_DOM_IMPORT?: boolean | undefined;
RETURN_DOM?: boolean | undefined;
RETURN_TRUSTED_TYPE?: boolean | undefined;
SAFE_FOR_TEMPLATES?: boolean | undefined;
SANITIZE_DOM?: boolean | undefined;
/** @default false */
SANITIZE_NAMED_PROPS?: boolean | undefined;
USE_PROFILES?:
| false
| {
mathMl?: boolean | undefined;
svg?: boolean | undefined;
svgFilters?: boolean | undefined;
html?: boolean | undefined;
}
| undefined;
WHOLE_DOCUMENT?: boolean | undefined;
CUSTOM_ELEMENT_HANDLING?: {
tagNameCheck?: RegExp | ((tagName: string) => boolean) | null | undefined;
attributeNameCheck?: RegExp | ((lcName: string) => boolean) | null | undefined;
allowCustomizedBuiltInElements?: boolean | undefined;
};
}
type HookName =
| "beforeSanitizeElements"
| "uponSanitizeElement"
| "afterSanitizeElements"
| "beforeSanitizeAttributes"
| "uponSanitizeAttribute"
| "afterSanitizeAttributes"
| "beforeSanitizeShadowDOM"
| "uponSanitizeShadowNode"
| "afterSanitizeShadowDOM";
type HookEvent = SanitizeElementHookEvent | SanitizeAttributeHookEvent | null;
interface SanitizeElementHookEvent {
tagName: string;
allowedTags: { [key: string]: boolean };
}
interface SanitizeAttributeHookEvent {
attrName: string;
attrValue: string;
keepAttr: boolean;
allowedAttributes: { [key: string]: boolean };
forceKeepAttr?: boolean | undefined;
}
}