@harnessio/react-ssca-manager-client 0.50.0 → 0.52.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 (18) hide show
  1. package/dist/ssca-manager/src/services/hooks/useFetchComplianceResultsByComplianceIdQuery.d.ts +38 -0
  2. package/dist/ssca-manager/src/services/hooks/useFetchComplianceResultsByComplianceIdQuery.js +20 -0
  3. package/dist/ssca-manager/src/services/hooks/useGetCompliaceStandardByIdQuery.d.ts +21 -0
  4. package/dist/ssca-manager/src/services/hooks/useGetCompliaceStandardByIdQuery.js +14 -0
  5. package/dist/ssca-manager/src/services/index.d.ts +7 -0
  6. package/dist/ssca-manager/src/services/index.js +2 -0
  7. package/dist/ssca-manager/src/services/responses/ComplianceStandardByIdResponseBodyResponse.d.ts +2 -0
  8. package/dist/ssca-manager/src/services/responses/ComplianceStandardByIdResponseBodyResponse.js +1 -0
  9. package/dist/ssca-manager/src/services/responses/FetchArtifactsByComplianceIdResponseBodyResponse.d.ts +2 -0
  10. package/dist/ssca-manager/src/services/responses/FetchArtifactsByComplianceIdResponseBodyResponse.js +1 -0
  11. package/dist/ssca-manager/src/services/schemas/CodeRepositoryListingResponse.d.ts +2 -4
  12. package/dist/ssca-manager/src/services/schemas/ComplianceArtifactWithExecution.d.ts +19 -0
  13. package/dist/ssca-manager/src/services/schemas/ComplianceArtifactWithExecution.js +1 -0
  14. package/dist/ssca-manager/src/services/schemas/ComplianceChecksMetrics.d.ts +1 -0
  15. package/dist/ssca-manager/src/services/schemas/ComplianceEvaluationHistory.d.ts +2 -0
  16. package/dist/ssca-manager/src/services/schemas/ComplianceResultAggregationByType.d.ts +0 -1
  17. package/dist/ssca-manager/src/services/schemas/PipelineDetails.d.ts +1 -0
  18. package/package.json +1 -1
