@bymax-one/nest-core 1.0.0 → 1.1.0

package/dist/health/index.d.cts

@@ -1,3 +1,35 @@
+import { CustomDecorator } from '@nestjs/common';
+
+/**
+ * Reflect metadata key carrying the discoverable marker. Namespaced so it cannot
+ * collide with a consumer's own metadata, and exported so a test — or a sibling
+ * library's own conformance suite — can assert a class is marked without
+ * depending on how the decorator is implemented.
+ */
+declare const BYMAX_HEALTH_INDICATOR_METADATA = "bymax-one:health-indicator";
+/**
+ * Mark a provider class as a readiness indicator, so `BymaxCoreModule` discovers
+ * it without the application registering it by hand.
+ *
+ * The class must implement `IHealthIndicator`; a marked provider that does not
+ * fails at bootstrap with a message naming it, rather than being skipped
+ * silently. Discovery has to be enabled (`health.autoDiscover`) for the marker to
+ * be read at all — marking a class in an application that never enables it costs
+ * one metadata entry and changes nothing.
+ *
+ * @returns The class decorator carrying the marker.
+ * @example
+ *   \@BymaxHealthIndicator()
+ *   \@Injectable()
+ *   export class RedisHealthIndicator implements IHealthIndicator {
+ *     readonly name = 'redis'
+ *     async check(): Promise<HealthIndicatorResult> {
+ *       return { status: 'up' }
+ *     }
+ *   }
+ */
+declare function BymaxHealthIndicator(): CustomDecorator<string>;
+
 /**
  * @fileoverview Health-check contracts. Consumers implement
  * {@link IHealthIndicator} against a client they already own (a cache, a
@@ -61,4 +93,4 @@ interface HealthResponse {
     checks: HealthCheckEntry[];
 }
 
-export type { HealthCheckEntry, HealthIndicatorResult, HealthResponse, IHealthIndicator };
+export { BYMAX_HEALTH_INDICATOR_METADATA, BymaxHealthIndicator, type HealthCheckEntry, type HealthIndicatorResult, type HealthResponse, type IHealthIndicator };

package/dist/health/index.d.ts

@@ -1,3 +1,35 @@
+import { CustomDecorator } from '@nestjs/common';
+
+/**
+ * Reflect metadata key carrying the discoverable marker. Namespaced so it cannot
+ * collide with a consumer's own metadata, and exported so a test — or a sibling
+ * library's own conformance suite — can assert a class is marked without
+ * depending on how the decorator is implemented.
+ */
+declare const BYMAX_HEALTH_INDICATOR_METADATA = "bymax-one:health-indicator";
+/**
+ * Mark a provider class as a readiness indicator, so `BymaxCoreModule` discovers
+ * it without the application registering it by hand.
+ *
+ * The class must implement `IHealthIndicator`; a marked provider that does not
+ * fails at bootstrap with a message naming it, rather than being skipped
+ * silently. Discovery has to be enabled (`health.autoDiscover`) for the marker to
+ * be read at all — marking a class in an application that never enables it costs
+ * one metadata entry and changes nothing.
+ *
+ * @returns The class decorator carrying the marker.
+ * @example
+ *   \@BymaxHealthIndicator()
+ *   \@Injectable()
+ *   export class RedisHealthIndicator implements IHealthIndicator {
+ *     readonly name = 'redis'
+ *     async check(): Promise<HealthIndicatorResult> {
+ *       return { status: 'up' }
+ *     }
+ *   }
+ */
+declare function BymaxHealthIndicator(): CustomDecorator<string>;
+
 /**
  * @fileoverview Health-check contracts. Consumers implement
  * {@link IHealthIndicator} against a client they already own (a cache, a
@@ -61,4 +93,4 @@ interface HealthResponse {
     checks: HealthCheckEntry[];
 }
 
-export type { HealthCheckEntry, HealthIndicatorResult, HealthResponse, IHealthIndicator };
+export { BYMAX_HEALTH_INDICATOR_METADATA, BymaxHealthIndicator, type HealthCheckEntry, type HealthIndicatorResult, type HealthResponse, type IHealthIndicator };

package/dist/health/index.mjs

@@ -1 +1,9 @@
+import { SetMetadata } from '@nestjs/common';
 
+// src/health/health.marker.ts
+var BYMAX_HEALTH_INDICATOR_METADATA = "bymax-one:health-indicator";
+function BymaxHealthIndicator() {
+  return SetMetadata(BYMAX_HEALTH_INDICATOR_METADATA, true);
+}
+
+export { BYMAX_HEALTH_INDICATOR_METADATA, BymaxHealthIndicator };