@vercel/geistdocs 2.7.10 → 2.9.0

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.
Files changed (128) hide show
  1. package/dist/assets/icons/icon-fullscreen-close.d.ts +26 -0
  2. package/dist/assets/icons/icon-fullscreen-close.d.ts.map +1 -0
  3. package/dist/assets/icons/icon-fullscreen-close.js +25 -0
  4. package/dist/assets/icons/icon-fullscreen.d.ts +26 -0
  5. package/dist/assets/icons/icon-fullscreen.d.ts.map +1 -0
  6. package/dist/assets/icons/icon-fullscreen.js +25 -0
  7. package/dist/assets/icons/icon-thumb-down.d.ts +26 -0
  8. package/dist/assets/icons/icon-thumb-down.d.ts.map +1 -0
  9. package/dist/assets/icons/icon-thumb-down.js +25 -0
  10. package/dist/assets/icons/index.d.ts +3 -0
  11. package/dist/assets/icons/index.d.ts.map +1 -1
  12. package/dist/assets/icons/index.js +3 -0
  13. package/dist/cli/index.js +1 -1
  14. package/dist/config.d.ts +67 -3
  15. package/dist/config.d.ts.map +1 -1
  16. package/dist/controls.d.ts +23 -1
  17. package/dist/controls.d.ts.map +1 -1
  18. package/dist/controls.js +44 -3
  19. package/dist/footer.js +1 -1
  20. package/dist/internal/chat/activity.d.ts +5 -1
  21. package/dist/internal/chat/activity.d.ts.map +1 -1
  22. package/dist/internal/chat/activity.js +11 -4
  23. package/dist/internal/chat/chat-user.d.ts +12 -0
  24. package/dist/internal/chat/chat-user.d.ts.map +1 -0
  25. package/dist/internal/chat/chat-user.js +27 -0
  26. package/dist/internal/chat/commands.d.ts +91 -0
  27. package/dist/internal/chat/commands.d.ts.map +1 -0
  28. package/dist/internal/chat/commands.js +165 -0
  29. package/dist/internal/chat/context.d.ts +49 -2
  30. package/dist/internal/chat/context.d.ts.map +1 -1
  31. package/dist/internal/chat/context.js +57 -4
  32. package/dist/internal/chat/message-actions.d.ts +15 -0
  33. package/dist/internal/chat/message-actions.d.ts.map +1 -0
  34. package/dist/internal/chat/message-actions.js +113 -0
  35. package/dist/internal/chat/message-feedback.d.ts +68 -0
  36. package/dist/internal/chat/message-feedback.d.ts.map +1 -0
  37. package/dist/internal/chat/message-feedback.js +188 -0
  38. package/dist/internal/chat/message-metadata.d.ts.map +1 -1
  39. package/dist/internal/chat/message-metadata.js +7 -1
  40. package/dist/internal/chat/message-text.d.ts +9 -0
  41. package/dist/internal/chat/message-text.d.ts.map +1 -0
  42. package/dist/internal/chat/message-text.js +15 -0
  43. package/dist/internal/chat/message.d.ts +4 -2
  44. package/dist/internal/chat/message.d.ts.map +1 -1
  45. package/dist/internal/chat/message.js +8 -1
  46. package/dist/internal/chat/options.d.ts +94 -0
  47. package/dist/internal/chat/options.d.ts.map +1 -0
  48. package/dist/internal/chat/options.js +171 -0
  49. package/dist/internal/chat/page-attachment.d.ts +12 -0
  50. package/dist/internal/chat/page-attachment.d.ts.map +1 -0
  51. package/dist/internal/chat/page-attachment.js +18 -0
  52. package/dist/internal/chat/session-provider.d.ts +33 -0
  53. package/dist/internal/chat/session-provider.d.ts.map +1 -0
  54. package/dist/internal/chat/session-provider.js +138 -0
  55. package/dist/internal/chat/session.d.ts +60 -0
  56. package/dist/internal/chat/session.d.ts.map +1 -0
  57. package/dist/internal/chat/session.js +85 -0
  58. package/dist/internal/chat/shell.d.ts.map +1 -1
  59. package/dist/internal/chat/shell.js +86 -157
  60. package/dist/internal/chat/use-chat-commands.d.ts +28 -0
  61. package/dist/internal/chat/use-chat-commands.d.ts.map +1 -0
  62. package/dist/internal/chat/use-chat-commands.js +62 -0
  63. package/dist/internal/chat/user-avatar.d.ts +7 -0
  64. package/dist/internal/chat/user-avatar.d.ts.map +1 -0
  65. package/dist/internal/chat/user-avatar.js +27 -0
  66. package/dist/internal/eve-agent-session-cookie.d.ts +68 -0
  67. package/dist/internal/eve-agent-session-cookie.d.ts.map +1 -0
  68. package/dist/internal/eve-agent-session-cookie.js +164 -0
  69. package/dist/internal/eve-agent-session.d.ts +9 -7
  70. package/dist/internal/eve-agent-session.d.ts.map +1 -1
  71. package/dist/internal/eve-agent-session.js +10 -13
  72. package/dist/internal/eve-agent.d.ts +96 -24
  73. package/dist/internal/eve-agent.d.ts.map +1 -1
  74. package/dist/internal/eve-agent.js +74 -51
  75. package/dist/internal/feedback-action.d.ts +14 -0
  76. package/dist/internal/feedback-action.d.ts.map +1 -1
  77. package/dist/internal/feedback-action.js +37 -5
  78. package/dist/internal/mdx-to-markdown.d.ts.map +1 -1
  79. package/dist/internal/mdx-to-markdown.js +226 -19
  80. package/dist/internal/page-actions-client.d.ts +9 -0
  81. package/dist/internal/page-actions-client.d.ts.map +1 -1
  82. package/dist/internal/page-actions-client.js +8 -4
  83. package/dist/internal/provider-client.d.ts.map +1 -1
  84. package/dist/internal/provider-client.js +10 -4
  85. package/dist/internal/use-mobile.d.ts +7 -0
  86. package/dist/internal/use-mobile.d.ts.map +1 -1
  87. package/dist/internal/use-mobile.js +17 -1
  88. package/dist/internal/webmcp-client.d.ts.map +1 -1
  89. package/dist/internal/webmcp-client.js +13 -3
  90. package/dist/internal/webmcp.d.ts +5 -1
  91. package/dist/internal/webmcp.d.ts.map +1 -1
  92. package/dist/internal/webmcp.js +31 -1
  93. package/dist/pages/changelog.d.ts.map +1 -1
  94. package/dist/pages/changelog.js +4 -0
  95. package/dist/pages/docs.d.ts.map +1 -1
  96. package/dist/pages/docs.js +2 -0
  97. package/dist/routes/chat.d.ts +83 -5
  98. package/dist/routes/chat.d.ts.map +1 -1
  99. package/dist/routes/chat.js +517 -80
  100. package/dist/routes/discovery.d.ts +1 -1
  101. package/dist/routes/discovery.d.ts.map +1 -1
  102. package/dist/routes/discovery.js +7 -11
  103. package/dist/routes/openapi.d.ts.map +1 -1
  104. package/dist/routes/openapi.js +47 -25
  105. package/docs/agents.md +3 -3
  106. package/docs/llms.txt +634 -37
  107. package/docs/manifest.json +3 -3
  108. package/docs/pages/agent-readiness.md +1 -1
  109. package/docs/pages/ask-ai.md +570 -26
  110. package/docs/pages/configuration.md +21 -1
  111. package/docs/pages/env.md +17 -3
  112. package/docs/pages/feedback.md +4 -0
  113. package/docs/pages/webmcp.md +18 -3
  114. package/docs/sitemap.md +1 -1
  115. package/package.json +1 -2
  116. package/template/.env.example +5 -0
  117. package/template/AGENTS.md +2 -0
  118. package/template/content/docs/agent-readiness.mdx +1 -1
  119. package/template/content/docs/ask-ai.cn.mdx +466 -15
  120. package/template/content/docs/ask-ai.mdx +570 -26
  121. package/template/content/docs/configuration.cn.mdx +39 -0
  122. package/template/content/docs/configuration.mdx +21 -1
  123. package/template/content/docs/env.cn.mdx +15 -1
  124. package/template/content/docs/env.mdx +18 -4
  125. package/template/content/docs/feedback.cn.mdx +4 -0
  126. package/template/content/docs/feedback.mdx +4 -0
  127. package/template/content/docs/webmcp.mdx +18 -3
  128. package/template/package.json +1 -2
