@navios/core 0.5.1 → 0.7.0

package/lib/testing/index.d.mts

@@ -0,0 +1,156 @@
+import { K as NaviosModule, i as NaviosApplicationOptions, n as NaviosApplication } from "../index-D657ijFO.mjs";
+import { ClassType, ClassTypeWithInstance, InjectionToken } from "@navios/di";
+import { TestContainer } from "@navios/di/testing";
+export * from "@navios/di/testing";
+
+//#region src/testing/testing-module.d.mts
+
+/**
+ * Configuration for overriding a provider in the testing module.
+ *
+ * @typeParam T - The type of the provider being overridden
+ */
+interface TestingModuleOverride<T = any> {
+  /**
+   * The injection token or class to override.
+   */
+  token: ClassType | InjectionToken<T, any>;
+  /**
+   * Value to use instead of the original provider.
+   */
+  useValue?: T;
+  /**
+   * Class to use instead of the original provider.
+   */
+  useClass?: ClassType;
+}
+/**
+ * Options for creating a testing module.
+ *
+ * Extends NaviosApplicationOptions but excludes the container option,
+ * as TestingModule manages its own TestContainer.
+ */
+interface TestingModuleOptions extends Omit<NaviosApplicationOptions, 'container'> {
+  /**
+   * Initial provider overrides to apply when creating the testing module.
+   *
+   * You can also use `overrideProvider()` method for a fluent API.
+   */
+  overrides?: TestingModuleOverride[];
+}
+/**
+ * A testing-optimized wrapper around NaviosApplication.
+ * Provides utilities for setting up test environments with mock dependencies.
+ */
+declare class TestingModule {
+  private readonly appModule;
+  private readonly container;
+  private readonly options;
+  private app;
+  constructor(appModule: ClassTypeWithInstance<NaviosModule>, container: TestContainer, options: TestingModuleOptions);
+  /**
+   * Compiles the testing module and returns the NaviosApplication.
+   * Call this after setting up all overrides.
+   */
+  compile(): Promise<NaviosApplication>;
+  /**
+   * Initializes the application (loads modules, sets up HTTP if configured).
+   * This is equivalent to calling app.init() on the compiled application.
+   */
+  init(): Promise<NaviosApplication>;
+  /**
+   * Gets the underlying TestContainer for direct manipulation.
+   */
+  getContainer(): TestContainer;
+  /**
+   * Gets the compiled application. Throws if not yet compiled.
+   */
+  getApplication(): NaviosApplication;
+  /**
+   * Override a provider with a mock value.
+   */
+  overrideProvider<T>(token: ClassType | InjectionToken<T, any>): {
+    useValue: (value: T) => TestingModule;
+    useClass: (target: ClassType) => TestingModule;
+  };
+  /**
+   * Gets an instance from the container.
+   */
+  get<T>(token: ClassTypeWithInstance<T> | InjectionToken<T, any>): Promise<T>;
+  /**
+   * Disposes the testing module and cleans up resources.
+   */
+  close(): Promise<void>;
+}
+/**
+ * Fluent builder interface for TestingModule.
+ *
+ * Provides a chainable API for configuring and using a testing module.
+ */
+interface TestingModuleBuilder {
+  /**
+   * Override a provider with a mock value or class.
+   *
+   * @param token - The injection token or class to override
+   * @returns An object with `useValue` and `useClass` methods for chaining
+   *
+   * @example
+   * ```typescript
+   * const testingModule = await createTestingModule(AppModule)
+   *   .overrideProvider(DatabaseService)
+   *   .useValue(mockDatabaseService)
+   *   .compile()
+   * ```
+   */
+  overrideProvider<T>(token: ClassType | InjectionToken<T, any>): {
+    useValue: (value: T) => TestingModuleBuilder;
+    useClass: (target: ClassType) => TestingModuleBuilder;
+  };
+  /**
+   * Compiles the testing module and returns the NaviosApplication.
+   *
+   * This creates the application instance but does not initialize it.
+   * Call `init()` if you need the application to be fully initialized.
+   */
+  compile(): Promise<NaviosApplication>;
+  /**
+   * Initializes the application (loads modules, sets up HTTP if configured).
+   *
+   * This is equivalent to calling `compile()` followed by `app.init()`.
+   */
+  init(): Promise<NaviosApplication>;
+  /**
+   * Gets the underlying TestContainer for direct manipulation.
+   */
+  getContainer(): TestContainer;
+  /**
+   * Gets an instance from the container.
+   *
+   * @typeParam T - The type of the instance to retrieve
+   * @param token - The injection token or class
+   * @returns The resolved instance
+   */
+  get<T>(token: ClassTypeWithInstance<T> | InjectionToken<T, any>): Promise<T>;
+  /**
+   * Disposes the testing module and cleans up resources.
+   */
+  close(): Promise<void>;
+}
+/**
+ * Creates a testing module for the given app module.
+ * This is the main entry point for setting up tests.
+ *
+ * @example
+ * ```typescript
+ * const testingModule = await createTestingModule(AppModule, {
+ *   adapter: [],
+ * })
+ *   .overrideProvider(DatabaseService)
+ *   .useValue(mockDatabaseService)
+ *   .compile()
+ * ```
+ */
+declare function createTestingModule(appModule: ClassTypeWithInstance<NaviosModule>, options?: TestingModuleOptions): TestingModule;
+//#endregion
+export { TestingModule, TestingModuleBuilder, TestingModuleOptions, TestingModuleOverride, createTestingModule };
+//# sourceMappingURL=index.d.mts.map

