@harnessio/react-ssca-manager-client 0.22.0 → 0.24.0

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

@@ -0,0 +1,47 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { ArtifactListingResponseBodyV2Response } from '../responses/ArtifactListingResponseBodyV2Response';
+import type { ArtifactListingRequestBodyRequestBody } from '../requestBodies/ArtifactListingRequestBodyRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ArtifactListQueryPathParams {
+    org: string;
+    project: string;
+}
+export interface ArtifactListQueryQueryParams {
+    /**
+     * @default 30
+     */
+    limit?: number;
+    /**
+     * @default "ASC"
+     */
+    order?: 'ASC' | 'DESC';
+    /**
+     * @default 0
+     */
+    page?: number;
+    /**
+     * @default "name"
+     */
+    sort?: {};
+    type: 'image' | 'repository';
+    /**
+     * @default "all"
+     */
+    view_mode?: 'all' | 'latest';
+}
+export interface ArtifactListQueryHeaderParams {
+    'Harness-Account'?: string;
+}
+export type ArtifactListRequestBody = ArtifactListingRequestBodyRequestBody;
+export type ArtifactListOkResponse = ResponseWithPagination<ArtifactListingResponseBodyV2Response>;
+export type ArtifactListErrorResponse = unknown;
+export interface ArtifactListProps extends ArtifactListQueryPathParams, Omit<FetcherOptions<ArtifactListQueryQueryParams, ArtifactListRequestBody, ArtifactListQueryHeaderParams>, 'url'> {
+    queryParams: ArtifactListQueryQueryParams;
+    body: ArtifactListRequestBody;
+}
+export declare function artifactList(props: ArtifactListProps): Promise<ArtifactListOkResponse>;
+/**
+ * List artifacts
+ */
+export declare function useArtifactListQuery(props: ArtifactListProps, options?: Omit<UseQueryOptions<ArtifactListOkResponse, ArtifactListErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ArtifactListOkResponse, unknown>;

package/dist/ssca-manager/src/services/hooks/useArtifactListQuery.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 artifactList(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/artifacts`, method: 'POST' }, props));
+}
+/**
+ * List artifacts
+ */
+export function useArtifactListQuery(props, options) {
+    return useQuery(['artifactList', props.org, props.project, props.queryParams, props.body], ({ signal }) => artifactList(Object.assign(Object.assign({}, props), { signal })), options);
+}

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

@@ -0,0 +1,23 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { ArtifactAndDeploymentsResponseBody } from '../schemas/ArtifactAndDeploymentsResponseBody';
+import type { RemediationTrackerCreateRequestBodyRequestBody } from '../requestBodies/RemediationTrackerCreateRequestBodyRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface CheckArtifactAndDeploymentsMutationPathParams {
+    org: string;
+    project: string;
+}
+export interface CheckArtifactAndDeploymentsMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type CheckArtifactAndDeploymentsRequestBody = RemediationTrackerCreateRequestBodyRequestBody;
+export type CheckArtifactAndDeploymentsOkResponse = ResponseWithPagination<ArtifactAndDeploymentsResponseBody>;
+export type CheckArtifactAndDeploymentsErrorResponse = unknown;
+export interface CheckArtifactAndDeploymentsProps extends CheckArtifactAndDeploymentsMutationPathParams, Omit<FetcherOptions<unknown, CheckArtifactAndDeploymentsRequestBody, CheckArtifactAndDeploymentsMutationHeaderParams>, 'url'> {
+    body: CheckArtifactAndDeploymentsRequestBody;
+}
+export declare function checkArtifactAndDeployments(props: CheckArtifactAndDeploymentsProps): Promise<CheckArtifactAndDeploymentsOkResponse>;
+/**
+ * Check Artifacts And Deployments.
+ */
+export declare function useCheckArtifactAndDeploymentsMutation(options?: Omit<UseMutationOptions<CheckArtifactAndDeploymentsOkResponse, CheckArtifactAndDeploymentsErrorResponse, CheckArtifactAndDeploymentsProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<CheckArtifactAndDeploymentsOkResponse, unknown, CheckArtifactAndDeploymentsProps, unknown>;

package/dist/ssca-manager/src/services/hooks/useCheckArtifactAndDeploymentsMutation.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 checkArtifactAndDeployments(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/remediations/check-artifacts`, method: 'POST' }, props));
+}
+/**
+ * Check Artifacts And Deployments.
+ */
+export function useCheckArtifactAndDeploymentsMutation(options) {
+    return useMutation((mutateProps) => checkArtifactAndDeployments(mutateProps), options);
+}

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

@@ -1,6 +1,10 @@
 export type { GetPathParamsType, ResponseWithPagination } from './helpers';
