@ehildt/nestjs-config-factory 1.0.0 → 1.1.0

package/README.md

@@ -18,9 +18,9 @@ A NestJS configuration library providing decorators and modules for caching retu
 
 # StatusBadges
 
-![github](https://img.shields.io/github/release/ehildt/nestjs--config--factory?labelColor=333&style=for-the-badge&cacheSeconds=3600&color=b16425&logo=github&logoColor=b16425&logoWidth=40&branch=main)
-![github](https://img.shields.io/github/stars/ehildt/nestjs--config--factory?labelColor=333&style=for-the-badge&cacheSeconds=3600&color=b16425&logo=github&logoColor=b16425&logoWidth=40&branch=main)
-![github](https://img.shields.io/github/license/ehildt/nestjs--config--factory?labelColor=333&style=for-the-badge&cacheSeconds=3600&color=b16425&logo=github&logoColor=b16425&logoWidth=40&branch=main)
+![github](https://img.shields.io/github/release/ehildt/nestjs-config-factory?labelColor=333&style=for-the-badge&cacheSeconds=3600&color=b16425&logo=github&logoColor=b16425&logoWidth=40&branch=main)
+![github](https://img.shields.io/github/stars/ehildt/nestjs-config-factory?labelColor=333&style=for-the-badge&cacheSeconds=3600&color=b16425&logo=github&logoColor=b16425&logoWidth=40&branch=main)
+![github](https://img.shields.io/github/license/ehildt/nestjs-config-factory?labelColor=333&style=for-the-badge&cacheSeconds=3600&color=b16425&logo=github&logoColor=b16425&logoWidth=40&branch=main)
 
 </div>
 

package/dist/cache-return-value/index.d.ts

@@ -1,5 +1,9 @@
 import Joi from 'joi';
 
-declare function CacheReturnValue<T = unknown>(schema?: Joi.Schema<T>): MethodDecorator & PropertyDecorator;
+interface CacheConfig<T = unknown> {
+    schema?: Joi.Schema<T>;
+    ttl?: number | false;
+}
+declare function CacheReturnValue<T = unknown>(config?: Joi.Schema<T> | CacheConfig<T> | false): MethodDecorator & PropertyDecorator;
 
-export { CacheReturnValue };
+export { type CacheConfig, CacheReturnValue };

package/dist/cache-return-value/index.mjs

@@ -12,24 +12,69 @@ var ValidateReturnValueError = class extends Error {
 };
 
 // src/cache-return-value/cache-return-value.decorator.ts
-function CacheReturnValue(schema) {
+var DEFAULT_TTL_MS = 5 * 60 * 1e3;
+function isJoiSchema(value) {
+  return typeof value === "object" && value !== null && "type" in value && typeof value.validate === "function";
+}
+function parseConfig(config) {
+  if (config === false) return { ttl: false };
+  if (config === void 0) return { ttl: DEFAULT_TTL_MS };
+  if (typeof config === "number") return { ttl: config };
+  if (isJoiSchema(config)) return { schema: config, ttl: DEFAULT_TTL_MS };
+  return {
+    schema: config.schema,
+    ttl: config.ttl ?? DEFAULT_TTL_MS
+  };
+}
+function validateValue(value, schema) {
+  if (schema) {
+    const { error, value: validated } = schema.validate(value, {
+      abortEarly: false
+    });
+    if (error) throw new ValidateReturnValueError(`Schema violation`, error.details);
+    return validated;
+  }
+  return value;
+}
+function isExpired(entry, ttl) {
+  if (ttl === false) return false;
+  return Date.now() - entry.timestamp > ttl;
+}
+function CacheReturnValue(config) {
   return function(_target, propertyKey, descriptor) {
+    const { schema, ttl } = parseConfig(config);
+    const setCache = (instance, key, value, refreshPromise) => {
+      let instanceCache = INSTANCE_CACHE.get(instance);
+      if (!instanceCache) {
+        instanceCache = /* @__PURE__ */ new Map();
+        INSTANCE_CACHE.set(instance, instanceCache);
+      }
+      instanceCache.set(key, { value, timestamp: Date.now(), refreshPromise });
+    };
     if (descriptor?.get) {
       const originalGet = descriptor.get;
       descriptor.get = function() {
         const cache = getCacheFor(this);
-        if (!cache.has(String(propertyKey))) {
-          let value = originalGet.call(this);
-          if (schema) {
-            const { error, value: validated } = schema.validate(value, {
-              abortEarly: false
-            });
-            if (error) throw new ValidateReturnValueError(`Schema violation`, error.details);
-            value = validated;
-          }
-          cache.set(String(propertyKey), value);
+        const key = String(propertyKey);
+        const entry = cache.get(key);
+        if (!entry) {
+          const value = validateValue(originalGet.call(this), schema);
+          setCache(this, key, value);
+          return value;
         }
-        return cache.get(String(propertyKey));
+        if (!isExpired(entry, ttl)) return entry.value;
+        const staleValue = entry.value;
+        if (entry.refreshPromise) return staleValue;
+        const refreshPromise = (async () => {
+          return validateValue(await originalGet.call(this), schema);
+        })();
+        setCache(this, key, staleValue, refreshPromise);
+        refreshPromise.then((freshValue) => {
+          setCache(this, key, freshValue);
+        }).catch(() => {
+          setCache(this, key, staleValue);
+        });
+        return staleValue;
       };
     }
     if (descriptor?.value instanceof Function) {
@@ -37,18 +82,25 @@ function CacheReturnValue(schema) {
       descriptor.value = function(...args) {
         const cache = getCacheFor(this);
         const key = hashPayload(`${String(propertyKey)}:${JSON.stringify(args)}`);
-        if (!cache.has(key)) {
-          let result = originalMethod.apply(this, args);
-          if (schema) {
-            const { error, value: validated } = schema.validate(result, {
-              abortEarly: false
-            });
-            if (error) throw new ValidateReturnValueError(`Schema violation`, error.details);
-            result = validated;
-          }
-          cache.set(key, result);
+        const entry = cache.get(key);
+        if (!entry) {
+          const result = validateValue(originalMethod.apply(this, args), schema);
+          setCache(this, key, result);
+          return result;
         }
-        return cache.get(key);
+        if (!isExpired(entry, ttl)) return entry.value;
+        const staleValue = entry.value;
+        if (entry.refreshPromise) return staleValue;
+        const refreshPromise = (async () => {
+          return validateValue(await originalMethod.apply(this, args), schema);
+        })();
+        setCache(this, key, staleValue, refreshPromise);
+        refreshPromise.then((freshValue) => {
+          setCache(this, key, freshValue);
+        }).catch(() => {
+          setCache(this, key, staleValue);
+        });
+        return staleValue;
       };
     }
   };

package/dist/config-factory/index.mjs

@@ -9,6 +9,20 @@ var __decorateClass = (decorators, target, key, kind) => {
   return result;
 };
 var ConfigFactoryModule = class {
+  /**
+   * Creates a dynamic module with the specified configuration providers.
+   * All providers are automatically exported for use by other modules.
+   *
+   * @param options - Configuration options
+   * @param options.global - Whether to register as a global module
+   * @param options.providers - Array of configuration provider classes
+   *
+   * @example
+   * ConfigFactoryModule.forRoot({
+   *   global: true,
+   *   providers: [DatabaseConfigService, AppConfigService],
+   * });
+   */
   static forRoot({ global = false, providers = [] } = {}) {
     if (!providers.length)
       console.warn("[ConfigFactoryModule] No providers registered.");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ehildt/nestjs-config-factory",
   "description": "A dynamic NestJS module factory designed to register, manage, and expose custom configuration providers throughout the application.",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "MIT",
   "type": "module",
   "exports": {