package/lib/testing/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/testing/testing-module.mts"],"sourcesContent":[],"mappings":";;;;;;;;;AAcA;;;AAIqB,UAJJ,qBAII,CAAA,IAAA,GAAA,CAAA,CAAA;EAIR;;;EAaI,KAAA,EAjBR,SAiBQ,GAjBI,cAkBnB,CAlBkC,CAkBlC,EAAA,GAAA,CAAA;EAAa;;;EAAD,QAAA,CAAA,EAdD,CAcC;EAaD;;;EAKmB,QAAA,CAAA,EA5BnB,SA4BmB;;;;;;;;AAkDH,UArEZ,oBAAA,SACP,IAoEmB,CApEd,wBAoEc,EAAA,WAAA,CAAA,CAAA;EAA2B;;;;;EAEnB,SAAA,CAAA,EAhEvB,qBAgEuB,EAAA;;;;;;AAiBqC,cA1E7D,aAAA,CA0E6D;EAOzD,iBAAA,SAAA;EAAO,iBAAA,SAAA;EAaP,iBAAA,OAAoB;EAeR,QAAA,GAAA;EAA2B,WAAA,CAAA,SAAA,EAzGxB,qBAyGwB,CAzGF,YAyGE,CAAA,EAAA,SAAA,EAxGxB,aAwGwB,EAAA,OAAA,EAvG1B,oBAuG0B;EAAf;;;;EAEJ,OAAA,CAAA,CAAA,EAlGlB,OAkGkB,CAlGV,iBAkGU,CAAA;EAShB;;;;EAYH,IAAA,CAAA,CAAA,EA3GF,OA2GE,CA3GM,iBA2GN,CAAA;EASoB;;;EAAK,YAAA,CAAA,CAAA,EAzGzB,aAyGyB;EAAiC;;;EAK1D,cAAA,CAAA,CAAA,EAvGE,iBAuGF;EAiBF;;;EAEL,gBAAA,CAAA,CAAA,CAAA,CAAA,KAAA,EA9GkB,SA8GlB,GA9G8B,cA8G9B,CA9G6C,CA8G7C,EAAA,GAAA,CAAA,CAAA,EAAA;IACR,QAAA,EAAA,CAAA,KAAA,EA9GmB,CA8GnB,EAAA,GA9GyB,aA8GzB;IAAa,QAAA,EAAA,CAAA,MAAA,EA7GO,SA6GP,EAAA,GA7GqB,aA6GrB;;;;;gBA5FM,sBAAsB,KAAK,eAAe,UAAU,QAAQ;;;;WAOjE;;;;;;;UAaA,oBAAA;;;;;;;;;;;;;;;6BAeY,YAAY,eAAe;sBAClC,MAAM;uBACL,cAAc;;;;;;;;aASxB,QAAQ;;;;;;UAOX,QAAQ;;;;kBAKA;;;;;;;;gBASF,sBAAsB,KAAK,eAAe,UAAU,QAAQ;;;;WAKjE;;;;;;;;;;;;;;;;iBAiBK,mBAAA,YACH,sBAAsB,yBACxB,uBACR"}

