@ampsec/platform-client 3.0.0 → 4.0.1

package/build/src/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,2CAAyB;AACzB,iDAA+B;AAC/B,mDAAiC;AACjC,yCAAuB"}

package/build/src/services/rest/RestClient.d.ts

@@ -0,0 +1,46 @@
+import { Axios, AxiosStatic } from 'axios';
+import { RestRequest } from './RestRequest';
+import { RestResponse } from './RestResponse';
+import { RestClientRetryStrategy } from './retry.rest';
+import { HeadersMap } from './utils';
+import { RestClientRateLimitStrategy } from './rateLimit.rest';
+export type AmpRestClientOptions = {
+    baseUrl: string;
+    token: string;
+    timeout?: number;
+    retryStrategy?: RestClientRetryStrategy;
+    rateLimitStrategy?: RestClientRateLimitStrategy;
+    verbose?: boolean;
+    client?: AxiosStatic;
+};
+export type RestClientOptions = {
+    baseUrl?: string;
+    headers?: HeadersMap;
+    timeout?: number;
+    retryStrategy?: RestClientRetryStrategy;
+    rateLimitStrategy?: RestClientRateLimitStrategy;
+    verbose?: boolean;
+    client?: AxiosStatic;
+};
+/**
+ * RestClient is a generic interface for making REST calls.
+ */
+export interface RestClient {
+    call(_request: RestRequest): Promise<RestResponse>;
+}
+/**
+ * DefaultRestClient is a default implementation of RestClient.
+ * It defaults to useing axios to make REST calls and adds reasonble defaults
+ * for retry logic, error handling, headers, and timeouts.
+ *
+ * These strategies can be useful when scraping 3rd party APIs.
+ */
+export declare class DefaultRestClient {
+    protected readonly ampAxios: Axios;
+    protected readonly retryStrategy: RestClientRetryStrategy;
+    protected readonly rateLimitStrategy: RestClientRateLimitStrategy;
+    protected readonly verbose: boolean;
+    constructor(options?: RestClientOptions);
+    call(request: RestRequest): Promise<RestResponse>;
+}
+export declare const getAmpRestClient: (options: AmpRestClientOptions) => RestClient;

package/build/src/services/rest/RestClient.js

@@ -0,0 +1,106 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAmpRestClient = exports.DefaultRestClient = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const axios_1 = __importStar(require("axios"));
+const retry_rest_1 = require("./retry.rest");
+const utils_1 = require("./utils");
+const rateLimit_rest_1 = require("./rateLimit.rest");
+/**
+ * DefaultRestClient is a default implementation of RestClient.
+ * It defaults to useing axios to make REST calls and adds reasonble defaults
+ * for retry logic, error handling, headers, and timeouts.
+ *
+ * These strategies can be useful when scraping 3rd party APIs.
+ */
+class DefaultRestClient {
+    constructor(options = {}) {
+        var _a, _b, _c, _d, _e;
+        // TODO: rest client
+        const client = (_a = options.client) !== null && _a !== void 0 ? _a : axios_1.default;
+        this.ampAxios = client.create({
+            baseURL: options.baseUrl,
+            timeout: options.timeout,
+        });
+        Object.keys((_b = options.headers) !== null && _b !== void 0 ? _b : {}).forEach(key => {
+            var _a;
+            this.ampAxios.defaults.headers.common[key] = (_a = options.headers) === null || _a === void 0 ? void 0 : _a[key];
+        });
+        this.verbose = (_c = options.verbose) !== null && _c !== void 0 ? _c : false;
+        this.ampAxios.defaults.headers.common['Accepts'] = 'application/json';
+        this.ampAxios.defaults.headers.post['Content-Type'] = 'application/json';
+        this.ampAxios.defaults.headers.put['Content-Type'] = 'application/json';
+        this.retryStrategy = (_d = options.retryStrategy) !== null && _d !== void 0 ? _d : retry_rest_1.noopRestRetryStrategy;
+        this.rateLimitStrategy = (_e = options.rateLimitStrategy) !== null && _e !== void 0 ? _e : rateLimit_rest_1.noopRestClientRateLimitStrategy;
+    }
+    async call(request) {
+        var _a, _b;
+        const req = lodash_1.default.merge(request);
+        try {
+            await this.rateLimitStrategy.reserve(req);
+            if (this.verbose)
+                console.log('Request', req);
+            const res = await this.ampAxios.request(req);
+            return {
+                status: res.status,
+                headers: (0, utils_1.convertHeaders)(res),
+                data: res.data,
+                error: null,
+            };
+        }
+        catch (err) {
+            if (err instanceof axios_1.AxiosError) {
+                const axiosError = err;
+                return {
+                    status: (_b = (_a = axiosError.response) === null || _a === void 0 ? void 0 : _a.status) !== null && _b !== void 0 ? _b : 500,
+                    headers: axiosError.response ? (0, utils_1.convertHeaders)(axiosError.response) : {},
+                    data: null,
+                    error: err,
+                };
+            }
+            throw err;
+        }
+    }
+}
+exports.DefaultRestClient = DefaultRestClient;
+const getAmpRestClient = (options) => {
+    var _a;
+    const ampClient = new DefaultRestClient({
+        baseUrl: options.baseUrl,
+        headers: {
+            Authorization: `Bearer ${options.token}`,
+        },
+        rateLimitStrategy: new rateLimit_rest_1.StaticRestClientRateLimitStrategy(50),
+        verbose: (_a = options.verbose) !== null && _a !== void 0 ? _a : false,
+        client: options.client,
+    });
+    return ampClient;
+};
+exports.getAmpRestClient = getAmpRestClient;
+//# sourceMappingURL=RestClient.js.map

