@harnessio/react-ssca-manager-client 0.0.2 → 0.0.3

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

@@ -0,0 +1,23 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { SbomProcessResponseBodyResponse } from '../responses/SbomProcessResponseBodyResponse';
+import type { SbomProcessRequestBodyRequestBody } from '../requestBodies/SbomProcessRequestBodyRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ProcessSbomMutationPathParams {
+    org: string;
+    project: string;
+}
+export interface ProcessSbomMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type ProcessSbomRequestBody = SbomProcessRequestBodyRequestBody;
+export type ProcessSbomOkResponse = ResponseWithPagination<SbomProcessResponseBodyResponse>;
+export type ProcessSbomErrorResponse = unknown;
+export interface ProcessSbomProps extends ProcessSbomMutationPathParams, Omit<FetcherOptions<unknown, ProcessSbomRequestBody, ProcessSbomMutationHeaderParams>, 'url'> {
+    body: ProcessSbomRequestBody;
+}
+export declare function processSbom(props: ProcessSbomProps): Promise<ProcessSbomOkResponse>;
+/**
+ * process & inject sbom
+ */
+export declare function useProcessSbomMutation(options?: Omit<UseMutationOptions<ProcessSbomOkResponse, ProcessSbomErrorResponse, ProcessSbomProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<ProcessSbomOkResponse, unknown, ProcessSbomProps, unknown>;

package/dist/ssca-manager/src/services/hooks/useProcessSbomMutation.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 processSbom(props) {
+    return fetcher(Object.assign({ url: `/v1/org/${props.org}/project/${props.project}/sbom/process`, method: 'POST' }, props));
+}
+/**
+ * process & inject sbom
+ */
+export function useProcessSbomMutation(options) {
+    return useMutation((mutateProps) => processSbom(mutateProps), options);
+}

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

@@ -1 +1,11 @@
 export type { GetPathParamsType, ResponseWithPagination } from './helpers';
+export type { ProcessSbomErrorResponse, ProcessSbomMutationPathParams, ProcessSbomOkResponse, ProcessSbomProps, ProcessSbomRequestBody, } from './hooks/useProcessSbomMutation';
+export { processSbom, useProcessSbomMutation } from './hooks/useProcessSbomMutation';
+export type { SbomProcessRequestBodyRequestBody } from './requestBodies/SbomProcessRequestBodyRequestBody';
+export type { SbomProcessResponseBodyResponse } from './responses/SbomProcessResponseBodyResponse';
+export type { Artifact } from './schemas/Artifact';
+export type { Attestation } from './schemas/Attestation';
+export type { SbomMetadata } from './schemas/SbomMetadata';
+export type { SbomProcess } from './schemas/SbomProcess';
+export type { SbomProcessRequestBody } from './schemas/SbomProcessRequestBody';
+export type { SbomProcessResponseBody } from './schemas/SbomProcessResponseBody';

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

@@ -1 +1 @@
-export {};
+export { processSbom, useProcessSbomMutation } from './hooks/useProcessSbomMutation';

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,28 @@
+export interface Artifact {
+    /**
+     * id of the artifact
+     * @example "089855ea-f90e-4bea-a5c9-b5ddf85d3180"
+     */
+    id?: string;
+    /**
+     * name of the artifact
+     * @example "harness/image"
+     */
+    name: string;
+    /**
+     * url of the artifact
+     * @example "https://console.cloud.google.com/gcr/images/imageName"
+     */
+    registry_url: string;
+    /**
+     * tag of the artifact
+     * @default "latest"
+     * @example "latest"
+     */
+    tag?: string;
+    /**
+     * type of the artifact
+     * @example "repo/image"
+     */
+    type?: string;
+}

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

@@ -0,0 +1,11 @@
+export interface Attestation {
+    /**
+     * is the sbom attested or not
+     */
+    is_attested?: boolean;
+    /**
+     * url of the attested file
+     * @example "https://storage.googleapis.com/sbom_store_public/kmpySmUISimoRrJL6NL73w/default/SSCS_CI_Plugin_Demo/CKO_SSCA_Pipeline/Build/39/q940CvjoQj-GEInJQfWiwg/sbom"
+     */
+    url?: string;
+}

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

@@ -0,0 +1,47 @@
+export interface SbomMetadata {
+    /**
+     * BuildURL
+     * @example "https://app.harness.io/ng/#/account/acc/ci/orgs/org/projects/dummyProject/pipelines/CKO_SSCA_Pipeline/executions/q940CvjoQj-GEInJQfWiwg/pipeline?storeType=INLINE"
+     */
+    build_url?: string;
+    /**
+     * stage name where sbom is generated
+     * @example "spdx-json"
+     */
+    format?: string;
+    /**
+     * name of the package
+     * @example "z940CvjoQj-GEInJQfWiwq"
+     */
+    pipeline_execution_id?: string;
+    /**
+     * name of the package
+     * @example "SSCA_Pipeline"
+     */
+    pipeline_identifier?: string;
+    /**
+     * name of the package
+     * @example "1"
+     */
+    sequence_id?: string;
+    /**
+     * name of the Stage
+     * @example "Build"
+     */
+    stage_identifier?: string;
+    /**
+     * StepExecutionId
+     * @example "betatest1"
+     */
+    step_execution_id?: string;
+    /**
+     * id of the step
+     * @example "Orchestrate"
+     */
+    step_identifier?: string;
+    /**
+     * name of the package
+     * @example "synk"
+     */
+    tool?: string;
+}

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

@@ -0,0 +1,22 @@
+export interface SbomProcess {
+    /**
+     * serialised sbom data
+     * @format byte
+     */
+    data?: string;
+    /**
+     * format of the SBOM
+     * @example "spdx-json"
+     */
+    format: string;
+    /**
+     * name of the sbom
+     * @example "SBOM_Name"
+     */
+    name: string;
+    /**
+     * URL of the sbom
+     * @example "https://console.google.com/storage"
+     */
+    url?: string;
+}

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

@@ -0,0 +1,10 @@
+import type { Artifact } from '../schemas/Artifact';
+import type { Attestation } from '../schemas/Attestation';
+import type { SbomMetadata } from '../schemas/SbomMetadata';
+import type { SbomProcess } from '../schemas/SbomProcess';
+export interface SbomProcessRequestBody {
+    artifact?: Artifact;
+    attestation?: Attestation;
+    sbom_metadata?: SbomMetadata;
+    sbom_process?: SbomProcess;
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface SbomProcessResponseBody {
+    /**
+     * Id of created artifact
+     */
+    artifact_id?: string;
+}

package/dist/ssca-manager/src/services/schemas/SbomProcessResponseBody.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.0.2",
+  "version": "0.0.3",
   "description": "Harness SSCA manager APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",