@gruncellka/porto-data 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 gruncellka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# Porto Data
+
+[![validation](https://github.com/gruncellka/porto-data/actions/workflows/validation.yml/badge.svg)](https://github.com/gruncellka/porto-data/actions/workflows/validation.yml)
+[![codecov](https://codecov.io/gh/gruncellka/porto-data/branch/main/graph/badge.svg)](https://codecov.io/gh/gruncellka/porto-data)
+
+**Structured JSON data for Deutsche Post shipping services**
+
+A comprehensive, schema-validated dataset containing Deutsche Post pricing, restrictions, zones, features, services, and compliance frameworks for international postal services. All data is validated against JSON schemas and published as a self-contained package on **npm** and **PyPI**.
+
+---
+
+## Install
+
+**npm** (scope: `@gruncellka`)
+
+```bash
+npm install @gruncellka/porto-data
+```
+
+**PyPI (Python)**
+
+```bash
+pip install gruncellka-porto-data
+```
+
+The package includes `data/`, `schemas/`, `mappings.json`, and `metadata.json` so you can validate and use the data offline. Data files reference canonical schema URLs (GitHub); schemas are shipped in the package for local validation.
+
+- **PyPI**: After `pip install`, use the `porto` CLI or import the `porto_data` package; paths are resolved automatically.
+- **npm**: Data lives under `porto_data/` (e.g. `porto_data/data/products.json`, `porto_data/schemas/`, `porto_data/mappings.json`, `porto_data/metadata.json`). Same layout in both ecosystems; the `porto_data` folder exists so the wheel includes the files correctly.
+
+---
+
+## Use cases
+
+E-commerce and logistics (shipping costs, restrictions), compliance (sanctions, frameworks), research and education.
+
+---
+
+## Data statistics
+
+9 JSON files, 9 schemas; 190+ countries in zones; 5 product types; 5 service types (e.g. registered mail); 31 restrictions across 18 compliance frameworks.
+
+---
+
+## Data overview and structure
+
+| File                | Description                                             |
+| ------------------- | ------------------------------------------------------- |
+| `products.json`     | Shipping products (letters, parcels, packages)          |
+| `services.json`     | Additional services (registered mail, etc.)             |
+| `prices.json`       | Pricing by product, zone, and weight (effective dates)  |
+| `zones.json`        | Geographic zones and country mappings                   |
+| `weight_tiers.json` | Weight brackets for pricing                             |
+| `dimensions.json`   | Size limits and specifications                          |
+| `features.json`     | Service features and capabilities                       |
+| `restrictions.json` | Shipping restrictions, sanctions, compliance frameworks |
+| `data_links.json`   | Cross-references between data files                     |
+
+All data is validated against JSON schemas in `schemas/`; `mappings.json` maps schemas to files; `metadata.json` has checksums and canonical URLs. **Structure:** Products → Prices → Zones (dimensions, weight tiers, effective dates); Services → Features; Restrictions → Frameworks (e.g. EU sanctions, UN resolutions). One-directional; no circular dependencies. `data_links.json` describes dependencies and lookup rules.
+
+---
+
+## Standards
+
+- **Country codes**: ISO 3166-1 alpha-2 (`DE`, `US`, `FR`, `YE`)
+- **Region codes**: ISO 3166-2 (`DE-BY`, `US-CA`, `FR-75`)
+- **Dates**: ISO 8601 (`2024-01-15`, `2023-06-01`)
+- **Jurisdiction**: `EU` (European Union), `UN` (United Nations), `DE` (Germany), `DP` (Deutsche Post operational)
+
+**Restrictions:** Tracks occupied/disputed territories, links to legal frameworks (EU sanctions, UN resolutions), supports partial territory restrictions (`effective_partial`) and historical dates (`effective_from`, `effective_to`).
+
+---
+
+## Disclaimer
+
+This is **reference data** for Deutsche Post services. Always verify current restrictions, pricing, and service availability with Deutsche Post before shipping. Data accuracy is best-effort. Official information: [Deutsche Post](https://www.deutschepost.de).
+
+---
+
+## Related resources
+
+- [Deutsche Post](https://www.deutschepost.de)
+- [EU Sanctions Map](https://www.sanctionsmap.eu/)
+- [ISO 3166 Country Codes](https://www.iso.org/iso-3166-country-codes.html)
+
+---
+
+🔳 gruncellka

package/package.json

@@ -0,0 +1,28 @@
+{
+    "name": "@gruncellka/porto-data",
+    "version": "0.1.0",
+    "description": "Deutsche Post pricing and rules data with schema validation",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/gruncellka/porto-data.git"
+    },
+    "keywords": [
+        "deutsche-post",
+        "shipping",
+        "postal",
+        "pricing",
+        "zones",
+        "restrictions",
+        "json",
+        "schema"
+    ],
+    "files": [
+        "porto_data/data",
+        "porto_data/schemas",
+        "porto_data/mappings.json",
+        "porto_data/metadata.json",
+        "README.md",
+        "LICENSE"
+    ]
+}

package/porto_data/data/data_links.json

@@ -0,0 +1,148 @@
+{
+    "$schema": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/data_links.schema.json",
+    "file_type": "data_links",
+    "schema_version": "1.0",
+    "unit": {
+        "weight": "g",
+        "dimension": "mm",
+        "price": "cents",
+        "currency": "EUR"
+    },
+    "dependencies": {
+        "products": {
+            "file": "products.json",
+            "depends_on": [
+                "zones.json",
+                "weight_tiers.json",
+                "dimensions.json",
+                "services.json",
+                "features.json"
+            ],
+            "description": "Products require zones, weight tiers, dimensions, services and features"
+        },
+        "services": {
+            "file": "services.json",
+            "depends_on": [
+                "features.json"
+            ],
+            "description": "Services require features and price information"
+        },
+        "prices": {
+            "file": "prices.json",
+            "depends_on": [
+                "products.json",
+                "services.json",
+                "zones.json",
+                "weight_tiers.json"
+            ],
+            "description": "Prices reference products, services, zones, and weight tiers"
+        },
+        "zones": {
+            "file": "zones.json",
+            "depends_on": [
+                "restrictions.json"
+            ],
+            "description": "Zones may have restricted destinations"
+        },
+        "weight_tiers": {
+            "file": "weight_tiers.json",
+            "depends_on": [],
+            "description": "Weight tiers are standalone definitions"
+        },
+        "dimensions": {
+            "file": "dimensions.json",
+            "depends_on": [],
+            "description": "Dimensions are standalone definitions"
+        },
+        "restrictions": {
+            "file": "restrictions.json",
+            "depends_on": [
+                "zones.json",
+                "products.json"
+            ],
+            "description": "Restrictions reference zones, products, and compliance frameworks"
+        },
+        "features": {
+            "file": "features.json",
+            "depends_on": [],
+            "description": "Features are standalone definitions referenced by services"
+        }
+    },
+    "links": {
+        "letter_standard": {
+            "zones": [
+                "domestic",
+                "zone_1_eu",
+                "world"
+            ],
+            "weight_tiers": [
+                "W0020"
+            ]
+        },
+        "letter_compact": {
+            "zones": [
+                "domestic",
+                "zone_1_eu",
+                "world"
+            ],
+            "weight_tiers": [
+                "W0050"
+            ]
+        },
+        "letter_large": {
+            "zones": [
+                "domestic",
+                "zone_1_eu",
+                "world"
+            ],
+            "weight_tiers": [
+                "W0500"
+            ]
+        },
+        "letter_maxi": {
+            "zones": [
+                "domestic",
+                "zone_1_eu",
+                "world"
+            ],
+            "weight_tiers": [
+                "W1000"
+            ]
+        },
+        "merchandise": {
+            "zones": [
+                "domestic"
+            ],
+            "weight_tiers": [
+                "W1000",
+                "W2000"
+            ]
+        }
+    },
+    "lookup_rules": {
+        "price_lookup": "Find price in prices.json where product_id + zone + weight_tier match",
+        "service_lookup": "Find service in services.json by id",
+        "weight_resolution": "Find weight_tier in weight_tiers.json where min <= weight <= max",
+        "zone_validation": "Check if zone is in product's zones array"
+    },
+    "global_settings": {
+        "price_source": "prices.json",
+        "lookup_method": {
+            "file": "prices.json",
+            "array": "prices.product_prices",
+            "match": {
+                "product_id": "from product id",
+                "zone": "from zones array",
+                "weight_tier": "from weight_tiers array"
+            },
+            "description": "Find prices by matching product_id, zone, and weight_tier"
+        },
+        "available_services": [
+            "registered_mail",
+            "registered_mail_mailbox",
+            "registered_mail_return_receipt",
+            "registered_mail_personal",
+            "registered_mail_personal_return_receipt"
+        ]
+    }
+}

package/porto_data/data/dimensions.json

@@ -0,0 +1,158 @@
+{
+    "$schema": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/dimensions.schema.json",
+    "file_type": "dimensions",
+    "unit": {
+        "dimension": "mm"
+    },
+    "dimensions": [
+        {
+            "id": "DL",
+            "label": "DIN Lang",
+            "standard": "DIN 678",
+            "size": {
+                "width": 220,
+                "height": 110,
+                "thickness": 5
+            },
+            "print_area": {
+                "x": 10,
+                "y": 45,
+                "width": 200,
+                "height": 60
+            },
+            "stamp_area": {
+                "x": 160,
+                "y": 10,
+                "width": 40,
+                "height": 40
+            },
+            "window_supported": true,
+            "window_area": {
+                "x": 20,
+                "y": 50,
+                "width": 90,
+                "height": 40
+            },
+            "orientation": "landscape",
+            "weight_tier": "W0020"
+        },
+        {
+            "id": "C6",
+            "label": "C6 Envelope",
+            "standard": "DIN 678",
+            "size": {
+                "width": 162,
+                "height": 114,
+                "thickness": 5
+            },
+            "print_area": {
+                "x": 10,
+                "y": 45,
+                "width": 140,
+                "height": 60
+            },
+            "stamp_area": {
+                "x": 110,
+                "y": 10,
+                "width": 40,
+                "height": 40
+            },
+            "window_supported": true,
+            "window_area": {
+                "x": 20,
+                "y": 50,
+                "width": 90,
+                "height": 40
+            },
+            "orientation": "landscape",
+            "weight_tier": "W0020"
+        },
+        {
+            "id": "C5",
+            "label": "C5 Envelope",
+            "standard": "DIN 678",
+            "size": {
+                "width": 229,
+                "height": 162,
+                "thickness": 10
+            },
+            "print_area": {
+                "x": 15,
+                "y": 50,
+                "width": 200,
+                "height": 90
+            },
+            "stamp_area": {
+                "x": 180,
+                "y": 15,
+                "width": 40,
+                "height": 40
+            },
+            "window_supported": true,
+            "window_area": {
+                "x": 20,
+                "y": 60,
+                "width": 90,
+                "height": 45
+            },
+            "orientation": "landscape",
+            "weight_tier": "W0050"
+        },
+        {
+            "id": "C4",
+            "label": "C4 Envelope",
+            "standard": "DIN 678",
+            "size": {
+                "width": 324,
+                "height": 229,
+                "thickness": 20
+            },
+            "print_area": {
+                "x": 15,
+                "y": 60,
+                "width": 295,
+                "height": 150
+            },
+            "stamp_area": {
+                "x": 270,
+                "y": 15,
+                "width": 40,
+                "height": 40
+            },
+            "window_supported": true,
+            "window_area": {
+                "x": 20,
+                "y": 70,
+                "width": 90,
+                "height": 45
+            },
+            "orientation": "landscape",
+            "weight_tier": "W0500"
+        },
+        {
+            "id": "B4",
+            "label": "B4 Envelope",
+            "standard": "DIN 678",
+            "size": {
+                "width": 353,
+                "height": 250,
+                "thickness": 50
+            },
+            "print_area": {
+                "x": 15,
+                "y": 70,
+                "width": 320,
+                "height": 170
+            },
+            "stamp_area": {
+                "x": 300,
+                "y": 15,
+                "width": 40,
+                "height": 40
+            },
+            "supports_window": false,
+            "orientation": "landscape",
+            "weight_tier": "W1000"
+        }
+    ]
+}

package/porto_data/data/features.json

@@ -0,0 +1,66 @@
+{
+    "$schema": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/features.schema.json",
+    "file_type": "features",
+    "features": [
+        {
+            "id": "tracking_number",
+            "name": "Sendungsverfolgung",
+            "label": "Tracking number",
+            "description": "Unique tracking number for package monitoring"
+        },
+        {
+            "id": "proof_of_mailing",
+            "name": "Einlieferungsbeleg",
+            "label": "Proof of mailing",
+            "description": "Documentation that item was mailed"
+        },
+        {
+            "id": "delivery_confirmation",
+            "name": "Zustellbest\u00e4tigung",
+            "label": "Delivery confirmation",
+            "description": "Confirmation that item was delivered"
+        },
+        {
+            "id": "mailbox_delivery",
+            "name": "Briefkastenzustellung",
+            "label": "Mailbox delivery",
+            "description": "Item delivered directly to recipient's mailbox"
+        },
+        {
+            "id": "photo_proof_delivery",
+            "name": "Foto-Zustellnachweis",
+            "label": "Photo proof of delivery",
+            "description": "Photographic evidence of delivery"
+        },
+        {
+            "id": "recipient_signature",
+            "name": "Empf\u00e4ngerunterschrift",
+            "label": "Recipient signature required",
+            "description": "Recipient must sign upon delivery"
+        },
+        {
+            "id": "return_receipt",
+            "name": "R\u00fcckschein",
+            "label": "Return receipt to sender",
+            "description": "Receipt returned to sender as proof of delivery"
+        },
+        {
+            "id": "proof_of_delivery",
+            "name": "Zustellnachweis",
+            "label": "Proof of delivery",
+            "description": "Documentation proving successful delivery"
+        },
+        {
+            "id": "personal_delivery",
+            "name": "Eigenh\u00e4ndige Zustellung",
+            "label": "Personal delivery to recipient only",
+            "description": "Item delivered only to the named recipient"
+        },
+        {
+            "id": "id_verification",
+            "name": "Ausweiskontrolle",
+            "label": "ID verification",
+            "description": "Recipient must show identification"
+        }
+    ]
+}