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

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

@@ -0,0 +1,20 @@
+/**
+ * @example {"approverId":"user111111111111111111","pipelineId":"abcdef1234567890ghijkl","targetId":"abcdef1234567890ghijkl"}
+ */
+export interface PromoteExemptionRequestBody {
+    /**
+     * User ID the user who approved or rejected this exemptions
+     * @example "user111111111111111111"
+     */
+    approverId: string;
+    /**
+     * Harness STO pipeline ID
+     * @example "abcdef1234567890ghijkl"
+     */
+    pipelineId?: string;
+    /**
+     * Harness STO Target ID
+     * @example "abcdef1234567890ghijkl"
+     */
+    targetId?: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @example {"isCorrelated":true}
+ */
+export interface PullRequestCorrelationResult {
+    /**
+     * True if the path is correlated to the Pull Request
+     * @example true
+     */
+    isCorrelated: boolean;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * @example {"pullRequestNumber":7032269265141213000,"pullRequestUrl":"Voluptas iure sint repudiandae ullam est.","sourceBranch":"feat/shiny-object"}
+ */
+export interface PullRequestResult {
+    /**
+     * The number of the Pull Request
+     * @format int64
+     * @example 3126170514516337000
+     */
+    pullRequestNumber: number;
+    /**
+     * The  URL of the Pull Request
+     * @example "Sit adipisci nobis magnam et molestiae."
+     */
+    pullRequestUrl: string;
+    /**
+     * The source branch of the Pull Request
+     * @example "feat/shiny-object"
+     */
+    sourceBranch: string;
+}

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

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

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * @example {"id":"Consectetur modi exercitationem natus.","type":"Excepturi iure et aliquid amet."}
+ */
+export interface RefIds {
+    /**
+     * @example "Mollitia et ab inventore ipsam."
+     */
+    id?: string;
+    /**
+     * @example "Similique soluta quod quisquam."
+     */
+    type?: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * @example {"stageId":"stage_id","stepId":"step_id"}
+ */
+export interface StageStepId {
+    /**
+     * @example "stage_id"
+     */
+    stageId: string;
+    /**
+     * @example "step_id"
+     */
+    stepId: string;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * Information about a Scan Step
+ * @example {"baselineVariant":"branch: main","scanId":"scan111111111111111111","scanTool":"owasp","stageId":"stage_id","stepId":"step_id","subproduct":"product","targetId":"target1111111111111111","targetName":"The Target","targetType":"repository","targetVariant":"branch: feature"}
+ */
+export interface StepInfo {
+    /**
+     * A short description of the baseline target variant for the pipeline step's scan diff
+     * @example "branch: main"
+     */
+    baselineVariant?: string;
+    /**
+     * Scan id
+     * @example "scan111111111111111111"
+     */
+    scanId: string;
+    /**
+     * Product name of the scan tool used in this step
+     * @example "owasp"
+     */
+    scanTool: string;
+    /**
+     * @example "stage_id"
+     */
+    stageId: string;
+    /**
+     * @example "step_id"
+     */
+    stepId: string;
+    /**
+     * The subproduct that identified this Security Issue
+     * @example "product"
+     */
+    subproduct?: string;
+    /**
+     * The ID of the target of the pipeline step's scan
+     * @example "target1111111111111111"
+     */
+    targetId: string;
+    /**
+     * The name of the target of the pipeline step's scan
+     * @example "The Target"
+     */
+    targetName: string;
+    /**
+     * The type of the target of the pipeline step's scan
+     * @example "repository"
+     */
+    targetType: 'configuration' | 'container' | 'instance' | 'repository';
+    /**
+     * A short description of the target variant of the pipeline step's scan
+     * @example "branch: feature"
+     */
+    targetVariant: string;
+}

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

@@ -0,0 +1,48 @@
+import type { TestTargetVariant } from '../schemas/TestTargetVariant';
+/**
+ * Individual TestTarget
+ * @example {"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]}
+ */
+export interface TestTarget {
+    baseline?: TestTargetVariant;
+    /**
+     * RegEx to match for dynamically selecting the Baseline for this Scan Target. Must be compatible with the RE2 standard.
+     * @example "release_.*"
+     */
+    baselineRegEx?: string;
+    /**
+     * Directory of target
+     * @example "/"
+     */
+    directory?: string;
+    /**
+     * ID of target
+     * @example "target1111111111111111"
+     */
+    id: string;
+    /**
+     * Timestamp at which the Baseline was last scanned
+     * @format int64
+     * @example 1634836529
+     */
+    lastScanned: number;
+    /**
+     * Name of Target
+     * @example "target 1"
+     */
+    name: string;
+    /**
+     * Type of target
+     * @example "repository"
+     */
+    type: 'configuration' | 'container' | 'instance' | 'repository';
+    /**
+     * Url of target
+     * @example "github.com/harness/sto-core"
+     */
+    url?: string;
+    /**
+     * @example [{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]
+     */
+    variants: TestTargetVariant[];
+}

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

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

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

@@ -0,0 +1,14 @@
+import type { TestTarget } from '../schemas/TestTarget';
+import type { Pagination } from '../schemas/Pagination';
+/**
+ * Data needed by the Test Targets page
+ * @example {"targets":[{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]},{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]},{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]},{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]}],"targetsPagination":{"link":"","page":4,"pageSize":20,"totalItems":230,"totalPages":12}}
+ */
+export interface TestTargetResult {
+    /**
+     * Test Targets data
+     * @example [{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]},{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]},{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]},{"baseline":{"id":"variant111111111111111","name":"Branch: feature-1"},"baselineRegEx":"release_.*","directory":"/","id":"target1111111111111111","lastScanned":1634836529,"name":"target 1","type":"repository","url":"github.com/harness/sto-core","variants":[{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"},{"id":"variant111111111111111","name":"Branch: feature-1"}]}]
+     */
+    targets: TestTarget[];
+    targetsPagination: Pagination;
+}

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Individual Test Target Variant
+ * @example {"id":"variant111111111111111","name":"Branch: feature-1"}
+ */
+export interface TestTargetVariant {
+    /**
+     * Target Variant ID
+     * @example "variant111111111111111"
+     */
+    id: string;
+    /**
+     * Name of Target Variant
+     * @example "Branch: feature-1"
+     */
+    name: string;
+}

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

@@ -0,0 +1,43 @@
+import type { PendingChanges } from '../schemas/PendingChanges';
+/**
+ * @example {"expiration":1651578240,"link":"https://example.com/ABC-1234","pendingChanges":{"durationDays":7},"pipelineId":"your_pipeline","reason":"Waiting on upstream bug fix","requesterId":"user111111111111111111","targetId":"abcdef1234567890ghijkl","type":"Other"}
+ */
+export interface UpdateExemptionRequestBody {
+    /**
+     * Unix timestamp at which this Exemption will expire
+     * @format int64
+     * @example 1651578240
+     */
+    expiration?: number;
+    /**
+     * Link to a related ticket
+     * @example "https://example.com/ABC-1234"
+     */
+    link?: string;
+    pendingChanges: PendingChanges;
+    /**
+     * ID of the Harness Pipeline to which the exemption applies. You must also specify "projectId" and "orgId". Cannot be specified alongside "targetId".
+     * @example "your_pipeline"
+     */
+    pipelineId?: string;
+    /**
+     * Text describing why this Exemption is necessary
+     * @example "Waiting on upstream bug fix"
+     */
+    reason: string;
+    /**
+     * User ID of user who requested this exemptions
+     * @example "user111111111111111111"
+     */
+    requesterId: string;
+    /**
+     * ID of the Target to which the exemption applies. Cannot be specified alongside "projectId" or "pipelineId".
+     * @example "abcdef1234567890ghijkl"
+     */
+    targetId?: string;
+    /**
+     * Type of Exemption (Compensating Controls / Acceptable Use / Acceptable Risk / False Positive / Fix Unavailable / Other)
+     * @example "Other"
+     */
+    type: 'Acceptable Risk' | 'Acceptable Use' | 'Compensating Controls' | 'False Positive' | 'Fix Unavailable' | 'Other';
+}

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

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

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

@@ -0,0 +1,55 @@
+/**
+ * @example {"id":"1234567890abcdefghijkl","occurrenceId":12345,"pipelineUrl":"https://app.harness.io/path/to/pipeline","pullRequestNumber":11,"remediationCode":"func example() int {\n  return 0\n}","remediationCodeEnd":16,"remediationCodePath":"path/to/code","remediationCodeStart":14,"remediationContext":"Context to the function.","remediationIndent":9,"vulnerableCode":"func example() int {\n  return 0\n}"}
+ */
+export interface UpdatePullRequestRequestBody {
+    /**
+     * The ID of the Security Issue to create a Pull Request for
+     * @example "1234567890abcdefghijkl"
+     */
+    id: string;
+    /**
+     * @format int64
+     * @example 12345
+     */
+    occurrenceId: number;
+    /**
+     * @example "https://app.harness.io/path/to/pipeline"
+     */
+    pipelineUrl: string;
+    /**
+     * @format int64
+     * @example 11
+     */
+    pullRequestNumber: number;
+    /**
+     * @example "func example() int {\n  return 0\n}"
+     */
+    remediationCode: string;
+    /**
+     * @format int64
+     * @example 16
+     */
+    remediationCodeEnd: number;
+    /**
+     * @example "path/to/code"
+     */
+    remediationCodePath: string;
+    /**
+     * @format int64
+     * @example 14
+     */
+    remediationCodeStart: number;
+    /**
+     * @example "Context to the function."
+     */
+    remediationContext: string;
+    /**
+     * @format int64
+     * @example 9
+     */
+    remediationIndent?: number;
+    /**
+     * @example "func example() int {\n  return 0\n}"
+     */
+    vulnerableCode: string;
+}

package/dist/sto-core/src/services/schemas/UpdatePullRequestRequestBody.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-sto-core-client",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Harness STO service APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",