@scanoss_test/sdk 2.0.1

package/src/gen/scanoss/v1/types_pb.ts

@@ -0,0 +1,191 @@
+// @generated by protoc-gen-es v2.10.2 with parameter "target=ts"
+// @generated from file scanoss/v1/types.proto (package scanoss.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file scanoss/v1/types.proto.
+ */
+export const file_scanoss_v1_types: GenFile = /*@__PURE__*/
+  fileDesc("ChZzY2Fub3NzL3YxL3R5cGVzLnByb3RvEgpzY2Fub3NzLnYxIkYKCEZpbGVJbmZvEgwKBHBhdGgYASABKAkSDAoEc2l6ZRgCIAEoAxIRCglleHRlbnNpb24YAyABKAkSCwoDbWQ1GAQgASgJItsBCgVNYXRjaBIKCgJpZBgBIAEoCRIRCgljb21wb25lbnQYAiABKAkSDgoGdmVuZG9yGAMgASgJEg8KB3ZlcnNpb24YBCABKAkSFgoObGF0ZXN0X3ZlcnNpb24YBSABKAkSDwoHbGljZW5zZRgGIAEoCRIMCgRwdXJsGAcgASgJEgsKA3VybBgIIAEoCRIMCgRmaWxlGAkgASgJEg8KB21hdGNoZWQYCiABKAkSDQoFbGluZXMYCyABKAkSEQoJb3NzX2xpbmVzGAwgASgJEg0KBXNjb3JlGA0gASgCIksKCkZpbGVSZXN1bHQSDAoEcGF0aBgBIAEoCRILCgNtZDUYAiABKAkSIgoHbWF0Y2hlcxgDIAMoCzIRLnNjYW5vc3MudjEuTWF0Y2giNwoFRXJyb3ISDAoEY29kZRgBIAEoBRIPCgdtZXNzYWdlGAIgASgJEg8KB2RldGFpbHMYAyABKAlCTQoPY29tLnNjYW5vc3MuZ2VuUAFaOGdpdGh1Yi5jb20vc2Nhbm9zcy9zY2Fub3NzL2NvcmUvZ2VuL3NjYW5vc3MvdjE7c2Nhbm9zc3YxYgZwcm90bzM");
+
+/**
+ * Information about a file
+ *
+ * @generated from message scanoss.v1.FileInfo
+ */
+export type FileInfo = Message<"scanoss.v1.FileInfo"> & {
+  /**
+   * @generated from field: string path = 1;
+   */
+  path: string;
+
+  /**
+   * @generated from field: int64 size = 2;
+   */
+  size: bigint;
+
+  /**
+   * @generated from field: string extension = 3;
+   */
+  extension: string;
+
+  /**
+   * @generated from field: string md5 = 4;
+   */
+  md5: string;
+};
+
+/**
+ * Describes the message scanoss.v1.FileInfo.
+ * Use `create(FileInfoSchema)` to create a new message.
+ */
+export const FileInfoSchema: GenMessage<FileInfo> = /*@__PURE__*/
+  messageDesc(file_scanoss_v1_types, 0);
+
+/**
+ * A match found during scanning
+ *
+ * @generated from message scanoss.v1.Match
+ */
+export type Match = Message<"scanoss.v1.Match"> & {
+  /**
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * @generated from field: string component = 2;
+   */
+  component: string;
+
+  /**
+   * @generated from field: string vendor = 3;
+   */
+  vendor: string;
+
+  /**
+   * @generated from field: string version = 4;
+   */
+  version: string;
+
+  /**
+   * @generated from field: string latest_version = 5;
+   */
+  latestVersion: string;
+
+  /**
+   * @generated from field: string license = 6;
+   */
+  license: string;
+
+  /**
+   * @generated from field: string purl = 7;
+   */
+  purl: string;
+
+  /**
+   * @generated from field: string url = 8;
+   */
+  url: string;
+
+  /**
+   * @generated from field: string file = 9;
+   */
+  file: string;
+
+  /**
+   * Match percentage (e.g., "100%")
+   *
+   * @generated from field: string matched = 10;
+   */
+  matched: string;
+
+  /**
+   * Lines in scanned file (e.g., "1-50")
+   *
+   * @generated from field: string lines = 11;
+   */
+  lines: string;
+
+  /**
+   * Lines in matched OSS (e.g., "1-50")
+   *
+   * @generated from field: string oss_lines = 12;
+   */
+  ossLines: string;
+
+  /**
+   * @generated from field: float score = 13;
+   */
+  score: number;
+};
+
+/**
+ * Describes the message scanoss.v1.Match.
+ * Use `create(MatchSchema)` to create a new message.
+ */
+export const MatchSchema: GenMessage<Match> = /*@__PURE__*/
+  messageDesc(file_scanoss_v1_types, 1);
+
+/**
+ * Result for a single file scan
+ *
+ * @generated from message scanoss.v1.FileResult
+ */
+export type FileResult = Message<"scanoss.v1.FileResult"> & {
+  /**
+   * @generated from field: string path = 1;
+   */
+  path: string;
+
+  /**
+   * @generated from field: string md5 = 2;
+   */
+  md5: string;
+
+  /**
+   * @generated from field: repeated scanoss.v1.Match matches = 3;
+   */
+  matches: Match[];
+};
+
+/**
+ * Describes the message scanoss.v1.FileResult.
+ * Use `create(FileResultSchema)` to create a new message.
+ */
+export const FileResultSchema: GenMessage<FileResult> = /*@__PURE__*/
+  messageDesc(file_scanoss_v1_types, 2);
+
+/**
+ * Error information
+ *
+ * @generated from message scanoss.v1.Error
+ */
+export type Error = Message<"scanoss.v1.Error"> & {
+  /**
+   * @generated from field: int32 code = 1;
+   */
+  code: number;
+
+  /**
+   * @generated from field: string message = 2;
+   */
+  message: string;
+
+  /**
+   * @generated from field: string details = 3;
+   */
+  details: string;
+};
+
+/**
+ * Describes the message scanoss.v1.Error.
+ * Use `create(ErrorSchema)` to create a new message.
+ */
+export const ErrorSchema: GenMessage<Error> = /*@__PURE__*/
+  messageDesc(file_scanoss_v1_types, 3);
+

package/src/index.ts

@@ -0,0 +1,9 @@
+/**
+ * SCANOSS SDK for Software Composition Analysis
+ * @packageDocumentation
+ */
+
+export { Scanoss, ScanossOptions } from './client';
+export { ScanossError } from './errors';
+export { getBinaryPath } from './binary';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,98 @@
+/**
+ * Type definitions for SCANOSS SDK
+ */
+
+/** Output format for scan results */
+export type OutputFormat = 'json' | 'spdx' | 'cyclonedx' | 'csv' | 'wfp';
+
+/** Type of scan to perform */
+export type ScanType = 'identify' | 'blacklist';
+
+/** File information */
+export interface FileInfo {
+  path: string;
+  size: number;
+  extension: string;
+}
+
+/** Match information for a component */
+export interface Match {
+  component: string;
+  version: string;
+  license: string;
+  purl: string;
+  score: number;
+}
+
+/** Result for a single file */
+export interface FileResult {
+  path: string;
+  matches: Match[];
+}
+
+/** Scan command parameters */
+export interface ScanParams {
+  path: string;
+  format?: OutputFormat;
+  scanType?: ScanType;
+  include?: string[];
+  exclude?: string[];
+  apiUrl?: string;
+  apiKey?: string;
+}
+
+/** Scan result */
+export interface ScanResult {
+  files: FileResult[];
+  totalFiles: number;
+  filesWithMatches: number;
+  totalMatches: number;
+}
+
+/** Filter files command parameters */
+export interface FilterFilesParams {
+  path: string;
+  include?: string[];
+  exclude?: string[];
+  skipHidden?: boolean;
+}
+
+/** Filter files result */
+export interface FilterFilesResult {
+  files: FileInfo[];
+  totalCount: number;
+  totalBytes: number;
+}
+
+/** Fingerprint command parameters */
+export interface FingerprintParams {
+  path: string;
+  include?: string[];
+  exclude?: string[];
+}
+
+/** Fingerprint result */
+export interface FingerprintResult {
+  wfp: string;
+  fileCount: number;
+}
+
+/** Generate SBOM command parameters */
+export interface GenerateSbomParams {
+  path: string;
+  format?: 'spdx' | 'cyclonedx';
+}
+
+/** Generate SBOM result */
+export interface GenerateSbomResult {
+  sbom: string;
+  format: string;
+  componentCount: number;
+}
+
+/** Version information */
+export interface VersionResult {
+  version: string;
+  commit: string;
+  buildDate: string;
+}