@ampsec/platform-client 10.2.0 → 10.3.0

package/build/src/services/AmpApi.d.ts

@@ -2,6 +2,7 @@ import { AgentDto, AgentUpsertDto, AssetDto, ConnectorDto, ConnectorUpsertDto, F
 import { AmpEntityService } from './entity.service';
 import { AmpDataService } from './data.service';
 import { AmpRestClientOptions, RestClient } from './rest';
+import { AmpReportService } from './reports.service';
 export type AmpApiOptions = AmpRestClientOptions;
 /**
  * AMP API
@@ -22,6 +23,7 @@ export declare class AmpApi {
     readonly findings: AmpDataService<FindingDto>;
     readonly providers: AmpDataService<ProviderDto>;
     readonly reportResults: AmpDataService<ReportResultDto>;
+    readonly reports: AmpReportService;
     readonly saasAssets: AmpDataService<SaasAssetDto>;
     readonly saasComponents: AmpDataService<SaasComponentDto>;
     readonly saasUsers: AmpDataService<SaasUserDto>;

package/build/src/services/AmpApi.js

@@ -4,6 +4,8 @@ exports.AmpApi = void 0;
 const entity_service_1 = require("./entity.service");
 const data_service_1 = require("./data.service");
 const rest_1 = require("./rest");
+const constants_1 = require("./constants");
+const reports_service_1 = require("./reports.service");
 /**
  * AMP API
  * This client is a wrapper around the AMP REST API meant to be used by
@@ -18,17 +20,18 @@ const rest_1 = require("./rest");
  */
 class AmpApi {
     constructor(rest) {
-        this.agents = new entity_service_1.AmpEntityServiceImpl(rest, 'agents');
-        this.asset = new data_service_1.AmpDataServiceImpl(rest, 'assets');
-        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, 'connectors');
-        this.findings = new data_service_1.AmpDataServiceImpl(rest, 'findings');
-        this.providers = new data_service_1.AmpDataServiceImpl(rest, 'providers');
-        this.reportResults = new data_service_1.AmpDataServiceImpl(rest, 'report_results');
-        this.saasAssets = new data_service_1.AmpDataServiceImpl(rest, 'saas_assets');
-        this.saasComponents = new data_service_1.AmpDataServiceImpl(rest, 'saas_components');
-        this.saasUsers = new data_service_1.AmpDataServiceImpl(rest, 'saas_users');
-        this.tenants = new entity_service_1.AmpEntityServiceImpl(rest, 'agents');
-        this.users = new data_service_1.AmpDataServiceImpl(rest, 'users');
+        this.agents = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.AGENTS);
+        this.asset = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.ASSETS);
+        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.CONNECTORS);
+        this.findings = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.FINDINGS);
+        this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS);
+        this.reportResults = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.REPORT_RESULTS);
+        this.reports = new reports_service_1.AmpReportServiceImpl(rest);
+        this.saasAssets = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.SAAS_ASSETS);
+        this.saasComponents = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.SAAS_COMPONENTS);
+        this.saasUsers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.SAAS_USERS);
+        this.tenants = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.TENANTS);
+        this.users = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.USERS);
     }
     static instance(options) {
         const rest = (0, rest_1.getAmpRestClient)(options);

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

@@ -1 +1 @@
-{"version":3,"file":"AmpApi.js","sourceRoot":"","sources":["../../../src/services/AmpApi.ts"],"names":[],"mappings":";;;AAgBA,qDAAwE;AACxE,iDAAkE;AAClE,iCAA0E;AAI1E;;;;;;;;;;;GAWG;AACH,MAAa,MAAM;IAajB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2B,IAAI,EAAE,QAAQ,CAAC,CAAC;QACjF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAW,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9D,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,YAAY,CAAC,CAAC;QACjG,IAAI,CAAC,QAAQ,GAAG,IAAI,iCAAkB,CAAa,IAAI,EAAE,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACrF,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAkB,CAAe,IAAI,EAAE,aAAa,CAAC,CAAC;QAC5E,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAkB,CAAmB,IAAI,EAAE,iBAAiB,CAAC,CAAC;QACxF,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,YAAY,CAAC,CAAC;QACzE,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,QAAQ,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AA/BD,wBA+BC"}
+{"version":3,"file":"AmpApi.js","sourceRoot":"","sources":["../../../src/services/AmpApi.ts"],"names":[],"mappings":";;;AAgBA,qDAAwE;AACxE,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAiC;AACjC,uDAAyE;AAIzE;;;;;;;;;;;GAWG;AACH,MAAa,MAAM;IAcjB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2B,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAW,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,CAAC,QAAQ,GAAG,IAAI,iCAAkB,CAAa,IAAI,EAAE,gBAAI,CAAC,QAAQ,CAAC,CAAC;QACxE,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAkB,CAAe,IAAI,EAAE,gBAAI,CAAC,WAAW,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAkB,CAAmB,IAAI,EAAE,gBAAI,CAAC,eAAe,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAU,IAAI,EAAE,gBAAI,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AAjCD,wBAiCC"}

package/build/src/services/AmpSdk.js

@@ -4,6 +4,7 @@ exports.AmpSdkServices = void 0;
 const entity_service_1 = require("./entity.service");
 const data_service_1 = require("./data.service");
 const rest_1 = require("./rest");
+const constants_1 = require("./constants");
 /**
  * AMP API
  * This client is a wrapper around the AMP REST API meant to be used by
@@ -17,17 +18,17 @@ const rest_1 = require("./rest");
  */
 class AmpSdkServices {
     constructor(rest) {
-        this.agents = new entity_service_1.AmpEntityServiceImpl(rest, 'agents', data_service_1.TARGET_API_PLATFORM);
-        this.asset = new entity_service_1.AmpGlobalEntityServiceImpl(rest, 'assets', data_service_1.TARGET_API_PLATFORM);
-        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, 'connectors', data_service_1.TARGET_API_PLATFORM);
-        this.findings = new entity_service_1.AmpSaaSEntityServiceImpl(rest, 'findings', data_service_1.TARGET_API_PLATFORM);
-        this.providers = new data_service_1.AmpDataServiceImpl(rest, 'providers', data_service_1.TARGET_API_AGENT);
-        this.reportResults = new entity_service_1.AmpSaaSEntityServiceImpl(rest, 'report_results', data_service_1.TARGET_API_PLATFORM);
-        this.saasAssets = new entity_service_1.AmpSaaSEntityServiceImpl(rest, 'saas_assets', data_service_1.TARGET_API_PLATFORM);
-        this.saasComponents = new entity_service_1.AmpSaaSEntityServiceImpl(rest, 'saas_components', data_service_1.TARGET_API_PLATFORM);
-        this.saasUsers = new entity_service_1.AmpSaaSEntityServiceImpl(rest, 'saas_users', data_service_1.TARGET_API_PLATFORM);
-        this.tenants = new entity_service_1.AmpEntityServiceImpl(rest, 'tenants', data_service_1.TARGET_API_PLATFORM);
-        this.users = new entity_service_1.AmpGlobalEntityServiceImpl(rest, 'users', data_service_1.TARGET_API_PLATFORM);
+        this.agents = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.AGENTS, constants_1.TARGET_API_PLATFORM);
+        this.asset = new entity_service_1.AmpGlobalEntityServiceImpl(rest, constants_1.KIND.ASSETS, constants_1.TARGET_API_PLATFORM);
+        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.CONNECTORS, constants_1.TARGET_API_PLATFORM);
+        this.findings = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.FINDINGS, constants_1.TARGET_API_PLATFORM);
+        this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS, constants_1.TARGET_API_AGENT);
+        this.reportResults = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.REPORT_RESULTS, constants_1.TARGET_API_PLATFORM);
+        this.saasAssets = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.SAAS_ASSETS, constants_1.TARGET_API_PLATFORM);
+        this.saasComponents = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.SAAS_COMPONENTS, constants_1.TARGET_API_PLATFORM);
+        this.saasUsers = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.SAAS_USERS, constants_1.TARGET_API_PLATFORM);
+        this.tenants = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.TENANTS, constants_1.TARGET_API_PLATFORM);
+        this.users = new entity_service_1.AmpGlobalEntityServiceImpl(rest, constants_1.KIND.USERS, constants_1.TARGET_API_PLATFORM);
     }
     static instance(options) {
         const rest = (0, rest_1.getAmpRestClient)(options);

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

@@ -1 +1 @@
-{"version":3,"file":"AmpSdk.js","sourceRoot":"","sources":["../../../src/services/AmpSdk.ts"],"names":[],"mappings":";;;AAuBA,qDAA4K;AAC5K,iDAAyG;AACzG,iCAA0E;AAI1E;;;;;;;;;;GAUG;AACH,MAAa,cAAc;IAazB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2C,IAAI,EAAE,QAAQ,EAAE,kCAAmB,CAAC,CAAC;QACtH,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAA2C,IAAI,EAAE,QAAQ,EAAE,kCAAmB,CAAC,CAAC;QAC3H,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmD,IAAI,EAAE,YAAY,EAAE,kCAAmB,CAAC,CAAC;QACtI,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAwB,CAA+C,IAAI,EAAE,UAAU,EAAE,kCAAmB,CAAC,CAAC;QAClI,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,WAAW,EAAE,+BAAgB,CAAC,CAAC;QAC1F,IAAI,CAAC,aAAa,GAAG,IAAI,yCAAwB,CAAyD,IAAI,EAAE,gBAAgB,EAAE,kCAAmB,CAAC,CAAC;QACvJ,IAAI,CAAC,UAAU,GAAG,IAAI,yCAAwB,CAAmD,IAAI,EAAE,aAAa,EAAE,kCAAmB,CAAC,CAAC;QAC3I,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAwB,CAA2D,IAAI,EAAE,iBAAiB,EAAE,kCAAmB,CAAC,CAAC;QAC3J,IAAI,CAAC,SAAS,GAAG,IAAI,yCAAwB,CAAiD,IAAI,EAAE,YAAY,EAAE,kCAAmB,CAAC,CAAC;QACvI,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,SAAS,EAAE,kCAAmB,CAAC,CAAC;QAC1G,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAAyC,IAAI,EAAE,OAAO,EAAE,kCAAmB,CAAC,CAAC;IAC1H,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AA/BD,wCA+BC"}
+{"version":3,"file":"AmpSdk.js","sourceRoot":"","sources":["../../../src/services/AmpSdk.ts"],"names":[],"mappings":";;;AAuBA,qDAA4K;AAC5K,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAwE;AAIxE;;;;;;;;;;GAUG;AACH,MAAa,cAAc;IAazB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2C,IAAI,EAAE,gBAAI,CAAC,MAAM,EAAE,+BAAmB,CAAC,CAAC;QACzH,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAA2C,IAAI,EAAE,gBAAI,CAAC,MAAM,EAAE,+BAAmB,CAAC,CAAC;QAC9H,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmD,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,+BAAmB,CAAC,CAAC;QACzI,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAwB,CAA+C,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,+BAAmB,CAAC,CAAC;QACrI,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,EAAE,4BAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,aAAa,GAAG,IAAI,yCAAwB,CAAyD,IAAI,EAAE,gBAAI,CAAC,cAAc,EAAE,+BAAmB,CAAC,CAAC;QAC1J,IAAI,CAAC,UAAU,GAAG,IAAI,yCAAwB,CAAmD,IAAI,EAAE,gBAAI,CAAC,WAAW,EAAE,+BAAmB,CAAC,CAAC;QAC9I,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAwB,CAA2D,IAAI,EAAE,gBAAI,CAAC,eAAe,EAAE,+BAAmB,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,GAAG,IAAI,yCAAwB,CAAiD,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,+BAAmB,CAAC,CAAC;QAC1I,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,EAAE,+BAAmB,CAAC,CAAC;QAC7G,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAAyC,IAAI,EAAE,gBAAI,CAAC,KAAK,EAAE,+BAAmB,CAAC,CAAC;IAC7H,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AA/BD,wCA+BC"}

package/build/src/services/constants.d.ts

@@ -0,0 +1,31 @@
+export interface ErrorHandler<T> {
+    (_error: unknown): T;
+}
+export declare const DEFAULT_TREND_WINDOW_MONTHS = 6;
+export type TargetApi = 'api' | 'platform';
+export declare const TARGET_API_PLATFORM: TargetApi;
+export declare const TARGET_API_AGENT: TargetApi;
+export declare const KIND: {
+    AGENTS: string;
+    ASSETS: string;
+    CONNECTORS: string;
+    FINDINGS: string;
+    PROVIDERS: string;
+    REPORT_RESULTS: string;
+    SAAS_ASSETS: string;
+    SAAS_COMPONENTS: string;
+    SAAS_USERS: string;
+    TENANTS: string;
+    USERS: string;
+};
+export declare const REPORTS: {
+    HEALTH_SCORE: string;
+    EMPLOYEE_TOOLING_COVERAGE: string;
+    ENDPOINT_TOOLING_COVERAGE: string;
+    VULNERABILITY_SLA: string;
+    TOP_RISK_CONTRIBUTORS: string;
+    MFA_COVERAGE: string;
+    TRAINING_DEFICIENCIES: string;
+    SECURITY_HYGIENE: string;
+    HEALTH_SCORE_TREND: string;
+};

package/build/src/services/constants.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REPORTS = exports.KIND = exports.TARGET_API_AGENT = exports.TARGET_API_PLATFORM = exports.DEFAULT_TREND_WINDOW_MONTHS = void 0;
+exports.DEFAULT_TREND_WINDOW_MONTHS = 6;
+exports.TARGET_API_PLATFORM = 'platform';
+exports.TARGET_API_AGENT = 'api';
+exports.KIND = {
+    AGENTS: 'agents',
+    ASSETS: 'assets',
+    CONNECTORS: 'connectors',
+    FINDINGS: 'findings',
+    PROVIDERS: 'providers',
+    REPORT_RESULTS: 'report_results',
+    SAAS_ASSETS: 'saas_assets',
+    SAAS_COMPONENTS: 'saas_components',
+    SAAS_USERS: 'saas_users',
+    TENANTS: 'tenants',
+    USERS: 'users',
+};
+exports.REPORTS = {
+    HEALTH_SCORE: 'health-score',
+    EMPLOYEE_TOOLING_COVERAGE: 'workforce-tooling-employee-coverage',
+    ENDPOINT_TOOLING_COVERAGE: 'workforce-tooling-endpoint-coverage',
+    VULNERABILITY_SLA: 'vulnerability-sla',
+    TOP_RISK_CONTRIBUTORS: 'top-risk-contributors',
+    MFA_COVERAGE: 'mfa-application-coverage',
+    TRAINING_DEFICIENCIES: 'training-deficiencies',
+    SECURITY_HYGIENE: 'security-hygiene',
+    // trending reports
+    HEALTH_SCORE_TREND: 'health-trend',
+};
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AAEpC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACf,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,mBAAmB;IACnB,kBAAkB,EAAE,cAAc;CACnC,CAAC"}

package/build/src/services/data.service.d.ts

@@ -1,16 +1,11 @@
 import { BaseDto, Page } from '../dto';
 import { FilterCriteria } from '../FilterCriteria';
+import { ErrorHandler, TargetApi } from './constants';
 import { RestClient, RestRequest } from './rest';
 export interface AmpDataService<ReadT extends BaseDto> {
     list(_filter: FilterCriteria): Promise<Page<ReadT>>;
     getById(_id: string): Promise<Page<ReadT>>;
 }
-export interface ErrorHandler<T> {
-    (_error: unknown): T;
-}
-export type TargetApi = 'api' | 'platform';
-export declare const TARGET_API_PLATFORM: TargetApi;
-export declare const TARGET_API_AGENT: TargetApi;
 export declare class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService<ReadT> {
     protected readonly rest: RestClient;
     protected readonly kind: string;

package/build/src/services/data.service.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AmpDataServiceImpl = exports.TARGET_API_AGENT = exports.TARGET_API_PLATFORM = void 0;
-exports.TARGET_API_PLATFORM = 'platform';
-exports.TARGET_API_AGENT = 'api';
+exports.AmpDataServiceImpl = void 0;
 class AmpDataServiceImpl {
     constructor(rest, kind, targetApi = 'api') {
         this.rest = rest;

package/build/src/services/data.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../../../src/services/data.service.ts"],"names":[],"mappings":";;;AAca,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AAEjD,MAAa,kBAAkB;IAK7B,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,KAAK;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,IAAI,CAAI,GAAgB,EAAE,YAA6B;QACrE,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,CAAC,IAAS,CAAC;SACtB;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;SAC5B;IACH,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,GAAgB;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;YACvC,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC7B,KAAK,EAAG,KAA2B,CAAC,OAAO;gBAC3C,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAsB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;YACzC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAnDD,gDAmDC"}
+{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../../../src/services/data.service.ts"],"names":[],"mappings":";;;AAUA,MAAa,kBAAkB;IAK7B,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,KAAK;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,IAAI,CAAI,GAAgB,EAAE,YAA6B;QACrE,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,CAAC,IAAS,CAAC;SACtB;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;SAC5B;IACH,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,GAAgB;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;YACvC,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC7B,KAAK,EAAG,KAA2B,CAAC,OAAO;gBAC3C,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAsB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;YACzC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAnDD,gDAmDC"}

package/build/src/services/entity.service.d.ts

@@ -1,5 +1,6 @@
 import { BaseDto, BaseUpsertDto, ExtKeyMap, Page } from '../dto';
-import { AmpDataService, AmpDataServiceImpl, TargetApi } from './data.service';
+import { TargetApi } from './constants';
+import { AmpDataService, AmpDataServiceImpl } from './data.service';
 import { RestClient } from './rest';
 export interface AmpEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
     create(_model: WriteT): Promise<Page<ReadT>>;

package/build/src/services/entity.service.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AmpSaaSEntityServiceImpl = exports.AmpGlobalEntityServiceImpl = exports.AmpEntityServiceImpl = void 0;
+const constants_1 = require("./constants");
 const data_service_1 = require("./data.service");
 class AmpEntityServiceImpl extends data_service_1.AmpDataServiceImpl {
-    constructor(rest, kind, targetApi = data_service_1.TARGET_API_AGENT) {
+    constructor(rest, kind, targetApi = constants_1.TARGET_API_AGENT) {
         super(rest, kind, targetApi);
     }
     create(model) {
@@ -48,7 +49,7 @@ const extIdMapErrorHandler = (error) => {
     return {};
 };
 class AmpGlobalEntityServiceImpl extends AmpEntityServiceImpl {
-    constructor(rest, kind, targetApi = data_service_1.TARGET_API_AGENT) {
+    constructor(rest, kind, targetApi = constants_1.TARGET_API_AGENT) {
         super(rest, kind, targetApi);
     }
     getLookupIds(tid) {
@@ -62,7 +63,7 @@ class AmpGlobalEntityServiceImpl extends AmpEntityServiceImpl {
 }
 exports.AmpGlobalEntityServiceImpl = AmpGlobalEntityServiceImpl;
 class AmpSaaSEntityServiceImpl extends AmpEntityServiceImpl {
-    constructor(rest, kind, targetApi = data_service_1.TARGET_API_AGENT) {
+    constructor(rest, kind, targetApi = constants_1.TARGET_API_AGENT) {
         super(rest, kind, targetApi);
     }
     getLookupIds(cid) {

package/build/src/services/entity.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity.service.js","sourceRoot":"","sources":["../../../src/services/entity.service.ts"],"names":[],"mappings":";;;AACA,iDAA6G;AAqB7G,MAAa,oBAA0E,SAAQ,iCAAyB;IACtH,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,+BAAgB;QACjF,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;YACzC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE;YACrD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,MAAM,GAAG,GAAgB;gBACvB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;gBAC/C,MAAM,EAAE,QAAQ;aACjB,CAAC;YACF,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;gBACtD,IAAI,KAAK,YAAY,KAAK,EAAE;oBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;iBAC9B;gBACD,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAC,CAAC;YACjC,CAAC,CAAC,CAAC;YACH,IAAI,KAAK,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,IAAI,aAAa,EAAE,GAAG,CAAC,CAAC;aAClE;SACF;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAxCD,oDAwCC;AAED,MAAM,oBAAoB,GAA4B,CAAC,KAAc,EAAE,EAAE;IACvE,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9B;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAa,0BACX,SAAQ,oBAAmC;IAG3C,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,+BAAgB;QACjF,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IACD,YAAY,CAAC,GAAW;QACtB,MAAM,GAAG,GAAgB;YACvB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,cAAc;YACrD,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,EAAC,GAAG,EAAC;SACd,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC9C,CAAC;CACF;AAfD,gEAeC;AAED,MAAa,wBACX,SAAQ,oBAAmC;IAG3C,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,+BAAgB;QACjF,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IACD,YAAY,CAAC,GAAW;QACtB,MAAM,GAAG,GAAgB;YACvB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,cAAc;YACrD,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,EAAC,GAAG,EAAC;SACd,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC9C,CAAC;CACF;AAfD,4DAeC"}
+{"version":3,"file":"entity.service.js","sourceRoot":"","sources":["../../../src/services/entity.service.ts"],"names":[],"mappings":";;;AACA,2CAAsE;AACtE,iDAAkE;AAqBlE,MAAa,oBAA0E,SAAQ,iCAAyB;IACtH,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,4BAAgB;QACjF,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;YACzC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE;YACrD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnC,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,MAAM,GAAG,GAAgB;gBACvB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;gBAC/C,MAAM,EAAE,QAAQ;aACjB,CAAC;YACF,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;gBACtD,IAAI,KAAK,YAAY,KAAK,EAAE;oBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;iBAC9B;gBACD,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAC,CAAC;YACjC,CAAC,CAAC,CAAC;YACH,IAAI,KAAK,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,IAAI,aAAa,EAAE,GAAG,CAAC,CAAC;aAClE;SACF;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAxCD,oDAwCC;AAED,MAAM,oBAAoB,GAA4B,CAAC,KAAc,EAAE,EAAE;IACvE,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9B;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAa,0BACX,SAAQ,oBAAmC;IAG3C,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,4BAAgB;QACjF,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IACD,YAAY,CAAC,GAAW;QACtB,MAAM,GAAG,GAAgB;YACvB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,cAAc;YACrD,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,EAAC,GAAG,EAAC;SACd,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC9C,CAAC;CACF;AAfD,gEAeC;AAED,MAAa,wBACX,SAAQ,oBAAmC;IAG3C,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,4BAAgB;QACjF,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IACD,YAAY,CAAC,GAAW;QACtB,MAAM,GAAG,GAAgB;YACvB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,cAAc;YACrD,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,EAAC,GAAG,EAAC;SACd,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC9C,CAAC;CACF;AAfD,4DAeC"}

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

@@ -1,5 +1,6 @@
 export * from './AmpApi';
 export * from './AmpSdk';
+export * from './constants';
 export * from './data.service';
 export * from './entity.service';
 export * from './rest';

package/build/src/services/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AmpApi"), exports);
 __exportStar(require("./AmpSdk"), exports);
+__exportStar(require("./constants"), exports);
 __exportStar(require("./data.service"), exports);
 __exportStar(require("./entity.service"), exports);
 __exportStar(require("./rest"), exports);

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

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,2CAAyB;AACzB,8CAA4B;AAC5B,iDAA+B;AAC/B,mDAAiC;AACjC,yCAAuB"}

package/build/src/services/reports.service.d.ts

@@ -0,0 +1,20 @@
+import { FilterCriteria } from '../FilterCriteria';
+import { Page, ReportResultDto } from '../dto';
+import { RestClient } from './rest';
+export interface AmpReportService {
+    getMetrics: (_reportId: string, _filter?: FilterCriteria) => Promise<Page<ReportResultDto>>;
+    getMetricsTrend: (_reportId: string, _filter?: FilterCriteria) => Promise<Page<ReportResultDto>>;
+}
+export declare class AmpReportServiceImpl implements AmpReportService {
+    protected readonly rest: RestClient;
+    constructor(rest: RestClient);
+    getMetrics(reportId: string, filter?: FilterCriteria | undefined): Promise<Page<ReportResultDto>>;
+    /**
+     *
+     * @deprecated
+     * @param reportId
+     * @param filter
+     * @returns
+     */
+    getMetricsTrend(reportId: string, filter?: FilterCriteria): Promise<Page<ReportResultDto>>;
+}

package/build/src/services/reports.service.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmpReportServiceImpl = void 0;
+const constants_1 = require("./constants");
+class AmpReportServiceImpl {
+    constructor(rest) {
+        this.rest = rest;
+    }
+    async getMetrics(reportId, filter) {
+        var _a;
+        filter = filter !== null && filter !== void 0 ? filter : {};
+        filter.limit = (_a = filter.limit) !== null && _a !== void 0 ? _a : 1; // pull latest result by default
+        try {
+            const req = {
+                url: `/api/v1/reports/${reportId}/metrics`,
+                method: 'GET',
+                params: filter !== null && filter !== void 0 ? filter : {},
+            };
+            const res = await this.rest.call(req);
+            return res.data;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                console.error(error.message);
+            }
+            return {
+                data: [],
+                kind: constants_1.KIND.REPORT_RESULTS.toUpperCase(),
+                error: error.message,
+                hints: {},
+            };
+        }
+    }
+    /**
+     *
+     * @deprecated
+     * @param reportId
+     * @param filter
+     * @returns
+     */
+    async getMetricsTrend(reportId, filter) {
+        var _a;
+        // I am breaking this out into a separate method so that we can extend typing later
+        // and add buckets/aggregations to the args
+        filter = filter !== null && filter !== void 0 ? filter : {};
+        filter.limit = (_a = filter.limit) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_TREND_WINDOW_MONTHS;
+        return this.getMetrics(reportId, filter);
+    }
+}
+exports.AmpReportServiceImpl = AmpReportServiceImpl;
+//# sourceMappingURL=reports.service.js.map

package/build/src/services/reports.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.service.js","sourceRoot":"","sources":["../../../src/services/reports.service.ts"],"names":[],"mappings":";;;AAEA,2CAA8D;AAQ9D,MAAa,oBAAoB;IAG/B,YAAY,IAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,MAAmC;;QACpE,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAC,gCAAgC;QAClE,IAAI;YACF,MAAM,GAAG,GAAG;gBACV,GAAG,EAAE,mBAAmB,QAAQ,UAAU;gBAC1C,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE;aACN,CAAC;YACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,CAAC,IAA6B,CAAC;SAC1C;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,gBAAI,CAAC,cAAc,CAAC,WAAW,EAAE;gBACvC,KAAK,EAAG,KAA2B,CAAC,OAAO;gBAC3C,KAAK,EAAE,EAAE;aACV,CAAC;SACH;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,QAAgB,EAAE,MAAuB;;QAC7D,mFAAmF;QACnF,2CAA2C;QAC3C,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,uCAA2B,CAAC;QAC3D,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF;AA7CD,oDA6CC"}

package/example/main.js

@@ -1,4 +1,4 @@
-const {AmpApi} = require('@ampsec/platform-client');
+const {AmpApi, REPORTS} = require('@ampsec/platform-client');
 const axios = require('axios');
 
 const BASE_URL = process.env.AMPSEC_API_BASE_URL || '...';
@@ -26,4 +26,24 @@ async function datagridExample() {
   }
 }
 
-datagridExample().then(() => console.log('Done!'));
+async function reportsExample() {
+  const orgHealthScorePage = await api.reports.getMetrics(REPORTS.HEALTH_SCORE);
+  console.log('Health Score:', orgHealthScorePage.data[0].results);
+  const salesHealthScorePage = await api.reports.getMetrics(REPORTS.HEALTH_SCORE, {department: 'Sales'});
+  console.log('Sales Health Score:', salesHealthScorePage.data[0].results);
+  const toolingCoveragePage = await api.reports.getMetrics(REPORTS.EMPLOYEE_TOOLING_COVERAGE);
+  console.log('Tooling Coverage:', toolingCoveragePage.data[0].results);
+  const healthTrendPage = await api.reports.getMetricsTrend(REPORTS.HEALTH_SCORE_TREND);
+  console.log('Health Score Trend:');
+  for (const metric of healthTrendPage.data) {
+    console.log('   - ', metric);
+  }
+}
+
+async function run() {
+  await datagridExample();
+  await reportsExample();
+  console.log('Done!');
+}
+
+run();

package/example/package.json

@@ -10,7 +10,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@ampsec/platform-client": "^10.0.0",
+    "@ampsec/platform-client": "^10.3.0",
     "axios": "^1.4.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "10.2.0",
+  "version": "10.3.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/services/AmpApi.ts

@@ -17,6 +17,8 @@ import {
 import {AmpEntityService, AmpEntityServiceImpl} from './entity.service';
 import {AmpDataService, AmpDataServiceImpl} from './data.service';
 import {AmpRestClientOptions, RestClient, getAmpRestClient} from './rest';
+import {KIND} from './constants';
+import {AmpReportService, AmpReportServiceImpl} from './reports.service';
 
 export type AmpApiOptions = AmpRestClientOptions;
 
@@ -39,6 +41,7 @@ export class AmpApi {
   readonly findings: AmpDataService<FindingDto>;
   readonly providers: AmpDataService<ProviderDto>;
   readonly reportResults: AmpDataService<ReportResultDto>;
+  readonly reports: AmpReportService;
   readonly saasAssets: AmpDataService<SaasAssetDto>;
   readonly saasComponents: AmpDataService<SaasComponentDto>;
   readonly saasUsers: AmpDataService<SaasUserDto>;
@@ -46,17 +49,18 @@ export class AmpApi {
   readonly users: AmpDataService<UserDto>;
 
   constructor(rest: RestClient) {
-    this.agents = new AmpEntityServiceImpl<AgentUpsertDto, AgentDto>(rest, 'agents');
-    this.asset = new AmpDataServiceImpl<AssetDto>(rest, 'assets');
-    this.connectors = new AmpEntityServiceImpl<ConnectorUpsertDto, ConnectorDto>(rest, 'connectors');
-    this.findings = new AmpDataServiceImpl<FindingDto>(rest, 'findings');
-    this.providers = new AmpDataServiceImpl<ProviderDto>(rest, 'providers');
-    this.reportResults = new AmpDataServiceImpl<ReportResultDto>(rest, 'report_results');
-    this.saasAssets = new AmpDataServiceImpl<SaasAssetDto>(rest, 'saas_assets');
-    this.saasComponents = new AmpDataServiceImpl<SaasComponentDto>(rest, 'saas_components');
-    this.saasUsers = new AmpDataServiceImpl<SaasUserDto>(rest, 'saas_users');
-    this.tenants = new AmpEntityServiceImpl<TenantUpsertDto, TenantDto>(rest, 'agents');
-    this.users = new AmpDataServiceImpl<UserDto>(rest, 'users');
+    this.agents = new AmpEntityServiceImpl<AgentUpsertDto, AgentDto>(rest, KIND.AGENTS);
+    this.asset = new AmpDataServiceImpl<AssetDto>(rest, KIND.ASSETS);
+    this.connectors = new AmpEntityServiceImpl<ConnectorUpsertDto, ConnectorDto>(rest, KIND.CONNECTORS);
+    this.findings = new AmpDataServiceImpl<FindingDto>(rest, KIND.FINDINGS);
+    this.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS);
+    this.reportResults = new AmpDataServiceImpl<ReportResultDto>(rest, KIND.REPORT_RESULTS);
+    this.reports = new AmpReportServiceImpl(rest);
+    this.saasAssets = new AmpDataServiceImpl<SaasAssetDto>(rest, KIND.SAAS_ASSETS);
+    this.saasComponents = new AmpDataServiceImpl<SaasComponentDto>(rest, KIND.SAAS_COMPONENTS);
+    this.saasUsers = new AmpDataServiceImpl<SaasUserDto>(rest, KIND.SAAS_USERS);
+    this.tenants = new AmpEntityServiceImpl<TenantUpsertDto, TenantDto>(rest, KIND.TENANTS);
+    this.users = new AmpDataServiceImpl<UserDto>(rest, KIND.USERS);
   }
 
   static instance(options: AmpApiOptions): AmpApi {

package/src/services/AmpSdk.ts

@@ -22,8 +22,9 @@ import {
   TenantUpsertDto,
 } from '../dto';
 import {AmpEntityService, AmpEntityServiceImpl, AmpGlobalEntityService, AmpGlobalEntityServiceImpl, AmpSaaSEntityService, AmpSaaSEntityServiceImpl} from './entity.service';
-import {AmpDataService, AmpDataServiceImpl, TARGET_API_AGENT, TARGET_API_PLATFORM} from './data.service';
+import {AmpDataService, AmpDataServiceImpl} from './data.service';
 import {AmpRestClientOptions, RestClient, getAmpRestClient} from './rest';
+import {KIND, TARGET_API_AGENT, TARGET_API_PLATFORM} from './constants';
 
 export type AmpSdkOptions = AmpRestClientOptions;
 
@@ -52,17 +53,17 @@ export class AmpSdkServices {
   readonly users: AmpGlobalEntityService<PlatformUserUpsertDto, PlatformUserDto>;
 
   constructor(rest: RestClient) {
-    this.agents = new AmpEntityServiceImpl<PlatformAgentUpsertDto, PlatformAgentDto>(rest, 'agents', TARGET_API_PLATFORM);
-    this.asset = new AmpGlobalEntityServiceImpl<PlatformAssetUpsertDto, PlatformAssetDto>(rest, 'assets', TARGET_API_PLATFORM);
-    this.connectors = new AmpEntityServiceImpl<PlatformConnectorUpsertDto, PlatformConnectorDto>(rest, 'connectors', TARGET_API_PLATFORM);
-    this.findings = new AmpSaaSEntityServiceImpl<PlatformFindingUpsertDto, PlatformFindingDto>(rest, 'findings', TARGET_API_PLATFORM);
-    this.providers = new AmpDataServiceImpl<ProviderDto>(rest, 'providers', TARGET_API_AGENT);
-    this.reportResults = new AmpSaaSEntityServiceImpl<PlatformReportResultUpsertDto, PlatformReportResultDto>(rest, 'report_results', TARGET_API_PLATFORM);
-    this.saasAssets = new AmpSaaSEntityServiceImpl<PlatformSaasAssetUpsertDto, PlatformSaasAssetDto>(rest, 'saas_assets', TARGET_API_PLATFORM);
-    this.saasComponents = new AmpSaaSEntityServiceImpl<PlatformSaasComponentUpsertDto, PlatformSaasComponentDto>(rest, 'saas_components', TARGET_API_PLATFORM);
-    this.saasUsers = new AmpSaaSEntityServiceImpl<PlatformSaasUserUpsertDto, PlatformSaasUserDto>(rest, 'saas_users', TARGET_API_PLATFORM);
-    this.tenants = new AmpEntityServiceImpl<TenantUpsertDto, TenantDto>(rest, 'tenants', TARGET_API_PLATFORM);
-    this.users = new AmpGlobalEntityServiceImpl<PlatformUserUpsertDto, PlatformUserDto>(rest, 'users', TARGET_API_PLATFORM);
+    this.agents = new AmpEntityServiceImpl<PlatformAgentUpsertDto, PlatformAgentDto>(rest, KIND.AGENTS, TARGET_API_PLATFORM);
+    this.asset = new AmpGlobalEntityServiceImpl<PlatformAssetUpsertDto, PlatformAssetDto>(rest, KIND.ASSETS, TARGET_API_PLATFORM);
+    this.connectors = new AmpEntityServiceImpl<PlatformConnectorUpsertDto, PlatformConnectorDto>(rest, KIND.CONNECTORS, TARGET_API_PLATFORM);
+    this.findings = new AmpSaaSEntityServiceImpl<PlatformFindingUpsertDto, PlatformFindingDto>(rest, KIND.FINDINGS, TARGET_API_PLATFORM);
+    this.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS, TARGET_API_AGENT);
+    this.reportResults = new AmpSaaSEntityServiceImpl<PlatformReportResultUpsertDto, PlatformReportResultDto>(rest, KIND.REPORT_RESULTS, TARGET_API_PLATFORM);
+    this.saasAssets = new AmpSaaSEntityServiceImpl<PlatformSaasAssetUpsertDto, PlatformSaasAssetDto>(rest, KIND.SAAS_ASSETS, TARGET_API_PLATFORM);
+    this.saasComponents = new AmpSaaSEntityServiceImpl<PlatformSaasComponentUpsertDto, PlatformSaasComponentDto>(rest, KIND.SAAS_COMPONENTS, TARGET_API_PLATFORM);
+    this.saasUsers = new AmpSaaSEntityServiceImpl<PlatformSaasUserUpsertDto, PlatformSaasUserDto>(rest, KIND.SAAS_USERS, TARGET_API_PLATFORM);
+    this.tenants = new AmpEntityServiceImpl<TenantUpsertDto, TenantDto>(rest, KIND.TENANTS, TARGET_API_PLATFORM);
+    this.users = new AmpGlobalEntityServiceImpl<PlatformUserUpsertDto, PlatformUserDto>(rest, KIND.USERS, TARGET_API_PLATFORM);
   }
 
   static instance(options: AmpSdkOptions): AmpSdkServices {

package/src/services/constants.ts

@@ -0,0 +1,36 @@
+export interface ErrorHandler<T> {
+  (_error: unknown): T;
+}
+
+export const DEFAULT_TREND_WINDOW_MONTHS = 6;
+
+export type TargetApi = 'api' | 'platform';
+export const TARGET_API_PLATFORM: TargetApi = 'platform';
+export const TARGET_API_AGENT: TargetApi = 'api';
+
+export const KIND = {
+  AGENTS: 'agents',
+  ASSETS: 'assets',
+  CONNECTORS: 'connectors',
+  FINDINGS: 'findings',
+  PROVIDERS: 'providers',
+  REPORT_RESULTS: 'report_results',
+  SAAS_ASSETS: 'saas_assets',
+  SAAS_COMPONENTS: 'saas_components',
+  SAAS_USERS: 'saas_users',
+  TENANTS: 'tenants',
+  USERS: 'users',
+};
+
+export const REPORTS = {
+  HEALTH_SCORE: 'health-score',
+  EMPLOYEE_TOOLING_COVERAGE: 'workforce-tooling-employee-coverage',
+  ENDPOINT_TOOLING_COVERAGE: 'workforce-tooling-endpoint-coverage',
+  VULNERABILITY_SLA: 'vulnerability-sla',
+  TOP_RISK_CONTRIBUTORS: 'top-risk-contributors',
+  MFA_COVERAGE: 'mfa-application-coverage',
+  TRAINING_DEFICIENCIES: 'training-deficiencies',
+  SECURITY_HYGIENE: 'security-hygiene',
+  // trending reports
+  HEALTH_SCORE_TREND: 'health-trend',
+};

package/src/services/data.service.ts

@@ -1,5 +1,6 @@
 import {BaseDto, Page} from '../dto';
 import {FilterCriteria} from '../FilterCriteria';
+import {ErrorHandler, TargetApi} from './constants';
 import {RestClient, RestRequest} from './rest';
 
 export interface AmpDataService<ReadT extends BaseDto> {
@@ -7,14 +8,6 @@ export interface AmpDataService<ReadT extends BaseDto> {
   getById(_id: string): Promise<Page<ReadT>>;
 }
 
-export interface ErrorHandler<T> {
-  (_error: unknown): T;
-}
-
-export type TargetApi = 'api' | 'platform';
-export const TARGET_API_PLATFORM: TargetApi = 'platform';
-export const TARGET_API_AGENT: TargetApi = 'api';
-
 export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService<ReadT> {
   protected readonly rest: RestClient;
   protected readonly kind: string;

package/src/services/entity.service.ts

@@ -1,5 +1,6 @@
 import {BaseDto, BaseUpsertDto, ExtKeyMap, Page} from '../dto';
-import {AmpDataService, AmpDataServiceImpl, ErrorHandler, TARGET_API_AGENT, TargetApi} from './data.service';
+import {TargetApi, TARGET_API_AGENT, ErrorHandler} from './constants';
+import {AmpDataService, AmpDataServiceImpl} from './data.service';
 import {RestClient, RestRequest} from './rest';
 
 export interface AmpEntityService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {

package/src/services/index.ts

@@ -1,5 +1,6 @@
 export * from './AmpApi';
 export * from './AmpSdk';
+export * from './constants';
 export * from './data.service';
 export * from './entity.service';
 export * from './rest';

package/src/services/reports.service.ts

@@ -0,0 +1,56 @@
+import {FilterCriteria} from '../FilterCriteria';
+import {Page, ReportResultDto} from '../dto';
+import {DEFAULT_TREND_WINDOW_MONTHS, KIND} from './constants';
+import {RestClient, RestRequest} from './rest';
+
+export interface AmpReportService {
+  getMetrics: (_reportId: string, _filter?: FilterCriteria) => Promise<Page<ReportResultDto>>;
+  getMetricsTrend: (_reportId: string, _filter?: FilterCriteria) => Promise<Page<ReportResultDto>>;
+}
+
+export class AmpReportServiceImpl implements AmpReportService {
+  protected readonly rest: RestClient;
+
+  constructor(rest: RestClient) {
+    this.rest = rest;
+  }
+
+  async getMetrics(reportId: string, filter?: FilterCriteria | undefined): Promise<Page<ReportResultDto>> {
+    filter = filter ?? {};
+    filter.limit = filter.limit ?? 1; // pull latest result by default
+    try {
+      const req = {
+        url: `/api/v1/reports/${reportId}/metrics`,
+        method: 'GET',
+        params: filter ?? {},
+      } as RestRequest;
+      const res = await this.rest.call(req);
+      return res.data as Page<ReportResultDto>;
+    } catch (error: unknown) {
+      if (error instanceof Error) {
+        console.error(error.message);
+      }
+      return {
+        data: [],
+        kind: KIND.REPORT_RESULTS.toUpperCase(),
+        error: (error as {message: string}).message,
+        hints: {},
+      };
+    }
+  }
+
+  /**
+   *
+   * @deprecated
+   * @param reportId
+   * @param filter
+   * @returns
+   */
+  async getMetricsTrend(reportId: string, filter?: FilterCriteria): Promise<Page<ReportResultDto>> {
+    // I am breaking this out into a separate method so that we can extend typing later
+    // and add buckets/aggregations to the args
+    filter = filter ?? {};
+    filter.limit = filter.limit ?? DEFAULT_TREND_WINDOW_MONTHS;
+    return this.getMetrics(reportId, filter);
+  }
+}