@gruncellka/porto-data 0.3.1 → 0.4.1

package/porto_data/schemas/service_prices.schema.json

@@ -0,0 +1,116 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/service_prices.schema.json",
+  "title": "Service surcharge prices",
+  "description": "Add-on service amounts keyed by service_id (native id from services.json). Convention: price[].effective_from uses the catalog baseline date (currently 2026-01-01) as bundle snapshot start, not carrier historical introduction dates.",
+  "type": "object",
+  "required": [
+    "file_type",
+    "provider",
+    "unit",
+    "service_prices"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "service_prices"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z_]+$",
+      "description": "Provider identifier"
+    },
+    "unit": {
+      "type": "object",
+      "required": [
+        "price",
+        "currency"
+      ],
+      "properties": {
+        "price": {
+          "type": "string",
+          "const": "cents"
+        },
+        "currency": {
+          "type": "string",
+          "enum": [
+            "EUR",
+            "CHF",
+            "UAH",
+            "USD"
+          ],
+          "description": "Default currency for rows in this file. Set row.currency only when a row is quoted in another currency (must differ from this default)."
+        }
+      },
+      "additionalProperties": false
+    },
+    "service_prices": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": [
+          "service_id",
+          "price"
+        ],
+        "properties": {
+          "service_id": {
+            "type": "string",
+            "pattern": "^[a-z0-9_]+$",
+            "description": "Must match services.json id"
+          },
+          "currency": {
+            "type": "string",
+            "enum": [
+              "EUR",
+              "CHF",
+              "UAH",
+              "USD"
+            ],
+            "description": "Row override when this amount is not in unit.currency. Omit when same as file default. SDK priority: row → file unit → markets[country].currency."
+          },
+          "price": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "type": "object",
+              "required": [
+                "amount",
+                "effective_from"
+              ],
+              "properties": {
+                "amount": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "effective_from": {
+                  "type": [
+                    "string",
+                    "null"
+                  ],
+                  "format": "date",
+                  "description": "Row valid from this date. Provider bundles use the catalog baseline (e.g. 2026-01-01) unless superseding rows exist."
+                },
+                "effective_to": {
+                  "type": [
+                    "string",
+                    "null"
+                  ],
+                  "format": "date",
+                  "description": "Null while current; set when a newer price row replaces this amount."
+                }
+              },
+              "additionalProperties": false
+            }
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/porto_data/schemas/services.schema.json

@@ -1,77 +1,120 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/services.schema.json",
-    "title": "Services Schema",
-    "description": "Schema for Deutsche Post services definitions",
-    "type": "object",
-    "required": [
-        "file_type",
-        "services"
-    ],
-    "properties": {
-        "$schema": {
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/services.schema.json",
+  "title": "Services Schema",
+  "description": "Provider-scoped postal add-on services. Each row has unified Porto `porto_id` (SDK input), provider `id` (native catalog key for graph/prices/rules), native `name`, and English `label`.",
+  "type": "object",
+  "required": [
+    "file_type",
+    "provider",
+    "services"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI reference"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "services",
+      "description": "File type identifier"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z_]+$",
+      "description": "Provider identifier (e.g. deutschepost, ukrposhta, laposte, swisspost)"
+    },
+    "services": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "porto_id",
+          "name",
+          "label",
+          "description",
+          "features"
+        ],
+        "properties": {
+          "id": {
             "type": "string",
-            "format": "uri",
-            "description": "JSON Schema URI reference"
-        },
-        "file_type": {
+            "pattern": "^[a-z_]+$",
+            "description": "Provider-scoped service id in this catalog (may match operator naming; referenced from provider-specific tooling)"
+          },
+          "porto_id": {
+            "$ref": "porto_ids.schema.json#/definitions/service_porto_id",
+            "description": "Unified Porto service id for SDK input and cross-operator resolution. graph.json and prices.service_id use native `id`, not `porto_id`."
+          },
+          "name": {
             "type": "string",
-            "const": "services",
-            "description": "File type identifier"
-        },
-        "services": {
+            "minLength": 1,
+            "description": "Native-market service name (operator primary language)"
+          },
+          "label": {
+            "type": "string",
+            "minLength": 1,
+            "description": "English human-readable label for unified tooling and docs"
+          },
+          "description": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Service description"
+          },
+          "features": {
             "type": "array",
             "minItems": 1,
             "items": {
-                "type": "object",
-                "required": [
-                    "id",
-                    "name",
-                    "description",
-                    "features"
-                ],
-                "properties": {
-                    "id": {
-                        "type": "string",
-                        "pattern": "^[a-z_]+$",
-                        "description": "Service ID"
-                    },
-                    "name": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "German service name"
-                    },
-                    "name_en": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "English service name (optional)"
-                    },
-                    "description": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "Service description"
-                    },
-                    "features": {
-                        "type": "array",
-                        "minItems": 1,
-                        "items": {
-                            "type": "string",
-                            "pattern": "^[a-z_]+$",
-                            "description": "Feature ID reference"
-                        },
-                        "description": "List of feature IDs this service provides"
-                    },
-                    "source_id": {
-                        "type": [
-                            "string",
-                            "null"
-                        ],
-                        "description": "Deutsche Post PPL service identifier (note: services in PPL are typically composite products, not standalone IDs)"
-                    }
-                },
-                "additionalProperties": false
-            }
-        }
-    },
-    "additionalProperties": false
+              "type": "string",
+              "pattern": "^[a-z_]+$",
+              "description": "Feature ID reference"
+            },
+            "description": "Feature references: each entry may be provider feature `id` or unified `porto_id` (see features.json)"
+          },
+          "source_id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Deutsche Post PPL service identifier (note: services in PPL are typically composite products, not standalone IDs)"
+          },
+          "online_supported": {
+            "type": "boolean",
+            "description": "Whether this service can be ordered via online provider flows (e.g. Internetmarke, WebStamp). Default: true if omitted. Set false for discontinued or offline-only services."
+          },
+          "integrations": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "boolean"
+            },
+            "description": "Per-integration support: { \"internetmarke\": true, \"webstamp\": false }. Only list integrations with explicit evidence of support."
+          },
+          "supported_zones": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^[a-z0-9_]+$"
+            },
+            "description": "Zone IDs where this service is orderable via API. When omitted, service is available for all zones the product supports. Used for API restrictions (e.g. Einschreiben Einwurf/Rückschein only domestic via Internetmarke)."
+          },
+          "combinable_with": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^[a-z_]+$"
+            },
+            "description": "Service IDs this service can be combined with in a single order."
+          },
+          "enables_tracking": {
+            "type": "boolean",
+            "description": "When true, ordering this service activates tracking on the execution result (product tracking_mode must be optional or included)."
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
 }