+export type { ArtifactListErrorResponse, ArtifactListOkResponse, ArtifactListProps, ArtifactListQueryPathParams, ArtifactListQueryQueryParams, ArtifactListRequestBody, } from './hooks/useArtifactListQuery';
+export { artifactList, useArtifactListQuery } from './hooks/useArtifactListQuery';
 export type { CalculateDriftForArtifactErrorResponse, CalculateDriftForArtifactMutationPathParams, CalculateDriftForArtifactOkResponse, CalculateDriftForArtifactProps, CalculateDriftForArtifactRequestBody, } from './hooks/useCalculateDriftForArtifactMutation';
 export { calculateDriftForArtifact, useCalculateDriftForArtifactMutation, } from './hooks/useCalculateDriftForArtifactMutation';
+export type { CheckArtifactAndDeploymentsErrorResponse, CheckArtifactAndDeploymentsMutationPathParams, CheckArtifactAndDeploymentsOkResponse, CheckArtifactAndDeploymentsProps, CheckArtifactAndDeploymentsRequestBody, } from './hooks/useCheckArtifactAndDeploymentsMutation';
+export { checkArtifactAndDeployments, useCheckArtifactAndDeploymentsMutation, } from './hooks/useCheckArtifactAndDeploymentsMutation';
 export type { CloseRemediationTrackerErrorResponse, CloseRemediationTrackerMutationPathParams, CloseRemediationTrackerOkResponse, CloseRemediationTrackerProps, } from './hooks/useCloseRemediationTrackerMutation';
 export { closeRemediationTracker, useCloseRemediationTrackerMutation, } from './hooks/useCloseRemediationTrackerMutation';
 export type { CreateRemediationTrackerErrorResponse, CreateRemediationTrackerMutationPathParams, CreateRemediationTrackerOkResponse, CreateRemediationTrackerProps, CreateRemediationTrackerRequestBody, } from './hooks/useCreateRemediationTrackerMutation';
@@ -62,6 +66,7 @@ export type { ArtifactComponentViewResponseBodyResponse } from './responses/Arti
 export type { ArtifactDeploymentViewResponseBodyResponse } from './responses/ArtifactDeploymentViewResponseBodyResponse';
 export type { ArtifactDetailResponseBodyResponse } from './responses/ArtifactDetailResponseBodyResponse';
 export type { ArtifactListingResponseBodyResponse } from './responses/ArtifactListingResponseBodyResponse';
+export type { ArtifactListingResponseBodyV2Response } from './responses/ArtifactListingResponseBodyV2Response';
 export type { ArtifactSbomDriftResponseBodyResponse } from './responses/ArtifactSbomDriftResponseBodyResponse';
 export type { ArtifactSbomResponseBodyResponse } from './responses/ArtifactSbomResponseBodyResponse';
 export type { BaselineResponseBodyResponse } from './responses/BaselineResponseBodyResponse';
@@ -80,6 +85,7 @@ export type { RemediationTrackerUpdateResponseBodyResponse } from './responses/R
 export type { RemediationTrackersOverallSummaryResponseBodyResponse } from './responses/RemediationTrackersOverallSummaryResponseBodyResponse';
 export type { SaveResponseResponse } from './responses/SaveResponseResponse';
 export type { SbomScorecardResponseBodyResponse } from './responses/SbomScorecardResponseBodyResponse';
+export type { ArtifactAndDeploymentsResponseBody } from './schemas/ArtifactAndDeploymentsResponseBody';
 export type { ArtifactComponentViewRequestBody } from './schemas/ArtifactComponentViewRequestBody';
 export type { ArtifactComponentViewResponse } from './schemas/ArtifactComponentViewResponse';
 export type { ArtifactDeploymentViewRequestBody } from './schemas/ArtifactDeploymentViewRequestBody';
@@ -87,9 +93,11 @@ export type { ArtifactDeploymentViewResponse } from './schemas/ArtifactDeploymen
 export type { ArtifactDetailResponse } from './schemas/ArtifactDetailResponse';
 export type { ArtifactListingRequestBody } from './schemas/ArtifactListingRequestBody';
 export type { ArtifactListingResponse } from './schemas/ArtifactListingResponse';
+export type { ArtifactListingResponseV2 } from './schemas/ArtifactListingResponseV2';
 export type { ArtifactSbomDriftRequestBody } from './schemas/ArtifactSbomDriftRequestBody';
 export type { ArtifactSbomDriftResponse } from './schemas/ArtifactSbomDriftResponse';
 export type { ArtifactSbomResponseBody } from './schemas/ArtifactSbomResponseBody';
+export type { ArtifactVariant } from './schemas/ArtifactVariant';
 export type { BaselineRequestBody } from './schemas/BaselineRequestBody';
 export type { BaselineResponseBody } from './schemas/BaselineResponseBody';
 export type { CategoryScorecard } from './schemas/CategoryScorecard';

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

