zklib-ts 1.0.4-development → 1.0.5

package/dist/helper/utils.d.ts

@@ -21,6 +21,36 @@ interface UDPHeader {
 interface TCPHeader extends UDPHeader {
     payloadSize: number;
 }
+export type FreeSizes = {
+    /** Number of users */
+    userCounts: number;
+    /** Number of logs */
+    logCounts: number;
+    /** Number of fingerprints */
+    fingerCount: number;
+    /** Number of admins */
+    adminCount: number;
+    /** Number or opLogs, maybe access control events? */
+    opLogCount: number;
+    /** Capacity of logs in bytes */
+    logCapacity: number;
+    /** Capacity of fingerprints */
+    fingerCapacity: number;
+    /** Capacity of users */
+    userCapacity: number;
+    /** Capacity of oplog */
+    attLogCapacity: number;
+    /** Number of available finger templates */
+    fingerAvailable: number;
+    /** Number of available Users */
+    userAvailable: number;
+    /** Number of attendanceLog available */
+    attLogAvailable: number;
+    /** Number of faces */
+    faceCount: number;
+    /** Capacity of faces */
+    faceCapacity: number;
+};
 export declare const createUDPHeader: (command: number, sessionId: number, replyId: number, data: any) => Buffer;
 export declare const createTCPHeader: (command: number, sessionId: number, replyId: number, data: any) => Buffer;
 export declare const removeTcpHeader: (buf: Buffer) => Buffer;

package/dist/index.cjs.js

@@ -1328,17 +1328,26 @@ class ZTCP {
     }
     async getSerialNumber() {
         const keyword = '~SerialNumber';
+        let serialNumber = '';
+        let count = 10;
         try {
             // Execute the command to get serial number
-            const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
-            // Extract and format the serial number from the response data
-            const serialNumber = data.slice(8) // Skip the first 8 bytes (header)
-                .toString('utf-8') // Convert buffer to string
-                .replace(`${keyword}=`, '') // Remove the keyword prefix
-                .replace('=', '') // Remove sometines last number is a character equal to = or unknow character
-                .replace(/\u0000/g, ''); // Remove null characters
-            if (serialNumber.length !== 13 && this.verbose) {
-                console.warn('Serial number length not equal to 13, check');
+            /**
+             * @dev implemented a counter and a while loop because sometimes serial number parses wrong for some reason
+             * */
+            while (serialNumber.length !== 13 && count > 0) {
+                const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
+                // Extract and format the serial number from the response data
+                const SN = data.slice(8) // Skip the first 8 bytes (header)
+                    .toString('utf-8') // Convert buffer to string
+                    .replace(`${keyword}=`, '') // Remove the keyword prefix
+                    .replace('=', '') // Remove sometines last number is a character equal to = or unknow character
+                    .replace(/\u0000/g, ''); // Remove null characters
+                if (serialNumber.length !== 13 && this.verbose) {
+                    console.warn('Serial number length not equal to 13, check');
+                }
+                count--;
+                serialNumber = SN;
             }
             return serialNumber;
         }
@@ -2755,7 +2764,7 @@ class Zklib {
         return this.functionWrapper(() => this.ztcp.restartDevice(), async () => { throw new Error('UDP restart device not supported'); }, 'RESTART_DEVICE');
     }
     async getSizes() {
-        return this.functionWrapper(() => this.ztcp.getSizes(), () => this.zudp.getInfo(), 'GET_SIZES');
+        return this.functionWrapper(() => this.ztcp.getSizes(), () => { throw new Error('not implemented ofr UDP'); }, 'GET_SIZES');
     }
     async disconnect() {
         return this.functionWrapper(() => this.ztcp.disconnect(), () => this.zudp.disconnect(), 'DISCONNECT');

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { ZUDP } from './zudp';
 import { User } from './models/User';
 import { Finger } from './models/Finger';
 import { Attendance } from "./models/Attendance";
-import { RecordData16, UserData28, DeviceInfo } from "./helper/utils";
+import { RecordData16, UserData28, DeviceInfo, FreeSizes } from "./helper/utils";
 export default class Zklib {
     set connectionType(value: "tcp" | "udp" | null);
     private _connectionType;
@@ -60,7 +60,7 @@ export default class Zklib {
     enrollUser(uid: number, temp_id: number, user_id: string): Promise<boolean>;
     verifyUser(uid: number): Promise<boolean>;
     restartDevice(): Promise<void>;
-    getSizes(): Promise<DeviceInfo>;
+    getSizes(): Promise<FreeSizes>;
     disconnect(): Promise<void>;
     freeData(): Promise<boolean>;
     disableDevice(): Promise<boolean>;

package/dist/index.es.js

@@ -1307,17 +1307,26 @@ class ZTCP {
     }
     async getSerialNumber() {
         const keyword = '~SerialNumber';
+        let serialNumber = '';
+        let count = 10;
         try {
             // Execute the command to get serial number
-            const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
-            // Extract and format the serial number from the response data
-            const serialNumber = data.slice(8) // Skip the first 8 bytes (header)
-                .toString('utf-8') // Convert buffer to string
-                .replace(`${keyword}=`, '') // Remove the keyword prefix
-                .replace('=', '') // Remove sometines last number is a character equal to = or unknow character
-                .replace(/\u0000/g, ''); // Remove null characters
-            if (serialNumber.length !== 13 && this.verbose) {
-                console.warn('Serial number length not equal to 13, check');
+            /**
+             * @dev implemented a counter and a while loop because sometimes serial number parses wrong for some reason
+             * */
+            while (serialNumber.length !== 13 && count > 0) {
+                const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
+                // Extract and format the serial number from the response data
+                const SN = data.slice(8) // Skip the first 8 bytes (header)
+                    .toString('utf-8') // Convert buffer to string
+                    .replace(`${keyword}=`, '') // Remove the keyword prefix
+                    .replace('=', '') // Remove sometines last number is a character equal to = or unknow character
+                    .replace(/\u0000/g, ''); // Remove null characters
+                if (serialNumber.length !== 13 && this.verbose) {
+                    console.warn('Serial number length not equal to 13, check');
+                }
+                count--;
+                serialNumber = SN;
             }
             return serialNumber;
         }
@@ -2734,7 +2743,7 @@ class Zklib {
         return this.functionWrapper(() => this.ztcp.restartDevice(), async () => { throw new Error('UDP restart device not supported'); }, 'RESTART_DEVICE');
     }
     async getSizes() {
-        return this.functionWrapper(() => this.ztcp.getSizes(), () => this.zudp.getInfo(), 'GET_SIZES');
+        return this.functionWrapper(() => this.ztcp.getSizes(), () => { throw new Error('not implemented ofr UDP'); }, 'GET_SIZES');
     }
     async disconnect() {
         return this.functionWrapper(() => this.ztcp.disconnect(), () => this.zudp.disconnect(), 'DISCONNECT');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklib-ts",
-  "version": "1.0.4-development",
+  "version": "1.0.5",
   "description": "Unofficial zkteco library allows Node.js developers to easily interface with ZK BioMetric Fingerprint Attendance Devices",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -15,8 +15,7 @@
     "test": "jest",
     "build": "rollup -c",
     "watch": "rollup -c --watch",
-    "prepare": "npm run build",
-    "publish": "npm run publish --tag latest"
+    "prepare": "npm run build"
   },
   "repositoryUrl": "https://github.com/guspaz0/zklib-ts.git",
   "repository": {