@tsed/config 8.9.0-beta.4 → 8.9.0-beta.6

package/lib/types/decorators/injectConfigSource.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Injects a specific configuration source by its name.
+ *
+ * @param {string} name - The name of the configuration source to inject.
+ * @return {Function} A decorator that resolves the configuration source dynamically.
+ */
+export declare function InjectConfigSource(name: string): any;

package/lib/types/fn/injectConfigSource.d.ts

@@ -0,0 +1,10 @@
+import { type InvokeOptions } from "@tsed/di";
+import type { ConfigSource } from "../interfaces/ConfigSource.js";
+/**
+ * Injects a configuration source by name and returns it as the specified type.
+ *
+ * @param {string} name - The name of the configuration source to retrieve.
+ * @param {Partial<Pick<InvokeOptions, "useOpts" | "rebuild" | "locals">>} [opts] - Optional invocation options to customize the behavior of the injection.
+ * @return {T} The configuration source cast to the specified type.
+ */
+export declare function injectConfigSource<T extends ConfigSource = ConfigSource>(name: string, opts?: Partial<Pick<InvokeOptions, "useOpts" | "rebuild" | "locals">>): T;

package/lib/types/interfaces/ConfigSource.d.ts

@@ -49,10 +49,11 @@ export type ConfigSourceOnChangeCB = () => void;
 export interface ConfigSource<Opts = any> {
     options: Opts;
     $onInit?(): Promise<void> | void;
+    $onDestroy?(): Promise<void> | void;
     /**
      * Load configuration from the source.
      */
     getAll(): Promise<Record<string, unknown>> | Record<string, unknown>;
-    watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB;
+    watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB | void | Promise<void>;
 }
 export type ConfigurationExtends = (Type<ConfigSource> | ConfigSourceOptions)[];

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/config",
   "description": "Configuration management for Ts.ED",
   "type": "module",
