@gruncellka/porto-data 0.3.1 → 0.4.1

package/porto_data/schemas/envelopes.schema.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/envelopes.schema.json",
+  "title": "Envelopes (international physical sizes)",
+  "description": "Canonical envelope id and face dimensions (mm). standard ISO269 is the catalog token for the ISO 269 physical envelope-size family. Print/window geometry is jurisdiction-specific: formats/layouts.json.",
+  "type": "object",
+  "required": [
+    "file_type",
+    "unit",
+    "envelopes"
+  ],
+  "definitions": {
+    "envelope_sheet": {
+      "type": "object",
+      "required": [
+        "sheet",
+        "fold"
+      ],
+      "properties": {
+        "sheet": {
+          "type": "string",
+          "pattern": "^[AB][0-9]+$",
+          "description": "ISO 216 paper size (e.g. A4, A5, A6, B4)"
+        },
+        "fold": {
+          "type": "string",
+          "enum": [
+            "flat",
+            "half",
+            "quarter",
+            "trifold"
+          ],
+          "description": "Fold style for this sheets[] entry (outcome-oriented). flat=no crease; half=one crease (~½ area); quarter=two creases to ~¼ sheet area (e.g. A4→C6); trifold=two parallel creases, three panels (DL / business letter). quarter and trifold both use two creases; geometry differs."
+        },
+        "description": {
+          "type": "string",
+          "description": "Human-readable fold / use hint for SDKs and docs"
+        }
+      },
+      "additionalProperties": false
+    },
+    "envelope": {
+      "type": "object",
+      "required": [
+        "id",
+        "label",
+        "width",
+        "height",
+        "standard",
+        "sheets"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Z0-9]+$",
+          "description": "Referenced from products.envelope_ids"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "width": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "height": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "standard": {
+          "type": "string",
+          "const": "ISO269",
+          "description": "Physical envelope size taxonomy for this row (ISO 269 C/B/DL family)"
+        },
+        "sheets": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/definitions/envelope_sheet"
+          },
+          "description": "Document preparation options for this envelope: ISO 216 sheet size + fold that typically fits the face dimensions (carrier thickness and operator rules still apply)"
+        },
+        "notes": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "envelopes"
+    },
+    "unit": {
+      "type": "object",
+      "required": [
+        "dimension"
+      ],
+      "properties": {
+        "dimension": {
+          "type": "string",
+          "const": "mm"
+        }
+      },
+      "additionalProperties": false
+    },
+    "envelopes": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/envelope"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/porto_data/schemas/features.schema.json

@@ -1,60 +1,71 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/features.schema.json",
-    "title": "Features Schema",
-    "description": "Schema for service features definitions",
-    "type": "object",
-    "required": [
-        "file_type",
-        "features"
-    ],
-    "properties": {
-        "$schema": {
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/features.schema.json",
+  "title": "Features Schema",
+  "description": "Provider-scoped service feature catalog. Each row has a unified Porto `porto_id` (cross-provider vocabulary) and a provider `id` (this bundle’s primary key; `services[].features` references `id`, and may match `porto_id` when vocabulary aligns). Native-market `name` and English `label`.",
+  "type": "object",
+  "required": [
+    "file_type",
+    "provider",
+    "features"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI reference"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "features",
+      "description": "File type identifier"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z_]+$",
+      "description": "Provider id (must match providers.json and this file path)"
+    },
+    "features": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "porto_id",
+          "name",
+          "label",
+          "description"
+        ],
+        "properties": {
+          "id": {
             "type": "string",
-            "format": "uri",
-            "description": "JSON Schema URI reference"
-        },
-        "file_type": {
+            "pattern": "^[a-z_]+$",
+            "description": "Provider-scoped feature id in this catalog; referenced from services.json feature lists within the same provider"
+          },
+          "porto_id": {
+            "$ref": "porto_ids.schema.json#/definitions/feature_porto_id",
+            "description": "Unified Porto feature id for cross-provider resolution and SDK semantics"
+          },
+          "name": {
             "type": "string",
-            "const": "features",
-            "description": "File type identifier"
+            "minLength": 1,
+            "description": "Native-market display name (operator primary language, e.g. DE/FR)"
+          },
+          "label": {
+            "type": "string",
+            "minLength": 1,
+            "description": "English human-readable label for unified tooling and docs"
+          },
+          "description": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Feature description"
+          }
         },
