@reservation-studio/electron-types 0.0.19 → 0.0.28

package/README.md

@@ -96,24 +96,24 @@ Methods for working with fiscal devices:
 // List all available fiscal devices
 const devices = await ReservationStudioElectron.fiscalDevices.list();
 
-// Set the active fiscal device
-await ReservationStudioElectron.fiscalDevices.setActiveDevice(serialNumber);
-
-// Get the active fiscal device
-const activeDevice =
-  await ReservationStudioElectron.fiscalDevices.getActiveDevice();
+// Select a deviceId for each call
+const deviceId = devices[0].deviceId;
 
 // Print a fiscal receipt
-const receiptNumber =
-  await ReservationStudioElectron.fiscalDevices.printReceipt({
-    operatorNumber: 1,
-    operatorPassword: '1',
+const response = await ReservationStudioElectron.fiscalDevices.printReceipt(
+  {
+    operator: {
+      number: 1,
+      password: '1'
+    },
+    uniqueSaleNumber: '1',
     items: [
       {
         name: 'Product 1',
-        price: 10.0,
+        unitPrice: 10.0,
         quantity: 1,
-        vatGroup: 'A'
+        vatGroup: '1',
+        currency: 'BGN'
       }
     ],
     payments: [
@@ -122,17 +122,44 @@ const receiptNumber =
         amount: 10.0
       }
     ]
-  });
+  },
+  deviceId
+);
 
-// Print non-fiscal text
-await ReservationStudioElectron.fiscalDevices.printText('Hello, World!');
+// Print non-fiscal receipt
+await ReservationStudioElectron.fiscalDevices.printNonFiscalReceipt(
+  {
+    operator: {
+      number: 1,
+      password: '1'
+    },
+    uniqueSaleNumber: '1',
+    items: [
+      {
+        name: 'Service',
+        unitPrice: 5.0,
+        quantity: 1,
+        vatGroup: '1',
+        currency: 'BGN'
+      }
+    ],
+    payments: [
+      {
+        type: 'cash',
+        amount: 5.0
+      }
+    ]
+  },
+  deviceId
+);
 
 // Get the last fiscal memory record
 const lastRecord =
-  await ReservationStudioElectron.fiscalDevices.getLastFiscalRecord();
+  await ReservationStudioElectron.fiscalDevices.getLastFiscalRecord(deviceId);
 
 // Get the fiscal device status
