url-sanitizer 5.2.0 → 5.2.2

package/types/index.d.ts

@@ -6,10 +6,30 @@
  * @see {@link https://github.com/asamuzaK/urlSanitizer/blob/main/LICENSE}
  */
 import { URLSanitizer } from './mjs/sanitize.js';
-export type InspectedURLResult = import('./mjs/sanitize.js').InspectedURLResult;
-export { URLSanitizer };
-declare const sanitizer: URLSanitizer;
-export declare const sanitizeURL: (url: string, opt?: {
+export type InspectedDataURL = {
+    base64: boolean;
+    data: string;
+    mime: string;
+};
+export type InspectedURLResult = {
+    input: string;
+    valid: boolean;
+    href: string | null;
+    relative?: boolean;
+    reason?: string;
+    data?: InspectedDataURL | null;
+    origin?: string;
+    protocol?: string;
+    username?: string;
+    password?: string;
+    host?: string;
+    hostname?: string;
+    port?: string;
+    pathname?: string;
+    search?: string;
+    hash?: string;
+};
+export type SanitizeOptions = {
     allow?: string[];
     deny?: string[];
     only?: string[];
@@ -18,16 +38,11 @@ export declare const sanitizeURL: (url: string, opt?: {
     revokeObjectURL?: boolean;
     maxBlobSize?: number;
     maxLength?: number;
-}) => Promise<string | null>;
-export declare const sanitizeURLSync: (url: string, opt?: {
-    allow?: string[];
-    deny?: string[];
-    only?: string[];
-    allowRelative?: boolean;
-    debug?: boolean;
-    revokeObjectURL?: boolean;
-    maxLength?: number;
-}) => string | null;
+};
+export { URLSanitizer };
+declare const sanitizer: URLSanitizer;
+export declare const sanitizeURL: (url: string, opt?: SanitizeOptions) => Promise<string | null>;
+export declare const sanitizeURLSync: (url: string, opt?: SanitizeOptions) => string | null;
 export declare const inspectURL: (url: string) => Promise<InspectedURLResult>;
 export declare const isValidURI: (uri: string) => boolean;
 export declare const isURISync: (uri: string) => boolean;

package/types/mjs/constant.d.ts

@@ -9,3 +9,4 @@ export declare const TRUNCATE_LENGTH: number;
 export declare const TYPE_FROM: number;
 export declare const TYPE_TO: number;
 export declare const DUMMY_BASE: string;
+export declare const DEFAULT_OPTS: import('./sanitize.js').InternalSanitizeOptions;

package/types/mjs/filter.d.ts

@@ -1,14 +1,18 @@
+export type DOMPurify = import('dompurify').DOMPurify;
+export type InspectedDataURL = import('../index.js').InspectedDataURL;
+export type InspectedURLResult = import('../index.js').InspectedURLResult;
+export type SanitizeOptions = import('../index.js').SanitizeOptions;
+export type InternalSanitizeOptions = import('./sanitize.js').InternalSanitizeOptions;
 export declare class SanitizeContext {
     #private;
-    domPurify: object;
+    domPurify: import("dompurify").DOMPurify;
     nest: number;
     recurse: Set<any>;
     restrictScheme: boolean;
     schemeMap: Map<string, boolean>;
     allowRelative: boolean | undefined;
     debug: boolean | undefined;
-    schemes: Set<any> | undefined;
-    constructor(opt: object, domPurifyInstance: object);
+    constructor(domPurifyInstance: DOMPurify, opt?: InternalSanitizeOptions);
     private #compileRules;
     private #registerScheme;
     enter(url: string): boolean;
@@ -16,13 +20,13 @@ export declare class SanitizeContext {
 }
 export declare class SanitizeFilter {
     #private;
-    constructor(options: object);
+    constructor(opt?: InternalSanitizeOptions);
     private #process;
     private #sanitizeDataURL;
     private #purify;
     private #handleSanitizeAttribute;
     private #sanitizeStandardURL;
-    sanitize(url: string, options?: object): string | null;
-    sanitizeBuffer(buffer: ArrayBuffer, mimeType: string, options?: object): Promise<string | null>;
-    sanitizeDataURL(url: string, options?: object): Promise<string | null>;
+    sanitize(url: string, opt?: InternalSanitizeOptions): string | null;
+    sanitizeBuffer(buffer: ArrayBuffer, mimeType: string, opt?: InternalSanitizeOptions): Promise<string | null>;
+    sanitizeDataURL(url: string, opt?: InternalSanitizeOptions): Promise<string | null>;
 }

package/types/mjs/sanitize.d.ts

@@ -1,26 +1,9 @@
 import { URISchemes } from './scheme.js';
-export type InspectedDataURL = {
-    base64: boolean;
-    data: string;
-    mime: string;
-};
-export type InspectedURLResult = {
-    input: string;
-    valid: boolean;
-    href: string | null;
-    relative?: boolean;
-    reason?: string;
-    data?: InspectedDataURL | null;
-    origin?: string;
-    protocol?: string;
-    username?: string;
-    password?: string;
-    host?: string;
-    hostname?: string;
-    port?: string;
-    pathname?: string;
-    search?: string;
-    hash?: string;
+export type InspectedDataURL = import('../index.js').InspectedDataURL;
+export type InspectedURLResult = import('../index.js').InspectedURLResult;
+export type SanitizeOptions = import('../index.js').SanitizeOptions;
+export type InternalSanitizeOptions = SanitizeOptions & {
+    schemes?: Set<string>;
 };
 export declare class URLSanitizer extends URISchemes {
     #private;
@@ -33,25 +16,8 @@ export declare class URLSanitizer extends URISchemes {
     add(scheme: string): string[];
     remove(scheme: string): boolean;
     reset(): void;
-    sanitizeURL(url: string, opt?: {
-        allow?: string[];
-        deny?: string[];
-        only?: string[];
-        allowRelative?: boolean;
-        debug?: boolean;
-        revokeObjectURL?: boolean;
-        maxBlobSize?: number;
-        maxLength?: number;
-    }): Promise<string | null>;
-    sanitizeURLSync(url: string, opt?: {
-        allow?: string[];
-        deny?: string[];
-        only?: string[];
-        allowRelative?: boolean;
-        debug?: boolean;
-        revokeObjectURL?: boolean;
-        maxLength?: number;
-    }): string | null;
+    sanitizeURL(url: string, opt?: SanitizeOptions): Promise<string | null>;
+    sanitizeURLSync(url: string, opt?: SanitizeOptions): string | null;
     inspectURL(url: string): Promise<InspectedURLResult>;
     isValidURI(uri: string): boolean;
 }