-  "version": "8.9.0-beta.4",
+  "version": "8.9.0-beta.6",
   "keywords": [
     "Ts.ED",
     "Configuration",
@@ -36,6 +36,18 @@
       "types": "./lib/types/providers/json/index.d.ts",
       "import": "./lib/esm/providers/json/index.js",
       "default": "./lib/esm/providers/json/index.js"
+    },
+    "./fn/*": {
+      "tsed-source": "./src/fn/*.ts",
+      "types": "./lib/types/fn/*.ts",
+      "import": "./lib/esm/fn/*.js",
+      "default": "./lib/esm/fn/*.js"
+    },
+    "./decorators/*": {
+      "tsed-source": "./src/decorators/*.ts",
+      "types": "./lib/types/decorators/*.ts",
+      "import": "./lib/esm/decorators/*.js",
+      "default": "./lib/esm/decorators/*.js"
     }
   },
   "scripts": {
@@ -49,11 +61,11 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/ajv": "8.9.0-beta.4",
-    "@tsed/barrels": "8.9.0-beta.4",
-    "@tsed/core": "8.9.0-beta.4",
-    "@tsed/di": "8.9.0-beta.4",
-    "@tsed/typescript": "8.9.0-beta.4",
+    "@tsed/ajv": "8.9.0-beta.6",
+    "@tsed/barrels": "8.9.0-beta.6",
+    "@tsed/core": "8.9.0-beta.6",
+    "@tsed/di": "8.9.0-beta.6",
+    "@tsed/typescript": "8.9.0-beta.6",
     "@types/js-yaml": "4.0.9",
     "dotenv": "^16.5.0",
     "dotenv-expand": "^12.0.2",

package/readme.md

@@ -319,6 +319,53 @@ export class MyCustomConfigSource implements ConfigSource<MyCustomConfigSourceOp
 }
 ```
 
+## Inject configuration source
+
+Given a configuration source, you can inject it in any service or controller using his name.
+
+```typescript
+import {Configuration} from "@tsed/di";
+import "@tsed/config";
+import {withOptions} from "@tsed/config";
+import {MyCustomConfigSource} from "./configs/MyCustomConfigSource.js";
+
+@Configuration({
+  extends: [
+    withOptions(MyCustomConfigSource, {
+      name: "myCustomConfig"
+    })
+  ]
+})
+export class Server {}
+```
+
+Then you can inject it in your service or controller using the `@InjectConfigSource` decorator:
+
+```typescript
+import {Injectable, Inject} from "@tsed/di";
+import {InjectConfigSource} from "@tsed/config/decorators/injectConfigSource.js";
+import {MyCustomConfigSource} from "./configs/MyCustomConfigSource.js";
+
+@Injectable()
+export class MyService {
+  @InjectConfigSource("myCustomConfig")
+  configSource: MyCustomConfigSource;
+}
+```
+
+Or using function `injectConfigSource`:
+
+```typescript
+import {Injectable} from "@tsed/di";
+import {injectConfigSource} from "@tsed/config/fn/injectConfigSource.js";
+import {MyCustomConfigSource} from "./configs/MyCustomConfigSource.js";
+
+@Injectable()
+export class MyService {
+  configSource = injectConfigSource<MyCustomConfigSource>("myCustomConfig");
+}
+```
+
 ## Contributors
 
 <a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>

package/src/decorators/injectConfigSource.integration.spec.ts

@@ -0,0 +1,43 @@
+import "../hooks/afterResolveConfiguration.js";
+
+import {DITest, inject, Injectable} from "@tsed/di";
+
+import type {ConfigSource} from "../interfaces/ConfigSource.js";
+import {InjectConfigSource} from "./injectConfigSource.js";
+
+class TestConfigSource implements ConfigSource {
+  options: {
+    hello?: string;
+  };
+
+  getAll() {
+    return Promise.resolve({
+      value: "string",
+      value2: "string-3",
+      ...this.options
+    });
+  }
+}
+
+@Injectable()
+class MyService {
+  @InjectConfigSource("test")
+  config: TestConfigSource;
+}
+
+describe("@InjectConfigSource", () => {
+  describe("without options", () => {
+    beforeEach(() =>
+      DITest.create({
+        extends: [TestConfigSource]
+      })
+    );
+    afterEach(() => DITest.reset());
+
+    it("should inject configuration source", () => {
+      const service = inject(MyService);
+
+      expect(service.config).toBeInstanceOf(TestConfigSource);
+    });
+  });
+});

package/src/decorators/injectConfigSource.ts

@@ -0,0 +1,15 @@
+import {Inject} from "@tsed/di";
+
+import {CONFIG_SOURCES} from "../constants/constants.js";
+
+/**
+ * Injects a specific configuration source by its name.
+ *
+ * @param {string} name - The name of the configuration source to inject.
+ * @return {Function} A decorator that resolves the configuration source dynamically.
+ */
+export function InjectConfigSource(name: string) {
+  return Inject(CONFIG_SOURCES, (configs: CONFIG_SOURCES) => {
+    return configs[name];
+  });
+}

package/src/fn/injectConfigSource.integration.spec.ts

@@ -0,0 +1,42 @@
+import "../hooks/afterResolveConfiguration.js";
+
+import {DITest, inject, Injectable} from "@tsed/di";
+
+import type {ConfigSource} from "../interfaces/ConfigSource.js";
+import {injectConfigSource} from "./injectConfigSource.js";
+
+class TestConfigSource implements ConfigSource {
+  options: {
+    hello?: string;
+  };
+
+  getAll() {
+    return Promise.resolve({
+      value: "string",
+      value2: "string-3",
+      ...this.options
+    });
+  }
+}
+
+@Injectable()
+class MyService {
+  config = injectConfigSource<TestConfigSource>("test");
+}
+
+describe("injectConfigSource()", () => {
+  describe("without options", () => {
+    beforeEach(() =>
+      DITest.create({
+        extends: [TestConfigSource]
+      })
+    );
+    afterEach(() => DITest.reset());
+
+    it("should inject configuration source", () => {
+      const service = inject(MyService);
+
+      expect(service.config).toBeInstanceOf(TestConfigSource);
+    });
+  });
+});

package/src/fn/injectConfigSource.ts

@@ -0,0 +1,20 @@
+import {inject, type InvokeOptions} from "@tsed/di";
+
+import {CONFIG_SOURCES} from "../constants/constants.js";
+import type {ConfigSource} from "../interfaces/ConfigSource.js";
+
+/**
+ * Injects a configuration source by name and returns it as the specified type.
+ *
+ * @param {string} name - The name of the configuration source to retrieve.
+ * @param {Partial<Pick<InvokeOptions, "useOpts" | "rebuild" | "locals">>} [opts] - Optional invocation options to customize the behavior of the injection.
+ * @return {T} The configuration source cast to the specified type.
+ */
+export function injectConfigSource<T extends ConfigSource = ConfigSource>(
+  name: string,
+  opts?: Partial<Pick<InvokeOptions, "useOpts" | "rebuild" | "locals">>
+): T {
+  const configs = inject<CONFIG_SOURCES>(CONFIG_SOURCES, opts);
+
+  return configs[name] as T;
+}

package/src/hooks/afterResolveConfiguration.ts

@@ -1,6 +1,6 @@
 import "@tsed/ajv";
 
-import {configuration, constant, injectable, logger} from "@tsed/di";
+import {configuration, constant, inject, injectable, logger} from "@tsed/di";
 import {$on} from "@tsed/hooks";
 
 import {CONFIG_SOURCES} from "../constants/constants.js";
@@ -18,8 +18,10 @@ export async function afterResolveConfiguration() {
       await instance.$onInit();
     }
 
+    const getAll = instance.getAll;
+
     const refresh = async () => {
-      let data = await instance.getAll();
+      let data = await getAll.apply(instance);
 
       if (validationSchema) {
         data = await validate(name!, data, validationSchema);
@@ -27,15 +29,19 @@ export async function afterResolveConfiguration() {
 
       source.data = data;
       configuration().set(data);
+
+      return data;
     };
 
+    instance.getAll = refresh as any;
+
     await refresh();
 
     // manage watcher
     if (watch && instance?.watch) {
       const closer = await instance.watch(refresh);
 
-      $on("$onDestroy", closer);
+      closer && $on("$onDestroy", closer);
     }
 
     // manager refresh on request
@@ -79,3 +85,12 @@ export async function afterResolveConfiguration() {
 }
 
 $on("$afterResolveConfiguration", afterResolveConfiguration);
+$on("$onDestroy", () => {
+  const configs = inject<CONFIG_SOURCES>(CONFIG_SOURCES);
+
+  const promises = Object.values(configs).map((config) => {
+    return config.$onDestroy?.();
+  });
+
+  return Promise.all(promises);
+});

package/src/interfaces/ConfigSource.ts

@@ -55,12 +55,13 @@ export interface ConfigSource<Opts = any> {
   options: Opts;
 
   $onInit?(): Promise<void> | void;
+  $onDestroy?(): Promise<void> | void;
   /**
    * Load configuration from the source.
    */
   getAll(): Promise<Record<string, unknown>> | Record<string, unknown>;
 
-  watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB;
+  watch?(onChange?: ConfigSourceOnChangeCB): Promise<ConfigSourceWatchCloseCB> | ConfigSourceWatchCloseCB | void | Promise<void>;
 }
 
 export type ConfigurationExtends = (Type<ConfigSource> | ConfigSourceOptions)[];