@farming-labs/docs 0.1.120 → 0.1.121
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli/index.mjs +1 -1
- package/dist/index.d.mts +2 -2
- package/dist/mcp.d.mts +1 -1
- package/dist/{review-BHFhvl2F.mjs → review-BouPBEHv.mjs} +1 -1
- package/dist/{review-_5fnI667.mjs → review-SngQ_dxy.mjs} +10 -0
- package/dist/{search-Dd0kOr6B.d.mts → search-DSgDbYBT.d.mts} +1 -1
- package/dist/server.d.mts +4 -2
- package/dist/server.mjs +1 -1
- package/dist/{types-DtBNjsk2.d.mts → types-CHD7M60f.d.mts} +6 -0
- package/package.json +1 -1
package/dist/cli/index.mjs
CHANGED
|
@@ -122,7 +122,7 @@ async function main() {
|
|
|
122
122
|
}
|
|
123
123
|
await runDoctor(doctorOptions);
|
|
124
124
|
} else if (parsedCommand.command === "review") {
|
|
125
|
-
const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-
|
|
125
|
+
const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-BouPBEHv.mjs");
|
|
126
126
|
const reviewOptions = parseReviewArgs(args.slice(1));
|
|
127
127
|
if (reviewOptions.help) {
|
|
128
128
|
printReviewHelp();
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as DocsSearchChunkingConfig, A as DocsConfig, At as PageTwitter, B as DocsObservabilityEventInput, Bt as SimpleDocsSearchConfig, C as DocsAskAIActionData, Ct as OpenDocsTarget, D as DocsAskAIFeedbackMessage, Dt as PageFrontmatter, E as DocsAskAIFeedbackData, Et as PageActionsConfig, F as DocsMcpToolsConfig, Ft as SidebarFolderIndexBehavior, G as DocsReviewRulesConfig, H as DocsReviewCiConfig, Ht as TypesenseDocsSearchConfig, I as DocsMetadata, It as SidebarFolderNode, J as DocsRobotsConfig, K as DocsReviewScoreConfig, L as DocsNav, Lt as SidebarNode, M as DocsFeedbackValue, Mt as ResolvedDocsRelatedLink, N as DocsI18nConfig, Nt as SidebarComponentProps, O as DocsAskAIFeedbackValue, Ot as PageOpenGraph, P as DocsMcpConfig, Pt as SidebarConfig, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, Rt as SidebarPageNode, S as DocsAnalyticsSource, St as OpenDocsProviderId, T as DocsAskAIFeedbackConfig, Tt as OrderingItem, U as DocsReviewCiMode, Ut as TypographyConfig, V as DocsRelatedItem, Vt as ThemeToggleConfig, W as DocsReviewConfig, Wt as UIConfig, X as DocsSearchAdapter, Y as DocsRobotsRule, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, at as DocsSearchResultType, b as DocsAnalyticsEventType, bt as OpenDocsProvider, c as ChangelogFrontmatter, ct as DocsTheme, d as CustomDocsSearchConfig, dt as GithubConfig, et as DocsSearchConfig, f as DocsAgentFeedbackContext, ft as LastUpdatedConfig, g as DocsAgentTraceStatus, gt as LlmsTxtSectionConfig, h as DocsAgentTraceEventType, ht as LlmsTxtMaxCharsMode, i as ApiReferenceConfig, it as DocsSearchResult, j as DocsFeedbackData, jt as ReadingTimeConfig, k as DocsAskAIMcpConfig, kt as PageSidebarFrontmatter, l as CodeBlockCopyData, lt as FeedbackConfig, m as DocsAgentTraceEventInput, mt as LlmsTxtMaxCharsConfig, n as AgentFeedbackConfig, nt as DocsSearchEmbeddingsConfig, o as BreadcrumbConfig, ot as DocsSearchSourcePage, p as DocsAgentFeedbackData, pt as LlmsTxtConfig, q as DocsReviewSeverity, r as AlgoliaDocsSearchConfig, rt as DocsSearchQuery, s as ChangelogConfig, st as DocsSitemapConfig, t as AIConfig, tt as DocsSearchDocument, u as CopyMarkdownConfig, ut as FontStyle, v as DocsAnalyticsEvent, vt as OGConfig, w as DocsAskAIActionType, wt as OpenGraphImage, x as DocsAnalyticsInput, xt as OpenDocsProviderConfig, y as DocsAnalyticsEventInput, yt as OpenDocsConfig, z as DocsObservabilityEvent, zt as SidebarTree } from "./types-
|
|
2
|
-
import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, I as PromptProviderChoice, J as DocsAgentTraceContext, L as SerializeOpenDocsProviderOptions, O as resolveDocsSitemapPageLastmod, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage } from "./search-
|
|
1
|
+
import { $ as DocsSearchChunkingConfig, A as DocsConfig, At as PageTwitter, B as DocsObservabilityEventInput, Bt as SimpleDocsSearchConfig, C as DocsAskAIActionData, Ct as OpenDocsTarget, D as DocsAskAIFeedbackMessage, Dt as PageFrontmatter, E as DocsAskAIFeedbackData, Et as PageActionsConfig, F as DocsMcpToolsConfig, Ft as SidebarFolderIndexBehavior, G as DocsReviewRulesConfig, H as DocsReviewCiConfig, Ht as TypesenseDocsSearchConfig, I as DocsMetadata, It as SidebarFolderNode, J as DocsRobotsConfig, K as DocsReviewScoreConfig, L as DocsNav, Lt as SidebarNode, M as DocsFeedbackValue, Mt as ResolvedDocsRelatedLink, N as DocsI18nConfig, Nt as SidebarComponentProps, O as DocsAskAIFeedbackValue, Ot as PageOpenGraph, P as DocsMcpConfig, Pt as SidebarConfig, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, Rt as SidebarPageNode, S as DocsAnalyticsSource, St as OpenDocsProviderId, T as DocsAskAIFeedbackConfig, Tt as OrderingItem, U as DocsReviewCiMode, Ut as TypographyConfig, V as DocsRelatedItem, Vt as ThemeToggleConfig, W as DocsReviewConfig, Wt as UIConfig, X as DocsSearchAdapter, Y as DocsRobotsRule, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, at as DocsSearchResultType, b as DocsAnalyticsEventType, bt as OpenDocsProvider, c as ChangelogFrontmatter, ct as DocsTheme, d as CustomDocsSearchConfig, dt as GithubConfig, et as DocsSearchConfig, f as DocsAgentFeedbackContext, ft as LastUpdatedConfig, g as DocsAgentTraceStatus, gt as LlmsTxtSectionConfig, h as DocsAgentTraceEventType, ht as LlmsTxtMaxCharsMode, i as ApiReferenceConfig, it as DocsSearchResult, j as DocsFeedbackData, jt as ReadingTimeConfig, k as DocsAskAIMcpConfig, kt as PageSidebarFrontmatter, l as CodeBlockCopyData, lt as FeedbackConfig, m as DocsAgentTraceEventInput, mt as LlmsTxtMaxCharsConfig, n as AgentFeedbackConfig, nt as DocsSearchEmbeddingsConfig, o as BreadcrumbConfig, ot as DocsSearchSourcePage, p as DocsAgentFeedbackData, pt as LlmsTxtConfig, q as DocsReviewSeverity, r as AlgoliaDocsSearchConfig, rt as DocsSearchQuery, s as ChangelogConfig, st as DocsSitemapConfig, t as AIConfig, tt as DocsSearchDocument, u as CopyMarkdownConfig, ut as FontStyle, v as DocsAnalyticsEvent, vt as OGConfig, w as DocsAskAIActionType, wt as OpenGraphImage, x as DocsAnalyticsInput, xt as OpenDocsProviderConfig, y as DocsAnalyticsEventInput, yt as OpenDocsConfig, z as DocsObservabilityEvent, zt as SidebarTree } from "./types-CHD7M60f.mjs";
|
|
2
|
+
import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, I as PromptProviderChoice, J as DocsAgentTraceContext, L as SerializeOpenDocsProviderOptions, O as resolveDocsSitemapPageLastmod, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage } from "./search-DSgDbYBT.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/define-docs.d.ts
|
package/dist/mcp.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { P as DocsMcpConfig, R as DocsObservabilityConfig, Tt as OrderingItem, _ as DocsAnalyticsConfig, et as DocsSearchConfig, ot as DocsSearchSourcePage } from "./types-
|
|
1
|
+
import { P as DocsMcpConfig, R as DocsObservabilityConfig, Tt as OrderingItem, _ as DocsAnalyticsConfig, et as DocsSearchConfig, ot as DocsSearchSourcePage } from "./types-CHD7M60f.mjs";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
|
|
4
4
|
//#region src/mcp.d.ts
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-
|
|
1
|
+
import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-SngQ_dxy.mjs";
|
|
2
2
|
import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, p as resolveDocsContentDir } from "./config-BHRL4R2v.mjs";
|
|
3
3
|
import matter from "gray-matter";
|
|
4
4
|
import { existsSync, lstatSync, readFileSync, readdirSync } from "node:fs";
|
|
@@ -4,6 +4,7 @@ import { dirname, isAbsolute, join, relative } from "node:path";
|
|
|
4
4
|
//#region src/review.ts
|
|
5
5
|
const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
|
|
6
6
|
const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
|
|
7
|
+
const DEFAULT_DOCS_REVIEW_CI_NAME = "docs-review";
|
|
7
8
|
const DEFAULT_REVIEW_RULES = {
|
|
8
9
|
brokenLinks: "error",
|
|
9
10
|
frontmatter: "error",
|
|
@@ -41,6 +42,7 @@ function resolveDocsReviewConfig(review) {
|
|
|
41
42
|
enabled: false,
|
|
42
43
|
ci: {
|
|
43
44
|
enabled: false,
|
|
45
|
+
name: DEFAULT_DOCS_REVIEW_CI_NAME,
|
|
44
46
|
mode: "off",
|
|
45
47
|
annotations: false,
|
|
46
48
|
comment: false
|
|
@@ -62,6 +64,7 @@ function resolveDocsReviewConfig(review) {
|
|
|
62
64
|
enabled,
|
|
63
65
|
ci: {
|
|
64
66
|
enabled: ciEnabled,
|
|
67
|
+
name: normalizeCiName(ciObject.name),
|
|
65
68
|
mode: ciEnabled ? mode : "off",
|
|
66
69
|
annotations: ciObject.annotations !== false,
|
|
67
70
|
comment: ciObject.comment !== false
|
|
@@ -82,6 +85,7 @@ function resolveDocsReviewConfig(review) {
|
|
|
82
85
|
}
|
|
83
86
|
function buildDocsReviewWorkflow(options = {}) {
|
|
84
87
|
const packageManager = options.packageManager ?? "npm";
|
|
88
|
+
const ciName = normalizeCiName(options.ciName);
|
|
85
89
|
const projectDir = normalizeProjectDir(options.projectDir);
|
|
86
90
|
const configArg = options.configPath ? ` --config ${shellQuote(options.configPath)}` : "";
|
|
87
91
|
const reviewCommand = `${options.reviewCommand ?? reviewCommandForPackageManager(packageManager)} review --ci${configArg}`;
|
|
@@ -104,6 +108,7 @@ permissions:
|
|
|
104
108
|
|
|
105
109
|
jobs:
|
|
106
110
|
docs-review:
|
|
111
|
+
name: ${JSON.stringify(ciName)}
|
|
107
112
|
runs-on: ubuntu-latest
|
|
108
113
|
steps:
|
|
109
114
|
- uses: actions/checkout@v4
|
|
@@ -140,6 +145,7 @@ function ensureDocsReviewWorkflow(options) {
|
|
|
140
145
|
const packageManager = detectPackageManager(repoRoot);
|
|
141
146
|
const workflow = buildDocsReviewWorkflow({
|
|
142
147
|
packageManager,
|
|
148
|
+
ciName: review.ci.name,
|
|
143
149
|
projectDir,
|
|
144
150
|
configPath,
|
|
145
151
|
buildCommand: detectLocalDocsCliBuildCommand(repoRoot, packageManager),
|
|
@@ -214,6 +220,9 @@ function normalizeRules(rules) {
|
|
|
214
220
|
function normalizeWeight(value, fallback) {
|
|
215
221
|
return typeof value === "number" && Number.isFinite(value) && value >= 0 ? value : fallback;
|
|
216
222
|
}
|
|
223
|
+
function normalizeCiName(value) {
|
|
224
|
+
return value?.trim() || DEFAULT_DOCS_REVIEW_CI_NAME;
|
|
225
|
+
}
|
|
217
226
|
function clampScoreThreshold(value) {
|
|
218
227
|
if (typeof value !== "number" || !Number.isFinite(value)) return DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD;
|
|
219
228
|
return Math.min(100, Math.max(0, Math.round(value)));
|
|
@@ -225,6 +234,7 @@ function readReviewCiObject(source, cursor) {
|
|
|
225
234
|
const mode = readTopLevelString(block, "mode");
|
|
226
235
|
return {
|
|
227
236
|
enabled: readTopLevelBoolean(block, "enabled"),
|
|
237
|
+
name: readTopLevelString(block, "name"),
|
|
228
238
|
mode: mode && REVIEW_CI_MODES.has(mode) ? mode : void 0,
|
|
229
239
|
annotations: readTopLevelBoolean(block, "annotations"),
|
|
230
240
|
comment: readTopLevelBoolean(block, "comment")
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $ as DocsSearchChunkingConfig, B as DocsObservabilityEventInput, Ct as OpenDocsTarget, Ht as TypesenseDocsSearchConfig, Mt as ResolvedDocsRelatedLink, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, X as DocsSearchAdapter, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, bt as OpenDocsProvider, d as CustomDocsSearchConfig, et as DocsSearchConfig, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, r as AlgoliaDocsSearchConfig, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-
|
|
1
|
+
import { $ as DocsSearchChunkingConfig, B as DocsObservabilityEventInput, Ct as OpenDocsTarget, Ht as TypesenseDocsSearchConfig, Mt as ResolvedDocsRelatedLink, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, X as DocsSearchAdapter, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, bt as OpenDocsProvider, d as CustomDocsSearchConfig, et as DocsSearchConfig, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, r as AlgoliaDocsSearchConfig, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-CHD7M60f.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/cloud-analytics.d.ts
|
|
4
4
|
interface DocsCloudAnalyticsOptions {
|
package/dist/server.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as DocsConfig, B as DocsObservabilityEventInput, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, G as DocsReviewRulesConfig, O as DocsAskAIFeedbackValue, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, T as DocsAskAIFeedbackConfig, U as DocsReviewCiMode, W as DocsReviewConfig, X as DocsSearchAdapter, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, et as DocsSearchConfig, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, rt as DocsSearchQuery, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-
|
|
2
|
-
import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, B as parsePromptStringArray, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, G as serializeOpenDocsProvider, H as sanitizePromptText, I as PromptProviderChoice, J as DocsAgentTraceContext, K as serializeOpenDocsProviders, L as SerializeOpenDocsProviderOptions, M as DEFAULT_OPEN_DOCS_PROVIDER_IDS, N as DEFAULT_OPEN_DOCS_TARGET, O as resolveDocsSitemapPageLastmod, P as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, U as serializeDocsIcon, V as resolvePromptProviderChoices, W as serializeDocsIconRegistry, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, j as DEFAULT_OPEN_DOCS_PROMPT, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage, z as normalizePromptProviderName } from "./search-
|
|
1
|
+
import { A as DocsConfig, B as DocsObservabilityEventInput, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, G as DocsReviewRulesConfig, O as DocsAskAIFeedbackValue, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, T as DocsAskAIFeedbackConfig, U as DocsReviewCiMode, W as DocsReviewConfig, X as DocsSearchAdapter, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, et as DocsSearchConfig, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, rt as DocsSearchQuery, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-CHD7M60f.mjs";
|
|
2
|
+
import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, B as parsePromptStringArray, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, G as serializeOpenDocsProvider, H as sanitizePromptText, I as PromptProviderChoice, J as DocsAgentTraceContext, K as serializeOpenDocsProviders, L as SerializeOpenDocsProviderOptions, M as DEFAULT_OPEN_DOCS_PROVIDER_IDS, N as DEFAULT_OPEN_DOCS_TARGET, O as resolveDocsSitemapPageLastmod, P as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, U as serializeDocsIcon, V as resolvePromptProviderChoices, W as serializeDocsIconRegistry, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, j as DEFAULT_OPEN_DOCS_PROMPT, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage, z as normalizePromptProviderName } from "./search-DSgDbYBT.mjs";
|
|
3
3
|
import { DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/api-reference.d.ts
|
|
@@ -59,6 +59,7 @@ interface ResolvedDocsReviewConfig {
|
|
|
59
59
|
enabled: boolean;
|
|
60
60
|
ci: {
|
|
61
61
|
enabled: boolean;
|
|
62
|
+
name: string;
|
|
62
63
|
mode: DocsReviewCiMode;
|
|
63
64
|
annotations: boolean;
|
|
64
65
|
comment: boolean;
|
|
@@ -75,6 +76,7 @@ interface ResolvedDocsReviewConfig {
|
|
|
75
76
|
}
|
|
76
77
|
interface DocsReviewWorkflowOptions {
|
|
77
78
|
packageManager?: "npm" | "pnpm" | "yarn" | "bun";
|
|
79
|
+
ciName?: string;
|
|
78
80
|
projectDir?: string;
|
|
79
81
|
configPath?: string;
|
|
80
82
|
buildCommand?: string;
|
package/dist/server.mjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { A as resolveDocsAnalyticsConfig, D as emitDocsAgentTraceEvent, E as createDocsAgentTraceId, M as createDocsCloudAnalytics, O as emitDocsAnalyticsEvent, T as createDocsAgentTraceContext, a as createMcpSearchAdapter, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, i as createCustomSearchAdapter, j as resolveDocsObservabilityConfig, k as emitDocsObservabilityEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, w as DOCS_AGENT_TRACE_EVENT_TYPES } from "./search-BL7o2rXk.mjs";
|
|
2
2
|
import { a as buildDocsSitemapManifest, c as renderDocsSitemapMarkdown, d as resolveDocsSitemapPageLastmod, f as resolveDocsSitemapRequest, i as DEFAULT_SITEMAP_XML_ROUTE, l as renderDocsSitemapXml, n as DEFAULT_SITEMAP_MD_ROUTE, o as createDocsSitemapResponse, p as toDocsSitemapMarkdownUrl, r as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, s as readDocsSitemapManifestFromContentMap, t as DEFAULT_SITEMAP_MANIFEST_PATH, u as resolveDocsSitemapConfig } from "./sitemap-CnqcTdQg.mjs";
|
|
3
3
|
import { C as resolveApiReferenceOpenApiDiscovery, S as resolveApiReferenceConfig, _ as buildApiReferenceOpenApiDocument, a as DEFAULT_PROMPT_PROVIDER_TEMPLATES, b as buildApiReferenceScalarCss, c as resolvePromptProviderChoices, d as serializeDocsIconRegistry, f as serializeOpenDocsProvider, g as buildApiReferenceHtmlDocumentAsync, h as buildApiReferenceHtmlDocument, i as DEFAULT_OPEN_DOCS_TARGET, l as sanitizePromptText, m as DEFAULT_API_REFERENCE_OPENAPI_ROUTE, n as DEFAULT_OPEN_DOCS_PROMPT, o as normalizePromptProviderName, p as serializeOpenDocsProviders, r as DEFAULT_OPEN_DOCS_PROVIDER_IDS, s as parsePromptStringArray, t as readDocsSitemapManifest, u as serializeDocsIcon, v as buildApiReferenceOpenApiDocumentAsync, w as resolveApiReferenceRenderer, x as isApiReferenceOpenApiRequest, y as buildApiReferencePageTitle } from "./sitemap-server-DdHzJorR.mjs";
|
|
4
|
-
import { a as ensureDocsReviewWorkflow, i as buildDocsReviewWorkflowPathFilters, n as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, o as readDocsReviewConfigFromSource, r as buildDocsReviewWorkflow, s as resolveDocsReviewConfig, t as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD } from "./review-
|
|
4
|
+
import { a as ensureDocsReviewWorkflow, i as buildDocsReviewWorkflowPathFilters, n as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, o as readDocsReviewConfigFromSource, r as buildDocsReviewWorkflow, s as resolveDocsReviewConfig, t as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD } from "./review-SngQ_dxy.mjs";
|
|
5
5
|
import { createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
6
6
|
|
|
7
7
|
export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
|
|
@@ -2074,6 +2074,12 @@ interface DocsReviewCiConfig {
|
|
|
2074
2074
|
* @default true
|
|
2075
2075
|
*/
|
|
2076
2076
|
enabled?: boolean;
|
|
2077
|
+
/**
|
|
2078
|
+
* GitHub Actions job/check name for the generated workflow.
|
|
2079
|
+
*
|
|
2080
|
+
* @default "docs-review"
|
|
2081
|
+
*/
|
|
2082
|
+
name?: string;
|
|
2077
2083
|
/**
|
|
2078
2084
|
* How CI should treat unhealthy review results.
|
|
2079
2085
|
*
|