@reservation-studio/electron-types 0.0.9 → 0.0.11

package/README.md

@@ -0,0 +1,259 @@
+# @reservation-studio/electron-types
+
+TypeScript type definitions for the Reservation.Studio Electron application.
+
+## Installation
+
+```bash
+npm install @reservation-studio/electron-types
+```
+
+## Overview
+
+This package provides TypeScript type definitions for the Reservation.Studio Electron application. It includes interfaces and enums for working with:
+
+- Certificate management
+- XML signing
+- HTTP requests
+- Fiscal device operations
+- Application environment and version information
+
+## API Reference
+
+### ReservationStudioElectron
+
+The main API object exposed by the Electron application. It's available in the renderer process as `window.ReservationStudioElectron`.
+
+```typescript
+import { ReservationStudioElectron } from '@reservation-studio/electron-types';
+
+// Example usage
+const version = await ReservationStudioElectron.version();
+```
+
+### Certificates
+
+Methods for working with certificates:
+
+```typescript
+// List all available certificates
+const certificates = await ReservationStudioElectron.certificates.list();
+
+// Validate a certificate PIN
+const isValid = await ReservationStudioElectron.certificates.isValidPin(slot, pin);
+```
+
+### XML Signing
+
+Methods for signing XML documents:
+
+```typescript
+// Sign an XML document
+const signedXml = await ReservationStudioElectron.xml.sign(xml, slot, pin);
+```
+
+### HTTP Requests
+
+Methods for making HTTP requests:
+
+```typescript
+// Make a GET request
+const response = await ReservationStudioElectron.http.get(url, {
+  headers: { 'Content-Type': 'application/json' },
+  timeout: 5000,
+  params: { key: 'value' }
+});
+
+// Make a POST request
+const response = await ReservationStudioElectron.http.post(url, data, {
+  headers: { 'Content-Type': 'application/json' }
+});
+```
+
+### Application Information
+
+Methods for getting application information:
+
+```typescript
+// Get application version
+const version = await ReservationStudioElectron.version();
+
+// Get application environment
+const environment = await ReservationStudioElectron.environment();
+
+// Reload the application window
+await ReservationStudioElectron.reload();
+```
+
+### Fiscal Devices
+
+Methods for working with fiscal devices:
+
+```typescript
+// 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();
+
+// Print a fiscal receipt
+const receiptNumber = await ReservationStudioElectron.fiscalDevices.printReceipt({
+  operatorNumber: 1,
+  operatorPassword: '1',
+  items: [
+    {
+      name: 'Product 1',
+      price: 10.00,
+      quantity: 1,
+      vatGroup: 'A'
+    }
+  ],
+  payments: [
+    {
+      type: 'cash',
+      amount: 10.00
+    }
+  ]
+});
+
+// Print non-fiscal text
+await ReservationStudioElectron.fiscalDevices.printText('Hello, World!');
+
+// Get the last fiscal memory record
+const lastRecord = await ReservationStudioElectron.fiscalDevices.getLastFiscalRecord();
+
+// Get the fiscal device status
+const status = await ReservationStudioElectron.fiscalDevices.getStatus();
+```
+
+## Interfaces
+
+### ApiInterface
+
+The main interface that defines the structure of the ReservationStudioElectron object.
+
+### CertificateInfo
+
+```typescript
+interface CertificateInfo {
+  slot: number;
+  name: string;
+  serialNumber: string;
+}
+```
+
+### HttpResponse
+
+```typescript
+interface HttpResponse {
+  status: number;
+  headers: Record<string, string>;
+  data: any;
+  error: boolean;
+}
+```
+
+### HttpOptions
+
+```typescript
+interface HttpOptions {
+  headers?: Record<string, string>;
+  timeout?: number;
+  params?: Record<string, string>;
+}
+```
+
+### FiscalReceipt
+
+```typescript
+interface FiscalReceipt {
+  operatorNumber: number;
+  operatorPassword: string;
+  uniqueSaleNumber?: string;
+  items: FiscalReceiptItem[];
+  payments: FiscalPayment[];
+  client?: FiscalClient;
+}
+```
+
+### FiscalReceiptItem
+
+```typescript
+interface FiscalReceiptItem {
+  name: string;
+  price: number;
+  quantity: number;
+  vatGroup: string;
+  discount?: number;
+}
+```
+
+### FiscalPayment
+
+```typescript
+interface FiscalPayment {
+  type: FiscalPaymentType;
+  amount: number;
+}
+```
+
+### FiscalPaymentType
+
+```typescript
+enum FiscalPaymentType {
+  CASH = 'cash',
+  CARD = 'card',
+  CHECK = 'check',
+  TRANSFER = 'transfer'
+}
+```
+
+### FiscalClient
+
+```typescript
+interface FiscalClient {
+  name: string;
+  address?: string;
+  taxNumber?: string;
+  vatNumber?: string;
+}
+```
+
+### FiscalMemoryRecord
+
+```typescript
+interface FiscalMemoryRecord {
+  number: string;
+  date: Date;
+  total: number;
+}
+```
+
+### FiscalDeviceStatus
+
+```typescript
+interface FiscalDeviceStatus {
+  connected: boolean;
+  hasPaper: boolean;
+  fiscalMemoryFull: boolean;
+  errorCode?: number;
+  errorMessage?: string;
+}
+```
+
+### EnvironmentEnum
+
+```typescript
+enum EnvironmentEnum {
+  LOCAL = 'local',
+  STAGING = 'staging',
+  PRODUCTION = 'production'
+}
+```
+
+## License
+
+Proprietary - Reservation.Studio

