@farming-labs/svelte 0.2.75 → 0.2.78

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/server.js CHANGED
@@ -30,27 +30,14 @@
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, buildDocsAgentDiscoverySpec, buildDocsConfigMap, buildDocsDiagnostics, createDocsStandardsDiscoveryResponse, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createDocsAgentTraceContext, createDocsAgentTraceId, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, findDocsMarkdownPage, getDocsLlmsTxtMaxCharsIssue, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsSkillRequest, normalizeDocsRelated, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, performDocsSearch, performDocsSearchWithMetadata, renderDocsMarkdownDocument, renderDocsLlmsTxt, renderDocsAgentsDocument, renderDocsSkillDocument, readDocsSitemapManifestFromContentMap, stripGeneratedAgentProvenance, resolveDocsAudienceMdxContent, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolvePageSidebarFolderIndexBehavior, resolveAskAISearchRequestConfig, resolveDocsSearchAudience, resolveDocsSearchFilters, resolveSearchRequestConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLocale, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, 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, resolveDocsMcpConfig, resolveConfiguredAgentSkills, serializeDocsIconRegistry, serializeOpenDocsProviders, } from "@farming-labs/docs/server";
33
+ import { applySidebarFolderIndexBehavior, buildDocsAskAIContext, buildDocsSearchFacets, buildDocsAgentDiscoverySpec, buildDocsConfigMap, buildDocsDiagnostics, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsStandardsDiscoveryResponse, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createDocsAgentTraceContext, createDocsAgentTraceId, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, findDocsMarkdownPage, getDocsLlmsTxtMaxCharsIssue, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsAgentDiscoveryRequest, isDocsContentChangesRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsSkillRequest, normalizeDocsRelated, normalizePageAgentFrontmatter, 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, 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";
38
38
  function isApiReferenceOpenApiRequest(url) {
39
39
  return url.searchParams.get("format")?.trim() === "openapi";
40
40
  }
41
- function resolveApiReferenceOpenApiDiscovery(value) {
42
- const apiReference = resolveApiReferenceConfig(value);
43
- if (!apiReference.enabled)
44
- return { enabled: false };
45
- return {
46
- enabled: true,
47
- url: "/api/docs?format=openapi",
48
- urlSource: "default",
49
- source: apiReference.specUrl ? "configured" : "generated",
50
- specUrl: apiReference.specUrl,
51
- apiReferencePath: `/${apiReference.path}`,
52
- };
53
- }
54
41
  function resolveAIModelAndProvider(aiConfig, requestedModelId) {
55
42
  const raw = aiConfig.model;
56
43
  const modelList = (typeof raw === "object" && raw?.models) || [];
@@ -648,6 +635,10 @@ export function createDocsServer(config = {}) {
648
635
  const llmsTxtConfig = config.llmsTxt;
649
636
  const llmsBaseUrl = typeof llmsTxtConfig === "object" ? (llmsTxtConfig.baseUrl ?? "") : "";
650
637
  const markdownMetadataBaseUrl = resolveDocsMetadataBaseUrl(config);
638
+ const contentChangesConfig = resolveDocsContentChangesConfig(config.agent?.contentChanges, {
639
+ staticExport: config.staticExport === true,
640
+ });
641
+ const contentChangeFeed = createDocsContentChangeFeed(config.agent?.contentChanges);
651
642
  const llmsTitle = typeof llmsTxtConfig === "object" ? (llmsTxtConfig.siteTitle ?? llmsSiteTitle) : llmsSiteTitle;
652
643
  const llmsDesc = typeof llmsTxtConfig === "object" ? llmsTxtConfig.siteDescription : undefined;
653
644
  const llmsEnabled = llmsTxtConfig !== false &&
@@ -732,6 +723,7 @@ export function createDocsServer(config = {}) {
732
723
  apiCatalog: apiCatalogEnabled,
733
724
  i18n,
734
725
  search: config.search,
726
+ contentChanges: contentChangesConfig.enabled,
735
727
  mcp: mcpConfig,
736
728
  feedback: agentFeedbackDiscovery,
737
729
  llms: {
@@ -827,6 +819,22 @@ export function createDocsServer(config = {}) {
827
819
  },
828
820
  });
829
821
  }
822
+ if (isDocsContentChangesRequest(event.url)) {
823
+ if (!contentChangesConfig.enabled) {
824
+ return new Response("Not Found", {
825
+ status: 404,
826
+ headers: { "Content-Type": "text/plain; charset=utf-8", "X-Robots-Tag": "noindex" },
827
+ });
828
+ }
829
+ return createDocsContentChangesHttpResponse({
830
+ request: event.request,
831
+ feed: contentChangeFeed,
832
+ pages: getSearchIndex(ctx),
833
+ search: config.search,
834
+ locale: ctx.locale,
835
+ baseUrl: markdownMetadataBaseUrl || event.url.origin,
836
+ });
837
+ }
830
838
  if (isApiReferenceOpenApiRequest(event.url)) {
831
839
  if (!openapiDiscovery.enabled) {
832
840
  return new Response("Not Found", {
@@ -993,9 +1001,18 @@ export function createDocsServer(config = {}) {
993
1001
  }
994
1002
  const query = event.url.searchParams.get("query")?.trim();
995
1003
  const audience = resolveDocsSearchAudience(event.url.searchParams.get("audience"));
996
- const filters = resolveDocsSearchFilters(event.url.searchParams);
997
- const structured = event.url.searchParams.get("response") === "structured";
998
- if (!query && !structured) {
1004
+ let searchRequest;
1005
+ try {
1006
+ searchRequest = resolveDocsSearchRequest(event.url.searchParams);
1007
+ }
1008
+ catch (error) {
1009
+ const searchError = resolveDocsSearchError(error);
1010
+ if (!searchError)
1011
+ throw error;
1012
+ return Response.json({ error: searchError }, { status: 400 });
1013
+ }
1014
+ const { filters, structured, facets, facet, cursor, limit } = searchRequest;
1015
+ if (!query && !structured && !facets) {
999
1016
  return new Response("[]", {
1000
1017
  headers: { "Content-Type": "application/json" },
1001
1018
  });
@@ -1011,24 +1028,44 @@ export function createDocsServer(config = {}) {
1011
1028
  siteTitle: llmsTitle,
1012
1029
  baseUrl: markdownMetadataBaseUrl || event.url.origin,
1013
1030
  syncBaseUrl: markdownMetadataBaseUrl ?? null,
1031
+ facet,
1032
+ cursor,
1033
+ limit,
1014
1034
  };
1015
- if (!query) {
1016
- const searchResponse = structured ? await performDocsSearchWithMetadata(searchOptions) : [];
1017
- return new Response(JSON.stringify(searchResponse), {
1018
- headers: { "Content-Type": "application/json" },
1035
+ const searchStartedAt = Date.now();
1036
+ let searchResponse;
1037
+ try {
1038
+ searchResponse = facets
1039
+ ? await buildDocsSearchFacets(searchOptions)
1040
+ : structured
1041
+ ? await performDocsSearchWithMetadata(searchOptions)
1042
+ : query
1043
+ ? await performDocsSearch(searchOptions)
1044
+ : [];
1045
+ }
1046
+ catch (error) {
1047
+ const searchError = resolveDocsSearchError(error);
1048
+ if (!searchError)
1049
+ throw error;
1050
+ return Response.json({ error: searchError }, { status: 400 });
1051
+ }
1052
+ if (facets) {
1053
+ return Response.json(searchResponse, {
1054
+ headers: { "Cache-Control": "public, max-age=60, stale-while-revalidate=300" },
1019
1055
  });
1020
1056
  }
1021
- const searchStartedAt = Date.now();
1022
- const searchResponse = structured
1023
- ? await performDocsSearchWithMetadata(searchOptions)
1024
- : await performDocsSearch(searchOptions);
1057
+ if (!query) {
1058
+ return Response.json(searchResponse);
1059
+ }
1025
1060
  const resultCount = Array.isArray(searchResponse)
1026
1061
  ? searchResponse.length
1027
- : searchResponse.resultCount;
1062
+ : "resultCount" in searchResponse
1063
+ ? searchResponse.resultCount
1064
+ : searchResponse.matchedPageCount;
1028
1065
  await emitDocsAnalyticsEvent(analytics, {
1029
1066
  type: "api_search",
1030
1067
  source: "server",
1031
- url: event.request.url,
1068
+ url: `${event.url.origin}${event.url.pathname}`,
1032
1069
  path: event.url.pathname,
1033
1070
  locale: ctx.locale,
1034
1071
  input: { query },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farming-labs/svelte",
3
- "version": "0.2.75",
3
+ "version": "0.2.78",
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.75"
60
+ "@farming-labs/docs": "0.2.78"
61
61
  },
62
62
  "peerDependencies": {
63
63
  "@farming-labs/docs": ">=0.2.73"
@@ -1,26 +0,0 @@
1
- import type { ApiReferenceConfig, DocsConfig } from "./types.js";
2
- type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
3
- export type ApiReferenceFramework = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt";
4
- export interface ApiReferenceRoute {
5
- title: string;
6
- summary: string;
7
- description?: string;
8
- routePath: string;
9
- sourceFile: string;
10
- methods: HttpMethod[];
11
- tag: string;
12
- parameters: Array<Record<string, unknown>>;
13
- }
14
- interface BuildApiReferenceOptions {
15
- framework: ApiReferenceFramework;
16
- rootDir?: string;
17
- }
18
- interface BuildApiReferenceHtmlOptions extends BuildApiReferenceOptions {
19
- title?: string;
20
- }
21
- export declare function resolveApiReferenceConfig(value: DocsConfig["apiReference"]): Required<ApiReferenceConfig>;
22
- export declare function buildApiReferencePageTitle(config: DocsConfig, title?: string): string;
23
- export declare function buildApiReferenceScalarCss(config: DocsConfig): string;
24
- export declare function buildApiReferenceOpenApiDocument(config: DocsConfig, options: BuildApiReferenceOptions): Record<string, unknown>;
25
- export declare function buildApiReferenceHtmlDocument(config: DocsConfig, options: BuildApiReferenceHtmlOptions): string;
26
- export {};