hik-iot-sdk 1.0.0

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

@@ -0,0 +1,270 @@
+import { z } from 'zod';
+export declare const TraceIdResponseSchema: 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 PersonValidSchema: z.ZodObject<{
+    enable: z.ZodBoolean;
+    beginTime: z.ZodString;
+    endTime: z.ZodString;
+    timeType: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    enable: boolean;
+    beginTime: string;
+    endTime: string;
+    timeType?: string | undefined;
+}, {
+    enable: boolean;
+    beginTime: string;
+    endTime: string;
+    timeType?: string | undefined;
+}>;
+export declare const PersonRightPlanSchema: z.ZodObject<{
+    doorNo: z.ZodNumber;
+    planTemplateNo: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    doorNo: number;
+    planTemplateNo: string;
+}, {
+    doorNo: number;
+    planTemplateNo: string;
+}>;
+export declare const PersonInfoSchema: z.ZodObject<{
+    employeeNo: z.ZodString;
+    name: z.ZodString;
+    userType: z.ZodString;
+    Valid: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodBoolean;
+        beginTime: z.ZodString;
+        endTime: z.ZodString;
+        timeType: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        enable: boolean;
+        beginTime: string;
+        endTime: string;
+        timeType?: string | undefined;
+    }, {
+        enable: boolean;
+        beginTime: string;
+        endTime: string;
+        timeType?: string | undefined;
+    }>>;
+    password: z.ZodOptional<z.ZodString>;
+    doorRight: z.ZodOptional<z.ZodString>;
+    RightPlan: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        doorNo: z.ZodNumber;
+        planTemplateNo: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        doorNo: number;
+        planTemplateNo: string;
+    }, {
+        doorNo: number;
+        planTemplateNo: string;
+    }>, "many">>;
+    maxOpenDoorTime: z.ZodOptional<z.ZodNumber>;
+    openDoorTime: z.ZodOptional<z.ZodNumber>;
+    numOfCard: z.ZodOptional<z.ZodNumber>;
+    numOfFP: z.ZodOptional<z.ZodNumber>;
+    numOfFace: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    employeeNo: string;
+    userType: string;
+    Valid?: {
+        enable: boolean;
+        beginTime: string;
+        endTime: string;
+        timeType?: string | undefined;
+    } | undefined;
+    password?: string | undefined;
+    doorRight?: string | undefined;
+    RightPlan?: {
+        doorNo: number;
+        planTemplateNo: string;
+    }[] | undefined;
+    maxOpenDoorTime?: number | undefined;
+    openDoorTime?: number | undefined;
+    numOfCard?: number | undefined;
+    numOfFP?: number | undefined;
+    numOfFace?: number | undefined;
+}, {
+    name: string;
+    employeeNo: string;
+    userType: string;
+    Valid?: {
+        enable: boolean;
+        beginTime: string;
+        endTime: string;
+        timeType?: string | undefined;
+    } | undefined;
+    password?: string | undefined;
+    doorRight?: string | undefined;
+    RightPlan?: {
+        doorNo: number;
+        planTemplateNo: string;
+    }[] | undefined;
+    maxOpenDoorTime?: number | undefined;
+    openDoorTime?: number | undefined;
+    numOfCard?: number | undefined;
+    numOfFP?: number | undefined;
+    numOfFace?: number | undefined;
+}>;
+export declare const SearchPersonResponseSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+    data: z.ZodArray<z.ZodObject<{
+        employeeNo: z.ZodString;
+        name: z.ZodString;
+        userType: z.ZodString;
+        Valid: z.ZodOptional<z.ZodObject<{
+            enable: z.ZodBoolean;
+            beginTime: z.ZodString;
+            endTime: z.ZodString;
+            timeType: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            enable: boolean;
+            beginTime: string;
+            endTime: string;
+            timeType?: string | undefined;
+        }, {
+            enable: boolean;
+            beginTime: string;
+            endTime: string;
+            timeType?: string | undefined;
+        }>>;
+        password: z.ZodOptional<z.ZodString>;
+        doorRight: z.ZodOptional<z.ZodString>;
+        RightPlan: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            doorNo: z.ZodNumber;
+            planTemplateNo: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            doorNo: number;
+            planTemplateNo: string;
+        }, {
+            doorNo: number;
+            planTemplateNo: string;
+        }>, "many">>;
+        maxOpenDoorTime: z.ZodOptional<z.ZodNumber>;
+        openDoorTime: z.ZodOptional<z.ZodNumber>;
+        numOfCard: z.ZodOptional<z.ZodNumber>;
+        numOfFP: z.ZodOptional<z.ZodNumber>;
+        numOfFace: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        employeeNo: string;
+        userType: string;
+        Valid?: {
+            enable: boolean;
+            beginTime: string;
+            endTime: string;
+            timeType?: string | undefined;
+        } | undefined;
+        password?: string | undefined;
+        doorRight?: string | undefined;
+        RightPlan?: {
+            doorNo: number;
+            planTemplateNo: string;
+        }[] | undefined;
+        maxOpenDoorTime?: number | undefined;
+        openDoorTime?: number | undefined;
+        numOfCard?: number | undefined;
+        numOfFP?: number | undefined;
+        numOfFace?: number | undefined;
+    }, {
+        name: string;
+        employeeNo: string;
+        userType: string;
+        Valid?: {
+            enable: boolean;
+            beginTime: string;
+            endTime: string;
+            timeType?: string | undefined;
+        } | undefined;
+        password?: string | undefined;
+        doorRight?: string | undefined;
+        RightPlan?: {
+            doorNo: number;
+            planTemplateNo: string;
+        }[] | undefined;
+        maxOpenDoorTime?: number | undefined;
+        openDoorTime?: number | undefined;
+        numOfCard?: number | undefined;
+        numOfFP?: number | undefined;
+        numOfFace?: number | undefined;
+    }>, "many">;
+    count: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    code: number;
+    msg: string;
+    data: {
+        name: string;
+        employeeNo: string;
+        userType: string;
+        Valid?: {
+            enable: boolean;
+            beginTime: string;
+            endTime: string;
+            timeType?: string | undefined;
+        } | undefined;
+        password?: string | undefined;
+        doorRight?: string | undefined;
+        RightPlan?: {
+            doorNo: number;
+            planTemplateNo: string;
+        }[] | undefined;
+        maxOpenDoorTime?: number | undefined;
+        openDoorTime?: number | undefined;
+        numOfCard?: number | undefined;
+        numOfFP?: number | undefined;
+        numOfFace?: number | undefined;
+    }[];
+    count: number;
+}, {
+    code: number;
+    msg: string;
+    data: {
+        name: string;
+        employeeNo: string;
+        userType: string;
+        Valid?: {
+            enable: boolean;
+            beginTime: string;
+            endTime: string;
+            timeType?: string | undefined;
+        } | undefined;
+        password?: string | undefined;
+        doorRight?: string | undefined;
+        RightPlan?: {
+            doorNo: number;
+            planTemplateNo: string;
+        }[] | undefined;
+        maxOpenDoorTime?: number | undefined;
+        openDoorTime?: number | undefined;
+        numOfCard?: number | undefined;
+        numOfFP?: number | undefined;
+        numOfFace?: number | undefined;
+    }[];
+    count: number;
+}>;

