@ampsec/platform-client 40.0.0 → 40.1.0

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

@@ -1,6 +1,31 @@
+/**
+ * Enum for FindingStatus
+ *
+ * |                       | OPEN                 | CLOSED |
+ * | :-------------------- | :------------------- | :----- |
+ * | Included in score     | OPEN + ACCEPTED_RISK | N/A    |
+ * | Not included in score | FALSE_POSITIVE       | CLOSED |
+ *
+ * - OPEN
+ *    - Included in Score
+ *       - OPEN
+ *       - ACCEPTED_RISK
+ *    - Not included in Score
+ *      - PENDING_VERIFICATION
+ *      - FALSE_POSITIVE
+ * - CLOSED
+ */
+
 /* eslint-disable no-unused-vars */
 export enum FindingStatus {
+  /** OPEN + INCLUDED in score */
   OPEN = 'OPEN',
-  CLOSED = 'CLOSED',
+  /** OPEN + INCLUDED in score */
   PENDING_VERIFICATION = 'PENDING_VERIFICATION',
+  /** OPEN + INCLUDED in score */
+  ACCEPTED_RISK = 'ACCEPTED_RISK',
+  /** CLOSED + IGNORED from score */
+  CLOSED = 'CLOSED',
+  /** CLOSED + IGNORED from score */
+  FALSE_POSITIVE = 'CLOSED_FALSE_POSITIVE',
 }

package/src/services/AmpApi.ts

@@ -4,7 +4,6 @@ import {
   AssetDto,
   ConnectorDto,
   ConnectorUpsertDto,
-  FindingDto,
   NotificationDto,
   ProviderDto,
   ReportResultDto,
@@ -24,6 +23,7 @@ import {DefaultEnumService, EnumService} from './rest/EnumService';
 import {AmpSettingsService} from './settings.service';
 import {AgentIdentityService} from './rest/AgentIdentityService';
 import {ConnectorInstallService} from './rest/ConnectorInstallService';
+import {FindingsService} from './findings.service';
 
 export type AmpApiOptions = AmpRestClientOptions;
 
@@ -44,7 +44,7 @@ export class AmpApi {
   readonly asset: AmpDataService<AssetDto>;
   readonly connectors: AmpEntityService<ConnectorUpsertDto, ConnectorDto>;
   readonly enums: EnumService;
-  readonly findings: AmpDataService<FindingDto>;
+  readonly findings: FindingsService;
   readonly identity: AgentIdentityService;
   readonly install: ConnectorInstallService;
   readonly notifications: AmpDataService<NotificationDto>;
@@ -63,7 +63,7 @@ export class AmpApi {
     this.asset = new AmpDataServiceImpl<AssetDto>(rest, KIND.ASSETS);
     this.connectors = new AmpEntityServiceImpl<ConnectorUpsertDto, ConnectorDto>(rest, KIND.CONNECTORS);
     this.enums = new DefaultEnumService(rest);
-    this.findings = new AmpDataServiceImpl<FindingDto>(rest, KIND.FINDINGS);
+    this.findings = new FindingsService(rest);
     this.identity = new AgentIdentityService(rest);
     this.install = new ConnectorInstallService(rest);
     this.notifications = new AmpDataServiceImpl<NotificationDto>(rest, KIND.NOTIFICATIONS);

package/src/services/data.service.ts

@@ -29,7 +29,7 @@ export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService
     this.targetApi = targetApi;
   }
 
-  protected async call<T>(req: RestRequest, errorHandler: ErrorHandler<T>): Promise<T> {
+  protected call = async <T>(req: RestRequest, errorHandler: ErrorHandler<T>): Promise<T> => {
     try {
       const res = await this.rest.call(req);
       return res.data as T;
@@ -39,9 +39,9 @@ export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService
       }
       return errorHandler(error);
     }
-  }
+  };
 
-  protected async getPage(req: RestRequest): Promise<Page<ReadT>> {
+  protected getPage = async (req: RestRequest): Promise<Page<ReadT>> => {
     return this.call(req, (error: unknown) => {
       const message = error instanceof Error ? error.message : 'Unknown error';
       return {
@@ -51,22 +51,22 @@ export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService
         hints: {},
       };
     });
-  }
+  };
 
-  list(filter: FilterCriteria): Promise<Page<ReadT>> {
+  list = (filter: FilterCriteria): Promise<Page<ReadT>> => {
     return this.getPage({
       url: `/${this.targetApi}/v1/${this.kind}`,
       method: 'GET',
       params: filter,
     });
-  }
+  };
 
-  getById(id: string): Promise<Page<ReadT>> {
+  getById = (id: string): Promise<Page<ReadT>> => {
     return this.getPage({
       url: `/${this.targetApi}/v1/${this.kind}/${id}`,
       method: 'GET',
     });
-  }
+  };
 }
 
 export class AmpPatchDataServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataServiceImpl<ReadT> implements AmpPatchDataService<WriteT, ReadT> {
@@ -74,7 +74,7 @@ export class AmpPatchDataServiceImpl<WriteT extends BaseUpsertDto, ReadT extends
     super(rest, kind, targetApi);
   }
 