package/build/src/services/rest/RestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestClient.js","sourceRoot":"","sources":["../../../../src/services/rest/RestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,+CAA4D;AAG5D,6CAA4E;AAC5E,mCAAmD;AACnD,qDAAiI;AA6BjI;;;;;;GAMG;AACH,MAAa,iBAAiB;IAK5B,YAAY,UAA6B,EAAE;;QACzC,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,eAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;;YAC/C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAA,OAAO,CAAC,OAAO,0CAAG,GAAG,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,KAAK,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACzE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACxE,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,kCAAqB,CAAC;QACpE,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,gDAA+B,CAAC;IACxF,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAoB;;QAC7B,MAAM,GAAG,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI;YACF,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7C,OAAO;gBACL,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,OAAO,EAAE,IAAA,sBAAc,EAAC,GAAG,CAAC;gBAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,IAAI;aACZ,CAAC;SACH;QAAC,OAAO,GAAY,EAAE;YACrB,IAAI,GAAG,YAAY,kBAAU,EAAE;gBAC7B,MAAM,UAAU,GAAG,GAAiB,CAAC;gBACrC,OAAO;oBACL,MAAM,EAAE,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,mCAAI,GAAG;oBAC1C,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,GAAG;iBACX,CAAC;aACH;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;CACF;AA/CD,8CA+CC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAc,EAAE;;IAC5E,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC;QACtC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,EAAE;SACzC;QACD,iBAAiB,EAAE,IAAI,kDAAiC,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,KAAK;QACjC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAXW,QAAA,gBAAgB,oBAW3B"}

package/build/src/services/rest/RestRequest.d.ts

@@ -0,0 +1,8 @@
+import { HeadersMap, QueryMap } from './utils';
+export type RestRequest = {
+    url: string;
+    headers?: HeadersMap;
+    params?: QueryMap;
+    data?: unknown;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+};

package/build/src/services/rest/RestRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RestRequest.js.map

package/build/src/services/rest/RestRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestRequest.js","sourceRoot":"","sources":["../../../../src/services/rest/RestRequest.ts"],"names":[],"mappings":""}

package/build/src/services/rest/RestResponse.d.ts

@@ -0,0 +1,7 @@
+import { HeadersMap } from './utils';
+export type RestResponse = {
+    status: number;
+    headers: HeadersMap;
+    data: unknown;
+    error: unknown;
+};

package/build/src/services/rest/RestResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RestResponse.js.map

