zklib-ts 1.0.5 → 1.0.7

package/dist/models/Attendance.d.ts

@@ -1,9 +1,17 @@
+/**
+ * Represents an Attendance Records
+ */
 export declare class Attendance {
+    /** Internal serial number for the user */
     sn: number;
+    /** User ID/Pin stored as a string */
     user_id: string;
-    record_time: Date;
+    /** Verification type */
     type?: number;
+    /** Time of the attendance event */
+    record_time: Date;
+    /** Verify state */
     state?: number;
     ip?: string;
-    constructor(sn: number, user_id: string, record_time: Date, type?: number, state?: number);
+    constructor(sn: number, user_id: string, type: number, record_time: Date, state?: number);
 }

package/dist/models/Finger.d.ts

@@ -4,6 +4,7 @@
 export declare class Finger {
     uid: number;
     fid: number;
+    /** Flag indicating 0 = invalid | 1 = valid | 3 = duress. if is not initilizaed, default is 1 = valid */
     valid: number;
     template: Buffer;
     size: number;
@@ -15,7 +16,7 @@ export declare class Finger {
      * @param valid Flag indicating 0 = invalid | 1 = valid | 3 = duress
      * @param template Fingerprint template data buffer
      */
-    constructor(uid: number, fid: number, valid: number, template: Buffer);
+    constructor(uid: number, fid: number, template: Buffer, valid?: number);
     /**
      * Packs the fingerprint data with metadata into a Buffer
      * @returns Buffer containing packed fingerprint data

package/dist/services/options.service.d.ts

@@ -0,0 +1,49 @@
+import { ZTCP } from "../ztcp";
+export declare class OptionsService {
+    _zkTcp: ZTCP;
+    constructor(zkTcp: ZTCP);
+    /** Ask if the device doesn't support alphanumeric symbols for user id values. */
+    isAbcPinEnable(): Promise<string>;
+    /** Ask if the device doesn't support alphanumeric symbols for user id values. */
+    isT9FunOn(): Promise<string>;
+    getDeviceId(): Promise<any>;
+    /**
+     * Change Device ID
+     * @param id a number between 1 and 254
+     */
+    setDeviceId(id: number): Promise<boolean>;
+    getVendor(): Promise<any>;
+    getProductTime(): Promise<Date>;
+    getMacAddress(): Promise<string>;
+    getNetworkParams(): Promise<{
+        IPAddress: string;
+        NetMask: string;
+        GATEIPAddress: string;
+        TCPPort: string;
+    }>;
+    getSerialNumber(): Promise<string>;
+    /**
+     * get Zkteko Template version
+     * @returns number
+     */
+    getDeviceVersion(): Promise<string>;
+    /**
+     * get Device/Model Name
+     * @returns
+     */
+    getDeviceName(): Promise<any>;
+    getPlatform(): Promise<any>;
+    getOS(): Promise<string>;
+    getWorkCode(): Promise<string>;
+    /**
+     * get User ID max length
+     * @returns
+     */
+    getPIN(): Promise<string>;
+    getFaceOn(): Promise<"No" | "Yes">;
+    getSSR(): Promise<string>;
+    getFirmware(): Promise<string>;
+    getTime(): Promise<Date>;
+    setTime(tm: Date | string): Promise<boolean>;
+    voiceTest(): Promise<void>;
+}

package/dist/services/transaction.service.d.ts

@@ -0,0 +1,9 @@
+import { ZTCP } from '../ztcp';
+export declare class TransactionService {
+    _zkTcp: ZTCP;
+    constructor(zkTcp: ZTCP);
+    getAttendances(callbackInProcess?: any): Promise<{
+        data: any[];
+    }>;
+    clearAttendanceLog(): Promise<boolean>;
+}

package/dist/services/user.service.d.ts

@@ -0,0 +1,33 @@
+import { User } from "../models/User";
+import { ZTCP } from "../ztcp";
+import { Finger } from "../models/Finger";
+export declare class UserService {
+    _zkTcp: ZTCP;
+    _users: Map<string, User>;
+    constructor(zkTcp: ZTCP);
+    getUserByUserId(user_id: string): Promise<User>;
+    getUsers(): Promise<{
+        data: User[];
+    }>;
+    setUser(user_id: string, name: string, password: string, role?: number, cardno?: number): Promise<boolean>;
+    DeleteUser(user_id: string): Promise<boolean>;
+    getTemplates(cb?: Function): Promise<Record<string, Finger[]>>;
+    DownloadFp(user_id: string, fid: number): Promise<Finger>;
+    /**
+     *
+     * @param user_id {string} user
+     * @param fingers {Finger[]} array of finger templates instances
+     * */
+    saveTemplates(user_id: string, fingers?: Finger[]): Promise<void>;
+    deleteFinger(user_id?: string, fid?: number): Promise<boolean>;
+    enrollInfo(user_id: string, tempId: number): Promise<unknown>;
+    verify(user_id: string): Promise<boolean>;
+    /**
+     * Upload a single fingerprint for a given user id
+     * @param user_id {string} user id for customer
+     * @param fingerTemplate {string} finger template in base64 string
+     * @param fid {number} finger id is a number between 0 and 9
+     * @param fp_valid {number} finger flag. e.g., valid=1, duress=3
+     */
+    uploadFingerTemplate(user_id: string, fingerTemplate: string, fid: number, fp_valid: number): Promise<boolean>;
+}

package/dist/ztcp.d.ts

@@ -1,24 +1,27 @@
-import { Socket } from 'net';
-import { RealTimeLog } from './helper/utils';
-import { Finger } from './models/Finger';
-import { User } from './models/User';
+import { Socket } from "net";
+import { RealTimeLog } from "./helper/utils";
+import { Finger } from "./models/Finger";
+import { UserService } from "./services/user.service";
+import { TransactionService } from "./services/transaction.service";
+import { OptionsService } from "./services/options.service";
 export declare class ZTCP {
+    #private;
     /**
-    * @param_ip ip address of device
-    * @param_port port number of device
-    * @param_timeout connection timout
-    * @param_comm_key communication key of device (if the case)
-    * @return Zkteco TCP socket connection instance
-    */
-    private ip;
+     * @param_ip ip address of device
+     * @param_port port number of device
+     * @param_timeout connection timout
+     * @param_comm_key communication key of device (if the case)
+     * @return Zkteco TCP socket connection instance
+     */
+    ip: string;
     private port;
-    private timeout;
-    private sessionId;
-    private replyId;
+    timeout: number;
+    sessionId: number;
+    replyId: number;
     socket: Socket | undefined;
     private comm_key;
     private user_count;
-    private fp_count;
+    fp_count: number;
     private pwd_count;
     private oplog_count;
     private attlog_count;
@@ -30,15 +33,18 @@ export declare class ZTCP {
     private attlog_av;
     private face_count;
     private face_cap;
-    private userPacketSize;
-    private verbose;
+    userPacketSize: number;
+    verbose: boolean;
     private packetNumber;
     private replyData;
+    _optionsService: OptionsService;
+    _transactionService: TransactionService;
+    _userService: UserService;
     constructor(ip: string, port: number, timeout: number, comm_key: number, verbose: boolean);
-    createSocket(cbError: any, cbClose: any): Promise<unknown>;
+    createSocket(cbError: (err: Error) => void, cbClose: (type: string) => void): Promise<unknown>;
     connect(): Promise<boolean>;
     closeSocket(): Promise<boolean>;
-    writeMessage(msg: Buffer, connect: boolean): Promise<Buffer>;
+    writeMessage(msg: Buffer, connect: boolean, cb: (data: Buffer) => any): Promise<Buffer>;
     requestData(msg: Buffer): Promise<Buffer>;
     /**
      *
@@ -58,24 +64,13 @@ export declare class ZTCP {
      * readWithBuffer will reject error if it'wrong when starting request data
      * readWithBuffer will return { data: replyData , err: Error } when receiving requested data
      */
-    readWithBuffer(reqData: Buffer | string, cb?: Function): Promise<Record<string, Buffer | number>>;
-    /**
-     *  reject error when starting request data
-     *  @return {Record<string, User[] | Error>} when receiving requested data
-     */
-    getUsers(): Promise<{
-        data: User[];
-    }>;
+    readWithBuffer(reqData: Buffer | string, cb?: (received: number, total: number) => void): Promise<Record<string, Buffer | number | Error>>;
     /**
      *
-     * @param {*} ip
      * @param {*} callbackInProcess
      *  reject error when starting request data
      *  return { data: records, err: Error } when receiving requested data
      */
-    getAttendances(callbackInProcess?: any): Promise<{
-        data: any[];
-    }>;
     freeData(): Promise<boolean>;
     disableDevice(): Promise<boolean>;
     enableDevice(): Promise<boolean>;
@@ -101,32 +96,18 @@ export declare class ZTCP {
         faceCount: number;
         faceCapacity: number;
     }>;
-    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>;
-    getPlatform(): Promise<string>;
-    getOS(): Promise<string>;
-    getWorkCode(): Promise<string>;
-    getPIN(): Promise<string>;
-    getFaceOn(): Promise<"No" | "Yes">;
-    getSSR(): Promise<string>;
-    getFirmware(): Promise<string>;
-    getTime(): Promise<Date>;
-    setTime(tm: Date | string): Promise<boolean>;
-    voiceTest(): Promise<void>;
-    setUser(uid: number, userid: string, name: string, password: string, role?: number, cardno?: number): Promise<boolean>;
-    deleteUser(uid: number): Promise<boolean>;
     getAttendanceSize(): Promise<number>;
-    clearAttendanceLog(): Promise<Buffer<ArrayBufferLike>>;
-    clearData(): Promise<Buffer<ArrayBufferLike>>;
+    clearAttendanceLog(): Promise<boolean>;
+    /**
+     * Clears all data on the device
+     * @value 1 Attendance records
+     * @value 2 Fingerprint templates
+     * @value 3 None
+     * @value 4 Operation records
+     * @value 5 User information
+     * @default 0 Delete all
+     */
+    clearData(value?: number): Promise<boolean>;
     getRealTimeLogs(cb?: (realTimeLog: RealTimeLog) => void): Promise<void>;
     /**
      * Get all Finger objects
@@ -141,15 +122,6 @@ export declare class ZTCP {
     refreshData(): Promise<boolean>;
     sendWithBuffer(buffer: Buffer): Promise<unknown>;
     sendChunk(commandString: Buffer): Promise<unknown>;
-    /**
-     * save user and template
-     *
-     * @param {User | number | string} user - User class object | uid | user_id
-     * @param {Finger[]} fingers - Array of finger class. `0 <= index <= 9`
-     */
-    saveUserTemplate(user: User, fingers?: Finger[]): Promise<void>;
-    deleteFinger(uid: number, fid: number): Promise<boolean>;
-    enrollUser(uid: number, tempId: number, userId?: string): Promise<boolean>;
     readSocket(length: number, cb?: any): Promise<any>;
     /**
      * Register events
@@ -158,8 +130,6 @@ export declare class ZTCP {
      * @throws {ZKErrorResponse} If registration fails
      */
     regEvent(flags: number): Promise<void>;
-    ackOk(): Promise<void>;
     cancelCapture(): Promise<boolean>;
-    verifyUser(uid: number): Promise<boolean>;
     restartDevice(): Promise<void>;
 }

package/dist/zudp.d.ts

@@ -1,5 +1,5 @@
 import { RecordData16, UserData28 } from './helper/utils';
-import * as dgram from "node:dgram";
+import * as dgram from 'node:dgram';
 interface DeviceInfo {
     userCounts: number;
     logCounts: number;
@@ -39,8 +39,8 @@ export declare class ZUDP {
     getInfo(): Promise<DeviceInfo>;
     getTime(): Promise<Date>;
     setTime(tm: Date | string): Promise<boolean>;
-    clearAttendanceLog(): Promise<Buffer>;
-    clearData(): Promise<Buffer>;
+    clearAttendanceLog(): Promise<boolean>;
+    clearData(): Promise<boolean>;
     disableDevice(): Promise<boolean>;
     enableDevice(): Promise<boolean>;
     disconnect(): Promise<void>;

package/package.json

@@ -1,69 +1,70 @@
-{
-  "name": "zklib-ts",
-  "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",
-  "typings": "dist/index",
-  "types": "dist/index.d.ts",
-  "type": "commonjs",
-  "files": [
-    "dist/",
-    "README.md"
-  ],
-  "scripts": {
-    "test": "jest",
-    "build": "rollup -c",
-    "watch": "rollup -c --watch",
-    "prepare": "npm run build"
-  },
-  "repositoryUrl": "https://github.com/guspaz0/zklib-ts.git",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/guspaz0/zklib-ts.git"
-  },
-  "keywords": [
-    "typescript",
-    "javascript",
-    "jest",
-    "ip",
-    "libs",
-    "device",
-    "zkteco",
-    "address",
-    "realtime",
-    "real-time",
-    "biometric",
-    "attendance",
-    "biometric attendance",
-    "biometric attendance device"
-  ],
-  "author": "Gustavo Paz",
-  "license": "MIT",
-  "directories": {
-    "test": "tests"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-typescript": "^12.1.2",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.14",
-    "dotenv": "^16.4.7",
-    "jest": "30.2.0",
-    "rollup": "^4.37.0",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "ts-jest": "29.4.6",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.8.1",
-    "typescript": "^5.8.2"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  },
-  "precommit": [
-    "build"
-  ]
-}
+{
+  "name": "zklib-ts",
+  "version": "1.0.7",
+  "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",
+  "typings": "dist/index",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "repositoryUrl": "https://github.com/guspaz0/zklib-ts.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guspaz0/zklib-ts.git"
+  },
+  "keywords": [
+    "typescript",
+    "javascript",
+    "jest",
+    "ip",
+    "libs",
+    "device",
+    "zkteco",
+    "address",
+    "realtime",
+    "real-time",
+    "biometric",
+    "attendance",
+    "biometric attendance",
+    "biometric attendance device"
+  ],
+  "author": "Gustavo Paz",
+  "license": "MIT",
+  "directories": {
+    "test": "tests"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/jest": "^29.5.14",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.19.17",
+    "dotenv": "^16.4.7",
+    "jest": "30.2.0",
+    "rollup": "^4.37.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "ts-jest": "29.4.6",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "precommit": [
+    "build"
+  ],
+  "scripts": {
+    "test": "jest",
+    "build": "rollup -c",
+    "watch": "rollup -c --watch",
+    "lint": "eslint ."
+  }
+}