-  patch(model: WriteT | WriteT[], options: DataServiceCallOptions): Promise<Page<ReadT>> {
+  patch = (model: WriteT | WriteT[], options: DataServiceCallOptions): Promise<Page<ReadT>> => {
     const url = _.isArray(model) ? `/${this.targetApi}/v1/${this.kind}` : `/${this.targetApi}/v1/${this.kind}/${model.id}`;
     return this.getPage({
       url,
@@ -82,5 +82,5 @@ export class AmpPatchDataServiceImpl<WriteT extends BaseUpsertDto, ReadT extends
       params: options.params as QueryMap,
       data: model,
     });
-  }
+  };
 }

package/src/services/entity.service.ts

@@ -38,16 +38,16 @@ export class AmpEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends Ba
     super(rest, kind, targetApi);
   }
 
-  create(model: WriteT | WriteT[], options?: EntityCallOptions): Promise<Page<ReadT>> {
+  create = (model: WriteT | WriteT[], options?: EntityCallOptions): Promise<Page<ReadT>> => {
     return this.getPage({
       url: `/${this.targetApi}/v1/${this.kind}`,
       method: 'POST',
       params: options?.params as QueryMap,
       data: model,
     });
-  }
+  };
 
-  update(model: WriteT | WriteT[], options?: EntityCallOptions): Promise<Page<ReadT>> {
+  update = (model: WriteT | WriteT[], options?: EntityCallOptions): Promise<Page<ReadT>> => {
     const url = _.isArray(model) ? `/${this.targetApi}/v1/${this.kind}` : `/${this.targetApi}/v1/${this.kind}/${model.id}`;
     return this.getPage({
       url,
@@ -55,9 +55,9 @@ export class AmpEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends Ba
       params: options?.params as QueryMap,
       data: model,
     });
-  }
+  };
 
-  async delete(id: string, options?: EntityCallOptions): Promise<Page<ReadT>> {
+  delete = async (id: string, options?: EntityCallOptions): Promise<Page<ReadT>> => {
     const res = await this.getById(id);
     if (res.data.length === 1) {
       const req: RestRequest = {
@@ -76,7 +76,7 @@ export class AmpEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends Ba
       }
     }
     return res;
-  }
+  };
 }
 
 const extIdMapErrorHandler: ErrorHandler<ExtKeyMap> = (error: unknown) => {
@@ -93,7 +93,7 @@ export class AmpGlobalEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT exte
   constructor(rest: RestClient, kind: string, targetApi: TargetApi = TARGET_API_AGENT) {
     super(rest, kind, targetApi);
   }
-  getLookupIds(tid: string, options?: EntityCallOptions): Promise<ExtKeyMap> {
+  getLookupIds = (tid: string, options?: EntityCallOptions): Promise<ExtKeyMap> => {
     const req: RestRequest = {
       url: `/${this.targetApi}/v1/${this.kind}/ext_key_map`,
       method: 'GET',
@@ -103,7 +103,7 @@ export class AmpGlobalEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT exte
       },
     };
     return this.call(req, extIdMapErrorHandler);
-  }
+  };
 }
 
 export class AmpSaaSEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto>
