@webpieces/core-util 0.3.285 → 0.3.287

package/src/http/PlatformHeader.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlatformHeader = void 0;
-/**
- * PlatformHeader - Defines an HTTP header that can be transferred between services.
- *
- * Port of Java PlatformHeaders, simplified:
- * - No isWantLogged flag (deprecated in Java) - "wants MDC logging" is expressed
- *   by setting loggerMdcKey. Headers without one still appear in API logs
- *   (masked when isSecured); they just aren't exposed as an MDC dimension key.
- *
- * Implements Header interface from core-util to avoid circular dependencies.
- *
- * Per CLAUDE.md: "All data-only structures MUST be classes, not interfaces."
- * This is a data-only class with no business logic methods.
- */
-class PlatformHeader {
-    /**
-     * The HTTP header name (e.g., 'x-request-id', 'x-tenant-id').
-     * Also used as the MDC logging key in RequestContext.
-     * Case-insensitive per HTTP spec, but stored in canonical form.
-     */
-    headerName;
-    /**
-     * Whether this header should be transferred from HTTP request to RequestContext.
-     * If false, header is defined but not automatically transferred.
-     * Only headers with isWantTransferred=true are copied from incoming requests.
-     */
-    isWantTransferred;
-    /**
-     * Whether this header contains sensitive data that should be secured/masked in logs.
-     * Examples: Authorization tokens, passwords, API keys.
-     */
-    isSecured;
-    /**
-     * Whether this header should be used as a dimension for metrics/monitoring.
-     * Examples: x-tenant-id, x-request-id (for distributed tracing).
-     */
-    isDimensionForMetrics;
-    /**
-     * Key used when exposing this header to the logger's MDC / structured log
-     * dimensions. Port of Java getLoggerMDCKey(). When set, log maps key this
-     * header by it instead of headerName (e.g. 'requestId' vs 'x-request-id').
-     * Undefined = not an MDC dimension (Java: getLoggerMDCKey() == null).
-     */
-    loggerMdcKey;
-    constructor(headerName, isWantTransferred = true, isSecured = false, isDimensionForMetrics = false, loggerMdcKey) {
-        this.headerName = headerName;
-        this.isWantTransferred = isWantTransferred;
-        this.isSecured = isSecured;
-        this.isDimensionForMetrics = isDimensionForMetrics;
-        this.loggerMdcKey = loggerMdcKey;
-    }
-    /**
-     * Get the header name (implements Header interface).
-     * @returns The HTTP header name
-     */
-    getHeaderName() {
-        return this.headerName;
-    }
-}
-exports.PlatformHeader = PlatformHeader;
-//# sourceMappingURL=PlatformHeader.js.map

package/src/http/PlatformHeader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlatformHeader.js","sourceRoot":"","sources":["../../../../../../packages/core/core-util/src/http/PlatformHeader.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IACvB;;;;OAIG;IACM,UAAU,CAAS;IAE5B;;;;OAIG;IACM,iBAAiB,CAAU;IAEpC;;;OAGG;IACM,SAAS,CAAU;IAE5B;;;OAGG;IACM,qBAAqB,CAAU;IAExC;;;;;OAKG;IACM,YAAY,CAAU;IAE/B,YACI,UAAkB,EAClB,oBAA6B,IAAI,EACjC,YAAqB,KAAK,EAC1B,wBAAiC,KAAK,EACtC,YAAqB;QAErB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,aAAa;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;CACJ;AAxDD,wCAwDC","sourcesContent":["import { Header } from '../Header';\n\n/**\n * PlatformHeader - Defines an HTTP header that can be transferred between services.\n *\n * Port of Java PlatformHeaders, simplified:\n * - No isWantLogged flag (deprecated in Java) - \"wants MDC logging\" is expressed\n *   by setting loggerMdcKey. Headers without one still appear in API logs\n *   (masked when isSecured); they just aren't exposed as an MDC dimension key.\n *\n * Implements Header interface from core-util to avoid circular dependencies.\n *\n * Per CLAUDE.md: \"All data-only structures MUST be classes, not interfaces.\"\n * This is a data-only class with no business logic methods.\n */\nexport class PlatformHeader implements Header {\n    /**\n     * The HTTP header name (e.g., 'x-request-id', 'x-tenant-id').\n     * Also used as the MDC logging key in RequestContext.\n     * Case-insensitive per HTTP spec, but stored in canonical form.\n     */\n    readonly headerName: string;\n\n    /**\n     * Whether this header should be transferred from HTTP request to RequestContext.\n     * If false, header is defined but not automatically transferred.\n     * Only headers with isWantTransferred=true are copied from incoming requests.\n     */\n    readonly isWantTransferred: boolean;\n\n    /**\n     * Whether this header contains sensitive data that should be secured/masked in logs.\n     * Examples: Authorization tokens, passwords, API keys.\n     */\n    readonly isSecured: boolean;\n\n    /**\n     * Whether this header should be used as a dimension for metrics/monitoring.\n     * Examples: x-tenant-id, x-request-id (for distributed tracing).\n     */\n    readonly isDimensionForMetrics: boolean;\n\n    /**\n     * Key used when exposing this header to the logger's MDC / structured log\n     * dimensions. Port of Java getLoggerMDCKey(). When set, log maps key this\n     * header by it instead of headerName (e.g. 'requestId' vs 'x-request-id').\n     * Undefined = not an MDC dimension (Java: getLoggerMDCKey() == null).\n     */\n    readonly loggerMdcKey?: string;\n\n    constructor(\n        headerName: string,\n        isWantTransferred: boolean = true,\n        isSecured: boolean = false,\n        isDimensionForMetrics: boolean = false,\n        loggerMdcKey?: string\n    ) {\n        this.headerName = headerName;\n        this.isWantTransferred = isWantTransferred;\n        this.isSecured = isSecured;\n        this.isDimensionForMetrics = isDimensionForMetrics;\n        this.loggerMdcKey = loggerMdcKey;\n    }\n\n    /**\n     * Get the header name (implements Header interface).\n     * @returns The HTTP header name\n     */\n    getHeaderName(): string {\n        return this.headerName;\n    }\n}\n"]}

