@shrkcrft/inspector 0.1.0-alpha.2

package/dist/repository-knowledge-model.d.ts

@@ -0,0 +1,218 @@
+import { type IPresetRecommendation } from '@shrkcrft/presets';
+import type { ISharkcraftInspection } from './sharkcraft-inspector.js';
+import { type IInferredBoundaryRule, type IInferredPathConvention, type IInferredPipeline, type IInferredRule, type IInferredTemplateCandidate, type IInferredVerificationCommand } from './onboarding.js';
+import { type IGeneratedCodeReport } from './generated-code.js';
+import { type IContradictionReport } from './contradictions.js';
+import { type IStabilityMap } from './stability-map.js';
+import { type ILanguageProfileReport, type ILanguageCommandReport, type IPolyglotDependencyGraph, type IPolyglotBoundaryReport, type ILanguageBoundarySuggestionReport, type IPolyglotTestImpact } from './languages/index.js';
+export declare const REPOSITORY_KNOWLEDGE_MODEL_SCHEMA = "sharkcraft.repository-knowledge-model/v1";
+export declare enum IngestDepth {
+    Shallow = "shallow",
+    Standard = "standard",
+    Deep = "deep",
+    Extreme = "extreme"
+}
+export declare enum IngestSection {
+    RepositoryOverview = "repositoryOverview",
+    ArchitectureModel = "architectureModel",
+    BusinessLogicModel = "businessLogicModel",
+    RulesAndConventions = "rulesAndConventions",
+    DependencyBoundaries = "dependencyBoundaries",
+    DomainMap = "domainMap",
+    WorkflowMap = "workflowMap",
+    ChangeProtocol = "changeProtocol",
+    RiskAreas = "riskAreas",
+    Contradictions = "contradictions",
+    OpenQuestions = "openQuestions",
+    GeneratedVsHandwritten = "generatedVsHandwritten",
+    StableExperimentalDeprecated = "stableExperimentalDeprecated",
+    TaskContextHints = "taskContextHints",
+    RecommendedSharkCraftFiles = "recommendedSharkCraftFiles"
+}
+export declare const ALL_INGEST_SECTIONS: readonly IngestSection[];
+export interface IRepositoryOverview {
+    projectName: string;
+    description?: string;
+    packageManager: string;
+    frameworks: readonly string[];
+    topLevelDirs: readonly string[];
+    knownScripts: readonly string[];
+    hasSharkcraftFolder: boolean;
+    monorepo: boolean;
+    detectedLanguages: readonly string[];
+}
+export interface IArchitectureLayerSummary {
+    id: string;
+    description: string;
+    paths: readonly string[];
+    fileCount: number;
+}
+export interface IArchitectureModel {
+    layers: readonly IArchitectureLayerSummary[];
+    /** Public API surfaces (paths whose deep imports should be forbidden). */
+    publicApis: readonly string[];
+    /** Notes about cycles or imports that violate the inferred layer order. */
+    notes: readonly string[];
+}
+export interface IBusinessConcept {
+    id: string;
+    title: string;
+    source: 'docs' | 'folder' | 'construct' | 'pack' | 'config';
+    /** Free-form summary in 1–3 lines. */
+    summary: string;
+    paths: readonly string[];
+    /** Domain workflows in which this concept participates. */
+    relatedWorkflows: readonly string[];
+}
+export interface IBusinessLogicModel {
+    entities: readonly IBusinessConcept[];
+    workflows: readonly IBusinessConcept[];
+    invariants: readonly string[];
+}
+export interface IDomainAreaEntry {
+    id: string;
+    paths: readonly string[];
+    kind: string;
+    fileCount: number;
+}
+export interface IDomainMap {
+    areas: readonly IDomainAreaEntry[];
+    constructs: readonly {
+        id: string;
+        title: string;
+        paths: readonly string[];
+    }[];
+}
+export interface IWorkflowEntry {
+    id: string;
+    title: string;
+    source: 'docs' | 'scripts' | 'pipelines' | 'inferred';
+    steps: readonly string[];
+}
+export interface IWorkflowMap {
+    workflows: readonly IWorkflowEntry[];
+}
+export interface IChangeProtocolEntry {
+    id: string;
+    title: string;
+    steps: readonly string[];
+    recommendedCommands: readonly string[];
+}
+export interface IChangeProtocol {
+    entries: readonly IChangeProtocolEntry[];
+}
+export interface IRiskAreaEntry {
+    id: string;
+    path: string;
+    reason: string;
+    recommendation: string;
+    /** Higher = riskier. 0–100. */
+    score: number;
+}
+export interface ITaskContextHint {
+    trigger: string;
+    hint: string;
+    recommendedCommand?: string;
+}
+export interface IRecommendedSharkCraftFile {
+    /** sharkcraft/X.ts or sharkcraft/ingestion/generated/X.draft.ts */
+    target: string;
+    reason: string;
+    entries: readonly IDraftEntryRef[];
+}
+export interface IDraftEntryRef {
+    id: string;
+    /** Why this entry was placed in this file. */
+    reason: string;
+    /** What the entry represents (rule|path|template|...) */
+    kind: string;
+}
+export interface IRepositoryKnowledgeModelConfidence {
+    /** 0–100. */
+    overall: number;
+    perSection: Readonly<Record<IngestSection, number>>;
+    /** What signals were strong vs weak. */
+    notes: readonly string[];
+}
+export interface ILanguageRiskNote {
+    language: string;
+    note: string;
+}
+export interface ILanguageGeneratedSignal {
+    language: string;
+    signal: string;
+    paths: readonly string[];
+}
+export interface ILanguageStabilitySignal {
+    language: string;
+    kind: string;
+    paths: readonly string[];
+}
+export interface IRepositoryKnowledgeModel {
+    schema: typeof REPOSITORY_KNOWLEDGE_MODEL_SCHEMA;
+    projectRoot: string;
+    depth: IngestDepth;
+    presets: readonly IPresetRecommendation[];
+    forcedPresetIds: readonly string[];
+    transformationalIntents: readonly string[];
+    selectedSections: readonly IngestSection[];
+    repositoryOverview: IRepositoryOverview;
+    /** Language-aware sections. */
+    languageProfiles?: ILanguageProfileReport;
+    languageCommands?: ILanguageCommandReport;
+    polyglotDependencySummary?: IPolyglotDependencyGraph;
+    polyglotTestImpactSummary?: IPolyglotTestImpact;
+    languageBoundarySuggestions?: ILanguageBoundarySuggestionReport;
+    polyglotBoundaryReport?: IPolyglotBoundaryReport;
+    languageRiskNotes?: readonly ILanguageRiskNote[];
+    languageGeneratedCodeSignals?: readonly ILanguageGeneratedSignal[];
+    languageStabilitySignals?: readonly ILanguageStabilitySignal[];
+    architectureModel: IArchitectureModel;
+    businessLogicModel: IBusinessLogicModel;
+    rulesAndConventions: {
+        rules: readonly IInferredRule[];
+        paths: readonly IInferredPathConvention[];
+        verificationCommands: readonly IInferredVerificationCommand[];
+    };
+    dependencyBoundaries: {
+        rules: readonly IInferredBoundaryRule[];
+        importGraphSummary: {
+            nodeCount: number;
+            edgeCount: number;
+            cycles: readonly string[];
+        };
+    };
+    domainMap: IDomainMap;
+    workflowMap: IWorkflowMap;
+    changeProtocol: IChangeProtocol;
+    riskAreas: readonly IRiskAreaEntry[];
+    contradictions: IContradictionReport;
+    openQuestions: readonly string[];
+    generatedVsHandwritten: IGeneratedCodeReport;
+    stableExperimentalDeprecated: IStabilityMap;
+    taskContextHints: readonly ITaskContextHint[];
+    recommendedSharkCraftFiles: readonly IRecommendedSharkCraftFile[];
+    inferredPipelines: readonly IInferredPipeline[];
+    inferredTemplates: readonly IInferredTemplateCandidate[];
+    confidence: IRepositoryKnowledgeModelConfidence;
+    limitations: readonly string[];
+    generatedAt: string;
+}
+export interface IBuildRepositoryKnowledgeModelOptions {
+    inspection: ISharkcraftInspection;
+    depth?: IngestDepth;
+    selectedSections?: readonly IngestSection[];
+    excludedSections?: readonly IngestSection[];
+    /** Pinned preset ids — order matters for ranking. */
+    forcedPresetIds?: readonly string[];
+    /** Free-form task description to bias ranking / hints. */
+    task?: string;
+    /** Whether to read large docs. Default true at depth >= Standard. */
+    docsFirst?: boolean;
+}
+export declare function buildRepositoryKnowledgeModel(options: IBuildRepositoryKnowledgeModelOptions): Promise<IRepositoryKnowledgeModel>;
+export declare function renderRepositoryKnowledgeModelText(model: IRepositoryKnowledgeModel): string;
+export declare function renderRepositoryKnowledgeModelMarkdown(model: IRepositoryKnowledgeModel): string;
+export declare function renderRepositoryKnowledgeModelJson(model: IRepositoryKnowledgeModel): string;
+export declare function renderRepositoryKnowledgeModelHtml(model: IRepositoryKnowledgeModel): string;
+//# sourceMappingURL=repository-knowledge-model.d.ts.map

