@harnessio/react-ssca-manager-client 0.23.0 → 0.25.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 (20) hide show
  1. package/dist/ssca-manager/src/services/hooks/useCheckArtifactAndDeploymentsMutation.d.ts +23 -0
  2. package/dist/ssca-manager/src/services/hooks/useCheckArtifactAndDeploymentsMutation.js +14 -0
  3. package/dist/ssca-manager/src/services/hooks/useGetComponentsQuery.d.ts +36 -0
  4. package/dist/ssca-manager/src/services/hooks/useGetComponentsQuery.js +14 -0
  5. package/dist/ssca-manager/src/services/index.d.ts +8 -0
  6. package/dist/ssca-manager/src/services/index.js +2 -0
  7. package/dist/ssca-manager/src/services/responses/ComponentListResponseBodyResponse.d.ts +2 -0
  8. package/dist/ssca-manager/src/services/responses/ComponentListResponseBodyResponse.js +1 -0
  9. package/dist/ssca-manager/src/services/schemas/ArtifactAndDeploymentsResponseBody.d.ts +4 -0
  10. package/dist/ssca-manager/src/services/schemas/ArtifactAndDeploymentsResponseBody.js +4 -0
  11. package/dist/ssca-manager/src/services/schemas/ArtifactListingResponseV2.d.ts +3 -14
  12. package/dist/ssca-manager/src/services/schemas/ArtifactListingResponseV2.js +0 -3
  13. package/dist/ssca-manager/src/services/schemas/ArtifactVariant.d.ts +10 -0
  14. package/dist/ssca-manager/src/services/schemas/ArtifactVariant.js +4 -0
  15. package/dist/ssca-manager/src/services/schemas/ComponentDto.d.ts +5 -0
  16. package/dist/ssca-manager/src/services/schemas/ComponentDto.js +4 -0
  17. package/dist/ssca-manager/src/services/schemas/RemediationArtifactListingRequestBody.d.ts +1 -1
  18. package/dist/ssca-manager/src/services/schemas/RemediationDetailsResponse.d.ts +4 -0
  19. package/dist/ssca-manager/src/services/schemas/RemediationListingResponse.d.ts +5 -0
  20. package/package.json +1 -1
