karrio-server-graph 2025.5.5__py3-none-any.whl → 2025.5.7__py3-none-any.whl

karrio/server/graph/schemas/base/types.py

@@ -1148,15 +1148,18 @@ class ShipmentType:
         return utils.paginated_connection(queryset, **_filter.pagination())
 
 
+# ─────────────────────────────────────────────────────────────────────────────
+# SHARED ZONE TYPE (Rate Sheet Level)
+# ─────────────────────────────────────────────────────────────────────────────
+
+
 @strawberry.type
-class ServiceZoneType:
+class SharedZoneType:
+    """Shared zone definition at the RateSheet level."""
+
     object_type: str
-    id: typing.Optional[str] = None
+    id: str
     label: typing.Optional[str] = None
-    rate: typing.Optional[float] = None
-
-    min_weight: typing.Optional[float] = None
-    max_weight: typing.Optional[float] = None
 
     transit_days: typing.Optional[int] = None
     transit_time: typing.Optional[float] = None
@@ -1167,24 +1170,98 @@ class ServiceZoneType:
 
     cities: typing.Optional[typing.List[str]] = None
     postal_codes: typing.Optional[typing.List[str]] = None
-    country_codes: typing.Optional[typing.List[utils.CountryCodeEnum]] = None
+    country_codes: typing.Optional[typing.List[str]] = None
 
     @staticmethod
     def parse(zone: dict):