package/src/http/PlatformHeadersExtension.d.ts

@@ -1,51 +0,0 @@
-import { PlatformHeader } from './PlatformHeader';
-/**
- * PlatformHeadersExtension - Extension that contributes platform headers to the framework.
- *
- * This is a DI-level extension (not an app-level Plugin).
- * Multiple modules can bind PlatformHeadersExtension instances, and the framework
- * collects them via Inversify @multiInject.
- *
- * Two-level plugin system:
- * 1. **Extensions** (DI-level): Contribute specific capabilities to framework
- *    - Examples: PlatformHeadersExtension, BodyContentExtension, EntityLookupExtension
- *    - Pattern: Bound via multiInject, consumed by framework
- *    - Java equivalent: Multibinder<AddPlatformHeaders>, Multibinder<BodyContentBinder>
- *
- * 2. **Plugins** (App-level): Provide complete features with modules + routes
- *    - Examples: HibernatePlugin, JacksonPlugin, Auth0Plugin
- *    - Pattern: Implements getGuiceModules() + getRouteModules()
- *    - Java equivalent: Plugin interface with getGuiceModules() + getRouteModules()
- *
- * Usage:
- * ```typescript
- * // In WebpiecesModule
- * const coreExtension = new PlatformHeadersExtension([
- *     WebpiecesCoreHeaders.REQUEST_ID,
- *     WebpiecesCoreHeaders.CORRELATION_ID,
- * ]);
- * bind(HEADER_TYPES.PlatformHeadersExtension).toConstantValue(coreExtension);
- *
- * // In CompanyModule
- * const companyExtension = new PlatformHeadersExtension([
- *     CompanyHeaders.TENANT_ID,
- *     CompanyHeaders.API_VERSION,
- * ]);
- * bind(HEADER_TYPES.PlatformHeadersExtension).toConstantValue(companyExtension);
- *
- * // Framework collects all extensions
- * constructor(@multiInject(HEADER_TYPES.PlatformHeadersExtension) extensions: PlatformHeadersExtension[]) {}
- * ```
- */
-export declare class PlatformHeadersExtension {
-    /**
-     * The set of platform headers contributed by this extension.
-     */
-    readonly headers: PlatformHeader[];
-    constructor(headers: PlatformHeader[]);
-    /**
-     * Get all headers from this extension.
-     * @returns Array of platform headers
-     */
-    getHeaders(): PlatformHeader[];
-}