package/lib/testing/index.mjs

@@ -0,0 +1,100 @@
+import { t as NaviosFactory } from "../src-DzPY5s6d.mjs";
+import "../use-guards.decorator-kZ3lNK8v.mjs";
+import { TestContainer } from "@navios/di/testing";
+
+export * from "@navios/di/testing"
+
+//#region src/testing/testing-module.mts
+/**
+* A testing-optimized wrapper around NaviosApplication.
+* Provides utilities for setting up test environments with mock dependencies.
+*/ var TestingModule = class {
+	appModule;
+	container;
+	options;
+	app = null;
+	constructor(appModule, container, options) {
+		this.appModule = appModule;
+		this.container = container;
+		this.options = options;
+	}
+	/**
+	* Compiles the testing module and returns the NaviosApplication.
+	* Call this after setting up all overrides.
+	*/ async compile() {
+		this.app = await NaviosFactory.create(this.appModule, {
+			...this.options,
+			container: this.container
+		});
+		return this.app;
+	}
+	/**
+	* Initializes the application (loads modules, sets up HTTP if configured).
+	* This is equivalent to calling app.init() on the compiled application.
+	*/ async init() {
+		if (!this.app) await this.compile();
+		await this.app.init();
+		return this.app;
+	}
+	/**
+	* Gets the underlying TestContainer for direct manipulation.
+	*/ getContainer() {
+		return this.container;
+	}
+	/**
+	* Gets the compiled application. Throws if not yet compiled.
+	*/ getApplication() {
+		if (!this.app) throw new Error("TestingModule not compiled. Call compile() or init() first.");
+		return this.app;
+	}
+	/**
+	* Override a provider with a mock value.
+	*/ overrideProvider(token) {
+		return {
+			useValue: (value) => {
+				this.container.bind(token).toValue(value);
+				return this;
+			},
+			useClass: (target) => {
+				this.container.bind(token).toClass(target);
+				return this;
+			}
+		};
+	}
+	/**
+	* Gets an instance from the container.
+	*/ async get(token) {
+		return this.container.get(token);
+	}
+	/**
+	* Disposes the testing module and cleans up resources.
+	*/ async close() {
+		if (this.app) await this.app.close();
+		await this.container.dispose();
+	}
+};
+/**
+* Creates a testing module for the given app module.
+* This is the main entry point for setting up tests.
+*
+* @example
+* ```typescript
+* const testingModule = await createTestingModule(AppModule, {
+*   adapter: [],
+* })
+*   .overrideProvider(DatabaseService)
+*   .useValue(mockDatabaseService)
+*   .compile()
+* ```
+*/ function createTestingModule(appModule, options = { adapter: [] }) {
+	const container = new TestContainer();
+	if (options.overrides) {
+		for (const override of options.overrides) if (override.useValue !== void 0) container.bind(override.token).toValue(override.useValue);
+		else if (override.useClass) container.bind(override.token).toClass(override.useClass);
+	}
+	return new TestingModule(appModule, container, options);
+}
+
+//#endregion
+export { TestingModule, createTestingModule };
+//# sourceMappingURL=index.mjs.map