-        "features": {
-            "type": "array",
-            "minItems": 1,
-            "items": {
-                "type": "object",
-                "required": [
-                    "id",
-                    "name",
-                    "label",
-                    "description"
-                ],
-                "properties": {
-                    "id": {
-                        "type": "string",
-                        "pattern": "^[a-z_]+$",
-                        "description": "Feature ID"
-                    },
-                    "name": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "German feature name"
-                    },
-                    "label": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "English feature label"
-                    },
-                    "description": {
-                        "type": "string",
-                        "minLength": 1,
-                        "description": "Feature description"
-                    }
-                },
-                "additionalProperties": false
-            }
-        }
-    },
-    "additionalProperties": false
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
 }

package/porto_data/schemas/graph.schema.json

@@ -0,0 +1,189 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/gruncellka/porto-data/refs/heads/main/porto_data/schemas/graph.schema.json",
+  "title": "Graph schema",
+  "description": "Provider graph: data file dependencies, resolution edges (products × zone × weight; marks × zone × service), and service list",
+  "type": "object",
+  "required": [
+    "file_type",
+    "provider",
+    "unit",
+    "dependencies",
+    "edges",
+    "services"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "description": "JSON Schema URI reference"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "graph",
+      "description": "File type identifier"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z_]+$",
+      "description": "Provider identifier (e.g. deutschepost, ukrposhta, laposte, swisspost)"
+    },
+    "unit": {
+      "type": "object",
+      "required": [
+        "weight",
+        "dimension",
+        "price",
+        "currency"
+      ],
+      "properties": {
+        "weight": {
+          "type": "string",
+          "const": "g"
+        },
+        "dimension": {
+          "type": "string",
+          "const": "mm"
+        },
+        "price": {
+          "type": "string",
+          "const": "cents"
+        },
+        "currency": {
+          "type": "string",
+          "enum": [
+            "EUR",
+            "CHF",
+            "UAH",
+            "USD"
+          ],
+          "description": "ISO 4217 currency code; must match policy/markets.json markets[providers.json country].currency"
+        }
+      },
+      "additionalProperties": false
+    },
+    "dependencies": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-z_]+$": {
+          "type": "object",
+          "required": [
+            "file",
+            "depends_on",
+            "description"
+          ],
+          "properties": {
+            "file": {
+              "type": "string",
+              "pattern": "^(policy/[a-z0-9_./-]+\\.json|formats/[a-z0-9_./-]+\\.json|[a-z0-9_./-]+\\.json)$",
+              "description": "Data path: provider-relative (e.g. prices/products.json) or bundle-shared under policy/ or formats/"
+            },
+            "depends_on": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "pattern": "^(policy/[a-z0-9_./-]+\\.json|formats/[a-z0-9_./-]+\\.json|[a-z0-9_./-]+\\.json)$"
+              },
+              "description": "List of dependent files (same path convention as file)"
+            },
+            "description": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Dependency description"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "edges": {
+      "type": "object",
+      "required": [
+        "products",
+        "marks"
+      ],
+      "properties": {
+        "products": {
+          "type": "object",
+          "description": "Per-product edges: each key is a **product `id`** from products.json. Maps product → allowed zones and weight tiers.",
+          "patternProperties": {
+            "^[a-z_]+$": {
+              "type": "object",
+              "required": [
+                "zones",
+                "weight_tiers"
+              ],
+              "properties": {
+                "zones": {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string",
+                    "pattern": "^[a-z0-9_]+$"
+                  },
+                  "description": "Available zones for this product"
+                },
+                "weight_tiers": {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string",
+                    "pattern": "^W[0-9]+$"
+                  },
+                  "description": "Available weight tiers for this product"
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
+        "marks": {
+          "type": "object",
+          "description": "Mark profile resolution per zone. Keys are zone ids from zones.json.",
+          "patternProperties": {
+            "^[a-z0-9_]+$": {
+              "type": "object",
+              "required": [
+                "profile"
+              ],
+              "properties": {
+                "profile": {
+                  "type": "string",
+                  "pattern": "^[a-z0-9_]+$",
+                  "description": "Default marks.profiles[].id for this zone"
+                },
+                "services": {
+                  "type": "object",
+                  "minProperties": 1,
+                  "patternProperties": {
+                    "^[a-z_]+$": {
+                      "type": "string",
+                      "pattern": "^[a-z0-9_]+$"
+                    }
+                  },
+                  "additionalProperties": false,
+                  "description": "Native service id → marks.profiles[].id when that service is selected"
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "services": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "pattern": "^[a-z_]+$"
+      },
+      "description": "Attachable services for this provider. Each entry must match **services.json `id`** (provider-native key)."
+    }
+  },
+  "additionalProperties": false
+}

package/porto_data/schemas/jurisdictions.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/jurisdictions.schema.json",
+  "title": "Jurisdictions (membership reference)",
+  "description": "Symbolic blocs eu and un (members + timezone) plus per-country IANA zones (uppercase ISO alpha-2 key, timezone only). Switzerland is keyed CH only (no lowercase ch bloc). providers.json resolves operational timezone via jurisdictions[COUNTRY].timezone.",
+  "type": "object",
+  "required": [
+    "file_type",
+    "unit",
+    "jurisdictions"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "file_type": {
+      "type": "string",
+      "const": "jurisdictions"
+    },
+    "description": {
+      "type": "string"
+    },
+    "unit": {
+      "type": "object",
+      "description": "Human-readable encoding hints for this file and related porto-data fields. Required: country_code (alpha-2 in jurisdictions.*.members and uppercase country keys). Other keys are optional documentation (e.g. region_code, date); values are short standard names.",
+      "required": [
+        "country_code"
+      ],
+      "properties": {
+        "country_code": {
+          "type": "string",
+          "const": "ISO 3166-1 alpha-2"
+        },
+        "region_code": {
+          "type": "string",
+          "const": "ISO 3166-2"
+        },
+        "date": {
+          "type": "string",
+          "const": "ISO 8601"
+        }
+      },
+      "additionalProperties": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "jurisdictions": {
+      "type": "object",
+      "description": "Keys: lowercase eu, un (blocs with members + timezone). Uppercase ISO alpha-2: timezone only. Framework tag CH resolves via country entry CH, not a ch bloc.",
+      "required": [
+        "eu",
+        "un"
+      ],
+      "properties": {
+        "eu": {
+          "$ref": "#/definitions/jurisdiction_bloc"
+        },
+        "un": {
+          "$ref": "#/definitions/jurisdiction_bloc"
+        }
+      },
+      "patternProperties": {
+        "^[A-Z]{2}$": {
+          "$ref": "#/definitions/jurisdiction_country"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "definitions": {
+    "jurisdiction_bloc": {
+      "type": "object",
+      "description": "Member list and default IANA zone for symbolic framework tags EU or UN.",
+      "required": [
+        "members",
+        "timezone"
+      ],
+      "properties": {
+        "members": {
+          "type": "array",
+          "description": "ISO 3166-1 alpha-2 codes in this bloc",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Z]{2}$"
+          }
+        },
+        "timezone": {
+          "type": "string",
+          "minLength": 3,
+          "pattern": "^[A-Za-z0-9_+-]+(/[A-Za-z0-9_+-]+)+$"
+        }
+      },
+      "additionalProperties": false
+    },
+    "jurisdiction_country": {
+      "type": "object",
+      "description": "Primary legal/operational IANA zone for this country code (same key as ISO alpha-2).",
+      "required": [
+        "timezone"
+      ],
+      "properties": {
+        "timezone": {
+          "type": "string",
+          "minLength": 3,
+          "pattern": "^[A-Za-z0-9_+-]+(/[A-Za-z0-9_+-]+)+$"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}