@harnessio/react-ssca-manager-client 0.51.0 → 0.53.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/dist/ssca-manager/src/services/hooks/useArtifactListV2Query.d.ts +1 -1
  2. package/dist/ssca-manager/src/services/hooks/useFetchComplianceResultsByArtifactQuery.d.ts +2 -2
  3. package/dist/ssca-manager/src/services/hooks/useGetComplianceEvaluationTrendsQuery.d.ts +29 -0
  4. package/dist/ssca-manager/src/services/hooks/useGetComplianceEvaluationTrendsQuery.js +14 -0
  5. package/dist/ssca-manager/src/services/index.d.ts +7 -2
  6. package/dist/ssca-manager/src/services/index.js +1 -0
  7. package/dist/ssca-manager/src/services/requestBodies/ComplianceEvaluationTrendRequestRequestBody.d.ts +2 -0
  8. package/dist/ssca-manager/src/services/requestBodies/FetchComplianceResultByArtifactRequestBodyRequestBody.d.ts +2 -0
  9. package/dist/ssca-manager/src/services/requestBodies/FetchComplianceResultByArtifactRequestBodyRequestBody.js +1 -0
  10. package/dist/ssca-manager/src/services/responses/ComplianceEvaluationTrendResponseResponse.d.ts +2 -0
  11. package/dist/ssca-manager/src/services/responses/ComplianceEvaluationTrendResponseResponse.js +1 -0
  12. package/dist/ssca-manager/src/services/schemas/ComplianceArtifactWithExecution.d.ts +5 -15
  13. package/dist/ssca-manager/src/services/schemas/ComplianceEvaluationHistory.d.ts +2 -0
  14. package/dist/ssca-manager/src/services/schemas/ComplianceEvaluationTrend.d.ts +9 -0
  15. package/dist/ssca-manager/src/services/schemas/ComplianceResultAggregationByType.d.ts +0 -1
  16. package/dist/ssca-manager/src/services/schemas/ComplianceResultByArtifactFilter.d.ts +10 -0
  17. package/dist/ssca-manager/src/services/schemas/ComplianceResultByArtifactFilter.js +1 -0
  18. package/dist/ssca-manager/src/services/schemas/FetchComplianceResultByArtifactResponseBody.d.ts +4 -0
  19. package/package.json +1 -1
  20. package/dist/ssca-manager/src/services/schemas/ComplianceArtifactType.d.ts +0 -3
  21. package/dist/ssca-manager/src/services/schemas/ComplianceResult.d.ts +0 -21
  22. /package/dist/ssca-manager/src/services/{schemas/ComplianceResult.js → requestBodies/ComplianceEvaluationTrendRequestRequestBody.js} +0 -0
  23. /package/dist/ssca-manager/src/services/schemas/{ComplianceArtifactType.js → ComplianceEvaluationTrend.js} +0 -0
@@ -21,7 +21,7 @@ export interface ArtifactListV2QueryQueryParams {
21
21
  /**
22
22
  * @default "DESC"
23
23
  */
24
- order?: {};
24
+ order?: 'ASC' | 'DESC';
25
25
  }