@@ -113,7 +113,7 @@ export class AmpSaaSEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extend
   constructor(rest: RestClient, kind: string, targetApi: TargetApi = TARGET_API_AGENT) {
     super(rest, kind, targetApi);
   }
-  getLookupIds(cid: string, options?: EntityCallOptions): Promise<ExtKeyMap> {
+  getLookupIds = (cid: string, options?: EntityCallOptions): Promise<ExtKeyMap> => {
     const req: RestRequest = {
       url: `/${this.targetApi}/v1/${this.kind}/ext_key_map`,
       method: 'GET',
@@ -123,5 +123,5 @@ export class AmpSaaSEntityServiceImpl<WriteT extends BaseUpsertDto, ReadT extend
       },
     };
     return this.call(req, extIdMapErrorHandler);
-  }
+  };
 }

package/src/services/findings.service.ts

@@ -0,0 +1,24 @@
+import _ from 'lodash';
+import {FindingDto, FindingStatus, Page} from '../dto';
+import {AmpDataServiceImpl} from './data.service';
+import {RestClient} from './rest';
+import {KIND} from './constants';
+
+export interface FindingPatchDto {
+  status: FindingStatus;
+}
+
+export class FindingsService extends AmpDataServiceImpl<FindingDto> {
+  constructor(rest: RestClient) {
+    super(rest, KIND.FINDINGS);
+  }
+
+  patch(id: string, values: FindingPatchDto | FindingPatchDto[]): Promise<Page<FindingDto>> {
+    const url = _.isArray(values) ? `/${this.targetApi}/v1/${this.kind}` : `/${this.targetApi}/v1/${this.kind}/${id}`;
+    return this.getPage({
+      url,
+      method: 'PATCH',
+      data: values,
+    });
+  }
+}

package/src/services/index.ts

@@ -4,5 +4,6 @@ export * from './AmpSdk';
 export * from './constants';
 export * from './data.service';
 export * from './entity.service';
+export * from './findings.service';
 export * from './rest';
 export * from './settings.service';

package/src/services/reports.service.ts

@@ -15,7 +15,7 @@ export class AmpReportServiceImpl implements AmpReportService {
     this.rest = rest;
   }
 
-  async getMetrics(reportId: string, filter?: FilterCriteria | undefined): Promise<Page<ReportResultDto>> {
+  getMetrics = async (reportId: string, filter?: FilterCriteria | undefined): Promise<Page<ReportResultDto>> => {
     filter = filter ?? {};
     filter.limit = filter.limit ?? 1; // pull latest result by default
     try {
@@ -37,7 +37,7 @@ export class AmpReportServiceImpl implements AmpReportService {
         hints: {},
       };
     }
-  }
+  };
 
   /**
    *
@@ -46,11 +46,11 @@ export class AmpReportServiceImpl implements AmpReportService {
    * @param filter
    * @returns
    */
-  async getMetricsTrend(reportId: string, filter?: FilterCriteria): Promise<Page<ReportResultDto>> {
+  getMetricsTrend = async (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);
-  }
+  };
 }

package/src/services/rest/AgentIdentityService.ts

@@ -10,7 +10,7 @@ export class AgentIdentityService {
   constructor(rest: RestClient) {
     this.rest = rest;
   }
-  async exchangeToken(targetTenantId: string): Promise<TokenResponse> {
+  exchangeToken = async (targetTenantId: string): Promise<TokenResponse> => {
     const res = await this.rest.call({
       url: '/api/v1/auth/token/exchange',
       method: 'GET',
@@ -19,13 +19,13 @@ export class AgentIdentityService {
       },
     });
     return res.data as TokenResponse;
-  }
+  };
 
-  async me(): Promise<AgentDto> {
+  me = async (): Promise<AgentDto> => {
     const res = await this.rest.call({
       url: '/api/v1/me',
       method: 'GET',
     });
     return res.data as AgentDto;
-  }
+  };
 }

package/src/services/rest/ConnectorInstallService.ts

@@ -7,7 +7,7 @@ export class ConnectorInstallService {
     this.rest = rest;
   }
 
