@ampsec/platform-client 10.3.0 → 11.0.0

package/build/src/dto/enum.dto.d.ts

@@ -0,0 +1,5 @@
+export type EnumDto = {
+    [enumValueName: string]: {
+        total: number;
+    };
+};

package/build/src/dto/{metrics.dto.js → enum.dto.js}

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

package/build/src/dto/enum.dto.js.map

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

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

@@ -2,11 +2,11 @@ export * from './agents.dto';
 export * from './assets.dto';
 export * from './base.dto';
 export * from './connectors.dto';
+export * from './enum.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';

package/build/src/dto/index.js

@@ -18,11 +18,11 @@ __exportStar(require("./agents.dto"), exports);
 __exportStar(require("./assets.dto"), exports);
 __exportStar(require("./base.dto"), exports);
 __exportStar(require("./connectors.dto"), exports);
+__exportStar(require("./enum.dto"), exports);
 __exportStar(require("./enums"), exports);
 __exportStar(require("./extKeyMap.dto"), exports);
 __exportStar(require("./findings.dto"), exports);
 __exportStar(require("./message.dto"), exports);
-__exportStar(require("./metrics.dto"), exports);
 __exportStar(require("./page.dto"), exports);
 __exportStar(require("./platform"), exports);
 __exportStar(require("./providers.dto"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,6CAA2B;AAC3B,mDAAiC;AACjC,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,gDAA8B;AAC9B,gDAA8B;AAC9B,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,gDAA8B;AAC9B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,6CAA2B;AAC3B,mDAAiC;AACjC,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,gDAA8B;AAC9B,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,gDAA8B;AAC9B,8CAA4B"}

package/build/src/dto/platform/index.d.ts

@@ -2,7 +2,6 @@ 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';

package/build/src/dto/platform/index.js

@@ -18,7 +18,6 @@ __exportStar(require("./platform.agents.dto"), exports);
 __exportStar(require("./platform.assets.dto"), exports);
 __exportStar(require("./platform.connectors.dto"), exports);
 __exportStar(require("./platform.findings.dto"), exports);
-__exportStar(require("./platform.metrics.dto"), exports);
 __exportStar(require("./platform.providers.dto"), exports);
 __exportStar(require("./platform.reportResults.dto"), exports);
 __exportStar(require("./platform.saasAssets.dto"), exports);

package/build/src/dto/platform/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/platform/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,2DAAyC;AACzC,+DAA6C;AAC7C,4DAA0C;AAC1C,gEAA8C;AAC9C,2DAAyC;AACzC,yDAAuC;AACvC,uDAAqC;AACrC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/platform/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,4DAA0C;AAC1C,0DAAwC;AACxC,2DAAyC;AACzC,+DAA6C;AAC7C,4DAA0C;AAC1C,gEAA8C;AAC9C,2DAAyC;AACzC,yDAAuC;AACvC,uDAAqC;AACrC,qDAAmC"}

package/build/src/dto/reportResults.dto.d.ts

@@ -1,5 +1,8 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { MetricKind } from './enums/metric.kind';
+export type Meta = {
+    [propName: string]: Meta | string | number;
+};
 export type BaseMetric = {
     /** Kind indicator for metric type */
     kind: MetricKind;
@@ -7,6 +10,8 @@ export type BaseMetric = {
     label: string;
     /** Primary display value */
     value: number;
+    /** Generic field to hold additional information */
+    meta?: Meta;
 };
 export type DescriptiveMetric = BaseMetric & {
     /** Additional context label */

package/build/src/dto/users.dto.d.ts

@@ -1,5 +1,5 @@
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
-import { MetricDto } from './metrics.dto';
+import { MetricResults } from './reportResults.dto';
 import { RiskContributorDto } from './riskContributors.dto';
 export type UserUpsertDto = ChangeAwareUpsertDto & {
     /** Tenant ID */
@@ -21,6 +21,6 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
     /** Risk Contributors associated with the user */
     riskContributors: RiskContributorDto[];
     /** Metrics associated with the user */
-    metrics: MetricDto[];
+    metrics?: MetricResults;
 };
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/package.json

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

package/src/dto/enum.dto.ts

@@ -0,0 +1,3 @@
+export type EnumDto = {
+  [enumValueName: string]: {total: number};
+};

package/src/dto/index.ts

@@ -2,11 +2,11 @@ export * from './agents.dto';
 export * from './assets.dto';
 export * from './base.dto';
 export * from './connectors.dto';
+export * from './enum.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';

package/src/dto/platform/index.ts

@@ -2,7 +2,6 @@ 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';

package/src/dto/reportResults.dto.ts

@@ -1,6 +1,10 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {MetricKind} from './enums/metric.kind';
 
+export type Meta = {
+  [propName: string]: Meta | string | number;
+};
+
 export type BaseMetric = {
   /** Kind indicator for metric type */
   kind: MetricKind;
@@ -8,6 +12,8 @@ export type BaseMetric = {
   label: string;
   /** Primary display value */
   value: number;
+  /** Generic field to hold additional information */
+  meta?: Meta;
 };
 
 export type DescriptiveMetric = BaseMetric & {

package/src/dto/users.dto.ts

@@ -1,5 +1,5 @@
 import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
-import {MetricDto} from './metrics.dto';
+import {MetricResults} from './reportResults.dto';
 import {RiskContributorDto} from './riskContributors.dto';
 
 export type UserUpsertDto = ChangeAwareUpsertDto & {
@@ -22,7 +22,7 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
   /** Risk Contributors associated with the user */
   riskContributors: RiskContributorDto[];
   /** Metrics associated with the user */
-  metrics: MetricDto[];
+  metrics?: MetricResults;
 };
 
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/build/src/dto/metrics.dto.d.ts

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

package/build/src/dto/metrics.dto.js.map

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

package/build/src/dto/platform/platform.metrics.dto.d.ts

@@ -1,4 +0,0 @@
-import { MetricDto, MetricUpsertDto } from '../metrics.dto';
-import { TenantBased, UpsertTenantBased } from './tenant.based.dto';
-export type PlatformMetricUpsertDto = MetricUpsertDto & UpsertTenantBased;
-export type PlatformMetricDto = MetricDto & TenantBased;

package/build/src/dto/platform/platform.metrics.dto.js

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

package/build/src/dto/platform/platform.metrics.dto.js.map

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

package/src/dto/metrics.dto.ts

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

package/src/dto/platform/platform.metrics.dto.ts

@@ -1,6 +0,0 @@
-import {MetricDto, MetricUpsertDto} from '../metrics.dto';
-import {TenantBased, UpsertTenantBased} from './tenant.based.dto';
-
-export type PlatformMetricUpsertDto = MetricUpsertDto & UpsertTenantBased;
-
-export type PlatformMetricDto = MetricDto & TenantBased;