@@ -4,23 +4,96 @@ import { type ChatMixedbreadOptions } from "../internal/chat-retrieval";
4
4
  import { type GeistdocsPageFilter } from "../page-visibility";
5
5
  import type { GeistdocsSourceBundle } from "../source";
6
6
  type SourceBundle = GeistdocsSourceBundle;
7
+ /**
8
+ * Headers for upstream requests: a static value, or a function that receives
9
+ * the incoming chat `Request` (for per-request values) and may be async.
10
+ */
11
+ type ChatUpstreamHeaders = HeadersInit | ((request: Request) => HeadersInit | Promise<HeadersInit>);
7
12
  interface ChatProxyConfig {
8
- headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
13
+ headers?: ChatUpstreamHeaders;
9
14
  url: string;
10
15
  }
16
+ /**
17
+ * What proxy and eve agent modes add to the message they forward.
18
+ * - `"auto"`: on the first user message, the attached page (or the page at
19
+ * `currentRoute`) excerpt plus related docs from retrieval, emitted as
20
+ * source citations.
21
+ * - `"page-only"`: only a page the request attaches with `pageContext`, in
22
+ * full, and no citations; every other message is forwarded as sent.
23
+ */
24
+ type ChatContextInjection = "auto" | "page-only";
11
25
  interface ChatEveAgentOptions {
26
+ /**
27
+ * Send eve's turn-scoped `clientContext: { currentPage: { url, title } }`
28
+ * with every message, including the message that starts a replacement
29
+ * session; prewarm requests carry no message, so they never send it.
30
+ * `url` is the absolute public URL of `currentRoute`
31
+ * (on `config.siteUrl`, or the request origin); `title` is included when
32
+ * the route is a page Ask AI may see. @default false
33
+ */
34
+ clientContext?: boolean;
12
35
  /**
13
36
  * Extra headers for requests to the eve agent, replacing the default
14
37
  * `Authorization: Bearer <Vercel OIDC token>` when an `authorization`
15
- * header is provided. Accepts an async function for per-request tokens.
38
+ * header is provided. A function receives the incoming chat `Request` and
39
+ * may be async, for per-request tokens or forwarded values.
16
40
  * Server-only: never expose auth material through `geistdocs.tsx`.
17
41
  */
18
- headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
42
+ headers?: ChatUpstreamHeaders;
43
+ /**
44
+ * Secret used to sign the httpOnly cookie that binds a browser to its eve
45
+ * session. Defaults to the `GEISTDOCS_CHAT_SECRET` environment variable
46
+ * and must be at least 32 bytes (`openssl rand -base64 32`). Without a
47
+ * secret, every turn starts a fresh eve session with the conversation
48
+ * inlined, and prewarm requests are refused. Server-only.
49
+ */
50
+ secret?: string;
51
+ /**
52
+ * Forward the agent's tool outputs to the client and show the URLs found
53
+ * in them as source citations. When `false`, tool calls still show as
54
+ * activity, but their outputs reach the client as `null` and produce no
55
+ * citations. @default true
56
+ */
57
+ toolCitations?: boolean;
19
58
  /** Overrides `config.ai.eveAgent.url` (e.g. for a staging agent). */
20
59
  url?: string;
60
+ /**
61
+ * Names of the agent tools whose calls the client sees. Calls to any
62
+ * other tool, with their results and citations, are not forwarded.
63
+ * Omit to forward every tool call.
64
+ */
65
+ visibleTools?: string[];
66
+ }
67
+ interface ChatRequestLimits {
68
+ /**
69
+ * Most messages accepted in one request. Larger requests receive 400.
70
+ * @default 200
71
+ */
72
+ maxMessages?: number;
73
+ /**
74
+ * Longest legacy `pageContext.content` accepted, in characters. Longer
75
+ * requests receive 400. Pages referenced by `pageContext.url` alone are
76
+ * read from the site's sources and are not rejected; with
77
+ * `contextInjection: "page-only"`, their Markdown is truncated to this
78
+ * length before it is forwarded.
79
+ * @default 200_000
80
+ */
81
+ maxPageContextChars?: number;
82
+ /**
83
+ * Largest request body accepted, in bytes. Larger requests receive 413.
84
+ * @default 1_000_000
85
+ */
86
+ maxRequestBytes?: number;
21
87
  }
