# meaningfy-ws/mapping-suite-sdk architecture

> Architecture diagram of the GitHub repository meaningfy-ws/mapping-suite-sdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/meaningfy-ws/mapping-suite-sdk
- Repository: https://github.com/meaningfy-ws/mapping-suite-sdk

## Overview

##### Project Type and Purpose
- The project is an SDK (Software Development Kit) built for working with “Mapping Suites”. It focuses on the re-use of mapping suites (described as ZIP archive files with a specific folder structure) within transformation pipelines.
- There are two main use case perspectives mentioned in the README—one for a “UserModel” in a pipeline and one for a “DeveloperModel” in an editor. Although the current focus is on re-use, this hints at a separation in concerns between runtime usage and development.

##### File Structure
- Top-Level Components:
– The project root includes CI/CD configurations (.github/workflows), testing setup (tests), documentation (docs), and packaging scripts (Makefile, pyproject.toml, requirements.txt).
- Core Library Structure (located in the “mapping_suite_sdk” directory):
– Adapters: Contains modules like extractor.py, loader.py, and serialiser.py. These are responsible for handling input (extracting data from archives) and output (serialising mapping packages).
– Models: Consists of domain entities such as asset.py, core.py, and mapping_package.py. These files define the structure and relationships of the mapping suite domain.
– Services: Contains orchestration logic (e.g., load_mapping_package.py and serialise_mapping_package.py) that tie adapters and models together.
- Testing: The tests directory includes unit tests for both adapters and services and contains sample mapping package archives for test data.
- Documentation: The docs folder (with Antora configuration) is used to generate module-based documentation, which helps others understand the usage and structure of the SDK.

##### Elements
- Clear Labels: Each component (e.g., “Adapters”, “Models”, “Services”, “Mapping Package Archive”, and “Client / Pipeline”).

## Diagram (Mermaid)

```mermaid
graph TD
    EXTERNAL["Mapping Package Archive (ZIP)"]:::external
    SDKC["SDK Core"]:::sdkcore
    AD["Adapters"]:::adapter
    MO["Models"]:::model
    SE["Services"]:::service
    CLIENT["Client/Pipeline (UserModel)"]:::client
    DEVELOPER["Developer Model (Editor)"]:::client
    SUPPORT_DOC["Documentation"]:::support
    SUPPORT_CI["CI/CD Configurations"]:::support

    EXTERNAL -->|"provides"| SDKC
    SDKC -->|"contains"| AD
    AD -->|"extracts/loads"| MO
    MO -->|"structures"| SE
    SE -->|"serves"| CLIENT
    SE -->|"integrates"| DEVELOPER

    SDKC ---|"supports"| SUPPORT_DOC
    SDKC ---|"monitored by"| SUPPORT_CI

    click SDKC "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/mapping_suite_sdk/"
    click AD "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/mapping_suite_sdk/adapters/"
    click MO "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/mapping_suite_sdk/models/"
    click SE "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/mapping_suite_sdk/services/"
    click EXTERNAL "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/tests/test_data/mapping_packages/"
    click SUPPORT_DOC "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/docs/"
    click SUPPORT_CI "https://github.com/meaningfy-ws/mapping-suite-sdk/tree/main/.github/workflows/"

    classDef sdkcore fill:#B3E5FC,stroke:#0277BD,stroke-width:2px;
    classDef adapter fill:#C8E6C9,stroke:#2E7D32,stroke-width:2px;
    classDef model fill:#FFF9C4,stroke:#F9A825,stroke-width:2px;
    classDef service fill:#FFECB3,stroke:#EF6C00,stroke-width:2px;
    classDef external fill:#FFCDD2,stroke:#C62828,stroke-width:2px;
    classDef client fill:#D1C4E9,stroke:#5E35B1,stroke-width:2px;
    classDef support fill:#E0E0E0,stroke:#757575,stroke-width:2px;
```