package/src/http/PlatformHeadersExtension.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlatformHeadersExtension = void 0;
-/**
- * PlatformHeadersExtension - Extension that contributes platform headers to the framework.
- *
- * This is a DI-level extension (not an app-level Plugin).
- * Multiple modules can bind PlatformHeadersExtension instances, and the framework
- * collects them via Inversify @multiInject.
- *
- * Two-level plugin system:
- * 1. **Extensions** (DI-level): Contribute specific capabilities to framework
- *    - Examples: PlatformHeadersExtension, BodyContentExtension, EntityLookupExtension
- *    - Pattern: Bound via multiInject, consumed by framework
- *    - Java equivalent: Multibinder<AddPlatformHeaders>, Multibinder<BodyContentBinder>
- *
- * 2. **Plugins** (App-level): Provide complete features with modules + routes
- *    - Examples: HibernatePlugin, JacksonPlugin, Auth0Plugin
- *    - Pattern: Implements getGuiceModules() + getRouteModules()
- *    - Java equivalent: Plugin interface with getGuiceModules() + getRouteModules()
- *
- * Usage:
- * ```typescript
- * // In WebpiecesModule
- * const coreExtension = new PlatformHeadersExtension([
- *     WebpiecesCoreHeaders.REQUEST_ID,
- *     WebpiecesCoreHeaders.CORRELATION_ID,
- * ]);
- * bind(HEADER_TYPES.PlatformHeadersExtension).toConstantValue(coreExtension);
- *
- * // In CompanyModule
- * const companyExtension = new PlatformHeadersExtension([
- *     CompanyHeaders.TENANT_ID,
- *     CompanyHeaders.API_VERSION,
- * ]);
- * bind(HEADER_TYPES.PlatformHeadersExtension).toConstantValue(companyExtension);
- *
- * // Framework collects all extensions
- * constructor(@multiInject(HEADER_TYPES.PlatformHeadersExtension) extensions: PlatformHeadersExtension[]) {}
- * ```
- */
-class PlatformHeadersExtension {
-    /**
-     * The set of platform headers contributed by this extension.
-     */
-    headers;
-    constructor(headers) {
-        this.headers = headers;
-    }
-    /**
-     * Get all headers from this extension.
-     * @returns Array of platform headers
-     */
-    getHeaders() {
-        return this.headers;
-    }
-}
-exports.PlatformHeadersExtension = PlatformHeadersExtension;
-//# sourceMappingURL=PlatformHeadersExtension.js.map

package/src/http/PlatformHeadersExtension.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlatformHeadersExtension.js","sourceRoot":"","sources":["../../../../../../packages/core/core-util/src/http/PlatformHeadersExtension.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAa,wBAAwB;IACjC;;OAEG;IACM,OAAO,CAAmB;IAEnC,YAAY,OAAyB;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;CACJ;AAjBD,4DAiBC","sourcesContent":["import { PlatformHeader } from './PlatformHeader';\n\n/**\n * PlatformHeadersExtension - Extension that contributes platform headers to the framework.\n *\n * This is a DI-level extension (not an app-level Plugin).\n * Multiple modules can bind PlatformHeadersExtension instances, and the framework\n * collects them via Inversify @multiInject.\n *\n * Two-level plugin system:\n * 1. **Extensions** (DI-level): Contribute specific capabilities to framework\n *    - Examples: PlatformHeadersExtension, BodyContentExtension, EntityLookupExtension\n *    - Pattern: Bound via multiInject, consumed by framework\n *    - Java equivalent: Multibinder<AddPlatformHeaders>, Multibinder<BodyContentBinder>\n *\n * 2. **Plugins** (App-level): Provide complete features with modules + routes\n *    - Examples: HibernatePlugin, JacksonPlugin, Auth0Plugin\n *    - Pattern: Implements getGuiceModules() + getRouteModules()\n *    - Java equivalent: Plugin interface with getGuiceModules() + getRouteModules()\n *\n * Usage:\n * ```typescript\n * // In WebpiecesModule\n * const coreExtension = new PlatformHeadersExtension([\n *     WebpiecesCoreHeaders.REQUEST_ID,\n *     WebpiecesCoreHeaders.CORRELATION_ID,\n * ]);\n * bind(HEADER_TYPES.PlatformHeadersExtension).toConstantValue(coreExtension);\n *\n * // In CompanyModule\n * const companyExtension = new PlatformHeadersExtension([\n *     CompanyHeaders.TENANT_ID,\n *     CompanyHeaders.API_VERSION,\n * ]);\n * bind(HEADER_TYPES.PlatformHeadersExtension).toConstantValue(companyExtension);\n *\n * // Framework collects all extensions\n * constructor(@multiInject(HEADER_TYPES.PlatformHeadersExtension) extensions: PlatformHeadersExtension[]) {}\n * ```\n */\nexport class PlatformHeadersExtension {\n    /**\n     * The set of platform headers contributed by this extension.\n     */\n    readonly headers: PlatformHeader[];\n\n    constructor(headers: PlatformHeader[]) {\n        this.headers = headers;\n    }\n\n    /**\n     * Get all headers from this extension.\n     * @returns Array of platform headers\n     */\n    getHeaders(): PlatformHeader[] {\n        return this.headers;\n    }\n}\n"]}