@ampsec/platform-client 4.0.1 → 6.0.0

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

@@ -3,6 +3,6 @@ export type AssetUpsertDto = ChangeAwareUpsertDto & {
     /** External Id */
     sn: string;
     /** User Id of the asset owner */
-    uid?: number | undefined;
+    uid?: string | undefined;
 };
 export type AssetDto = ChangeAwareDto & AssetUpsertDto;

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

@@ -4,7 +4,7 @@ export type BaseUpsertDto = {
 };
 export type BaseDto = {
     /** Unique Row Identifier */
-    id: number;
+    id: string;
     /** Record creation date in database. */
     createdAt: string;
     /** Last record update date in database. */

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

@@ -6,6 +6,6 @@ export type ConnectorUpsertDto = BaseUpsertDto & {
     /** Status of the connector, e.g. ACTIVE */
     status: ConnectorStatus;
     /** Provider Id */
-    pid?: number | null;
+    pid?: string | null;
 };
 export type ConnectorDto = BaseDto & ConnectorUpsertDto;

package/build/src/dto/enums/metric.kind.d.ts

@@ -0,0 +1,5 @@
+export declare enum MetricKind {
+    BASE = "BASE",
+    DESCRIPTIVE = "DESCRIPTIVE",
+    TRENDING = "TRENDING"
+}

package/build/src/dto/enums/metric.kind.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricKind = void 0;
+/* eslint-disable no-unused-vars */
+var MetricKind;
+(function (MetricKind) {
+    MetricKind["BASE"] = "BASE";
+    MetricKind["DESCRIPTIVE"] = "DESCRIPTIVE";
+    MetricKind["TRENDING"] = "TRENDING";
+})(MetricKind = exports.MetricKind || (exports.MetricKind = {}));
+//# sourceMappingURL=metric.kind.js.map

package/build/src/dto/enums/metric.kind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/metric.kind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,yCAA2B,CAAA;IAC3B,mCAAqB,CAAA;AACvB,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB"}

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

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

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

@@ -17,8 +17,8 @@ export type FindingUpsertDto = BaseUpsertDto & {
     /** Description of the finding */
     description?: string;
     /** Id of the user to which the finding applies */
-    uid?: number | undefined;
+    uid?: string | undefined;
     /** Id of the SaasComponent related to the given finding */
-    scid: number;
+    scid: string;
 };
 export type FindingDto = BaseDto & FindingUpsertDto;

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

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

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=reports.dto.js.map

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

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

package/build/src/dto/platform/tenant.based.dto.d.ts

@@ -1,9 +1,9 @@
 import { BaseDto, BaseUpsertDto } from '../base.dto';
 export type UpsertTenantBased = BaseUpsertDto & {
     /** Tenant Id */
-    tid?: number;
+    tid?: string;
 };
 export type TenantBased = BaseDto & {
     /** Tenant Id */
-    tid: number;
+    tid: string;
 };

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

@@ -1,10 +1,37 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
+import { MetricKind } from './enums/metric.kind';
+export type BaseMetric = {
+    /** Kind indicator for metric type */
+    kind: MetricKind;
+    /** Primary descriptive label */
+    label: string;
+    /** Primary display value */
+    value: number;
+};
+export type DescriptiveMetric = BaseMetric & {
+    /** Additional context label */
+    ctxLabel: string;
+    /** Additional context value */
+    ctxValue: number;
+};
+export type TrendingMetric = BaseMetric & {
+    /** Directional indicator: + = up, - = down, 0 = no change */
+    delta: number;
+};
+export type MetricResultsSubsection = {
+    [key: string]: BaseMetric[] | DescriptiveMetric[] | TrendingMetric[];
+};
+export type MetricResults = MetricResultsSubsection[] | BaseMetric[] | DescriptiveMetric[] | TrendingMetric[];
 export type ReportResultUpsertDto = BaseUpsertDto & {
     /** External Id */
     extKey: string;
+    /** User Id */
+    uid?: string;
+    /** Department */
+    department?: string | null;
     /** Timestamp the report result was generated in ISO8601 format */
     ts: string;
     /** The results generated for the given report */
-    results: unknown;
+    results: MetricResults;
 };
 export type ReportResultDto = BaseDto & ReportResultUpsertDto;

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

@@ -3,11 +3,11 @@ export type SaasAssetUpsertDto = ChangeAwareUpsertDto & {
     /** External Id */
     sn: string;
     /** Connector Id */
-    cid: number;
+    cid: string;
     /** Asset Id */
-    aid: number;
+    aid: string;
     /** User Id */
-    uid?: number | undefined;
+    uid?: string | undefined;
     /** Information specific to this asset */
     meta: unknown;
 };

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

@@ -1,15 +1,15 @@
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
 export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {
     /** Asset Id */
-    aid?: number | undefined;
+    aid?: string | undefined;
     /** Connector Id */
-    cid: number;
+    cid: string;
     /**  */
     kind: string;
     /** Context specific information related to the Saas Component */
     meta: unknown;
     /** User Id of the affected user */
-    uid?: number | undefined;
+    uid?: string | undefined;
     /** External Id */
     extKey: string;
 };

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

@@ -1,9 +1,9 @@
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
 export type SaasUserUpsertDto = ChangeAwareUpsertDto & {
     /** User Id */
-    uid: number;
+    uid: string;
     /** Connector Id */
-    cid: number;
+    cid: string;
     /** External Id */
     email: string;
     /** Additional information specific to this Saas User */

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

@@ -3,7 +3,7 @@ import { MetricDto } from './metrics.dto';
 import { RiskContributorDto } from './riskContributors.dto';
 export type UserUpsertDto = ChangeAwareUpsertDto & {
     /** Tenant ID */
-    tid: number;
+    tid: string;
     /** External ID: list of emails, allows or merging users across email aliases */
     emails: string[];
     /** User first name */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "4.0.1",
+  "version": "6.0.0",
   "description": "",
   "main": "build/src/index.js",
   "scripts": {

package/src/dto/assets.dto.ts

@@ -4,7 +4,7 @@ export type AssetUpsertDto = ChangeAwareUpsertDto & {
   /** External Id */
   sn: string;
   /** User Id of the asset owner */
-  uid?: number | undefined;
+  uid?: string | undefined;
 };
 
 export type AssetDto = ChangeAwareDto & AssetUpsertDto;

package/src/dto/base.dto.ts

@@ -5,7 +5,7 @@ export type BaseUpsertDto = {
 
 export type BaseDto = {
   /** Unique Row Identifier */
-  id: number;
+  id: string;
   /** Record creation date in database. */
   createdAt: string;
   /** Last record update date in database. */

package/src/dto/connectors.dto.ts

@@ -7,7 +7,7 @@ export type ConnectorUpsertDto = BaseUpsertDto & {
   /** Status of the connector, e.g. ACTIVE */
   status: ConnectorStatus;
   /** Provider Id */
-  pid?: number | null;
+  pid?: string | null;
 };
 
 export type ConnectorDto = BaseDto & ConnectorUpsertDto;

package/src/dto/enums/metric.kind.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-unused-vars */
+export enum MetricKind {
+  BASE = 'BASE',
+  DESCRIPTIVE = 'DESCRIPTIVE',
+  TRENDING = 'TRENDING',
+}

package/src/dto/extKeyMap.dto.ts

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

package/src/dto/findings.dto.ts

@@ -18,9 +18,9 @@ export type FindingUpsertDto = BaseUpsertDto & {
   /** Description of the finding */
   description?: string;
   /** Id of the user to which the finding applies */
-  uid?: number | undefined;
+  uid?: string | undefined;
   /** Id of the SaasComponent related to the given finding */
-  scid: number;
+  scid: string;
 };
 
 export type FindingDto = BaseDto & FindingUpsertDto;

package/src/dto/metrics.dto.ts

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

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

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

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

@@ -2,10 +2,10 @@ import {BaseDto, BaseUpsertDto} from '../base.dto';
 
 export type UpsertTenantBased = BaseUpsertDto & {
   /** Tenant Id */
-  tid?: number;
+  tid?: string;
 };
 
 export type TenantBased = BaseDto & {
   /** Tenant Id */
-  tid: number;
+  tid: string;
 };

package/src/dto/reportResults.dto.ts

@@ -1,12 +1,44 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
+import {MetricKind} from './enums/metric.kind';
+
+export type BaseMetric = {
+  /** Kind indicator for metric type */
+  kind: MetricKind;
+  /** Primary descriptive label */
+  label: string;
+  /** Primary display value */
+  value: number;
+};
+
+export type DescriptiveMetric = BaseMetric & {
+  /** Additional context label */
+  ctxLabel: string;
+  /** Additional context value */
+  ctxValue: number;
+};
+
+export type TrendingMetric = BaseMetric & {
+  /** Directional indicator: + = up, - = down, 0 = no change */
+  delta: number;
+};
+
+export type MetricResultsSubsection = {
+  [key: string]: BaseMetric[] | DescriptiveMetric[] | TrendingMetric[];
+};
+
+export type MetricResults = MetricResultsSubsection[] | BaseMetric[] | DescriptiveMetric[] | TrendingMetric[];
 
 export type ReportResultUpsertDto = BaseUpsertDto & {
   /** External Id */
   extKey: string;
+  /** User Id */
+  uid?: string;
+  /** Department */
+  department?: string | null;
   /** Timestamp the report result was generated in ISO8601 format */
   ts: string;
   /** The results generated for the given report */
-  results: unknown;
+  results: MetricResults;
 };
 
 export type ReportResultDto = BaseDto & ReportResultUpsertDto;

package/src/dto/saasAssets.dto.ts

@@ -4,11 +4,11 @@ export type SaasAssetUpsertDto = ChangeAwareUpsertDto & {
   /** External Id */
   sn: string;
   /** Connector Id */
-  cid: number;
+  cid: string;
   /** Asset Id */
-  aid: number;
+  aid: string;
   /** User Id */
-  uid?: number | undefined;
+  uid?: string | undefined;
   /** Information specific to this asset */
   meta: unknown;
 };

package/src/dto/saasComponents.dto.ts

@@ -2,15 +2,15 @@ import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
 
 export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {
   /** Asset Id */
-  aid?: number | undefined;
+  aid?: string | undefined;
   /** Connector Id */
-  cid: number;
+  cid: string;
   /**  */
   kind: string;
   /** Context specific information related to the Saas Component */
   meta: unknown;
   /** User Id of the affected user */
-  uid?: number | undefined;
+  uid?: string | undefined;
   /** External Id */
   extKey: string;
 };

package/src/dto/saasUsers.dto.ts

@@ -2,9 +2,9 @@ import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
 
 export type SaasUserUpsertDto = ChangeAwareUpsertDto & {
   /** User Id */
-  uid: number;
+  uid: string;
   /** Connector Id */
-  cid: number;
+  cid: string;
   /** External Id */
   email: string;
   /** Additional information specific to this Saas User */

package/src/dto/users.dto.ts

@@ -4,7 +4,7 @@ import {RiskContributorDto} from './riskContributors.dto';
 
 export type UserUpsertDto = ChangeAwareUpsertDto & {
   /** Tenant ID */
-  tid: number;
+  tid: string;
   /** External ID: list of emails, allows or merging users across email aliases */
   emails: string[];
   /** User first name */