package/dist/modules/person/person.schema.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchPersonResponseSchema = exports.PersonInfoSchema = exports.PersonRightPlanSchema = exports.PersonValidSchema = exports.TraceIdResponseSchema = void 0;
+const zod_1 = require("zod");
+exports.TraceIdResponseSchema = 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.PersonValidSchema = zod_1.z.object({
+    enable: zod_1.z.boolean(),
+    beginTime: zod_1.z.string(),
+    endTime: zod_1.z.string(),
+    timeType: zod_1.z.string().optional(),
+});
+exports.PersonRightPlanSchema = zod_1.z.object({
+    doorNo: zod_1.z.number(),
+    planTemplateNo: zod_1.z.string(),
+});
+exports.PersonInfoSchema = zod_1.z.object({
+    employeeNo: zod_1.z.string(),
+    name: zod_1.z.string(),
+    userType: zod_1.z.string(),
+    Valid: exports.PersonValidSchema.optional(),
+    password: zod_1.z.string().optional(),
+    doorRight: zod_1.z.string().optional(),
+    RightPlan: zod_1.z.array(exports.PersonRightPlanSchema).optional(),
+    maxOpenDoorTime: zod_1.z.number().optional(),
+    openDoorTime: zod_1.z.number().optional(),
+    numOfCard: zod_1.z.number().optional(),
+    numOfFP: zod_1.z.number().optional(),
+    numOfFace: zod_1.z.number().optional(),
+});
+exports.SearchPersonResponseSchema = zod_1.z.object({
+    code: zod_1.z.number(),
+    msg: zod_1.z.string(),
+    data: zod_1.z.array(exports.PersonInfoSchema),
+    count: zod_1.z.number(),
+});

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

