@agentskit/doc-bridge 1.0.1 → 1.1.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { D as DocBridgeConfigV1 } from './index-CPUJbTbg.js';
-export { A as AgentCorpusConfig, C as ConfigNotFoundError, a as DocBridgeConfigV1Schema, L as LoadConfigOptions, b as LoadConfigResult, c as applyConfigDefaults, d as defineConfig, l as loadConfig, p as projectRootFromConfigPath, r as resolveProjectRoot } from './index-CPUJbTbg.js';
+import { D as DocBridgeConfigV1, a as DocumentationStandardRuleId } from './index-DGI9TBLE.js';
+export { A as AgentCorpusConfig, C as ConfigNotFoundError, b as DocBridgeConfigV1Schema, c as DocumentationStandardRuleIdSchema, d as DocumentationStandardV1Config, e as DocumentationStandardV1ConfigSchema, E as EcosystemContractEvidenceSchema, L as LoadConfigOptions, f as LoadConfigResult, g as applyConfigDefaults, h as defineConfig, l as loadConfig, p as projectRootFromConfigPath, r as resolveProjectRoot } from './index-DGI9TBLE.js';
 import { z } from 'zod';
 
 declare const HANDOFF_SCHEMA_VERSION: 1;
@@ -341,18 +341,18 @@ declare const KnowledgeEntrySchema: z.ZodObject<{
     type: string;
     id: string;
     title: string;
+    links?: string[] | undefined;
     description?: string | undefined;
     body?: string | undefined;
-    links?: string[] | undefined;
     tags?: string[] | undefined;
 }, {
     path: string;
     type: string;
     id: string;
     title: string;
+    links?: string[] | undefined;
     description?: string | undefined;
     body?: string | undefined;
-    links?: string[] | undefined;
     tags?: string[] | undefined;
 }>;
 declare const DocBridgeIndexV1Schema: z.ZodObject<{
@@ -401,18 +401,18 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
         type: string;
         id: string;
         title: string;
+        links?: string[] | undefined;
         description?: string | undefined;
         body?: string | undefined;
-        links?: string[] | undefined;
         tags?: string[] | undefined;
     }, {
         path: string;
         type: string;
         id: string;
         title: string;
+        links?: string[] | undefined;
         description?: string | undefined;
         body?: string | undefined;
-        links?: string[] | undefined;
         tags?: string[] | undefined;
     }>, "many">;
     capabilities: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -640,9 +640,9 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
         type: string;
         id: string;
         title: string;
+        links?: string[] | undefined;
         description?: string | undefined;
         body?: string | undefined;
