printer-core 0.0.1__py3-none-any.whl

printer_core/entities/print_models.py

@@ -0,0 +1,230 @@
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class PrintChannel(str, Enum):
+    KIOSKO = "kiosko"
+    BARRA = "barra"
+    LOCAL = "local"
+    DOMICILE = "domicilio"
+    PICKUP = "recoger"
+
+
+class CompanyHeaderData(BaseModel):
+    company_name: str | None = None
+    company_reason: str | None = None
+    company_dni: str | None = None
+    company_phone: str | None = None
+    company_address: str | None = None
+
+
+class WorkerData(BaseModel):
+    first_name: str | None = None
+
+
+class DiscountData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    value: str | None = None
+    type: str | None = None
+    total: str | None = None
+
+
+class HeaderData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    company_name: str | None = None
+    company_reason: str | None = None
+    company_dni: str | None = None
+    company_phone: str | None = None
+    company_address: str | None = None
+    worker_name: str | None = None
+    client_name: str | None = None
+    client_phone: str | None = None
+    client_address: str | None = None
+
+
+class PrintSettingsData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    show_header: bool | None = None
+    show_total_price: bool | None = None
+    show_price_per_unit: bool | None = None
+    show_local_header: bool | None = None
+    details_font: dict[str, Any] | str | None = None
+
+
+class IvaData(BaseModel):
+    Base: str
+    impo: str
+    iva: str
+
+
+class FiskalyData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+
+class PrinterData(BaseModel):
+    name: str
+    printer_width: str
+    tpv: str | None = None
+
+
+class PrintProductData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    product_name: str
+    qty: int
+    option: Any = None
+    total_price: Any
+    product_price: Any
+    discount_type: str | None = None
+    discount: DiscountData | None = None
+    importe: Any | None = None
+    details: str | None = None
+    order: str | None = None
+    order_readable: str | None = None
+    printer: list[PrinterData] = Field(default_factory=list)
+    category: int | None = None
+
+
+class ClientTicketProduct(BaseModel):
+    name: str
+    qty: int
+    option: Any | None = None
+    price: str | None = None
+    unitary_price: str | None = None
+
+
+class KitchenProductLine(BaseModel):
+    name: str
+    qty: int
+    option: Any | None = None
+    printer_r: str
+    printer_w: str
+    details: str | None = None
+    order: str | None = None
+    tpv: str | None = None
+    order_readable: str | None = None
+    price: Any | None = None
+    unitary_price: Any | None = None
+
+
+class ProductsGroup(BaseModel):
+    group: str
+    products: list[KitchenProductLine]
+
+
+class PrinterProductGroup(BaseModel):
+    printer_name: str
+    tpv_key: str
+    printer_width: str
+    products: list[KitchenProductLine]
+
+
+class KitchenTicketData(BaseModel):
+    id: int | None = None
+    table_name: str | None = None
+    credit_card: bool
+    serial: str
+    details: str | None = None
+    type: str
+    discount: DiscountData | None = None
+    created_at: str | None = None
+    total: str | None = None
+    request_price: Any | None = None
+    command_guests: int | None = None
+    headerData: HeaderData | None = None
+    products: list[KitchenProductLine] | None = None
+    products_groups: list[ProductsGroup] | None = None
+
+
+class PrintRequestData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    id: int
+    type: str
+    serial: str
+    credit_card: bool
+    request_price: Any
+    details: str | None = None
+    from_client: str | None = None
+    client: int | None = None
+    address: int | None = None
+    shift_time: str | None = None
+    delivery_date: str | None = None
+    created_at: str | None = None
+    print_by: str | None = None
+    order_by: str | None = None
+    group_by_orders: bool | None = None
+    all_discounted: bool | None = None
+    discount: DiscountData | None = None
+    command_guests: int | None = None
+    table_name: str | None = None
+    qr: str | None = None
+    currency: str | None = None
+    total: str | None = None
+    ivaData: IvaData | None = None
+    PrintSettings: PrintSettingsData | None = None
+    headerData: HeaderData | None = None
+    is_invoice: bool | None = None
+    ticket_text: str | None = None
+    payed_with: str | None = None
+    fiskalyData: FiskalyData | None = None
+    price_domicile_service: Any | None = None
+
+
+class ClientTicketData(PrintRequestData):
+    products: list[ClientTicketProduct] | None = None
+
+
+class PrintJob(BaseModel):
+    request: PrintRequestData
+    products: list[PrintProductData]
+    tpv_key: str
+
+
+class ClientTicketPayload(BaseModel):
+    data: ClientTicketData
+    currency: str
+    model: int
+    company_key: str | None
+    printer: str
+    printer_qty: int
+    printer_width: Any
+
+
+class KitchenTicketPayload(BaseModel):
+    data: KitchenTicketData
+    currency: str
+    model: int
+    company_key: str | None = None
+    printer: str
+    printer_qty: int
+    printer_width: Any
+    PrintSettings: PrintSettingsData | None = None
+
+
+class MarchCommandData(BaseModel):
+    table_name: str | None = None
+    credit_card: bool | None = None
+    serial: str | None = None
+    type: str | None = None
+
+
+class FamilyData(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    id: int
+    name: str | None = None
+
+
+class PrintResult(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    multi_printer: list[KitchenTicketPayload] | bool | None = None
+    ticket_client: list[ClientTicketPayload] | None = None

printer_core/formatters/__init__.py

@@ -0,0 +1 @@
+from .discount_formatter import DiscountFormatter

printer_core/formatters/discount_formatter.py

@@ -0,0 +1,17 @@
+from decimal import Decimal
+from typing import Callable
+
+from printer_core.entities import PrintProductData
+
+class DiscountFormatter:
+    def __init__(self, currency_symbol_resolver: Callable[[str], str] | None = None):
+        self._currency_symbol_resolver = currency_symbol_resolver or (lambda _: "")
+
+    def format(self, product: PrintProductData, currency_code: str) -> str:
+        currency_symbol = self._currency_symbol_resolver(currency_code)
+        if product.discount_type == "number":
+            return f" (Dto {product.total_price}{currency_symbol})"
+        if product.discount_type == "percent" and product.discount:
+            total = Decimal(str(product.importe)) - Decimal(str(product.total_price))
+            return f" (Dto {product.discount.value}% {total}{currency_symbol})"
+        return ""

printer_core/ports.py

@@ -0,0 +1,45 @@
+from typing import Any, Protocol
+
+from printer_core.entities import FamilyData, HeaderData, PrintRequestData, PrintSettingsData
+
+
+class PrinterGateway(Protocol):
+    def send_data(self, tpv_key: str, data: Any) -> None:
+        ...
+
+
+class Clock(Protocol):
+    def now_iso(self) -> str:
+        ...
+
+
+class HeaderProvider(Protocol):
+    def build_header(self, request: PrintRequestData, worker: Any | None = None) -> HeaderData:
+        ...
+
+
+class HeaderDataProvider(Protocol):
+    def get_company_header(self) -> dict[str, str]:
+        ...
+
+    def get_worker_header(self, user: Any) -> dict[str, str]:
+        ...
+
+    def get_pickup_client_header(self, client_id: int | None, from_client: str | None) -> dict[str, str]:
+        ...
+
+    def get_domicile_client_header(self, address_id: int | None, from_client: str | None) -> dict[str, str]:
+        ...
+
+
+class PrintSettingsBuilder(Protocol):
+    def build(self, kitchen_ticket_settings: Any) -> PrintSettingsData:
+        ...
+
+
+class FamilyCategoryProvider(Protocol):
+    def get_families(self) -> list[FamilyData]:
+        ...
+
+    def get_family_by_category_ids(self, category_ids: list[int]) -> dict[int, FamilyData]:
+        ...

printer_core/selectors/__init__.py

@@ -0,0 +1 @@
+from .family_product_selector import FamilyProductSelector

printer_core/selectors/family_product_selector.py

@@ -0,0 +1,33 @@
+from collections import defaultdict
+
+from printer_core.entities import FamilyData, PrintProductData
+from printer_core.ports import FamilyCategoryProvider
+
+
+class FamilyProductSelector:
+    def __init__(self, provider: FamilyCategoryProvider):
+        self._provider = provider
+
+    def group_products(self, products: list[PrintProductData]) -> tuple[
+        list[FamilyData], dict[int, list[PrintProductData]], list[PrintProductData]
+    ]:
+        category_ids = [product.category for product in products if product.category]
+        category_ids = [category_id for category_id in category_ids if category_id]
+        families = self._provider.get_families()
+        family_by_category = self._provider.get_family_by_category_ids(category_ids)
+
+        products_by_family: dict[int, list[PrintProductData]] = defaultdict(list)
+        products_without_family: list[PrintProductData] = []
+
+        for product in products:
+            category_id = product.category
+            if not category_id or category_id not in family_by_category:
+                products_without_family.append(product)
+                continue
+            family = family_by_category.get(category_id)
+            if not family:
+                products_without_family.append(product)
+                continue
+            products_by_family[family.id].append(product)
+
+        return families, products_by_family, products_without_family

printer_core/services/__init__.py

@@ -0,0 +1,12 @@
+from printer_core.dispatchers.kitchen_ticket_dispatcher import KitchenTicketDispatcher
+from printer_core.context.ticket_context_builder import TicketContextBuilder
+from printer_core.selectors.family_product_selector import FamilyProductSelector
+from printer_core.builders.client_ticket_builder import ClientTicketBuilder
+from printer_core.dispatchers.payload_dispatcher import PayloadDispatcher
+from printer_core.services.flows import ClientPrintFlow, KitchenPrintFlow, PrintFlow
+from printer_core.services.print_policy import FlowTarget, PrintPlan, PrintPolicy
+from .march_printer_service import MarchPrinterService
+from .multi_printer_service import MultiPrinterService
+from .multi_printer_family_service import MultiPrinterFamilyService
+from .order_print_service import OrderPrintService
+from .unique_ticket_service import UniqueTicketService

printer_core/services/flows/__init__.py

@@ -0,0 +1,5 @@
+from printer_core.services.flows.base import PrintFlow
+from printer_core.services.flows.client import ClientPrintFlow
+from printer_core.services.flows.kitchen import KitchenPrintFlow
+
+__all__ = ["PrintFlow", "ClientPrintFlow", "KitchenPrintFlow"]

printer_core/services/flows/base.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from typing import Any, Protocol
+
+from printer_core.entities import (
+    ClientTicketPayload,
+    KitchenTicketPayload,
+    PrintChannel,
+    PrintProductData,
+    PrintRequestData,
+)
+from printer_core.services.print_policy import FlowTarget
+
+
+class PrintFlow(Protocol):
+    target: FlowTarget
+
+    def execute(
+        self,
+        base_request: PrintRequestData,
+        products: list[PrintProductData],
+        context: Any,
+        channel: PrintChannel,
+        tpv_key: str | None = None,
+    ) -> list[KitchenTicketPayload] | list[ClientTicketPayload]:
+        ...

printer_core/services/flows/client.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+from typing import Any, Callable
+
+from printer_core.builders.client_ticket_builder import ClientTicketBuilder
+from printer_core.context.ticket_context_builder import TicketContextBuilder
+from printer_core.entities import (
+    ClientTicketPayload,
+    PrintChannel,
+    PrintProductData,
+    PrintRequestData,
+    PrinterData,
+)
+from printer_core.ports import HeaderProvider, PrinterGateway, PrintSettingsBuilder
+from printer_core.services.print_policy import FlowTarget
+
+
+class ClientPrintFlow:
+    target = FlowTarget.CLIENT
+
+    def __init__(
+        self,
+        gateway: PrinterGateway,
+        header_provider: HeaderProvider,
+        print_settings_builder: PrintSettingsBuilder,
+        currency_symbol_resolver: Callable[[str], str],
+        domicile_service_label: str,
+    ):
+        self._gateway = gateway
+        self._currency_symbol_resolver = currency_symbol_resolver
+        self._domicile_service_label = domicile_service_label
+        self._context_builder = TicketContextBuilder(
+            header_provider=header_provider,
+            print_settings_builder=print_settings_builder,
+        )
+
+    def execute(
+        self,
+        base_request: PrintRequestData,
+        products: list[PrintProductData],
+        context: Any,
+        channel: PrintChannel,
+        tpv_key: str,
+    ) -> list[ClientTicketPayload]:
+        if not tpv_key:
+            raise ValueError("tpv_key is required for client printing")
+        client_request = self._context_builder.apply_client_context(
+            base_request,
+            context.kitchen_settings,
+            include_header=True,
+            details_font_none=True,
+            worker=context.worker,
+        )
+        client_request = self._apply_client_request_overrides(client_request, channel)
+        client_request = client_request.model_copy(update={"is_invoice": False})
+        data = self._build_client_ticket(
+            client_request,
+            products,
+            context.ticket_settings,
+            context.main_printer,
+            tpv_key,
+        )
+        payload = [item.model_dump(mode="json", exclude_none=True) for item in data]
+        self._gateway.send_data(tpv_key, payload)
+        return data
+
+    def _build_client_ticket(
+        self,
+        request: PrintRequestData,
+        products: list[PrintProductData],
+        ticket_settings: Any,
+        main_printer: PrinterData,
+        tpv_key: str,
+    ) -> list[ClientTicketPayload]:
+        ticket_builder = ClientTicketBuilder(
+            currency_symbol_resolver=self._currency_symbol_resolver,
+            domicile_service_label=self._domicile_service_label,
+        )
+        return ticket_builder.build(
+            request=request,
+            products=products,
+            printer=main_printer,
+            ticket_settings=ticket_settings,
+            tpv_key=tpv_key,
+        )
+
+    def _apply_client_request_overrides(
+        self,
+        request: PrintRequestData,
+        channel: PrintChannel,
+    ) -> PrintRequestData:
+        if channel != PrintChannel.LOCAL:
+            return request
+        print_settings = request.PrintSettings
+        if not print_settings:
+            return request
+        return request.model_copy(update={"PrintSettings": print_settings.model_copy(update={"show_header": False})})

printer_core/services/flows/kitchen.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+from typing import Any, Callable
+
+from printer_core.context.ticket_context_builder import TicketContextBuilder
+from printer_core.entities import (
+    KitchenProductLine,
+    KitchenTicketPayload,
+    PrintChannel,
+    PrintProductData,
+    PrintRequestData,
+    PrinterData,
+    ProductsGroup,
+)
+from printer_core.ports import FamilyCategoryProvider, HeaderProvider, PrinterGateway, PrintSettingsBuilder
+from printer_core.services.multi_printer_family_service import MultiPrinterFamilyService
+from printer_core.services.multi_printer_service import MultiPrinterService
+from printer_core.services.print_policy import FlowTarget
+
+
+class KitchenPrintFlow:
+    target = FlowTarget.KITCHEN
+
+    def __init__(
+        self,
+        gateway: PrinterGateway,
+        header_provider: HeaderProvider,
+        print_settings_builder: PrintSettingsBuilder,
+        family_provider: FamilyCategoryProvider,
+        currency_symbol_resolver: Callable[[str], str],
+    ):
+        self._gateway = gateway
+        self._family_provider = family_provider
+        self._currency_symbol_resolver = currency_symbol_resolver
+        self._context_builder = TicketContextBuilder(
+            header_provider=header_provider,
+            print_settings_builder=print_settings_builder,
+        )
+
+    def execute(
+        self,
+        base_request: PrintRequestData,
+        products: list[PrintProductData],
+        context: Any,
+        channel: PrintChannel,
+        tpv_key: str | None = None,
+    ) -> list[KitchenTicketPayload]:
+        kitchen_request = self._context_builder.apply_kitchen_context(
+            base_request,
+            context.ticket_settings,
+            context.kitchen_settings,
+            header_mode=self._header_mode(channel),
+            include_print_by=self._include_print_by(channel),
+            worker=context.worker,
+        )
+        return self._dispatch_kitchen(
+            request=kitchen_request,
+            products=products,
+            ticket_settings=context.ticket_settings,
+            kitchen_settings=context.kitchen_settings,
+            main_printer=context.main_printer,
+        )
+
+    def _dispatch_kitchen(
+        self,
+        request: PrintRequestData,
+        products: list[PrintProductData],
+        ticket_settings: Any,
+        kitchen_settings: Any,
+        main_printer: PrinterData,
+    ) -> list[KitchenTicketPayload]:
+        if getattr(kitchen_settings, "print_by", "categories") == "categories":
+            service = MultiPrinterService(
+                gateway=self._gateway,
+                currency_symbol_resolver=self._currency_symbol_resolver,
+                order_by_func=self._noop_order_by,
+                group_products_func=self._noop_group_products,
+            )
+            return service.build_and_dispatch(
+                request=request,
+                products=products,
+                main_printer=main_printer,
+                ticket_settings=ticket_settings,
+                kitchen_ticket_settings=kitchen_settings,
+            )
+        service = MultiPrinterFamilyService(
+            gateway=self._gateway,
+            family_provider=self._family_provider,
+            currency_symbol_resolver=self._currency_symbol_resolver,
+            order_by_func=self._noop_order_by,
+            group_products_func=self._noop_group_products,
+        )
+        return service.build_and_dispatch(
+            request=request,
+            products=products,
+            main_printer=main_printer,
+            ticket_settings=ticket_settings,
+            kitchen_ticket_settings=kitchen_settings,
+        )
+
+    def _header_mode(self, channel: PrintChannel) -> str:
+        if channel in (PrintChannel.DOMICILE, PrintChannel.PICKUP):
+            return "domicile"
+        return "local"
+
+    def _include_print_by(self, channel: PrintChannel) -> bool:
+        return channel not in (PrintChannel.BARRA, PrintChannel.KIOSKO)
+
+    def _noop_order_by(self, products: list[KitchenProductLine]) -> list[KitchenProductLine]:
+        return products
+
+    def _noop_group_products(self, products: list[KitchenProductLine]) -> list[ProductsGroup]:
+        return [ProductsGroup(group="Sin orden", products=products)]

printer_core/services/march_printer_service.py

@@ -0,0 +1,61 @@
+from printer_core.clock import SystemClock
+from printer_core.entities import KitchenProductLine, KitchenTicketData, KitchenTicketPayload, MarchCommandData, PrinterData, PrintSettingsData
+from printer_core.ports import Clock, PrinterGateway
+
+
+class MarchPrinterService:
+    def __init__(self, gateway: PrinterGateway, clock: Clock | None = None):
+        self._gateway = gateway
+        self._clock = clock or SystemClock()
+
+    def build_and_send(self,
+                       printers: list[PrinterData],
+                       command_data: MarchCommandData,
+                       order_type_text: str,
+                       tpv_key: str,
+                       currency: str,
+                       print_settings: PrintSettingsData,
+                       printer_qty: int = 1,
+                       ) -> list[KitchenTicketPayload]:
+        final_request: list[KitchenTicketPayload] = []
+        for printer in printers:
+            products = [KitchenProductLine(
+                name=str(order_type_text),
+                qty=0,
+                option=[],
+                price=0,
+                printer_r=str(printer.name),
+                printer_w=printer.printer_width,
+                details="",
+                order=None,
+                tpv=str(tpv_key),
+                order_readable=None,
+            )]
+            data = KitchenTicketData(
+                table_name=str(command_data.table_name or ""),
+                credit_card=bool(command_data.credit_card),
+                serial=str(command_data.serial or ""),
+                created_at=self._clock.now_iso(),
+                request_price="0",
+                type=str(command_data.type or ""),
+                total="0",
+                discount=None,
+                products=products,
+            )
+            payload = KitchenTicketPayload(
+                data=data,
+                model=1,
+                printer_qty=printer_qty,
+                printer=str(printer.name),
+                printer_width=printer.printer_width,
+                currency=currency,
+                PrintSettings=print_settings.model_copy(update={
+                    "show_header": True,
+                    "show_total_price": False,
+                    "show_price_per_unit": False,
+                }),
+            )
+
+            final_request.append(payload)
+            self._gateway.send_data(tpv_key, [payload.model_dump(mode="json", exclude_none=True)])
+        return final_request