nest-hex 0.4.0 → 0.4.2

package/README.md

@@ -1,7 +1,6 @@
-</br>
-<img src="https://raw.githubusercontent.com/LiorVainer/nest-hex/main/assets/icon.png">
-</br>
-</br>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/LiorVainer/nest-hex/main/assets/icon.png" width="150">
+</p>
 
 ## nest-hex
 
@@ -71,7 +70,7 @@ export interface StoragePort {
 import type { AdapterConfig } from 'nest-hex'
 import type { STORAGE_PORT, StoragePort } from './storage.port'
 
-export interface S3Options {
+export interface S3ConfigOptions {
   bucket: string
   region: string
 }
@@ -83,11 +82,11 @@ export type S3AdapterConfig = AdapterConfig<StorageToken, StoragePort>
 // s3.service.ts - Implementation service
 import { Injectable } from '@nestjs/common'
 import type { StoragePort } from './storage.port'
-import type { S3Options } from './s3.types'
+import type { S3ConfigOptions } from './s3.types'
 
 @Injectable()
 export class S3Service implements StoragePort {
-  constructor(private options: S3Options) {}
+  constructor(private options: S3ConfigOptions) {}
 
   async upload(key: string, data: Buffer): Promise<string> {
     // AWS S3 upload logic here
@@ -104,14 +103,14 @@ export class S3Service implements StoragePort {
 import { Adapter, AdapterBase } from 'nest-hex'
 import { STORAGE_PORT } from './storage.port'
 import { S3Service } from './s3.service'
-import type { S3AdapterConfig, S3Options } from './s3.types'
+import type { S3AdapterConfig, S3ConfigOptions } from './s3.types'
 
 // Single decorator with type safety!
 @Adapter<S3AdapterConfig>({
   portToken: STORAGE_PORT,
   implementation: S3Service
 })
-export class S3Adapter extends AdapterBase<S3Options> {}
+export class S3Adapter extends AdapterBase<S3ConfigOptions> {}
 ```
 
 ### 3. Create a Domain Service
@@ -136,16 +135,16 @@ export class FileService {
 }
 ```
 
-### 4. Create a Port Module
+### 4. Create a Domain Module
 
 ```typescript
 // file.module.ts
 import { Module } from '@nestjs/common'
-import { PortModule } from 'nest-hex'
+import { DomainModule } from 'nest-hex'
 import { FileService } from './file.service'
 
 @Module({})
-export class FileModule extends PortModule {}
+export class FileModule extends DomainModule {}
 ```
 
 ### 5. Wire It Up
@@ -224,7 +223,7 @@ export type S3AdapterConfig = AdapterConfig<StorageToken, StoragePort>
   portToken: STORAGE_PORT,
   implementation: S3StorageService
 })
-export class S3Adapter extends AdapterBase<S3Options> {}
+export class S3Adapter extends AdapterBase<S3ConfigOptions> {}
 ```
 
 ## Swappable Infrastructure
@@ -283,7 +282,7 @@ export type AxiosAdapterConfig = AdapterConfig<HttpClientToken, HttpClientPort>
     { provide: 'HTTP_CONFIG', useValue: { timeout: 5000 } }
   ]
 })
-export class AxiosAdapter extends AdapterBase<AxiosOptions> {}
+export class AxiosAdapter extends AdapterBase<AxiosConfigOptions> {}
 ```
 
 ### Mock Adapters for Testing

package/dist/src/index.d.ts

@@ -17,7 +17,7 @@ import { DynamicModule, Provider } from "@nestjs/common";
 *   imports: [HttpModule],
 *   providers: [{ provide: 'CONFIG', useValue: {...} }]
 * })
-* class S3Adapter extends AdapterBase<S3Options> {}
+* class S3Adapter extends AdapterBase<S3ConfigOptions> {}
 * ```
 *
 * Advanced adapter with dynamic configuration:
@@ -26,12 +26,12 @@ import { DynamicModule, Provider } from "@nestjs/common";
 *   portToken: STORAGE_PORT,
 *   implementation: S3Service
 * })
-* class S3Adapter extends AdapterBase<S3Options> {
-*   protected imports(options: S3Options) {
+* class S3Adapter extends AdapterBase<S3ConfigOptions> {
+*   protected imports(options: S3ConfigOptions) {
 *     return [HttpModule.register({ timeout: options.timeout })]
 *   }
 *
-*   protected extraProviders(options: S3Options) {
+*   protected extraProviders(options: S3ConfigOptions) {
 *     return [{ provide: 'S3_CONFIG', useValue: options }]
 *   }
 * }
@@ -114,7 +114,7 @@ type AdapterConfig<
 *   portToken: OBJECT_STORAGE_PORT,
 *   implementation: S3ObjectStorageService
 * })
-* class S3Adapter extends AdapterBase<S3Options> {}
+* class S3Adapter extends AdapterBase<S3ConfigOptions> {}
 * ```
 *
 * @example
@@ -154,9 +154,9 @@ declare function Adapter<Config extends AdapterConfig<any, any>>(config: {
 */
 declare function InjectPort<TToken>(token: TToken): ParameterDecorator;
 import { DynamicModule as DynamicModule3 } from "@nestjs/common";
-declare class PortModule {
+declare class DomainModule {
 	/**
-	* Registers the port module with an adapter.
+	* Registers the domain module with an adapter.
 	*
 	* @param config - Configuration object containing the adapter module
 	* @param config.adapter - An adapter module that provides a port implementation
@@ -166,4 +166,4 @@ declare class PortModule {
 		adapter?: DynamicModule3;
 	}): DynamicModule3;
 }
-export { PortModule, InjectPort, AdapterConfig, AdapterBase, Adapter };
+export { InjectPort, DomainModule, AdapterConfig, AdapterBase, Adapter };

package/dist/src/index.js

@@ -90,23 +90,23 @@ function Adapter(config) {
 function InjectPort(token) {
   return Inject(token);
 }
-// src/core/port-module.base.ts
+// src/core/domain-module.base.ts
 import"reflect-metadata";
 import { Module } from "@nestjs/common";
-class PortModule {
+class DomainModule {
   static register(config) {
     return {
-      module: PortModule,
+      module: DomainModule,
       imports: config.adapter ? [config.adapter] : []
     };
   }
 }
-PortModule = __legacyDecorateClassTS([
+DomainModule = __legacyDecorateClassTS([
   Module({})
-], PortModule);
+], DomainModule);
 export {
-  PortModule,
   InjectPort,
+  DomainModule,
   AdapterBase,
   Adapter
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nest-hex",
-	"version": "0.4.0",
+	"version": "0.4.2",
 	"type": "module",
 	"description": "A tiny NestJS-native library for building pluggable adapters (Ports & Adapters / Hexagonal) using class-based Dynamic Modules, with great DX and strong type safety.",
 	"homepage": "https://github.com/LiorVainer/nest-hex#readme",