package/dist/enums/actions.enum.d.ts

@@ -4,6 +4,14 @@ export declare enum IpcActions {
     XML_SIGN = "xml:sign",
     GET_VERSION = "get-version",
     RELOAD_WINDOW = "reload-window",
+    ENVIRONMENT = "environment:get",
     HTTP_GET = "http:get",
-    HTTP_POST = "http:post"
+    HTTP_POST = "http:post",
+    FISCAL_LIST = "fiscal:list",
+    FISCAL_SET_ACTIVE = "fiscal:set-active",
+    FISCAL_GET_ACTIVE = "fiscal:get-active",
+    FISCAL_PRINT_RECEIPT = "fiscal:print-receipt",
+    FISCAL_PRINT_TEXT = "fiscal:print-text",
+    FISCAL_GET_LAST_RECORD = "fiscal:get-last-record",
+    FISCAL_GET_STATUS = "fiscal:get-status"
 }

package/dist/enums/envirovment.enum.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Enumeration representing different application environments.
+ *
+ * This enum is used to specify and manage various environments in which
+ * the application might run, such as local development, staging, and
+ * production environments.
+ *
+ * Members:
+ * - LOCAL: Represents the local development environment.
+ * - STAGING: Represents the staging environment.
+ * - PRODUCTION: Represents the production environment.
+ */
+export declare enum EnvironmentEnum {
+    LOCAL = "local",
+    STAGING = "staging",
+    PRODUCTION = "production"
+}

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

@@ -1,37 +1,62 @@
 import { CertificateInfo } from './certificate-info.interface';
 import { HttpOptions, HttpResponse } from './http.interface';
