@fluojs/terminus 1.0.3 → 1.0.4

package/README.ko.md

@@ -30,8 +30,6 @@ Redis indicator subpath를 사용할 때만 선택적 peer를 설치하세요.
 pnpm add @fluojs/redis ioredis
 ```
 
-`path`로 health endpoint를 custom path 아래에 mount할 수 있고, `readinessChecks`로 애플리케이션별 readiness logic을 Terminus indicator 및 platform readiness check와 합성할 수 있습니다.
-
 ## 사용 시점
 
 - 외부 의존성(데이터베이스, Redis, API 등)의 상태를 애플리케이션 헬스 체크 결과에 포함해야 할 때.
@@ -74,7 +72,7 @@ class AppModule {}
 
 ### DI 기반 인디케이터
 
-Redis나 DB 클라이언트와 같이 DI 컨테이너의 의존성이 필요한 인디케이터를 사용할 때는, 모듈 로드 시점에 피어 의존성을 import하지 않도록 제공되는 provider 팩토리를 사용하세요.
+Redis나 DB 클라이언트와 같이 DI 컨테이너의 의존성이 필요한 인디케이터를 사용할 때는, 모듈 로드 시점에 피어 의존성을 import하지 않도록 문서화된 provider 팩토리를 사용하세요. 이 helper들은 `TerminusModule.forRoot({ indicatorProviders })`에 전달할 indicator provider entry를 만들며 module facade를 대체하지 않습니다.
 
 ```typescript
 import { TerminusModule } from '@fluojs/terminus';
@@ -119,6 +117,8 @@ TerminusModule.forRoot({
 });
 ```
 
+`path`로 health endpoint를 custom path 아래에 mount할 수 있고, `readinessChecks`로 애플리케이션별 readiness logic을 Terminus indicator 및 platform readiness check와 합성할 수 있습니다.
+
 ### 실패 시맨틱
 
 인디케이터가 실패하면 `HealthCheckError`를 던집니다. `TerminusHealthService`는 이 실패들을 모아 보고서를 작성합니다.
@@ -154,7 +154,7 @@ TerminusModule.forRoot({
 
 - `runHealthCheck(...)`, `assertHealthCheck(...)`: 직접 aggregation/testing helper입니다.
 - `TERMINUS_HEALTH_INDICATORS`, `TERMINUS_INDICATOR_PROVIDER_TOKENS`: 등록된 indicator와 provider token을 위한 DI token입니다.
-- Built-in indicator는 `create*HealthIndicator()` 및 `create*HealthIndicatorProvider()` helper도 노출합니다.
+- Built-in indicator는 `create*HealthIndicator()` 및 `create*HealthIndicatorProvider()` helper도 노출합니다. Provider helper는 `indicatorProviders`를 위한 의도적인 DI composition 예외이며, 애플리케이션 등록은 계속 `TerminusModule.forRoot(...)`를 사용해야 합니다.
 
 ### `@fluojs/terminus/redis`
 

package/README.md

@@ -72,7 +72,7 @@ The package provides several indicators out of the box:
 
 ### DI-Backed Indicators
 
-To use indicators that require dependencies from the DI container (like Redis or Database clients) without importing peer dependencies at module load time, use the provider factories.
+To use indicators that require dependencies from the DI container (like Redis or Database clients) without importing peer dependencies at module load time, use the documented provider factories. These helpers create indicator provider entries for `TerminusModule.forRoot({ indicatorProviders })`; they do not replace the module facade.
 
 ```typescript
 import { TerminusModule } from '@fluojs/terminus';
