skyeye-svc-common-utils 1.0.136 → 1.0.138

package/.env

@@ -1,3 +1,3 @@
-PUBLIC_JWT_SECRET=unittest
-USER_PUBLIC_RETRIEVE = usersvc
+PUBLIC_JWT_SECRET=unittest
+USER_PUBLIC_RETRIEVE = usersvc
 USER_INTERNAL_RETRIEVE = usersvc

package/.github/dependabot.yml

@@ -1,18 +1,18 @@
-# for more information, see https://dependabot.com
-# for more settings, see https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates#commit-message
-
-version: 2
-updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  target-branch: "master"
-  open-pull-requests-limit: 1
-  reviewers:
-  - dexterchang-tw
-  - Clifford-Liu
-  - Steven-h3
-  - sophia6734wu
-  allow:
+# for more information, see https://dependabot.com
+# for more settings, see https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates#commit-message
+
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  target-branch: "master"
+  open-pull-requests-limit: 1
+  reviewers:
+  - dexterchang-tw
+  - Clifford-Liu
+  - Steven-h3
+  - sophia6734wu
+  allow:
   - dependency-name: skyeye-common-const

package/.vscode/settings.json

@@ -1,25 +1,25 @@
-{
-    "cSpell.words": [
-        "APIKEY",
-        "DELINK",
-        "ICBSECTOR",
-        "KEYVAULT",
-        "NERL",
-        "RBAC",
-        "SCOUTAI",
-        "SCOUTAIRESULT",
-        "TAASCONFIG",
-        "blobstorage",
-        "guids",
-        "mutex",
-        "openapi",
-        "organisation",
-        "printf",
-        "proto",
-        "protobuf",
-        "skyeye",
-        "startdb",
-        "tada",
-        "typeorm"
-    ]
+{
+    "cSpell.words": [
+        "APIKEY",
+        "DELINK",
+        "ICBSECTOR",
+        "KEYVAULT",
+        "NERL",
+        "RBAC",
+        "SCOUTAI",
+        "SCOUTAIRESULT",
+        "TAASCONFIG",
+        "blobstorage",
+        "guids",
+        "mutex",
+        "openapi",
+        "organisation",
+        "printf",
+        "proto",
+        "protobuf",
+        "skyeye",
+        "startdb",
+        "tada",
+        "typeorm"
+    ]
 }

package/README.md

@@ -1,30 +1,30 @@
-# 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
+# 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

package/package.json

@@ -1,83 +1,83 @@
-{
-  "name": "skyeye-svc-common-utils",
-  "version": "1.0.136",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc -p ./tsconfig.json",
-    "clean": "rm -rf node_modules log",
-    "cleanPublish": "npm i && npm run build && npm run clean && npm publish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils.git"
-  },
-  "author": "",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils/issues"
-  },
-  "homepage": "https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils#readme",
-  "dependencies": {
-    "@azure/data-tables": "^13.2.2",
-    "@azure/identity": "4.4.1",
-    "@azure/keyvault-secrets": "4.8.0",
-    "@azure/service-bus": "7.9.1",
-    "@azure/storage-blob": "12.27.0",
-    "@azure/storage-queue": "^12.0.2",
-    "@azure/core-rest-pipeline": "1.12.2",
-    "@azure/core-lro": "2.6.0",
-    "@azure/logger": "1.0.4",
-    "@sendgrid/client": "^8.1.3",
-    "@sendgrid/helpers": "^8.0.0",
-    "@sendgrid/mail": "^7.7.0",
-    "@types/chai": "^4.2.11",
-    "@types/express": "4.17.14",
-    "@types/express-serve-static-core": "4.17.30",
-    "@types/google-protobuf": "^3.7.2",
-    "@types/ioredis": "^4.26.4",
-    "@types/jsonwebtoken": "^9.0.0",
-    "@types/lodash": "4.14.182",
-    "@types/swagger-jsdoc": "^3.0.2",
-    "@types/swagger-ui-express": "^4.1.1",
-    "async-mutex": "^0.3.2",
-    "cron-parser": "4.8.1",
-    "dateformat": "^3.0.3",
-    "debug": "^4.1.1",
-    "dotenv": "^8.2.0",
-    "elastic-apm-node": "^3.5.0",
-    "express": "^4.17.1",
-    "http-errors": "^1.7.3",
-    "https": "^1.0.0",
-    "ioredis": "^4.27.6",
-    "jsonwebtoken": "^9.0.0",
-    "logform": "2.4.2",
-    "moment": "^2.24.0",
-    "morgan": "^1.9.1",
-    "node-fetch": "^2.6.0",
-    "nyc": "^15.1.0",
-    "rotating-file-stream": "^1.4.6",
-    "skyeye-common-const": "1.0.89",
-    "swagger-jsdoc": "^3.5.0",
-    "swagger-ui-express": "^4.1.3",
-    "ts-node": "^9.0.0",
-    "typeorm": "^0.2.20",
-    "@types/tedious": "^18.0.0",
-    "tedious": "^18.6.1",
-    "typescript": "^4.8.4",
-    "uuid": "^3.3.3",
-    "winston": "^3.2.1",
-    "winston-daily-rotate-file": "^4.2.1",
-    "follow-redirects": "^1.15.6"
-  },
-  "devDependencies": {
-    "@types/dateformat": "^3.0.1",
-    "@types/debug": "~4.1.5",
-    "@types/http-errors": "~1.6.1",
-    "@types/morgan": "~1.7.37",
-    "@types/node": "^14.0.27",
-    "@types/node-fetch": "^2.5.3",
-    "@types/uuid": "^3.4.6"
-  }
-}
+{
+  "name": "skyeye-svc-common-utils",
+  "version": "1.0.138",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p ./tsconfig.json",
+    "clean": "rm -rf node_modules log",
+    "cleanPublish": "npm i && npm run build && npm run clean && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils/issues"
+  },
+  "homepage": "https://github.com/HandshakesByDC/SkyEye-SVC-Common-Utils#readme",
+  "dependencies": {
+    "@azure/data-tables": "^13.2.2",
+    "@azure/identity": "4.4.1",
+    "@azure/keyvault-secrets": "4.8.0",
+    "@azure/service-bus": "7.9.1",
+    "@azure/storage-blob": "12.27.0",
+    "@azure/storage-queue": "^12.0.2",
+    "@azure/core-rest-pipeline": "1.12.2",
+    "@azure/core-lro": "2.6.0",
+    "@azure/logger": "1.0.4",
+    "@sendgrid/client": "^8.1.3",
+    "@sendgrid/helpers": "^8.0.0",
+    "@sendgrid/mail": "^7.7.0",
+    "@types/chai": "^4.2.11",
+    "@types/express": "4.17.14",
+    "@types/express-serve-static-core": "4.17.30",
+    "@types/google-protobuf": "^3.7.2",
+    "@types/ioredis": "^4.26.4",
+    "@types/jsonwebtoken": "^9.0.0",
+    "@types/lodash": "4.14.182",
+    "@types/swagger-jsdoc": "^3.0.2",
+    "@types/swagger-ui-express": "^4.1.1",
+    "async-mutex": "^0.3.2",
+    "cron-parser": "4.8.1",
+    "dateformat": "^3.0.3",
+    "debug": "^4.1.1",
+    "dotenv": "^8.2.0",
+    "elastic-apm-node": "^3.5.0",
+    "express": "^4.17.1",
+    "http-errors": "^1.7.3",
+    "https": "^1.0.0",
+    "ioredis": "^4.27.6",
+    "jsonwebtoken": "^9.0.0",
+    "logform": "2.4.2",
+    "moment": "^2.24.0",
+    "morgan": "^1.9.1",
+    "node-fetch": "^2.6.0",
+    "nyc": "^15.1.0",
+    "rotating-file-stream": "^1.4.6",
+    "skyeye-common-const": "1.0.92",
+    "swagger-jsdoc": "^3.5.0",
+    "swagger-ui-express": "^4.1.3",
+    "ts-node": "^9.0.0",
+    "typeorm": "^0.2.20",
+    "@types/tedious": "^18.0.0",
+    "tedious": "^18.6.1",
+    "typescript": "^4.8.4",
+    "uuid": "^3.3.3",
+    "winston": "^3.2.1",
+    "winston-daily-rotate-file": "^4.2.1",
+    "follow-redirects": "^1.15.6"
+  },
+  "devDependencies": {
+    "@types/dateformat": "^3.0.1",
+    "@types/debug": "~4.1.5",
+    "@types/http-errors": "~1.6.1",
+    "@types/morgan": "~1.7.37",
+    "@types/node": "^14.0.27",
+    "@types/node-fetch": "^2.5.3",
+    "@types/uuid": "^3.4.6"
+  }
+}