-const status = await ReservationStudioElectron.fiscalDevices.getStatus();
+const status =
+  await ReservationStudioElectron.fiscalDevices.getStatus(deviceId);
 ```
 
 ## Interfaces
@@ -176,8 +203,11 @@ interface HttpOptions {
 
 ```typescript
 interface FiscalReceipt {
-  operatorNumber: number;
-  operatorPassword: string;
+  operator: {
+    number: number;
+    password: string;
+    code?: string;
+  };
   uniqueSaleNumber?: string;
   items: FiscalReceiptItem[];
   payments: FiscalPayment[];
@@ -190,7 +220,8 @@ interface FiscalReceipt {
 ```typescript
 interface FiscalReceiptItem {
   name: string;
-  price: number;
+  unitPrice: number;
+  currency: string;
   quantity: number;
   vatGroup: string;
   discount?: number;

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, FiscalDeviceResponse, FiscalDeviceStatus, FiscalMemoryRecord, FiscalReceipt, FiscalResponse, ReversalReceipt } from './fiscal-device.interface';
+import { DeviceInfo, FiscalDeviceDiagnosticsOptions, FiscalDeviceDiagnosticsResult, FiscalDeviceResponse, FiscalDeviceStatus, FiscalMemoryRecord, FiscalReceipt, FiscalResponse, ReversalReceipt } from './fiscal-device.interface';
 export interface ApiInterface {
     /**
      * An object representing operations related to certificates.
@@ -91,129 +91,128 @@ export interface ApiInterface {
          */
         list(): Promise<FiscalDeviceResponse[]>;
         /**
-         * Sets the active fiscal device.
+         * Scans for fiscal devices and refreshes the device list.
          *
-         * @param {string} serialNumber - The serial number of the device to set as active.
-         * @return {Promise<void>} A promise that resolves when the device is successfully set as active.
-         * @throws {Error} If the device with the specified serial number is not found.
+         * @return {Promise<FiscalDeviceResponse[]>} A promise that resolves to an updated device list.
          */
-        setActiveDevice(serialNumber: string): Promise<void>;
-        /**
-         * Gets the active fiscal device.
-         *
-         * @return {Promise<FiscalDeviceResponse>} A promise that resolves to the active fiscal device information.
-         * @throws {Error} If no active device is set.
-         */
-        getActiveDevice(): Promise<FiscalDeviceResponse>;
+        scan(): Promise<FiscalDeviceResponse[]>;
         /**
          * Gets detailed information about a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to get information for. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<DeviceInfo>} A promise that resolves to the detailed device information.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        getDeviceInfo(serial?: string): Promise<DeviceInfo>;
+        getDeviceInfo(deviceId: string): Promise<DeviceInfo>;
         /**
          * Prints a fiscal receipt using a fiscal device.
          *
          * @param {FiscalReceipt} receipt - The receipt to print.
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<FiscalResponse>} A promise that resolves to the fiscal response.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        printReceipt(receipt: FiscalReceipt, serial?: string): Promise<FiscalResponse>;
+        printReceipt(receipt: FiscalReceipt, deviceId: string): Promise<FiscalResponse>;
         /**
          * 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 {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @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 no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        printNonFiscalReceipt(receipt: FiscalReceipt, serial?: string): Promise<FiscalResponse>;
+        printNonFiscalReceipt(receipt: FiscalReceipt, deviceId: string): Promise<FiscalResponse>;
         /**
          * Prints a reversal receipt using a fiscal device.
          *
          * @param {ReversalReceipt} receipt - The reversal receipt to print.
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<FiscalResponse>} A promise that resolves to the fiscal response.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        printReversalReceipt(receipt: ReversalReceipt, serial?: string): Promise<FiscalResponse>;
+        printReversalReceipt(receipt: ReversalReceipt, deviceId: string): Promise<FiscalResponse>;
         /**
          * Gets the last fiscal memory record from a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<FiscalMemoryRecord>} A promise that resolves to the last fiscal memory record.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        getLastFiscalRecord(serial?: string): Promise<FiscalMemoryRecord>;
+        getLastFiscalRecord(deviceId: string): Promise<FiscalMemoryRecord>;
         /**
          * Gets the status of a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to get status for. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<FiscalDeviceStatus>} A promise that resolves to the status of the device.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        getStatus(serial?: string): Promise<FiscalDeviceStatus>;
+        getStatus(deviceId: string): Promise<FiscalDeviceStatus>;
         /**
          * Prints an X report (daily financial report without reset) using a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<boolean>} A promise that resolves to true if printing was successful.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        printXReport(serial?: string): Promise<boolean>;
+        printXReport(deviceId: string): Promise<boolean>;
         /**
          * Prints a Z report (daily financial report with reset) using a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<boolean>} A promise that resolves to true if printing was successful.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        printZReport(serial?: string): Promise<boolean>;
+        printZReport(deviceId: string): Promise<boolean>;
         /**
          * Deposits money into the cash register using a fiscal device.
          *
          * @param {number} amount - The amount to deposit.
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<boolean>} A promise that resolves to true if the deposit was successful.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        depositMoney(amount: number, serial?: string): Promise<boolean>;
+        depositMoney(amount: number, deviceId: string): Promise<boolean>;
         /**
          * Withdraws money from the cash register using a fiscal device.
          *
          * @param {number} amount - The amount to withdraw.
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<boolean>} A promise that resolves to true if the withdrawal was successful.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        withdrawMoney(amount: number, serial?: string): Promise<boolean>;
+        withdrawMoney(amount: number, deviceId: string): Promise<boolean>;
         /**
          * Gets the current cash amount in the register using a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<number>} A promise that resolves to the current cash amount.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        getCashAmount(serial?: string): Promise<number>;
+        getCashAmount(deviceId: string): Promise<number>;
         /**
          * Sets the date and time on a fiscal device.
          *
          * @param {Date} dateTime - The date and time to set.
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<boolean>} A promise that resolves to true if setting was successful.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
          */
-        setDateTime(dateTime: Date, serial?: string): Promise<boolean>;
+        setDateTime(dateTime: Date, deviceId: string): Promise<boolean>;
         /**
          * Prints a duplicate of the last receipt using a fiscal device.
          *
-         * @param {string} [serial] - Optional serial number of the device to use. If not provided, uses the active device.
+         * @param {string} deviceId - Device identifier from list/scan.
          * @return {Promise<boolean>} A promise that resolves to true if printing was successful.
-         * @throws {Error} If no active device is set and no serial is provided, or if the device with the specified serial is not found.
+         * @throws {Error} If the device with the specified deviceId is not found.
+         */
+        printDuplicate(deviceId: string): Promise<boolean>;
+        /**
+         * Runs a device diagnostics sequence to verify core functionality.
+         *
+         * @param {string} deviceId - Device identifier from list/scan.
+         * @param {FiscalDeviceDiagnosticsOptions} options - Operator credentials and receipt parameters.
+         * @return {Promise<FiscalDeviceDiagnosticsResult>} A promise that resolves to the diagnostics report.
          */
-        printDuplicate(serial?: string): Promise<boolean>;
+        runDiagnostics(deviceId: string, options: FiscalDeviceDiagnosticsOptions): Promise<FiscalDeviceDiagnosticsResult>;
     };
 }

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

@@ -1,125 +1,31 @@
 /**
- * Interface for fiscal device operations
+ * Types for fiscal device communication between renderer and main process.
  */
-export interface FiscalDeviceInterface {
-    /**
-     * The model name of the fiscal device
-     */
-    readonly model: string;
-    /**
-     * The manufacturer of the fiscal device
-     */
-    readonly manufacturer: string;
-    /**
-     * The serial number of the fiscal device
-     */
-    readonly serialNumber: string;
-    /**
-     * The port path of the fiscal device
-     */
-    readonly port: string;
-    /**
-     * Initializes the fiscal device
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if initialization was successful
-     */
-    initialize(): Promise<boolean>;
-    /**
-     * Checks if the device is connected and responsive
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if the device is connected
-     */
-    isConnected(): Promise<boolean>;
-    /**
-     * Gets detailed information about the device
-     *
-     * @returns {Promise<DeviceInfo>} A promise that resolves to the device information
-     */
-    getDeviceInfo(): Promise<DeviceInfo>;
-    /**
-     * Prints a fiscal receipt
-     *
-     * @param {FiscalReceipt} receipt - The receipt to print
-     * @returns {Promise<FiscalResponse>} A promise that resolves to the fiscal response
-     */
-    printReceipt(receipt: FiscalReceipt): Promise<FiscalResponse>;
-    /**
-     * Prints a non-fiscal receipt based on the provided receipt details.
-     *
-     * @param {FiscalReceipt} receipt - The receipt object containing all relevant data for generating the non-fiscal receipt.
-     * @return {Promise<FiscalResponse>} A promise that resolves to a FiscalResponse object containing the status and details of the print operation.
-     */
-    printNonFiscalReceipt(receipt: FiscalReceipt): Promise<FiscalResponse>;
-    /**
-     * Prints a reversal receipt
-     *
-     * @param {ReversalReceipt} receipt - The reversal receipt to print
-     * @returns {Promise<FiscalResponse>} A promise that resolves to the fiscal response
-     */
-    printReversalReceipt(receipt: ReversalReceipt): Promise<FiscalResponse>;
-    /**
-     * Gets the last fiscal memory record
-     *
-     * @returns {Promise<FiscalMemoryRecord>} A promise that resolves to the last fiscal memory record
-     */
-    getLastFiscalRecord(): Promise<FiscalMemoryRecord>;
-    /**
-     * Gets the status of the fiscal device
-     *
-     * @returns {Promise<FiscalDeviceStatus>} A promise that resolves to the status of the fiscal device
-     */
-    getStatus(): Promise<FiscalDeviceStatus>;
-    /**
-     * Prints an X report (daily financial report without reset)
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if printing was successful
-     */
-    printXReport(): Promise<boolean>;
-    /**
-     * Prints a Z report (daily financial report with reset)
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if printing was successful
-     */
-    printZReport(): Promise<boolean>;
-    /**
-     * Deposits money into the cash register
-     *
-     * @param {number} amount - The amount to deposit
-     * @returns {Promise<boolean>} A promise that resolves to true if the deposit was successful
-     */
-    depositMoney(amount: number): Promise<boolean>;
-    /**
-     * Withdraws money from the cash register
-     *
-     * @param {number} amount - The amount to withdraw
-     * @returns {Promise<boolean>} A promise that resolves to true if the withdrawal was successful
-     */
-    withdrawMoney(amount: number): Promise<boolean>;
-    /**
-     * Gets the current cash amount in the register
-     *
-     * @returns {Promise<number>} A promise that resolves to the current cash amount
-     */
-    getCashAmount(): Promise<number>;
-    /**
-     * Sets the date and time on the fiscal device
-     *
-     * @param {Date} dateTime - The date and time to set
-     * @returns {Promise<boolean>} A promise that resolves to true if setting was successful
-     */
-    setDateTime(dateTime: Date): Promise<boolean>;
-    /**
-     * Prints a duplicate of the last receipt
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if printing was successful
-     */
-    printDuplicate(): Promise<boolean>;
-    /**
-     * Closes the connection to the fiscal device
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if closing was successful
-     */
-    close(): Promise<boolean>;
+export type DeviceId = string;
+export type TransportType = 'serial' | 'tcp' | 'bluetooth-spp' | 'bluetooth-ble' | 'hid' | 'sdk';
+export interface DeviceCapabilities {
+    supportedOperations: {
+        printFiscalReceipt: boolean;
+        printNonFiscalReceipt: boolean;
+        printReversalReceipt: boolean;
+        printXReport: boolean;
+        printZReport: boolean;
+        printDuplicate: boolean;
+        depositMoney: boolean;
+        withdrawMoney: boolean;
+        getCashAmount: boolean;
+        setDateTime: boolean;
+        getLastFiscalRecord: boolean;
+        getStatus: boolean;
+    };
+    supportsInvoices: boolean;
+    supportsRefunds: boolean;
+    supportsCreditNotes: boolean;
+    maxItemTextLength: number;
+    maxCommentTextLength: number;
+    maxOperatorPasswordLength: number;
+    vatGroups: FiscalVATGroup[];
+    paymentTypes: FiscalPaymentType[];
 }
 /**
  * Interface for fiscal receipt
@@ -134,6 +40,10 @@ export interface FiscalReceipt {
          * 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.
@@ -298,11 +208,19 @@ export interface FiscalDeviceStatus {
      * 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
      */
@@ -315,11 +233,69 @@ export interface FiscalDeviceResponse {
      * 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 {
+    operatorNumber: number;
+    operatorPassword: string;
+    amount?: number;
+    currency?: string;
+    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
      */
@@ -336,6 +312,14 @@ export interface DeviceInfo {
      * The model name of the fiscal device
      */
     model: string;
+    /**
+     * Driver identifier
+     */
+    driverId?: string;
+    /**
+     * Transport type
+     */
+    transport?: TransportType;
     /**
      * The firmware version of the fiscal device
      */

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@reservation-studio/electron-types",
-  "version": "0.0.19",
+  "version": "0.0.28",
   "description": "TypeScript типове за ReservationStudioElectron",
   "scripts": {
     "build": "tsc --project tsconfig.json",
-    "prebuild": "rimraf ./dist",
+    "prebuild": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
     "release": "npm run build && npm publish --access public"
   },
   "main": "./dist/api/exports.js",