@reservation-studio/electron-types 0.0.29 → 0.0.31

package/README.md

@@ -112,13 +112,12 @@ const response = await ReservationStudioElectron.fiscalDevices.printReceipt(
         name: 'Product 1',
         unitPrice: 10.0,
         quantity: 1,
-        vatGroup: '1',
-        currency: 'BGN'
+        vatGroup: FiscalVATGroup.A
       }
     ],
     payments: [
       {
-        type: 'cash',
+        type: FiscalPaymentType.CASH,
         amount: 10.0
       }
     ]
@@ -133,20 +132,12 @@ await ReservationStudioElectron.fiscalDevices.printNonFiscalReceipt(
       number: 1,
       password: '1'
     },
-    uniqueSaleNumber: '1',
     items: [
       {
         name: 'Service',
         unitPrice: 5.0,
         quantity: 1,
-        vatGroup: '1',
-        currency: 'BGN'
-      }
-    ],
-    payments: [
-      {
-        type: 'cash',
-        amount: 5.0
+        vatGroup: FiscalVATGroup.A
       }
     ]
   },
@@ -160,6 +151,76 @@ const lastRecord =
 // Get the fiscal device status
 const status =
   await ReservationStudioElectron.fiscalDevices.getStatus(deviceId);
+
+// Print X report (daily report without reset)
+await ReservationStudioElectron.fiscalDevices.printXReport(deviceId);
+
+// Print Z report (daily report with reset)
+await ReservationStudioElectron.fiscalDevices.printZReport(deviceId);
+
+// Print duplicate of last receipt
+await ReservationStudioElectron.fiscalDevices.printDuplicate(deviceId);
+
+// Deposit money to cash register
+await ReservationStudioElectron.fiscalDevices.depositMoney(100, deviceId);
+
+// Withdraw money from cash register
+await ReservationStudioElectron.fiscalDevices.withdrawMoney(50, deviceId);
+
+// Get current cash amount in register
+const cashAmount =
+  await ReservationStudioElectron.fiscalDevices.getCashAmount(deviceId);
+
+// Set date and time on fiscal device
+await ReservationStudioElectron.fiscalDevices.setDateTime(new Date(), deviceId);
+
+// Get date and time from fiscal device
+const deviceDateTime =
+  await ReservationStudioElectron.fiscalDevices.getDateTime(deviceId);
+
+// Run diagnostics test
+const diagnosticsResult =
+  await ReservationStudioElectron.fiscalDevices.runDiagnostics(deviceId, {
+    operator: {
+      number: 1,
+      password: '0000',
+      code: 'OP01' // optional
+    },
+    amount: 1,
+    vatGroup: FiscalVATGroup.A,
+    itemName: 'Diagnostic item'
+  });
+
+// Print reversal receipt
+const reversalResponse =
+  await ReservationStudioElectron.fiscalDevices.printReversalReceipt(
+    {
+      operator: {
+        number: 1,
+        password: '0000'
+      },
+      uniqueSaleNumber: '1',
+      reason: 'refund', // or 'void', 'tax-base-reduction'
+      originalReceiptNumber: '12345',
+      originalReceiptDateTime: new Date('2023-01-01T10:00:00'),
+      originalFiscalMemorySerialNumber: 'FM12345678',
+      items: [
+        {
+          name: 'Returned Item',
+          unitPrice: 10.0,
+          quantity: 1,
+          vatGroup: FiscalVATGroup.A
+        }
+      ],
+      payments: [
+        {
+          type: FiscalPaymentType.CASH,
+          amount: 10.0
+        }
+      ]
+    },
+    deviceId
+  );
 ```
 
 ## Interfaces
@@ -199,21 +260,39 @@ interface HttpOptions {
 }
 ```
 
-### FiscalReceipt
+### OperatorInfo
 
 ```typescript
+interface OperatorInfo {
+  number: number;
+  password: string;
+  code?: string;
+}
+```
+
+### FiscalReceipt
+
+````typescript
 interface FiscalReceipt {
-  operator: {
-    number: number;
-    password: string;
-    code?: string;
-  };
-  uniqueSaleNumber: string;
+  operator: OperatorInfo;
+  uniqueSaleNumber: string; // numeric string up to 7 digits
   items: FiscalReceiptItem[];
   payments: FiscalPayment[];
   client?: FiscalClient;
 }
-```
+
+### NonFiscalReceipt
+
+```typescript
+interface NonFiscalReceipt {
+  operator: OperatorInfo;
+  items: FiscalReceiptItem[];
+  payments?: FiscalPayment[];
+  client?: FiscalClient;
+}
+````
+
+````
 
 ### FiscalReceiptItem
 