package/pull_request_template.md

@@ -1,42 +1,42 @@
-Thank you for your contribution to the repo. 
-Before submitting this PR, please make sure:
-
-- [ ] Your code builds clean without any errors or warnings
-- [ ] You are using approved terminology
-- [ ] You have added unit tests
-- [ ] You have updated documentation
-- [ ] You have checked related services are updated
-
-You may delete the sections as necessary.
-
-### Context
-___
-
-Fill this up with some context that will be useful to the reviewer that is looking at your PR.
-
-Example:
-* Add references to a related previous PR.
-* Link to an existing card on Click Up/Confluence.
-* Link to an issue on Sentry.
-
-### Changes
-___
-
-Fill this up with the changes that are included in this PR.
-
-Example:
-* Added tests.
-* Refactored checkout flow.
-
-### Test
-___
-
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. 
-Please also list any relevant details for your test configuration.
-
-- [ ] Test A
-- [ ] Test B
-
-### Shout-outs
-___
+Thank you for your contribution to the repo. 
+Before submitting this PR, please make sure:
+
+- [ ] Your code builds clean without any errors or warnings
+- [ ] You are using approved terminology
+- [ ] You have added unit tests
+- [ ] You have updated documentation
+- [ ] You have checked related services are updated
+
+You may delete the sections as necessary.
+
+### Context
+___
+
+Fill this up with some context that will be useful to the reviewer that is looking at your PR.
+
+Example:
+* Add references to a related previous PR.
+* Link to an existing card on Click Up/Confluence.
+* Link to an issue on Sentry.
+
+### Changes
+___
+
+Fill this up with the changes that are included in this PR.
+
+Example:
+* Added tests.
+* Refactored checkout flow.
+
+### Test
+___
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. 
+Please also list any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+### Shout-outs
+___
 Fill this up with the people that have helped you out along the way to thank them! :tada

