Package Overview

ziegel consists of multiple specialized packages designed to work together seamlessly. Each package serves a specific purpose and can be used independently or as part of a larger ecosystem.

Package Categories

🏗️ Foundation Packages

Package	Description	Key Features
@breadstone/ziegel-core	Essential utilities and base types	String extensions, type guards, exceptions, utilities
@breadstone/ziegel-data	Data manipulation and validation	Data validation, transformation, querying

🔧 Platform Services

Package	Description	Key Features
@breadstone/ziegel-platform	Core platform services	Dependency injection, service location, culture management
@breadstone/ziegel-platform-http	HTTP client and networking	HTTP interceptors, request/response handling, retry policies
@breadstone/ziegel-platform-logging	Structured logging framework	Multiple log providers, structured logging, log levels
@breadstone/ziegel-platform-configuration	Configuration management	Environment-specific config, validation, hot-reload
@breadstone/ziegel-platform-caching	Caching strategies	Memory cache, distributed cache, cache policies
@breadstone/ziegel-platform-serialization	Data serialization	JSON/XML serialization, custom serializers, binary formats
@breadstone/ziegel-platform-mapping	Object mapping utilities	Entity mapping, transformation, property mapping

🎨 Presentation Layer

Package	Description	Key Features
@breadstone/ziegel-presentation	UI component foundations	Base components, styling utilities, theming
@breadstone/ziegel-platform-presentation	Advanced presentation services	UI state management, responsive design, accessibility
@breadstone/ziegel-platform-navigation	Navigation and routing	Route management, navigation guards, deep linking

🔬 Specialized Services

Package	Description	Key Features
@breadstone/ziegel-platform-analytics	Analytics and tracking	Event tracking, user analytics, performance metrics
@breadstone/ziegel-platform-messaging	Event-driven messaging	Pub/sub patterns, message queues, event aggregation
@breadstone/ziegel-platform-localization	Multi-language support	Resource management, culture switching, pluralization
@breadstone/ziegel-platform-transaction	Transaction management	ACID transactions, rollback, state management
@breadstone/ziegel-platform-translation	AI-powered translation	OpenAI integration, batch translation, multiple modes

🌐 Internationalization

Package	Description	Key Features
@breadstone/ziegel-intl	Core internationalization	Number/date formatting, locale management
@breadstone/ziegel-intl-commerce	Commerce-specific i18n	Currency formatting, tax calculations, pricing
@breadstone/ziegel-intl-units	Unit conversion and formatting	Measurement units, conversions, localized formatting

🔌 Framework Integrations

Package	Description	Key Features
@breadstone/ziegel-redux	Redux integration utilities	Action creators, reducers, middleware
@breadstone/ziegel-rx	RxJS extensions and operators	Custom operators, reactive utilities, stream handling

Installation Matrix

Choose the packages you need based on your requirements:

Minimal Setup (Basic TypeScript utilities)

npm install @breadstone/ziegel-core

Web Application Starter

npm install @breadstone/ziegel-core @breadstone/ziegel-platform @breadstone/ziegel-platform-http @breadstone/ziegel-platform-logging

Full Platform (Enterprise applications)

npm install @breadstone/ziegel-core @breadstone/ziegel-platform @breadstone/ziegel-platform-http @breadstone/ziegel-platform-logging @breadstone/ziegel-platform-configuration @breadstone/ziegel-platform-caching @breadstone/ziegel-platform-serialization @breadstone/ziegel-presentation

Internationalization Suite

npm install @breadstone/ziegel-intl @breadstone/ziegel-intl-commerce @breadstone/ziegel-intl-units @breadstone/ziegel-platform-localization

Package Dependencies

Understanding package dependencies helps you make informed decisions:

graph LR
    Core[ziegel-core] --> Platform[ziegel-platform]
    Core --> Data[ziegel-data]
    Core --> Presentation[ziegel-presentation]
    Core --> Intl[ziegel-intl]
    Core --> Redux[ziegel-redux]
    Core --> Rx[ziegel-rx]

    Platform --> PlatformHttp[platform-http]
    Platform --> PlatformLogging[platform-logging]
    Platform --> PlatformConfig[platform-configuration]
    Platform --> PlatformCaching[platform-caching]
    Platform --> PlatformAnalytics[platform-analytics]
    Platform --> PlatformMessaging[platform-messaging]
    Platform --> PlatformLocalization[platform-localization]
    Platform --> PlatformPresentation[platform-presentation]
    Platform --> PlatformNavigation[platform-navigation]

    Core --> PlatformTransaction[platform-transaction]
    Core --> PlatformTranslation[platform-translation]

    Intl --> IntlCommerce[intl-commerce]
    Intl --> IntlUnits[intl-units]

Version Compatibility

All ziegel packages follow semantic versioning and are released together:

• Major versions: Breaking changes across the ecosystem
• Minor versions: New features, backward compatible
• Patch versions: Bug fixes and improvements

Package Size Reference

Approximate bundle sizes (minified + gzipped):

Package	Size	Tree-shakeable
ziegel-core	~8KB	✅
ziegel-platform	~12KB	✅
ziegel-platform-http	~6KB	✅
ziegel-platform-logging	~4KB	✅
ziegel-presentation	~10KB	✅
ziegel-intl	~15KB	✅

Support Matrix

Package	Node.js	TypeScript	Browser
All packages	18+	4.8+	ES2020+

Next Steps

• Getting Started - Quick start guide
• Examples - Practical examples
• Individual Package Docs - Detailed documentation for each package:
  • Core Package
  • Platform Services
  • Data Management
  • HTTP Client
  • Logging
  • Configuration
  • Caching
  • Analytics
  • Messaging
  • Serialization
  • Mapping
  • Presentation
  • Platform Presentation
  • Navigation
  • Internationalization
  • Commerce i18n
  • Units i18n
  • Redux Integration
  • RxJS Extensions
  • And more...

Package Selection Guide

For Web Applications

• Start with: ziegel-core, ziegel-platform
• Add HTTP: ziegel-platform-http
• Add logging: ziegel-platform-logging
• For UI: ziegel-presentation

For Node.js Services

• Start with: ziegel-core, ziegel-platform
• Add config: ziegel-platform-configuration
• Add logging: ziegel-platform-logging
• For APIs: ziegel-platform-http

For Internationalized Apps

• Base: ziegel-core, ziegel-intl
• Localization: ziegel-platform-localization
• Commerce: ziegel-intl-commerce
• Translation: ziegel-platform-translation

For Data-Heavy Applications

• Base: ziegel-core, ziegel-data
• Caching: ziegel-platform-caching
• Transactions: ziegel-platform-transaction
• Analytics: ziegel-platform-analytics