@@ -0,0 +1,16 @@
+import type { HttpClient } from '../../core/http';
+import type { CreatePersonInput, DeletePersonInput, BatchDeletePersonInput, SearchPersonInput, TraceIdResponse, PersonInfo } from './person.types';
+export declare class PersonService {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(input: CreatePersonInput): Promise<TraceIdResponse>;
+    update(input: CreatePersonInput): Promise<TraceIdResponse>;
+    delete(input: DeletePersonInput): Promise<TraceIdResponse>;
+    batchDelete(input: BatchDeletePersonInput): Promise<TraceIdResponse>;
+    search(input: SearchPersonInput): Promise<{
+        data: PersonInfo[];
+        count: number;
+    }>;
+    get(deviceSerial: string, employeeNo: string): Promise<PersonInfo | null>;
+    private formatDateTime;
+}

package/dist/modules/person/person.service.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonService = void 0;
+const person_schema_1 = require("./person.schema");
+class PersonService {
+    constructor(http) {
+        this.http = http;
+    }
+    async create(input) {
+        const { deviceSerial, employeeNo, name, userType = 'normal', permanentValid = false, enableBeginTime = this.formatDateTime(new Date()), enableEndTime = '2037-12-31T23:59:59', doorRight = [1], doorRightPlan = [{ doorNo: 1, planTemplateId: [1] }], password, maxOpenDoorTime, } = input;
+        const userInfo = {
+            employeeNo,
+            name,
+            userType,
+            permanentValid,
+            enableBeginTime,
+            enableEndTime,
+            doorRight,
+            doorRightPlan,
+        };
+        if (password !== undefined) {
+            userInfo.password = password;
+        }
+        if (maxOpenDoorTime !== undefined) {
+            userInfo.maxOpenDoorTime = maxOpenDoorTime;
+        }
+        const response = await this.http.post('/device/direct/v1/userInfo/addOneRecord', {
+            deviceSerial,
+            payload: { userInfo },
+        }, person_schema_1.TraceIdResponseSchema);
+        return response.data;
+    }
+    async update(input) {
+        return this.create(input);
+    }
+    async delete(input) {
+        const { deviceSerial, employeeNo } = input;
+        const response = await this.http.post('/device/direct/v1/userInfo/deleteByKey', {
+            deviceSerial,
+            payload: {
+                userInfo: { employeeNo },
+            },
+        }, person_schema_1.TraceIdResponseSchema);
+        return response.data;
+    }
+    async batchDelete(input) {
+        const { deviceSerial, employeeNos } = input;
+        if (employeeNos.length === 0) {
+            throw new Error('employeeNos cannot be empty');
+        }
+        const response = await this.http.post('/device/direct/v1/userInfo/batchDeleteByKey', {
+            deviceSerial,
+            payload: {
+                userInfo: employeeNos.map((employeeNo) => ({ employeeNo })),
+            },
+        }, person_schema_1.TraceIdResponseSchema);
+        return response.data;
+    }
+    async search(input) {
+        const { deviceSerial, page = 1, size = 20, keyword } = input;
+        const requestData = {
+            deviceSerial,
+            page,
+            size,
+        };
+        if (keyword) {
+            requestData.keyword = keyword;
+        }
+        const response = await this.http.post('/device/direct/v1/userInfo/search', requestData, person_schema_1.SearchPersonResponseSchema);
+        return {
+            data: response.data,
+            count: response.count,
+        };
+    }
+    async get(deviceSerial, employeeNo) {
+        const result = await this.search({
+            deviceSerial,
+            keyword: employeeNo,
+            size: 1,
+        });
+        return result.data.find((p) => p.employeeNo === employeeNo) ?? null;
+    }
+    formatDateTime(date) {
+        const pad = (n) => n.toString().padStart(2, '0');
+        return `${date.getFullYear()}-${pad(date.getMonth() + 1)}-${pad(date.getDate())}T${pad(date.getHours())}:${pad(date.getMinutes())}:${pad(date.getSeconds())}`;
+    }
+}
+exports.PersonService = PersonService;

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

