@farming-labs/svelte 0.2.114 → 0.2.116

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.
@@ -1,2 +1,5 @@
1
- import type { DocsConfig } from "@farming-labs/docs";
2
- export declare function createSvelteApiReference(config: DocsConfig & Record<string, any>): () => Promise<Response>;
1
+ import { type DocsConfig } from "@farming-labs/docs";
2
+ export declare function createSvelteApiReference(config: DocsConfig & Record<string, any>): (event?: {
3
+ url?: URL;
4
+ request?: Request;
5
+ }) => Promise<Response>;
@@ -1,14 +1,34 @@
1
- import { buildApiReferenceHtmlDocumentAsync, resolveApiReferenceConfig, } from "@farming-labs/docs/server";
1
+ import { buildApiReferenceHtmlDocumentAsync, createApiReferenceOperationMarkdownResponse, resolveApiReferenceConfig, resolveApiReferenceVersionFromPathname, } from "@farming-labs/docs/server";
2
+ import { resolveDocsMetadataBaseUrl } from "@farming-labs/docs";
2
3
  export function createSvelteApiReference(config) {
3
- return async () => {
4
+ return async (event) => {
4
5
  const apiReference = resolveApiReferenceConfig(config.apiReference);
5
6
  if (!apiReference.enabled) {
6
7
  return new Response("Not Found", { status: 404 });
7
8
  }
8
9
  const rootDir = typeof config.rootDir === "string" ? config.rootDir : process.cwd();
10
+ const requestUrl = event?.url ?? (event?.request ? new URL(event.request.url) : undefined);
11
+ if (event?.request && requestUrl) {
12
+ const markdownResponse = await createApiReferenceOperationMarkdownResponse(config, {
13
+ request: event.request,
14
+ framework: "sveltekit",
15
+ rootDir,
16
+ baseUrl: requestUrl.origin,
17
+ origin: resolveDocsMetadataBaseUrl(config) || requestUrl.origin,
18
+ sitemap: config.sitemap,
19
+ okf: config.agent?.okf,
20
+ });
21
+ if (markdownResponse)
22
+ return markdownResponse;
23
+ }
24
+ const version = requestUrl
25
+ ? resolveApiReferenceVersionFromPathname(config.apiReference, requestUrl.pathname)
26
+ : undefined;
9
27
  const html = await buildApiReferenceHtmlDocumentAsync(config, {
10
28
  framework: "sveltekit",
11
29
  rootDir,
30
+ baseUrl: requestUrl?.origin,
31
+ version: version?.id,
12
32
  });
13
33
  return new Response(html, {
14
34
  headers: {
package/dist/server.js CHANGED
@@ -30,8 +30,8 @@
30
30
  import fs from "node:fs";
31
31
  import path from "node:path";
32
32
  import matter from "gray-matter";
33
- import { applySidebarFolderIndexBehavior, buildDocsAskAIContext, buildDocsSearchFacets, buildDocsAgentDiscoverySpec, compactDocsAgentDiscoverySpec, buildDocsConfigMap, buildDocsDiagnostics, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsCacheableResponse, createDocsStandardsDiscoveryResponse, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createDocsAgentTraceContext, createDocsAgentTraceId, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, findDocsMarkdownPage, getDocsLlmsTxtMaxCharsIssue, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsAgentDiscoveryRequest, isDocsContentChangesRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsSkillRequest, normalizeDocsRelated, normalizePageAgentFrontmatter, normalizeDocsOkfTrustMetadataInput, parseDocsAgentFeedbackData, performDocsSearch, performDocsSearchWithMetadata, renderDocsMarkdownDocument, renderDocsLlmsTxt, renderDocsAgentsDocument, renderDocsSkillDocument, readDocsSitemapManifestFromContentMap, stripGeneratedAgentProvenance, resolveDocsAudienceMdxContent, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolvePageSidebarFolderIndexBehavior, resolveAskAISearchRequestConfig, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchRequest, resolveSearchRequestConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLocale, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsContentChangesConfig, resolveDocsRequestApiRoute, resolveDocsRetrievalLastModified, resolveDocsPublishedAgentSkill, resolveDocsStandardsDiscoveryRequest, resolveDocsPath, resolvePageReadingTime, resolveReadingTimeOptions, resolveDocsSitemapPageLastmod, resolveDocsAgentsFormat, resolveDocsSkillFormat, inferDocsTelemetryAgentSurface, renderDocsPageStructuredDataJson, selectDocsLlmsTxtContent, validateDocsAgentFeedbackPayload, } from "@farming-labs/docs";
34
- import { buildApiReferenceOpenApiDocumentAsync, createDocsCloudAskAIResponse, createDocsMcpHttpHandler, isDocsCloudAskAIProvider, readDocsSitemapManifest, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveDocsMcpConfig, resolveConfiguredAgentSkills, serializeDocsIconRegistry, serializeOpenDocsProviders, } from "@farming-labs/docs/server";
33
+ import { applySidebarFolderIndexBehavior, buildDocsAskAIContext, buildDocsSearchFacets, buildDocsAgentDiscoverySpec, compactDocsAgentDiscoverySpec, buildDocsConfigMap, buildDocsDiagnostics, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsCacheableResponse, createDocsStandardsDiscoveryResponse, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createDocsAgentTraceContext, createDocsAgentTraceId, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, findDocsMarkdownPage, getDocsLlmsTxtMaxCharsIssue, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsAgentDiscoveryRequest, isDocsContentChangesRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsSkillRequest, normalizeDocsRelated, normalizePageAgentFrontmatter, normalizeDocsOkfTrustMetadataInput, parseDocsAgentFeedbackData, performDocsSearch, performDocsSearchWithMetadata, renderDocsMarkdownDocument, renderDocsLlmsTxt, renderDocsAgentsDocument, renderDocsSkillDocument, readDocsSitemapManifestFromContentMap, stripGeneratedAgentProvenance, resolveDocsAudienceMdxContent, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolvePageSidebarFolderIndexBehavior, resolveAskAISearchRequestConfig, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchRequest, resolveSearchRequestConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLocale, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsContentChangesConfig, resolveDocsRequestApiRoute, resolveDocsRetrievalLastModified, resolveDocsPublishedAgentSkill, resolveDocsStandardsDiscoveryRequest, resolveDocsPath, resolvePageReadingTime, resolveReadingTimeOptions, resolveDocsSitemapPageLastmod, resolveDocsAgentsFormat, resolveDocsSkillFormat, inferDocsTelemetryAgentSurface, renderDocsPageStructuredDataJson, selectDocsLlmsTxtContent, validateDocsAgentFeedbackPayload, withDocsOpenApiOperationCounts, } from "@farming-labs/docs";
34
+ import { buildApiReferenceOpenApiDocumentAsync, buildApiReferenceOperationPagesAsync, createApiReferenceOperationMarkdownResponse, createDocsCloudAskAIResponse, createDocsMcpHttpHandler, isDocsCloudAskAIProvider, readDocsSitemapManifest, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveDocsMcpConfig, resolveConfiguredAgentSkills, serializeDocsIconRegistry, serializeOpenDocsProviders, } from "@farming-labs/docs/server";
35
35
  import { loadDocsNavTree, loadDocsContent, flattenNavTree, normalizeDocsFrontmatterLastmod, } from "./content.js";
36
36
  import { renderMarkdown } from "./markdown.js";
37
37
  export { createSvelteApiReference } from "./api-reference.js";
@@ -617,6 +617,7 @@ export function createDocsServer(config = {}) {
617
617
  }
618
618
  // ─── Search index ──────────────────────────────────────────
619
619
  const searchIndexByEntry = new Map();
620
+ const apiOperationPagesByLocale = new Map();
620
621
  function getSearchIndex(ctx) {
621
622
  const key = ctx.locale ?? "__default__";
622
623
  const cached = searchIndexByEntry.get(key);
@@ -628,6 +629,20 @@ export function createDocsServer(config = {}) {
628
629
  searchIndexByEntry.set(key, index);
629
630
  return index;
630
631
  }
632
+ function getApiOperationSearchPages(ctx, baseUrl) {
633
+ const key = `${ctx.locale ?? "__default__"}\0${baseUrl}`;
634
+ const cached = apiOperationPagesByLocale.get(key);
635
+ if (cached)
636
+ return cached;
637
+ const next = buildApiReferenceOperationPagesAsync(config, {
638
+ framework: "sveltekit",
639
+ rootDir,
640
+ baseUrl,
641
+ locale: ctx.locale,
642
+ });
643
+ apiOperationPagesByLocale.set(key, next);
644
+ return next;
645
+ }
631
646
  // ─── llms.txt content builder ────────────────────────────────
632
647
  const llmsSiteTitle = typeof config.nav === "object" &&
633
648
  typeof config.nav?.title === "string"
@@ -682,21 +697,22 @@ export function createDocsServer(config = {}) {
682
697
  surface,
683
698
  });
684
699
  }
685
- function getLlmsContent(ctx, apiRoute) {
700
+ async function getLlmsContent(ctx, apiRoute, baseUrl) {
686
701
  const cached = llmsCache.get(ctx.locale);
687
- if (cached?.apiRoute === apiRoute)
702
+ if (cached?.apiRoute === apiRoute && cached.baseUrl === baseUrl)
688
703
  return cached.content;
689
- const next = renderDocsLlmsTxt(getSearchIndex(ctx), {
704
+ const operationPages = await getApiOperationSearchPages(ctx, baseUrl);
705
+ const next = renderDocsLlmsTxt([...getSearchIndex(ctx), ...operationPages], {
690
706
  siteTitle: llmsTitle,
691
707
  siteDescription: llmsDesc,
692
708
  baseUrl: llmsBaseUrl,
693
709
  apiRoute,
694
710
  maxChars: typeof llmsTxtConfig === "object" ? llmsTxtConfig.maxChars : undefined,
695
711
  sections: typeof llmsTxtConfig === "object" ? llmsTxtConfig.sections : undefined,
696
- openapi: openapiDiscovery,
712
+ openapi: withDocsOpenApiOperationCounts(openapiDiscovery, operationPages),
697
713
  apiCatalog: apiCatalogEnabled,
698
714
  });
699
- llmsCache.set(ctx.locale, { apiRoute, content: next });
715
+ llmsCache.set(ctx.locale, { apiRoute, baseUrl, content: next });
700
716
  return next;
701
717
  }
702
718
  function resolveLocaleForMcp(locale) {
@@ -720,7 +736,7 @@ export function createDocsServer(config = {}) {
720
736
  }
721
737
  : null;
722
738
  }
723
- function createDiscoveryOptions(origin, apiRoute) {
739
+ function createDiscoveryOptions(origin, apiRoute, openapi = openapiDiscovery) {
724
740
  return {
725
741
  origin,
726
742
  entry,
@@ -743,7 +759,7 @@ export function createDocsServer(config = {}) {
743
759
  },
744
760
  sitemap: config.sitemap,
745
761
  robots: config.robots,
746
- openapi: openapiDiscovery,
762
+ openapi,
747
763
  markdown: {
748
764
  acceptHeader: true,
749
765
  },
@@ -799,7 +815,17 @@ export function createDocsServer(config = {}) {
799
815
  });
800
816
  }
801
817
  const discoveryApiRoute = requestApiRoute;
802
- const discoveryOptions = createDiscoveryOptions(event.url.origin, discoveryApiRoute);
818
+ const standardsRequest = resolveDocsStandardsDiscoveryRequest(event.url, {
819
+ apiRoute: discoveryApiRoute,
820
+ });
821
+ const needsOperationDiscovery = standardsRequest?.kind === "api-catalog" ||
822
+ isDocsAgentDiscoveryRequest(event.url, { apiRoute: discoveryApiRoute });
823
+ const discoveryOperationPages = needsOperationDiscovery
824
+ ? await getApiOperationSearchPages(ctx, markdownMetadataBaseUrl || event.url.origin)
825
+ : [];
826
+ const discoveryOptions = createDiscoveryOptions(event.url.origin, discoveryApiRoute, needsOperationDiscovery
827
+ ? withDocsOpenApiOperationCounts(openapiDiscovery, discoveryOperationPages)
828
+ : openapiDiscovery);
803
829
  const standardsDiscoveryResponse = await resolveStandardsResponse(event.request, event.url, discoveryOptions);
804
830
  if (standardsDiscoveryResponse)
805
831
  return standardsDiscoveryResponse;
@@ -868,6 +894,7 @@ export function createDocsServer(config = {}) {
868
894
  framework: "sveltekit",
869
895
  rootDir,
870
896
  baseUrl: event.url.origin,
897
+ version: event.url.searchParams.get("version")?.trim() || undefined,
871
898
  });
872
899
  return new Response(JSON.stringify(document, null, 2), {
873
900
  headers: {
@@ -947,6 +974,21 @@ export function createDocsServer(config = {}) {
947
974
  });
948
975
  if (robotsResponse)
949
976
  return robotsResponse;
977
+ const operationMarkdownResponse = await createApiReferenceOperationMarkdownResponse(config, {
978
+ request: event.request,
979
+ framework: "sveltekit",
980
+ rootDir,
981
+ baseUrl: event.url.origin,
982
+ origin: markdownMetadataBaseUrl || event.url.origin,
983
+ locale: ctx.locale,
984
+ apiRoute: discoveryApiRoute,
985
+ pages: getSearchIndex(ctx),
986
+ operationPages: () => getApiOperationSearchPages(ctx, markdownMetadataBaseUrl || event.url.origin),
987
+ sitemap: config.sitemap,
988
+ okf: config.agent?.okf,
989
+ });
990
+ if (operationMarkdownResponse)
991
+ return operationMarkdownResponse;
950
992
  const markdownRequest = resolveDocsMarkdownRequest(entry, event.url, event.request, {
951
993
  apiRoute: discoveryApiRoute,
952
994
  });
@@ -980,7 +1022,7 @@ export function createDocsServer(config = {}) {
980
1022
  },
981
1023
  });
982
1024
  }
983
- const selected = selectDocsLlmsTxtContent(getLlmsContent(ctx, requestApiRoute), llmsRequest);
1025
+ const selected = selectDocsLlmsTxtContent(await getLlmsContent(ctx, requestApiRoute, markdownMetadataBaseUrl || event.url.origin), llmsRequest);
984
1026
  if (!selected) {
985
1027
  return new Response("Not Found", {
986
1028
  status: 404,
@@ -1030,8 +1072,9 @@ export function createDocsServer(config = {}) {
1030
1072
  headers: { "Content-Type": "application/json" },
1031
1073
  });
1032
1074
  }
1075
+ const operationPages = await getApiOperationSearchPages(ctx, markdownMetadataBaseUrl || event.url.origin);
1033
1076
  const searchOptions = {
1034
- pages: getSearchIndex(ctx),
1077
+ pages: [...getSearchIndex(ctx), ...operationPages],
1035
1078
  query: query ?? "",
1036
1079
  search: resolveSearchRequestConfig(config.search, event.request.url, {
1037
1080
  localMcp: config.mcp,
@@ -1337,8 +1380,9 @@ export function createDocsServer(config = {}) {
1337
1380
  maxResults,
1338
1381
  },
1339
1382
  });
1383
+ const operationPages = await getApiOperationSearchPages(ctx, markdownMetadataBaseUrl || requestUrl.origin);
1340
1384
  const retrieval = await buildDocsAskAIContext({
1341
- pages: getSearchIndex(ctx),
1385
+ pages: [...getSearchIndex(ctx), ...operationPages],
1342
1386
  query: lastUserMessage.content,
1343
1387
  search: resolveAskAISearchRequestConfig({
1344
1388
  search: config.search,
@@ -1684,6 +1728,16 @@ export function createDocsServer(config = {}) {
1684
1728
  return [rootSkill, ...(await getPublishedAgentSkills())];
1685
1729
  },
1686
1730
  },
1731
+ apiReference: {
1732
+ getPages(locale, context) {
1733
+ const ctx = resolveContextFromPath(`/${entry}`, resolveLocaleForMcp(locale));
1734
+ const baseUrl = markdownMetadataBaseUrl ||
1735
+ (context?.request
1736
+ ? new URL(context.request.url).origin
1737
+ : llmsBaseUrl || "http://localhost");
1738
+ return getApiOperationSearchPages(ctx, baseUrl);
1739
+ },
1740
+ },
1687
1741
  mcp: config.mcp,
1688
1742
  okf: config.agent?.okf,
1689
1743
  openapi: mcpApiReference
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farming-labs/svelte",
3
- "version": "0.2.114",
3
+ "version": "0.2.116",
4
4
  "description": "SvelteKit adapter for @farming-labs/docs — content loading and navigation utilities",
5
5
  "keywords": [
6
6
  "docs",
@@ -57,7 +57,7 @@
57
57
  "@types/node": "^22.10.0",
58
58
  "typescript": "^5.9.3",
59
59
  "vitest": "^4.1.8",
60
- "@farming-labs/docs": "0.2.114"
60
+ "@farming-labs/docs": "0.2.116"
61
61
  },
62
62
  "peerDependencies": {
63
63
  "@farming-labs/docs": ">=0.2.73"