package/dist/repository-knowledge-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository-knowledge-model.d.ts","sourceRoot":"","sources":["../src/repository-knowledge-model.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAEL,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EAElC,MAAM,iBAAiB,CAAC;AAOzB,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,KAAK,aAAa,EAEnB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAQL,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,iCAAiC,EACtC,KAAK,mBAAmB,EACzB,MAAM,sBAAsB,CAAC;AAE9B,eAAO,MAAM,iCAAiC,6CAA6C,CAAC;AAE5F,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,aAAa;IACvB,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;IAC3C,oBAAoB,yBAAyB;IAC7C,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,cAAc,mBAAmB;IACjC,SAAS,cAAc;IACvB,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,sBAAsB,2BAA2B;IACjD,4BAA4B,iCAAiC;IAC7D,gBAAgB,qBAAqB;IACrC,0BAA0B,+BAA+B;CAC1D;AAED,eAAO,MAAM,mBAAmB,EAAE,SAAS,aAAa,EAAiC,CAAC;AAE1F,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,iBAAiB,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,SAAS,yBAAyB,EAAE,CAAC;IAC7C,0EAA0E;IAC1E,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,2EAA2E;IAC3E,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC5D,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,2DAA2D;IAC3D,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACvC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnC,UAAU,EAAE,SAAS;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;CAChF;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC;IACtD,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,SAAS,cAAc,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACzC,mEAAmE;IACnE,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mCAAmC;IAClD,aAAa;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,wCAAwC;IACxC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,OAAO,iCAAiC,CAAC;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,WAAW,CAAC;IACnB,OAAO,EAAE,SAAS,qBAAqB,EAAE,CAAC;IAC1C,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,uBAAuB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C,gBAAgB,EAAE,SAAS,aAAa,EAAE,CAAC;IAC3C,kBAAkB,EAAE,mBAAmB,CAAC;IACxC,+BAA+B;IAC/B,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,yBAAyB,CAAC,EAAE,wBAAwB,CAAC;IACrD,yBAAyB,CAAC,EAAE,mBAAmB,CAAC;IAChD,2BAA2B,CAAC,EAAE,iCAAiC,CAAC;IAChE,sBAAsB,CAAC,EAAE,uBAAuB,CAAC;IACjD,iBAAiB,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACjD,4BAA4B,CAAC,EAAE,SAAS,wBAAwB,EAAE,CAAC;IACnE,wBAAwB,CAAC,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAC/D,iBAAiB,EAAE,kBAAkB,CAAC;IACtC,kBAAkB,EAAE,mBAAmB,CAAC;IACxC,mBAAmB,EAAE;QACnB,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;QAChC,KAAK,EAAE,SAAS,uBAAuB,EAAE,CAAC;QAC1C,oBAAoB,EAAE,SAAS,4BAA4B,EAAE,CAAC;KAC/D,CAAC;IACF,oBAAoB,EAAE;QACpB,KAAK,EAAE,SAAS,qBAAqB,EAAE,CAAC;QACxC,kBAAkB,EAAE;YAClB,SAAS,EAAE,MAAM,CAAC;YAClB,SAAS,EAAE,MAAM,CAAC;YAClB,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;SAC3B,CAAC;KACH,CAAC;IACF,SAAS,EAAE,UAAU,CAAC;IACtB,WAAW,EAAE,YAAY,CAAC;IAC1B,cAAc,EAAE,eAAe,CAAC;IAChC,SAAS,EAAE,SAAS,cAAc,EAAE,CAAC;IACrC,cAAc,EAAE,oBAAoB,CAAC;IACrC,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,sBAAsB,EAAE,oBAAoB,CAAC;IAC7C,4BAA4B,EAAE,aAAa,CAAC;IAC5C,gBAAgB,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC9C,0BAA0B,EAAE,SAAS,0BAA0B,EAAE,CAAC;IAClE,iBAAiB,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAChD,iBAAiB,EAAE,SAAS,0BAA0B,EAAE,CAAC;IACzD,UAAU,EAAE,mCAAmC,CAAC;IAChD,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qCAAqC;IACpD,UAAU,EAAE,qBAAqB,CAAC;IAClC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,gBAAgB,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IAC5C,gBAAgB,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IAC5C,qDAAqD;IACrD,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,wBAAsB,6BAA6B,CACjD,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,yBAAyB,CAAC,CAyRpC;AA2iBD,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,yBAAyB,GAAG,MAAM,CAkC3F;AAED,wBAAgB,sCAAsC,CAAC,KAAK,EAAE,yBAAyB,GAAG,MAAM,CA6E/F;AAED,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,yBAAyB,GAAG,MAAM,CAE3F;AAED,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,yBAAyB,GAAG,MAAM,CAI3F"}