@@ -0,0 +1,23 @@
1
+ import { UseMutationOptions } from '@tanstack/react-query';
2
+ import type { ArtifactAndDeploymentsResponseBody } from '../schemas/ArtifactAndDeploymentsResponseBody';
3
+ import type { RemediationTrackerCreateRequestBodyRequestBody } from '../requestBodies/RemediationTrackerCreateRequestBodyRequestBody';
4
+ import type { ResponseWithPagination } from '../helpers';
5
+ import { FetcherOptions } from '../../../../fetcher/index.js';
6
+ export interface CheckArtifactAndDeploymentsMutationPathParams {
7
+ org: string;
8
+ project: string;
9
+ }
10
+ export interface CheckArtifactAndDeploymentsMutationHeaderParams {
11
+ 'Harness-Account'?: string;
12
+ }
13
+ export type CheckArtifactAndDeploymentsRequestBody = RemediationTrackerCreateRequestBodyRequestBody;
14
+ export type CheckArtifactAndDeploymentsOkResponse = ResponseWithPagination<ArtifactAndDeploymentsResponseBody>;
15
+ export type CheckArtifactAndDeploymentsErrorResponse = unknown;
16
+ export interface CheckArtifactAndDeploymentsProps extends CheckArtifactAndDeploymentsMutationPathParams, Omit<FetcherOptions<unknown, CheckArtifactAndDeploymentsRequestBody, CheckArtifactAndDeploymentsMutationHeaderParams>, 'url'> {
17
+ body: CheckArtifactAndDeploymentsRequestBody;
18
+ }
19
+ export declare function checkArtifactAndDeployments(props: CheckArtifactAndDeploymentsProps): Promise<CheckArtifactAndDeploymentsOkResponse>;
20
+ /**
21
+ * Check Artifacts And Deployments.
22
+ */
23
+ export declare function useCheckArtifactAndDeploymentsMutation(options?: Omit<UseMutationOptions<CheckArtifactAndDeploymentsOkResponse, CheckArtifactAndDeploymentsErrorResponse, CheckArtifactAndDeploymentsProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<CheckArtifactAndDeploymentsOkResponse, unknown, CheckArtifactAndDeploymentsProps, 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 { useMutation } from '@tanstack/react-query';
5
+ import { fetcher } from '../../../../fetcher/index.js';
6
+ export function checkArtifactAndDeployments(props) {
7
+ return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediations/check-artifacts`, method: 'POST' }, props));
8
+ }
9
+ /**
10
+ * Check Artifacts And Deployments.
11
+ */
12
+ export function useCheckArtifactAndDeploymentsMutation(options) {
13
+ return useMutation((mutateProps) => checkArtifactAndDeployments(mutateProps), options);
14
+ }
@@ -0,0 +1,36 @@
1
+ import { UseQueryOptions } from '@tanstack/react-query';
2
+ import type { ComponentListResponseBodyResponse } from '../responses/ComponentListResponseBodyResponse';
3
+ import type { ResponseWithPagination } from '../helpers';
4
+ import { FetcherOptions } from '../../../../fetcher/index.js';
5
+ export interface GetComponentsQueryPathParams {
6
+ org: string;
7
+ project: string;
8
+ }
9
+ export interface GetComponentsQueryQueryParams {
10
+ search_term?: string;
11
+ /**
12
+ * @default 30
13
+ */
14
+ limit?: number;
15
+ /**
16
+ * @default "ASC"
17
+ */
18
+ order?: 'ASC' | 'DESC';
19
+ /**
20
+ * @default 0
21
+ */
22
+ page?: number;
23
+ }
24
+ export interface GetComponentsQueryHeaderParams {
25
+ 'Harness-Account'?: string;
26
+ }
27
+ export type GetComponentsOkResponse = ResponseWithPagination<ComponentListResponseBodyResponse>;
28
+ export type GetComponentsErrorResponse = unknown;
29
+ export interface GetComponentsProps extends GetComponentsQueryPathParams, Omit<FetcherOptions<GetComponentsQueryQueryParams, unknown, GetComponentsQueryHeaderParams>, 'url'> {
30
+ queryParams: GetComponentsQueryQueryParams;
31
+ }
32
+ export declare function getComponents(props: GetComponentsProps): Promise<GetComponentsOkResponse>;
33
+ /**
34
+ * Get components for project
35
+ */
36
+ export declare function useGetComponentsQuery(props: GetComponentsProps, options?: Omit<UseQueryOptions<GetComponentsOkResponse, GetComponentsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetComponentsOkResponse, 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 getComponents(props) {
7
+ return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/components`, method: 'GET' }, props));
8
+ }
9
+ /**
10
+ * Get components for project
11
+ */
12
+ export function useGetComponentsQuery(props, options) {
13
+ return useQuery(['getComponents', props.org, props.project, props.queryParams], ({ signal }) => getComponents(Object.assign(Object.assign({}, props), { signal })), options);
14
+ }
@@ -3,6 +3,8 @@ export type { ArtifactListErrorResponse, ArtifactListOkResponse, ArtifactListPro
3
3
  export { artifactList, useArtifactListQuery } from './hooks/useArtifactListQuery';
4
4
  export type { CalculateDriftForArtifactErrorResponse, CalculateDriftForArtifactMutationPathParams, CalculateDriftForArtifactOkResponse, CalculateDriftForArtifactProps, CalculateDriftForArtifactRequestBody, } from './hooks/useCalculateDriftForArtifactMutation';
5
5
  export { calculateDriftForArtifact, useCalculateDriftForArtifactMutation, } from './hooks/useCalculateDriftForArtifactMutation';
6
+ export type { CheckArtifactAndDeploymentsErrorResponse, CheckArtifactAndDeploymentsMutationPathParams, CheckArtifactAndDeploymentsOkResponse, CheckArtifactAndDeploymentsProps, CheckArtifactAndDeploymentsRequestBody, } from './hooks/useCheckArtifactAndDeploymentsMutation';
7
+ export { checkArtifactAndDeployments, useCheckArtifactAndDeploymentsMutation, } from './hooks/useCheckArtifactAndDeploymentsMutation';
6
8
  export type { CloseRemediationTrackerErrorResponse, CloseRemediationTrackerMutationPathParams, CloseRemediationTrackerOkResponse, CloseRemediationTrackerProps, } from './hooks/useCloseRemediationTrackerMutation';
7
9
  export { closeRemediationTracker, useCloseRemediationTrackerMutation, } from './hooks/useCloseRemediationTrackerMutation';
8
10
  export type { CreateRemediationTrackerErrorResponse, CreateRemediationTrackerMutationPathParams, CreateRemediationTrackerOkResponse, CreateRemediationTrackerProps, CreateRemediationTrackerRequestBody, } from './hooks/useCreateRemediationTrackerMutation';
@@ -27,6 +29,8 @@ export type { GetBaselineForArtifactErrorResponse, GetBaselineForArtifactOkRespo
27
29
  export { getBaselineForArtifact, useGetBaselineForArtifactQuery, } from './hooks/useGetBaselineForArtifactQuery';
28
30
  export type { GetComponentDriftErrorResponse, GetComponentDriftOkResponse, GetComponentDriftProps, GetComponentDriftQueryPathParams, GetComponentDriftQueryQueryParams, } from './hooks/useGetComponentDriftQuery';
29
31
  export { getComponentDrift, useGetComponentDriftQuery } from './hooks/useGetComponentDriftQuery';
32
+ export type { GetComponentsErrorResponse, GetComponentsOkResponse, GetComponentsProps, GetComponentsQueryPathParams, GetComponentsQueryQueryParams, } from './hooks/useGetComponentsQuery';
33
+ export { getComponents, useGetComponentsQuery } from './hooks/useGetComponentsQuery';
30
34
  export type { GetDeploymentsListForArtifactInRemediationErrorResponse, GetDeploymentsListForArtifactInRemediationOkResponse, GetDeploymentsListForArtifactInRemediationProps, GetDeploymentsListForArtifactInRemediationQueryPathParams, GetDeploymentsListForArtifactInRemediationQueryQueryParams, GetDeploymentsListForArtifactInRemediationRequestBody, } from './hooks/useGetDeploymentsListForArtifactInRemediationQuery';
31
35
  export { getDeploymentsListForArtifactInRemediation, useGetDeploymentsListForArtifactInRemediationQuery, } from './hooks/useGetDeploymentsListForArtifactInRemediationQuery';
32
36
  export type { GetEnvironmentListForRemediationErrorResponse, GetEnvironmentListForRemediationOkResponse, GetEnvironmentListForRemediationProps, GetEnvironmentListForRemediationQueryPathParams, GetEnvironmentListForRemediationQueryQueryParams, } from './hooks/useGetEnvironmentListForRemediationQuery';
@@ -69,6 +73,7 @@ export type { ArtifactSbomDriftResponseBodyResponse } from './responses/Artifact
69
73
  export type { ArtifactSbomResponseBodyResponse } from './responses/ArtifactSbomResponseBodyResponse';
70
74
  export type { BaselineResponseBodyResponse } from './responses/BaselineResponseBodyResponse';
71
75
  export type { ComponentDriftResponseBodyResponse } from './responses/ComponentDriftResponseBodyResponse';
76
+ export type { ComponentListResponseBodyResponse } from './responses/ComponentListResponseBodyResponse';
72
77
  export type { CreateTicketResponseBodyResponse } from './responses/CreateTicketResponseBodyResponse';
73
78
  export type { LicenseDriftResponseBodyResponse } from './responses/LicenseDriftResponseBodyResponse';
74
79
  export type { PolicyViolationResponseResponse } from './responses/PolicyViolationResponseResponse';
@@ -83,6 +88,7 @@ export type { RemediationTrackerUpdateResponseBodyResponse } from './responses/R
83
88
  export type { RemediationTrackersOverallSummaryResponseBodyResponse } from './responses/RemediationTrackersOverallSummaryResponseBodyResponse';
84
89
  export type { SaveResponseResponse } from './responses/SaveResponseResponse';
85
90
  export type { SbomScorecardResponseBodyResponse } from './responses/SbomScorecardResponseBodyResponse';
91
+ export type { ArtifactAndDeploymentsResponseBody } from './schemas/ArtifactAndDeploymentsResponseBody';
86
92
  export type { ArtifactComponentViewRequestBody } from './schemas/ArtifactComponentViewRequestBody';
87
93
  export type { ArtifactComponentViewResponse } from './schemas/ArtifactComponentViewResponse';
88
94
  export type { ArtifactDeploymentViewRequestBody } from './schemas/ArtifactDeploymentViewRequestBody';
@@ -94,11 +100,13 @@ export type { ArtifactListingResponseV2 } from './schemas/ArtifactListingRespons
94
100
  export type { ArtifactSbomDriftRequestBody } from './schemas/ArtifactSbomDriftRequestBody';
95
101
  export type { ArtifactSbomDriftResponse } from './schemas/ArtifactSbomDriftResponse';
96
102
  export type { ArtifactSbomResponseBody } from './schemas/ArtifactSbomResponseBody';
103
+ export type { ArtifactVariant } from './schemas/ArtifactVariant';
97
104
  export type { BaselineRequestBody } from './schemas/BaselineRequestBody';
98
105
  export type { BaselineResponseBody } from './schemas/BaselineResponseBody';
99
106
  export type { CategoryScorecard } from './schemas/CategoryScorecard';
100
107
  export type { ComponentDrift } from './schemas/ComponentDrift';
101
108
  export type { ComponentDriftSummary } from './schemas/ComponentDriftSummary';
109
+ export type { ComponentDto } from './schemas/ComponentDto';
102
110
  export type { ComponentFilter } from './schemas/ComponentFilter';
103
111
  export type { ComponentSummary } from './schemas/ComponentSummary';
104
112
  export type { ContactInfo } from './schemas/ContactInfo';
@@ -1,5 +1,6 @@
1
1
  export { artifactList, useArtifactListQuery } from './hooks/useArtifactListQuery';
2
2
  export { calculateDriftForArtifact, useCalculateDriftForArtifactMutation, } from './hooks/useCalculateDriftForArtifactMutation';
3
+ export { checkArtifactAndDeployments, useCheckArtifactAndDeploymentsMutation, } from './hooks/useCheckArtifactAndDeploymentsMutation';
3
4
  export { closeRemediationTracker, useCloseRemediationTrackerMutation, } from './hooks/useCloseRemediationTrackerMutation';
4
5
  export { createRemediationTracker, useCreateRemediationTrackerMutation, } from './hooks/useCreateRemediationTrackerMutation';
5
6
  export { createTicket, useCreateTicketMutation } from './hooks/useCreateTicketMutation';
@@ -12,6 +13,7 @@ export { getArtifactInRemediationDetails, useGetArtifactInRemediationDetailsQuer
12
13
  export { getArtifactListForRemediation, useGetArtifactListForRemediationQuery, } from './hooks/useGetArtifactListForRemediationQuery';
13
14
  export { getBaselineForArtifact, useGetBaselineForArtifactQuery, } from './hooks/useGetBaselineForArtifactQuery';
14
15
  export { getComponentDrift, useGetComponentDriftQuery } from './hooks/useGetComponentDriftQuery';
16
+ export { getComponents, useGetComponentsQuery } from './hooks/useGetComponentsQuery';
15
17
  export { getDeploymentsListForArtifactInRemediation, useGetDeploymentsListForArtifactInRemediationQuery, } from './hooks/useGetDeploymentsListForArtifactInRemediationQuery';
16
18
  export { getEnvironmentListForRemediation, useGetEnvironmentListForRemediationQuery, } from './hooks/useGetEnvironmentListForRemediationQuery';
17
19
  export { getLicenseDrift, useGetLicenseDriftQuery } from './hooks/useGetLicenseDriftQuery';
@@ -0,0 +1,2 @@
1
+ import type { ComponentDto } from '../schemas/ComponentDto';
2
+ export type ComponentListResponseBodyResponse = ComponentDto[];
@@ -0,0 +1,4 @@
1
+ export interface ArtifactAndDeploymentsResponseBody {
2
+ is_valid?: boolean;
3
+ message?: string;
4
+ }
@@ -0,0 +1,4 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ export {};
@@ -1,3 +1,4 @@
1
+ import type { ArtifactVariant } from '../schemas/ArtifactVariant';
1
2
  export interface ArtifactListingResponseV2 {
2
3
  /**
3
4
  * Flag denoting if current artifact is baseline
@@ -70,7 +71,7 @@ export interface ArtifactListingResponseV2 {
70
71
  /**
71
72
  * artifact type
72
73
  */
73
- type?: string;
74
+ type?: 'image' | 'repository';
74
75
  /**
75
76
  * Last updated time of the artifact
76
77
  */
@@ -79,17 +80,5 @@ export interface ArtifactListingResponseV2 {
79
80
  * Artifact Origin URL
80
81
  */
81
82
  url?: string;
82
- /**
83
- * Artifact variant details
84
- */
85
- variant?: {
86
- /**
87
- * Type of the variant.
88
- */
89
- type?: string;
90
- /**
91
- * value of the variant for the aritfact.
92
- */
93
- value?: string;
94
- };
83
+ variant?: ArtifactVariant;
95
84
  }
@@ -1,4 +1 @@
1
- /* eslint-disable */
2
- // This code is autogenerated using @harnessio/oats-cli.
3
- // Please do not modify this code directly.
4
1
  export {};
@@ -0,0 +1,10 @@
1
+ export interface ArtifactVariant {
2
+ /**
3
+ * type of the variant of the artifact.
4
+ */
5
+ type?: 'branch' | 'commit' | 'gitTag' | 'tag';
6
+ /**
7
+ * Value of the variant of the artifact.
8
+ */
9
+ value?: string;
10
+ }
@@ -0,0 +1,4 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ export {};
@@ -0,0 +1,5 @@
1
+ export interface ComponentDto {
2
+ name?: string;
3
+ org?: string;
4
+ project?: string;
5
+ }
@@ -0,0 +1,4 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ export {};
@@ -1,4 +1,4 @@
1
1
  export interface RemediationArtifactListingRequestBody {
2
2
  deployment_status?: 'PreProd' | 'Prod';
3
- remediation_status?: 'Completed' | 'Pending';
3
+ remediation_status?: 'Done' | 'In_Progress';
4
4
  }
@@ -15,6 +15,10 @@ export interface RemediationDetailsResponse {
15
15
  * @format int64
16
16
  */
17
17
  artifacts_excluded: number;
18
+ /**
19
+ * If Remediation Tracker was closed manually , name of the user who closed it.
20
+ */
21
+ closed_by?: string;
18
22
  /**
19
23
  * Description/comments for the tracker.
20
24
  */
@@ -9,6 +9,11 @@ export interface RemediationListingResponse {
9
9
  * @format int64
10
10
  */
11
11
  artifacts: number;
12
+ /**
13
+ * If tracker was closed manually , name of the person who closed it
14
+ *
15
+ */
16
+ closed_by?: string;
12
17
  /**
13
18
  * Component Name.
14
19
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-ssca-manager-client",
3
- "version": "0.23.0",
3
+ "version": "0.25.0",
4
4
  "description": "Harness SSCA manager APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",