zklib-ts 1.0.6 → 1.0.8

package/dist/models/Attendance.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents an Attendance Records
+ */
 export declare class Attendance {
     /** Internal serial number for the user */
     sn: 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

@@ -1,4 +1,4 @@
-import { ZTCP } from "../ztcp";
+import { ZTCP } from '../ztcp';
 export declare class TransactionService {
     _zkTcp: ZTCP;
     constructor(zkTcp: ZTCP);

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

@@ -7,12 +7,12 @@ export declare class UserService {
     constructor(zkTcp: ZTCP);
     getUserByUserId(user_id: string): Promise<User>;
     getUsers(): Promise<{
-        data: any[];
+        data: User[];
     }>;
     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>;
+    getTemplates(cb?: Function): Promise<Record<string, Finger[]>>;
+    DownloadFp(user_id: string, fid: number): Promise<Finger>;
     /**
      *
      * @param user_id {string} user
@@ -20,7 +20,7 @@ export declare class UserService {
      * */
     saveTemplates(user_id: string, fingers?: Finger[]): Promise<void>;
     deleteFinger(user_id?: string, fid?: number): Promise<boolean>;
-    enrollInfo(user_id: string, tempId: 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