mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
7caf9e949e
The new Trusted Types definitions introduced by #46321 contained an unexported interface, which caused type checking errors when trustedTypes.createPolicy was referenced, but not called. This fixes that by removing the interface, and instead adding a type parameter to the public TrustedTypePolicy interface. Thanks to @engelsdamien for the help.
76 lines
3.2 KiB
TypeScript
76 lines
3.2 KiB
TypeScript
// Type definitions for trusted-types 1.0
|
|
// Project: https://github.com/WICG/trusted-types
|
|
// Definitions by: Jakub Vrana <https://github.com/vrana>
|
|
// Damien Engels <https://github.com/engelsdamien>
|
|
// Emanuel Tesar <https://github.com/siegrift>
|
|
// Bjarki <https://github.com/bjarkler>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 3.1
|
|
|
|
type FnNames = keyof TrustedTypePolicyOptions;
|
|
type Args<Options extends TrustedTypePolicyOptions, K extends FnNames> =
|
|
Parameters<NonNullable<Options[K]>>;
|
|
|
|
declare global {
|
|
class TrustedHTML {
|
|
private constructor(); // To prevent instantiting with 'new'.
|
|
private brand: true; // To prevent structural typing.
|
|
}
|
|
|
|
class TrustedScript {
|
|
private constructor(); // To prevent instantiting with 'new'.
|
|
private brand: true; // To prevent structural typing.
|
|
}
|
|
|
|
class TrustedScriptURL {
|
|
private constructor(); // To prevent instantiting with 'new'.
|
|
private brand: true; // To prevent structural typing.
|
|
}
|
|
|
|
interface TrustedTypePolicyFactory {
|
|
createPolicy<Options extends TrustedTypePolicyOptions>(
|
|
policyName: string,
|
|
policyOptions?: Options,
|
|
): Pick<TrustedTypePolicy<Options>, 'name'|Extract<keyof Options, FnNames>>;
|
|
isHTML(value: unknown): value is TrustedHTML;
|
|
isScript(value: unknown): value is TrustedScript;
|
|
isScriptURL(value: unknown): value is TrustedScriptURL;
|
|
readonly emptyHTML: TrustedHTML;
|
|
readonly emptyScript: TrustedScript;
|
|
getAttributeType(tagName: string, attribute: string, elementNs?: string, attrNs?: string): string | null;
|
|
getPropertyType(tagName: string, property: string, elementNs?: string): string | null;
|
|
readonly defaultPolicy: TrustedTypePolicy | null;
|
|
}
|
|
|
|
interface TrustedTypePolicy<Options extends TrustedTypePolicyOptions = TrustedTypePolicyOptions> {
|
|
readonly name: string;
|
|
createHTML(...args: Args<Options, 'createHTML'>): TrustedHTML;
|
|
createScript(...args: Args<Options, 'createScript'>): TrustedScript;
|
|
createScriptURL(...args: Args<Options, 'createScriptURL'>): TrustedScriptURL;
|
|
}
|
|
|
|
interface TrustedTypePolicyOptions {
|
|
createHTML?: (input: string, ...arguments: any[]) => string;
|
|
createScript?: (input: string, ...arguments: any[]) => string;
|
|
createScriptURL?: (input: string, ...arguments: any[]) => string;
|
|
}
|
|
|
|
interface Window {
|
|
// `trustedTypes` is left intentionally optional to make sure that
|
|
// people handle the case when their code is running in a browser not
|
|
// supporting trustedTypes.
|
|
trustedTypes?: TrustedTypePolicyFactory;
|
|
TrustedHTML: TrustedHTML;
|
|
TrustedScript: TrustedScript;
|
|
TrustedScriptURL: TrustedScriptURL;
|
|
TrustedTypePolicyFactory: TrustedTypePolicyFactory;
|
|
TrustedTypePolicy: TrustedTypePolicy;
|
|
}
|
|
}
|
|
|
|
// This is not available in global scope. It's only used for the export. This is
|
|
// necessary to be able to use these types from nodejs (for SSR).
|
|
declare const trustedTypes: TrustedTypePolicyFactory;
|
|
|
|
export default trustedTypes;
|