-  async getInstallToken(cid: string): Promise<string> {
+  getInstallToken = async (cid: string): Promise<string> => {
     const res = await this.rest.call({
       url: '/install/oauth/token',
       method: 'POST',
@@ -15,9 +15,9 @@ export class ConnectorInstallService {
     });
     const token = (res.data as {token: string}).token;
     return token;
-  }
+  };
 
-  buildInstallOAuthUrl(apiBaseUrl: string, token: string, redirectUrl: string): string {
+  buildInstallOAuthUrl = (apiBaseUrl: string, token: string, redirectUrl: string): string => {
     return `${apiBaseUrl}/install/oauth?token=${token}&redirect=${encodeURIComponent(redirectUrl)}`;
-  }
+  };
 }

package/src/services/rest/EnumService.ts

@@ -23,14 +23,14 @@ class DefaultEnumCollection implements EnumCollection {
     this.kind = kind;
     this.targetApi = targetApi;
   }
-  async list(filter?: FilterCriteria): Promise<Page<EnumDto>> {
+  list = async (filter?: FilterCriteria): Promise<Page<EnumDto>> => {
     const res = await this.rest.call({
       url: `/${this.targetApi}/v1/enum/${this.kind}`,
       method: 'GET',
       params: filter,
     });
     return res.data as Page<EnumDto>;
-  }
+  };
 }
 
 export class DefaultEnumService implements EnumService {

package/src/services/rest/RestClient.ts

@@ -68,7 +68,7 @@ export class DefaultRestClient {
     this.retryStrategy = options.retryStrategy ?? noopRestRetryStrategy;
     this.rateLimitStrategy = options.rateLimitStrategy ?? noopRestClientRateLimitStrategy;
   }
-  async call(request: RestRequest): Promise<RestResponse> {
+  call = async (request: RestRequest): Promise<RestResponse> => {
     const req = _.merge(request);
     try {
       await this.rateLimitStrategy.reserve(req);
@@ -92,7 +92,7 @@ export class DefaultRestClient {
       }
       throw err;
     }
-  }
+  };
 }
 
 export const getAmpRestClient = (options: AmpRestClientOptions): RestClient => {

package/src/services/rest/UserIdentityService.ts

@@ -10,11 +10,11 @@ export class UserIdentityService {
   constructor(rest: RestClient) {
     this.rest = rest;
   }
-  async me(): Promise<AmpJwtToken> {
+  me = async (): Promise<AmpJwtToken> => {
     const res = await this.rest.call({
       url: '/eng/v1/me',
       method: 'GET',
     });
     return res.data as AmpJwtToken;
-  }
+  };
 }

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

@@ -6,7 +6,7 @@ export interface RestClientRateLimitStrategy {
 
 export const noopRestClientRateLimitStrategy: RestClientRateLimitStrategy = {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  reserve(_req: RestRequest): Promise<void> {
+  reserve: (_req: RestRequest): Promise<void> => {
     return Promise.resolve();
   },
 };
@@ -22,10 +22,10 @@ export class StaticRestClientRateLimitStrategy implements RestClientRateLimitStr
     this.lastRequest = 0;
   }
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async reserve(_req: RestRequest): Promise<void> {
+  reserve = async (_req: RestRequest): Promise<void> => {
     while (Date.now() - this.lastRequest < this.delay) {
       await sleep(this.delay);
     }
     this.lastRequest = Date.now();
-  }
+  };
 }

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

@@ -8,7 +8,7 @@ export interface RestClientRetryStrategy {
 }
 
 export const noopRestRetryStrategy: RestClientRetryStrategy = {
-  onError(req: RestRequest, err: AxiosError): Promise<RestResponse> {
+  onError: (req: RestRequest, err: AxiosError): Promise<RestResponse> => {
     const axiosError = err as AxiosError;
     const res: RestResponse = {
       status: axiosError.response?.status ?? 500,

package/src/services/settings.service.ts

@@ -26,7 +26,7 @@ export class AmpSettingsService {
     this.targetApi = targetApi;
   }
 
-  async getSettingsMap(tid?: string): Promise<AmpSettingsMap> {
+  getSettingsMap = async (tid?: string): Promise<AmpSettingsMap> => {
     const res = await this.rest.call({
       url: `/${this.targetApi}/v1/settings`,
       method: 'GET',
@@ -36,9 +36,9 @@ export class AmpSettingsService {
     const settings = page.data;
     const rawSettingsMap: TenantSettingsMap = AmpSettingsService.formatSettingMap(settings, true);
     return new AmpSettingsMap(rawSettingsMap, settings);
-  }
+  };
 
-  async create<T>(key: TypedAmpSettingsKey<T>, value: T, tid: string, cid?: string): Promise<AmpSettingDto> {
+  create = async <T>(key: TypedAmpSettingsKey<T>, value: T, tid: string, cid?: string): Promise<AmpSettingDto> => {
     const page = await this.rest.call({
       url: `/${this.targetApi}/v1/settings`,
       method: 'POST',
@@ -51,9 +51,9 @@ export class AmpSettingsService {
     });
     const settings = page.data as AmpSettingDto[];
     return settings[0];
-  }
+  };
 
-  async update(id: string, entity: AmpSettingUpsertDto): Promise<AmpSettingDto> {
+  update = async (id: string, entity: AmpSettingUpsertDto): Promise<AmpSettingDto> => {
     const page = await this.rest.call({
       url: `/${this.targetApi}/v1/settings/${id}`,
       method: 'PUT',
@@ -61,18 +61,18 @@ export class AmpSettingsService {
     });
     const settings = page.data as AmpSettingDto[];
     return settings[0];
-  }
+  };
 
-  async delete(id: string): Promise<AmpSettingDto> {
+  delete = async (id: string): Promise<AmpSettingDto> => {
     const page = await this.rest.call({
       url: `/${this.targetApi}/v1/settings/${id}`,
       method: 'DELETE',
     });
     const settings = page.data as AmpSettingDto[];
     return settings[0];
-  }
+  };
 
-  static formatSettingMap(settings: AmpSettingDto[], valuesOnly = true): TenantSettingsMap {
+  static formatSettingMap = (settings: AmpSettingDto[], valuesOnly = true): TenantSettingsMap => {
     const rawSettingsMap: TenantSettingsMap = {
       tenantSettings: {},
       connectorSettings: {},
@@ -88,7 +88,7 @@ export class AmpSettingsService {
       }
     });
     return rawSettingsMap;
-  }
+  };
 }
 
 export class AmpSettingsMap {
@@ -100,15 +100,15 @@ export class AmpSettingsMap {
     this.rawSettingsList = rawSettingsList;
   }
 
-  getGlobalSetting<T>(key: TypedAmpSettingsKey<T>): T {
+  getGlobalSetting = <T>(key: TypedAmpSettingsKey<T>): T => {
     const tenantVal = this.settings.tenantSettings[key.id];
     if (tenantVal) {
       return tenantVal as T;
     }
     return key.defaultValue;
-  }
+  };
 
-  getConnectorSetting<T>(cid: string, key: TypedAmpSettingsKey<T>): T {
+  getConnectorSetting = <T>(cid: string, key: TypedAmpSettingsKey<T>): T => {
     const tenantVal = this.settings.tenantSettings[key.id];
     const connectorMap = this.settings.connectorSettings[cid];
     if (connectorMap) {
@@ -121,23 +121,23 @@ export class AmpSettingsMap {
       return tenantVal as T;
     }
     return key.defaultValue;
-  }
+  };
 
-  getConnectorSettings(cid: string): RawAmpSettingsMap | undefined {
+  getConnectorSettings = (cid: string): RawAmpSettingsMap | undefined => {
     if (!this.settings.connectorSettings[cid]) {
       return undefined;
     }
     return _.clone(this.settings.connectorSettings[cid]);
-  }
+  };
 
-  getRawMap(): TenantSettingsMap {
+  getRawMap = (): TenantSettingsMap => {
     return AmpSettingsService.formatSettingMap(this.rawSettingsList, false);
-  }
+  };
 
-  static asKey<T>(key: AmpSettingKey, defaultValue: T): TypedAmpSettingsKey<T> {
+  static asKey = <T>(key: AmpSettingKey, defaultValue: T): TypedAmpSettingsKey<T> => {
     return {
       id: key,
       defaultValue,
     };
-  }
+  };
 }