+import { EnvironmentEnum } from '../enums/envirovment.enum';
+import { FiscalDeviceStatus, FiscalMemoryRecord, FiscalReceipt } from './fiscal-device.interface';
 export interface ApiInterface {
     /**
-     * Represents the certificates functionality for managing and retrieving certificate information.
-     *
-     * @property {Function} list Retrieves a list of certificates.
-     * @returns {Promise<CertificateInfo[]>} A promise that resolves with an array of `CertificateInfo` objects containing details about each certificate.
+     * An object representing operations related to certificates.
      */
     certificates: {
+        /**
+         * Retrieves a list of certificate information.
+         *
+         * @return {Promise<CertificateInfo[]>} A promise that resolves to an array of CertificateInfo objects.
+         */
         list(): Promise<CertificateInfo[]>;
+        /**
+         * Validates a PIN against a specific slot.
+         *
+         * @param {number} slot - The numerical identifier of the slot to validate the PIN against.
+         * @param {string} pin - The PIN to be validated.
+         * @return {Promise<boolean>} A promise that resolves to true if the PIN is valid, otherwise false.
+         */
         isValidPin(slot: number, pin: string): Promise<boolean>;
     };
     /**
-     * An object containing functionality related to XML operations.
-     *
-     * @property {function} sign - A function to sign an XML string using a specified slot and PIN.
-     * @param {string} xml - The XML string to be signed.
-     * @param {number} slot - The slot number to be used for signing.
-     * @param {string} pin - The PIN associated with the slot for authentication.
-     * @returns {Promise<string>} A promise that resolves to the signed XML string.
+     * Object representing XML-related operations.
      */
     xml: {
+        /**
+         * Signs the provided XML data using the specified cryptographic token slot and PIN.
+         *
+         * @param {string} xml - The XML string to be digitally signed.
+         * @param {number} slot - The slot number of the cryptographic token to be used for signing.
+         * @param {string} pin - The personal identification number (PIN) for accessing the cryptographic token.
+         * @return {Promise<string>} - A promise that resolves to the signed XML string.
+         */
         sign(xml: string, slot: number, pin: string): Promise<string>;
     };
     /**
-     * An HTTP utility object that provides methods to make HTTP requests.
-     * This object can be used to send HTTP POST and GET requests.
-     *
-     * @property {function} post - Sends an HTTP POST request to the specified URL with the provided data and optional configurations.
-     * @property {function} get - Sends an HTTP GET request to the specified URL with optional configurations.
+     * A utility object for making HTTP requests, providing methods for sending GET and POST requests.
+     * Supports configuration options such as headers, query parameters, and response handling.
      */
     http: {
+        /**
+         * Sends an HTTP POST request to the specified URL with the provided data and options.
+         *
+         * @param {string} url - The URL to which the POST request is sent.
+         * @param {any} data - The payload to be sent in the body of the POST request.
+         * @param {HttpOptions} [options] - Optional configuration for the HTTP request, such as headers and parameters.
+         * @return {Promise<HttpResponse>} A promise that resolves to the HTTP response object containing status, headers, and data.
+         */
         post(url: string, data: any, options?: HttpOptions): Promise<HttpResponse>;
+        /**
+         * Sends an HTTP GET request to the specified URL with optional configuration settings.
+         *
+         * @param {string} url - The target URL to which the GET request will be sent.
+         * @param {HttpOptions} [options] - Optional settings to configure the HTTP request, such as headers, query parameters, and other request options.
+         * @return {Promise<HttpResponse>} A promise that resolves to the HTTP response containing the status, headers, and data of the response.
+         */
         get(url: string, options?: HttpOptions): Promise<HttpResponse>;
     };
     /**
@@ -48,4 +73,70 @@ export interface ApiInterface {
      * @return {Promise<void>} A promise that resolves when the reload operation is complete.
      */
     reload(): Promise<void>;
+    /**
+     * Retrieves the current application environment.
+     *
+     * @return {Promise<EnvironmentEnum>} A promise that resolves to the enumeration representing the current environment.
+     */
+    environment(): Promise<EnvironmentEnum>;
+    /**
+     * An object representing operations related to fiscal devices.
+     * All methods automatically initialize fiscal devices when needed.
+     */
+    fiscalDevices: {
+        /**
+         * Gets a list of all detected fiscal devices.
+         * Automatically initializes fiscal devices if needed.
+         *
+         * @return {Promise<Array<{manufacturer: string, model: string, serialNumber: string}>>} A promise that resolves to an array of fiscal device information.
+         */
+        list(): Promise<Array<{
+            manufacturer: string;
+            model: string;
+            serialNumber: string;
+        }>>;
+        /**
+         * Sets the active fiscal device.
+         *
+         * @param {string} serialNumber - The serial number of the device to set as active.
+         * @return {Promise<boolean>} A promise that resolves to true if the device was found and set as active.
+         */
+        setActiveDevice(serialNumber: string): Promise<boolean>;
+        /**
+         * Gets the active fiscal device.
+         *
+         * @return {Promise<{manufacturer: string, model: string, serialNumber: string} | null>} A promise that resolves to the active fiscal device information or null if no device is active.
+         */
+        getActiveDevice(): Promise<{
+            manufacturer: string;
+            model: string;
+            serialNumber: string;
+        } | null>;
+        /**
+         * Prints a fiscal receipt using the active device.
+         *
+         * @param {FiscalReceipt} receipt - The receipt to print.
+         * @return {Promise<string>} A promise that resolves to the receipt number.
+         */
+        printReceipt(receipt: FiscalReceipt): Promise<string>;
+        /**
+         * Prints a non-fiscal text using the active device.
+         *
+         * @param {string} text - The text to print.
+         * @return {Promise<boolean>} A promise that resolves to true if printing was successful.
+         */
+        printText(text: string): Promise<boolean>;
+        /**
+         * Gets the last fiscal memory record from the active device.
+         *
+         * @return {Promise<FiscalMemoryRecord>} A promise that resolves to the last fiscal memory record.
+         */
+        getLastFiscalRecord(): Promise<FiscalMemoryRecord>;
+        /**
+         * Gets the status of the active device.
+         *
+         * @return {Promise<FiscalDeviceStatus>} A promise that resolves to the status of the active device.
+         */
+        getStatus(): Promise<FiscalDeviceStatus>;
+    };
 }