@@ -0,0 +1,65 @@
+export type UserType = 'normal' | 'visitor' | 'blackList';
+export interface DoorRightPlan {
+    doorNo: number;
+    planTemplateId: number[];
+}
+export interface CreatePersonInput {
+    deviceSerial: string;
+    employeeNo: string;
+    name: string;
+    userType?: UserType;
+    permanentValid?: boolean;
+    enableBeginTime?: string;
+    enableEndTime?: string;
+    doorRight?: number[];
+    doorRightPlan?: DoorRightPlan[];
+    password?: string;
+    maxOpenDoorTime?: number;
+}
+export interface DeletePersonInput {
+    deviceSerial: string;
+    employeeNo: string;
+}
+export interface BatchDeletePersonInput {
+    deviceSerial: string;
+    employeeNos: string[];
+}
+export interface SearchPersonInput {
+    deviceSerial: string;
+    page?: number;
+    size?: number;
+    keyword?: string;
+}
+export interface PersonValid {
+    enable: boolean;
+    beginTime: string;
+    endTime: string;
+    timeType?: string;
+}
+export interface PersonRightPlan {
+    doorNo: number;
+    planTemplateNo: string;
+}
+export interface PersonInfo {
+    employeeNo: string;
+    name: string;
+    userType: string;
+    Valid?: PersonValid;
+    password?: string;
+    doorRight?: string;
+    RightPlan?: PersonRightPlan[];
+    maxOpenDoorTime?: number;
+    openDoorTime?: number;
+    numOfCard?: number;
+    numOfFP?: number;
+    numOfFace?: number;
+}
+export interface TraceIdResponse {
+    traceId: string;
+}
+export interface SearchPersonResponse {
+    code: number;
+    msg: string;
+    data: PersonInfo[];
+    count: number;
+}

package/dist/modules/person/person.types.js

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

package/dist/sdk.d.ts

@@ -0,0 +1,60 @@
+import { type HikSdkOptions } from './core/config';
+import { PersonService } from './modules/person/person.service';
+import { FaceService } from './modules/face/face.service';
+import { CardService } from './modules/card/card.service';
+import { DeviceService } from './modules/device/device.service';
+import { AccessService } from './modules/access/access.service';
+import type { DoorRightPlan } from './modules/person/person.types';
+export declare class HikSdk {
+    readonly person: PersonService;
+    readonly face: FaceService;
+    readonly card: CardService;
+    readonly device: DeviceService;
+    readonly access: AccessService;
+    private readonly config;
+    private readonly authManager;
+    private readonly httpClient;
+    constructor(options: HikSdkOptions);
+    getUserInfo(): {
+        teamNo: string;
+        personNo: string;
+        accountNo: string;
+    } | null;
+    createPersonWithFace(input: {
+        deviceSerial: string;
+        employeeNo: string;
+        name: string;
+        faceURL: string;
+        userType?: 'normal' | 'visitor' | 'blackList';
+        permanentValid?: boolean;
+        enableBeginTime?: string;
+        enableEndTime?: string;
+        doorRight?: number[];
+        doorRightPlan?: DoorRightPlan[];
+    }): Promise<{
+        personTraceId: string;
+        faceTraceId: string;
+    }>;
+    createPersonWithFaceAndCard(input: {
+        deviceSerial: string;
+        employeeNo: string;
+        name: string;
+        faceURL: string;
+        cardNo: string;
+        userType?: 'normal' | 'visitor' | 'blackList';
+        permanentValid?: boolean;
+        enableBeginTime?: string;
+        enableEndTime?: string;
+        doorRight?: number[];
+        doorRightPlan?: DoorRightPlan[];
+        cardType?: 'normalCard' | 'patrolCard' | 'hijackCard' | 'superCard' | 'dismissingCard' | 'emergencyCard';
+    }): Promise<{
+        personTraceId: string;
+        faceTraceId: string;
+        cardTraceId: string;
+    }>;
+    deletePersonComplete(deviceSerial: string, employeeNo: string): Promise<{
+        faceTraceId?: string;
+        personTraceId: string;
+    }>;
+}

