bridgelist 1.1.0 → 1.2.1

package/README.md

@@ -1,119 +1,119 @@
-# bridgelist
-
-[![npm version](https://img.shields.io/npm/v/bridgelist.svg)](https://www.npmjs.com/package/bridgelist)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue)](https://www.typescriptlang.org/)
-
-A TypeScript-based tool for automatically documenting field mappings between different API systems. Generate documentation from your mapping code using simple decorators.
-
-![birdgelist-example](https://biga.de/wp-content/uploads/2025/09/bridgelist-example.png)
-
-## Installation
-
-```bash
-npm install bridgelist
-# or
-yarn add bridgelist
-# or
-pnpm add bridgelist
-```
-## Features
-- **Automatic Mapping Detection**: Analyzes your TypeScript code to identify mapping relationships
-- **Decorator-based Configuration**: Add metadata to your mapping methods
-- **HTML Documentation Generation**: Creates clear and interactive documentation
-- **Supports Various Mapping Types**:
-    - Direct mappings
-    - Transformations
-    - Constant values
-    - Nested objects
-
-## Usage
-### Basic Usage
-1. Import the necessary functions:
-``` typescript
-import { GenerateMappingDocumentation, generateDocumentation } from 'bridgelist';
-```
-2. Extend tsconfig.json settings
-
-```json
-{
-  "compilerOptions": {
-    
-    "experimentalDecorators": true
-    
-  }
-}
-```
-3. Decorate your mapping methods:
-``` typescript
-class SimpleMapper {
-  @GenerateMappingDocumentation({
-    sourceSystem: 'System A',
-    targetSystem: 'System B',
-    description: 'Converts customer data from System A to System B'
-  })
-  mapCustomer(sourceData: any): any {
-    return {
-      id: sourceData.id,
-      firstName: sourceData.properties.firstname,
-      lastName: sourceData.properties.lastname,
-      // more mappings...
-    };
-  }
-}
-```
-4. Generate the documentation:
-``` typescript
-// Scans the project and creates HTML documentation
-generateDocumentation('./docs/api-mappings.html');
-```
-### Complex Mappings
-The tool automatically recognizes different types of mappings:
-``` typescript
-class ComplexMapper {
-  @GenerateMappingDocumentation({
-    sourceSystem: 'CRM',
-    targetSystem: 'ERP',
-    description: 'Converts CRM contacts to ERP customers'
-  })
-  mapContactToCustomer(contact: any): any { 
-    return {
-      // Direct mapping
-      customerId: contact.id,
-    
-      // Constant value
-      defaultCountry: 'Germany',
-    
-      // Transformation
-      fullName: `${contact.firstName} ${contact.lastName}`,
-    
-      // Nested object
-      address: {
-        street: contact.address.streetName,
-        city: contact.address.city,
-        country: defaultCountry
-      }
-    };
-  }
-}
-```
-## API Reference
-### `GenerateMappingDocumentation(options)`
-A decorator to mark mapping methods with metadata.
-#### Parameters
-- `options`: An object with the following properties:
-    - `sourceSystem` (string, required): Name of the source system
-    - `targetSystem` (string, required): Name of the target system
-    - `description` (string, optional): Description of the mapping
-
-### `generateDocumentation(outputPath)`
-Scans the project for decorated methods and generates HTML documentation.
-#### Parameters
-- `outputPath` (string, required): Path where the HTML documentation should be saved
-
-
-### `scanProject(rootDir)`
-Recursively scans a directory for TypeScript files with decorated mapping methods.
-#### Parameters
-- `rootDir` (string, required): Path to the root directory of the project to scan
-
+# bridgelist
+
+[![npm version](https://img.shields.io/npm/v/bridgelist.svg)](https://www.npmjs.com/package/bridgelist)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue)](https://www.typescriptlang.org/)
+
+A TypeScript-based tool for automatically documenting field mappings between different API systems. Generate documentation from your mapping code using simple decorators.
+
+![birdgelist-example](https://biga.de/wp-content/uploads/2025/09/bridgelist-example.png)
+
+## Installation
+
+```bash
+npm install bridgelist
+# or
+yarn add bridgelist
+# or
+pnpm add bridgelist
+```
+## Features
+- **Automatic Mapping Detection**: Analyzes your TypeScript code to identify mapping relationships
+- **Decorator-based Configuration**: Add metadata to your mapping methods
+- **HTML Documentation Generation**: Creates clear and interactive documentation
+- **Supports Various Mapping Types**:
+    - Direct mappings
+    - Transformations
+    - Constant values
+    - Nested objects
+
+## Usage
+### Basic Usage
+1. Import the necessary functions:
+``` typescript
+import { GenerateMappingDocumentation, generateDocumentation } from 'bridgelist';
+```
+2. Extend tsconfig.json settings
+
+```json
+{
+  "compilerOptions": {
+    
+    "experimentalDecorators": true
+    
+  }
+}
+```
+3. Decorate your mapping methods:
+``` typescript
+class SimpleMapper {
+  @GenerateMappingDocumentation({
+    sourceSystem: 'System A',
+    targetSystem: 'System B',
+    description: 'Converts customer data from System A to System B'
+  })
+  mapCustomer(sourceData: any): any {
+    return {
+      id: sourceData.id,
+      firstName: sourceData.properties.firstname,
+      lastName: sourceData.properties.lastname,
+      // more mappings...
+    };
+  }
+}
+```
+4. Generate the documentation:
+``` typescript
+// Scans the project and creates HTML documentation
+generateDocumentation('./docs/api-mappings.html');
+```
+### Complex Mappings
+The tool automatically recognizes different types of mappings:
+``` typescript
+class ComplexMapper {
+  @GenerateMappingDocumentation({
+    sourceSystem: 'CRM',
+    targetSystem: 'ERP',
+    description: 'Converts CRM contacts to ERP customers'
+  })
+  mapContactToCustomer(contact: any): any { 
+    return {
+      // Direct mapping
+      customerId: contact.id,
+    
+      // Constant value
+      defaultCountry: 'Germany',
+    
+      // Transformation
+      fullName: `${contact.firstName} ${contact.lastName}`,
+    
+      // Nested object
+      address: {
+        street: contact.address.streetName,
+        city: contact.address.city,
+        country: defaultCountry
+      }
+    };
+  }
+}
+```
+## API Reference
+### `GenerateMappingDocumentation(options)`
+A decorator to mark mapping methods with metadata.
+#### Parameters
+- `options`: An object with the following properties:
+    - `sourceSystem` (string, required): Name of the source system
+    - `targetSystem` (string, required): Name of the target system
+    - `description` (string, optional): Description of the mapping
+
+### `generateDocumentation(outputPath)`
+Scans the project for decorated methods and generates HTML documentation.
+#### Parameters
+- `outputPath` (string, required): Path where the HTML documentation should be saved
+
+
+### `scanProject(rootDir)`
+Recursively scans a directory for TypeScript files with decorated mapping methods.
+#### Parameters
+- `rootDir` (string, required): Path to the root directory of the project to scan
+

package/dist/decorators/text-documentation.d.ts

@@ -0,0 +1,2 @@
+import { TextDocumentationOptions } from "../types";
+export declare function GenerateTextDocumentation(options: TextDocumentationOptions): (target: any, propertyKey: string) => void;

package/dist/decorators/text-documentation.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateTextDocumentation = GenerateTextDocumentation;
+function GenerateTextDocumentation(options) {
+    return function (target, propertyKey) {
+        return;
+    };
+}
+//# sourceMappingURL=text-documentation.js.map

package/dist/decorators/text-documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-documentation.js","sourceRoot":"","sources":["../../src/decorators/text-documentation.ts"],"names":[],"mappings":";;AAEA,8DAOC;AAPD,SAAgB,yBAAyB,CAAC,OAAiC;IACvE,OAAO,UACH,MAAW,EACX,WAAmB;QAEnB,OAAO;IACX,CAAC,CAAA;AACL,CAAC"}

package/dist/generators/doc-generator-html.d.ts

@@ -1 +1 @@
-export declare function generateMappingDocumentationHTML(outputPath: string, mappingMethods?: any[], arrayMethods?: any[]): void;
+export declare function generateMappingDocumentationHTML(outputPath: string, mappingMethods?: any[], arrayMethods?: any[], textDocs?: any[]): void;