-        return ServiceZoneType(
-            **{
-                "object_type": "zone",
-                **{
-                    k: v
-                    for k, v in zone.items()
-                    if k in ServiceZoneType.__annotations__
-                },
-            }
+        return SharedZoneType(
+            object_type="shared_zone",
+            id=zone.get("id", ""),
+            label=zone.get("label"),
+            transit_days=zone.get("transit_days"),
+            transit_time=zone.get("transit_time"),
+            radius=zone.get("radius"),
+            latitude=zone.get("latitude"),
+            longitude=zone.get("longitude"),
+            cities=zone.get("cities"),
+            postal_codes=zone.get("postal_codes"),
+            country_codes=zone.get("country_codes"),
+        )
+
+
+# ─────────────────────────────────────────────────────────────────────────────
+# SHARED SURCHARGE TYPE (Rate Sheet Level)
+# ─────────────────────────────────────────────────────────────────────────────
+
+
+@strawberry.type
+class SharedSurchargeType:
+    """Shared surcharge definition at the RateSheet level."""
+
+    object_type: str
+    id: str
+    name: str
+    amount: float
+    surcharge_type: str
+    cost: typing.Optional[float] = None
+    active: bool = True
+
+    @staticmethod
+    def parse(surcharge: dict):
+        return SharedSurchargeType(
+            object_type="shared_surcharge",
+            id=surcharge.get("id", ""),
+            name=surcharge.get("name", ""),
+            amount=float(surcharge.get("amount", 0)),
+            surcharge_type=surcharge.get("surcharge_type", "fixed"),
+            cost=surcharge.get("cost"),
+            active=surcharge.get("active", True),
+        )
+
+
+# ─────────────────────────────────────────────────────────────────────────────
+# SERVICE RATE TYPE (Service-Zone Rate Mapping)
+# ─────────────────────────────────────────────────────────────────────────────
+
+
+@strawberry.type
+class ServiceRateType:
+    """Service-zone rate mapping."""
+
+    object_type: str
+    service_id: str
+    zone_id: str
+    rate: float
+    cost: typing.Optional[float] = None
+    min_weight: typing.Optional[float] = None
+    max_weight: typing.Optional[float] = None
+    transit_days: typing.Optional[int] = None
+    transit_time: typing.Optional[float] = None
+
+    @staticmethod
+    def parse(rate: dict):
+        return ServiceRateType(
+            object_type="service_rate",
+            service_id=rate.get("service_id", ""),
+            zone_id=rate.get("zone_id", ""),
+            rate=float(rate.get("rate", 0)),
+            cost=rate.get("cost"),
+            min_weight=rate.get("min_weight"),
+            max_weight=rate.get("max_weight"),
+            transit_days=rate.get("transit_days"),
+            transit_time=rate.get("transit_time"),
         )
 
 
 @strawberry.type
 class ServiceLevelType:
+    """
+    Service level definition for rate sheet-based shipping.
+
+    Services reference shared zones and surcharges defined at the RateSheet level
+    via zone_ids and surcharge_ids. Rate values are stored in RateSheet.service_rates.
+    """
+
     id: str
     object_type: str
     service_name: typing.Optional[str]
@@ -1202,24 +1279,33 @@ class ServiceLevelType:
     max_length: typing.Optional[float]
     dimension_unit: typing.Optional[utils.DimensionUnitEnum]
 
+    min_weight: typing.Optional[float]
     max_weight: typing.Optional[float]
     weight_unit: typing.Optional[utils.WeightUnitEnum]
 
+    max_volume: typing.Optional[float]
+    cost: typing.Optional[float]
+
     domicile: typing.Optional[bool]
     international: typing.Optional[bool]
 
     @strawberry.field
-    def zones(self: providers.ServiceLevel) -> typing.List[ServiceZoneType]:
-        # Use computed_zones for backward compatibility with optimized structure
-        return [ServiceZoneType.parse(zone) for zone in self.computed_zones]
-
-    @strawberry.field
-    def metadata(self: providers.RateSheet) -> typing.Optional[utils.JSON]:
+    def metadata(self: providers.ServiceLevel) -> typing.Optional[utils.JSON]:
         try:
             return lib.to_dict(self.metadata)
         except:
             return self.metadata
 
+    @strawberry.field
+    def zone_ids(self: providers.ServiceLevel) -> typing.List[str]:
+        """List of zone IDs this service applies to (references RateSheet.zones)."""
+        return self.zone_ids or []
+
+    @strawberry.field
+    def surcharge_ids(self: providers.ServiceLevel) -> typing.List[str]:
+        """List of surcharge IDs to apply (references RateSheet.surcharges)."""
+        return self.surcharge_ids or []
+
 
 @strawberry.type
 class LabelTemplateType:
@@ -1256,6 +1342,37 @@ class RateSheetType:
     def services(self: providers.RateSheet) -> typing.List[ServiceLevelType]:
         return self.services.all()
 
+    # ─────────────────────────────────────────────────────────────────
+    # NEW: Shared zones at RateSheet level
+    # ─────────────────────────────────────────────────────────────────
+    @strawberry.field
+    def zones(self: providers.RateSheet) -> typing.Optional[typing.List[SharedZoneType]]:
+        """Shared zone definitions for this rate sheet."""
+        zones_data = self.zones or []
+        return [SharedZoneType.parse(zone) for zone in zones_data]
+
+    # ─────────────────────────────────────────────────────────────────
+    # NEW: Shared surcharges at RateSheet level
+    # ─────────────────────────────────────────────────────────────────
+    @strawberry.field
+    def surcharges(
+        self: providers.RateSheet,
+    ) -> typing.Optional[typing.List[SharedSurchargeType]]:
+        """Shared surcharge definitions for this rate sheet."""
+        surcharges_data = self.surcharges or []
+        return [SharedSurchargeType.parse(surcharge) for surcharge in surcharges_data]
+
+    # ─────────────────────────────────────────────────────────────────
+    # NEW: Service-zone rate mappings
+    # ─────────────────────────────────────────────────────────────────
+    @strawberry.field
+    def service_rates(
+        self: providers.RateSheet,
+    ) -> typing.Optional[typing.List[ServiceRateType]]:
+        """Service-zone rate mappings for this rate sheet."""
+        rates_data = self.service_rates or []
+        return [ServiceRateType.parse(rate) for rate in rates_data]
+
     @staticmethod
     @utils.authentication_required
     def resolve(info, id: str) -> typing.Optional["RateSheetType"]:

karrio/server/graph/serializers.py

@@ -244,6 +244,13 @@ def ensure_unique_default_related_data(
 
 @serializers.owned_model_serializer
 class ServiceLevelModelSerializer(serializers.ModelSerializer):
+    """
+    Serializer for ServiceLevel model.
+
+    Services reference shared zones and surcharges at the RateSheet level
+    via zone_ids and surcharge_ids.
+    """
+
     dimension_unit = serializers.CharField(
         required=False, allow_null=True, allow_blank=True
     )
@@ -257,46 +264,6 @@ class ServiceLevelModelSerializer(serializers.ModelSerializer):
         exclude = ["created_at", "updated_at", "created_by"]
         extra_kwargs = {field: {"read_only": True} for field in ["id"]}
 
-    def update_zone(self, zone_index: int, zone_data: dict) -> None:
-        """Update a specific zone in the service level."""
-        if zone_index >= len(self.instance.zones):
-            raise exceptions.ValidationError(
-                _(f"Zone index {zone_index} is out of range"),
-                code="invalid_zone_index",
-            )
-
-        self.instance.zones[zone_index].update(
-            {k: v for k, v in zone_data.items() if v != strawberry.UNSET}
-        )
-        self.instance.save(update_fields=["zones"])
-
-    def update(self, instance, validated_data, context=None, **kwargs):
-        """Handle partial updates of service level data including zones."""
-        zones_data = validated_data.pop("zones", None)
-        instance = super().update(instance, validated_data, context=context)
-
-        if zones_data is not None:
-            # Handle zone updates if provided
-            existing_zones = instance.zones or []
-            updated_zones = []
-
-            for idx, zone_data in enumerate(zones_data):
-                if idx < len(existing_zones):
-                    # Update existing zone
-                    zone = existing_zones[idx].copy()
-                    zone.update(
-                        {k: v for k, v in zone_data.items() if v != strawberry.UNSET}
-                    )
-                    updated_zones.append(zone)
-                else:
-                    # Add new zone
-                    updated_zones.append(zone_data)
-
-            instance.zones = updated_zones
-            instance.save(update_fields=["zones"])
-
-        return instance
-
 
 @serializers.owned_model_serializer
 class LabelTemplateModelSerializer(serializers.ModelSerializer):
@@ -367,14 +334,110 @@ class RateSheetModelSerializer(serializers.ModelSerializer):
                 carrier.rate_sheet = self.instance if carrier.id in carriers else None
                 carrier.save(update_fields=["rate_sheet"])
 
+    def process_zones(self, zones_data: list, remove_missing: bool = False) -> None:
+        """Process zones for the rate sheet.
+
+        Args:
+            zones_data: List of zone dicts with id, label, country_codes, etc.
+            remove_missing: If True, remove zones not present in zones_data.
+        """
+        existing_zone_ids = {z["id"] for z in (self.instance.zones or [])}
+        incoming_zone_ids = set()
+
+        for zone_data in zones_data:
+            zone_dict = {k: v for k, v in zone_data.items() if v is not None}
+            zone_id = zone_dict.get("id")
+
+            if zone_id:
+                incoming_zone_ids.add(zone_id)
+
+            if zone_id and zone_id in existing_zone_ids:
+                self.instance.update_zone(zone_id, zone_dict)
+            else:
+                self.instance.add_zone(zone_dict)
+
+        # Remove zones not in incoming data
+        if remove_missing:
+            zones_to_remove = existing_zone_ids - incoming_zone_ids
+            for zone_id in zones_to_remove:
+                self.instance.remove_zone(zone_id)
+
+    def process_surcharges(self, surcharges_data: list, remove_missing: bool = False) -> None:
+        """Process surcharges for the rate sheet.
+
+        Args:
+            surcharges_data: List of surcharge dicts with id, name, amount, etc.
+            remove_missing: If True, remove surcharges not present in surcharges_data.
+        """
+        existing_surcharge_ids = {s["id"] for s in (self.instance.surcharges or [])}
+        incoming_surcharge_ids = set()
+
+        for surcharge_data in surcharges_data:
+            surcharge_dict = {k: v for k, v in surcharge_data.items() if v is not None}
+            surcharge_id = surcharge_dict.get("id")
+
+            if surcharge_id:
+                incoming_surcharge_ids.add(surcharge_id)
+
+            if surcharge_id and surcharge_id in existing_surcharge_ids:
+                self.instance.update_surcharge(surcharge_id, surcharge_dict)
+            else:
+                self.instance.add_surcharge(surcharge_dict)
+
+        # Remove surcharges not in incoming data
+        if remove_missing:
+            surcharges_to_remove = existing_surcharge_ids - incoming_surcharge_ids
+            for surcharge_id in surcharges_to_remove:
+                self.instance.remove_surcharge(surcharge_id)
+
+    def process_service_rates(
+        self, service_rates_data: list, temp_to_real_id_map: dict = None
+    ) -> None:
+        """Process service rates for the rate sheet.
+
+        Args:
+            service_rates_data: List of service rate dicts with service_id, zone_id, rate, etc.
+            temp_to_real_id_map: Optional mapping of temp-{idx} IDs to real service IDs.
+        """
+        temp_to_real_id_map = temp_to_real_id_map or {}
+
+        for rate_data in service_rates_data:
+            rate_dict = {k: v for k, v in rate_data.items() if v is not None}
+            service_id = rate_dict.pop("service_id", None)
+            zone_id = rate_dict.pop("zone_id", None)
+
+            # Map temp service ID to real ID if needed
+            if service_id and str(service_id).startswith("temp-"):
+                service_id = temp_to_real_id_map.get(service_id, service_id)
+
+            if service_id and zone_id:
+                self.instance.update_service_rate(service_id, zone_id, rate_dict)
+
+    def build_temp_to_real_service_map(self, services_data: list) -> dict:
+        """Build mapping from temp-{idx} IDs to real service IDs by service_code."""
+        created_services = {s.service_code: s.id for s in self.instance.services.all()}
+
+        return {
+            f"temp-{idx}": created_services[svc.get("service_code")]
+            for idx, svc in enumerate(services_data)
+            if svc.get("service_code") in created_services
+        }
+
     def update(self, instance, validated_data, **kwargs):
-        """Handle updates of rate sheet data including services and carriers."""
+        """Handle updates of rate sheet data including services and carriers.
+
+        When zones or surcharges data is provided, it's treated as a full replacement -
+        zones/surcharges not in the incoming data will be removed.
+        """
         services_data = validated_data.pop("services", None)
         carriers = (
             validated_data.pop("carriers", None)
             if "carriers" in validated_data
             else None
         )
+        zones_data = validated_data.pop("zones", None)
+        surcharges_data = validated_data.pop("surcharges", None)
+        service_rates_data = validated_data.pop("service_rates", None)
         remove_missing_services = validated_data.pop("remove_missing_services", False)
 
         instance = super().update(instance, validated_data)
@@ -385,4 +448,15 @@ class RateSheetModelSerializer(serializers.ModelSerializer):
         if carriers is not None:
             self.update_carriers(carriers)
 
+        if zones_data:
+            # Full update: remove zones not present in incoming data
+            self.process_zones(zones_data, remove_missing=True)
+
+        if surcharges_data:
+            # Full update: remove surcharges not present in incoming data
+            self.process_surcharges(surcharges_data, remove_missing=True)
+
+        if service_rates_data:
+            self.process_service_rates(service_rates_data)
+
         return instance