extract sanitizer-related types

src/plugin/v2/grpc_plugin.ts

@@ -5,7 +5,7 @@ import { GrpcPlugin } from '../../node-plugin';
 import { Logger } from '../../logger';
 import { PluginConfig } from '../../config';
 import { createBrowser, Browser } from '../../browser';
-import { HTTPHeaders, ImageRenderOptions, RenderOptions, SanitizeRequest } from '../../types';
+import { HTTPHeaders, ImageRenderOptions, RenderOptions } from '../../types';
 import {
   RenderRequest,
   RenderResponse,
@@ -20,6 +20,7 @@ import {
   GRPCSanitizeResponse,
 } from './types';
 import { createSanitizer, Sanitizer } from '../../sanitizer/Sanitizer';
+import { SanitizeRequest } from '../../sanitizer/types';
 
 const rendererV2PackageDef = protoLoader.loadSync(__dirname + '/../../../proto/rendererv2.proto', {
   keepCase: true,

src/plugin/v2/types.ts

@@ -1,4 +1,4 @@
-import { ConfigType } from '../../types';
+import { ConfigType } from '../../sanitizer/types';
 
 export interface StringList {
   values: string[];

src/sanitizer/Sanitizer.ts

@@ -1,6 +1,6 @@
 import * as DOMPurify from 'dompurify';
 import { JSDOM } from 'jsdom';
-import { ConfigType, isDOMPurifyConfig, SanitizeRequest, SanitizeResponse } from '../types';
+import { ConfigType, isDOMPurifyConfig, SanitizeRequest, SanitizeResponse } from './types';
 
 const svgTags = {
   altGlyphDef: /(<\/?)altGlyphDef([> ])/gi,

src/sanitizer/types.ts

@@ -0,0 +1,30 @@
+import * as DOMPurify from 'dompurify';
+
+export enum ConfigType {
+  DOMPurify = 'DOMPurify',
+}
+
+export const isDOMPurifyConfig = (req: SanitizeRequest): req is SanitizeRequest<ConfigType.DOMPurify> => req.configType === ConfigType.DOMPurify;
+
+const allConfigTypes = Object.values(ConfigType);
+
+export type ConfigTypeToConfig = {
+  [ConfigType.DOMPurify]: {
+    domPurifyConfig?: DOMPurify.Config;
+    allowAllLinksInSvgUseTags?: boolean;
+  };
+};
+
+export const isSanitizeRequest = (obj: any): obj is SanitizeRequest => {
+  return Boolean(obj?.content) && allConfigTypes.includes(obj.configType) && typeof obj.config === 'object';
+};
+
+export type SanitizeRequest<configType extends ConfigType = ConfigType> = {
+  content: Buffer;
+  configType: configType;
+  config: ConfigTypeToConfig[configType];
+};
+
+export type SanitizeResponse = {
+  sanitized: Buffer;
+};

src/service/http-server.ts

@@ -9,10 +9,11 @@ import { Logger } from '../logger';
 import { Browser, createBrowser } from '../browser';
 import { ServiceConfig } from '../config';
 import { setupHttpServerMetrics } from './metrics_middleware';
-import { HTTPHeaders, ImageRenderOptions, isSanitizeRequest, RenderOptions } from '../types';
+import { HTTPHeaders, ImageRenderOptions, RenderOptions } from '../types';
 import { Sanitizer } from '../sanitizer/Sanitizer';
 import * as bodyParser from 'body-parser';
 import * as multer from 'multer';
+import { isSanitizeRequest } from '../sanitizer/types';
 
 const upload = multer({ storage: multer.memoryStorage() });
 

src/types.ts

@@ -1,5 +1,3 @@
-import * as DOMPurify from 'dompurify';
-
 export interface HTTPHeaders {
   'Accept-Language'?: string;
   [header: string]: string | undefined;
@@ -27,32 +25,3 @@ export interface ImageRenderOptions extends RenderOptions {
   fullPageImage?: boolean;
   scaleImage?: number;
 }
-
-export enum ConfigType {
-  DOMPurify = 'DOMPurify',
-}
-
-export const isDOMPurifyConfig = (req: SanitizeRequest): req is SanitizeRequest<ConfigType.DOMPurify> => req.configType === ConfigType.DOMPurify;
-
-const allConfigTypes = Object.values(ConfigType);
-
-export type ConfigTypeToConfig = {
-  [ConfigType.DOMPurify]: {
-    domPurifyConfig?: DOMPurify.Config;
-    allowAllLinksInSvgUseTags?: boolean;
-  };
-};
-
-export const isSanitizeRequest = (obj: any): obj is SanitizeRequest => {
-  return Boolean(obj?.content) && allConfigTypes.includes(obj.configType) && typeof obj.config === 'object';
-};
-
-export type SanitizeRequest<configType extends ConfigType = ConfigType> = {
-  content: Buffer;
-  configType: configType;
-  config: ConfigTypeToConfig[configType];
-};
-
-export type SanitizeResponse = {
-  sanitized: Buffer;
-};