zklib-ts 1.0.2-development → 1.0.4-development

package/LICENSE.md

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) Gustavo Paz <gusti.paz@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+The MIT License (MIT)
+
+Copyright (c) Gustavo Paz <gusti.paz@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.

package/README.md

@@ -1,3 +1,4 @@
+[![NPM](https://nodei.co/npm/zklib-ts.png?downloads=true&stars=true)](https://www.npmjs.com/package/is-electron)
 <h1 align="center">zklib ts</h1>
 <p align="center">An unofficial library that provides a robust solution for Node.js developers to interface with ZKTeco Devices.</p>
 <p align="center">
@@ -107,3 +108,4 @@ npm t Generic
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+

package/dist/index.cjs.js

@@ -365,7 +365,7 @@ const parseTimeToDate = (time) => {
     const month = time % 12;
     time = (time - month) / 12;
     const year = time + 2000;
-    return new Date(year, month, day, hour, minute, second);
+    return new Date(Date.UTC(year, month, day, hour, minute, second));
 };
 const decodeUserData28 = (userData) => {
     return {
@@ -1249,9 +1249,9 @@ class ZTCP {
     async getVendor() {
         const keyword = '~OEMVendor';
         try {
-            // Execute the command to get serial number
+            // Execute the command to get oem vendor
             const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
-            // Extract and format the serial number from the response data
+            // Extract and format the oem bendor from the response data
             const vendor = data.slice(8) // Skip the first 8 bytes (header)
                 .toString('ascii') // Convert buffer to string
                 .replace(`${keyword}=`, '') // Remove the keyword prefix
@@ -1303,6 +1303,29 @@ class ZTCP {
             throw err;
         }
     }
+    async getNetworkParams() {
+        try {
+            const params = {
+                IPAddress: this.ip,
+                NetMask: '',
+                GATEIPAddress: ''
+            };
+            const keywords = Object.keys(params);
+            for await (const keyword of keywords) {
+                const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
+                params[keyword] = data.slice(8)
+                    .toString('utf-8')
+                    .replace(`${keyword}=`, '') // Remove the keyword prefix
+                    .replace(/\u0000/g, '')
+                    .replace('=', '.'); // Replace equal simbol to dot, due to sometimes there are parsing errors
+            }
+            return params;
+        }
+        catch (err) {
+            console.error("Error getting Network Params: ", err);
+            throw err;
+        }
+    }
     async getSerialNumber() {
         const keyword = '~SerialNumber';
         try {
@@ -1312,7 +1335,11 @@ class ZTCP {
             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');
+            }
             return serialNumber;
         }
         catch (err) {
@@ -2754,6 +2781,9 @@ class Zklib {
     async executeCmd(command, data = '') {
         return this.functionWrapper(() => this.ztcp.executeCmd(command, data), () => this.zudp.executeCmd(command, data), 'EXECUTE_CMD');
     }
+    async getNetworkParams() {
+        return this.functionWrapper(() => this.ztcp.getNetworkParams(), async () => { throw new Error('UDP getNetworkParams not implemented'); }, 'NETWORK_PARAMS');
+    }
 }
 
 module.exports = Zklib;

package/dist/index.d.ts

@@ -69,5 +69,10 @@ export default class Zklib {
     clearAttendanceLog(): Promise<any>;
     clearData(): Promise<any>;
     executeCmd(command: number, data?: string | Buffer): Promise<Buffer>;
+    getNetworkParams(): Promise<{
+        IPAddress: string;
+        NetMask: string;
+        GATEIPAddress: string;
+    }>;
 }
 export type { Attendance, User, Finger, DeviceInfo, Zklib };

package/dist/index.es.js

@@ -344,7 +344,7 @@ const parseTimeToDate = (time) => {
     const month = time % 12;
     time = (time - month) / 12;
     const year = time + 2000;
-    return new Date(year, month, day, hour, minute, second);
+    return new Date(Date.UTC(year, month, day, hour, minute, second));
 };
 const decodeUserData28 = (userData) => {
     return {
@@ -1228,9 +1228,9 @@ class ZTCP {
     async getVendor() {
         const keyword = '~OEMVendor';
         try {
-            // Execute the command to get serial number
+            // Execute the command to get oem vendor
             const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
-            // Extract and format the serial number from the response data
+            // Extract and format the oem bendor from the response data
             const vendor = data.slice(8) // Skip the first 8 bytes (header)
                 .toString('ascii') // Convert buffer to string
                 .replace(`${keyword}=`, '') // Remove the keyword prefix
@@ -1282,6 +1282,29 @@ class ZTCP {
             throw err;
         }
     }
+    async getNetworkParams() {
+        try {
+            const params = {
+                IPAddress: this.ip,
+                NetMask: '',
+                GATEIPAddress: ''
+            };
+            const keywords = Object.keys(params);
+            for await (const keyword of keywords) {
+                const data = await this.executeCmd(COMMANDS.CMD_OPTIONS_RRQ, keyword);
+                params[keyword] = data.slice(8)
+                    .toString('utf-8')
+                    .replace(`${keyword}=`, '') // Remove the keyword prefix
+                    .replace(/\u0000/g, '')
+                    .replace('=', '.'); // Replace equal simbol to dot, due to sometimes there are parsing errors
+            }
+            return params;
+        }
+        catch (err) {
+            console.error("Error getting Network Params: ", err);
+            throw err;
+        }
+    }
     async getSerialNumber() {
         const keyword = '~SerialNumber';
         try {
@@ -1291,7 +1314,11 @@ class ZTCP {
             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');
+            }
             return serialNumber;
         }
         catch (err) {
@@ -2733,6 +2760,9 @@ class Zklib {
     async executeCmd(command, data = '') {
         return this.functionWrapper(() => this.ztcp.executeCmd(command, data), () => this.zudp.executeCmd(command, data), 'EXECUTE_CMD');
     }
+    async getNetworkParams() {
+        return this.functionWrapper(() => this.ztcp.getNetworkParams(), async () => { throw new Error('UDP getNetworkParams not implemented'); }, 'NETWORK_PARAMS');
+    }
 }
 
 export { Zklib as default };

package/dist/ztcp.d.ts

@@ -104,6 +104,11 @@ export declare class ZTCP {
     getVendor(): Promise<string>;
     getProductTime(): Promise<Date>;
     getMacAddress(): Promise<string>;
+    getNetworkParams(): Promise<{
+        IPAddress: string;
+        NetMask: string;
+        GATEIPAddress: string;
+    }>;
     getSerialNumber(): Promise<string>;
     getDeviceVersion(): Promise<string>;
     getDeviceName(): Promise<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklib-ts",
-  "version": "1.0.2-development",
+  "version": "1.0.4-development",
   "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,12 +15,13 @@
     "test": "jest",
     "build": "rollup -c",
     "watch": "rollup -c --watch",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "publish": "npm run publish --tag latest"
   },
   "repositoryUrl": "https://github.com/guspaz0/zklib-ts.git",
   "repository": {
     "type": "git",
-    "url": "https://github.com/guspaz0/zklib-ts.git"
+    "url": "git+https://github.com/guspaz0/zklib-ts.git"
   },
   "keywords": [
     "typescript",
@@ -49,13 +50,11 @@
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.13.14",
-    "cz-conventional-changelog": "^3.3.0",
     "dotenv": "^16.4.7",
-    "jest": "^29.7.0",
+    "jest": "30.2.0",
     "rollup": "^4.37.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
-    "semantic-release": "^24.0.0",
-    "ts-jest": "^29.3.0",
+    "ts-jest": "29.4.6",
     "ts-node": "^10.9.2",
     "tslib": "^2.8.1",
     "typescript": "^5.8.2"