zklib-ts 1.0.5 → 1.0.6

package/dist/index.d.ts

@@ -46,8 +46,19 @@ export default class Zklib {
     getFaceOn(): Promise<string>;
     getSSR(): Promise<string>;
     getFirmware(): Promise<string>;
-    setUser(uid: number, userid: string, name: string, password: string, role?: number, cardno?: number): Promise<boolean>;
-    deleteUser(uid: number): Promise<boolean>;
+    /** Update or create a user if user id/pin not exists
+     * @param user_id {string} user id/pin for customer
+     * @param name {string} user name
+     * @param password {string} user password
+     * @param role {number} role/privilege id number
+     * @param cardno {number} card number/id
+     */
+    setUser(user_id: string, name: string, password: string, role?: number, cardno?: number): Promise<boolean>;
+    /**
+     * Delete user by a given user id/pin
+     * @param user_id {string}
+     */
+    deleteUser(user_id: string): Promise<boolean>;
     getAttendanceSize(): Promise<number>;
     getAttendances(cb?: (progress: number, total: number) => void): Promise<{
         data: Attendance[] | RecordData16[];
@@ -55,10 +66,40 @@ export default class Zklib {
     }>;
     getRealTimeLogs(cb: (log: any) => void): Promise<void>;
     getTemplates(): Promise<Record<string, Finger[]>>;
-    saveUserTemplate(user: User, fingers?: Finger[]): Promise<void>;
-    deleteFinger(uid: number, fid: number): Promise<boolean>;
-    enrollUser(uid: number, temp_id: number, user_id: string): Promise<boolean>;
-    verifyUser(uid: number): Promise<boolean>;
+    /**
+     * Get a user template for a given user id/pin and finger id
+     * @param user_id {string} user id/pin
+     * @param fid {number} finger index
+     */
+    getUserTemplate(user_id: string, fid: number): Promise<Buffer<ArrayBufferLike>>;
+    /**
+     * Upload a single fingerprint for a given user id
+     * @param user_id {string} user id/pin 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>;
+    /**
+     * save user and template
+     *
+     * @param {string} user_id - user id for customer
+     * @param {Finger[]} fingers - Array of finger class
+     */
+    saveUserTemplate(user_id: string, fingers?: Finger[]): Promise<void>;
+    /**
+     * Delete a single finger template by user id and finger index
+     * @param user_id {string} user id/pin for customer
+     * @param fid {number} finger index
+     */
+    deleteFinger(user_id?: string, fid?: number): Promise<boolean>;
+    /**
+     * Start to enroll a finger template
+     * @param user_id {string} user id/pin for customer
+     * @param temp_id {number} finger index
+     */
+    enrollUser(user_id: string, temp_id: number): Promise<boolean>;
+    verifyUser(user_id: string): Promise<boolean>;
     restartDevice(): Promise<void>;
     getSizes(): Promise<FreeSizes>;
     disconnect(): Promise<void>;