package/sonar-project.properties

@@ -1,12 +1,12 @@
-sonar.projectKey=HandshakesByDC_SkyEye-SVC-Common-Utils
-sonar.organization=handshakesbydc
-
-# This is the name and version displayed in the SonarCloud UI.
-#sonar.projectName=SkyEye-SVC-Announcement
-#sonar.projectVersion=1.0
-
-# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
-#sonar.sources=.
-
-# Encoding of the source code. Default is default system encoding
+sonar.projectKey=HandshakesByDC_SkyEye-SVC-Common-Utils
+sonar.organization=handshakesbydc
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=SkyEye-SVC-Announcement
+#sonar.projectVersion=1.0
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
 #sonar.sourceEncoding=UTF-8

package/src/index.ts

@@ -1,32 +1,32 @@
-import SendGridClient, { ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem } from './lib/sendGridClient';
-
-export * from './utils/appConfig';
-export * from './utils/appConst';
-export * from './utils/commonUtils';
-export * from './utils/authentication/auth';
-export * from './utils/logger/logger';
-export * from './utils/logger/morganLogger';
-export * from './utils/middleware/handleError';
-export * from './utils/middleware/isPublicUser';
-export * from './utils/middleware/overwriteConst';
-export * from './utils/middleware/startdbConnection';
-export * from './utils/baseClass/baseController';
-export * from './utils/baseClass/baseService';
-export * from './interfaces/index';
-export * from './lib/azure/azureKeyVault';
-export * from './lib/azure/azureServiceBusClient';
-export * from './lib/azure/azureStorageQueue';
-export * from './lib/azure/azureServiceBusQueue';
-export * from './lib/azure/azureTableStorage';
-export * from './lib/azure/azureBlobStorage';
-export * from './utils/documentation/swagger';
-export * from './lib/httpClient';
-export * from './utils/monitoring/apm';
-export * from './models/baseControllerParameter';
-export * from './models';
-export * from './lib/redisClient';
-export * from './interfaces/grpcServiceResponse';
-export * from './interfaces/grpcListRequest';
-export * from './utils/commonUtils/appConfigKeyRetriever';
-export * from './utils/constant/httpCodes';
-export { SendGridClient, ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem };
+import SendGridClient, { ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem } from './lib/sendGridClient';
+
+export * from './utils/appConfig';
+export * from './utils/appConst';
+export * from './utils/commonUtils';
+export * from './utils/authentication/auth';
+export * from './utils/logger/logger';
+export * from './utils/logger/morganLogger';
+export * from './utils/middleware/handleError';
+export * from './utils/middleware/isPublicUser';
+export * from './utils/middleware/overwriteConst';
+export * from './utils/middleware/startdbConnection';
+export * from './utils/baseClass/baseController';
+export * from './utils/baseClass/baseService';
+export * from './interfaces/index';
+export * from './lib/azure/azureKeyVault';
+export * from './lib/azure/azureServiceBusClient';
+export * from './lib/azure/azureStorageQueue';
+export * from './lib/azure/azureServiceBusQueue';
+export * from './lib/azure/azureTableStorage';
+export * from './lib/azure/azureBlobStorage';
+export * from './utils/documentation/swagger';
+export * from './lib/httpClient';
+export * from './utils/monitoring/apm';
+export * from './models/baseControllerParameter';
+export * from './models';
+export * from './lib/redisClient';
+export * from './interfaces/grpcServiceResponse';
+export * from './interfaces/grpcListRequest';
+export * from './utils/commonUtils/appConfigKeyRetriever';
+export * from './utils/constant/httpCodes';
+export { SendGridClient, ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem };

