nest-hex 0.3.2 → 0.4.0

package/README.md

@@ -1,8 +1,17 @@
-# nest-hex
+</br>
+<img src="https://raw.githubusercontent.com/LiorVainer/nest-hex/main/assets/icon.png">
+</br>
+</br>
 
-> A tiny, **class-based**, **NestJS-native** library for building **pluggable adapters** following the Ports & Adapters (Hexagonal Architecture) pattern with minimal boilerplate.
+## nest-hex
+
+[![test coverage](https://badgen.net/badge/coverage/100%25/green?icon=github)](https://github.com/LiorVainer/nest-hex)
+[![npm version](https://img.shields.io/npm/v/nest-hex?color=f00e0e&logo=npm&style=flat)](https://www.npmjs.com/package/nest-hex)
+[![install size](https://packagephobia.com/badge?p=nest-hex)](https://packagephobia.com/result?p=nest-hex)
+[![minizipped size](https://img.shields.io/bundlephobia/minzip/nest-hex)](https://packagephobia.com/result?p=nest-hex)
+[![License](https://img.shields.io/github/license/liorvainer/nest-hex?color=orange)](https://www.npmjs.com/package/nest-hex)
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+> A tiny, **class-based**, **NestJS-native** library for building **pluggable adapters** following the Ports & Adapters (Hexagonal Architecture) pattern with minimal boilerplate.
 
 ## What is nest-hex?
 
@@ -58,15 +67,27 @@ export interface StoragePort {
 ### 2. Create an Adapter (Infrastructure Implementation)
 
 ```typescript
-// s3.adapter.ts
+// s3.types.ts - Configuration types
+import type { AdapterConfig } from 'nest-hex'
+import type { STORAGE_PORT, StoragePort } from './storage.port'
+
+export interface S3Options {
+  bucket: string
+  region: string
+}
+
+export type StorageToken = typeof STORAGE_PORT
+
+export type S3AdapterConfig = AdapterConfig<StorageToken, StoragePort>
+
+// s3.service.ts - Implementation service
 import { Injectable } from '@nestjs/common'
-import { Adapter } from 'nest-hex'
-import { STORAGE_PORT, type StoragePort } from './storage.port'
+import type { StoragePort } from './storage.port'
+import type { S3Options } from './s3.types'
 
-// Implementation service
 @Injectable()
-class S3Service implements StoragePort {
-  constructor(private options: { bucket: string; region: string }) {}
+export class S3Service implements StoragePort {
+  constructor(private options: S3Options) {}
 
   async upload(key: string, data: Buffer): Promise<string> {
     // AWS S3 upload logic here
@@ -79,12 +100,18 @@ class S3Service implements StoragePort {
   }
 }
 
-// Adapter module - single decorator declares everything!
-@Adapter({
+// s3.adapter.ts - Adapter module
+import { Adapter, AdapterBase } from 'nest-hex'
+import { STORAGE_PORT } from './storage.port'
+import { S3Service } from './s3.service'
+import type { S3AdapterConfig, S3Options } from './s3.types'
+
+// Single decorator with type safety!
+@Adapter<S3AdapterConfig>({
   portToken: STORAGE_PORT,
   implementation: S3Service
 })
-export class S3Adapter extends AdapterBase<{ bucket: string; region: string }> {}
+export class S3Adapter extends AdapterBase<S3Options> {}
 ```
 
 ### 3. Create a Domain Service
@@ -118,7 +145,7 @@ import { PortModule } from 'nest-hex'
 import { FileService } from './file.service'
 
 @Module({})
-export class FileModule extends PortModule<typeof FileService> {}
+export class FileModule extends PortModule {}
 ```
 
 ### 5. Wire It Up
@@ -188,7 +215,12 @@ export class S3StorageModule {
 ### After (With nest-hex)
 
 ```typescript
-@Adapter({
+// s3.types.ts
+export type StorageToken = typeof STORAGE_PORT
+export type S3AdapterConfig = AdapterConfig<StorageToken, StoragePort>
+
+// s3.adapter.ts
+@Adapter<S3AdapterConfig>({
   portToken: STORAGE_PORT,
   implementation: S3StorageService
 })
@@ -238,7 +270,12 @@ export class AppModule {}
 ### Adapters with Dependencies
 
 ```typescript
-@Adapter({
+// axios.types.ts
+export type HttpClientToken = typeof HTTP_CLIENT_PORT
+export type AxiosAdapterConfig = AdapterConfig<HttpClientToken, HttpClientPort>
+
+// axios.adapter.ts
+@Adapter<AxiosAdapterConfig>({
   portToken: HTTP_CLIENT_PORT,
   implementation: AxiosHttpClient,
   imports: [HttpModule],
@@ -252,6 +289,11 @@ export class AxiosAdapter extends AdapterBase<AxiosOptions> {}
 ### Mock Adapters for Testing
 
 ```typescript
+// mock-storage.types.ts
+export type StorageToken = typeof STORAGE_PORT
+export type MockStorageAdapterConfig = AdapterConfig<StorageToken, StoragePort>
+
+// mock-storage.service.ts
 @Injectable()
 class MockStorageService implements StoragePort {
   async upload(key: string, data: Buffer): Promise<string> {
@@ -262,7 +304,8 @@ class MockStorageService implements StoragePort {
   }
 }
 
-@Adapter({
+// mock-storage.adapter.ts
+@Adapter<MockStorageAdapterConfig>({
   portToken: STORAGE_PORT,
   implementation: MockStorageService
 })

package/dist/shared/chunk-btf6z45c.js

@@ -0,0 +1,13 @@
+import { createRequire } from "node:module";
+var __legacyDecorateClassTS = function(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+    r = Reflect.decorate(decorators, target, key, desc);
+  else
+    for (var i = decorators.length - 1;i >= 0; i--)
+      if (d = decorators[i])
+        r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+
+export { __legacyDecorateClassTS };