@harnessio/react-sto-core-client 0.3.5 → 0.3.6

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

@@ -1,12 +1,12 @@
 import { UseQueryOptions } from '@tanstack/react-query';
-import type { Exemption } from '../schemas/Exemption';
+import type { ExemptionsFindExemptionByIdResponseBody } from '../schemas/ExemptionsFindExemptionByIdResponseBody';
 import type { NotFound } from '../schemas/NotFound';
 import type { ResponseWithPagination } from '../helpers';
 import { FetcherOptions } from '../../../../fetcher/index.js';
 export interface ExemptionsFindExemptionByIdQueryPathParams {
     /**
      * The ID of the Exemption to retrieve
-     * @example "abcdef1234567890ghijkl"
+     * @example "MipZ3daNhtT3wgLnyfDems"
      */
     id: string;
 }
@@ -43,7 +43,7 @@ export interface ExemptionsFindExemptionByIdQueryHeaderParams {
      */
     'X-Api-Key'?: string;
 }
-export type ExemptionsFindExemptionByIdOkResponse = ResponseWithPagination<Exemption>;
+export type ExemptionsFindExemptionByIdOkResponse = ResponseWithPagination<ExemptionsFindExemptionByIdResponseBody>;
 export type ExemptionsFindExemptionByIdErrorResponse = NotFound;
 export interface ExemptionsFindExemptionByIdProps extends ExemptionsFindExemptionByIdQueryPathParams, Omit<FetcherOptions<ExemptionsFindExemptionByIdQueryQueryParams, unknown, ExemptionsFindExemptionByIdQueryHeaderParams>, 'url'> {
     queryParams: ExemptionsFindExemptionByIdQueryQueryParams;

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

@@ -75,7 +75,9 @@ export type { CreateExemptionRequestBody } from './schemas/CreateExemptionReques
 export type { CreatePullRequestRequestBody } from './schemas/CreatePullRequestRequestBody';
 export type { Exemption } from './schemas/Exemption';
 export type { ExemptionImpactedTargetsResult } from './schemas/ExemptionImpactedTargetsResult';
+export type { ExemptionWithComment } from './schemas/ExemptionWithComment';
 export type { ExemptionsCreateExemptionResponseBody } from './schemas/ExemptionsCreateExemptionResponseBody';
+export type { ExemptionsFindExemptionByIdResponseBody } from './schemas/ExemptionsFindExemptionByIdResponseBody';
 export type { ExemptionsListExemptionsResponseBody } from './schemas/ExemptionsListExemptionsResponseBody';
 export type { FrontendAllIssuesDetailsResponseBody } from './schemas/FrontendAllIssuesDetailsResponseBody';
 export type { FrontendAllIssuesFiltersResponseBody } from './schemas/FrontendAllIssuesFiltersResponseBody';

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

@@ -1,5 +1,5 @@
 /**
- * @example {"approverId":"user111111111111111111"}
+ * @example {"approverId":"user111111111111111111","comment":"This is a comment for the approval or rejection of the exemption"}
  */
 export interface ApproveExemptionRequestBody {
     /**
@@ -7,4 +7,9 @@ export interface ApproveExemptionRequestBody {
      * @example "user111111111111111111"
      */
     approverId: string;
+    /**
+     * Comment to be added to the Exemption approval or rejection
+     * @example "This is a comment for the approval or rejection of the exemption"
+     */
+    comment?: string;
 }

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

@@ -0,0 +1,13 @@
+import type { Exemption } from '../schemas/Exemption';
+/**
+ * Exemption with comment
+ * @example {"comment":"This exemption was reviewed by the security team.","exemption":{"approverId":"user111111111111111111","canApproveFor":["ACCOUNT","ORG","PROJECT","PIPELINE"],"canCancel":true,"canCreate":true,"canReApprove":true,"canReject":true,"created":1651578240,"exemptionStatusAtScan":"Approved","expiration":1651578240,"id":"abcdef1234567890ghijkl","isDeleted":true,"issueId":"abcdef1234567890ghijkl","lastModified":1651578240,"link":"https://example.com/ABC-1234","numOccurrences":10,"occurrences":[42,666],"orgId":"your_project","pendingChanges":{"durationDays":7},"pipelineId":"your_pipeline","projectId":"your_project","reason":"Waiting on upstream bug fix","requesterId":"user111111111111111111","scanId":"abcdef1234567890ghijkl","scope":"PROJECT","search":"CWE-123,5","status":"Expired","targetId":"abcdef1234567890ghijkl","type":"Other"}}
+ */
+export interface ExemptionWithComment {
+    /**
+     * The additional comment to include with the exemption
+     * @example "This exemption was reviewed by the security team."
+     */
+    comment?: string;
+    exemption: Exemption;
+}

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

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

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

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

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

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

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

@@ -1,5 +1,5 @@
 /**
- * @example {"approverId":"user111111111111111111","pipelineId":"abcdef1234567890ghijkl","targetId":"abcdef1234567890ghijkl"}
+ * @example {"approverId":"user111111111111111111","comment":"This is a comment for the approval or rejection of the exemption","pipelineId":"abcdef1234567890ghijkl","targetId":"abcdef1234567890ghijkl"}
  */
 export interface PromoteExemptionRequestBody {
     /**
@@ -7,6 +7,11 @@ export interface PromoteExemptionRequestBody {
      * @example "user111111111111111111"
      */
     approverId: string;
+    /**
+     * Comment to be added to the Exemption approval or rejection
+     * @example "This is a comment for the approval or rejection of the exemption"
+     */
+    comment?: string;
     /**
      * Harness STO pipeline ID
      * @example "abcdef1234567890ghijkl"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-sto-core-client",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "Harness STO service APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",