package/src/interfaces/apiResponse.ts

@@ -1,7 +1,7 @@
-export interface ApiResponse {
-    isSuccess: boolean;
-    message?: string;
-    data?: any;
-    totalCount?: number;
-    aggregation?: any;
+export interface ApiResponse {
+    isSuccess: boolean;
+    message?: string;
+    data?: any;
+    totalCount?: number;
+    aggregation?: any;
 }

package/src/interfaces/grpcListRequest.ts

@@ -1,6 +1,6 @@
-export interface GrpcListRequest {
-    skip?: number;
-    select?: number;
-    orderBy?: string;
-    order?: string;
+export interface GrpcListRequest {
+    skip?: number;
+    select?: number;
+    orderBy?: string;
+    order?: string;
 }

package/src/interfaces/grpcServiceResponse.ts

@@ -1,8 +1,8 @@
-export interface GrpcServiceResponse {
-    isSuccess: boolean;
-    message?: string;
-    data?: any;
-    totalCount?: number;
-    error?: boolean;
-    aggregation?: boolean;
+export interface GrpcServiceResponse {
+    isSuccess: boolean;
+    message?: string;
+    data?: any;
+    totalCount?: number;
+    error?: boolean;
+    aggregation?: boolean;
 }

package/src/interfaces/httpError.ts

@@ -1,12 +1,12 @@
-export class HttpError extends Error {
-    statusCode: number;
-    customErrorMessage?: string;
-
-    constructor(message: string, statusCode: number) {
-        super(message);
-        this.statusCode = statusCode;
-        this.customErrorMessage = message;
-
-        Object.setPrototypeOf(this, HttpError.prototype);
-    }
+export class HttpError extends Error {
+    statusCode: number;
+    customErrorMessage?: string;
+
+    constructor(message: string, statusCode: number) {
+        super(message);
+        this.statusCode = statusCode;
+        this.customErrorMessage = message;
+
+        Object.setPrototypeOf(this, HttpError.prototype);
+    }
 }

package/src/interfaces/index.ts

@@ -1,18 +1,18 @@
-import { ApiResponse } from './apiResponse';
-import { ServiceResponse } from './serviceResponse';
-import { UserInfo } from './userInfo';
-import { Pagination } from './pagination';
-import { SubcriptionFeaturePermissionModel } from './subcriptionFeaturePermissionModel';
-import { GrpcListRequest } from './grpcListRequest';
-import { GrpcServiceResponse } from './grpcServiceResponse';
-export {
-    ApiResponse,
-    ServiceResponse,
-    UserInfo,
-    Pagination,
-    SubcriptionFeaturePermissionModel,
-    GrpcListRequest,
-    GrpcServiceResponse
-};
-export * from './internalHttp/request';
+import { ApiResponse } from './apiResponse';
+import { ServiceResponse } from './serviceResponse';
+import { UserInfo } from './userInfo';
+import { Pagination } from './pagination';
+import { SubcriptionFeaturePermissionModel } from './subcriptionFeaturePermissionModel';
+import { GrpcListRequest } from './grpcListRequest';
+import { GrpcServiceResponse } from './grpcServiceResponse';
+export {
+    ApiResponse,
+    ServiceResponse,
+    UserInfo,
+    Pagination,
+    SubcriptionFeaturePermissionModel,
+    GrpcListRequest,
+    GrpcServiceResponse
+};
+export * from './internalHttp/request';
 export * from './internalHttp/response';

package/src/interfaces/internalHttp/request/search.ts

@@ -1,11 +1,11 @@
-import { GrpcContentListReq } from "../../../models";
-
-export interface IContentAggregateByMentionedCompanyWithFiltersFilter {
-    identifier: string;
-    filter: Partial<GrpcContentListReq>;
-}
-
-export interface IContentAggregateByMentionedCompanyWithFiltersRequest {
-    isOverallMentionCountRequired: boolean;
-    filters: Array<IContentAggregateByMentionedCompanyWithFiltersFilter>;
+import { GrpcContentListReq } from "../../../models";
+
+export interface IContentAggregateByMentionedCompanyWithFiltersFilter {
+    identifier: string;
+    filter: Partial<GrpcContentListReq>;
+}
+
+export interface IContentAggregateByMentionedCompanyWithFiltersRequest {
+    isOverallMentionCountRequired: boolean;
+    filters: Array<IContentAggregateByMentionedCompanyWithFiltersFilter>;
 }

package/src/interfaces/internalHttp/response/search.ts

@@ -1,13 +1,13 @@
-import { ServiceResponse } from "../../serviceResponse";
-
-export interface IMentionedCompany {
-    companyGuid: string;
-    companyName: string;
-    mentionCount: number;
-}
-
-export interface IContentAggregateByMentionedCompanyWithFiltersResponseItem {
-    identifier: string;
-    totalMentionedCompany: number;
-    mentionedCompanies: IMentionedCompany[];
+import { ServiceResponse } from "../../serviceResponse";
+
+export interface IMentionedCompany {
+    companyGuid: string;
+    companyName: string;
+    mentionCount: number;
+}
+
+export interface IContentAggregateByMentionedCompanyWithFiltersResponseItem {
+    identifier: string;
+    totalMentionedCompany: number;
+    mentionedCompanies: IMentionedCompany[];
 }