hik-iot-sdk 1.0.0

package/dist/modules/device/device.schema.d.ts

@@ -0,0 +1,258 @@
+import { z } from 'zod';
+export declare const DeviceTraceIdResponseSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+    data: z.ZodObject<{
+        traceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        traceId: string;
+    }, {
+        traceId: string;
+    }>;
+    detail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    code: number;
+    msg: string;
+    data: {
+        traceId: string;
+    };
+    detail?: string | null | undefined;
+}, {
+    code: number;
+    msg: string;
+    data: {
+        traceId: string;
+    };
+    detail?: string | null | undefined;
+}>;
+export declare const StorageCountSchema: z.ZodObject<{
+    count: z.ZodNumber;
+    maxNum: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    count: number;
+    maxNum: number;
+}, {
+    count: number;
+    maxNum: number;
+}>;
+export declare const StorageCountResponseSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+    data: z.ZodObject<{
+        UserInfo: z.ZodOptional<z.ZodObject<{
+            count: z.ZodNumber;
+            maxNum: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            maxNum: number;
+        }, {
+            count: number;
+            maxNum: number;
+        }>>;
+        FaceAccess: z.ZodOptional<z.ZodObject<{
+            count: z.ZodNumber;
+            maxNum: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            maxNum: number;
+        }, {
+            count: number;
+            maxNum: number;
+        }>>;
+        CardInfo: z.ZodOptional<z.ZodObject<{
+            count: z.ZodNumber;
+            maxNum: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            maxNum: number;
+        }, {
+            count: number;
+            maxNum: number;
+        }>>;
+        FingerPrint: z.ZodOptional<z.ZodObject<{
+            count: z.ZodNumber;
+            maxNum: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            maxNum: number;
+        }, {
+            count: number;
+            maxNum: number;
+        }>>;
+        AcsEvent: z.ZodOptional<z.ZodObject<{
+            count: z.ZodNumber;
+            maxNum: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            maxNum: number;
+        }, {
+            count: number;
+            maxNum: number;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        UserInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FaceAccess?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        CardInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FingerPrint?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        AcsEvent?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+    }, {
+        UserInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FaceAccess?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        CardInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FingerPrint?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        AcsEvent?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    code: number;
+    msg: string;
+    data: {
+        UserInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FaceAccess?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        CardInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FingerPrint?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        AcsEvent?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+    };
+}, {
+    code: number;
+    msg: string;
+    data: {
+        UserInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FaceAccess?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        CardInfo?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        FingerPrint?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+        AcsEvent?: {
+            count: number;
+            maxNum: number;
+        } | undefined;
+    };
+}>;
+export declare const DoorStatusResponseSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+    data: z.ZodObject<{
+        doorLockStatus: z.ZodArray<z.ZodString, "many">;
+        magneticStatus: z.ZodArray<z.ZodString, "many">;
+        doorStatus: z.ZodArray<z.ZodString, "many">;
+        antiSneakStatus: z.ZodOptional<z.ZodString>;
+        hostAntiDismantleStatus: z.ZodOptional<z.ZodString>;
+        cardReaderOnlineStatus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        cardReaderAntiDismantleStatus: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        cardReaderVerifyMode: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        netStatus: z.ZodOptional<z.ZodString>;
+        ezvizStatus: z.ZodOptional<z.ZodString>;
+        wifiStatus: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        doorLockStatus: string[];
+        magneticStatus: string[];
+        doorStatus: string[];
+        antiSneakStatus?: string | undefined;
+        hostAntiDismantleStatus?: string | undefined;
+        cardReaderOnlineStatus?: string[] | undefined;
+        cardReaderAntiDismantleStatus?: string[] | undefined;
+        cardReaderVerifyMode?: string[] | undefined;
+        netStatus?: string | undefined;
+        ezvizStatus?: string | undefined;
+        wifiStatus?: string | undefined;
+    }, {
+        doorLockStatus: string[];
+        magneticStatus: string[];
+        doorStatus: string[];
+        antiSneakStatus?: string | undefined;
+        hostAntiDismantleStatus?: string | undefined;
+        cardReaderOnlineStatus?: string[] | undefined;
+        cardReaderAntiDismantleStatus?: string[] | undefined;
+        cardReaderVerifyMode?: string[] | undefined;
+        netStatus?: string | undefined;
+        ezvizStatus?: string | undefined;
+        wifiStatus?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    code: number;
+    msg: string;
+    data: {
+        doorLockStatus: string[];
+        magneticStatus: string[];
+        doorStatus: string[];
+        antiSneakStatus?: string | undefined;
+        hostAntiDismantleStatus?: string | undefined;
+        cardReaderOnlineStatus?: string[] | undefined;
+        cardReaderAntiDismantleStatus?: string[] | undefined;
+        cardReaderVerifyMode?: string[] | undefined;
+        netStatus?: string | undefined;
+        ezvizStatus?: string | undefined;
+        wifiStatus?: string | undefined;
+    };
+}, {
+    code: number;
+    msg: string;
+    data: {
+        doorLockStatus: string[];
+        magneticStatus: string[];
+        doorStatus: string[];
+        antiSneakStatus?: string | undefined;
+        hostAntiDismantleStatus?: string | undefined;
+        cardReaderOnlineStatus?: string[] | undefined;
+        cardReaderAntiDismantleStatus?: string[] | undefined;
+        cardReaderVerifyMode?: string[] | undefined;
+        netStatus?: string | undefined;
+        ezvizStatus?: string | undefined;
+        wifiStatus?: string | undefined;
+    };
+}>;

package/dist/modules/device/device.schema.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DoorStatusResponseSchema = exports.StorageCountResponseSchema = exports.StorageCountSchema = exports.DeviceTraceIdResponseSchema = void 0;
+const zod_1 = require("zod");
+exports.DeviceTraceIdResponseSchema = zod_1.z.object({
+    code: zod_1.z.number(),
+    msg: zod_1.z.string(),
+    data: zod_1.z.object({
+        traceId: zod_1.z.string(),
+    }),
+    detail: zod_1.z.string().nullable().optional(),
+});
+exports.StorageCountSchema = zod_1.z.object({
+    count: zod_1.z.number(),
+    maxNum: zod_1.z.number(),
+});
+exports.StorageCountResponseSchema = zod_1.z.object({
+    code: zod_1.z.number(),
+    msg: zod_1.z.string(),
+    data: zod_1.z.object({
+        UserInfo: exports.StorageCountSchema.optional(),
+        FaceAccess: exports.StorageCountSchema.optional(),
+        CardInfo: exports.StorageCountSchema.optional(),
+        FingerPrint: exports.StorageCountSchema.optional(),
+        AcsEvent: exports.StorageCountSchema.optional(),
+    }),
+});
+exports.DoorStatusResponseSchema = zod_1.z.object({
+    code: zod_1.z.number(),
+    msg: zod_1.z.string(),
+    data: zod_1.z.object({
+        doorLockStatus: zod_1.z.array(zod_1.z.string()),
+        magneticStatus: zod_1.z.array(zod_1.z.string()),
+        doorStatus: zod_1.z.array(zod_1.z.string()),
+        antiSneakStatus: zod_1.z.string().optional(),
+        hostAntiDismantleStatus: zod_1.z.string().optional(),
+        cardReaderOnlineStatus: zod_1.z.array(zod_1.z.string()).optional(),
+        cardReaderAntiDismantleStatus: zod_1.z.array(zod_1.z.string()).optional(),
+        cardReaderVerifyMode: zod_1.z.array(zod_1.z.string()).optional(),
+        netStatus: zod_1.z.string().optional(),
+        ezvizStatus: zod_1.z.string().optional(),
+        wifiStatus: zod_1.z.string().optional(),
+    }),
+});

package/dist/modules/device/device.service.d.ts

@@ -0,0 +1,14 @@
+import type { HttpClient } from '../../core/http';
+import type { RemoteControlDoorInput, GetDoorStatusInput, GetStorageCountInput, ClearStorageInput, DoorStatusResponse, StorageCountResponse, DeviceTraceIdResponse } from './device.types';
+export declare class DeviceService {
+    private readonly http;
+    constructor(http: HttpClient);
+    remoteControlDoor(input: RemoteControlDoorInput): Promise<DeviceTraceIdResponse>;
+    openDoor(deviceSerial: string, doorNo?: number): Promise<DeviceTraceIdResponse>;
+    closeDoor(deviceSerial: string, doorNo?: number): Promise<DeviceTraceIdResponse>;
+    setDoorAlwaysOpen(deviceSerial: string, doorNo?: number): Promise<DeviceTraceIdResponse>;
+    setDoorAlwaysClose(deviceSerial: string, doorNo?: number): Promise<DeviceTraceIdResponse>;
+    getDoorStatus(input: GetDoorStatusInput): Promise<DoorStatusResponse>;
+    getStorageCount(input: GetStorageCountInput): Promise<StorageCountResponse>;
+    clearStorage(input: ClearStorageInput): Promise<void>;
+}

package/dist/modules/device/device.service.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceService = void 0;
+const device_schema_1 = require("./device.schema");
+class DeviceService {
+    constructor(http) {
+        this.http = http;
+    }
+    async remoteControlDoor(input) {
+        const { deviceSerial, cmd, doorNo = 1, controlType = 'monitor', channelNo = 1, } = input;
+        const response = await this.http.post('/device/direct/v1/doorControl/remoteControlDoor', {
+            deviceSerial,
+            payload: {
+                cmd,
+                doorNo,
+                controlType,
+                channelNo,
+            },
+        }, device_schema_1.DeviceTraceIdResponseSchema);
+        return response.data;
+    }
+    async openDoor(deviceSerial, doorNo = 1) {
+        return this.remoteControlDoor({
+            deviceSerial,
+            cmd: 'open',
+            doorNo,
+        });
+    }
+    async closeDoor(deviceSerial, doorNo = 1) {
+        return this.remoteControlDoor({
+            deviceSerial,
+            cmd: 'close',
+            doorNo,
+        });
+    }
+    async setDoorAlwaysOpen(deviceSerial, doorNo = 1) {
+        return this.remoteControlDoor({
+            deviceSerial,
+            cmd: 'alwaysOpen',
+            doorNo,
+        });
+    }
+    async setDoorAlwaysClose(deviceSerial, doorNo = 1) {
+        return this.remoteControlDoor({
+            deviceSerial,
+            cmd: 'alwaysClose',
+            doorNo,
+        });
+    }
+    async getDoorStatus(input) {
+        const { deviceSerial } = input;
+        const response = await this.http.post('/device/direct/v1/acsWorkStatus/getAttrs', { deviceSerial }, device_schema_1.DoorStatusResponseSchema);
+        return response.data;
+    }
+    async getStorageCount(input) {
+        const { deviceSerial } = input;
+        const response = await this.http.post('/device/direct/v1/acsStorage/count', { deviceSerial }, device_schema_1.StorageCountResponseSchema);
+        return response.data;
+    }
+    async clearStorage(input) {
+        const { deviceSerial, opts } = input;
+        const requestData = { deviceSerial };
+        if (opts && opts.length > 0) {
+            requestData.opts = opts;
+        }
+        await this.http.post('/device/direct/v1/acsStorage/clear', requestData);
+    }
+}
+exports.DeviceService = DeviceService;

package/dist/modules/device/device.types.d.ts

@@ -0,0 +1,46 @@
+export type DoorControlCmd = 'open' | 'close' | 'alwaysOpen' | 'alwaysClose' | 'visitorCallLadder' | 'householdCallLadder';
+export type ControlType = 'monitor' | 'calling';
+export interface RemoteControlDoorInput {
+    deviceSerial: string;
+    cmd: DoorControlCmd;
+    doorNo?: number;
+    controlType?: ControlType;
+    channelNo?: number;
+}
+export interface GetDoorStatusInput {
+    deviceSerial: string;
+}
+export interface GetStorageCountInput {
+    deviceSerial: string;
+}
+export interface ClearStorageInput {
+    deviceSerial: string;
+    opts?: Array<'supportUserInfo' | 'supportCardInfo' | 'supportFingerPrintCfg' | 'supportDoorStatusPlanTemplate' | 'supportHealthCodeCfg'>;
+}
+export interface DoorStatusResponse {
+    doorLockStatus: string[];
+    magneticStatus: string[];
+    doorStatus: string[];
+    antiSneakStatus?: string;
+    hostAntiDismantleStatus?: string;
+    cardReaderOnlineStatus?: string[];
+    cardReaderAntiDismantleStatus?: string[];
+    cardReaderVerifyMode?: string[];
+    netStatus?: string;
+    ezvizStatus?: string;
+    wifiStatus?: string;
+}
+export interface StorageCount {
+    count: number;
+    maxNum: number;
+}
+export interface StorageCountResponse {
+    UserInfo?: StorageCount;
+    FaceAccess?: StorageCount;
+    CardInfo?: StorageCount;
+    FingerPrint?: StorageCount;
+    AcsEvent?: StorageCount;
+}
+export interface DeviceTraceIdResponse {
+    traceId: string;
+}

package/dist/modules/device/device.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/face/face.schema.d.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+export declare const FaceTraceIdResponseSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+    data: z.ZodObject<{
+        traceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        traceId: string;
+    }, {
+        traceId: string;
+    }>;
+    detail: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    code: number;
+    msg: string;
+    data: {
+        traceId: string;
+    };
+    detail?: string | null | undefined;
+}, {
+    code: number;
+    msg: string;
+    data: {
+        traceId: string;
+    };
+    detail?: string | null | undefined;
+}>;