package/porto_data/schemas/weights.schema.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/weights.schema.json",
+  "title": "Weights schema",
+  "description": "Provider weight brackets (tier ids W* → min/max g) for pricing and resolution",
+  "type": "object",
+  "required": [
+    "file_type",
+    "provider",
+    "unit",
+    "weights"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI reference"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "weights",
+      "description": "File type identifier"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z_]+$",
+      "description": "Provider identifier (e.g. deutschepost, ukrposhta, laposte, swisspost)"
+    },
+    "unit": {
+      "type": "object",
+      "required": [
+        "weight"
+      ],
+      "properties": {
+        "weight": {
+          "type": "string",
+          "const": "g"
+        }
+      },
+      "additionalProperties": false
+    },
+    "weights": {
+      "type": "object",
+      "patternProperties": {
+        "^W[0-9]+$": {
+          "type": "object",
+          "required": [
+            "min",
+            "max"
+          ],
+          "properties": {
+            "min": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Minimum weight in grams"
+            },
+            "max": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "Maximum weight in grams"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/porto_data/schemas/zones.schema.json

@@ -1,79 +1,85 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/zones.schema.json",
-    "title": "Zones Schema",
-    "description": "Schema for shipping zones definitions",
-    "type": "object",
-    "required": [
-        "file_type",
-        "unit",
-        "zones"
-    ],
-    "properties": {
-        "$schema": {
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/zones.schema.json",
+  "title": "Zones Schema",
+  "description": "Schema for shipping zones definitions",
+  "type": "object",
+  "required": [
+    "file_type",
+    "provider",
+    "unit",
+    "zones"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI reference"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "zones",
+      "description": "File type identifier"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z_]+$",
+      "description": "Provider identifier (e.g. deutschepost, ukrposhta, laposte, swisspost)"
+    },
+    "unit": {
+      "type": "object",
+      "required": [
+        "country_code"
+      ],
+      "properties": {
+        "country_code": {
+          "type": "string",
+          "const": "ISO 3166-1 alpha-2"
+        }
+      },
+      "additionalProperties": false
+    },
+    "zones": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "name",
+          "description",
+          "country_codes"
+        ],
+        "properties": {
+          "id": {
             "type": "string",
-            "format": "uri",
-            "description": "JSON Schema URI reference"
-        },
-        "file_type": {
+            "pattern": "^[a-z0-9_]+$",
+            "description": "Zone ID"
+          },
+          "name": {
             "type": "string",
-            "const": "zones",
-            "description": "File type identifier"
-        },
-        "unit": {
-            "type": "object",
-            "required": [
-                "country_code"
-            ],
-            "properties": {
-                "country_code": {
-                    "type": "string",
-                    "const": "ISO 3166-1 alpha-2"
-                }
-            },
-            "additionalProperties": false
-        },
-        "zones": {
+            "minLength": 1,
+            "description": "Zone name"
+          },
+          "description": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Zone description"
+          },
+          "country_codes": {
             "type": "array",
             "minItems": 1,
             "items": {
-                "type": "object",
-                "required": [
-                    "id",
-                    "name",
-                    "description",
-                    "country_codes"
-                ],
-                "properties": {
-                    "id": {
-                        "type": "string",
-                        "pattern": "^[a-z0-9_]+$",
-                        "description": "Zone ID"
-                    },
-                    "name": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "Zone name"
-                    },
-                    "description": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "Zone description"
-                    },
-                    "country_codes": {
-                        "type": "array",
-                        "minItems": 1,
-                        "items": {
-                            "type": "string",
-                            "pattern": "^[A-Z]{2}$",
-                            "description": "ISO 3166-1 alpha-2 country code"
-                        },
-                        "description": "List of country codes in this zone"
-                    }
-                },
-                "additionalProperties": false
-            }
-        }
-    },
-    "additionalProperties": false
+              "type": "string",
+              "pattern": "^[A-Z]{2}$",
+              "description": "ISO 3166-1 alpha-2 country code"
+            },
+            "description": "List of country codes in this zone"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
 }