@harnessio/react-chaos-manager-client 1.90.1 → 1.91.0

package/dist/chaos-manager/src/services/hooks/useListRiskScanRisksQuery.d.ts

@@ -0,0 +1,49 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { RiskscansScanRisksResponse } from '../schemas/RiskscansScanRisksResponse';
+import type { SharedError } from '../schemas/SharedError';
+import { FetcherOptions } from '../../../../custom-fetcher/index.js';
+export interface ListRiskScanRisksQueryPathParams {
+    identity: string;
+}
+export interface ListRiskScanRisksQueryQueryParams {
+    accountIdentifier: string;
+    agentIdentity?: string;
+    correlationID?: string;
+    environmentIdentity?: string;
+    externalID?: string;
+    infrastructureIdentity?: string;
+    /**
+     * @default 15
+     */
+    limit?: number;
+    organizationIdentifier?: string;
+    /**
+     * @default 0
+     */
+    page?: number;
+    parentUniqueId?: string;
+    projectIdentifier?: string;
+    riskRuleIdentities?: string;
+    search?: string;
+    serviceIdentity?: string;
+    severity?: 'Critical' | 'High' | 'Low' | 'Medium';
+    sortAscending?: boolean;
+    sortField?: 'createdAt' | 'experimentName' | 'lastExecuted' | 'lastUpdated' | 'name';
+    status?: 'Ignored' | 'InProgress' | 'Open' | 'Resolved';
+    tags?: string;
+    validationType?: 'Confirmed' | 'Passive';
+}
+export type ListRiskScanRisksOkResponse = RiskscansScanRisksResponse;
+export type ListRiskScanRisksErrorResponse = SharedError;
+export interface ListRiskScanRisksProps extends ListRiskScanRisksQueryPathParams, Omit<FetcherOptions<ListRiskScanRisksQueryQueryParams, unknown>, 'url'> {
+    queryParams: ListRiskScanRisksQueryQueryParams;
+}
+export interface ListRiskScanRisksResponseContainer {
+    body: ListRiskScanRisksOkResponse;
+    headers: Headers;
+}
+export declare function listRiskScanRisks(props: ListRiskScanRisksProps): Promise<ListRiskScanRisksResponseContainer>;
+/**
+ * returns a paginated list of risks detected by the scan, each carrying the service detail relevant to the scan type in serviceInScanContext
+ */
+export declare function useListRiskScanRisksQuery(props: ListRiskScanRisksProps, options?: Omit<UseQueryOptions<ListRiskScanRisksResponseContainer, ListRiskScanRisksErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListRiskScanRisksResponseContainer, SharedError>;

package/dist/chaos-manager/src/services/hooks/useListRiskScanRisksQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../custom-fetcher/index.js';
+export function listRiskScanRisks(props) {
+    return fetcher(Object.assign({ url: `/v3/risk-scans/${props.identity}/risks`, method: 'GET' }, props));
+}
+/**
+ * returns a paginated list of risks detected by the scan, each carrying the service detail relevant to the scan type in serviceInScanContext
+ */
+export function useListRiskScanRisksQuery(props, options) {
+    return useQuery(['listRiskScanRisks', props.identity, props.queryParams], ({ signal }) => listRiskScanRisks(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/chaos-manager/src/services/hooks/useListRiskScanServicesQuery.d.ts

@@ -0,0 +1,37 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { RiskscansScanServicesResponse } from '../schemas/RiskscansScanServicesResponse';
+import type { SharedError } from '../schemas/SharedError';
+import { FetcherOptions } from '../../../../custom-fetcher/index.js';
+export interface ListRiskScanServicesQueryPathParams {
+    identity: string;
+}
+export interface ListRiskScanServicesQueryQueryParams {
+    accountIdentifier: string;
+    correlationID?: string;
+    /**
+     * @default 15
+     */
+    limit?: number;
+    organizationIdentifier?: string;
+    /**
+     * @default 0
+     */
+    page?: number;
+    parentUniqueId?: string;
+    projectIdentifier?: string;
+    search?: string;
+}
+export type ListRiskScanServicesOkResponse = RiskscansScanServicesResponse;
+export type ListRiskScanServicesErrorResponse = SharedError;
+export interface ListRiskScanServicesProps extends ListRiskScanServicesQueryPathParams, Omit<FetcherOptions<ListRiskScanServicesQueryQueryParams, unknown>, 'url'> {
+    queryParams: ListRiskScanServicesQueryQueryParams;
+}
+export interface ListRiskScanServicesResponseContainer {
+    body: ListRiskScanServicesOkResponse;
+    headers: Headers;
+}
+export declare function listRiskScanServices(props: ListRiskScanServicesProps): Promise<ListRiskScanServicesResponseContainer>;
+/**
+ * returns the distinct services that have risks in this scan, each with its per-severity risk counts and the service detail relevant to the scan type; each row can be drilled into via the risks endpoint using serviceIdentity
+ */
+export declare function useListRiskScanServicesQuery(props: ListRiskScanServicesProps, options?: Omit<UseQueryOptions<ListRiskScanServicesResponseContainer, ListRiskScanServicesErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListRiskScanServicesResponseContainer, SharedError>;

package/dist/chaos-manager/src/services/hooks/useListRiskScanServicesQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../custom-fetcher/index.js';
+export function listRiskScanServices(props) {
+    return fetcher(Object.assign({ url: `/v3/risk-scans/${props.identity}/services`, method: 'GET' }, props));
+}
+/**
+ * returns the distinct services that have risks in this scan, each with its per-severity risk counts and the service detail relevant to the scan type; each row can be drilled into via the risks endpoint using serviceIdentity
+ */
+export function useListRiskScanServicesQuery(props, options) {
+    return useQuery(['listRiskScanServices', props.identity, props.queryParams], ({ signal }) => listRiskScanServices(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/chaos-manager/src/services/hooks/useListRiskScanSuggestedServicesQuery.d.ts

@@ -0,0 +1,29 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { RiskscansScanSuggestedServicesResponse } from '../schemas/RiskscansScanSuggestedServicesResponse';
+import type { SharedError } from '../schemas/SharedError';
+import { FetcherOptions } from '../../../../custom-fetcher/index.js';
+export interface ListRiskScanSuggestedServicesQueryPathParams {
+    identity: string;
+}
+export interface ListRiskScanSuggestedServicesQueryQueryParams {
+    accountIdentifier: string;
+    correlationID?: string;
+    organizationIdentifier?: string;
+    parentUniqueId?: string;
+    projectIdentifier?: string;
+    search?: string;
+}
+export type ListRiskScanSuggestedServicesOkResponse = RiskscansScanSuggestedServicesResponse;
+export type ListRiskScanSuggestedServicesErrorResponse = SharedError;
+export interface ListRiskScanSuggestedServicesProps extends ListRiskScanSuggestedServicesQueryPathParams, Omit<FetcherOptions<ListRiskScanSuggestedServicesQueryQueryParams, unknown>, 'url'> {
+    queryParams: ListRiskScanSuggestedServicesQueryQueryParams;
+}
+export interface ListRiskScanSuggestedServicesResponseContainer {
+    body: ListRiskScanSuggestedServicesOkResponse;
+    headers: Headers;
+}
+export declare function listRiskScanSuggestedServices(props: ListRiskScanSuggestedServicesProps): Promise<ListRiskScanSuggestedServicesResponseContainer>;
+/**
+ * returns the full list of distinct services that have risks in this scan, carrying the service detail relevant to the scan type; used to populate the service filter dropdown of the risks endpoint
+ */
+export declare function useListRiskScanSuggestedServicesQuery(props: ListRiskScanSuggestedServicesProps, options?: Omit<UseQueryOptions<ListRiskScanSuggestedServicesResponseContainer, ListRiskScanSuggestedServicesErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListRiskScanSuggestedServicesResponseContainer, SharedError>;

package/dist/chaos-manager/src/services/hooks/useListRiskScanSuggestedServicesQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../custom-fetcher/index.js';
+export function listRiskScanSuggestedServices(props) {
+    return fetcher(Object.assign({ url: `/v3/risk-scans/${props.identity}/suggested-services`, method: 'GET' }, props));
+}
+/**
+ * returns the full list of distinct services that have risks in this scan, carrying the service detail relevant to the scan type; used to populate the service filter dropdown of the risks endpoint
+ */
+export function useListRiskScanSuggestedServicesQuery(props, options) {
+    return useQuery(['listRiskScanSuggestedServices', props.identity, props.queryParams], ({ signal }) => listRiskScanSuggestedServices(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/chaos-manager/src/services/index.d.ts

@@ -430,6 +430,12 @@ export type { ListRiskExperimentRecommendationsErrorResponse, ListRiskExperiment
 export { listRiskExperimentRecommendations, useListRiskExperimentRecommendationsQuery, } from './hooks/useListRiskExperimentRecommendationsQuery';
 export type { ListRiskRulesErrorResponse, ListRiskRulesOkResponse, ListRiskRulesProps, ListRiskRulesQueryQueryParams, } from './hooks/useListRiskRulesQuery';
 export { listRiskRules, useListRiskRulesQuery } from './hooks/useListRiskRulesQuery';
+export type { ListRiskScanRisksErrorResponse, ListRiskScanRisksOkResponse, ListRiskScanRisksProps, ListRiskScanRisksQueryPathParams, ListRiskScanRisksQueryQueryParams, } from './hooks/useListRiskScanRisksQuery';
+export { listRiskScanRisks, useListRiskScanRisksQuery } from './hooks/useListRiskScanRisksQuery';
+export type { ListRiskScanServicesErrorResponse, ListRiskScanServicesOkResponse, ListRiskScanServicesProps, ListRiskScanServicesQueryPathParams, ListRiskScanServicesQueryQueryParams, } from './hooks/useListRiskScanServicesQuery';
+export { listRiskScanServices, useListRiskScanServicesQuery, } from './hooks/useListRiskScanServicesQuery';
+export type { ListRiskScanSuggestedServicesErrorResponse, ListRiskScanSuggestedServicesOkResponse, ListRiskScanSuggestedServicesProps, ListRiskScanSuggestedServicesQueryPathParams, ListRiskScanSuggestedServicesQueryQueryParams, } from './hooks/useListRiskScanSuggestedServicesQuery';
+export { listRiskScanSuggestedServices, useListRiskScanSuggestedServicesQuery, } from './hooks/useListRiskScanSuggestedServicesQuery';
 export type { ListRiskScansErrorResponse, ListRiskScansOkResponse, ListRiskScansProps, ListRiskScansQueryQueryParams, } from './hooks/useListRiskScansQuery';
 export { listRiskScans, useListRiskScansQuery } from './hooks/useListRiskScansQuery';
 export type { ListRisksErrorResponse, ListRisksOkResponse, ListRisksProps, ListRisksQueryQueryParams, } from './hooks/useListRisksQuery';
@@ -1365,7 +1371,14 @@ export type { RiskscansOccurrenceDetails } from './schemas/RiskscansOccurrenceDe
 export type { RiskscansReportResponse } from './schemas/RiskscansReportResponse';
 export type { RiskscansReportSummary } from './schemas/RiskscansReportSummary';
 export type { RiskscansRiskScanResponse } from './schemas/RiskscansRiskScanResponse';
+export type { RiskscansScanRiskItem } from './schemas/RiskscansScanRiskItem';
+export type { RiskscansScanRisksResponse } from './schemas/RiskscansScanRisksResponse';
+export type { RiskscansScanServiceItem } from './schemas/RiskscansScanServiceItem';
+export type { RiskscansScanServiceRiskCounts } from './schemas/RiskscansScanServiceRiskCounts';
+export type { RiskscansScanServicesResponse } from './schemas/RiskscansScanServicesResponse';
+export type { RiskscansScanSuggestedServicesResponse } from './schemas/RiskscansScanSuggestedServicesResponse';
 export type { RiskscansScannedRiskWithOccurrences } from './schemas/RiskscansScannedRiskWithOccurrences';
+export type { RiskscansServiceInScanContext } from './schemas/RiskscansServiceInScanContext';
 export type { RiskscansUpdateRequest } from './schemas/RiskscansUpdateRequest';
 export type { ScannedrisksGetResponse } from './schemas/ScannedrisksGetResponse';
 export type { ScannedrisksListResponse } from './schemas/ScannedrisksListResponse';

package/dist/chaos-manager/src/services/index.js

@@ -214,6 +214,9 @@ export { listProbes, useListProbesQuery } from './hooks/useListProbesQuery';
 export { listRecommendations, useListRecommendationsQuery, } from './hooks/useListRecommendationsQuery';
 export { listRiskExperimentRecommendations, useListRiskExperimentRecommendationsQuery, } from './hooks/useListRiskExperimentRecommendationsQuery';
 export { listRiskRules, useListRiskRulesQuery } from './hooks/useListRiskRulesQuery';
+export { listRiskScanRisks, useListRiskScanRisksQuery } from './hooks/useListRiskScanRisksQuery';
+export { listRiskScanServices, useListRiskScanServicesQuery, } from './hooks/useListRiskScanServicesQuery';
+export { listRiskScanSuggestedServices, useListRiskScanSuggestedServicesQuery, } from './hooks/useListRiskScanSuggestedServicesQuery';
 export { listRiskScans, useListRiskScansQuery } from './hooks/useListRiskScansQuery';
 export { listRisks, useListRisksQuery } from './hooks/useListRisksQuery';
 export { listRule, useListRuleQuery } from './hooks/useListRuleQuery';

package/dist/chaos-manager/src/services/schemas/RiskscansHeatmapRow.d.ts

@@ -1,7 +1,8 @@
 import type { RiskscansHeatmapCell } from '../schemas/RiskscansHeatmapCell';
+import type { RiskscansServiceInScanContext } from '../schemas/RiskscansServiceInScanContext';
 export interface RiskscansHeatmapRow {
     cells?: RiskscansHeatmapCell[];
     serviceIdentity?: string;
+    serviceInScanContext?: RiskscansServiceInScanContext;
     serviceName?: string;
-    serviceType?: string;
 }

package/dist/chaos-manager/src/services/schemas/RiskscansScanRiskItem.d.ts

@@ -0,0 +1,17 @@
+import type { RiskscansServiceInScanContext } from '../schemas/RiskscansServiceInScanContext';
+export interface RiskscansScanRiskItem {
+    description?: string;
+    fingerprint?: string;
+    firstDetected?: number;
+    identity?: string;
+    lastDetected?: number;
+    name?: string;
+    occurrenceCount?: number;
+    riskRuleId?: string;
+    riskRuleName?: string;
+    serviceInScanContext?: RiskscansServiceInScanContext;
+    severity?: string;
+    status?: string;
+    tags?: string[];
+    validationTypes?: string[];
+}

package/dist/chaos-manager/src/services/schemas/RiskscansScanRiskItem.js

@@ -0,0 +1 @@
+export {};

package/dist/chaos-manager/src/services/schemas/RiskscansScanRisksResponse.d.ts

@@ -0,0 +1,7 @@
+import type { RiskscansScanRiskItem } from '../schemas/RiskscansScanRiskItem';
+import type { SharedPaginationResponse } from '../schemas/SharedPaginationResponse';
+export interface RiskscansScanRisksResponse {
+    correlationID?: string;
+    data?: RiskscansScanRiskItem[];
+    pagination?: SharedPaginationResponse;
+}

package/dist/chaos-manager/src/services/schemas/RiskscansScanRisksResponse.js

@@ -0,0 +1 @@
+export {};

package/dist/chaos-manager/src/services/schemas/RiskscansScanServiceItem.d.ts

@@ -0,0 +1,8 @@
+import type { RiskscansScanServiceRiskCounts } from '../schemas/RiskscansScanServiceRiskCounts';
+import type { RiskscansServiceInScanContext } from '../schemas/RiskscansServiceInScanContext';
+export interface RiskscansScanServiceItem {
+    riskCounts?: RiskscansScanServiceRiskCounts;
+    serviceIdentity?: string;
+    serviceInScanContext?: RiskscansServiceInScanContext;
+    serviceName?: string;
+}

package/dist/chaos-manager/src/services/schemas/RiskscansScanServiceItem.js

@@ -0,0 +1 @@
+export {};

package/dist/chaos-manager/src/services/schemas/RiskscansScanServiceRiskCounts.d.ts

@@ -0,0 +1,7 @@
+export interface RiskscansScanServiceRiskCounts {
+    critical?: number;
+    high?: number;
+    low?: number;
+    medium?: number;
+    total?: number;
+}

package/dist/chaos-manager/src/services/schemas/RiskscansScanServiceRiskCounts.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/chaos-manager/src/services/schemas/RiskscansScanServicesResponse.d.ts

@@ -0,0 +1,7 @@
+import type { RiskscansScanServiceItem } from '../schemas/RiskscansScanServiceItem';
+import type { SharedPaginationResponse } from '../schemas/SharedPaginationResponse';
+export interface RiskscansScanServicesResponse {
+    correlationID?: string;
+    data?: RiskscansScanServiceItem[];
+    pagination?: SharedPaginationResponse;
+}

package/dist/chaos-manager/src/services/schemas/RiskscansScanServicesResponse.js

@@ -0,0 +1 @@
+export {};

package/dist/chaos-manager/src/services/schemas/RiskscansScanSuggestedServicesResponse.d.ts

@@ -0,0 +1,5 @@
+import type { RiskscansServiceInScanContext } from '../schemas/RiskscansServiceInScanContext';
+export interface RiskscansScanSuggestedServicesResponse {
+    correlationID?: string;
+    data?: RiskscansServiceInScanContext[];
+}

package/dist/chaos-manager/src/services/schemas/RiskscansScanSuggestedServicesResponse.js

@@ -0,0 +1 @@
+export {};

package/dist/chaos-manager/src/services/schemas/RiskscansServiceInScanContext.d.ts

@@ -0,0 +1,8 @@
+export interface RiskscansServiceInScanContext {
+    agentIdentity?: string;
+    environmentIdentity?: string;
+    externalID?: string;
+    infrastructureIdentity?: string;
+    serviceIdentity?: string;
+    serviceName?: string;
+}

package/dist/chaos-manager/src/services/schemas/RiskscansServiceInScanContext.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-chaos-manager-client",
-  "version": "1.90.1",
+  "version": "1.91.0",
   "description": "Harness React Chaos Manager Service Client - APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",