package/build/src/services/rest/RestResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestResponse.js","sourceRoot":"","sources":["../../../../src/services/rest/RestResponse.ts"],"names":[],"mappings":""}

package/build/src/services/rest/index.d.ts

@@ -0,0 +1,5 @@
+export * from './RestClient';
+export * from './RestRequest';
+export * from './RestResponse';
+export * from './rateLimit.rest';
+export * from './retry.rest';

package/build/src/services/rest/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./RestClient"), exports);
+__exportStar(require("./RestRequest"), exports);
+__exportStar(require("./RestResponse"), exports);
+__exportStar(require("./rateLimit.rest"), exports);
+__exportStar(require("./retry.rest"), exports);
+//# sourceMappingURL=index.js.map

package/build/src/services/rest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/rest/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,gDAA8B;AAC9B,iDAA+B;AAC/B,mDAAiC;AACjC,+CAA6B"}

package/build/src/services/rest/rateLimit.rest.d.ts

@@ -0,0 +1,11 @@
+import { RestRequest } from './RestRequest';
+export interface RestClientRateLimitStrategy {
+    reserve(_req: RestRequest): Promise<void>;
+}
+export declare const noopRestClientRateLimitStrategy: RestClientRateLimitStrategy;
+export declare class StaticRestClientRateLimitStrategy implements RestClientRateLimitStrategy {
+    private readonly delay;
+    private lastRequest;
+    constructor(delay: number);
+    reserve(_req: RestRequest): Promise<void>;
+}

