@harnessio/react-ssca-manager-client 0.18.0 → 0.19.0

package/dist/ssca-manager/src/services/hooks/useCreateRemediationTrackerMutation.js

@@ -4,7 +4,7 @@
 import { useMutation } from '@tanstack/react-query';
 import { fetcher } from '../../../../fetcher/index.js';
 export function createRemediationTracker(props) {
-    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediation`, method: 'POST' }, props));
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediations`, method: 'POST' }, props));
 }
 /**
  * Create Remediation Tracker.

package/dist/ssca-manager/src/services/hooks/useGetOverallSummaryQuery.d.ts

@@ -0,0 +1,20 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { RemediationTrackersOverallSummaryResponseBodyResponse } from '../responses/RemediationTrackersOverallSummaryResponseBodyResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface GetOverallSummaryQueryPathParams {
+    org: string;
+    project: string;
+}
+export interface GetOverallSummaryQueryHeaderParams {
+    'Harness-Account'?: string;
+}
+export type GetOverallSummaryOkResponse = ResponseWithPagination<RemediationTrackersOverallSummaryResponseBodyResponse>;
+export type GetOverallSummaryErrorResponse = unknown;
+export interface GetOverallSummaryProps extends GetOverallSummaryQueryPathParams, Omit<FetcherOptions<unknown, unknown, GetOverallSummaryQueryHeaderParams>, 'url'> {
+}
+export declare function getOverallSummary(props: GetOverallSummaryProps): Promise<GetOverallSummaryOkResponse>;
+/**
+ * Get Overall summary of Remediation Trackers.
+ */
+export declare function useGetOverallSummaryQuery(props: GetOverallSummaryProps, options?: Omit<UseQueryOptions<GetOverallSummaryOkResponse, GetOverallSummaryErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetOverallSummaryOkResponse, unknown>;

package/dist/ssca-manager/src/services/hooks/useGetOverallSummaryQuery.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 '../../../../fetcher/index.js';
+export function getOverallSummary(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediations/overall-summary`, method: 'GET' }, props));
+}
+/**
+ * Get Overall summary of Remediation Trackers.
+ */
+export function useGetOverallSummaryQuery(props, options) {
+    return useQuery(['getOverallSummary', props.org, props.project], ({ signal }) => getOverallSummary(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/ssca-manager/src/services/hooks/useListRemediationsQuery.d.ts

@@ -0,0 +1,39 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { RemediationListingResponseBodyResponse } from '../responses/RemediationListingResponseBodyResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ListRemediationsQueryPathParams {
+    org: string;
+    project: string;
+}
+export interface ListRemediationsQueryQueryParams {
+    /**
+     * @default 30
+     */
+    limit?: number;
+    /**
+     * @default "ASC"
+     */
+    order?: 'ASC' | 'DESC';
+    /**
+     * @default 0
+     */
+    page?: number;
+    /**
+     * @default "component"
+     */
+    sort?: {};
+}
+export interface ListRemediationsQueryHeaderParams {
+    'Harness-Account'?: string;
+}
+export type ListRemediationsOkResponse = ResponseWithPagination<RemediationListingResponseBodyResponse>;
+export type ListRemediationsErrorResponse = unknown;
+export interface ListRemediationsProps extends ListRemediationsQueryPathParams, Omit<FetcherOptions<ListRemediationsQueryQueryParams, unknown, ListRemediationsQueryHeaderParams>, 'url'> {
+    queryParams: ListRemediationsQueryQueryParams;
+}
+export declare function listRemediations(props: ListRemediationsProps): Promise<ListRemediationsOkResponse>;
+/**
+ * List all Remediation Trackers.
+ */
+export declare function useListRemediationsQuery(props: ListRemediationsProps, options?: Omit<UseQueryOptions<ListRemediationsOkResponse, ListRemediationsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListRemediationsOkResponse, unknown>;

package/dist/ssca-manager/src/services/hooks/useListRemediationsQuery.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 '../../../../fetcher/index.js';
+export function listRemediations(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediations`, method: 'GET' }, props));
+}
+/**
+ * List all Remediation Trackers.
+ */
+export function useListRemediationsQuery(props, options) {
+    return useQuery(['listRemediations', props.org, props.project, props.queryParams], ({ signal }) => listRemediations(Object.assign(Object.assign({}, props), { signal })), options);
+}

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