@@ -221,12 +300,11 @@ interface FiscalReceipt {
 interface FiscalReceiptItem {
   name: string;
   unitPrice: number;
-  currency: string;
   quantity: number;
-  vatGroup: string;
+  vatGroup: FiscalVATGroup;
   discount?: number;
 }
-```
+````
 
 ### FiscalPayment
 
@@ -248,6 +326,21 @@ enum FiscalPaymentType {
 }
 ```
 
+### FiscalVATGroup
+
+```typescript
+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' // Special rate 4
+}
+```
+
 ### FiscalClient
 
 ```typescript
@@ -273,11 +366,55 @@ interface FiscalMemoryRecord {
 
 ```typescript
 interface FiscalDeviceStatus {
-  connected: boolean;
-  hasPaper: boolean;
-  fiscalMemoryFull: boolean;
-  errorCode?: number;
-  errorMessage?: string;
+  connected?: boolean;
+  hasPaper?: boolean;
+  fiscalMemoryFull?: boolean;
+  fiscalReceiptOpen?: boolean;
+  nonFiscalReceiptOpen?: boolean;
+  printingAllowed?: boolean;
+  messages: FiscalResponseMessage[];
+}
+```
+
+### FiscalResponseMessage
+
+```typescript
+interface FiscalResponseMessage {
+  type: 'info' | 'warning' | 'error';
+  code?: string;
+  text: string;
+}
+```
+
+### ReversalReceipt
+
+```typescript
+interface ReversalReceipt extends FiscalReceipt {
+  reason: ReversalReason;
+  originalReceiptNumber: string;
+  originalReceiptDateTime: Date;
+  originalFiscalMemorySerialNumber: string;
+}
+```
+
+### FiscalDeviceDiagnosticsOptions
+
+```typescript
+interface FiscalDeviceDiagnosticsOptions {
+  operator: OperatorInfo;
+  amount?: number;
+  vatGroup?: FiscalVATGroup;
+  itemName?: string;
+}
+```
+
+### ReversalReason
+
+```typescript
+enum ReversalReason {
+  VOID = 'void',
+  REFUND = 'refund',
+  TAX_BASE_REDUCTION = 'tax-base-reduction'
 }
 ```
 

package/dist/interfaces/api.interface.d.ts

@@ -1,7 +1,7 @@
 import { CertificateInfo } from './certificate-info.interface';
 import { HttpOptions, HttpResponse } from './http.interface';
 import { EnvironmentEnum } from '../enums/envirovment.enum';
-import { DeviceInfo, FiscalDeviceDiagnosticsOptions, FiscalDeviceDiagnosticsResult, FiscalDeviceResponse, FiscalDeviceStatus, FiscalMemoryRecord, FiscalReceipt, FiscalResponse, ReversalReceipt } from './fiscal-device.interface';
+import { DeviceInfo, FiscalDeviceDiagnosticsOptions, FiscalDeviceDiagnosticsResult, FiscalDeviceResponse, FiscalDeviceStatus, FiscalMemoryRecord, FiscalReceipt, FiscalResponse, NonFiscalReceipt, ReversalReceipt } from './fiscal-device.interface';
 export interface ApiInterface {
     /**
      * An object representing operations related to certificates.
@@ -116,12 +116,12 @@ export interface ApiInterface {
         /**
          * Prints a non-fiscal receipt using a fiscal device.
          *
-         * @param {FiscalReceipt} receipt - The receipt object containing details to be printed as a non-fiscal receipt.
+         * @param {NonFiscalReceipt} receipt - The receipt object containing details to be printed as a non-fiscal receipt.
          * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<FiscalResponse>} A promise that resolves to a FiscalResponse object indicating the result of the operation.
          * @throws {Error} If the device with the specified deviceId is not found.
          */
-        printNonFiscalReceipt(receipt: FiscalReceipt, deviceId: string): Promise<FiscalResponse>;
+        printNonFiscalReceipt(receipt: NonFiscalReceipt, deviceId: string): Promise<FiscalResponse>;
         /**
          * Prints a reversal receipt using a fiscal device.
          *

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

@@ -3,6 +3,25 @@
  */
 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;
@@ -18,6 +37,7 @@ export interface DeviceCapabilities {
         getDateTime: boolean;
         getLastFiscalRecord: boolean;
         getStatus: boolean;
+        printBarcode: boolean;
     };
     supportsInvoices: boolean;
     supportsRefunds: boolean;
@@ -29,45 +49,56 @@ export interface DeviceCapabilities {
     paymentTypes: FiscalPaymentType[];
 }
 /**
- * Interface for fiscal receipt
+ * Common payload fields shared by fiscal and non-fiscal receipts.
  */
-export interface FiscalReceipt {
-    /**
-     * An object representing various operator-related properties.
-     */
-    operator: {
-        /**
-         * Represents a numerical value.
-         * This variable can store any valid number, including integers and floating-point values.
-         */
-        number: number;
-        /**
-         * Optional operator code. If not provided, driver may derive it from operator number.
-         */
-        code?: string;
-        /**
-         * 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;
-    };
+export interface BaseReceipt {
     /**
-     * The unique sale number
+     * Operator information
      */
-    uniqueSaleNumber: string;
+    operator: OperatorInfo;
     /**
      * The items in the receipt
      */
     items: FiscalReceiptItem[];
     /**
-     * The payments in the receipt
+     * 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 {
     /**
-     * The client information (for invoice receipts)
+     * Optional informational payments printed on the receipt.
      */
-    client?: FiscalClient;
+    payments?: FiscalPayment[];
 }
 /**
  * Interface for fiscal receipt item
@@ -84,14 +115,10 @@ export interface FiscalReceiptItem {
      */
     description?: string;
     /**
-     * The price of the item
+     * 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;
-    /**
-     * Represents the currency code in ISO 4217 format (e.g., 'USD', 'EUR', 'JPY').
-     * Typically used to indicate the currency of a monetary value.
-     */
-    currency: string;
     /**
      * The quantity of the item
      */
@@ -101,7 +128,7 @@ export interface FiscalReceiptItem {
      */
     vatGroup: FiscalVATGroup;
     /**
-     * The discount percentage (optional)
+     * Discount percentage (optional). Use 0-100, no surcharges.
      */
     discount?: number;
 }
@@ -169,10 +196,6 @@ export interface FiscalMemoryRecord {
  * Interface for fiscal device status
  */
 export interface FiscalDeviceStatus {
-    /**
-     * Whether the operation was successful
-     */
-    ok: boolean;
     /**
      * Whether the device is connected
      */
@@ -197,14 +220,6 @@ export interface FiscalDeviceStatus {
      * Whether printing is allowed
      */
     printingAllowed?: boolean;
-    /**
-     * The error code if any
-     */
-    errorCode?: number;
-    /**
-     * The error message if any
-     */
-    errorMessage?: string;
     /**
      * The messages returned by the fiscal device
      */
@@ -275,10 +290,8 @@ export interface FiscalDeviceDiagnosticStepNonFiscalReceipt extends FiscalDevice
 }
 export type FiscalDeviceDiagnosticStep = FiscalDeviceDiagnosticStepDeviceInfo | FiscalDeviceDiagnosticStepStatus | FiscalDeviceDiagnosticStepLastFiscalRecord | FiscalDeviceDiagnosticStepCashAmount | FiscalDeviceDiagnosticStepNonFiscalReceipt;
 export interface FiscalDeviceDiagnosticsOptions {
-    operatorNumber: number;
-    operatorPassword: string;
+    operator: OperatorInfo;
     amount?: number;
-    currency?: string;
     vatGroup?: FiscalVATGroup;
     itemName?: string;
 }
@@ -344,16 +357,12 @@ export interface DeviceInfo {
     /**
      * The supported payment types
      */
-    supportedPaymentTypes: string[];
+    supportedPaymentTypes: FiscalPaymentType[];
 }
 /**
  * Interface for fiscal response
  */
 export interface FiscalResponse {
-    /**
-     * Whether the operation was successful
-     */
-    ok: boolean;
     /**
      * The receipt number (if applicable)
      */
@@ -429,7 +438,7 @@ export interface ReversalReceipt extends FiscalReceipt {
  * Enum for reversal reasons
  */
 export declare enum ReversalReason {
-    OPERATOR_ERROR = "operator-error",
+    VOID = "void",
     REFUND = "refund",
     TAX_BASE_REDUCTION = "tax-base-reduction"
 }
@@ -446,3 +455,15 @@ export declare enum FiscalVATGroup {
     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;
+}

package/dist/interfaces/fiscal-device.interface.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FiscalVATGroup = exports.ReversalReason = exports.FiscalPaymentType = void 0;
+exports.BarcodeType = exports.FiscalVATGroup = exports.ReversalReason = exports.FiscalPaymentType = void 0;
 /**
  * Enum for fiscal payment types
  */
@@ -16,7 +16,7 @@ var FiscalPaymentType;
  */
 var ReversalReason;
 (function (ReversalReason) {
-    ReversalReason["OPERATOR_ERROR"] = "operator-error";
+    ReversalReason["VOID"] = "void";
     ReversalReason["REFUND"] = "refund";
     ReversalReason["TAX_BASE_REDUCTION"] = "tax-base-reduction";
 })(ReversalReason || (exports.ReversalReason = ReversalReason = {}));
@@ -34,3 +34,10 @@ var FiscalVATGroup;
     FiscalVATGroup["G"] = "7";
     FiscalVATGroup["H"] = "8"; // Special rate 4
 })(FiscalVATGroup || (exports.FiscalVATGroup = FiscalVATGroup = {}));
+var BarcodeType;
+(function (BarcodeType) {
+    BarcodeType["EAN8"] = "EAN8";
+    BarcodeType["EAN13"] = "EAN13";
+    BarcodeType["CODE128"] = "CODE128";
+    BarcodeType["QR"] = "QR";
+})(BarcodeType || (exports.BarcodeType = BarcodeType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservation-studio/electron-types",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "description": "TypeScript типове за ReservationStudioElectron",
   "scripts": {
     "build": "tsc --project tsconfig.json",