-        links?: string[] | undefined;
         tags?: string[] | undefined;
     }[];
     capabilities?: {
@@ -719,9 +719,9 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
         type: string;
         id: string;
         title: string;
+        links?: string[] | undefined;
         description?: string | undefined;
         body?: string | undefined;
-        links?: string[] | undefined;
         tags?: string[] | undefined;
     }[];
     capabilities?: {
@@ -1415,13 +1415,67 @@ type HumanDocMap = Record<string, string>;
 declare const scanHumanDocRecords: (root: string, config: DocBridgeConfigV1) => HumanDocRecord[];
 declare const scanHumanDocs: (root: string, config: DocBridgeConfigV1) => HumanDocMap;
 
-type GateId = 'index-freshness' | 'human-guide-links' | 'okf-type' | 'docs-style';
+declare const DOCUMENTATION_STANDARD_V1_ID: "documentation-standard-v1";
+declare const DOCUMENTATION_STANDARD_V1_STATUS: "stable";
+
+type DocumentationStandardRuleLevel = 'required' | 'recommended';
+type DocumentationStandardRuleStatus = 'pass' | 'fail' | 'excepted';
+type DocumentationStandardEvidence = {
+    readonly path: string;
+    readonly detail: string;
+};
+type DocumentationStandardRemediation = {
+    readonly command: string;
+    readonly detail: string;
+};
+type DocumentationStandardRuleResult = {
+    readonly id: DocumentationStandardRuleId;
+    readonly level: DocumentationStandardRuleLevel;
+    readonly status: DocumentationStandardRuleStatus;
+    readonly ok: boolean;
+    readonly message: string;
+    readonly evidence: readonly DocumentationStandardEvidence[];
+    readonly remediation: DocumentationStandardRemediation;
+    readonly exception?: {
+        readonly reason: string;
+        readonly approvedBy: string;
+        readonly trackingUrl: string;
+    };
+};
+type DocumentationConformanceReportV1 = {
+    readonly schemaVersion: 1;
+    readonly profile: {
+        readonly id: typeof DOCUMENTATION_STANDARD_V1_ID;
+        readonly version: 1;
+        readonly status: typeof DOCUMENTATION_STANDARD_V1_STATUS;
+    };
+    readonly ok: boolean;
+    readonly recommendedOk: boolean;
+    readonly summary: {
+        readonly required: {
+            readonly passed: number;
+            readonly failed: number;
+            readonly excepted: number;
+        };
+        readonly recommended: {
+            readonly passed: number;
+            readonly failed: number;
+            readonly excepted: number;
+        };
+    };
+    readonly results: readonly DocumentationStandardRuleResult[];
+};
+declare const runDocumentationStandardV1: (root: string, config: DocBridgeConfigV1) => DocumentationConformanceReportV1;
+declare const formatDocumentationStandardText: (report: DocumentationConformanceReportV1) => string[];
+
+type GateId = 'index-freshness' | 'human-guide-links' | 'okf-type' | 'docs-style' | 'documentation-standard-v1';
 type GateResult = {
     readonly id: GateId;
     readonly ok: boolean;
     readonly message: string;
     readonly expected?: string;
     readonly actual?: string;
+    readonly details?: DocumentationConformanceReportV1;
 };
 type GateRunResult = {
     readonly ok: boolean;
@@ -1722,7 +1776,7 @@ declare const chunksFromMarkdown: (property: string, raw: string, sourceUrl: str
 declare const loadFederatedChunks: (root: string, config: DocBridgeConfigV1, options?: FederatedRetrieverOptions) => Promise<DocBridgeRetrievedChunk[]>;
 declare const retrieveHybridChunks: (root: string, config: DocBridgeConfigV1, index: DocBridgeIndexV1, query: string, options?: FederatedRetrieverOptions) => Promise<DocBridgeRetrievedChunk[]>;
 
-declare const PACKAGE_VERSION = "1.0.0";
+declare const PACKAGE_VERSION = "1.1.1";
 
 type FrontmatterValue = string | boolean | readonly string[];
 type FrontmatterData = Record<string, FrontmatterValue>;
@@ -1836,4 +1890,4 @@ declare const docBridgePatternPayload: () => {
     cli: "ak-docs";
 };
 
-export { AgentHandoffLegacySchema, type AgentHandoffV1, AgentHandoffV1JsonSchema, AgentHandoffV1Schema, type AgentSearchV1, AgentSearchV1Schema, type BuildIndexOptions, type BuildIndexResult, DOC_BRIDGE_PATTERN_ID, DOC_BRIDGE_PATTERN_META, DocBridgeConfigV1, type DocBridgeIndexV1, DocBridgeIndexV1JsonSchema, DocBridgeIndexV1Schema, DocBridgeJsonSchemas, type DocBridgeRetrievedChunk, type DocBridgeRetriever, type DocBridgeRetrieverOptions, type DoctorBadgeMetrics, type DoctorCoverage, type DoctorIssue, type DoctorReport, type FederatedRetrieverOptions, type FetchText, type GateId, type GateResult, type GateRunResult, type GithubPrOptions, type GithubPrResult, HANDOFF_SCHEMA_VERSION, type HandoffBridge, HandoffBridgeSchema, type HandoffTarget, type HandoffTargetType, HandoffTargetTypeSchema, type HumanDocMap, type HumanDocRecord, INDEX_SCHEMA_VERSION, IndexNotFoundError, type KnowledgeEntry, KnowledgeEntrySchema, MCP_TOOLS, MEMORY_CANDIDATE_SCHEMA_VERSION, type McpInstallResult, type McpInstallTarget, type MemoryCandidateV1, MemoryCandidateV1JsonSchema, MemoryCandidateV1Schema, type MemoryClassification, type MemoryPromotionDraft, type MemoryRoute, PACKAGE_VERSION, type ParseIssue, type ParseResult, PeerMissingError, type QueryKind, type QueryRequest, type QueryResult, type SafetyFinding, type SearchMatch, type WatchIndexOptions, buildDocBridgeIndex, buildLookup, chunksFromMarkdown, classifyMemoryCandidates, collectPackages, createDocBridgeRag, createDocBridgeRetriever, defaultPromotionDraftPath, docBridgePatternMarkdown, docBridgePatternPayload, doctorBadgeMetrics, draftMemoryPromotion, formatDoctorBadgeJson, formatDoctorBadgeMarkdown, formatDoctorText, handleMcpRequest, indexFilePath, ingestAgentMemory, ingestCursorRules, ingestMemoryCandidates, installMcpConfig, layer1InstallHint, loadDocBridgeIndex, loadFederatedChunks, mcpSnippet, normalizeAgentHandoff, parseAgentHandoff, parseAgentSearch, parseDocBridgeConfig, parseDocBridgeIndex, parseLlmsTxtLinks, parseMemoryCandidate, promoteMemoryToGithubPr, resolveGateIds, resolveRoot, retrieveDocBridgeChunks, retrieveHybridChunks, runChatOnce, runDoctor, runGate, runGates, runQuery, safeParseAgentHandoff, scanHumanDocRecords, scanHumanDocs, scanMemorySafety, searchIndex, sha256NormalizedV1, startInkChat, startMcpStdioServer, watchDocBridgeIndex, writePromotionDraft };
+export { AgentHandoffLegacySchema, type AgentHandoffV1, AgentHandoffV1JsonSchema, AgentHandoffV1Schema, type AgentSearchV1, AgentSearchV1Schema, type BuildIndexOptions, type BuildIndexResult, DOCUMENTATION_STANDARD_V1_ID, DOCUMENTATION_STANDARD_V1_STATUS, DOC_BRIDGE_PATTERN_ID, DOC_BRIDGE_PATTERN_META, DocBridgeConfigV1, type DocBridgeIndexV1, DocBridgeIndexV1JsonSchema, DocBridgeIndexV1Schema, DocBridgeJsonSchemas, type DocBridgeRetrievedChunk, type DocBridgeRetriever, type DocBridgeRetrieverOptions, type DoctorBadgeMetrics, type DoctorCoverage, type DoctorIssue, type DoctorReport, type DocumentationConformanceReportV1, type DocumentationStandardEvidence, type DocumentationStandardRemediation, DocumentationStandardRuleId, type DocumentationStandardRuleLevel, type DocumentationStandardRuleResult, type DocumentationStandardRuleStatus, type FederatedRetrieverOptions, type FetchText, type GateId, type GateResult, type GateRunResult, type GithubPrOptions, type GithubPrResult, HANDOFF_SCHEMA_VERSION, type HandoffBridge, HandoffBridgeSchema, type HandoffTarget, type HandoffTargetType, HandoffTargetTypeSchema, type HumanDocMap, type HumanDocRecord, INDEX_SCHEMA_VERSION, IndexNotFoundError, type KnowledgeEntry, KnowledgeEntrySchema, MCP_TOOLS, MEMORY_CANDIDATE_SCHEMA_VERSION, type McpInstallResult, type McpInstallTarget, type MemoryCandidateV1, MemoryCandidateV1JsonSchema, MemoryCandidateV1Schema, type MemoryClassification, type MemoryPromotionDraft, type MemoryRoute, PACKAGE_VERSION, type ParseIssue, type ParseResult, PeerMissingError, type QueryKind, type QueryRequest, type QueryResult, type SafetyFinding, type SearchMatch, type WatchIndexOptions, buildDocBridgeIndex, buildLookup, chunksFromMarkdown, classifyMemoryCandidates, collectPackages, createDocBridgeRag, createDocBridgeRetriever, defaultPromotionDraftPath, docBridgePatternMarkdown, docBridgePatternPayload, doctorBadgeMetrics, draftMemoryPromotion, formatDoctorBadgeJson, formatDoctorBadgeMarkdown, formatDoctorText, formatDocumentationStandardText, handleMcpRequest, indexFilePath, ingestAgentMemory, ingestCursorRules, ingestMemoryCandidates, installMcpConfig, layer1InstallHint, loadDocBridgeIndex, loadFederatedChunks, mcpSnippet, normalizeAgentHandoff, parseAgentHandoff, parseAgentSearch, parseDocBridgeConfig, parseDocBridgeIndex, parseLlmsTxtLinks, parseMemoryCandidate, promoteMemoryToGithubPr, resolveGateIds, resolveRoot, retrieveDocBridgeChunks, retrieveHybridChunks, runChatOnce, runDoctor, runDocumentationStandardV1, runGate, runGates, runQuery, safeParseAgentHandoff, scanHumanDocRecords, scanHumanDocs, scanMemorySafety, searchIndex, sha256NormalizedV1, startInkChat, startMcpStdioServer, watchDocBridgeIndex, writePromotionDraft };