@@ -154,7 +154,7 @@ When an indicator fails, it throws a `HealthCheckError`. The `TerminusHealthServ
 
 - `runHealthCheck(...)`, `assertHealthCheck(...)`: Direct aggregation/testing helpers.
 - `TERMINUS_HEALTH_INDICATORS`, `TERMINUS_INDICATOR_PROVIDER_TOKENS`: DI tokens for registered indicators and provider tokens.
-- Built-in indicators also expose `create*HealthIndicator()` and `create*HealthIndicatorProvider()` helpers.
+- Built-in indicators also expose `create*HealthIndicator()` and `create*HealthIndicatorProvider()` helpers. Provider helpers are intentional DI-composition exceptions for `indicatorProviders`, while application registration should still go through `TerminusModule.forRoot(...)`.
 
 ### `@fluojs/terminus/redis`
 

package/dist/indicators/memory.d.ts

@@ -1,17 +1,28 @@
 import type { Provider } from '@fluojs/di';
 import type { HealthIndicator, HealthIndicatorResult } from '../types.js';
+/** Snapshot returned by a memory usage sampler. */
+export interface MemoryUsageSnapshot {
+    arrayBuffers: number;
+    external: number;
+    heapTotal: number;
+    heapUsed: number;
+    rss: number;
+}
+/** Function that samples runtime memory usage for `MemoryHealthIndicator`. */
+export type MemoryUsageSampler = () => MemoryUsageSnapshot;
 /** Options for checking process heap and RSS thresholds. */
 export interface MemoryHealthIndicatorOptions {
     heapUsedThresholdBytes?: number;
     heapUsedThresholdRatio?: number;
     key?: string;
+    memoryUsage?: MemoryUsageSampler;
     rssThresholdBytes?: number;
 }
 /**
  * Create a process-memory health indicator.
  *
  * @param options Optional heap and RSS thresholds plus an indicator key override.
- * @returns A health indicator backed by `process.memoryUsage()`.
+ * @returns A health indicator backed by the Node runtime memory sampler.
  */
 export declare function createMemoryHealthIndicator(options?: MemoryHealthIndicatorOptions): HealthIndicator;
 /**

package/dist/indicators/memory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/indicators/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAE1E,4DAA4D;AAC5D,MAAM,WAAW,4BAA4B;IAC3C,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAYD;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,GAAE,4BAAiC,GAAG,eAAe,CAEvG;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,OAAO,GAAE,4BAAiC,GAAG,QAAQ,CAOxG;AAED,qEAAqE;AACrE,qBAAa,qBAAsB,YAAW,eAAe;IAG/C,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEJ,OAAO,GAAE,4BAAiC;IAIjE,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAiCzD"}
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/indicators/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAI3C,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAE1E,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,MAAM,mBAAmB,CAAC;AAE3D,4DAA4D;AAC5D,MAAM,WAAW,4BAA4B;IAC3C,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAYD;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,GAAE,4BAAiC,GAAG,eAAe,CAEvG;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,OAAO,GAAE,4BAAiC,GAAG,QAAQ,CAOxG;AAED,qEAAqE;AACrE,qBAAa,qBAAsB,YAAW,eAAe;IAG/C,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEJ,OAAO,GAAE,4BAAiC;IAIjE,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAiCzD"}

package/dist/indicators/memory.js

@@ -1,4 +1,9 @@
 import { createDownResult, createUpResult, resolveIndicatorKey, throwHealthCheckError } from './utils.js';
+import { readNodeMemoryUsage } from '../node-runtime.js';
+
+/** Snapshot returned by a memory usage sampler. */
+
+/** Function that samples runtime memory usage for `MemoryHealthIndicator`. */
 
 /** Options for checking process heap and RSS thresholds. */
 
@@ -14,7 +19,7 @@ function exceedsRatioThreshold(used, total, threshold) {
  * Create a process-memory health indicator.
  *
  * @param options Optional heap and RSS thresholds plus an indicator key override.
- * @returns A health indicator backed by `process.memoryUsage()`.
+ * @returns A health indicator backed by the Node runtime memory sampler.
  */
 export function createMemoryHealthIndicator(options = {}) {
   return new MemoryHealthIndicator(options);
@@ -44,7 +49,7 @@ export class MemoryHealthIndicator {
   async check(key) {
     const indicatorKey = resolveIndicatorKey('memory', this.options.key ?? key);
     const heapRatioThreshold = this.options.heapUsedThresholdRatio ?? DEFAULT_HEAP_RATIO_THRESHOLD;
-    const usage = process.memoryUsage();
+    const usage = (this.options.memoryUsage ?? readNodeMemoryUsage)();
     const usageDetails = {
       arrayBuffers: usage.arrayBuffers,
       external: usage.external,

package/dist/node-runtime.d.ts

@@ -0,0 +1,11 @@
+interface NodeMemoryUsageSnapshot {
+    arrayBuffers: number;
+    external: number;
+    heapTotal: number;
+    heapUsed: number;
+    rss: number;
+}
+/** Read Node.js process memory usage through the Terminus Node runtime seam. */
+export declare function readNodeMemoryUsage(): NodeMemoryUsageSnapshot;
+export {};
+//# sourceMappingURL=node-runtime.d.ts.map

package/dist/node-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-runtime.d.ts","sourceRoot":"","sources":["../src/node-runtime.ts"],"names":[],"mappings":"AAAA,UAAU,uBAAuB;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAkBD,gFAAgF;AAChF,wBAAgB,mBAAmB,IAAI,uBAAuB,CAQ7D"}

package/dist/node-runtime.js

@@ -0,0 +1,13 @@
+function resolveNodeProcess() {
+  const runtimeGlobal = globalThis;
+  return runtimeGlobal.process;
+}
+
+/** Read Node.js process memory usage through the Terminus Node runtime seam. */
+export function readNodeMemoryUsage() {
+  const memoryUsage = resolveNodeProcess()?.memoryUsage;
+  if (typeof memoryUsage !== 'function') {
+    throw new Error('Node.js process.memoryUsage() is not available in this runtime.');
+  }
+  return memoryUsage();
+}

package/package.json

@@ -9,7 +9,7 @@
     "liveness",
     "health-check"
   ],
-  "version": "1.0.3",
+  "version": "1.0.4",
   "private": false,
   "license": "MIT",
   "repository": {
@@ -45,14 +45,14 @@
   ],
   "dependencies": {
     "@fluojs/core": "^1.0.3",
-    "@fluojs/di": "^1.0.3",
+    "@fluojs/di": "^1.1.0",
     "@fluojs/http": "^1.1.0",
-    "@fluojs/runtime": "^1.1.1"
+    "@fluojs/runtime": "^1.1.6"
   },
   "peerDependencies": {
-    "@fluojs/drizzle": "^1.0.1",
-    "@fluojs/prisma": "^1.0.1",
-    "@fluojs/redis": "^1.0.0"
+    "@fluojs/drizzle": "^1.0.2",
+    "@fluojs/prisma": "^1.0.2",
+    "@fluojs/redis": "^1.0.1"
   },
   "peerDependenciesMeta": {
     "@fluojs/drizzle": {
@@ -67,7 +67,7 @@
   },
   "devDependencies": {
     "vitest": "^3.2.4",
-    "@fluojs/testing": "^1.0.3"
+    "@fluojs/testing": "^1.0.5"
   },
   "scripts": {
     "prebuild": "node ../../tooling/scripts/clean-dist.mjs",