package/build/src/services/rest/rateLimit.rest.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticRestClientRateLimitStrategy = exports.noopRestClientRateLimitStrategy = void 0;
+exports.noopRestClientRateLimitStrategy = {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    reserve(_req) {
+        return Promise.resolve();
+    },
+};
+const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
+class StaticRestClientRateLimitStrategy {
+    constructor(delay) {
+        this.delay = delay;
+        this.lastRequest = 0;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async reserve(_req) {
+        while (Date.now() - this.lastRequest < this.delay) {
+            await sleep(this.delay);
+        }
+        this.lastRequest = Date.now();
+    }
+}
+exports.StaticRestClientRateLimitStrategy = StaticRestClientRateLimitStrategy;
+//# sourceMappingURL=rateLimit.rest.js.map

package/build/src/services/rest/rateLimit.rest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateLimit.rest.js","sourceRoot":"","sources":["../../../../src/services/rest/rateLimit.rest.ts"],"names":[],"mappings":";;;AAMa,QAAA,+BAA+B,GAAgC;IAC1E,6DAA6D;IAC7D,OAAO,CAAC,IAAiB;QACvB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAE9E,MAAa,iCAAiC;IAI5C,YAAY,KAAa;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,6DAA6D;IAC7D,KAAK,CAAC,OAAO,CAAC,IAAiB;QAC7B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE;YACjD,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzB;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAChC,CAAC;CACF;AAfD,8EAeC"}

package/build/src/services/rest/retry.rest.d.ts

@@ -0,0 +1,7 @@
+import { AxiosError } from 'axios';
+import { RestRequest } from './RestRequest';
+import { RestResponse } from './RestResponse';
+export interface RestClientRetryStrategy {
+    onError(_req: RestRequest, _err: AxiosError): Promise<RestResponse>;
+}
+export declare const noopRestRetryStrategy: RestClientRetryStrategy;

package/build/src/services/rest/retry.rest.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noopRestRetryStrategy = void 0;
+const utils_1 = require("./utils");
+exports.noopRestRetryStrategy = {
+    onError(req, err) {
+        var _a, _b;
+        const axiosError = err;
+        const res = {
+            status: (_b = (_a = axiosError.response) === null || _a === void 0 ? void 0 : _a.status) !== null && _b !== void 0 ? _b : 500,
+            headers: axiosError.response ? (0, utils_1.convertHeaders)(axiosError.response) : {},
+            data: null,
+            error: err,
+        };
+        return Promise.resolve(res);
+    },
+};
+//# sourceMappingURL=retry.rest.js.map

package/build/src/services/rest/retry.rest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.rest.js","sourceRoot":"","sources":["../../../../src/services/rest/retry.rest.ts"],"names":[],"mappings":";;;AACA,mCAAuC;AAQ1B,QAAA,qBAAqB,GAA4B;IAC5D,OAAO,CAAC,GAAgB,EAAE,GAAe;;QACvC,MAAM,UAAU,GAAG,GAAiB,CAAC;QACrC,MAAM,GAAG,GAAiB;YACxB,MAAM,EAAE,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,mCAAI,GAAG;YAC1C,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;YACvE,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,GAAG;SACX,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF,CAAC"}

package/build/src/services/rest/utils.d.ts

@@ -0,0 +1,7 @@
+import { AxiosResponse } from 'axios';
+export type StringMap<T> = {
+    [key: string]: T;
+};
+export type HeadersMap = StringMap<string>;
+export type QueryMap = StringMap<unknown>;
+export declare function convertHeaders(res: AxiosResponse): HeadersMap;

package/build/src/services/rest/utils.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertHeaders = void 0;
+function convertHeaders(res) {
+    const headers = {};
+    for (const [key, value] of Object.entries(res.headers)) {
+        headers[key] = value;
+    }
+    return headers;
+}
+exports.convertHeaders = convertHeaders;
+//# sourceMappingURL=utils.js.map

package/build/src/services/rest/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/services/rest/utils.ts"],"names":[],"mappings":";;;AAMA,SAAgB,cAAc,CAAC,GAAkB;IAC/C,MAAM,OAAO,GAAe,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QACtD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAe,CAAC;KAChC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAND,wCAMC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "3.0.0",
+  "version": "4.0.1",
   "description": "",
   "main": "build/src/index.js",
   "scripts": {
@@ -19,14 +19,17 @@
   "author": "Amplifier Security <engineering@amplifiersecurity.com>",
   "license": "MIT",
   "dependencies": {
+    "axios": "^1.4.0",
     "blueimp-md5": "^2.19.0",
+    "lodash": "^4.17.21",
     "lodash.omit": "^4.5.0"
   },
   "devDependencies": {
     "@jest/types": "^29.5.0",
+    "@types/axios": "^0.14.0",
     "@types/blueimp-md5": "^2.18.0",
     "@types/jest": "^29.5.1",
-    "@types/lodash.omit": "^4.5.7",
+    "@types/lodash": "^4.14.195",
     "gts": "^3.1.1",
     "jest": "^29.5.0",
     "rimraf": "^5.0.0",
@@ -37,6 +40,7 @@
     "typescript": "^5.0.4"
   },
   "files": [
-    "/build/src"
+    "/build/src",
+    "/src"
   ]
 }

package/src/FilterCriteria.ts

@@ -0,0 +1,18 @@
+export type FilterCriteria = {
+  /** Number of records to return. */
+  limit?: number;
+  /** Number of records to skip before capturing results. */
+  offset?: number;
+  /** Tenant ID */
+  tid?: number;
+  /** Connector ID */
+  cid?: number;
+  /** Organization name. Defaults to `*` which matches all organizations. */
+  organization?: '*' | 'EXTERNAL' | string;
+  /** Department name. Defaults to `*` which matches all departments. */
+  department?: '*' | string;
+  /** User ID */
+  uid?: number;
+  /** Asset ID */
+  aid?: number;
+};

package/src/dto/agents.dto.ts

@@ -0,0 +1,15 @@
+import {AgentStatus} from './enums/agent.status';
+import {BaseDto, BaseUpsertDto} from './base.dto';
+
+export type AgentUpsertDto = BaseUpsertDto & {
+  /** Agent first name */
+  firstName: string;
+  /** Agent last name */
+  lastName: string;
+  /** Status of the Agent, e.g. ACTIVE */
+  status: AgentStatus;
+  /** External Id */
+  email: string;
+};
+
+export type AgentDto = BaseDto & AgentUpsertDto;

package/src/dto/assets.dto.ts

@@ -0,0 +1,10 @@
+import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
+
+export type AssetUpsertDto = ChangeAwareUpsertDto & {
+  /** External Id */
+  sn: string;
+  /** User Id of the asset owner */
+  uid?: number | undefined;
+};
+
+export type AssetDto = ChangeAwareDto & AssetUpsertDto;

package/src/dto/base.dto.ts

@@ -0,0 +1,25 @@
+export type BaseUpsertDto = {
+  /** Unique Row Identifier. Populated for entity updates. */
+  id?: number;
+};
+
+export type BaseDto = {
+  /** Unique Row Identifier */
+  id: number;
+  /** Record creation date in database. */
+  createdAt: string;
+  /** Last record update date in database. */
+  updatedAt: string;
+  /** Record deletion date in database. Only present on soft deleted, i.e. `null => active` */
+  deletedAt: string | null;
+};
+
+export type ChangeAwareUpsertDto = BaseUpsertDto & {
+  /** MD5 hash of a subset of properties to detect field level changes. */
+  etag: string;
+};
+
+export type ChangeAwareDto = BaseDto & {
+  /** MD5 hash of a subset of properties to deted field level changes. */
+  etag: string;
+};

package/src/dto/connectors.dto.ts

@@ -0,0 +1,13 @@
+import {BaseDto, BaseUpsertDto} from './base.dto';
+import {ConnectorStatus} from './enums/connector.status';
+
+export type ConnectorUpsertDto = BaseUpsertDto & {
+  /** Human readable name of the connector */
+  displayValue: string;
+  /** Status of the connector, e.g. ACTIVE */
+  status: ConnectorStatus;
+  /** Provider Id */
+  pid?: number | null;
+};
+
+export type ConnectorDto = BaseDto & ConnectorUpsertDto;

package/src/dto/enums/agent.status.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-unused-vars */
+export enum AgentStatus {
+  ACTIVE = 'ACTIVE',
+  INVITED = 'INVITED',
+  SUSPENDED = 'SUSPENDED',
+}

package/src/dto/enums/connector.status.ts

@@ -0,0 +1,7 @@
+/* eslint-disable no-unused-vars */
+export enum ConnectorStatus {
+  ACTIVE = 'ACTIVE',
+  DELETED = 'DELETED',
+  FAILED = 'FAILED',
+  DISABLED = 'DISABLED',
+}

package/src/dto/enums/finding.severity.ts

@@ -0,0 +1,7 @@
+/* eslint-disable no-unused-vars */
+export enum FindingSeverity {
+  LOW = 'LOW',
+  MEDIUM = 'MEDIUM',
+  HIGH = 'HIGH',
+  CRITICAL = 'CRITICAL',
+}

package/src/dto/enums/finding.status.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-unused-vars */
+export enum FindingStatus {
+  OPEN = 'OPEN',
+  CLOSED = 'CLOSED',
+}

package/src/dto/enums/index.ts

@@ -0,0 +1,4 @@
+export * from './agent.status';
+export * from './connector.status';
+export * from './finding.severity';
+export * from './finding.status';

package/src/dto/extKeyMap.dto.ts

@@ -0,0 +1,6 @@
+export type ExtKeyMap = {
+  [propName: string]: {
+    id: number;
+    etag: string;
+  };
+};

package/src/dto/findings.dto.ts

@@ -0,0 +1,26 @@
+import {BaseDto, BaseUpsertDto} from './base.dto';
+import {FindingSeverity} from './enums/finding.severity';
+import {FindingStatus} from './enums/finding.status';
+
+export type FindingUpsertDto = BaseUpsertDto & {
+  /** Date the finding was closed */
+  closedAt?: string;
+  /** Type of finding */
+  kind: string;
+  /** Status of the finding, e.g. OPEN */
+  status: FindingStatus;
+  /** Severity of the finding, e.g. CRITICAL, HIGH, etc... */
+  severity: FindingSeverity;
+  /** Number of times the user has been engaged to resolve the finding */
+  numberOfEngagements: number;
+  /** Human readable name of the finding */
+  displayValue: string;
+  /** Description of the finding */
+  description?: string;
+  /** Id of the user to which the finding applies */
+  uid?: number | undefined;
+  /** Id of the SaasComponent related to the given finding */
+  scid: number;
+};
+
+export type FindingDto = BaseDto & FindingUpsertDto;

package/src/dto/index.ts

@@ -0,0 +1,19 @@
+export * from './agents.dto';
+export * from './assets.dto';
+export * from './base.dto';
+export * from './connectors.dto';
+export * from './enums';
+export * from './extKeyMap.dto';
+export * from './findings.dto';
+export * from './message.dto';
+export * from './metrics.dto';
+export * from './page.dto';
+export * from './platform';
+export * from './providers.dto';
+export * from './reportResults.dto';
+export * from './riskContributors.dto';
+export * from './saasAssets.dto';
+export * from './saasComponents.dto';
+export * from './saasUsers.dto';
+export * from './tenants.dto';
+export * from './users.dto';

package/src/dto/message.dto.ts

@@ -0,0 +1,3 @@
+export type Message = {
+  message: string;
+};

package/src/dto/metrics.dto.ts

@@ -0,0 +1,10 @@
+import {BaseDto, BaseUpsertDto} from './base.dto';
+
+export type MetricUpsertDto = BaseUpsertDto & {
+  uid: number;
+  score: number;
+  scoreDelta: number;
+  rank: number;
+};
+
+export type MetricDto = BaseDto & MetricUpsertDto;

package/src/dto/page.dto.ts

@@ -0,0 +1,14 @@
+export type Page<T> = {
+  kind: string;
+  data: T[];
+  error: string | null;
+  hints: {
+    limit?: number;
+    offset?: number;
+    hasMore?: boolean;
+    next?: string;
+    count?: number;
+    links?: {[keyName: string]: string};
+    [propName: string]: number | string | boolean | null | {[keyName: string]: string} | undefined;
+  };
+};

package/src/dto/platform/index.ts

@@ -0,0 +1,13 @@
+export * from './platform.agents.dto';
+export * from './platform.assets.dto';
+export * from './platform.connectors.dto';
+export * from './platform.findings.dto';
+export * from './platform.metrics.dto';
+export * from './platform.providers.dto';
+export * from './platform.reportResults.dto';
+export * from './platform.saasAssets.dto';
+export * from './platform.saasComponents.dto';
+export * from './platform.saasUsers.dto';
+export * from './platform.tenants.dto';
+export * from './platform.users.dto';
+export * from './tenant.based.dto';

package/src/dto/platform/multi.tenant.based.dto.ts

@@ -0,0 +1,11 @@
+import {BaseDto, BaseUpsertDto} from '../base.dto';
+
+export type UpsertMultiTenantBased = BaseUpsertDto & {
+  /** Tenant Ids for multi-tenant entities */
+  tids?: number[];
+};
+
+export type MultiTenantBased = BaseDto & {
+  /** Tenant Ids for multi-tenant entities */
+  tids: number[];
+};

package/src/dto/platform/platform.agents.dto.ts

@@ -0,0 +1,6 @@
+import {AgentDto, AgentUpsertDto} from '../agents.dto';
+import {MultiTenantBased, UpsertMultiTenantBased} from './multi.tenant.based.dto';
+
+export type PlatformAgentUpsertDto = AgentUpsertDto & UpsertMultiTenantBased;
+
+export type PlatformAgentDto = AgentDto & MultiTenantBased;

package/src/dto/platform/platform.assets.dto.ts

@@ -0,0 +1,6 @@
+import {AssetDto, AssetUpsertDto} from '../assets.dto';
+import {TenantBased, UpsertTenantBased} from './tenant.based.dto';
+
+export type PlatformAssetUpsertDto = AssetUpsertDto & UpsertTenantBased;
+
+export type PlatformAssetDto = AssetDto & TenantBased;

package/src/dto/platform/platform.connectors.dto.ts

@@ -0,0 +1,6 @@
+import {ConnectorDto, ConnectorUpsertDto} from '../connectors.dto';
+import {TenantBased, UpsertTenantBased} from './tenant.based.dto';
+
+export type PlatformConnectorUpsertDto = ConnectorUpsertDto & UpsertTenantBased;
+
+export type PlatformConnectorDto = ConnectorDto & TenantBased;