package/dist/interfaces/certificate-info.interface.d.ts

@@ -1,4 +1,30 @@
+/**
+ * Represents information about a certificate that includes the slot number and name.
+ */
 export interface CertificateInfo {
+    /**
+     * The slot number associated with the certificate.
+     */
     slot: number;
+    /**
+     * The name of the certificate.
+     */
     name: string;
+    /**
+     * The serial number of the certificate.
+     */
+    serialNumber: string;
+}
+/**
+ * Interface representing a certificate-based authentication structure.
+ */
+export interface CertificateAuth {
+    /**
+     * Represents the serial number of an item.
+     */
+    serialNumber: string;
+    /**
+     * Personal identification code.
+     */
+    pin: string;
 }

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

@@ -0,0 +1,204 @@
+/**
+ * Interface for fiscal device operations
+ */
+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>;
+    /**
+     * Prints a fiscal receipt
+     *
+     * @param {FiscalReceipt} receipt - The receipt to print
+     * @returns {Promise<string>} A promise that resolves to the receipt number
+     */
+    printReceipt(receipt: FiscalReceipt): Promise<string>;
+    /**
+     * Prints a non-fiscal text
+     *
+     * @param {string} text - The text to print
+     * @returns {Promise<boolean>} A promise that resolves to true if printing was successful
+     */
+    printText(text: string): Promise<boolean>;
+    /**
+     * 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>;
+    /**
+     * Closes the connection to the fiscal device
+     *
+     * @returns {Promise<boolean>} A promise that resolves to true if closing was successful
+     */
+    close(): Promise<boolean>;
+}
+/**
+ * Interface for fiscal receipt
+ */
+export interface FiscalReceipt {
+    /**
+     * The operator number
+     */
+    operatorNumber: number;
+    /**
+     * The operator password
+     */
+    operatorPassword: string;
+    /**
+     * The unique sale number
+     */
+    uniqueSaleNumber?: string;
+    /**
+     * The items in the receipt
+     */
+    items: FiscalReceiptItem[];
+    /**
+     * The payments in the receipt
+     */
+    payments: FiscalPayment[];
+    /**
+     * The client information (for invoice receipts)
+     */
+    client?: FiscalClient;
+}
+/**
+ * Interface for fiscal receipt item
+ */
+export interface FiscalReceiptItem {
+    /**
+     * The name of the item
+     */
+    name: string;
+    /**
+     * The price of the item
+     */
+    price: number;
+    /**
+     * The quantity of the item
+     */
+    quantity: number;
+    /**
+     * The VAT group of the item
+     */
+    vatGroup: string;
+    /**
+     * The discount percentage (optional)
+     */
+    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;
+    /**
+     * The error code if any
+     */
+    errorCode?: number;
+    /**
+     * The error message if any
+     */
+    errorMessage?: string;
+}

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

@@ -1,11 +1,38 @@
+/**
+ * Interface representing an HTTP response.
+ */
 export interface HttpResponse {
+    /**
+     * The HTTP status code of the response.
+     */
     status: number;
+    /**
+     * The headers returned in the HTTP response as key-value pairs.
+     */
     headers: Record<string, string>;
+    /**
+     * The response data, which can be any type depending on the request.
+     */
     data: any;
+    /**
+     * Flag indicating whether an error occurred during the HTTP request.
+     */
     error: boolean;
 }
+/**
+ * Interface representing options for an HTTP request.
+ */
 export interface HttpOptions {
+    /**
+     * Optional headers to include in the HTTP request, represented as key-value pairs.
+     */
     headers?: Record<string, string>;
+    /**
+     * Optional timeout for the HTTP request, specified in milliseconds.
+     */
     timeout?: number;
+    /**
+     * Optional query parameters to include in the HTTP request, represented as key-value pairs.
+     */
     params?: Record<string, string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservation-studio/electron-types",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "TypeScript типове за ReservationStudioElectron",
   "scripts": {
     "build": "tsc",
@@ -16,8 +16,8 @@
   "author": "Venelin Iliev",
   "license": "Proprietary - Reservation.Studio",
   "devDependencies": {
-    "typescript": "^4.5.4",
-    "@types/node": "^22"
+    "@types/node": "^22.16.0",
+    "typescript": "^5.2.0"
   },
   "files": [
     "dist"

package/README.md

@@ -1 +0,0 @@
-# @reservation-studio/electron-types