26
26
  export interface ArtifactListV2QueryHeaderParams {
27
27
  'Harness-Account': string;
@@ -1,6 +1,6 @@
1
1
  import { UseQueryOptions } from '@tanstack/react-query';
2
2
  import type { FetchComplianceResultByArtifactResponseResponse } from '../responses/FetchComplianceResultByArtifactResponseResponse';
3
- import type { FetchComplianceResultRequestBodyRequestBody } from '../requestBodies/FetchComplianceResultRequestBodyRequestBody';
3
+ import type { FetchComplianceResultByArtifactRequestBodyRequestBody } from '../requestBodies/FetchComplianceResultByArtifactRequestBodyRequestBody';
4
4
  import type { ResponseWithPagination } from '../helpers';
5
5
  import { FetcherOptions } from '../../../../fetcher/index.js';
6
6
  export interface FetchComplianceResultsByArtifactQueryPathParams {
@@ -26,7 +26,7 @@ export interface FetchComplianceResultsByArtifactQueryQueryParams {
26
26
  export interface FetchComplianceResultsByArtifactQueryHeaderParams {
27
27
  'Harness-Account': string;
28
28
  }
29
- export type FetchComplianceResultsByArtifactRequestBody = FetchComplianceResultRequestBodyRequestBody;
29
+ export type FetchComplianceResultsByArtifactRequestBody = FetchComplianceResultByArtifactRequestBodyRequestBody;
30
30
  export type FetchComplianceResultsByArtifactOkResponse = ResponseWithPagination<FetchComplianceResultByArtifactResponseResponse>;
31
31
  export type FetchComplianceResultsByArtifactErrorResponse = unknown;
32
32
  export interface FetchComplianceResultsByArtifactProps extends FetchComplianceResultsByArtifactQueryPathParams, Omit<FetcherOptions<FetchComplianceResultsByArtifactQueryQueryParams, FetchComplianceResultsByArtifactRequestBody, FetchComplianceResultsByArtifactQueryHeaderParams>, 'url'> {
@@ -0,0 +1,29 @@
1
+ import { UseQueryOptions } from '@tanstack/react-query';
2
+ import type { ComplianceEvaluationTrendResponseResponse } from '../responses/ComplianceEvaluationTrendResponseResponse';
3
+ import type { ComplianceEvaluationTrendRequestRequestBody } from '../requestBodies/ComplianceEvaluationTrendRequestRequestBody';
4
+ import type { ResponseWithPagination } from '../helpers';
5
+ import { FetcherOptions } from '../../../../fetcher/index.js';
6
+ export interface GetComplianceEvaluationTrendsQueryPathParams {
7
+ org: string;
8
+ project: string;
9
+ }
10
+ export interface GetComplianceEvaluationTrendsQueryQueryParams {
11
+ start_time?: string;
12
+ end_time?: string;
13
+ aggregation_period?: string;
14
+ }
15
+ export interface GetComplianceEvaluationTrendsQueryHeaderParams {
16
+ 'Harness-Account': string;
17
+ }
18
+ export type GetComplianceEvaluationTrendsRequestBody = ComplianceEvaluationTrendRequestRequestBody;
19
+ export type GetComplianceEvaluationTrendsOkResponse = ResponseWithPagination<ComplianceEvaluationTrendResponseResponse>;
20
+ export type GetComplianceEvaluationTrendsErrorResponse = unknown;
21
+ export interface GetComplianceEvaluationTrendsProps extends GetComplianceEvaluationTrendsQueryPathParams, Omit<FetcherOptions<GetComplianceEvaluationTrendsQueryQueryParams, GetComplianceEvaluationTrendsRequestBody, GetComplianceEvaluationTrendsQueryHeaderParams>, 'url'> {
22
+ queryParams: GetComplianceEvaluationTrendsQueryQueryParams;
23
+ body: GetComplianceEvaluationTrendsRequestBody;
24
+ }
25
+ export declare function getComplianceEvaluationTrends(props: GetComplianceEvaluationTrendsProps): Promise<GetComplianceEvaluationTrendsOkResponse>;
26
+ /**
27
+ * Compliance Evaluation Trend API
28
+ */
29
+ export declare function useGetComplianceEvaluationTrendsQuery(props: GetComplianceEvaluationTrendsProps, options?: Omit<UseQueryOptions<GetComplianceEvaluationTrendsOkResponse, GetComplianceEvaluationTrendsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetComplianceEvaluationTrendsOkResponse, unknown>;
@@ -0,0 +1,14 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ import { useQuery } from '@tanstack/react-query';
5
+ import { fetcher } from '../../../../fetcher/index.js';
6
+ export function getComplianceEvaluationTrends(props) {
7
+ return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/compliance-stats/evaluation-trend`, method: 'POST' }, props));
8
+ }
9
+ /**
10
+ * Compliance Evaluation Trend API
11
+ */
12
+ export function useGetComplianceEvaluationTrendsQuery(props, options) {
13
+ return useQuery(['get-compliance-evaluation-trends', props.org, props.project, props.queryParams, props.body], ({ signal }) => getComplianceEvaluationTrends(Object.assign(Object.assign({}, props), { signal })), options);
14
+ }
@@ -59,6 +59,8 @@ export type { GetCodeRepositoryOverviewErrorResponse, GetCodeRepositoryOverviewO
59
59
  export { getCodeRepositoryOverview, useGetCodeRepositoryOverviewQuery, } from './hooks/useGetCodeRepositoryOverviewQuery';
60
60
  export type { GetCompliaceStandardByIdErrorResponse, GetCompliaceStandardByIdOkResponse, GetCompliaceStandardByIdProps, GetCompliaceStandardByIdQueryPathParams, } from './hooks/useGetCompliaceStandardByIdQuery';
61
61
  export { getCompliaceStandardById, useGetCompliaceStandardByIdQuery, } from './hooks/useGetCompliaceStandardByIdQuery';
62
+ export type { GetComplianceEvaluationTrendsErrorResponse, GetComplianceEvaluationTrendsOkResponse, GetComplianceEvaluationTrendsProps, GetComplianceEvaluationTrendsQueryPathParams, GetComplianceEvaluationTrendsQueryQueryParams, GetComplianceEvaluationTrendsRequestBody, } from './hooks/useGetComplianceEvaluationTrendsQuery';
63
+ export { getComplianceEvaluationTrends, useGetComplianceEvaluationTrendsQuery, } from './hooks/useGetComplianceEvaluationTrendsQuery';
62
64
  export type { GetComplianceResultStatsByComplianceChecksErrorResponse, GetComplianceResultStatsByComplianceChecksMutationPathParams, GetComplianceResultStatsByComplianceChecksMutationQueryParams, GetComplianceResultStatsByComplianceChecksOkResponse, GetComplianceResultStatsByComplianceChecksProps, GetComplianceResultStatsByComplianceChecksRequestBody, } from './hooks/useGetComplianceResultStatsByComplianceChecksMutation';
63
65
  export { getComplianceResultStatsByComplianceChecks, useGetComplianceResultStatsByComplianceChecksMutation, } from './hooks/useGetComplianceResultStatsByComplianceChecksMutation';
64
66
  export type { GetComplianceStandardsErrorResponse, GetComplianceStandardsMutationPathParams, GetComplianceStandardsMutationQueryParams, GetComplianceStandardsOkResponse, GetComplianceStandardsProps, GetComplianceStandardsRequestBody, } from './hooks/useGetComplianceStandardsMutation';
@@ -115,6 +117,7 @@ export type { ArtifactListingPipelineRequestBodyRequestBody } from './requestBod
115
117
  export type { ArtifactListingRequestBodyRequestBody } from './requestBodies/ArtifactListingRequestBodyRequestBody';
116
118
  export type { BaselineRequestBodyRequestBody } from './requestBodies/BaselineRequestBodyRequestBody';
117
119
  export type { CodeRepositoryListingRequestBodyRequestBody } from './requestBodies/CodeRepositoryListingRequestBodyRequestBody';
120
+ export type { ComplianceEvaluationTrendRequestRequestBody } from './requestBodies/ComplianceEvaluationTrendRequestRequestBody';
118
121
  export type { ComplianceResultsEvaluationBreakdownByArtifactsRequestRequestBody } from './requestBodies/ComplianceResultsEvaluationBreakdownByArtifactsRequestRequestBody';
119
122
  export type { ComplianceResultsOverviewRequestBodyRequestBody } from './requestBodies/ComplianceResultsOverviewRequestBodyRequestBody';
120
123
  export type { ComplianceStandardsRequestBodyRequestBody } from './requestBodies/ComplianceStandardsRequestBodyRequestBody';
@@ -123,6 +126,7 @@ export type { CreateComplianceStandardRequestBodyRequestBody } from './requestBo
123
126
  export type { CreateIntegrationRequestBodyRequestBody } from './requestBodies/CreateIntegrationRequestBodyRequestBody';
124
127
  export type { CreateTicketRequestBodyRequestBody } from './requestBodies/CreateTicketRequestBodyRequestBody';
125
128
  export type { ExcludeArtifactRequestBodyRequestBody } from './requestBodies/ExcludeArtifactRequestBodyRequestBody';
129
+ export type { FetchComplianceResultByArtifactRequestBodyRequestBody } from './requestBodies/FetchComplianceResultByArtifactRequestBodyRequestBody';
126
130
  export type { FetchComplianceResultRequestBodyRequestBody } from './requestBodies/FetchComplianceResultRequestBodyRequestBody';
127
131
  export type { FetchComplianeResultChecksStatsRequestBodyRequestBody } from './requestBodies/FetchComplianeResultChecksStatsRequestBodyRequestBody';
128
132
  export type { RemediationArtifactDeploymentsListingRequestBodyRequestBody } from './requestBodies/RemediationArtifactDeploymentsListingRequestBodyRequestBody';
@@ -144,6 +148,7 @@ export type { BaselineResponseBodyResponse } from './responses/BaselineResponseB
144
148
  export type { CodeRepositoryListingResponseBodyResponse } from './responses/CodeRepositoryListingResponseBodyResponse';
145
149
  export type { CodeRepositoryOverviewResponseBodyResponse } from './responses/CodeRepositoryOverviewResponseBodyResponse';
146
150
  export type { ComplianceChecksStatsResponseResponse } from './responses/ComplianceChecksStatsResponseResponse';
151
+ export type { ComplianceEvaluationTrendResponseResponse } from './responses/ComplianceEvaluationTrendResponseResponse';
147
152
  export type { ComplianceResultsEvaluationBreakdownByArtifactsResponseResponse } from './responses/ComplianceResultsEvaluationBreakdownByArtifactsResponseResponse';
148
153
  export type { ComplianceResultsEvaluationBreakdownResponseResponse } from './responses/ComplianceResultsEvaluationBreakdownResponseResponse';
149
154
  export type { ComplianceResultsGroupByComplianceIdResponseBodyResponse } from './responses/ComplianceResultsGroupByComplianceIdResponseBodyResponse';
@@ -200,7 +205,6 @@ export type { CodeRepoRulesEvaluation } from './schemas/CodeRepoRulesEvaluation'
200
205
  export type { CodeRepositoryListingRequest } from './schemas/CodeRepositoryListingRequest';
201
206
  export type { CodeRepositoryListingResponse } from './schemas/CodeRepositoryListingResponse';
202
207
  export type { CodeRepositoryOverview } from './schemas/CodeRepositoryOverview';
203
- export type { ComplianceArtifactType } from './schemas/ComplianceArtifactType';
204
208
  export type { ComplianceArtifactWithExecution } from './schemas/ComplianceArtifactWithExecution';
205
209
  export type { ComplianceCheck } from './schemas/ComplianceCheck';
206
210
  export type { ComplianceCheckEntityType } from './schemas/ComplianceCheckEntityType';
@@ -209,10 +213,11 @@ export type { ComplianceCheckType } from './schemas/ComplianceCheckType';
209
213
  export type { ComplianceChecksMetrics } from './schemas/ComplianceChecksMetrics';
210
214
  export type { ComplianceEvaluationHistory } from './schemas/ComplianceEvaluationHistory';
211
215
  export type { ComplianceEvaluationSummary } from './schemas/ComplianceEvaluationSummary';
216
+ export type { ComplianceEvaluationTrend } from './schemas/ComplianceEvaluationTrend';
212
217
  export type { ComplianceExecutionByType } from './schemas/ComplianceExecutionByType';
213
218
  export type { ComplianceFilter } from './schemas/ComplianceFilter';
214
- export type { ComplianceResult } from './schemas/ComplianceResult';
215
219
  export type { ComplianceResultAggregationByType } from './schemas/ComplianceResultAggregationByType';
220
+ export type { ComplianceResultByArtifactFilter } from './schemas/ComplianceResultByArtifactFilter';
216
221
  export type { ComplianceResultFilter } from './schemas/ComplianceResultFilter';
217
222
  export type { ComplianceResultStatus } from './schemas/ComplianceResultStatus';
218
223
  export type { ComplianceResultsEvaluationBreakdown } from './schemas/ComplianceResultsEvaluationBreakdown';
@@ -28,6 +28,7 @@ export { getArtifactV2Overview, useGetArtifactV2OverviewQuery, } from './hooks/u
28
28
  export { getBaselineForArtifact, useGetBaselineForArtifactQuery, } from './hooks/useGetBaselineForArtifactQuery';
29
29
  export { getCodeRepositoryOverview, useGetCodeRepositoryOverviewQuery, } from './hooks/useGetCodeRepositoryOverviewQuery';
30
30
  export { getCompliaceStandardById, useGetCompliaceStandardByIdQuery, } from './hooks/useGetCompliaceStandardByIdQuery';
31
+ export { getComplianceEvaluationTrends, useGetComplianceEvaluationTrendsQuery, } from './hooks/useGetComplianceEvaluationTrendsQuery';
31
32
  export { getComplianceResultStatsByComplianceChecks, useGetComplianceResultStatsByComplianceChecksMutation, } from './hooks/useGetComplianceResultStatsByComplianceChecksMutation';
32
33
  export { getComplianceStandards, useGetComplianceStandardsMutation, } from './hooks/useGetComplianceStandardsMutation';
33
34
  export { getComponentDrift, useGetComponentDriftQuery } from './hooks/useGetComponentDriftQuery';
@@ -0,0 +1,2 @@
1
+ import type { ComplianceResultFilter } from '../schemas/ComplianceResultFilter';
2
+ export type ComplianceEvaluationTrendRequestRequestBody = ComplianceResultFilter;
@@ -0,0 +1,2 @@
1
+ import type { ComplianceResultByArtifactFilter } from '../schemas/ComplianceResultByArtifactFilter';
2
+ export type FetchComplianceResultByArtifactRequestBodyRequestBody = ComplianceResultByArtifactFilter;
@@ -0,0 +1,2 @@
1
+ import type { ComplianceEvaluationTrend } from '../schemas/ComplianceEvaluationTrend';
2
+ export type ComplianceEvaluationTrendResponseResponse = ComplianceEvaluationTrend[];
@@ -1,29 +1,19 @@
1
- import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
1
+ import type { ComplianceEvaluationHistory } from '../schemas/ComplianceEvaluationHistory';
2
2
  import type { ComplianceCheckSeverity } from '../schemas/ComplianceCheckSeverity';
3
3
  import type { ComplianceStandardType } from '../schemas/ComplianceStandardType';
4
- import type { ComplianceResult } from '../schemas/ComplianceResult';
5
- import type { ComplianceArtifactType } from '../schemas/ComplianceArtifactType';
6
- /**
7
- *
8
- */
4
+ import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
9
5
  export interface ComplianceArtifactWithExecution {
10
6
  compliance_id: string;
11
7
  description?: string;
12
- executions?: {
13
- pipeline_excution_id: string;
14
- pipeline_id: string;
15
- stage_execution_id: string;
16
- status?: ComplianceResultStatus;
17
- step_execution_id: string;
18
- };
8
+ executions?: ComplianceEvaluationHistory[];
19
9
  name: string;
20
10
  reason?: string;
21
11
  remediation?: string;
22
12
  severity: ComplianceCheckSeverity;
23
13
  standards: ComplianceStandardType[];
24
- status?: ComplianceResult;
14
+ status?: ComplianceResultStatus;
25
15
  tags: string[];
26
16
  title?: string;
27
- type: ComplianceArtifactType;
17
+ type: string;
28
18
  updatedAt?: string;
29
19
  }
@@ -2,5 +2,7 @@ import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
2
2
  export interface ComplianceEvaluationHistory {
3
3
  pipeline_execution_id?: string;
4
4
  pipeline_id?: string;
5
+ stage_execution_id?: string;
5
6
  status?: ComplianceResultStatus;
7
+ step_execution_id?: string;
6
8
  }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Data point for compliane evaluation trend api
3
+ */
4
+ export interface ComplianceEvaluationTrend {
5
+ failed?: number;
6
+ passed?: number;
7
+ windowEndTime?: string;
8
+ windowStartTime?: string;
9
+ }
@@ -12,5 +12,4 @@ export interface ComplianceResultAggregationByType {
12
12
  standards: ComplianceStandardType[];
13
13
  tags: string[];
14
14
  title: string;
15
- type: string;
16
15
  }
@@ -0,0 +1,10 @@
1
+ import type { ComplianceCheckSeverity } from '../schemas/ComplianceCheckSeverity';
2
+ import type { ComplianceStandardType } from '../schemas/ComplianceStandardType';
3
+ import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
4
+ export interface ComplianceResultByArtifactFilter {
5
+ compliance_id?: string;
6
+ search_term?: string;
7
+ severity?: ComplianceCheckSeverity;
8
+ standards?: ComplianceStandardType[];
9
+ status?: ComplianceResultStatus[];
10
+ }
@@ -4,11 +4,15 @@ import type { ComplianceStandardType } from '../schemas/ComplianceStandardType';
4
4
  import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
5
5
  export interface FetchComplianceResultByArtifactResponseBody {
6
6
  compliance_id?: string;
7
+ description?: string;
7
8
  evaluation_history?: ComplianceEvaluationHistory[];
8
9
  /**
9
10
  * @format int64
10
11
  */
11
12
  evaluation_time?: number;
13
+ pipelineExecutionId?: string;
14
+ reason?: string;
15
+ remediation?: string;
12
16
  severity?: ComplianceCheckSeverity;
13
17
  standards?: ComplianceStandardType[];
14
18
  status?: ComplianceResultStatus;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-ssca-manager-client",
3
- "version": "0.51.0",
3
+ "version": "0.53.0",
4
4
  "description": "Harness SSCA manager APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",
@@ -1,3 +0,0 @@
1
- export interface ComplianceArtifactType {
2
- id?: {};
3
- }
@@ -1,21 +0,0 @@
1
- import type { ComplianceCheckEntityType } from '../schemas/ComplianceCheckEntityType';
2
- import type { ComplianceCheckSeverity } from '../schemas/ComplianceCheckSeverity';
3
- import type { ComplianceStandardType } from '../schemas/ComplianceStandardType';
4
- import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
5
- export interface ComplianceResult {
6
- category: string;
7
- category_id: string;
8
- compliance_id: string;
9
- description?: string;
10
- entity: ComplianceCheckEntityType;
11
- reason: string;
12
- remediation: string;
13
- severity: ComplianceCheckSeverity;
14
- standards: ComplianceStandardType[];
15
- status: ComplianceResultStatus;
16
- sub_category: string;
17
- sub_category_id: string;
18
- tags?: string[];
19
- title?: string;
20
- url?: string;
21
- }