22
88
  interface CreateChatRouteOptions {
23
- config: Pick<GeistdocsConfig, "ai" | "basePath" | "defaultLanguage" | "siteId" | "translations">;
89
+ config: Pick<GeistdocsConfig, "ai" | "basePath" | "defaultLanguage" | "siteId" | "siteUrl" | "translations">;
90
+ /**
91
+ * Docs context proxy and eve agent modes add to forwarded messages.
92
+ * `"page-only"` forwards messages as sent unless the request attaches a
93
+ * page with `pageContext`. Ignored in the default AI Gateway mode, which
94
+ * retrieves docs with its own tools. @default "auto"
95
+ */
96
+ contextInjection?: ChatContextInjection;
24
97
  /**
25
98
  * Server-side options for the eve agent responder configured through
26
99
  * `config.ai.eveAgent`. Mutually exclusive with `proxy`.
@@ -28,6 +101,11 @@ interface CreateChatRouteOptions {
28
101
  eveAgent?: ChatEveAgentOptions;
29
102
  /** Narrows the stable public corpus available to Ask AI. */
30
103
  filterPage?: GeistdocsPageFilter;
104
+ /**
105
+ * Request size caps applied before any model, proxy, or agent call. Rate
106
+ * limiting is not included; wrap the route with your own.
107
+ */
108
+ limits?: ChatRequestLimits;
31
109
  /**
32
110
  * Server-only Mixedbread overrides. Environment variables are used when
33
111
  * these values are omitted.
@@ -45,7 +123,7 @@ interface CreateChatRouteOptions {
45
123
  source?: SourceBundle;
46
124
  sources?: SourceBundle[];
47
125
  }
48
- export declare const createChatRoute: ({ config, eveAgent, filterPage, mixedbread, model, proxy, source, sources, }: CreateChatRouteOptions) => {
126
+ export declare const createChatRoute: ({ config, contextInjection, eveAgent, filterPage, limits, mixedbread, model, proxy, source, sources, }: CreateChatRouteOptions) => {
49
127
  POST: (req: Request) => Promise<Response>;
50
128
  maxDuration: 800;
51
129
  };
@@ -1 +1 @@
1
- {"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/routes/chat.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,aAAa,EAQnB,MAAM,IAAI,CAAC;AAGZ,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,WAAW,CAAC;AAKhE,OAAO,EAEL,KAAK,qBAAqB,EAG3B,MAAM,4BAA4B,CAAC;AAUpC,OAAO,EACL,KAAK,mBAAmB,EAEzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,KAAK,YAAY,GAAG,qBAAqB,CAAC;AA0B1C,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,mBAAmB;IAC3B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,UAAU,sBAAsB;IAC9B,MAAM,EAAE,IAAI,CACV,eAAe,EACf,IAAI,GAAG,UAAU,GAAG,iBAAiB,GAAG,QAAQ,GAAG,cAAc,CAClE,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,4DAA4D;IAC5D,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B;AAy/BD,eAAO,MAAM,eAAe,GAAI,8EAS7B,sBAAsB;gBAeE,OAAO;;CAqLjC,CAAC"}
1
+ {"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/routes/chat.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,aAAa,EAQnB,MAAM,IAAI,CAAC;AAGZ,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,WAAW,CAAC;AAKhE,OAAO,EAEL,KAAK,qBAAqB,EAG3B,MAAM,4BAA4B,CAAC;AAyBpC,OAAO,EACL,KAAK,mBAAmB,EAEzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,KAAK,YAAY,GAAG,qBAAqB,CAAC;AA4B1C;;;GAGG;AACH,KAAK,mBAAmB,GACpB,WAAW,GACX,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;AAE/D,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;GAOG;AACH,KAAK,oBAAoB,GAAG,MAAM,GAAG,WAAW,CAAC;AAEjD,UAAU,mBAAmB;IAC3B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,UAAU,iBAAiB;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,sBAAsB;IAC9B,MAAM,EAAE,IAAI,CACV,eAAe,EACb,IAAI,GACJ,UAAU,GACV,iBAAiB,GACjB,QAAQ,GACR,SAAS,GACT,cAAc,CACjB,CAAC;IACF;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,4DAA4D;IAC5D,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B;AAwoDD,eAAO,MAAM,eAAe,GAAI,wGAW7B,sBAAsB;gBAqBE,OAAO;;CAiMjC,CAAC"}