zklib-ts 1.0.5 → 1.0.6

package/dist/models/Attendance.d.ts

@@ -1,9 +1,14 @@
 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/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: any[];
+    }>;
+    setUser(user_id: string, name: string, password: string, role?: number, cardno?: number): Promise<boolean>;
+    DeleteUser(user_id: string): Promise<boolean>;
+    getTemplates(callbackInProcess?: any): Promise<Record<string, Finger[]>>;
+    DownloadFp(user_id: string, fid: number): Promise<Buffer>;
+    /**
+     *
+     * @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<boolean>;
+    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,7 +1,8 @@
 import { Socket } from 'net';
 import { RealTimeLog } from './helper/utils';
 import { Finger } from './models/Finger';
-import { User } from './models/User';
+import { UserService } from "./services/user.service";
+import { TransactionService } from "./services/transaction.service";
 export declare class ZTCP {
     /**
     * @param_ip ip address of device
@@ -10,15 +11,15 @@ export declare class ZTCP {
     * @param_comm_key communication key of device (if the case)
     * @return Zkteco TCP socket connection instance
     */
-    private ip;
+    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,10 +31,12 @@ 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;
+    _userService: UserService;
+    _transactionService: TransactionService;
     constructor(ip: string, port: number, timeout: number, comm_key: number, verbose: boolean);
     createSocket(cbError: any, cbClose: any): Promise<unknown>;
     connect(): Promise<boolean>;
@@ -59,16 +62,8 @@ export declare class ZTCP {
      * 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[];
-    }>;
     /**
      *
-     * @param {*} ip
      * @param {*} callbackInProcess
      *  reject error when starting request data
      *  return { data: records, err: Error } when receiving requested data
@@ -122,11 +117,18 @@ export declare class ZTCP {
     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 +143,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 +151,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

@@ -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,6 +1,6 @@
 {
   "name": "zklib-ts",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "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",