SkyEye-SVC-Common-Utils

This is the common utils for SkyEye service projects, It includes multiple utils, middilewares, authentications, some common interfaces.

GRPC

This command to build .proto files for Typescript used.

• protoc --proto_path=./ grpcProtos/sample.proto --js_out=import_style=commonjs,binary:. --ts_out=service=true:.

Please make sure run the npm run build before push changes

Command to run test

npm run test

Command to run code coverage

npm run coverage

Note

• don't push the .nyc_output\xx\xx.json and coverage file to github
• upload all the file from report folder

Permissions

When add new permissions, please avoid duplication, value for permission list : permissionCode: <ServiceName>_<HTTP Method>_<Controller>_<Action> permissionLabel: any name you want to show to frontend for easy recognise permissionDesc: short description on what this permission can do permissionMethod: The http Method: GET/POST/PUT/DELETE , uppercase only permissionUrl: the Path for this permission. /<Controller>/<Action> allowAnonymous: whether this path is able to access by anyone