@interf/compiler 0.1.8

package/dist/lib/workflows.d.ts

@@ -0,0 +1,125 @@
+import { type WorkflowExecutor } from "./executors.js";
+import { type InterfConfig } from "./interf.js";
+import { type SummarizePlan } from "./summarize-plan.js";
+import { type InterfaceWorkflowId, type KnowledgeBaseWorkflowId, type WorkflowStageDefinition } from "./workflow-definitions.js";
+export type InterfTargetKind = "knowledge-base" | "interface";
+export type InterfCheck = "summarize" | "compile" | "interface-plan" | "retrieve";
+export interface DetectedInterfTarget {
+    path: string;
+    kind: InterfTargetKind;
+    engineType: InterfTargetKind;
+    config: InterfConfig;
+}
+export interface WorkflowReporter {
+    line?: (message: string) => void;
+    blankLine?: () => void;
+}
+export interface WorkflowStageResult {
+    ok: boolean;
+    code: number;
+    summary?: string | null;
+}
+export interface KnowledgeBaseSummarizeResult extends WorkflowStageResult {
+    skipped: boolean;
+    plan: SummarizePlan;
+}
+export interface KnowledgeBaseCompileResult {
+    ok: boolean;
+    summarize: KnowledgeBaseSummarizeResult;
+    compile: WorkflowStageResult | null;
+    failedStage: string | null;
+}
+export interface InterfaceRetrieveResult extends WorkflowStageResult {
+    knowledgeBaseSummaryTotal: number;
+    relevantCount: number;
+    deltaCount: number;
+    analyzeCount: number;
+}
+export interface InterfaceAnalyzeResult extends WorkflowStageResult {
+    relevantCount: number;
+    deltaCount: number;
+    analyzeCount: number;
+}
+export interface InterfaceCompileStageResult extends WorkflowStageResult {
+    relevantCount: number;
+}
+export interface InterfaceCompileResult {
+    ok: boolean;
+    retrieve: InterfaceRetrieveResult;
+    analyze: InterfaceAnalyzeResult | null;
+    compile: InterfaceCompileStageResult | null;
+    failedStage: string | null;
+}
+export interface InterfacePlanOptions {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    name: string;
+    workflow: string;
+    useCase: string;
+    knowledgeBaseName: string;
+}
+interface KnowledgeBaseStageExecutionDefinition extends WorkflowStageDefinition {
+    contractType: "kb-file-evidence" | "kb-knowledge-layer";
+}
+interface InterfaceStageExecutionDefinition extends WorkflowStageDefinition {
+    contractType: "interface-retrieval" | "interface-analysis" | "interface-output";
+}
+export declare function detectKnowledgeBase(cwd: string): DetectedInterfTarget | null;
+export declare function createKnowledgeBase(name: string, sourcePath: string, workflowId?: KnowledgeBaseWorkflowId): string;
+export declare function createInterface(name: string, knowledgeBasePath: string, knowledgeBaseName: string, workflowId?: InterfaceWorkflowId): string;
+export declare function verifyInterfCheck(check: InterfCheck, knowledgeBasePath: string): import("./validate.js").KnowledgeBaseSummarizeValidation | import("./validate.js").KnowledgeBaseCompileValidation | import("./validate.js").InterfaceRetrieveValidation | import("./validate.js").InterfacePlanValidation;
+export declare function planInterface(options: InterfacePlanOptions): Promise<WorkflowStageResult>;
+export declare function runKnowledgeBaseSummarize(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    sourcePath?: string;
+    reporter?: WorkflowReporter;
+    reportSummary?: boolean;
+    reportStep?: boolean;
+    stageDefinition?: KnowledgeBaseStageExecutionDefinition;
+    fullPass?: boolean;
+}): Promise<KnowledgeBaseSummarizeResult>;
+export declare function runKnowledgeBaseCompile(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    sourcePath?: string;
+    reporter?: WorkflowReporter;
+    reportStep?: boolean;
+    stageDefinition?: KnowledgeBaseStageExecutionDefinition;
+}): Promise<WorkflowStageResult>;
+export declare function compileKnowledgeBase(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    reporter?: WorkflowReporter;
+}): Promise<KnowledgeBaseCompileResult>;
+export declare function runInterfaceRetrieve(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    sourcePath?: string;
+    reporter?: WorkflowReporter;
+    reportStep?: boolean;
+    stageDefinition?: InterfaceStageExecutionDefinition;
+}): Promise<InterfaceRetrieveResult>;
+export declare function runInterfaceAnalyze(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    sourcePath?: string;
+    reporter?: WorkflowReporter;
+    reportStep?: boolean;
+    stageDefinition?: InterfaceStageExecutionDefinition;
+}): Promise<InterfaceAnalyzeResult>;
+export declare function runInterfaceCompileStage(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    sourcePath?: string;
+    reporter?: WorkflowReporter;
+    reportStep?: boolean;
+    stageDefinition?: InterfaceStageExecutionDefinition;
+}): Promise<InterfaceCompileStageResult>;
+export declare function compileInterface(options: {
+    executor: WorkflowExecutor;
+    knowledgeBasePath: string;
+    reporter?: WorkflowReporter;
+}): Promise<InterfaceCompileResult>;
+export {};
+//# sourceMappingURL=workflows.d.ts.map

package/dist/lib/workflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../src/lib/workflows.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EASL,KAAK,YAAY,EAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAA0C,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAyBjG,OAAO,EAQL,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,2BAA2B,CAAC;AASnC,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,WAAW,CAAC;AAC9D,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,gBAAgB,GAAG,UAAU,CAAC;AAElF,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACvE,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,OAAO,CAAC;IACZ,SAAS,EAAE,4BAA4B,CAAC;IACxC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACpC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,yBAAyB,EAAE,MAAM,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,uBAAuB,CAAC;IAClC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACvC,OAAO,EAAE,2BAA2B,GAAG,IAAI,CAAC;IAC5C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,UAAU,qCAAsC,SAAQ,uBAAuB;IAC7E,YAAY,EAAE,kBAAkB,GAAG,oBAAoB,CAAC;CACzD;AAED,UAAU,iCAAkC,SAAQ,uBAAuB;IACzE,YAAY,EAAE,qBAAqB,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;CACjF;AA0RD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CAS5E;AAED,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,UAAU,GAAE,uBAAkC,GAC7C,MAAM,CAER;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,MAAM,EACzB,iBAAiB,EAAE,MAAM,EACzB,UAAU,GAAE,mBAAgC,GAC3C,MAAM,CAER;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,6NAe9E;AAsCD,wBAAsB,aAAa,CACjC,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,mBAAmB,CAAC,CAgF9B;AAED,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,qCAAqC,CAAC;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GACA,OAAO,CAAC,4BAA4B,CAAC,CA6GvC;AAED,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,qCAAqC,CAAC;CACzD,GACA,OAAO,CAAC,mBAAmB,CAAC,CA2E9B;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B,GACA,OAAO,CAAC,0BAA0B,CAAC,CA6DrC;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,iCAAiC,CAAC;CACrD,GACA,OAAO,CAAC,uBAAuB,CAAC,CAiGlC;AAED,wBAAsB,mBAAmB,CACvC,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,iCAAiC,CAAC;CACrD,GACA,OAAO,CAAC,sBAAsB,CAAC,CA8FjC;AAED,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,iCAAiC,CAAC;CACrD,GACA,OAAO,CAAC,2BAA2B,CAAC,CAkFtC;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE;IACP,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B,GACA,OAAO,CAAC,sBAAsB,CAAC,CAqFjC"}