@@ -17,6 +17,8 @@ export type { GetComponentDriftErrorResponse, GetComponentDriftOkResponse, GetCo
 export { getComponentDrift, useGetComponentDriftQuery } from './hooks/useGetComponentDriftQuery';
 export type { GetLicenseDriftErrorResponse, GetLicenseDriftOkResponse, GetLicenseDriftProps, GetLicenseDriftQueryPathParams, GetLicenseDriftQueryQueryParams, } from './hooks/useGetLicenseDriftQuery';
 export { getLicenseDrift, useGetLicenseDriftQuery } from './hooks/useGetLicenseDriftQuery';
+export type { GetOverallSummaryErrorResponse, GetOverallSummaryOkResponse, GetOverallSummaryProps, GetOverallSummaryQueryPathParams, } from './hooks/useGetOverallSummaryQuery';
+export { getOverallSummary, useGetOverallSummaryQuery } from './hooks/useGetOverallSummaryQuery';
 export type { GetPolicyViolationsErrorResponse, GetPolicyViolationsOkResponse, GetPolicyViolationsProps, GetPolicyViolationsQueryPathParams, GetPolicyViolationsQueryQueryParams, } from './hooks/useGetPolicyViolationsQuery';
 export { getPolicyViolations, useGetPolicyViolationsQuery, } from './hooks/useGetPolicyViolationsQuery';
 export type { GetSbomScorecardErrorResponse, GetSbomScorecardOkResponse, GetSbomScorecardProps, GetSbomScorecardQueryPathParams, } from './hooks/useGetSbomScorecardQuery';
@@ -25,6 +27,8 @@ export type { ListArtifactsErrorResponse, ListArtifactsOkResponse, ListArtifacts
 export { listArtifacts, useListArtifactsQuery } from './hooks/useListArtifactsQuery';
 export type { ListLatestArtifactsErrorResponse, ListLatestArtifactsOkResponse, ListLatestArtifactsProps, ListLatestArtifactsQueryPathParams, ListLatestArtifactsQueryQueryParams, } from './hooks/useListLatestArtifactsQuery';
 export { listLatestArtifacts, useListLatestArtifactsQuery, } from './hooks/useListLatestArtifactsQuery';
+export type { ListRemediationsErrorResponse, ListRemediationsOkResponse, ListRemediationsProps, ListRemediationsQueryPathParams, ListRemediationsQueryQueryParams, } from './hooks/useListRemediationsQuery';
+export { listRemediations, useListRemediationsQuery } from './hooks/useListRemediationsQuery';
 export type { SetBaselineForArtifactErrorResponse, SetBaselineForArtifactMutationPathParams, SetBaselineForArtifactOkResponse, SetBaselineForArtifactProps, SetBaselineForArtifactRequestBody, } from './hooks/useSetBaselineForArtifactMutation';
 export { setBaselineForArtifact, useSetBaselineForArtifactMutation, } from './hooks/useSetBaselineForArtifactMutation';
 export type { ArtifactListingRequestBodyRequestBody } from './requestBodies/ArtifactListingRequestBodyRequestBody';
@@ -40,7 +44,9 @@ export type { BaselineResponseBodyResponse } from './responses/BaselineResponseB
 export type { ComponentDriftResponseBodyResponse } from './responses/ComponentDriftResponseBodyResponse';
 export type { LicenseDriftResponseBodyResponse } from './responses/LicenseDriftResponseBodyResponse';
 export type { PolicyViolationResponseResponse } from './responses/PolicyViolationResponseResponse';
+export type { RemediationListingResponseBodyResponse } from './responses/RemediationListingResponseBodyResponse';
 export type { RemediationTrackerCreateResponseBodyResponse } from './responses/RemediationTrackerCreateResponseBodyResponse';
+export type { RemediationTrackersOverallSummaryResponseBodyResponse } from './responses/RemediationTrackersOverallSummaryResponseBodyResponse';
 export type { SaveResponseResponse } from './responses/SaveResponseResponse';
 export type { SbomScorecardResponseBodyResponse } from './responses/SbomScorecardResponseBodyResponse';
 export type { ArtifactComponentViewRequestBody } from './schemas/ArtifactComponentViewRequestBody';
@@ -61,14 +67,19 @@ export type { ComponentDriftSummary } from './schemas/ComponentDriftSummary';
 export type { ComponentFilter } from './schemas/ComponentFilter';
 export type { ComponentSummary } from './schemas/ComponentSummary';
 export type { ContactInfo } from './schemas/ContactInfo';
+export type { DeploymentsCount } from './schemas/DeploymentsCount';
 export type { LicenseDrift } from './schemas/LicenseDrift';
 export type { LicenseDriftSummary } from './schemas/LicenseDriftSummary';
 export type { LicenseFilter } from './schemas/LicenseFilter';
 export type { Operator } from './schemas/Operator';
 export type { PolicyViolation } from './schemas/PolicyViolation';
 export type { RemediationCondition } from './schemas/RemediationCondition';
+export type { RemediationCount } from './schemas/RemediationCount';
+export type { RemediationListingResponse } from './schemas/RemediationListingResponse';
+export type { RemediationStatus } from './schemas/RemediationStatus';
 export type { RemediationTrackerCreateRequestBody } from './schemas/RemediationTrackerCreateRequestBody';
 export type { RemediationTrackerCreateResponseBody } from './schemas/RemediationTrackerCreateResponseBody';
+export type { RemediationTrackersOverallSummaryResponseBody } from './schemas/RemediationTrackersOverallSummaryResponseBody';
 export type { SaveResponse } from './schemas/SaveResponse';
 export type { SbomDetailsForScorecard } from './schemas/SbomDetailsForScorecard';
 export type { SbomScorecardResponseBody } from './schemas/SbomScorecardResponseBody';

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

@@ -7,8 +7,10 @@ export { getArtifactDetails, useGetArtifactDetailsQuery } from './hooks/useGetAr
 export { getBaselineForArtifact, useGetBaselineForArtifactQuery, } from './hooks/useGetBaselineForArtifactQuery';
 export { getComponentDrift, useGetComponentDriftQuery } from './hooks/useGetComponentDriftQuery';
 export { getLicenseDrift, useGetLicenseDriftQuery } from './hooks/useGetLicenseDriftQuery';
+export { getOverallSummary, useGetOverallSummaryQuery } from './hooks/useGetOverallSummaryQuery';
 export { getPolicyViolations, useGetPolicyViolationsQuery, } from './hooks/useGetPolicyViolationsQuery';
 export { getSbomScorecard, useGetSbomScorecardQuery } from './hooks/useGetSbomScorecardQuery';
 export { listArtifacts, useListArtifactsQuery } from './hooks/useListArtifactsQuery';
 export { listLatestArtifacts, useListLatestArtifactsQuery, } from './hooks/useListLatestArtifactsQuery';
+export { listRemediations, useListRemediationsQuery } from './hooks/useListRemediationsQuery';
 export { setBaselineForArtifact, useSetBaselineForArtifactMutation, } from './hooks/useSetBaselineForArtifactMutation';

package/dist/ssca-manager/src/services/responses/RemediationListingResponseBodyResponse.d.ts

@@ -0,0 +1,2 @@
+import type { RemediationListingResponse } from '../schemas/RemediationListingResponse';
+export type RemediationListingResponseBodyResponse = RemediationListingResponse[];

package/dist/ssca-manager/src/services/responses/RemediationListingResponseBodyResponse.js

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

package/dist/ssca-manager/src/services/responses/RemediationTrackersOverallSummaryResponseBodyResponse.d.ts

@@ -0,0 +1,2 @@
+import type { RemediationTrackersOverallSummaryResponseBody } from '../schemas/RemediationTrackersOverallSummaryResponseBody';
+export type RemediationTrackersOverallSummaryResponseBodyResponse = RemediationTrackersOverallSummaryResponseBody;

package/dist/ssca-manager/src/services/responses/RemediationTrackersOverallSummaryResponseBodyResponse.js

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

package/dist/ssca-manager/src/services/schemas/DeploymentsCount.d.ts

@@ -0,0 +1,22 @@
+export interface DeploymentsCount {
+    /**
+     * Patched Non Prod Deployments.
+     * @format int64
+     */
+    patched_non_prod_count: number;
+    /**
+     * Patched Prod Deployments.
+     * @format int64
+     */
+    patched_prod_count: number;
+    /**
+     * Pending Non Prod Deployments to remediate.
+     * @format int64
+     */
+    pending_non_prod_count: number;
+    /**
+     * Pending Prod Deployments to remediate.
+     * @format int64
+     */
+    pending_prod_count: number;
+}

package/dist/ssca-manager/src/services/schemas/DeploymentsCount.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/ssca-manager/src/services/schemas/RemediationCount.d.ts

@@ -0,0 +1,10 @@
+import type { RemediationStatus } from '../schemas/RemediationStatus';
+export interface RemediationCount {
+    /**
+     * Number of trackers having the status.
+     * @format int64
+     * @default 0
+     */
+    count?: number;
+    status?: RemediationStatus;
+}

package/dist/ssca-manager/src/services/schemas/RemediationCount.js

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

package/dist/ssca-manager/src/services/schemas/RemediationListingResponse.d.ts

@@ -0,0 +1,42 @@
+import type { ContactInfo } from '../schemas/ContactInfo';
+import type { DeploymentsCount } from '../schemas/DeploymentsCount';
+import type { RemediationCondition } from '../schemas/RemediationCondition';
+import type { VulnerabilitySeverity } from '../schemas/VulnerabilitySeverity';
+import type { RemediationStatus } from '../schemas/RemediationStatus';
+export interface RemediationListingResponse {
+    /**
+     * Total distinct artifacts included in the tracker.
+     * @format int64
+     */
+    artifacts: number;
+    /**
+     * Component Name.
+     */
+    component: string;
+    contact?: ContactInfo;
+    /**
+     * CVE number.
+     */
+    cve?: string;
+    deployments_count: DeploymentsCount;
+    /**
+     * Tracker Id.
+     */
+    id: string;
+    remediation_condition?: RemediationCondition;
+    /**
+     * This indicates how we are going with schedule of target date.
+     *
+     */
+    schedule_status?: string;
+    severity: VulnerabilitySeverity;
+    status: RemediationStatus;
+    /**
+     * Target End Date set by the user.
+     */
+    target_date?: string;
+    /**
+     * Component Version.
+     */
+    version: string;
+}

package/dist/ssca-manager/src/services/schemas/RemediationListingResponse.js

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

package/dist/ssca-manager/src/services/schemas/RemediationStatus.d.ts

@@ -0,0 +1,2 @@
+export interface RemediationStatus {
+}

package/dist/ssca-manager/src/services/schemas/RemediationStatus.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/ssca-manager/src/services/schemas/RemediationTrackersOverallSummaryResponseBody.d.ts

@@ -0,0 +1,12 @@
+import type { RemediationCount } from '../schemas/RemediationCount';
+export interface RemediationTrackersOverallSummaryResponseBody {
+    /**
+     * Mean time to complete the Remediation in Hours.
+     * @format double
+     */
+    mean_time_to_remediate_in_hours?: number;
+    /**
+     * List of statuses and their counts.
+     */
+    remediation_counts?: RemediationCount[];
+}

package/dist/ssca-manager/src/services/schemas/RemediationTrackersOverallSummaryResponseBody.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-ssca-manager-client",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Harness SSCA manager APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",