@ediflow/core

> Modern EDIFACT Parser, Validator & Builder - Core Library


Clean Architecture • Type-Safe • Zero Config • Battle-Tested

---

📦 What is @ediflow/core?

@ediflow/core is the core engine for EDIFlow - a modern EDIFACT library built with Clean Architecture principles.

This package provides:
- ✅ Parser - EDIFACT string → EDIMessage
- ✅ Validator - 3-phase validation (Syntax → Structure → Business)
- ✅ Builder - EDIMessage → EDIFACT string
- ✅ Mapper - Auto-convert to/from business objects
- ✅ Envelope Generator - UNH/UNT/UNB/UNZ support
- ✅ CLI - Command-line tools
- ✅ TypeScript - Full type safety

What this package does NOT include:
- ❌ EDIFACT standard definitions (install separately)

---

🚀 Installation

``bash


Install core library

npm install @ediflow/core

Install EDIFACT standard(s) - REQUIRED for validation

npm install @ediflow/edifact-d20b # Latest (recommended)

OR

npm install @ediflow/edifact-d12a # Full coverage (196 messages)

OR

npm install @ediflow/edifact-d01b # Legacy systems
npm install @ediflow/edifact-d96a # Classic
`

---

📖 Quick Start

$3

`typescript
import { DIContainer } from '@ediflow/core';

const container = DIContainer.getInstance();
const parseUseCase = container.resolve('ParseEDIUseCase');

const result = parseUseCase.execute({
message: edifactString,
standard: 'EDIFACT'
});

if (result.success) {
console.log('✅ Parsed!', result.message);
}
`

$3

`typescript
const validateUseCase = container.resolve('ValidateMessageUseCase');

const validation = validateUseCase.execute({
message: result.message,
messageType: 'ORDERS',
version: 'D20B',
repositoryPath: './node_modules/@ediflow/edifact-d20b/data'
});

if (validation.success) {
console.log('✅ Valid!');
}
`

$3

`typescript
import { EDIMessage, EDISegment, EDIElement } from '@ediflow/core';

const message = new EDIMessage({
standard: 'EDIFACT',
version: 'D20B',
messageType: 'ORDERS',
segments: [
new EDISegment({
tag: 'BGM',
elements: [
new EDIElement({ value: '220' }),
new EDIElement({ value: 'PO12345' })
]
})
]
});

const buildUseCase = container.resolve('BuildEDIUseCase');
const ediString = buildUseCase.execute({
message,
standard: 'EDIFACT'
});

console.log(ediString); // BGM+220+PO12345'
`

---

🎯 Features

$3

- Parse - EDIFACT → EDIMessage (with envelope support)
- Validate - 3-phase validation (Syntax, Structure, Business)
- Build - EDIMessage → EDIFACT (with envelope generation)
- Map - Business Objects ↔ EDIMessage
- CLI - Command-line interface

$3

- Domain Layer - Pure business logic (zero dependencies)
- Application Layer - Use Cases (ParseEDI, ValidateMessage, BuildEDI)
- Infrastructure Layer - Parsers, Repositories
- Presentation Layer - CLI, Future: REST API

$3

- Full TypeScript definitions
- Advanced type inference
- IntelliSense support
- Strict type checking

$3

- Works out of the box
- Sensible defaults
- Easy to customize

---

📦 Related Packages

EDIFACT Standards (choose what you need):
- @ediflow/edifact-d96a - D.96A (1996) - 7 message types
- @ediflow/edifact-d01b - D.01B (2001) - 4 message types
- @ediflow/edifact-d20b - D.20B (2020) - 7 message types
- @ediflow/edifact-d12a - D.12A (2012) - 196 message types

---

🏗️ Architecture

`
┌─────────────────────────────────────┐
│ Presentation Layer │ CLI
└──────────────┬──────────────────────┘
│
┌──────────────▼──────────────────────┐
│ Application Layer │ Use Cases
│ • ParseEDIUseCase │
│ • ValidateMessageUseCase │
│ • BuildEDIUseCase │
└──────────────┬──────────────────────┘
│
┌──────────────▼──────────────────────┐
│ Domain Layer │ Entities
│ • EDIMessage │
│ • EDISegment │
│ • EDIElement │
└──────────────┬──────────────────────┘
│
┌──────────────▼──────────────────────┐
│ Infrastructure Layer │ Parsers
│ • EdifactMessageParser │
│ • FileBasedRepository │
└─────────────────────────────────────┘
`

Read more: Architecture Documentation

---

📚 Documentation

- Quick Start Guide - Get started in 5 minutes
- Architecture - Clean Architecture explained
- Developer Guide - Contributing
- API Reference - Complete API docs

---

🧪 Testing

Extensively tested with TDD:
- 590 tests passing
- Unit tests - Domain & Application layers
- Integration tests - Cross-layer interactions
- E2E tests - Complete roundtrip validation

`bash
npm test
npm run test:watch
npm run test:coverage
``

---

🤝 Contributing

We welcome contributions! See:
- Contributing Guide
- Developer Guide

---

📄 License

MIT License - see LICENSE

---

🔗 Links

- GitHub: ediflow-lib/core
- NPM: @ediflow/core
- Issues: Report bugs
- Discussions: Ask questions

---

Made with ❤️ for the EDI community