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

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

@@ -0,0 +1,23 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { RemediationTrackerCreateResponseBodyResponse } from '../responses/RemediationTrackerCreateResponseBodyResponse';
+import type { RemediationTrackerCreateRequestBodyRequestBody } from '../requestBodies/RemediationTrackerCreateRequestBodyRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface CreateRemediationTrackerMutationPathParams {
+    org: string;
+    project: string;
+}
+export interface CreateRemediationTrackerMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type CreateRemediationTrackerRequestBody = RemediationTrackerCreateRequestBodyRequestBody;
+export type CreateRemediationTrackerOkResponse = ResponseWithPagination<RemediationTrackerCreateResponseBodyResponse>;
+export type CreateRemediationTrackerErrorResponse = unknown;
+export interface CreateRemediationTrackerProps extends CreateRemediationTrackerMutationPathParams, Omit<FetcherOptions<unknown, CreateRemediationTrackerRequestBody, CreateRemediationTrackerMutationHeaderParams>, 'url'> {
+    body: CreateRemediationTrackerRequestBody;
+}
+export declare function createRemediationTracker(props: CreateRemediationTrackerProps): Promise<CreateRemediationTrackerOkResponse>;
+/**
+ * Create Remediation Tracker.
+ */
+export declare function useCreateRemediationTrackerMutation(options?: Omit<UseMutationOptions<CreateRemediationTrackerOkResponse, CreateRemediationTrackerErrorResponse, CreateRemediationTrackerProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<CreateRemediationTrackerOkResponse, unknown, CreateRemediationTrackerProps, unknown>;

package/dist/ssca-manager/src/services/hooks/useCreateRemediationTrackerMutation.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 '../../../../fetcher/index.js';
+export function createRemediationTracker(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediation`, method: 'POST' }, props));
+}
+/**
+ * Create Remediation Tracker.
+ */
+export function useCreateRemediationTrackerMutation(options) {
+    return useMutation((mutateProps) => createRemediationTracker(mutateProps), options);
+}

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

@@ -1,6 +1,8 @@
 export type { GetPathParamsType, ResponseWithPagination } from './helpers';
 export type { CalculateDriftForArtifactErrorResponse, CalculateDriftForArtifactMutationPathParams, CalculateDriftForArtifactOkResponse, CalculateDriftForArtifactProps, CalculateDriftForArtifactRequestBody, } from './hooks/useCalculateDriftForArtifactMutation';
 export { calculateDriftForArtifact, useCalculateDriftForArtifactMutation, } from './hooks/useCalculateDriftForArtifactMutation';
+export type { CreateRemediationTrackerErrorResponse, CreateRemediationTrackerMutationPathParams, CreateRemediationTrackerOkResponse, CreateRemediationTrackerProps, CreateRemediationTrackerRequestBody, } from './hooks/useCreateRemediationTrackerMutation';
+export { createRemediationTracker, useCreateRemediationTrackerMutation, } from './hooks/useCreateRemediationTrackerMutation';
 export type { DownloadSbomErrorResponse, DownloadSbomOkResponse, DownloadSbomProps, DownloadSbomQueryPathParams, } from './hooks/useDownloadSbomQuery';
 export { downloadSbom, useDownloadSbomQuery } from './hooks/useDownloadSbomQuery';
 export type { GetArtifactDetailComponentViewErrorResponse, GetArtifactDetailComponentViewOkResponse, GetArtifactDetailComponentViewProps, GetArtifactDetailComponentViewQueryPathParams, GetArtifactDetailComponentViewQueryQueryParams, GetArtifactDetailComponentViewRequestBody, } from './hooks/useGetArtifactDetailComponentViewQuery';
@@ -27,6 +29,7 @@ export type { SetBaselineForArtifactErrorResponse, SetBaselineForArtifactMutatio
 export { setBaselineForArtifact, useSetBaselineForArtifactMutation, } from './hooks/useSetBaselineForArtifactMutation';
 export type { ArtifactListingRequestBodyRequestBody } from './requestBodies/ArtifactListingRequestBodyRequestBody';
 export type { BaselineRequestBodyRequestBody } from './requestBodies/BaselineRequestBodyRequestBody';
+export type { RemediationTrackerCreateRequestBodyRequestBody } from './requestBodies/RemediationTrackerCreateRequestBodyRequestBody';
 export type { ArtifactComponentViewResponseBodyResponse } from './responses/ArtifactComponentViewResponseBodyResponse';
 export type { ArtifactDeploymentViewResponseBodyResponse } from './responses/ArtifactDeploymentViewResponseBodyResponse';
 export type { ArtifactDetailResponseBodyResponse } from './responses/ArtifactDetailResponseBodyResponse';
@@ -37,6 +40,7 @@ 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 { RemediationTrackerCreateResponseBodyResponse } from './responses/RemediationTrackerCreateResponseBodyResponse';
 export type { SaveResponseResponse } from './responses/SaveResponseResponse';
 export type { SbomScorecardResponseBodyResponse } from './responses/SbomScorecardResponseBodyResponse';
 export type { ArtifactComponentViewRequestBody } from './schemas/ArtifactComponentViewRequestBody';
@@ -53,14 +57,22 @@ export type { BaselineRequestBody } from './schemas/BaselineRequestBody';
 export type { BaselineResponseBody } from './schemas/BaselineResponseBody';
 export type { CategoryScorecard } from './schemas/CategoryScorecard';
 export type { ComponentDrift } from './schemas/ComponentDrift';
+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 { 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 { RemediationTrackerCreateRequestBody } from './schemas/RemediationTrackerCreateRequestBody';
+export type { RemediationTrackerCreateResponseBody } from './schemas/RemediationTrackerCreateResponseBody';
 export type { SaveResponse } from './schemas/SaveResponse';
 export type { SbomDetailsForScorecard } from './schemas/SbomDetailsForScorecard';
 export type { SbomScorecardResponseBody } from './schemas/SbomScorecardResponseBody';
 export type { ScorecardInfo } from './schemas/ScorecardInfo';
 export type { Slsa } from './schemas/Slsa';
+export type { VulnerabilityInfo } from './schemas/VulnerabilityInfo';
+export type { VulnerabilitySeverity } from './schemas/VulnerabilitySeverity';

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

@@ -1,4 +1,5 @@
 export { calculateDriftForArtifact, useCalculateDriftForArtifactMutation, } from './hooks/useCalculateDriftForArtifactMutation';
+export { createRemediationTracker, useCreateRemediationTrackerMutation, } from './hooks/useCreateRemediationTrackerMutation';
 export { downloadSbom, useDownloadSbomQuery } from './hooks/useDownloadSbomQuery';
 export { getArtifactDetailComponentView, useGetArtifactDetailComponentViewQuery, } from './hooks/useGetArtifactDetailComponentViewQuery';
 export { getArtifactDetailDeploymentView, useGetArtifactDetailDeploymentViewQuery, } from './hooks/useGetArtifactDetailDeploymentViewQuery';

package/dist/ssca-manager/src/services/requestBodies/RemediationTrackerCreateRequestBodyRequestBody.d.ts

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

package/dist/ssca-manager/src/services/requestBodies/RemediationTrackerCreateRequestBodyRequestBody.js

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

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

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

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

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

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

@@ -1,3 +1,5 @@
+import type { ComponentDriftSummary } from '../schemas/ComponentDriftSummary';
+import type { LicenseDriftSummary } from '../schemas/LicenseDriftSummary';
 /**
  * Response body for sbom drift calculation between 2 artifact versions.
  */
@@ -5,17 +7,23 @@ export interface ArtifactSbomDriftResponse {
     /**
      * Artifact name
      */
-    artifact_name?: string;
+    artifact_name: string;
     /**
      * Base tag from which drift was calculated
      */
-    base_tag?: string;
+    base_tag: string;
+    component_drift_summary?: ComponentDriftSummary;
     /**
      * Drift ID to get the drift results
      */
-    drift_id?: string;
+    drift_id: string;
+    license_drift_summary?: LicenseDriftSummary;
     /**
      * Tag on which drift was calculated
      */
-    tag?: string;
+    tag: string;
+    /**
+     * Sum total of component and license drifts.
+     */
+    total_drifts: number;
 }

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

@@ -1,4 +1 @@
-/* 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/ComponentDriftSummary.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Component drift summary
+ */
+export interface ComponentDriftSummary {
+    /**
+     * Number of components added.
+     */
+    added: number;
+    /**
+     * Number of components deleted.
+     */
+    deleted: number;
+    /**
+     * Number of components modified.
+     */
+    modified: number;
+    /**
+     * Total number of component drifts.
+     */
+    total: number;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Contact Details.
+ */
+export interface ContactInfo {
+    /**
+     * Email of the Contact person.
+     */
+    email?: string;
+    /**
+     * Name of the contact person.
+     */
+    name?: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Provides License Drift Summary
+ */
+export interface LicenseDriftSummary {
+    /**
+     * Total number of licenses added.
+     */
+    added: number;
+    /**
+     * Total number of licenses deleted
+     */
+    deleted: number;
+    /**
+     * Total number of license drifts.
+     */
+    total: number;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Removal of the following version indicates Artifact is remediated.
+ */
+export interface RemediationCondition {
+    /**
+     * Operator for Remediation Condition.
+     */
+    operator: 'All' | 'LessThan' | 'LessThanEquals' | 'Matches';
+    /**
+     * Component Version for Remediation. For operator like less than, less than equals, range, semantic versioning is required.
+     *
+     */
+    version?: string;
+}

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

@@ -0,0 +1,20 @@
+import type { ContactInfo } from '../schemas/ContactInfo';
+import type { RemediationCondition } from '../schemas/RemediationCondition';
+import type { VulnerabilityInfo } from '../schemas/VulnerabilityInfo';
+/**
+ * Create Request Body For Remediation tracker.
+ */
+export interface RemediationTrackerCreateRequestBody<T0 extends VulnerabilityInfo = VulnerabilityInfo> {
+    /**
+     * Description/comments for the tracker.
+     */
+    comments?: string;
+    contact?: ContactInfo;
+    remediation_condition: RemediationCondition;
+    /**
+     * Target End Date in UTC.
+     * @format date
+     */
+    target_end_date?: string;
+    vulnerability_info?: T0;
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface RemediationTrackerCreateResponseBody {
+    /**
+     * Remediation Tracker Id.
+     */
+    id?: string;
+}

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

@@ -0,0 +1,17 @@
+import type { VulnerabilitySeverity } from '../schemas/VulnerabilitySeverity';
+export interface VulnerabilityInfo {
+    /**
+     * Name of the component where vulnerability is found.
+     */
+    component_name: string;
+    /**
+     * Version(s) of the component where vulnerability is found.
+     */
+    component_version?: string;
+    severity: VulnerabilitySeverity;
+    type: {};
+    /**
+     * Details of the vulnerability.
+     */
+    vulnerability_description?: string;
+}

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

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

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

@@ -0,0 +1,5 @@
+/**
+ * Severity of the Vulnerability.
+ */
+export interface VulnerabilitySeverity {
+}

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

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/package.json

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