@specatlas/core 0.1.22 → 0.1.25

package/dist/index.d.ts

@@ -203,6 +203,7 @@ interface Change {
     tasks?: TasksFile;
     verify?: VerifyFile;
     fix?: VerifyFile;
+    fixCovers?: string[];
     planPath?: string;
     reviewPath?: string;
     presentationPath?: string;
@@ -1139,6 +1140,12 @@ declare function indexMarkdown(input: {
         slug: string;
         lane: Lane;
     }>;
+    fixes?: Array<{
+        slug: string;
+        date: string;
+        result: string;
+        domain?: string;
+    }>;
     archived: number;
 }): string;
 
@@ -1701,6 +1708,7 @@ interface ArchiveResult {
     slug: string;
     domain?: string;
     archivedTo?: string;
+    livingFix?: string;
     fold: FoldOutcome;
     diagnostics: Diagnostic[];
     dryRun: boolean;
@@ -1708,6 +1716,178 @@ interface ArchiveResult {
 declare function archiveChange(opts: ArchiveOptions): Promise<ArchiveResult>;
 declare function regenerateIndex(root: string, cfg?: AtlasConfig, now?: Date): Promise<void>;
 
+declare const SCHEMA_VERSION = 1;
+declare const BACKUP_DIRNAME = ".backup";
+declare const BACKUP_POINTER = ".latest";
+interface MigrationSpec {
+    id: string;
+    description: string;
+    from: number;
+    to: number;
+}
+declare const SCHEMA_MIGRATIONS: MigrationSpec[];
+interface UpgradeItem {
+    artifact: string;
+    path: string;
+    from: number;
+    to: number;
+    migration: string;
+    summary: string;
+}
+interface UpgradeIssue {
+    artifact: string;
+    path: string;
+    reason: string;
+}
+interface UpgradePlan {
+    root: string;
+    currentVersion: number;
+    pending: UpgradeItem[];
+    newer: UpgradeIssue[];
+    unreadable: UpgradeIssue[];
+    upToDate: boolean;
+}
+interface FoundArtifact {
+    artifact: string;
+    path: string;
+}
+declare function collectVersionedArtifacts(root: string): Promise<FoundArtifact[]>;
+type ArtifactVersionState = {
+    state: 'ok';
+    version: number;
+} | {
+    state: 'absent';
+} | {
+    state: 'unreadable';
+    reason: string;
+};
+declare function readArtifactVersion(content: string): ArtifactVersionState;
+declare function stampSchemaVersion(content: string, version: number): string | undefined;
+declare function planUpgrade(root: string): Promise<UpgradePlan>;
+interface UpgradeBackupInfo {
+    name: string;
+    dir: string;
+    relativeDir: string;
+    createdAt: string;
+    files: string[];
+}
+interface UpgradeApplyReport {
+    status: 'applied' | 'up-to-date' | 'failed';
+    plan: UpgradePlan;
+    applied: UpgradeItem[];
+    backup?: UpgradeBackupInfo;
+    failure?: {
+        artifact: string;
+        message: string;
+    };
+}
+declare function applyUpgrade(root: string, now?: Date): Promise<UpgradeApplyReport>;
+interface UpgradeRollbackReport {
+    status: 'restored' | 'no-backup' | 'failed';
+    restored: string[];
+    backup?: string;
+    failure?: {
+        artifact: string;
+        message: string;
+    };
+}
+declare function rollbackUpgrade(root: string): Promise<UpgradeRollbackReport>;
+interface UpgradeAdvisory {
+    plan: UpgradePlan;
+    diagnostics: Diagnostic[];
+}
+declare function upgradeAdvisory(root: string): Promise<UpgradeAdvisory>;
+
+declare const LIVING_FIXES_DIR: string;
+interface LivingFix {
+    slug: string;
+    file: string;
+    date: string;
+    result: string;
+    domain?: string;
+    title?: string;
+    covers: string[];
+    content: string;
+}
+declare function parseFixCovers(content: string): string[];
+declare function parseLivingFix(content: string, file: string): LivingFix;
+declare function loadLivingFixes(root: string): Promise<LivingFix[]>;
+interface WriteLivingFixInput {
+    slug: string;
+    date: string;
+    result?: string;
+    domain?: string;
+    title?: string;
+    covers?: string[];
+    content: string;
+}
+interface WriteLivingFixResult {
+    file: string;
+    relativePath: string;
+    created: boolean;
+}
+declare function writeLivingFix(root: string, input: WriteLivingFixInput): Promise<WriteLivingFixResult>;
+
+declare const SARIF_SCHEMA = "https://json.schemastore.org/sarif-2.1.0.json";
+declare const SARIF_VERSION = "2.1.0";
+declare const TOOL_NAME = "SpecAtlas";
+declare const TOOL_URL = "https://github.com/AlonsoAM/specatlas";
+interface SarifOptions {
+    diagnostics: readonly Diagnostic[];
+    root: string;
+    version: string;
+    failed?: boolean;
+}
+interface SarifRule {
+    id: string;
+    shortDescription: {
+        text: string;
+    };
+    help?: {
+        text: string;
+    };
+}
+interface SarifLocation {
+    physicalLocation: {
+        artifactLocation: {
+            uri: string;
+        };
+        region?: {
+            startLine: number;
+        };
+    };
+}
+interface SarifResult {
+    ruleId: string;
+    level: 'error' | 'warning' | 'note';
+    message: {
+        text: string;
+    };
+    locations?: SarifLocation[];
+}
+interface SarifReport {
+    $schema: string;
+    version: string;
+    runs: Array<{
+        tool: {
+            driver: {
+                name: string;
+                informationUri: string;
+                version: string;
+                rules: SarifRule[];
+            };
+        };
+        results: SarifResult[];
+        invocations: Array<{
+            executionSuccessful: boolean;
+        }>;
+    }>;
+}
+declare function ruleDescription(code: string): string;
+declare function sarifLevel(severity: Diagnostic['severity']): SarifResult['level'];
+declare function toSarifReport(opts: SarifOptions): SarifReport;
+declare function toSarifText(opts: SarifOptions): string;
+
 interface DoctorReport {
     findings: Diagnostic[];
     summary: {
@@ -1747,4 +1927,4 @@ declare function livingRequirementsMap(specs: Array<{
 }>): Map<string, Requirement>;
 declare function runCiGate(opts: CiOptions): Promise<CiResult>;
 
-export { type AdoptDomain, type AdoptOptions, type AdoptResult, type AgingBucket, type AnalyzeOptions, type AnalyzePackSummary, type AnalyzeResult, type Approval, type ApprovalStatus, type ApprovalsFile, type ApprovalsIndex, type ApproveFromGithubOptions, type ApproveFromGithubResult, type ArchiveOptions, type ArchiveResult, type AtlasConfig, type AttentionItem, BLOCK_HEAD_RE, BUILTIN_PACKS, type BlockWavePlan, CONFIG_FILE, CORE_VERSION, type CaptureResult, type Change, type ChangeMeta, type ChangeMetrics, type ChangeState, type CiCheck, type CiExtraCheck, type CiOptions, type CiResult, type Delta, type DeltaOp, type DeriveInput, type DerivedState, type DetectionResult, type Diagnostic, type DoctorReport, type Domain, type Evidence, type EvidenceMethod, type EvidenceResult, type ExecOptions, type ExecResult, type FoldOutcome, type FrontmatterResult, type GhRunner, type GitHubRepo, type GlossaryTerm, type ImpactEvidence, type ImpactReport, type ImpactTask, type InitOptions, type InitResult, type IssueBodyInput, type Lane, type Language, type LinkedIssue, type LintOptions, type LoadedConfig, type MockupCheckResult, type MockupManifest, type MockupPlan, type MockupPlanScreen, type MockupScreen, type MoveOps, type NewChangeOptions, type NewChangeResult, type NextAction, type Override, type Pack, type PackCheck, type PackCheckResult, type PackCheckType, type PackEvaluation, type ParsedGlossary, type PresentOptions, type PresentResult, type ProfileMatch, REQ_HEAD_RE, REQ_ID_RE, RULE_ID_RE, RULE_RE, RUN_EVENT_TYPES, type RecordEvidenceOptions, type RecordEvidenceResult, type Rename, type Requirement, type RiskLevel, type Rule, type RunEvent, type RunEventType, type RunRecord, type RunState, type RunStatus, SCENARIO_HEAD_RE, SCENARIO_ID_RE, SDD_DIR, SLUG_RE, type Scenario, type Severity, type SignApprovalOptions, type SignApprovalResult, type SpecFile, type SpecRef, type StackProfile, type SyncGithubOptions, type SyncGithubResult, TASK_ID_RE, TASK_LINE_RE, type Task, type TaskBlock, type TasksFile, type TemplateSet, type TraceEdge, type TraceFinding, type TraceGraph, type TraceInput, type TraceNode, type TraceResult, type VerifyFile, type WalkEntry, type WavePlan, type Workspace, type WorkspaceMetrics, adoptWorkspace, appendRunEvent, approvalsSchema, approveFromGithub, archiveChange, artifactHash, atlasConfigSchema, buildTraceGraph, canonicalizeMarkdown, captureMockups, changeMarker, changeMetaSchema, changeMetaYaml, checkMockups, checkTrace, collectMetrics, commentIssue, compareTaskIds, computeInputsHash, configToYaml, copyFile, countBySeverity, createChange, createIssue, createRun, defaultConfig, deriveState, detectProfiles, detectRepo, detectionToYaml, diag, editIssue, emitFrontmatter, ensureDir, ensureSddDirs, esc, evaluatePacks, evidenceSummary, exists, findLinkedIssue, findWorkspaceRoot, firstToken, foldDelta, generatePresentation, generateRunId, getNumber, getString, ghAuthStatus, ghAvailable, hasErrors, hasShellMetacharacters, impactOfFile, impactOfRequirement, indexMarkdown, initWorkspace, inline, isCommandAllowed, isDirectory, issueBody, issueLabels, laneOrDefault, lintDelta, lintMockupHtml, lintMockupManifest, lintPlan, lintRequirement, lintSpec, lintTasks, lintVerify, listChangeSlugs, listDir, listDirs, listRuns, livingRequirementsMap, loadActiveProfile, loadApprovals, loadChange, loadConfig, loadDetectedBest, loadProfileFile, loadProfilesFromDir, loadProjectPacks, loadSpecs, loadWorkspace, localCompact, localDate, localMonth, localOffset, localStamp, matchGlob, mockupManifestSchema, mockupsDir, mockupsReady, moveDirectory, packFindings, parseApprovals, parseChangeMeta, parseConfig, parseDelta, parseFrontmatter, parseGitHubRemote, parseGlossary, parseIssueUrl, parseRequirementBlocks, parseSpecFile, parseTasksFile, parseVerifyFile, patchChangeMeta, planBlock, planMockups, planWaves, profileSchema, readMockupManifest, readRun, readText, readTextIfExists, recordEvidence, regenerateIndex, renderMarkdown, renderRequirement, renderTemplate, requiresMockups, resolvePacks, runAnalyze, runCiGate, runDoctor, runProcess, setMockupRequirement, sha256, shortHash, signApproval, specHashOf, splitCommand, stateLabel, syncGithubIssue, templatesFor, toPosix, tokensFile, updateMockupScreenshots, updateRunStatus, verifyApproval, walkFiles, writeConfig, writeMockupManifest, writeMockupPlan, writeText };
+export { type AdoptDomain, type AdoptOptions, type AdoptResult, type AgingBucket, type AnalyzeOptions, type AnalyzePackSummary, type AnalyzeResult, type Approval, type ApprovalStatus, type ApprovalsFile, type ApprovalsIndex, type ApproveFromGithubOptions, type ApproveFromGithubResult, type ArchiveOptions, type ArchiveResult, type AtlasConfig, type AttentionItem, BACKUP_DIRNAME, BACKUP_POINTER, BLOCK_HEAD_RE, BUILTIN_PACKS, type BlockWavePlan, CONFIG_FILE, CORE_VERSION, type CaptureResult, type Change, type ChangeMeta, type ChangeMetrics, type ChangeState, type CiCheck, type CiExtraCheck, type CiOptions, type CiResult, type Delta, type DeltaOp, type DeriveInput, type DerivedState, type DetectionResult, type Diagnostic, type DoctorReport, type Domain, type Evidence, type EvidenceMethod, type EvidenceResult, type ExecOptions, type ExecResult, type FoldOutcome, type FrontmatterResult, type GhRunner, type GitHubRepo, type GlossaryTerm, type ImpactEvidence, type ImpactReport, type ImpactTask, type InitOptions, type InitResult, type IssueBodyInput, LIVING_FIXES_DIR, type Lane, type Language, type LinkedIssue, type LintOptions, type LivingFix, type LoadedConfig, type MigrationSpec, type MockupCheckResult, type MockupManifest, type MockupPlan, type MockupPlanScreen, type MockupScreen, type MoveOps, type NewChangeOptions, type NewChangeResult, type NextAction, type Override, type Pack, type PackCheck, type PackCheckResult, type PackCheckType, type PackEvaluation, type ParsedGlossary, type PresentOptions, type PresentResult, type ProfileMatch, REQ_HEAD_RE, REQ_ID_RE, RULE_ID_RE, RULE_RE, RUN_EVENT_TYPES, type RecordEvidenceOptions, type RecordEvidenceResult, type Rename, type Requirement, type RiskLevel, type Rule, type RunEvent, type RunEventType, type RunRecord, type RunState, type RunStatus, SARIF_SCHEMA, SARIF_VERSION, SCENARIO_HEAD_RE, SCENARIO_ID_RE, SCHEMA_MIGRATIONS, SCHEMA_VERSION, SDD_DIR, SLUG_RE, type SarifLocation, type SarifOptions, type SarifReport, type SarifResult, type SarifRule, type Scenario, type Severity, type SignApprovalOptions, type SignApprovalResult, type SpecFile, type SpecRef, type StackProfile, type SyncGithubOptions, type SyncGithubResult, TASK_ID_RE, TASK_LINE_RE, TOOL_NAME, TOOL_URL, type Task, type TaskBlock, type TasksFile, type TemplateSet, type TraceEdge, type TraceFinding, type TraceGraph, type TraceInput, type TraceNode, type TraceResult, type UpgradeAdvisory, type UpgradeApplyReport, type UpgradeBackupInfo, type UpgradeIssue, type UpgradeItem, type UpgradePlan, type UpgradeRollbackReport, type VerifyFile, type WalkEntry, type WavePlan, type Workspace, type WorkspaceMetrics, type WriteLivingFixInput, type WriteLivingFixResult, adoptWorkspace, appendRunEvent, applyUpgrade, approvalsSchema, approveFromGithub, archiveChange, artifactHash, atlasConfigSchema, buildTraceGraph, canonicalizeMarkdown, captureMockups, changeMarker, changeMetaSchema, changeMetaYaml, checkMockups, checkTrace, collectMetrics, collectVersionedArtifacts, commentIssue, compareTaskIds, computeInputsHash, configToYaml, copyFile, countBySeverity, createChange, createIssue, createRun, defaultConfig, deriveState, detectProfiles, detectRepo, detectionToYaml, diag, editIssue, emitFrontmatter, ensureDir, ensureSddDirs, esc, evaluatePacks, evidenceSummary, exists, findLinkedIssue, findWorkspaceRoot, firstToken, foldDelta, generatePresentation, generateRunId, getNumber, getString, ghAuthStatus, ghAvailable, hasErrors, hasShellMetacharacters, impactOfFile, impactOfRequirement, indexMarkdown, initWorkspace, inline, isCommandAllowed, isDirectory, issueBody, issueLabels, laneOrDefault, lintDelta, lintMockupHtml, lintMockupManifest, lintPlan, lintRequirement, lintSpec, lintTasks, lintVerify, listChangeSlugs, listDir, listDirs, listRuns, livingRequirementsMap, loadActiveProfile, loadApprovals, loadChange, loadConfig, loadDetectedBest, loadLivingFixes, loadProfileFile, loadProfilesFromDir, loadProjectPacks, loadSpecs, loadWorkspace, localCompact, localDate, localMonth, localOffset, localStamp, matchGlob, mockupManifestSchema, mockupsDir, mockupsReady, moveDirectory, packFindings, parseApprovals, parseChangeMeta, parseConfig, parseDelta, parseFixCovers, parseFrontmatter, parseGitHubRemote, parseGlossary, parseIssueUrl, parseLivingFix, parseRequirementBlocks, parseSpecFile, parseTasksFile, parseVerifyFile, patchChangeMeta, planBlock, planMockups, planUpgrade, planWaves, profileSchema, readArtifactVersion, readMockupManifest, readRun, readText, readTextIfExists, recordEvidence, regenerateIndex, renderMarkdown, renderRequirement, renderTemplate, requiresMockups, resolvePacks, rollbackUpgrade, ruleDescription, runAnalyze, runCiGate, runDoctor, runProcess, sarifLevel, setMockupRequirement, sha256, shortHash, signApproval, specHashOf, splitCommand, stampSchemaVersion, stateLabel, syncGithubIssue, templatesFor, toPosix, toSarifReport, toSarifText, tokensFile, updateMockupScreenshots, updateRunStatus, upgradeAdvisory, verifyApproval, walkFiles, writeConfig, writeLivingFix, writeMockupManifest, writeMockupPlan, writeText };