package/dist/sdk.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HikSdk = void 0;
+const config_1 = require("./core/config");
+const auth_1 = require("./core/auth");
+const http_1 = require("./core/http");
+const person_service_1 = require("./modules/person/person.service");
+const face_service_1 = require("./modules/face/face.service");
+const card_service_1 = require("./modules/card/card.service");
+const device_service_1 = require("./modules/device/device.service");
+const access_service_1 = require("./modules/access/access.service");
+const DEFAULT_REDIRECT_URL = 'https://iot.alan.fit/api/hik/callback';
+class HikSdk {
+    constructor(options) {
+        this.config = config_1.HikConfigSchema.parse({
+            appKey: options.appKey,
+            appSecret: options.appSecret,
+            baseUrl: options.baseUrl ?? 'https://open-api.hikiot.com',
+            enableEncrypt: options.enableEncrypt ?? true, // 海康互联默认开启加密
+            timeout: options.timeout ?? 30000,
+        });
+        this.authManager = new auth_1.AuthManager(this.config, {
+            userName: options.userName,
+            password: options.password,
+            redirectUrl: options.redirectUrl ?? DEFAULT_REDIRECT_URL,
+        });
+        this.httpClient = new http_1.HttpClient(this.config, this.authManager);
+        this.person = new person_service_1.PersonService(this.httpClient);
+        this.face = new face_service_1.FaceService(this.httpClient);
+        this.card = new card_service_1.CardService(this.httpClient);
+        this.device = new device_service_1.DeviceService(this.httpClient);
+        this.access = new access_service_1.AccessService(this.httpClient);
+    }
+    getUserInfo() {
+        return this.authManager.getUserInfo();
+    }
+    async createPersonWithFace(input) {
+        const { deviceSerial, employeeNo, name, faceURL, userType, permanentValid, enableBeginTime, enableEndTime, doorRight, doorRightPlan, } = input;
+        const personResult = await this.person.create({
+            deviceSerial,
+            employeeNo,
+            name,
+            userType,
+            permanentValid,
+            enableBeginTime,
+            enableEndTime,
+            doorRight,
+            doorRightPlan,
+        });
+        const faceResult = await this.face.add({
+            deviceSerial,
+            employeeNo,
+            faceURL,
+        });
+        return {
+            personTraceId: personResult.traceId,
+            faceTraceId: faceResult.traceId,
+        };
+    }
+    async createPersonWithFaceAndCard(input) {
+        const { deviceSerial, employeeNo, name, faceURL, cardNo, userType, permanentValid, enableBeginTime, enableEndTime, doorRight, doorRightPlan, cardType, } = input;
+        const personResult = await this.person.create({
+            deviceSerial,
+            employeeNo,
+            name,
+            userType,
+            permanentValid,
+            enableBeginTime,
+            enableEndTime,
+            doorRight,
+            doorRightPlan,
+        });
+        const faceResult = await this.face.add({
+            deviceSerial,
+            employeeNo,
+            faceURL,
+        });
+        const cardResult = await this.card.add({
+            deviceSerial,
+            employeeNo,
+            cardNo,
+            cardType,
+        });
+        return {
+            personTraceId: personResult.traceId,
+            faceTraceId: faceResult.traceId,
+            cardTraceId: cardResult.traceId,
+        };
+    }
+    async deletePersonComplete(deviceSerial, employeeNo) {
+        let faceTraceId;
+        try {
+            const faceResult = await this.face.delete({ deviceSerial, employeeNo });
+            faceTraceId = faceResult.traceId;
+        }
+        catch {
+            // Face may not exist, ignore
+        }
+        const personResult = await this.person.delete({ deviceSerial, employeeNo });
+        return {
+            faceTraceId,
+            personTraceId: personResult.traceId,
+        };
+    }
+}
+exports.HikSdk = HikSdk;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "hik-iot-sdk",
+  "version": "1.0.0",
+  "description": "Hikvision IoT Node.js SDK",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "demo": "tsx examples/face-access-demo.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "axios": "^0.27.0",
+    "node-forge": "^1.3.0",
+    "pino": "^8.0.0",
+    "zod": "^3.20.0"
+  },
+  "devDependencies": {
+    "@types/node": "^14.18.0",
+    "@types/node-forge": "^1.3.14",
+    "typescript": "^5.0.0"
+  }
+}