@harnessio/react-sto-core-client 0.2.0 → 0.3.0

package/dist/sto-core/src/services/hooks/useScansScanIssueOccurrencesQuery.d.ts

@@ -0,0 +1,88 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { ScansScanIssueResponseBody } from '../schemas/ScansScanIssueResponseBody';
+import type { NotFound } from '../schemas/NotFound';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ScansScanIssueOccurrencesQueryPathParams {
+    /**
+     * The ID of the Security Test Scan
+     * @example "Saepe enim sint labore modi at."
+     */
+    id: string;
+    /**
+     * The ID of the Security Test Issue
+     * @example "Iure omnis et."
+     */
+    issueId: string;
+}
+export interface ScansScanIssueOccurrencesQueryQueryParams {
+    /**
+     * Harness Account ID
+     * @example "abcdef1234567890ghijkl"
+     */
+    accountId: string;
+    /**
+     * Harness Organization ID
+     * @example "example_org"
+     */
+    orgId?: string;
+    /**
+     * Harness Project ID
+     * @example "example_project"
+     */
+    projectId?: string;
+    /**
+     * Page number to fetch (starting from 0)
+     * @format int64
+     * @default 0
+     * @example 4
+     */
+    page?: number;
+    /**
+     * Number of results per page
+     * @format int64
+     * @default 30
+     * @example 50
+     */
+    pageSize?: number;
+    /**
+     * @example "CWE-123,5"
+     */
+    search?: string;
+    /**
+     * @example "EXEMPTED,REJECTED"
+     */
+    exemptionStatus?: string;
+    /**
+     * The field to sort by
+     * @example "Aut aut."
+     */
+    sort?: string;
+    /**
+     * The order to sort by
+     * @example "ASC"
+     */
+    order?: 'ASC' | 'DESC';
+    /**
+     * ID of Security Test Exemption if the API call is for scan + issue + exemption, needed for exemption issue target occurrences detail
+     * @example "abcdef1234567890ghijkl"
+     */
+    exemptionId?: string;
+}
+export interface ScansScanIssueOccurrencesQueryHeaderParams {
+    /**
+     * Harness personal or service access token
+     * @example "Ut possimus est neque consequatur."
+     */
+    'X-Api-Key'?: string;
+}
+export type ScansScanIssueOccurrencesOkResponse = ResponseWithPagination<ScansScanIssueResponseBody>;
+export type ScansScanIssueOccurrencesErrorResponse = NotFound;
+export interface ScansScanIssueOccurrencesProps extends ScansScanIssueOccurrencesQueryPathParams, Omit<FetcherOptions<ScansScanIssueOccurrencesQueryQueryParams, unknown, ScansScanIssueOccurrencesQueryHeaderParams>, 'url'> {
+    queryParams: ScansScanIssueOccurrencesQueryQueryParams;
+}
+export declare function scansScanIssueOccurrences(props: ScansScanIssueOccurrencesProps): Promise<ScansScanIssueOccurrencesOkResponse>;
+/**
+ * Returns occurrences for a scan specific issue
+ */
+export declare function useScansScanIssueOccurrencesQuery(props: ScansScanIssueOccurrencesProps, options?: Omit<UseQueryOptions<ScansScanIssueOccurrencesOkResponse, ScansScanIssueOccurrencesErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ScansScanIssueOccurrencesOkResponse, NotFound>;

package/dist/sto-core/src/services/hooks/useScansScanIssueOccurrencesQuery.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 scansScanIssueOccurrences(props) {
+    return fetcher(Object.assign({ url: `/api/v2/scans/${props.id}/issue/${props.issueId}/occurrences`, method: 'GET' }, props));
+}
+/**
+ * Returns occurrences for a scan specific issue
+ */
+export function useScansScanIssueOccurrencesQuery(props, options) {
+    return useQuery(['Scans#ScanIssueOccurrences', props.id, props.issueId, props.queryParams], ({ signal }) => scansScanIssueOccurrences(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/sto-core/src/services/index.d.ts

@@ -1,5 +1,8 @@
 export type { GetPathParamsType, ResponseWithPagination } from './helpers';
-export type { ReferenceIdentifiersGetByReferenceIdErrorResponse, ReferenceIdentifiersGetByReferenceIdOkResponse, ReferenceIdentifiersGetByReferenceIdProps, ReferenceIdentifiersGetByReferenceIdQueryPathParams, } from './hooks/useReferenceIdentifiersGetByReferenceIdQuery';
-export { referenceIdentifiersGetByReferenceId, useReferenceIdentifiersGetByReferenceIdQuery, } from './hooks/useReferenceIdentifiersGetByReferenceIdQuery';
-export type { GetByReferenceIdResponseBody } from './schemas/GetByReferenceIdResponseBody';
+export type { ScansScanIssueOccurrencesErrorResponse, ScansScanIssueOccurrencesOkResponse, ScansScanIssueOccurrencesProps, ScansScanIssueOccurrencesQueryPathParams, ScansScanIssueOccurrencesQueryQueryParams, } from './hooks/useScansScanIssueOccurrencesQuery';
+export { scansScanIssueOccurrences, useScansScanIssueOccurrencesQuery, } from './hooks/useScansScanIssueOccurrencesQuery';
+export type { GitMetadata } from './schemas/GitMetadata';
+export type { IssueInScan } from './schemas/IssueInScan';
 export type { NotFound } from './schemas/NotFound';
+export type { Pagination } from './schemas/Pagination';
+export type { ScansScanIssueResponseBody } from './schemas/ScansScanIssueResponseBody';

package/dist/sto-core/src/services/index.js

@@ -1 +1 @@
-export { referenceIdentifiersGetByReferenceId, useReferenceIdentifiersGetByReferenceIdQuery, } from './hooks/useReferenceIdentifiersGetByReferenceIdQuery';
+export { scansScanIssueOccurrences, useScansScanIssueOccurrencesQuery, } from './hooks/useScansScanIssueOccurrencesQuery';

package/dist/sto-core/src/services/schemas/GitMetadata.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Git Metadata associated with the Scan
+ * @example {"detectedName":"Et error.","detectedVariant":"Sint qui est omnis ut.","droneCorrelated":true,"provider":"Temporibus non atque.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Aut eos.","Blanditiis laboriosam voluptatibus quis.","Aut laboriosam.","Non et."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"}
+ */
+export interface GitMetadata {
+    /**
+     * Detected Name
+     * @example "Fugiat sunt quia impedit quos temporibus."
+     */
+    detectedName?: string;
+    /**
+     * Detected Variant
+     * @example "Eveniet eius placeat possimus ullam."
+     */
+    detectedVariant?: string;
+    /**
+     * Drone Correlated
+     * @example true
+     */
+    droneCorrelated?: boolean;
+    /**
+     * Git Provider
+     * @example "Esse exercitationem reiciendis."
+     */
+    provider?: string;
+    /**
+     * Git Pull Request Number
+     * @format int64
+     * @example 11
+     */
+    pullRequestNumber?: number;
+    /**
+     * Git HTTP Repository
+     * @example "https://github.com/harness/drone-cli.git"
+     */
+    repositoryHttp?: string;
+    /**
+     * Git Repository Path
+     * @example ["Inventore voluptatum eos dolores.","Quo omnis similique quod perspiciatis.","Aut nobis nostrum enim id omnis."]
+     */
+    repositoryPath?: string[];
+    /**
+     * Git SSH Repository
+     * @example "git@github.com:harness/drone-cli.git"
+     */
+    repositorySsh?: string;
+    /**
+     * Git Source Branch
+     * @example "feat/shiny-object"
+     */
+    sourceBranch?: string;
+    /**
+     * Git Target Branch
+     * @example "develop"
+     */
+    targetBranch?: string;
+    /**
+     * Git Workspace Root
+     * @example "/harness"
+     */
+    workspace?: string;
+}

package/dist/sto-core/src/services/schemas/IssueInScan.d.ts

@@ -0,0 +1,156 @@
+import type { GitMetadata } from '../schemas/GitMetadata';
+import type { Pagination } from '../schemas/Pagination';
+/**
+ * @example {"baselineVariantId":"abcdef1234567890ghijkl","created":1651578240,"currentStatus":"Rejected","details":{"package":"json-schema","version":"v0.2.3"},"exemptionCoverage":"Partially Exempted","exemptionId":"abcdef1234567890ghijkl","exemptionStatusAtScan":"Approved","gitMetadata":{"detectedName":"Ullam maiores quas ea unde.","detectedVariant":"Exercitationem odit cumque.","droneCorrelated":false,"provider":"Reiciendis corporis et.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Aut sed vero quos laudantium est reprehenderit.","Ducimus aspernatur facere in ut culpa.","Deserunt aliquid.","Laboriosam ad dolore."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"},"harnessAugmentation":{"Nobis pariatur eos voluptatibus nesciunt similique dolor.":"Nulla magnam assumenda doloremque consectetur.","Rem ullam explicabo.":"Est reiciendis labore quis et."},"id":"abcdef1234567890ghijkl","key":"json-schema@0.2.3","numNonExemptedOccurrences":10,"numOccurrences":10,"occurrenceId":12345,"occurrences":[{"line":"42"},{"line":"666"}],"occurrencesPagination":{"link":"","page":4,"pageSize":20,"totalItems":230,"totalPages":12},"primaryOccurrenceId":12345,"productId":"product1234567890abcde","severity":8.5,"severityCode":"High","status":"Remediated","subproduct":"product","targetId":"abcdef1234567890ghijkl","targetName":"abcdef1234567890ghijkl","targetType":"repository","targetVariantId":"abcdef1234567890ghijkl","targetVariantName":"nodegoat:master","title":"json-schema@0.2.3 is vulnerable to Prototype Pollution","type":"SAST"}
+ */
+export interface IssueInScan {
+    /**
+     * The Baseline Target Variant related to this Security Issue
+     * @example "abcdef1234567890ghijkl"
+     */
+    baselineVariantId?: string;
+    /**
+     * Unix timestamp at which the resource was created
+     * @format int64
+     * @example 1651578240
+     */
+    created: number;
+    /**
+     * Current status of the Exemption
+     * @example "Approved"
+     */
+    currentStatus?: 'Approved' | 'Expired' | 'Pending' | 'Rejected';
+    /**
+     * Issue details common to all occurrences
+     * @example {"package":"json-schema","version":"v0.2.3"}
+     */
+    details: {
+        [key: string]: any;
+    };
+    /**
+     * Indicates if the Security Issue was found to be Exempted, Partially Exempted.
+     * @example "Partially Exempted"
+     */
+    exemptionCoverage?: string;
+    /**
+     * ID of the associated Exemption
+     * @example "abcdef1234567890ghijkl"
+     */
+    exemptionId?: string;
+    /**
+     * Exemption's status at the Security Scan created time
+     * @example "Rejected"
+     */
+    exemptionStatusAtScan?: 'Approved' | 'Expired' | 'Pending' | 'Rejected';
+    gitMetadata?: GitMetadata;
+    /**
+     * Harness Augmentation details
+     * @example {"Aut autem unde ad culpa quia enim.":"Et sit aut nemo fugiat.","Quam iure corrupti non cupiditate.":"Assumenda repellendus neque nostrum autem dolor.","Sed in neque nihil ut.":"Totam magnam ratione vero a."}
+     */
+    harnessAugmentation?: {
+        [key: string]: any;
+    };
+    /**
+     * Resource identifier
+     * @example "abcdef1234567890ghijkl"
+     */
+    id: string;
+    /**
+     * Compression/deduplication key
+     * @example "json-schema@0.2.3"
+     */
+    key: string;
+    /**
+     * Indicates the number of Occurrences which dont have an active exemption on the Occurrence
+     * @format int32
+     * @default 0
+     * @example 10
+     */
+    numNonExemptedOccurrences: number;
+    /**
+     * Indicates the number of Occurrences on the Issue
+     * @format int32
+     * @example 10
+     */
+    numOccurrences: number;
+    /**
+     * @format int64
+     * @example 12345
+     */
+    occurrenceId?: number;
+    /**
+     * Array of details unique to each occurrence
+     * @example [{"line":"42"},{"line":"666"}]
+     */
+    occurrences?: Array<{
+        [key: string]: any;
+    }>;
+    occurrencesPagination: Pagination;
+    /**
+     * The primary occurrence's ID
+     * @format int64
+     * @example 12345
+     */
+    primaryOccurrenceId: number;
+    /**
+     * The scan tool that identified this Security Issue
+     * @example "product1234567890abcde"
+     */
+    productId: string;
+    /**
+     * Numeric severity, from 0 (lowest) to 10 (highest)
+     * @format float
+     * @example 8.5
+     */
+    severity: number;
+    /**
+     * Severity code
+     * @example "High"
+     */
+    severityCode: 'Critical' | 'High' | 'Info' | 'Low' | 'Medium' | 'Unassigned';
+    /**
+     * Indicates if the Security Issue was found to be remediated, ignored, etc.
+     * @example "Remediated"
+     */
+    status?: 'Acceptable Risk' | 'Acceptable Use' | 'Compensating Controls' | 'Exempted' | 'False Positive' | 'Fix Unavailable' | 'Remediated';
+    /**
+     * The subproduct that identified this Security Issue
+     * @example "product"
+     */
+    subproduct?: string;
+    /**
+     * The Target that this Security Issue affects
+     * @example "abcdef1234567890ghijkl"
+     */
+    targetId?: string;
+    /**
+     * The Name of the Target that this Security Issue affects
+     * @example "abcdef1234567890ghijkl"
+     */
+    targetName?: string;
+    /**
+     * The type of the Target that this Security Issue affects
+     * @example "repository"
+     */
+    targetType?: 'configuration' | 'container' | 'instance' | 'repository';
+    /**
+     * The Target Variant that this Security Issue affects
+     * @example "abcdef1234567890ghijkl"
+     */
+    targetVariantId?: string;
+    /**
+     * Name of the associated Target and Variant
+     * @example "nodegoat:master"
+     */
+    targetVariantName?: string;
+    /**
+     * Title of the Security Issue
+     * @example "json-schema@0.2.3 is vulnerable to Prototype Pollution"
+     */
+    title: string;
+    /**
+     * The type of vulnerability or quality issue for this Issue
+     * @example "SAST"
+     */
+    type?: 'BUG_SMELLS' | 'CODE_COVERAGE' | 'CODE_SMELLS' | 'DAST' | 'EXTERNAL_POLICY' | 'IAC' | 'MISCONFIG' | 'SAST' | 'SCA' | 'SECRET';
+}

package/dist/sto-core/src/services/schemas/IssueInScan.js

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

package/dist/sto-core/src/services/schemas/Pagination.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @example {"link":"","page":4,"pageSize":20,"totalItems":230,"totalPages":12}
+ */
+export interface Pagination {
+    /**
+     * Link-based paging
+     * @example ""
+     */
+    link?: string;
+    /**
+     * Page number (starting from 0)
+     * @format int64
+     * @example 4
+     */
+    page: number;
+    /**
+     * Requested page size
+     * @format int64
+     * @example 20
+     */
+    pageSize: number;
+    /**
+     * Total results available
+     * @format int64
+     * @example 230
+     */
+    totalItems: number;
+    /**
+     * Total pages available
+     * @format int64
+     * @example 12
+     */
+    totalPages: number;
+}

package/dist/sto-core/src/services/schemas/Pagination.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/sto-core/src/services/schemas/ScansScanIssueResponseBody.d.ts

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

package/dist/sto-core/src/services/schemas/ScansScanIssueResponseBody.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-sto-core-client",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Harness STO service APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",
@@ -27,8 +27,5 @@
     "build": "yarn generate && tsc",
     "generate": "oats import --config='./oats.config.ts'",
     "fmt": "prettier --write ./index.ts"
-  },
-  "engines": {
-    "node": "^16"
   }
 }

package/dist/sto-core/src/services/hooks/useReferenceIdentifiersGetByReferenceIdQuery.d.ts

@@ -1,27 +0,0 @@
-import { UseQueryOptions } from '@tanstack/react-query';
-import type { GetByReferenceIdResponseBody } from '../schemas/GetByReferenceIdResponseBody';
-import type { NotFound } from '../schemas/NotFound';
-import type { ResponseWithPagination } from '../helpers';
-import { FetcherOptions } from '../../../../fetcher/index.js';
-export interface ReferenceIdentifiersGetByReferenceIdQueryPathParams {
-    /**
-     * @example "CWE-123"
-     */
-    refId: string;
-}
-export interface ReferenceIdentifiersGetByReferenceIdQueryHeaderParams {
-    /**
-     * Harness personal or service access token
-     * @example "Atque quaerat aut."
-     */
-    'X-Api-Key'?: string;
-}
-export type ReferenceIdentifiersGetByReferenceIdOkResponse = ResponseWithPagination<GetByReferenceIdResponseBody>;
-export type ReferenceIdentifiersGetByReferenceIdErrorResponse = NotFound;
-export interface ReferenceIdentifiersGetByReferenceIdProps extends ReferenceIdentifiersGetByReferenceIdQueryPathParams, Omit<FetcherOptions<unknown, unknown, ReferenceIdentifiersGetByReferenceIdQueryHeaderParams>, 'url'> {
-}
-export declare function referenceIdentifiersGetByReferenceId(props: ReferenceIdentifiersGetByReferenceIdProps): Promise<ReferenceIdentifiersGetByReferenceIdOkResponse>;
-/**
- * Reference Identifiers Lookup
- */
-export declare function useReferenceIdentifiersGetByReferenceIdQuery(props: ReferenceIdentifiersGetByReferenceIdProps, options?: Omit<UseQueryOptions<ReferenceIdentifiersGetByReferenceIdOkResponse, ReferenceIdentifiersGetByReferenceIdErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ReferenceIdentifiersGetByReferenceIdOkResponse, NotFound>;

package/dist/sto-core/src/services/hooks/useReferenceIdentifiersGetByReferenceIdQuery.js

@@ -1,14 +0,0 @@
-/* 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 referenceIdentifiersGetByReferenceId(props) {
-    return fetcher(Object.assign({ url: `/api/v2/reference-identifiers/${props.refId}`, method: 'GET' }, props));
-}
-/**
- * Reference Identifiers Lookup
- */
-export function useReferenceIdentifiersGetByReferenceIdQuery(props, options) {
-    return useQuery(['Reference Identifiers#getByReferenceId', props.refId], ({ signal }) => referenceIdentifiersGetByReferenceId(Object.assign(Object.assign({}, props), { signal })), options);
-}

package/dist/sto-core/src/services/schemas/GetByReferenceIdResponseBody.d.ts

@@ -1,31 +0,0 @@
-/**
- * @example {"description":"Ut vitae doloremque.","extendedDescription":"Saepe atque est molestias.","remediationSteps":"Voluptas voluptatem reiciendis tenetur quia.","severity":8.5,"severityCode":"High"}
- */
-export interface GetByReferenceIdResponseBody {
-    /**
-     * A short description of the identified issue.
-     * @example "Corporis consectetur aut quas veritatis."
-     */
-    description?: string;
-    /**
-     * A more detailed explanation of the issue and its potential impact.
-     * @example "Totam voluptatem nihil earum."
-     */
-    extendedDescription?: string;
-    /**
-     * Steps the developer can take to address or mitigate the issue.
-     * @example "Quod itaque unde suscipit facere molestiae delectus."
-     */
-    remediationSteps?: string;
-    /**
-     * Numeric severity, from 0 (lowest) to 10 (highest)
-     * @format double
-     * @example 8.5
-     */
-    severity?: number;
-    /**
-     * Severity code
-     * @example "High"
-     */
-    severityCode?: string;
-}