secure-kit

Version:

Production-grade security + performance toolkit for backend frameworks with OWASP Top 10 compliance

metadevzone.github.io/secure-kit/

11 lines • 342 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConfigManager | secure-backend</title><meta name="description" content="Documentation for secure-backend"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">secure-backend</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">secure-backend</a></li><li><a href="ConfigManager.html">ConfigManager</a></li></ul><h1>Class ConfigManager</h1></div><aside class="tsd-sources"><ul><li>Defined in src/core/config.ts:3</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ConfigManager.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg>constructor</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ConfigManager.html#PRESETS" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg>PRESETS</a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ConfigManager.html#applyEnvironmentOverrides" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>applyEnvironmentOverrides</a> <a href="ConfigManager.html#createConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>createConfig</a> <a href="ConfigManager.html#deepMerge" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>deepMerge</a> <a href="ConfigManager.html#getConfigSummary" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>getConfigSummary</a> <a href="ConfigManager.html#getDefaultConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>getDefaultConfig</a> <a href="ConfigManager.html#getPreset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>getPreset</a> <a href="ConfigManager.html#mergeConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>mergeConfig</a> <a href="ConfigManager.html#validateConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg>validateConfig</a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ConfigManager" class="tsd-anchor"></a>new ConfigManager(): <a href="ConfigManager.html" class="tsd-signature-type tsd-kind-class">ConfigManager</a><a href="#constructor.new_ConfigManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="ConfigManager.html" class="tsd-signature-type tsd-kind-class">ConfigManager</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="PRESETS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> PRESETS<a href="#PRESETS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature">PRESETS: { api: { environment: { https: boolean; production: boolean; }; logging: { enabled: boolean; failedLogins: boolean; format: string; level: string; rateLimitViolations: boolean; suspiciousRequests: boolean; }; performance: { caching: { enabled: boolean; etag: boolean; lastModified: boolean; maxAge: number; }; compression: { brotli: boolean; enabled: boolean; level: number; threshold: number; }; monitoring: { enabled: boolean; largePayloadThreshold: number; logLargePayloads: boolean; logSlowRequests: boolean; slowRequestThreshold: number; }; }; security: { auth: { jwt: { algorithms: string[]; maxAge: number; }; }; cors: { credentials: boolean; origin: boolean; }; csrf: { cookieName: string; enabled: boolean; excludedMethods: string[]; headerName: string; tokenLength: number; }; fileUpload: { allowedExtensions: string[]; allowedMimeTypes: string[]; enabled: boolean; maxFileSize: number; stripMetadata: boolean; }; headers: { crossOriginEmbedderPolicy: string; crossOriginOpenerPolicy: string; crossOriginResourcePolicy: string; csp: { connectSrc: string[]; defaultSrc: string[]; fontSrc: string[]; frameSrc: string[]; imgSrc: string[]; mediaSrc: string[]; objectSrc: string[]; scriptSrc: string[]; styleSrc: string[]; }; permissionsPolicy: { camera: string[]; geolocation: string[]; microphone: string[]; payment: string[]; }; referrerPolicy: string; xContentTypeOptions: boolean; xFrameOptions: string; }; rateLimit: { enabled: boolean; max: number; message: string; statusCode: number; windowMs: number; }; sanitization: { enabled: boolean; maxBodySize: number; maxQuerySize: number; noSqlInjection: boolean; sqlInjection: boolean; xss: boolean; }; }; }; strict: { environment: { https: boolean; production: boolean; }; logging: { enabled: boolean; failedLogins: boolean; format: string; level: string; rateLimitViolations: boolean; suspiciousRequests: boolean; }; performance: { caching: { enabled: boolean; etag: boolean; lastModified: boolean; maxAge: number; }; compression: { brotli: boolean; enabled: boolean; level: number; threshold: number; }; monitoring: { enabled: boolean; largePayloadThreshold: number; logLargePayloads: boolean; logSlowRequests: boolean; slowRequestThreshold: number; }; }; security: { auth: { jwt: { algorithms: string[]; maxAge: number; }; session: { httpOnly: boolean; maxAge: number; sameSite: string; secure: boolean; }; }; cors: { credentials: boolean; origin: boolean; }; csrf: { cookieName: string; cookieOptions: { httpOnly: boolean; maxAge: number; sameSite: string; secure: boolean; }; enabled: boolean; excludedMethods: string[]; headerName: string; tokenLength: number; }; fileUpload: { enabled: boolean; }; headers: { crossOriginEmbedderPolicy: string; crossOriginOpenerPolicy: string; crossOriginResourcePolicy: string; csp: { connectSrc: string[]; defaultSrc: string[]; fontSrc: string[]; frameSrc: string[]; imgSrc: string[]; mediaSrc: string[]; objectSrc: string[]; reportUri: string; scriptSrc: string[]; styleSrc: string[]; }; hsts: { includeSubDomains: boolean; maxAge: number; preload: boolean; }; permissionsPolicy: { accelerometer: string[]; camera: string[]; geolocation: string[]; gyroscope: string[]; magnetometer: string[]; microphone: string[]; payment: string[]; usb: string[]; }; referrerPolicy: string; xContentTypeOptions: boolean; xFrameOptions: string; }; rateLimit: { enabled: boolean; max: number; message: string; statusCode: number; windowMs: number; }; sanitization: { enabled: boolean; maxBodySize: number; maxQuerySize: number; noSqlInjection: boolean; sqlInjection: <span class