@typecad/cuttlefish 1.0.0-alpha.7 → 1.0.0-alpha.9

package/dist/licenses.d.ts

@@ -1,185 +0,0 @@
-export type CopyleftRisk = "permissive" | "weak-copyleft" | "strong-copyleft" | "unknown";
-export type LicenseSource = "library.properties" | "license-file" | "source-header" | "none";
-export interface LibraryLicenseEntry {
-    name: string;
-    version: string | undefined;
-    /** install_dir as reported by arduino-cli lib list. */
-    path: string;
-    /** Normalized SPDX ID (e.g. "BSD-3-Clause"); undefined if not determined. */
-    spdx: string | undefined;
-    risk: CopyleftRisk;
-    source: LicenseSource;
-}
-export type ScanOutcome = {
-    ok: true;
-    libraries: LibraryLicenseEntry[];
-} | {
-    ok: false;
-    reason: "arduino-cli-not-found" | "arduino-cli-unresponsive" | "no-libraries";
-    message: string;
-};
-/**
- * Headers the project needs. `source` is "ino" when read from the generated
- * .ino (authoritative) or "config" when derived from cuttlefish.config.ts
- * (partial: display/touch only).
- */
-export type ProjectHeaders = {
-    ok: true;
-    headers: string[];
-    source: "ino" | "config";
-    inoPath?: string;
-} | {
-    ok: false;
-    reason: "no-config" | "no-entry" | "unreadable-ino";
-    message: string;
-};
-/**
- * Minimal view of ResolvedCuttlefishConfig that resolveProjectHeaders needs.
- * Kept structural so we don't import the full config type (avoids a cycle).
- */
-interface ProjectConfig {
-    configPath: string;
-    entry?: string;
-    outputOutDir?: string;
-    /** FQBN, e.g. 'arduino:avr:uno'. Used to resolve the board core for core-bundled libs. */
-    buildTarget?: string;
-    display?: {
-        profile?: string;
-        driver?: string;
-        touch?: {
-            library?: string;
-        };
-    } | null;
-}
-/** Classify a header as a compiler-toolchain C-library header. */
-export declare function isToolchainHeader(header: string): boolean;
-/**
- * Result of resolving the project's board core directory.
- */
-export type ProjectCore = {
-    ok: true;
-    coreDir: string;
-} | {
-    ok: false;
-    reason: "no-fqbn" | "no-core";
-    message: string;
-};
-/**
- * Resolve the project's board-core directory from its FQBN, via
- * `arduino-cli config dump` (for the packages data dir) and the on-disk
- * `<data>/packages/<packager>/hardware/<arch>/<version>/` layout. Returns the
- * highest-versioned core dir. Never throws.
- *
- * `runConfigDump` is an injected seam (returns the `config dump` stdout, or ""
- * on failure) so the function is unit-testable without spawning.
- */
-export declare function resolveProjectCore(fqbn: string | undefined, runConfigDump: () => string, readdir: (d: string) => string[]): ProjectCore;
-/**
- * Resolve the project's library headers. Prefers the generated .ino
- * (authoritative); falls back to display/touch headers derived from config
- * (partial picture, no transpile required).
- */
-export declare function resolveProjectHeaders(config: ProjectConfig | undefined, readFile: (p: string) => string | undefined): ProjectHeaders;
-/**
- * One project header, joined to its owning library or flagged not-installed.
- */
-export type ProjectLibrary = {
-    kind: "resolved";
-    lib: LibraryLicenseEntry;
-} | {
-    kind: "core";
-    header: string;
-} | {
-    kind: "not-installed";
-    header: string;
-};
-/**
- * Build a header-basename -> bundled-library map from a board core's bundled
- * libraries. Scans `<coreDir>/libraries/<Lib>/src/` for .h files (e.g. Wire.h,
- * SPI.h). Each header maps to a synthetic RawArduinoLibrary so the existing
- * resolveLibraryLicense can read its license from the bundled lib's header
- * notice or library.properties.
- */
-export declare function buildCoreHeaderIndex(coreDir: string, readdir: (d: string) => string[]): Map<string, RawArduinoLibrary>;
-/**
- * Join each project header to its owning library or classify it. Pipeline:
- *   1. user library (arduino-cli lib list)  -> resolved (license)
- *   2. core library (project's own core)    -> resolved (license, e.g. LGPL-2.1)
- *   3. toolchain header (avr/*, util/*)     -> core (gray, no license)
- *   4. else                                  -> not-installed
- *
- * `coreDir` is optional; when absent, step 2 is skipped.
- */
-export declare function joinHeadersToLibraries(headers: string[], libs: RawArduinoLibrary[], readdir: (d: string) => string[], readFile: (p: string) => string | undefined, coreDir?: string): ProjectLibrary[];
-/**
- * Resolve a raw license input (either the short `library.properties` `license=`
- * value, the full text of a LICENSE file, or a source-file header comment) to a
- * canonical SPDX ID.
- *
- * Matching priority:
- *   1. SPDX-License-Identifier: <id> marker (authoritative when present)
- *   2. exact alias match (suits the short properties value)
- *   3. substring markers match, ALL markers required (suits full LICENSE text)
- *   4. shortMarkers match, ANY one sufficient (suits sparse header comments
- *      like Adafruit's "BSD license, all text here must be included")
- *
- * Returns the SPDX ID string, or undefined if nothing matched.
- */
-export declare function identifySpdx(input: string): string | undefined;
-/**
- * Classify the copyleft risk of a known SPDX ID. Returns "unknown" for
- * unrecognized ids.
- */
-export declare function classifyRisk(spdx: string): CopyleftRisk;
-/** Raw library entry as it appears in `arduino-cli lib list --format json`. */
-export interface RawArduinoLibrary {
-    name: string;
-    version?: string;
-    install_dir?: string;
-}
-/**
- * Options for `scanLicenses`. Production calls omit this object entirely; tests
- * inject `fakeLibList` and `fakeReadFile` to avoid spawning and disk I/O.
- */
-export interface ScanOptions {
-    /** Override the `arduino-cli lib list` call. Return null to simulate spawn failure. */
-    fakeLibList?: () => RawArduinoLibrary[] | null;
-    /** Override disk reads of library.properties and LICENSE files. */
-    fakeReadFile?: (p: string) => string | undefined;
-    /** Override directory listings. */
-    fakeReaddir?: (d: string) => string[];
-}
-/**
- * Normalize either JSON shape (wrapped or bare array) to a flat library list.
- * Exported for direct unit testing of the dual-shape parsing.
- */
-export declare function coerceLibList(parsed: unknown): RawArduinoLibrary[];
-/**
- * Module-level runner override used by presenter tests so `scanLicenses()`
- * (with no args) does not spawn. Mirrors __setArduinoCliRunnerForTest.
- */
-export interface LicensesRunner {
-    listLibraries: () => RawArduinoLibrary[] | null;
-    readFile: (p: string) => string | undefined;
-    readdir: (d: string) => string[];
-}
-/** @internal Test-only override of the default runner. */
-export declare function __setLicensesRunnerForTest(runner: LicensesRunner | undefined): void;
-/**
- * Scan installed Arduino libraries and resolve each one's license. Never throws.
- */
-export declare function scanLicenses(options?: ScanOptions): ScanOutcome;
-/** @internal Test-only override of the project config (normally loaded via loadCuttlefishConfig). */
-export declare function __setProjectConfigForTest(config: ProjectConfig | undefined): void;
-/** @internal Test-only override of `arduino-cli config dump` stdout. */
-export declare function __setConfigDumpForTest(fn: (() => string) | undefined): void;
-/**
- * `cuttlefish licenses` presenter. `all === false` (default, project scope)
- * resolves this project's libraries from the generated .ino (or config
- * fallback), joins each to an installed library, and reports only those.
- * `all === true` reports every installed library (the original behavior).
- * Warns on unknown licenses; flags NOT INSTALLED headers in project scope; sets
- * process.exitCode under --strict. Never calls process.exit().
- */
-export declare function runLicensesPresenter(strict: boolean, all: boolean): void;
-export {};