@harnessio/react-chaos-manager-client 1.89.1 → 1.90.0

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

@@ -0,0 +1,29 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { RiskexperimentrecommendationsCreateExperimentResponse } from '../schemas/RiskexperimentrecommendationsCreateExperimentResponse';
+import type { SharedError } from '../schemas/SharedError';
+import { FetcherOptions } from '../../../../custom-fetcher/index.js';
+export interface CreateRiskExperimentRecommendationExperimentMutationPathParams {
+    identity: string;
+}
+export interface CreateRiskExperimentRecommendationExperimentMutationQueryParams {
+    accountIdentifier: string;
+    correlationID?: string;
+    organizationIdentifier?: string;
+    parentUniqueId?: string;
+    projectIdentifier?: string;
+}
+export type CreateRiskExperimentRecommendationExperimentOkResponse = RiskexperimentrecommendationsCreateExperimentResponse;
+export type CreateRiskExperimentRecommendationExperimentErrorResponse = SharedError;
+export interface CreateRiskExperimentRecommendationExperimentProps extends CreateRiskExperimentRecommendationExperimentMutationPathParams, Omit<FetcherOptions<CreateRiskExperimentRecommendationExperimentMutationQueryParams, unknown>, 'url'> {
+    queryParams: CreateRiskExperimentRecommendationExperimentMutationQueryParams;
+}
+export interface CreateRiskExperimentRecommendationExperimentResponseContainer {
+    body: CreateRiskExperimentRecommendationExperimentOkResponse;
+    headers: Headers;
+}
+export declare function createRiskExperimentRecommendationExperiment(props: CreateRiskExperimentRecommendationExperimentProps): Promise<CreateRiskExperimentRecommendationExperimentResponseContainer>;
+export type CreateRiskExperimentRecommendationExperimentMutationProps<T extends keyof CreateRiskExperimentRecommendationExperimentProps> = Omit<CreateRiskExperimentRecommendationExperimentProps, T> & Partial<Pick<CreateRiskExperimentRecommendationExperimentProps, T>>;
+/**
+ * creates a chaos experiment from the recommendation's faults, infrastructure, and target workload. It attaches the probes of the chaos service onboarded for the workload, or the default workload probe when there are none
+ */
+export declare function useCreateRiskExperimentRecommendationExperimentMutation<T extends keyof CreateRiskExperimentRecommendationExperimentProps>(props: Pick<Partial<CreateRiskExperimentRecommendationExperimentProps>, T>, options?: Omit<UseMutationOptions<CreateRiskExperimentRecommendationExperimentResponseContainer, CreateRiskExperimentRecommendationExperimentErrorResponse, CreateRiskExperimentRecommendationExperimentMutationProps<T>>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<CreateRiskExperimentRecommendationExperimentResponseContainer, SharedError, CreateRiskExperimentRecommendationExperimentMutationProps<T>, unknown>;

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

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useMutation } from '@tanstack/react-query';
+import { fetcher } from '../../../../custom-fetcher/index.js';
+export function createRiskExperimentRecommendationExperiment(props) {
+    return fetcher(Object.assign({ url: `/v3/risk-experiment-recommendations/${props.identity}/experiment`, method: 'POST' }, props));
+}
+/**
+ * creates a chaos experiment from the recommendation's faults, infrastructure, and target workload. It attaches the probes of the chaos service onboarded for the workload, or the default workload probe when there are none
+ */
+export function useCreateRiskExperimentRecommendationExperimentMutation(props, options) {
+    return useMutation((mutateProps) => createRiskExperimentRecommendationExperiment(Object.assign(Object.assign({}, props), mutateProps)), options);
+}

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

