@reservation-studio/electron-types 0.0.8 → 0.0.10

package/README.md

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

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

@@ -9,19 +9,19 @@ export interface ApiInterface {
      */
     certificates: {
         list(): Promise<CertificateInfo[]>;
-        isValidPin(certificateId: string, pin: string): Promise<boolean>;
+        isValidPin(slot: number, pin: string): Promise<boolean>;
     };
     /**
-     * Provides functionality to handle XML signing operations.
+     * An object containing functionality related to XML operations.
      *
-     * @property {Function} sign - Signs an XML string with a specified digital certificate.
-     * @param {string} xml - The XML content to be signed.
-     * @param {string} certificateId - The identifier of the certificate to use for signing.
-     * @param {string} [pin] - Optional PIN code associated with the digital certificate.
-     * @returns {Promise<string>} A promise that resolves with the signed XML content as a string.
+     * @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.
      */
     xml: {
-        sign(xml: string, certificateId: string, pin?: string): Promise<string>;
+        sign(xml: string, slot: number, pin: string): Promise<string>;
     };
     /**
      * An HTTP utility object that provides methods to make HTTP requests.

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

@@ -1,8 +1,21 @@
+/**
+ * Represents information about a certificate that includes the slot number and name.
+ */
 export interface CertificateInfo {
-    id: string;
-    commonName?: string;
-    organization?: string;
-    country?: string;
-    email?: string;
+    /**
+     * The slot number associated with the certificate.
+     * This is typically used to identify the location or index of the certificate
+     * in a storage or hardware module.
+     */
+    slot: number;
+    /**
+     * The name of the certificate.
+     * This is often used for identification or descriptive purposes.
+     */
     name: string;
+    /**
+     * The serial number of the certificate.
+     * This is used to uniquely identify the certificate.
+     */
+    serialNumber: string;
 }

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

@@ -1,14 +1,38 @@
+/**
+ * Interface representing an HTTP response.
+ */
 export interface HttpResponse {
+    /**
+     * The HTTP status code of the response.
+     */
     status: number;
-    statusText: string;
+    /**
+     * 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;
-    ok: boolean;
+    /**
+     * 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;
-    responseType?: 'json' | 'text' | 'arraybuffer' | 'blob';
-    withCredentials?: boolean;
+    /**
+     * 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.8",
+  "version": "0.0.10",
   "description": "TypeScript типове за ReservationStudioElectron",
   "scripts": {
     "build": "tsc",
@@ -17,7 +17,7 @@
   "license": "Proprietary - Reservation.Studio",
   "devDependencies": {
     "typescript": "^4.5.4",
-    "@types/node": "^20"
+    "@types/node": "^22"
   },
   "files": [
     "dist"

package/README.md

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