@@ -0,0 +1,38 @@
1
+ import { UseQueryOptions } from '@tanstack/react-query';
2
+ import type { FetchArtifactsByComplianceIdResponseBodyResponse } from '../responses/FetchArtifactsByComplianceIdResponseBodyResponse';
3
+ import type { ResponseWithPagination } from '../helpers';
4
+ import { FetcherOptions } from '../../../../fetcher/index.js';
5
+ export interface FetchComplianceResultsByComplianceIdQueryPathParams {
6
+ org: string;
7
+ project: string;
8
+ compliance: string;
9
+ }
10
+ export interface FetchComplianceResultsByComplianceIdQueryQueryParams {
11
+ /**
12
+ * @default 0
13
+ */
14
+ page?: number;
15
+ /**
16
+ * @default 30
17
+ */
18
+ limit?: number;
19
+ /**
20
+ * @default "ASC"
21
+ */
22
+ order?: 'ASC' | 'DESC';
23
+ sort?: 'repo_name' | 'status' | 'updated';
24
+ search_term?: string;
25
+ }
26
+ export interface FetchComplianceResultsByComplianceIdQueryHeaderParams {
27
+ 'Harness-Account': string;
28
+ }
29
+ export type FetchComplianceResultsByComplianceIdOkResponse = ResponseWithPagination<FetchArtifactsByComplianceIdResponseBodyResponse>;
30
+ export type FetchComplianceResultsByComplianceIdErrorResponse = unknown;
31
+ export interface FetchComplianceResultsByComplianceIdProps extends FetchComplianceResultsByComplianceIdQueryPathParams, Omit<FetcherOptions<FetchComplianceResultsByComplianceIdQueryQueryParams, unknown, FetchComplianceResultsByComplianceIdQueryHeaderParams>, 'url'> {
32
+ queryParams: FetchComplianceResultsByComplianceIdQueryQueryParams;
33
+ }
34
+ export declare function fetchComplianceResultsByComplianceId(props: FetchComplianceResultsByComplianceIdProps): Promise<FetchComplianceResultsByComplianceIdOkResponse>;
35
+ /**
36
+ * Fetch Compliance Result By Compliance Id
37
+ */
38
+ export declare function useFetchComplianceResultsByComplianceIdQuery(props: FetchComplianceResultsByComplianceIdProps, options?: Omit<UseQueryOptions<FetchComplianceResultsByComplianceIdOkResponse, FetchComplianceResultsByComplianceIdErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<FetchComplianceResultsByComplianceIdOkResponse, unknown>;
@@ -0,0 +1,20 @@
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 fetchComplianceResultsByComplianceId(props) {
7
+ return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/compliance-results/compliances/${props.compliance}/artifacts`, method: 'GET' }, props));
8
+ }
9
+ /**
10
+ * Fetch Compliance Result By Compliance Id
11
+ */
12
+ export function useFetchComplianceResultsByComplianceIdQuery(props, options) {
13
+ return useQuery([
14
+ 'fetchComplianceResultsByComplianceId',
15
+ props.org,
16
+ props.project,
17
+ props.compliance,
18
+ props.queryParams,
19
+ ], ({ signal }) => fetchComplianceResultsByComplianceId(Object.assign(Object.assign({}, props), { signal })), options);
20
+ }
@@ -0,0 +1,21 @@
1
+ import { UseQueryOptions } from '@tanstack/react-query';
2
+ import type { ComplianceStandardByIdResponseBodyResponse } from '../responses/ComplianceStandardByIdResponseBodyResponse';
3
+ import type { ResponseWithPagination } from '../helpers';
4
+ import { FetcherOptions } from '../../../../fetcher/index.js';
5
+ export interface GetCompliaceStandardByIdQueryPathParams {
6
+ org: string;
7
+ project: string;
8
+ compliance: string;
9
+ }
10
+ export interface GetCompliaceStandardByIdQueryHeaderParams {
11
+ 'Harness-Account': string;
12
+ }
13
+ export type GetCompliaceStandardByIdOkResponse = ResponseWithPagination<ComplianceStandardByIdResponseBodyResponse>;
14
+ export type GetCompliaceStandardByIdErrorResponse = unknown;
15
+ export interface GetCompliaceStandardByIdProps extends GetCompliaceStandardByIdQueryPathParams, Omit<FetcherOptions<unknown, unknown, GetCompliaceStandardByIdQueryHeaderParams>, 'url'> {
16
+ }
17
+ export declare function getCompliaceStandardById(props: GetCompliaceStandardByIdProps): Promise<GetCompliaceStandardByIdOkResponse>;
18
+ /**
19
+ * Get Compliance Standard By Id
20
+ */
21
+ export declare function useGetCompliaceStandardByIdQuery(props: GetCompliaceStandardByIdProps, options?: Omit<UseQueryOptions<GetCompliaceStandardByIdOkResponse, GetCompliaceStandardByIdErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetCompliaceStandardByIdOkResponse, 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 getCompliaceStandardById(props) {
7
+ return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/compliance-standards/compliances/${props.compliance}`, method: 'GET' }, props));
8
+ }
9
+ /**
10
+ * Get Compliance Standard By Id
11
+ */
12
+ export function useGetCompliaceStandardByIdQuery(props, options) {
13
+ return useQuery(['getCompliaceStandardById', props.org, props.project, props.compliance], ({ signal }) => getCompliaceStandardById(Object.assign(Object.assign({}, props), { signal })), options);
14
+ }
@@ -29,6 +29,8 @@ export type { ExcludeArtifactErrorResponse, ExcludeArtifactMutationPathParams, E
29
29
  export { excludeArtifact, useExcludeArtifactMutation } from './hooks/useExcludeArtifactMutation';
30
30
  export type { FetchComplianceResultsByArtifactErrorResponse, FetchComplianceResultsByArtifactOkResponse, FetchComplianceResultsByArtifactProps, FetchComplianceResultsByArtifactQueryPathParams, FetchComplianceResultsByArtifactQueryQueryParams, FetchComplianceResultsByArtifactRequestBody, } from './hooks/useFetchComplianceResultsByArtifactQuery';
31
31
  export { fetchComplianceResultsByArtifact, useFetchComplianceResultsByArtifactQuery, } from './hooks/useFetchComplianceResultsByArtifactQuery';
32
+ export type { FetchComplianceResultsByComplianceIdErrorResponse, FetchComplianceResultsByComplianceIdOkResponse, FetchComplianceResultsByComplianceIdProps, FetchComplianceResultsByComplianceIdQueryPathParams, FetchComplianceResultsByComplianceIdQueryQueryParams, } from './hooks/useFetchComplianceResultsByComplianceIdQuery';
33
+ export { fetchComplianceResultsByComplianceId, useFetchComplianceResultsByComplianceIdQuery, } from './hooks/useFetchComplianceResultsByComplianceIdQuery';
32
34
  export type { FetchComplianceResultsGroupByIdErrorResponse, FetchComplianceResultsGroupByIdMutationPathParams, FetchComplianceResultsGroupByIdMutationQueryParams, FetchComplianceResultsGroupByIdOkResponse, FetchComplianceResultsGroupByIdProps, FetchComplianceResultsGroupByIdRequestBody, } from './hooks/useFetchComplianceResultsGroupByIdMutation';
33
35
  export { fetchComplianceResultsGroupById, useFetchComplianceResultsGroupByIdMutation, } from './hooks/useFetchComplianceResultsGroupByIdMutation';
34
36
  export type { FetchReposInIntegrationErrorResponse, FetchReposInIntegrationOkResponse, FetchReposInIntegrationProps, FetchReposInIntegrationQueryPathParams, FetchReposInIntegrationQueryQueryParams, } from './hooks/useFetchReposInIntegrationQuery';
@@ -55,6 +57,8 @@ export type { GetBaselineForArtifactErrorResponse, GetBaselineForArtifactOkRespo
55
57
  export { getBaselineForArtifact, useGetBaselineForArtifactQuery, } from './hooks/useGetBaselineForArtifactQuery';
56
58
  export type { GetCodeRepositoryOverviewErrorResponse, GetCodeRepositoryOverviewOkResponse, GetCodeRepositoryOverviewProps, GetCodeRepositoryOverviewQueryPathParams, } from './hooks/useGetCodeRepositoryOverviewQuery';
57
59
  export { getCodeRepositoryOverview, useGetCodeRepositoryOverviewQuery, } from './hooks/useGetCodeRepositoryOverviewQuery';
60
+ export type { GetCompliaceStandardByIdErrorResponse, GetCompliaceStandardByIdOkResponse, GetCompliaceStandardByIdProps, GetCompliaceStandardByIdQueryPathParams, } from './hooks/useGetCompliaceStandardByIdQuery';
61
+ export { getCompliaceStandardById, useGetCompliaceStandardByIdQuery, } from './hooks/useGetCompliaceStandardByIdQuery';
58
62
  export type { GetComplianceResultStatsByComplianceChecksErrorResponse, GetComplianceResultStatsByComplianceChecksMutationPathParams, GetComplianceResultStatsByComplianceChecksMutationQueryParams, GetComplianceResultStatsByComplianceChecksOkResponse, GetComplianceResultStatsByComplianceChecksProps, GetComplianceResultStatsByComplianceChecksRequestBody, } from './hooks/useGetComplianceResultStatsByComplianceChecksMutation';
59
63
  export { getComplianceResultStatsByComplianceChecks, useGetComplianceResultStatsByComplianceChecksMutation, } from './hooks/useGetComplianceResultStatsByComplianceChecksMutation';
60
64
  export type { GetComplianceStandardsErrorResponse, GetComplianceStandardsMutationPathParams, GetComplianceStandardsMutationQueryParams, GetComplianceStandardsOkResponse, GetComplianceStandardsProps, GetComplianceStandardsRequestBody, } from './hooks/useGetComplianceStandardsMutation';
@@ -143,11 +147,13 @@ export type { ComplianceChecksStatsResponseResponse } from './responses/Complian
143
147
  export type { ComplianceResultsEvaluationBreakdownByArtifactsResponseResponse } from './responses/ComplianceResultsEvaluationBreakdownByArtifactsResponseResponse';
144
148
  export type { ComplianceResultsEvaluationBreakdownResponseResponse } from './responses/ComplianceResultsEvaluationBreakdownResponseResponse';
145
149
  export type { ComplianceResultsGroupByComplianceIdResponseBodyResponse } from './responses/ComplianceResultsGroupByComplianceIdResponseBodyResponse';
150
+ export type { ComplianceStandardByIdResponseBodyResponse } from './responses/ComplianceStandardByIdResponseBodyResponse';
146
151
  export type { ComplianceStandardsResponseBodyResponse } from './responses/ComplianceStandardsResponseBodyResponse';
147
152
  export type { ComponentDriftResponseBodyResponse } from './responses/ComponentDriftResponseBodyResponse';
148
153
  export type { ComponentListResponseBodyResponse } from './responses/ComponentListResponseBodyResponse';
149
154
  export type { CreateIntegrationResponseBodyResponse } from './responses/CreateIntegrationResponseBodyResponse';
150
155
  export type { CreateTicketResponseBodyResponse } from './responses/CreateTicketResponseBodyResponse';
156
+ export type { FetchArtifactsByComplianceIdResponseBodyResponse } from './responses/FetchArtifactsByComplianceIdResponseBodyResponse';
151
157
  export type { FetchComplianceResultByArtifactResponseResponse } from './responses/FetchComplianceResultByArtifactResponseResponse';
152
158
  export type { FetchIntegrationReposResponseBodyResponse } from './responses/FetchIntegrationReposResponseBodyResponse';
153
159
  export type { IntegrationListingResponseBodyResponse } from './responses/IntegrationListingResponseBodyResponse';
@@ -194,6 +200,7 @@ export type { CodeRepoRulesEvaluation } from './schemas/CodeRepoRulesEvaluation'
194
200
  export type { CodeRepositoryListingRequest } from './schemas/CodeRepositoryListingRequest';
195
201
  export type { CodeRepositoryListingResponse } from './schemas/CodeRepositoryListingResponse';
196
202
  export type { CodeRepositoryOverview } from './schemas/CodeRepositoryOverview';
203
+ export type { ComplianceArtifactWithExecution } from './schemas/ComplianceArtifactWithExecution';
197
204
  export type { ComplianceCheck } from './schemas/ComplianceCheck';
198
205
  export type { ComplianceCheckEntityType } from './schemas/ComplianceCheckEntityType';
199
206
  export type { ComplianceCheckSeverity } from './schemas/ComplianceCheckSeverity';
@@ -13,6 +13,7 @@ export { deleteIntegration, useDeleteIntegrationMutation, } from './hooks/useDel
13
13
  export { downloadSbom, useDownloadSbomQuery } from './hooks/useDownloadSbomQuery';
14
14
  export { excludeArtifact, useExcludeArtifactMutation } from './hooks/useExcludeArtifactMutation';
15
15
  export { fetchComplianceResultsByArtifact, useFetchComplianceResultsByArtifactQuery, } from './hooks/useFetchComplianceResultsByArtifactQuery';
16
+ export { fetchComplianceResultsByComplianceId, useFetchComplianceResultsByComplianceIdQuery, } from './hooks/useFetchComplianceResultsByComplianceIdQuery';
16
17
  export { fetchComplianceResultsGroupById, useFetchComplianceResultsGroupByIdMutation, } from './hooks/useFetchComplianceResultsGroupByIdMutation';
17
18
  export { fetchReposInIntegration, useFetchReposInIntegrationQuery, } from './hooks/useFetchReposInIntegrationQuery';
18
19
  export { getAllRepositoriesSummary, useGetAllRepositoriesSummaryQuery, } from './hooks/useGetAllRepositoriesSummaryQuery';
@@ -26,6 +27,7 @@ export { getArtifactV2DetailDeploymentView, useGetArtifactV2DetailDeploymentView
26
27
  export { getArtifactV2Overview, useGetArtifactV2OverviewQuery, } from './hooks/useGetArtifactV2OverviewQuery';
27
28
  export { getBaselineForArtifact, useGetBaselineForArtifactQuery, } from './hooks/useGetBaselineForArtifactQuery';
28
29
  export { getCodeRepositoryOverview, useGetCodeRepositoryOverviewQuery, } from './hooks/useGetCodeRepositoryOverviewQuery';
30
+ export { getCompliaceStandardById, useGetCompliaceStandardByIdQuery, } from './hooks/useGetCompliaceStandardByIdQuery';
29
31
  export { getComplianceResultStatsByComplianceChecks, useGetComplianceResultStatsByComplianceChecksMutation, } from './hooks/useGetComplianceResultStatsByComplianceChecksMutation';
30
32
  export { getComplianceStandards, useGetComplianceStandardsMutation, } from './hooks/useGetComplianceStandardsMutation';
31
33
  export { getComponentDrift, useGetComponentDriftQuery } from './hooks/useGetComponentDriftQuery';
@@ -0,0 +1,2 @@
1
+ import type { ComplianceCheck } from '../schemas/ComplianceCheck';
2
+ export type ComplianceStandardByIdResponseBodyResponse = ComplianceCheck;
@@ -0,0 +1,2 @@
1
+ import type { ComplianceArtifactWithExecution } from '../schemas/ComplianceArtifactWithExecution';
2
+ export type FetchArtifactsByComplianceIdResponseBodyResponse = ComplianceArtifactWithExecution[];
@@ -1,3 +1,4 @@
1
+ import type { PipelineDetails } from '../schemas/PipelineDetails';
1
2
  import type { RiskAndCompliance } from '../schemas/RiskAndCompliance';
2
3
  import type { Scorecard } from '../schemas/Scorecard';
3
4
  import type { StoIssueCount } from '../schemas/StoIssueCount';
@@ -11,6 +12,7 @@ export interface CodeRepositoryListingResponse {
11
12
  * Code Respository ID
12
13
  */
13
14
  id?: string;
15
+ last_scan?: PipelineDetails;
14
16
  /**
15
17
  * Code Repository Name
16
18
  */
@@ -19,10 +21,6 @@ export interface CodeRepositoryListingResponse {
19
21
  risk_and_compliance?: RiskAndCompliance;
20
22
  scorecard?: Scorecard;
21
23
  sto_issue_count?: StoIssueCount;
22
- /**
23
- * Last updated time of the repository
24
- */
25
- updated?: string;
26
24
  /**
27
25
  * Code Repository URL
28
26
  */
@@ -0,0 +1,19 @@
1
+ import type { ComplianceEvaluationHistory } from '../schemas/ComplianceEvaluationHistory';
2
+ import type { ComplianceCheckSeverity } from '../schemas/ComplianceCheckSeverity';
3
+ import type { ComplianceStandardType } from '../schemas/ComplianceStandardType';
4
+ import type { ComplianceResultStatus } from '../schemas/ComplianceResultStatus';
5
+ export interface ComplianceArtifactWithExecution {
6
+ compliance_id: string;
7
+ description?: string;
8
+ executions?: ComplianceEvaluationHistory[];
9
+ name: string;
10
+ reason?: string;
11
+ remediation?: string;
12
+ severity: ComplianceCheckSeverity;
13
+ standards: ComplianceStandardType[];
14
+ status?: ComplianceResultStatus;
15
+ tags: string[];
16
+ title?: string;
17
+ type: string;
18
+ updatedAt?: string;
19
+ }
@@ -6,4 +6,5 @@ export interface ComplianceChecksMetrics {
6
6
  failed?: number;
7
7
  standards?: string[];
8
8
  tags?: string[];
9
+ title?: string;
9
10
  }
@@ -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
  }
@@ -12,5 +12,4 @@ export interface ComplianceResultAggregationByType {
12
12
  standards: ComplianceStandardType[];
13
13
  tags: string[];
14
14
  title: string;
15
- type: string;
16
15
  }
@@ -19,6 +19,7 @@ export interface PipelineDetails {
19
19
  * Project where pipeline is present.
20
20
  */
21
21
  project_id?: string;
22
+ status?: 'FAILED' | 'PASSED' | 'UNKNOWN';
22
23
  /**
23
24
  * Time of trigger of the deployment pipeline
24
25
  * @format int64
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-ssca-manager-client",
3
- "version": "0.50.0",
3
+ "version": "0.52.0",
4
4
  "description": "Harness SSCA manager APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",