@@ -1,4 +1,6 @@
+export { artifactList, useArtifactListQuery } from './hooks/useArtifactListQuery';
 export { calculateDriftForArtifact, useCalculateDriftForArtifactMutation, } from './hooks/useCalculateDriftForArtifactMutation';
+export { checkArtifactAndDeployments, useCheckArtifactAndDeploymentsMutation, } from './hooks/useCheckArtifactAndDeploymentsMutation';
 export { closeRemediationTracker, useCloseRemediationTrackerMutation, } from './hooks/useCloseRemediationTrackerMutation';
 export { createRemediationTracker, useCreateRemediationTrackerMutation, } from './hooks/useCreateRemediationTrackerMutation';
 export { createTicket, useCreateTicketMutation } from './hooks/useCreateTicketMutation';

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

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

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

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

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

@@ -0,0 +1,4 @@
+export interface ArtifactAndDeploymentsResponseBody {
+    is_valid?: boolean;
+    message?: string;
+}

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

@@ -0,0 +1,84 @@
+import type { ArtifactVariant } from '../schemas/ArtifactVariant';
+export interface ArtifactListingResponseV2 {
+    /**
+     * Flag denoting if current artifact is baseline
+     */
+    baseline?: boolean;
+    /**
+     * Number of components of the artifact
+     */
+    components_count?: number;
+    deployment?: {
+        /**
+         * Latest deployment activity of the artifact
+         */
+        activity?: 'DEPLOYED' | 'GENERATED';
+        /**
+         * Count of pre-production environment this artifact is currently deployed.
+         */
+        non_prod_env_count?: number;
+        /**
+         * Count of production environment this artifact is currently deployed.
+         */
+        prod_env_count?: number;
+    };
+    /**
+     * Artifact ID
+     */
+    id?: string;
+    /**
+     * Artifact Name
+     */
+    name?: string;
+    orchestration?: {
+        /**
+         * Orchestration step execution ID for the aritfact.
+         */
+        id?: string;
+        /**
+         * Build pipeline execution Id used for orchestration of the artifact
+         */
+        pipeline_execution_id?: string;
+        /**
+         * Build pipeline Id used for orchestration of the artifact
+         */
+        pipeline_id?: string;
+    };
+    policy_enforcement?: {
+        /**
+         * Count of the allow list policy violations
+         */
+        allow_list_violation_count?: string;
+        /**
+         * Count of the deny list policy violations
+         */
+        deny_list_violation_count?: string;
+        /**
+         * Enforcement Step Id for the artifact lastest enfrocement.
+         */
+        id?: string;
+    };
+    scorecard?: {
+        /**
+         * Average score of the artifact SBOM
+         */
+        avg_score?: string;
+        /**
+         * Maximum score of the artifact SBOM
+         */
+        max_score?: string;
+    };
+    /**
+     * artifact type
+     */
+    type?: 'image' | 'repository';
+    /**
+     * Last updated time of the artifact
+     */
+    updated?: string;
+    /**
+     * Artifact Origin URL
+     */
+    url?: string;
+    variant?: ArtifactVariant;
+}

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

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

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

@@ -0,0 +1,10 @@
+export interface ArtifactVariant {
+    /**
+     * type of the variant of the artifact.
+     */
+    type?: 'branch' | 'commit' | 'gitTag' | 'tag';
+    /**
+     * Value of the variant of the artifact.
+     */
+    value?: string;
+}

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

@@ -1,4 +1,4 @@
 export interface RemediationArtifactListingRequestBody {
     deployment_status?: 'PreProd' | 'Prod';
-    remediation_status?: 'Completed' | 'Pending';
+    remediation_status?: 'Done' | 'In_Progress';
 }

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

@@ -15,6 +15,10 @@ export interface RemediationDetailsResponse {
      * @format int64
      */
     artifacts_excluded: number;
+    /**
+     * If Remediation Tracker was closed manually , name of the user who closed it.
+     */
+    closed_by?: string;
     /**
      * Description/comments for the tracker.
      */

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

@@ -5,13 +5,13 @@ export interface RemediationListingRequestBody {
      */
     component_name_filter?: {
         operator: NameOperator;
-        value?: string;
+        value: string;
     };
     /**
      * Filter for CVE.
      */
     cve_filter?: {
         operator: NameOperator;
-        value?: string;
+        value: string;
     };
 }

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

@@ -9,6 +9,11 @@ export interface RemediationListingResponse {
      * @format int64
      */
     artifacts: number;
+    /**
+     * If tracker was closed manually , name of the person who closed it
+     *
+     */
+    closed_by?: string;
     /**
      * Component Name.
      */

package/package.json

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