package/lib/testing/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["TestContainer","NaviosFactory","TestingModule","app","appModule","container","options","compile","create","init","getContainer","getApplication","Error","overrideProvider","token","useValue","value","bind","toValue","useClass","target","toClass","get","close","dispose","createTestingModule","adapter","overrides","override","undefined"],"sources":["../../src/testing/testing-module.mts"],"sourcesContent":["import type { ClassType, ClassTypeWithInstance, InjectionToken } from '@navios/di'\nimport type { NaviosModule } from '../interfaces/index.mjs'\nimport type { NaviosApplicationOptions } from '../navios.application.mjs'\n\nimport { TestContainer } from '@navios/di/testing'\n\nimport { NaviosApplication } from '../navios.application.mjs'\nimport { NaviosFactory } from '../navios.factory.mjs'\n\n/**\n * Configuration for overriding a provider in the testing module.\n * \n * @typeParam T - The type of the provider being overridden\n */\nexport interface TestingModuleOverride<T = any> {\n  /**\n   * The injection token or class to override.\n   */\n  token: ClassType | InjectionToken<T, any>\n  /**\n   * Value to use instead of the original provider.\n   */\n  useValue?: T\n  /**\n   * Class to use instead of the original provider.\n   */\n  useClass?: ClassType\n}\n\n/**\n * Options for creating a testing module.\n * \n * Extends NaviosApplicationOptions but excludes the container option,\n * as TestingModule manages its own TestContainer.\n */\nexport interface TestingModuleOptions\n  extends Omit<NaviosApplicationOptions, 'container'> {\n  /**\n   * Initial provider overrides to apply when creating the testing module.\n   * \n   * You can also use `overrideProvider()` method for a fluent API.\n   */\n  overrides?: TestingModuleOverride[]\n}\n\n/**\n * A testing-optimized wrapper around NaviosApplication.\n * Provides utilities for setting up test environments with mock dependencies.\n */\nexport class TestingModule {\n  private app: NaviosApplication | null = null\n\n  constructor(\n    private readonly appModule: ClassTypeWithInstance<NaviosModule>,\n    private readonly container: TestContainer,\n    private readonly options: TestingModuleOptions,\n  ) {}\n\n  /**\n   * Compiles the testing module and returns the NaviosApplication.\n   * Call this after setting up all overrides.\n   */\n  async compile(): Promise<NaviosApplication> {\n    this.app = await NaviosFactory.create(this.appModule, {\n      ...this.options,\n      container: this.container,\n    })\n    return this.app\n  }\n\n  /**\n   * Initializes the application (loads modules, sets up HTTP if configured).\n   * This is equivalent to calling app.init() on the compiled application.\n   */\n  async init(): Promise<NaviosApplication> {\n    if (!this.app) {\n      await this.compile()\n    }\n    await this.app!.init()\n    return this.app!\n  }\n\n  /**\n   * Gets the underlying TestContainer for direct manipulation.\n   */\n  getContainer(): TestContainer {\n    return this.container\n  }\n\n  /**\n   * Gets the compiled application. Throws if not yet compiled.\n   */\n  getApplication(): NaviosApplication {\n    if (!this.app) {\n      throw new Error(\n        'TestingModule not compiled. Call compile() or init() first.',\n      )\n    }\n    return this.app\n  }\n\n  /**\n   * Override a provider with a mock value.\n   */\n  overrideProvider<T>(token: ClassType | InjectionToken<T, any>): {\n    useValue: (value: T) => TestingModule\n    useClass: (target: ClassType) => TestingModule\n  } {\n    return {\n      useValue: (value: T) => {\n        this.container.bind(token as any).toValue(value)\n        return this\n      },\n      useClass: (target: ClassType) => {\n        this.container.bind(token as any).toClass(target)\n        return this\n      },\n    }\n  }\n\n  /**\n   * Gets an instance from the container.\n   */\n  async get<T>(token: ClassTypeWithInstance<T> | InjectionToken<T, any>): Promise<T> {\n    return this.container.get(token as any)\n  }\n\n  /**\n   * Disposes the testing module and cleans up resources.\n   */\n  async close(): Promise<void> {\n    if (this.app) {\n      await this.app.close()\n    }\n    await this.container.dispose()\n  }\n}\n\n/**\n * Fluent builder interface for TestingModule.\n * \n * Provides a chainable API for configuring and using a testing module.\n */\nexport interface TestingModuleBuilder {\n  /**\n   * Override a provider with a mock value or class.\n   * \n   * @param token - The injection token or class to override\n   * @returns An object with `useValue` and `useClass` methods for chaining\n   * \n   * @example\n   * ```typescript\n   * const testingModule = await createTestingModule(AppModule)\n   *   .overrideProvider(DatabaseService)\n   *   .useValue(mockDatabaseService)\n   *   .compile()\n   * ```\n   */\n  overrideProvider<T>(token: ClassType | InjectionToken<T, any>): {\n    useValue: (value: T) => TestingModuleBuilder\n    useClass: (target: ClassType) => TestingModuleBuilder\n  }\n\n  /**\n   * Compiles the testing module and returns the NaviosApplication.\n   * \n   * This creates the application instance but does not initialize it.\n   * Call `init()` if you need the application to be fully initialized.\n   */\n  compile(): Promise<NaviosApplication>\n\n  /**\n   * Initializes the application (loads modules, sets up HTTP if configured).\n   * \n   * This is equivalent to calling `compile()` followed by `app.init()`.\n   */\n  init(): Promise<NaviosApplication>\n\n  /**\n   * Gets the underlying TestContainer for direct manipulation.\n   */\n  getContainer(): TestContainer\n\n  /**\n   * Gets an instance from the container.\n   * \n   * @typeParam T - The type of the instance to retrieve\n   * @param token - The injection token or class\n   * @returns The resolved instance\n   */\n  get<T>(token: ClassTypeWithInstance<T> | InjectionToken<T, any>): Promise<T>\n\n  /**\n   * Disposes the testing module and cleans up resources.\n   */\n  close(): Promise<void>\n}\n\n/**\n * Creates a testing module for the given app module.\n * This is the main entry point for setting up tests.\n *\n * @example\n * ```typescript\n * const testingModule = await createTestingModule(AppModule, {\n *   adapter: [],\n * })\n *   .overrideProvider(DatabaseService)\n *   .useValue(mockDatabaseService)\n *   .compile()\n * ```\n */\nexport function createTestingModule(\n  appModule: ClassTypeWithInstance<NaviosModule>,\n  options: TestingModuleOptions = { adapter: [] },\n): TestingModule {\n  const container = new TestContainer()\n\n  // Apply initial overrides if provided\n  if (options.overrides) {\n    for (const override of options.overrides) {\n      if (override.useValue !== undefined) {\n        container.bind(override.token as any).toValue(override.useValue)\n      } else if (override.useClass) {\n        container.bind(override.token as any).toClass(override.useClass)\n      }\n    }\n  }\n\n  return new TestingModule(appModule, container, options)\n}\n"],"mappings":";;;;;;;;;;GAiDA,IAAaE,gBAAb,MAAaA;;;;CACHC,MAAgC;CAExC,YACE,WACA,WACA,SACA;OAHiBC,YAAAA;OACAC,YAAAA;OACAC,UAAAA;;;;;IAOnB,MAAMC,UAAsC;AAC1C,OAAKJ,MAAM,MAAMF,cAAcO,OAAO,KAAKJ,WAAW;GACpD,GAAG,KAAKE;GACRD,WAAW,KAAKA;GAClB,CAAA;AACA,SAAO,KAAKF;;;;;IAOd,MAAMM,OAAmC;AACvC,MAAI,CAAC,KAAKN,IACR,OAAM,KAAKI,SAAO;AAEpB,QAAM,KAAKJ,IAAKM,MAAI;AACpB,SAAO,KAAKN;;;;IAMdO,eAA8B;AAC5B,SAAO,KAAKL;;;;IAMdM,iBAAoC;AAClC,MAAI,CAAC,KAAKR,IACR,OAAM,IAAIS,MACR,8DAAA;AAGJ,SAAO,KAAKT;;;;IAMdU,iBAAoBC,OAGlB;AACA,SAAO;GACLC,WAAWC,UAAAA;AACT,SAAKX,UAAUY,KAAKH,MAAAA,CAAcI,QAAQF,MAAAA;AAC1C,WAAO;;GAETG,WAAWC,WAAAA;AACT,SAAKf,UAAUY,KAAKH,MAAAA,CAAcO,QAAQD,OAAAA;AAC1C,WAAO;;GAEX;;;;IAMF,MAAME,IAAOR,OAAsE;AACjF,SAAO,KAAKT,UAAUiB,IAAIR,MAAAA;;;;IAM5B,MAAMS,QAAuB;AAC3B,MAAI,KAAKpB,IACP,OAAM,KAAKA,IAAIoB,OAAK;AAEtB,QAAM,KAAKlB,UAAUmB,SAAO;;;;;;;;;;;;;;;;GA8EhC,SAAgBC,oBACdrB,WACAE,UAAgC,EAAEoB,SAAS,EAAE,EAAE,EAAA;CAE/C,MAAMrB,YAAY,IAAIL,eAAAA;AAGtB,KAAIM,QAAQqB,WACV;OAAK,MAAMC,YAAYtB,QAAQqB,UAC7B,KAAIC,SAASb,aAAac,OACxBxB,WAAUY,KAAKW,SAASd,MAAK,CAASI,QAAQU,SAASb,SAAQ;WACtDa,SAAST,SAClBd,WAAUY,KAAKW,SAASd,MAAK,CAASO,QAAQO,SAAST,SAAQ;;AAKrE,QAAO,IAAIjB,cAAcE,WAAWC,WAAWC,QAAAA"}