@reservation-studio/electron-types 0.0.31 → 0.0.32

package/dist/interfaces/fiscal-device.interface.d.ts

@@ -1,469 +0,0 @@
-/**
- * Types for fiscal device communication between renderer and main process.
- */
-export type DeviceId = string;
-export type TransportType = 'serial' | 'tcp' | 'bluetooth-spp' | 'bluetooth-ble' | 'hid' | 'sdk';
-/**
- * Interface for operator information
- */
-export interface OperatorInfo {
-    /**
-     * The operator number
-     */
-    number: number;
-    /**
-     * A string representing the password for authentication or security purposes.
-     * This variable typically holds sensitive information and should be handled securely.
-     * Ensure this value is kept private and not exposed in any logs or outputs.
-     */
-    password: string;
-    /**
-     * Optional operator code. If not provided, driver may derive it from operator number.
-     */
-    code?: string;
-}
-export interface DeviceCapabilities {
-    supportedOperations: {
-        printFiscalReceipt: boolean;
-        printNonFiscalReceipt: boolean;
-        printReversalReceipt: boolean;
-        printXReport: boolean;
-        printZReport: boolean;
-        printDuplicate: boolean;
-        depositMoney: boolean;
-        withdrawMoney: boolean;
-        getCashAmount: boolean;
-        setDateTime: boolean;
-        getDateTime: boolean;
-        getLastFiscalRecord: boolean;
-        getStatus: boolean;
-        printBarcode: boolean;
-    };
-    supportsInvoices: boolean;
-    supportsRefunds: boolean;
-    supportsCreditNotes: boolean;
-    maxItemTextLength: number;
-    maxCommentTextLength: number;
-    maxOperatorPasswordLength: number;
-    vatGroups: FiscalVATGroup[];
-    paymentTypes: FiscalPaymentType[];
-}
-/**
- * Common payload fields shared by fiscal and non-fiscal receipts.
- */
-export interface BaseReceipt {
-    /**
-     * Operator information
-     */
-    operator: OperatorInfo;
-    /**
-     * The items in the receipt
-     */
-    items: FiscalReceiptItem[];
-    /**
-     * The client information (for invoice receipts)
-     */
-    client?: FiscalClient;
-    /**
-     * Optional text lines to be printed immediately after the receipt header.
-     */
-    headerText?: string[];
-    /**
-     * Optional text lines to be printed at the end of the receipt (before payments).
-     */
-    footerText?: string[];
-    /**
-     * Optional barcode to be printed at the end of the receipt (footer).
-     * Useful for loyalty programs, order tracking, or return vouchers.
-     */
-    footerBarcode?: BarcodeData;
-}
-/**
- * Interface for fiscal receipt
- */
-export interface FiscalReceipt extends BaseReceipt {
-    /**
-     * Numeric string up to 7 digits, used as part of the UNP.
-     */
-    uniqueSaleNumber: string;
-    /**
-     * The payments in the receipt. The total must cover the receipt amount to close.
-     */
-    payments: FiscalPayment[];
-}
-/**
- * Interface for non-fiscal (service) receipt
- */
-export interface NonFiscalReceipt extends BaseReceipt {
-    /**
-     * Optional informational payments printed on the receipt.
-     */
-    payments?: FiscalPayment[];
-}
-/**
- * Interface for fiscal receipt item
- */
-export interface FiscalReceiptItem {
-    /**
-     * The name of the item
-     */
-    name: string;
-    /**
-     * Optional description providing additional information or context.
-     * This can be used to supply user-friendly details or explanations
-     * associated with a particular resource, item, or operation.
-     */
-    description?: string;
-    /**
-     * The price of the item including tax (VAT inclusive).
-     * This price will be sent directly to the fiscal device and must include all applicable taxes.
-     */
-    unitPrice: number;
-    /**
-     * The quantity of the item
-     */
-    quantity: number;
-    /**
-     * The VAT group of the item
-     */
-    vatGroup: FiscalVATGroup;
-    /**
-     * Discount percentage (optional). Use 0-100, no surcharges.
-     */
-    discount?: number;
-}
-/**
- * Interface for fiscal payment
- */
-export interface FiscalPayment {
-    /**
-     * The payment type
-     */
-    type: FiscalPaymentType;
-    /**
-     * The amount of the payment
-     */
-    amount: number;
-}
-/**
- * Enum for fiscal payment types
- */
-export declare enum FiscalPaymentType {
-    CASH = "cash",
-    CARD = "card",
-    CHECK = "check",
-    TRANSFER = "transfer"
-}
-/**
- * Interface for fiscal client information
- */
-export interface FiscalClient {
-    /**
-     * The name of the client
-     */
-    name: string;
-    /**
-     * The address of the client
-     */
-    address?: string;
-    /**
-     * The tax number of the client
-     */
-    taxNumber?: string;
-    /**
-     * The VAT number of the client
-     */
-    vatNumber?: string;
-}
-/**
- * Interface for fiscal memory record
- */
-export interface FiscalMemoryRecord {
-    /**
-     * The number of the record
-     */
-    number: string;
-    /**
-     * The date of the record
-     */
-    date: Date;
-    /**
-     * The total amount of the record
-     */
-    total: number;
-}
-/**
- * Interface for fiscal device status
- */
-export interface FiscalDeviceStatus {
-    /**
-     * Whether the device is connected
-     */
-    connected?: boolean;
-    /**
-     * Whether the device has paper
-     */
-    hasPaper?: boolean;
-    /**
-     * Whether the fiscal memory is full
-     */
-    fiscalMemoryFull?: boolean;
-    /**
-     * Whether a fiscal receipt is currently open
-     */
-    fiscalReceiptOpen?: boolean;
-    /**
-     * Whether a non-fiscal receipt is currently open
-     */
-    nonFiscalReceiptOpen?: boolean;
-    /**
-     * Whether printing is allowed
-     */
-    printingAllowed?: boolean;
-    /**
-     * The messages returned by the fiscal device
-     */
-    messages: FiscalResponseMessage[];
-    /**
-     * Raw status bytes, if available
-     */
-    rawStatusBytes?: number[];
-}
-/**
- * Interface for fiscal device information in list responses
- */
-export interface FiscalDeviceResponse {
-    /**
-     * Device identifier (stable for the device model/serial)
-     */
-    deviceId: DeviceId;
-    /**
-     * The manufacturer of the fiscal device
-     */
-    manufacturer: string;
-    /**
-     * The model name of the fiscal device
-     */
-    model: string;
-    /**
-     * The serial number of the fiscal device
-     */
-    serialNumber: string;
-    /**
-     * Transport type used to access the device
-     */
-    transport?: TransportType;
-    /**
-     * Device capabilities
-     */
-    capabilities?: DeviceCapabilities;
-}
-export type FiscalDeviceDiagnosticStepName = 'deviceInfo' | 'status' | 'lastFiscalRecord' | 'cashAmount' | 'nonFiscalReceipt';
-export interface FiscalDeviceDiagnosticStepBase {
-    name: FiscalDeviceDiagnosticStepName;
-    ok: boolean;
-    startedAt: string;
-    finishedAt: string;
-    skipped?: boolean;
-    skipReason?: string;
-    error?: string;
-}
-export interface FiscalDeviceDiagnosticStepDeviceInfo extends FiscalDeviceDiagnosticStepBase {
-    name: 'deviceInfo';
-    data?: DeviceInfo;
-}
-export interface FiscalDeviceDiagnosticStepStatus extends FiscalDeviceDiagnosticStepBase {
-    name: 'status';
-    data?: FiscalDeviceStatus;
-}
-export interface FiscalDeviceDiagnosticStepLastFiscalRecord extends FiscalDeviceDiagnosticStepBase {
-    name: 'lastFiscalRecord';
-    data?: FiscalMemoryRecord;
-}
-export interface FiscalDeviceDiagnosticStepCashAmount extends FiscalDeviceDiagnosticStepBase {
-    name: 'cashAmount';
-    data?: number;
-}
-export interface FiscalDeviceDiagnosticStepNonFiscalReceipt extends FiscalDeviceDiagnosticStepBase {
-    name: 'nonFiscalReceipt';
-    data?: FiscalResponse;
-}
-export type FiscalDeviceDiagnosticStep = FiscalDeviceDiagnosticStepDeviceInfo | FiscalDeviceDiagnosticStepStatus | FiscalDeviceDiagnosticStepLastFiscalRecord | FiscalDeviceDiagnosticStepCashAmount | FiscalDeviceDiagnosticStepNonFiscalReceipt;
-export interface FiscalDeviceDiagnosticsOptions {
-    operator: OperatorInfo;
-    amount?: number;
-    vatGroup?: FiscalVATGroup;
-    itemName?: string;
-}
-export interface FiscalDeviceDiagnosticsResult {
-    deviceId: DeviceId;
-    ok: boolean;
-    startedAt: string;
-    finishedAt: string;
-    steps: FiscalDeviceDiagnosticStep[];
-}
-/**
- * Interface for detailed device information
- */
-export interface DeviceInfo {
-    /**
-     * Device identifier (stable for the device model/serial)
-     */
-    deviceId: DeviceId;
-    /**
-     * The serial number of the fiscal device
-     */
-    serialNumber: string;
-    /**
-     * The fiscal memory serial number
-     */
-    fiscalMemorySerialNumber: string;
-    /**
-     * The manufacturer of the fiscal device
-     */
-    manufacturer: string;
-    /**
-     * The model name of the fiscal device
-     */
-    model: string;
-    /**
-     * Driver identifier
-     */
-    driverId?: string;
-    /**
-     * Transport type
-     */
-    transport?: TransportType;
-    /**
-     * The firmware version of the fiscal device
-     */
-    firmwareVersion: string;
-    /**
-     * The current date and time of the fiscal device
-     */
-    currentDateTime?: string;
-    /**
-     * The maximum length of item text
-     */
-    itemTextMaxLength: number;
-    /**
-     * The maximum length of comment text
-     */
-    commentTextMaxLength: number;
-    /**
-     * The maximum length of operator password
-     */
-    operatorPasswordMaxLength: number;
-    /**
-     * The supported payment types
-     */
-    supportedPaymentTypes: FiscalPaymentType[];
-}
-/**
- * Interface for fiscal response
- */
-export interface FiscalResponse {
-    /**
-     * The receipt number (if applicable)
-     */
-    number?: string;
-    /**
-     * Represents a unique identifier for a receipt generated for a particular sale.
-     * This variable is used to ensure that each sale has a distinct and traceable number.
-     * It may be undefined if no sale has been processed or the number has not been generated yet.
-     */
-    generatedUniqueSaleNumber?: string;
-    /**
-     * The receipt date and time (if applicable)
-     */
-    datetime?: string;
-    /**
-     * The receipt amount (if applicable)
-     */
-    amount?: number;
-    /**
-     * Represents an optional piece of information regarding a device.
-     * This variable can store details such as the device's specifications,
-     * status, or metadata, depending on the structure of the `DeviceInfo` type.
-     *
-     * The value of `deviceInfo` may be undefined if no device information is available.
-     *
-     * @type {DeviceInfo | undefined}
-     */
-    deviceInfo?: DeviceInfo;
-    /**
-     * The messages returned by the fiscal device
-     */
-    messages: FiscalResponseMessage[];
-}
-/**
- * Interface for fiscal response message
- */
-export interface FiscalResponseMessage {
-    /**
-     * The type of the message
-     */
-    type: 'info' | 'warning' | 'error';
-    /**
-     * The code of the message (if applicable)
-     */
-    code?: string;
-    /**
-     * The text of the message
-     */
-    text: string;
-}
-/**
- * Interface for reversal receipt
- */
-export interface ReversalReceipt extends FiscalReceipt {
-    /**
-     * The reason for the reversal
-     */
-    reason: ReversalReason;
-    /**
-     * The original receipt number
-     */
-    originalReceiptNumber: string;
-    /**
-     * The original receipt date and time
-     */
-    originalReceiptDateTime: Date;
-    /**
-     * The original fiscal memory serial number
-     */
-    originalFiscalMemorySerialNumber: string;
-}
-/**
- * Enum for reversal reasons
- */
-export declare enum ReversalReason {
-    VOID = "void",
-    REFUND = "refund",
-    TAX_BASE_REDUCTION = "tax-base-reduction"
-}
-/**
- * Enum for fiscal VAT groups
- */
-export declare enum FiscalVATGroup {
-    A = "1",// 20%
-    B = "2",// 9%
-    C = "3",// 0%
-    D = "4",// Exempt
-    E = "5",// Special rate 1
-    F = "6",// Special rate 2
-    G = "7",// Special rate 3
-    H = "8"
-}
-export declare enum BarcodeType {
-    EAN8 = "EAN8",
-    EAN13 = "EAN13",
-    CODE128 = "CODE128",
-    QR = "QR"
-}
-export interface BarcodeData {
-    type: BarcodeType;
-    data: string;
-    height?: number;
-    printText?: boolean;
-}