package/dist/modules/face/face.schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FaceTraceIdResponseSchema = void 0;
+const zod_1 = require("zod");
+exports.FaceTraceIdResponseSchema = zod_1.z.object({
+    code: zod_1.z.number(),
+    msg: zod_1.z.string(),
+    data: zod_1.z.object({
+        traceId: zod_1.z.string(),
+    }),
+    detail: zod_1.z.string().nullable().optional(),
+});

package/dist/modules/face/face.service.d.ts

@@ -0,0 +1,9 @@
+import type { HttpClient } from '../../core/http';
+import type { AddFaceInput, DeleteFaceInput, FaceTraceIdResponse } from './face.types';
+export declare class FaceService {
+    private readonly http;
+    constructor(http: HttpClient);
+    add(input: AddFaceInput): Promise<FaceTraceIdResponse>;
+    update(input: AddFaceInput): Promise<FaceTraceIdResponse>;
+    delete(input: DeleteFaceInput): Promise<FaceTraceIdResponse>;
+}

package/dist/modules/face/face.service.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FaceService = void 0;
+const face_schema_1 = require("./face.schema");
+class FaceService {
+    constructor(http) {
+        this.http = http;
+    }
+    async add(input) {
+        const { deviceSerial, employeeNo, faceURL, faceLibType = 'blackFD', faceDbId = '1', } = input;
+        const response = await this.http.post('/device/direct/v1/faceAccess/addOneRecord', {
+            deviceSerial,
+            payload: {
+                faceInfo: {
+                    employeeNo,
+                    faceURL,
+                    faceLibType,
+                    faceDbId,
+                },
+            },
+        }, face_schema_1.FaceTraceIdResponseSchema);
+        return response.data;
+    }
+    async update(input) {
+        return this.add(input);
+    }
+    async delete(input) {
+        const { deviceSerial, employeeNo, faceLibType = 'blackFD', faceDbId = '1', } = input;
+        const response = await this.http.post('/device/direct/v1/faceAccess/deleteByKey', {
+            deviceSerial,
+            payload: {
+                faceInfo: {
+                    employeeNo,
+                    faceDbId,
+                    faceLibType,
+                },
+            },
+        }, face_schema_1.FaceTraceIdResponseSchema);
+        return response.data;
+    }
+}
+exports.FaceService = FaceService;

package/dist/modules/face/face.types.d.ts

@@ -0,0 +1,17 @@
+export type FaceLibType = 'blackFD' | 'staticFD';
+export interface AddFaceInput {
+    deviceSerial: string;
+    employeeNo: string;
+    faceURL: string;
+    faceLibType?: FaceLibType;
+    faceDbId?: string;
+}
+export interface DeleteFaceInput {
+    deviceSerial: string;
+    employeeNo: string;
+    faceLibType?: FaceLibType;
+    faceDbId?: string;
+}
+export interface FaceTraceIdResponse {
+    traceId: string;
+}

package/dist/modules/face/face.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });