@scanoss_test/sdk 2.0.1

package/dist/index.d.ts

@@ -0,0 +1,444 @@
+import { Message } from '@bufbuild/protobuf';
+
+/**
+ * Information about a file
+ *
+ * @generated from message scanoss.v1.FileInfo
+ */
+type FileInfo$1 = 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;
+};
+/**
+ * A match found during scanning
+ *
+ * @generated from message scanoss.v1.Match
+ */
+type Match$1 = 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;
+};
+/**
+ * Result for a single file scan
+ *
+ * @generated from message scanoss.v1.FileResult
+ */
+type FileResult$1 = 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$1[];
+};
+
+/**
+ * Output format for scan results and SBOM generation
+ *
+ * @generated from enum scanoss.v1.OutputFormat
+ */
+declare enum OutputFormat$1 {
+    /**
+     * @generated from enum value: OUTPUT_FORMAT_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: OUTPUT_FORMAT_JSON = 1;
+     */
+    JSON = 1,
+    /**
+     * @generated from enum value: OUTPUT_FORMAT_SPDX = 2;
+     */
+    SPDX = 2,
+    /**
+     * @generated from enum value: OUTPUT_FORMAT_CYCLONEDX = 3;
+     */
+    CYCLONEDX = 3,
+    /**
+     * @generated from enum value: OUTPUT_FORMAT_CSV = 4;
+     */
+    CSV = 4,
+    /**
+     * @generated from enum value: OUTPUT_FORMAT_WFP = 5;
+     */
+    WFP = 5
+}
+
+/**
+ * Scan result
+ *
+ * @generated from message scanoss.v1.ScanResult
+ */
+type ScanResult$1 = Message<"scanoss.v1.ScanResult"> & {
+    /**
+     * @generated from field: repeated scanoss.v1.FileResult files = 1;
+     */
+    files: FileResult$1[];
+    /**
+     * @generated from field: int32 total_files = 2;
+     */
+    totalFiles: number;
+    /**
+     * @generated from field: int32 files_with_matches = 3;
+     */
+    filesWithMatches: number;
+    /**
+     * @generated from field: int32 total_matches = 4;
+     */
+    totalMatches: number;
+};
+/**
+ * Filter files result
+ *
+ * @generated from message scanoss.v1.FilterFilesResult
+ */
+type FilterFilesResult$1 = Message<"scanoss.v1.FilterFilesResult"> & {
+    /**
+     * @generated from field: repeated scanoss.v1.FileInfo files = 1;
+     */
+    files: FileInfo$1[];
+    /**
+     * @generated from field: int32 total_count = 2;
+     */
+    totalCount: number;
+    /**
+     * @generated from field: int64 total_bytes = 3;
+     */
+    totalBytes: bigint;
+};
+/**
+ * Fingerprint result
+ *
+ * @generated from message scanoss.v1.FingerprintResult
+ */
+type FingerprintResult$1 = Message<"scanoss.v1.FingerprintResult"> & {
+    /**
+     * WFP content (if no output_path)
+     *
+     * @generated from field: string wfp = 1;
+     */
+    wfp: string;
+    /**
+     * Path where WFP was saved
+     *
+     * @generated from field: string output_path = 2;
+     */
+    outputPath: string;
+    /**
+     * @generated from field: int32 file_count = 3;
+     */
+    fileCount: number;
+    /**
+     * @generated from field: int64 total_bytes = 4;
+     */
+    totalBytes: bigint;
+};
+/**
+ * Generate SBOM result
+ *
+ * @generated from message scanoss.v1.GenerateSbomResult
+ */
+type GenerateSbomResult$1 = Message<"scanoss.v1.GenerateSbomResult"> & {
+    /**
+     * SBOM content (if no output_path)
+     *
+     * @generated from field: string sbom = 1;
+     */
+    sbom: string;
+    /**
+     * Path where SBOM was saved
+     *
+     * @generated from field: string output_path = 2;
+     */
+    outputPath: string;
+    /**
+     * @generated from field: scanoss.v1.OutputFormat format = 3;
+     */
+    format: OutputFormat$1;
+    /**
+     * @generated from field: int32 component_count = 4;
+     */
+    componentCount: number;
+};
+/**
+ * Version result
+ *
+ * @generated from message scanoss.v1.VersionResult
+ */
+type VersionResult$1 = Message<"scanoss.v1.VersionResult"> & {
+    /**
+     * @generated from field: string version = 1;
+     */
+    version: string;
+    /**
+     * @generated from field: string commit = 2;
+     */
+    commit: string;
+    /**
+     * @generated from field: string build_date = 3;
+     */
+    buildDate: string;
+    /**
+     * @generated from field: string go_version = 4;
+     */
+    goVersion: string;
+};
+
+/**
+ * Type definitions for SCANOSS SDK
+ */
+/** Output format for scan results */
+type OutputFormat = 'json' | 'spdx' | 'cyclonedx' | 'csv' | 'wfp';
+/** Type of scan to perform */
+type ScanType = 'identify' | 'blacklist';
+/** File information */
+interface FileInfo {
+    path: string;
+    size: number;
+    extension: string;
+}
+/** Match information for a component */
+interface Match {
+    component: string;
+    version: string;
+    license: string;
+    purl: string;
+    score: number;
+}
+/** Result for a single file */
+interface FileResult {
+    path: string;
+    matches: Match[];
+}
+/** Scan command parameters */
+interface ScanParams {
+    path: string;
+    format?: OutputFormat;
+    scanType?: ScanType;
+    include?: string[];
+    exclude?: string[];
+    apiUrl?: string;
+    apiKey?: string;
+}
+/** Scan result */
+interface ScanResult {
+    files: FileResult[];
+    totalFiles: number;
+    filesWithMatches: number;
+    totalMatches: number;
+}
+/** Filter files command parameters */
+interface FilterFilesParams {
+    path: string;
+    include?: string[];
+    exclude?: string[];
+    skipHidden?: boolean;
+}
+/** Filter files result */
+interface FilterFilesResult {
+    files: FileInfo[];
+    totalCount: number;
+    totalBytes: number;
+}
+/** Fingerprint command parameters */
+interface FingerprintParams {
+    path: string;
+    include?: string[];
+    exclude?: string[];
+}
+/** Fingerprint result */
+interface FingerprintResult {
+    wfp: string;
+    fileCount: number;
+}
+/** Generate SBOM command parameters */
+interface GenerateSbomParams {
+    path: string;
+    format?: 'spdx' | 'cyclonedx';
+}
+/** Generate SBOM result */
+interface GenerateSbomResult {
+    sbom: string;
+    format: string;
+    componentCount: number;
+}
+/** Version information */
+interface VersionResult {
+    version: string;
+    commit: string;
+    buildDate: string;
+}
+
+/**
+ * SCANOSS SDK client using protobuf binary protocol
+ */
+
+/** Options for creating a Scanoss instance */
+interface ScanossOptions {
+    /** Path to the scanoss binary. If not provided, will be auto-detected. */
+    binaryPath?: string;
+}
+/**
+ * SCANOSS SDK client.
+ *
+ * This client communicates with the SCANOSS daemon process via stdin/stdout
+ * using length-prefixed protobuf binary protocol.
+ *
+ * Wire format:
+ * ```
+ * ┌──────────────────┬─────────────────────────┐
+ * │  4 bytes (BE)    │  N bytes                │
+ * │  message length  │  protobuf binary data   │
+ * └──────────────────┴─────────────────────────┘
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const scanoss = new Scanoss();
+ * const result = await scanoss.scan({ path: '/path/to/project' });
+ * console.log(result);
+ * await scanoss.close();
+ * ```
+ */
+declare class Scanoss {
+    private process;
+    private requestId;
+    private pending;
+    private binaryPath;
+    private closed;
+    private buffer;
+    private expectedLength;
+    constructor(options?: ScanossOptions);
+    private start;
+    private processBuffer;
+    private rejectAllPending;
+    private send;
+    /**
+     * Scan files for open source matches.
+     */
+    scan(params: ScanParams): Promise<ScanResult$1>;
+    /**
+     * Filter files in a directory.
+     */
+    filterFiles(params: FilterFilesParams): Promise<FilterFilesResult$1>;
+    /**
+     * Generate WFP fingerprints for files.
+     */
+    fingerprint(params: FingerprintParams): Promise<FingerprintResult$1>;
+    /**
+     * Generate SBOM from scan results.
+     */
+    generateSbom(params: GenerateSbomParams): Promise<GenerateSbomResult$1>;
+    /**
+     * Get version information.
+     */
+    version(): Promise<VersionResult$1>;
+    /**
+     * Close the daemon process.
+     */
+    close(): Promise<void>;
+}
+
+/**
+ * Error types for SCANOSS SDK
+ */
+/**
+ * Error thrown by SCANOSS operations
+ */
+declare class ScanossError extends Error {
+    /** Error code from the daemon */
+    readonly code: number;
+    constructor(code: number, message: string);
+}
+
+/**
+ * Binary resolution for SCANOSS daemon.
+ *
+ * The binary is provided by platform-specific packages (@scanoss_test/linux-x64, etc.).
+ * npm will automatically install the correct one based on the user's OS and CPU.
+ */
+/**
+ * Get the path to the SCANOSS binary.
+ *
+ * @returns Path to the scanoss binary
+ * @throws Error if no binary package is installed
+ */
+declare function getBinaryPath(): string;
+
+export { type FileInfo, type FileResult, type FilterFilesParams, type FilterFilesResult, type FingerprintParams, type FingerprintResult, type GenerateSbomParams, type GenerateSbomResult, type Match, type OutputFormat, type ScanParams, type ScanResult, type ScanType, Scanoss, ScanossError, type ScanossOptions, type VersionResult, getBinaryPath };