@@ -0,0 +1,35 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { RiskexperimentrecommendationsListResponse } from '../schemas/RiskexperimentrecommendationsListResponse';
+import type { SharedError } from '../schemas/SharedError';
+import { FetcherOptions } from '../../../../custom-fetcher/index.js';
+export interface ListRiskExperimentRecommendationsQueryQueryParams {
+    accountIdentifier: string;
+    correlationID?: string;
+    /**
+     * @default 15
+     */
+    limit?: number;
+    organizationIdentifier?: string;
+    /**
+     * @default 0
+     */
+    page?: number;
+    parentUniqueId?: string;
+    projectIdentifier?: string;
+    scannedRiskIdentity?: string;
+    search?: string;
+}
+export type ListRiskExperimentRecommendationsOkResponse = RiskexperimentrecommendationsListResponse;
+export type ListRiskExperimentRecommendationsErrorResponse = SharedError;
+export interface ListRiskExperimentRecommendationsProps extends Omit<FetcherOptions<ListRiskExperimentRecommendationsQueryQueryParams, unknown>, 'url'> {
+    queryParams: ListRiskExperimentRecommendationsQueryQueryParams;
+}
+export interface ListRiskExperimentRecommendationsResponseContainer {
+    body: ListRiskExperimentRecommendationsOkResponse;
+    headers: Headers;
+}
+export declare function listRiskExperimentRecommendations(props: ListRiskExperimentRecommendationsProps): Promise<ListRiskExperimentRecommendationsResponseContainer>;
+/**
+ * returns the live risk experiment recommendations. Missing recommendations are created by the background reconciler. When scannedRiskIdentity is set, only that risk's recommendation is returned.
+ */
+export declare function useListRiskExperimentRecommendationsQuery(props: ListRiskExperimentRecommendationsProps, options?: Omit<UseQueryOptions<ListRiskExperimentRecommendationsResponseContainer, ListRiskExperimentRecommendationsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListRiskExperimentRecommendationsResponseContainer, SharedError>;

package/dist/chaos-manager/src/services/hooks/useListRiskExperimentRecommendationsQuery.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 listRiskExperimentRecommendations(props) {
+    return fetcher(Object.assign({ url: `/v3/risk-experiment-recommendations`, method: 'GET' }, props));
+}
+/**
+ * returns the live risk experiment recommendations. Missing recommendations are created by the background reconciler. When scannedRiskIdentity is set, only that risk's recommendation is returned.
+ */
+export function useListRiskExperimentRecommendationsQuery(props, options) {
+    return useQuery(['listRiskExperimentRecommendations', props.queryParams], ({ signal }) => listRiskExperimentRecommendations(Object.assign(Object.assign({}, props), { signal })), options);
+}

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

@@ -60,6 +60,8 @@ export type { CreateProbeTemplateErrorResponse, CreateProbeTemplateMutationProps
 export { createProbeTemplate, useCreateProbeTemplateMutation, } from './hooks/useCreateProbeTemplateMutation';
 export type { CreateRecommendationErrorResponse, CreateRecommendationMutationProps, CreateRecommendationMutationQueryParams, CreateRecommendationOkResponse, CreateRecommendationProps, } from './hooks/useCreateRecommendationMutation';
 export { createRecommendation, useCreateRecommendationMutation, } from './hooks/useCreateRecommendationMutation';
+export type { CreateRiskExperimentRecommendationExperimentErrorResponse, CreateRiskExperimentRecommendationExperimentMutationPathParams, CreateRiskExperimentRecommendationExperimentMutationProps, CreateRiskExperimentRecommendationExperimentMutationQueryParams, CreateRiskExperimentRecommendationExperimentOkResponse, CreateRiskExperimentRecommendationExperimentProps, } from './hooks/useCreateRiskExperimentRecommendationExperimentMutation';
+export { createRiskExperimentRecommendationExperiment, useCreateRiskExperimentRecommendationExperimentMutation, } from './hooks/useCreateRiskExperimentRecommendationExperimentMutation';
 export type { CreateRiskErrorResponse, CreateRiskMutationProps, CreateRiskMutationQueryParams, CreateRiskOkResponse, CreateRiskProps, CreateRiskRequestBody, } from './hooks/useCreateRiskMutation';
 export { createRisk, useCreateRiskMutation } from './hooks/useCreateRiskMutation';
 export type { CreateRiskScanErrorResponse, CreateRiskScanMutationProps, CreateRiskScanMutationQueryParams, CreateRiskScanOkResponse, CreateRiskScanProps, CreateRiskScanRequestBody, } from './hooks/useCreateRiskScanMutation';
@@ -424,6 +426,8 @@ export type { ListProbesErrorResponse, ListProbesOkResponse, ListProbesProps, Li
 export { listProbes, useListProbesQuery } from './hooks/useListProbesQuery';
 export type { ListRecommendationsErrorResponse, ListRecommendationsOkResponse, ListRecommendationsProps, ListRecommendationsQueryQueryParams, ListRecommendationsRequestBody, } from './hooks/useListRecommendationsQuery';
 export { listRecommendations, useListRecommendationsQuery, } from './hooks/useListRecommendationsQuery';
+export type { ListRiskExperimentRecommendationsErrorResponse, ListRiskExperimentRecommendationsOkResponse, ListRiskExperimentRecommendationsProps, ListRiskExperimentRecommendationsQueryQueryParams, } from './hooks/useListRiskExperimentRecommendationsQuery';
+export { listRiskExperimentRecommendations, useListRiskExperimentRecommendationsQuery, } from './hooks/useListRiskExperimentRecommendationsQuery';
 export type { ListRiskRulesErrorResponse, ListRiskRulesOkResponse, ListRiskRulesProps, ListRiskRulesQueryQueryParams, } from './hooks/useListRiskRulesQuery';
 export { listRiskRules, useListRiskRulesQuery } from './hooks/useListRiskRulesQuery';
 export type { ListRiskScansErrorResponse, ListRiskScansOkResponse, ListRiskScansProps, ListRiskScansQueryQueryParams, } from './hooks/useListRiskScansQuery';
@@ -1328,6 +1332,12 @@ export type { RiskSeverity } from './schemas/RiskSeverity';
 export type { RiskTargetService } from './schemas/RiskTargetService';
 export type { RiskTargetServiceType } from './schemas/RiskTargetServiceType';
 export type { RiskValidationType } from './schemas/RiskValidationType';
+export type { RiskexperimentrecommendationsCreateExperimentResponse } from './schemas/RiskexperimentrecommendationsCreateExperimentResponse';
+export type { RiskexperimentrecommendationsListResponse } from './schemas/RiskexperimentrecommendationsListResponse';
+export type { RiskexperimentrecommendationsRiskExperimentRecommendation } from './schemas/RiskexperimentrecommendationsRiskExperimentRecommendation';
+export type { RiskexperimentrecommendationsRiskExperimentRecommendationSpec } from './schemas/RiskexperimentrecommendationsRiskExperimentRecommendationSpec';
+export type { RiskexperimentrecommendationsStatus } from './schemas/RiskexperimentrecommendationsStatus';
+export type { RiskexperimentrecommendationsWorkload } from './schemas/RiskexperimentrecommendationsWorkload';
 export type { RiskoccurrencesProbeExecutionSource } from './schemas/RiskoccurrencesProbeExecutionSource';
 export type { RiskrulesListResponse } from './schemas/RiskrulesListResponse';
 export type { RiskrulesRiskRuleResponse } from './schemas/RiskrulesRiskRuleResponse';

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

@@ -29,6 +29,7 @@ export { createInputSetV3, useCreateInputSetV3Mutation } from './hooks/useCreate
 export { createProbe, useCreateProbeMutation } from './hooks/useCreateProbeMutation';
 export { createProbeTemplate, useCreateProbeTemplateMutation, } from './hooks/useCreateProbeTemplateMutation';
 export { createRecommendation, useCreateRecommendationMutation, } from './hooks/useCreateRecommendationMutation';
+export { createRiskExperimentRecommendationExperiment, useCreateRiskExperimentRecommendationExperimentMutation, } from './hooks/useCreateRiskExperimentRecommendationExperimentMutation';
 export { createRisk, useCreateRiskMutation } from './hooks/useCreateRiskMutation';
 export { createRiskScan, useCreateRiskScanMutation } from './hooks/useCreateRiskScanMutation';
 export { createRule, useCreateRuleMutation } from './hooks/useCreateRuleMutation';
@@ -211,6 +212,7 @@ export { listProbeTemplate, useListProbeTemplateQuery } from './hooks/useListPro
 export { listProbeTemplateReferencedBy, useListProbeTemplateReferencedByQuery, } from './hooks/useListProbeTemplateReferencedByQuery';
 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 { listRiskScans, useListRiskScansQuery } from './hooks/useListRiskScansQuery';
 export { listRisks, useListRisksQuery } from './hooks/useListRisksQuery';

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

@@ -8,6 +8,7 @@ import type { ChaosExperimentSingleClickOnboardMetadata } from '../schemas/Chaos
 import type { ChaosExperimentRunTemplateDetails } from '../schemas/ChaosExperimentRunTemplateDetails';
 export interface ChaosExperimentChaosExperimentRequest {
     accountID: string;
+    aiSummary?: string;
     createdAt?: number;
     createdBy?: string;
     cronSyntax?: string;

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

@@ -6,6 +6,7 @@ import type { ExperimentsRecentRunDetails } from '../schemas/ExperimentsRecentRu
 import type { ChaosExperimentRecommendation } from '../schemas/ChaosExperimentRecommendation';
 import type { ChaosExperimentRunTemplateDetails } from '../schemas/ChaosExperimentRunTemplateDetails';
 export interface ExperimentsGetResponse {
+    aiSummary?: string;
     createdAt?: number;
     createdBy?: HcesdkUserDetails;
     cronSyntax?: string;

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

@@ -0,0 +1,7 @@
+export interface RiskexperimentrecommendationsCreateExperimentResponse {
+    correlationID?: string;
+    experimentId?: string;
+    experimentName?: string;
+    recommendationIdentity?: string;
+    scannedRiskIdentity?: string;
+}

package/dist/chaos-manager/src/services/schemas/RiskexperimentrecommendationsCreateExperimentResponse.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/RiskexperimentrecommendationsListResponse.d.ts

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

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

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

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

@@ -0,0 +1,20 @@
+import type { RiskexperimentrecommendationsRiskExperimentRecommendationSpec } from '../schemas/RiskexperimentrecommendationsRiskExperimentRecommendationSpec';
+export interface RiskexperimentrecommendationsRiskExperimentRecommendation {
+    accountID: string;
+    createdAt?: number;
+    createdBy?: string;
+    identity?: string;
+    isRemoved: boolean;
+    orgID?: string;
+    parentUniqueId?: string;
+    projectID?: string;
+    /**
+     * ScannedRiskIdentity is top-level so the one-live-recommendation-per-risk
+     * unique index can cover it.
+     */
+    scannedRiskIdentity?: string;
+    spec?: RiskexperimentrecommendationsRiskExperimentRecommendationSpec;
+    uniqueId?: string;
+    updatedAt?: number;
+    updatedBy?: string;
+}

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

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

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

@@ -0,0 +1,34 @@
+import type { RiskScanType } from '../schemas/RiskScanType';
+import type { RiskSeverity } from '../schemas/RiskSeverity';
+import type { RiskexperimentrecommendationsStatus } from '../schemas/RiskexperimentrecommendationsStatus';
+import type { RiskexperimentrecommendationsWorkload } from '../schemas/RiskexperimentrecommendationsWorkload';
+export interface RiskexperimentrecommendationsRiskExperimentRecommendationSpec {
+    agentIdentity?: string;
+    /**
+     * ChaosServiceIdentity is the chaos service onboarded from the discovered
+     * service, when the scanned risk recorded one. Its probes are attached to
+     * the experiment.
+     */
+    chaosServiceIdentity?: string;
+    discoveredServiceId?: string;
+    environmentIdentity?: string;
+    experimentId?: string;
+    experimentName?: string;
+    /**
+     * FaultNames is the snapshot parsed from the latest occurrence's
+     * resilienceTestingRec when the recommendation was created.
+     */
+    faultNames?: string[];
+    /**
+     * InfraID is the chaos infrastructure ID in "<envRef>/<infraID>" form.
+     */
+    infraId?: string;
+    infraNamespace?: string;
+    occurrenceId?: string;
+    riskName?: string;
+    riskRuleId?: string;
+    scanType?: RiskScanType;
+    severity?: RiskSeverity;
+    status?: RiskexperimentrecommendationsStatus;
+    workload?: RiskexperimentrecommendationsWorkload;
+}

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

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

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

@@ -0,0 +1 @@
+export type RiskexperimentrecommendationsStatus = 'Pending';

package/dist/chaos-manager/src/services/schemas/RiskexperimentrecommendationsStatus.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/RiskexperimentrecommendationsWorkload.d.ts

@@ -0,0 +1,5 @@
+export interface RiskexperimentrecommendationsWorkload {
+    kind?: string;
+    name?: string;
+    namespace?: string;
+}

package/dist/chaos-manager/src/services/schemas/RiskexperimentrecommendationsWorkload.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/ScannedrisksScannedRiskSpec.d.ts

@@ -6,11 +6,27 @@ import type { RiskTargetService } from '../schemas/RiskTargetService';
 import type { ScannedrisksValidationType } from '../schemas/ScannedrisksValidationType';
 export interface ScannedrisksScannedRiskSpec {
     category?: RiskCategory;
+    /**
+     * ExperimentRef is the ID of the chaos experiment created from this risk's
+     * recommendation. Kept after the recommendation is removed.
+     */
+    experimentRef?: string;
     fingerprint?: string;
     firstDetected?: number;
     impact?: string;
     lastDetected?: number;
     occurrenceCount?: number;
+    /**
+     * RecommendationCheckedAt is when the background reconciler last considered
+     * this risk. Set even when no recommendation is created, so a miss is not
+     * retried until the cooldown elapses.
+     */
+    recommendationCheckedAt?: number;
+    /**
+     * RecommendationRef is the identity of the live risk experiment
+     * recommendation for this risk. Cleared when the risk is Resolved or Ignored.
+     */
+    recommendationRef?: string;
     riskRuleId?: string;
     riskRuleName?: string;
     severity?: RiskSeverity;

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

@@ -3,4 +3,5 @@ import type { TypesExperimentCreationRequest } from '../schemas/TypesExperimentC
 export interface TypesExperimentCreationResponse {
     auditAction?: ExperimentSaveChaosExperimentResponse;
     data?: TypesExperimentCreationRequest;
+    generateAISummary?: boolean;
 }

package/package.json

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