Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,28 @@
],
"classes/WebhookConfigurationError": [
"type-aliases/WebhookConfigurationErrorCode"
],
"functions/useBase44Chat": [
"interfaces/Base44ChatOptions",
"interfaces/Base44Chat",
"type-aliases/ChatStatus",
"type-aliases/ChatConnection",
"interfaces/ChatError"
],
"interfaces/Base44ChatBackend": [
"interfaces/Base44App",
"interfaces/ToolCallAnswer"
],
"interfaces/ChatItem": [
"interfaces/ChatStep",
"interfaces/ChatAnswer"
],
"type-aliases/ChatQuestion": [
"interfaces/ChoiceQuestion",
"interfaces/ChoiceEntry",
"interfaces/SecretsQuestion",
"interfaces/SecretField",
"interfaces/ApprovalQuestion",
"interfaces/ApprovalDetails"
]
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// Entry point for the Mintlify reference only, not part of the package. Re-exports the client and
// server entrypoints as one flat module, which is the layout the post-processing expects.
// Entry point for the Mintlify reference only, not part of the package. Re-exports the client,
// server and React entrypoints as one flat module, which is the layout the post-processing expects.
export * from "../../src/client/index.js";
export * from "../../src/server/index.js";
export * from "../../src/react/index.js";
// The client also exports a generated SecretField (a socket shape no page shows); the reference
// documents the React one, which partners use.
export type { SecretField } from "../../src/react/index.js";
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
[
"AppErrorCode",
"ApprovalDetails",
"ApprovalQuestion",
"Base44App",
"Base44Chat",
"Base44ChatBackend",
"Base44ChatOptions",
"ChatAnswer",
"ChatConnection",
"ChatError",
"ChatItem",
"ChatModule",
"ChatQuestion",
"ChatSession",
"ChatStatus",
"ChatStep",
"ChoiceEntry",
"ChoiceQuestion",
"PlatformEvent",
"PlatformSnapshot",
"PlatformSocketError",
"SecretField",
"SecretsQuestion",
"SessionErrorCode",
"SocketSession",
"ToolCallAnswer",
"UnknownWebhookEvent",
"WebhookConfigurationError",
"WebhookConfigurationErrorCode",
Expand Down
6 changes: 3 additions & 3 deletions packages/platform/src/react/chat.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface ToolCallAnswer {
*
* Base44 keeps the Send chat message and Submit tool-call input requests open until the AI
* finishes the turn. Resolve your call once Base44 accepts the request, not when it returns. The
* chat follows the rest live. A rejected promise from any call sets {@link Base44Chat.error}.
* chat follows the rest live. A rejected promise from any call sets `error` on the {@link useBase44Chat | chat}.
*
* @example
* ```typescript
Expand Down Expand Up @@ -148,10 +148,10 @@ export interface ChatAnswer {
* An open question, with the actions that answer this question and no other.
*
* Each kind carries only the actions that make sense for it, and every kind can be declined. The
* actions never throw. A failure sets {@link Base44Chat.error}, and the question opens again.
* actions never throw. A failure sets `error` on the {@link useBase44Chat | chat}, and the question opens again.
*
* The chat declines a question kind this release doesn't know, once per tool call, when Base44
* names that kind on the last assistant message. If the decline fails, {@link Base44Chat.error} says
* names that kind on the last assistant message. If the decline fails, the chat's `error` says
* so, and the chat tries again after it reconnects.
*/
export type ChatQuestion = ChoiceQuestion | SecretsQuestion | ApprovalQuestion;
Expand Down
3 changes: 2 additions & 1 deletion packages/platform/typedoc.mintlify.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
"maxTypeConversionDepth": 3,
"hideBreadcrumbs": true,
"disableSources": true,
"hidePageTitle": true
"hidePageTitle": true,
"intentionallyNotExported": ["src/client/modules/chat.events.generated.ts:SecretField"]
}
Loading