From 1f6df5aad4bbacc3549f3a65af52b4348b4214d1 Mon Sep 17 00:00:00 2001 From: amitbardos Date: Sun, 18 Oct 2026 16:13:31 +0300 Subject: [PATCH 1/3] docs(platform): add @base44/platform/react to the Mintlify reference The reference entry now re-exports /react beside the client and server, so the pipeline builds its pages from the JSDoc like the rest of the package: useBase44Chat (with its options and return types), Base44ChatBackend, ChatItem (with ChatStep and ChatAnswer) and ChatQuestion (with each kind). - The client also exports a generated SecretField, a socket shape no page shows; the reference documents the React one and marks the generated one as intentionally not exported. - Two JSDoc links pointed at a member of Base44Chat, which has no page of its own once appended to useBase44Chat; they link to the hook now. Co-Authored-By: Claude Opus 5.5 --- .../appended-articles.json | 23 +++++++++++++++++++ .../mintlify-post-processing/reference.ts | 8 +++++-- .../types-to-expose.json | 18 +++++++++++++++ packages/platform/src/react/chat.types.ts | 6 ++--- packages/platform/typedoc.mintlify.json | 3 ++- 5 files changed, 52 insertions(+), 6 deletions(-) diff --git a/packages/platform/scripts/mintlify-post-processing/appended-articles.json b/packages/platform/scripts/mintlify-post-processing/appended-articles.json index 20874f6d..16f06950 100644 --- a/packages/platform/scripts/mintlify-post-processing/appended-articles.json +++ b/packages/platform/scripts/mintlify-post-processing/appended-articles.json @@ -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" ] } diff --git a/packages/platform/scripts/mintlify-post-processing/reference.ts b/packages/platform/scripts/mintlify-post-processing/reference.ts index 265db4ce..bcdd7a3d 100644 --- a/packages/platform/scripts/mintlify-post-processing/reference.ts +++ b/packages/platform/scripts/mintlify-post-processing/reference.ts @@ -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"; diff --git a/packages/platform/scripts/mintlify-post-processing/types-to-expose.json b/packages/platform/scripts/mintlify-post-processing/types-to-expose.json index 886ab129..38f80e7d 100644 --- a/packages/platform/scripts/mintlify-post-processing/types-to-expose.json +++ b/packages/platform/scripts/mintlify-post-processing/types-to-expose.json @@ -1,12 +1,30 @@ [ "AppErrorCode", + "ApprovalDetails", + "ApprovalQuestion", + "Base44App", + "Base44Chat", + "Base44ChatBackend", + "Base44ChatOptions", "BuilderModule", "BuilderSession", + "ChatAnswer", + "ChatConnection", + "ChatError", + "ChatItem", + "ChatQuestion", + "ChatStatus", + "ChatStep", + "ChoiceEntry", + "ChoiceQuestion", "PlatformEvent", "PlatformSnapshot", "PlatformSocketError", + "SecretField", + "SecretsQuestion", "SessionErrorCode", "SocketSession", + "ToolCallAnswer", "UnknownWebhookEvent", "WebhookConfigurationError", "WebhookConfigurationErrorCode", diff --git a/packages/platform/src/react/chat.types.ts b/packages/platform/src/react/chat.types.ts index 9c0eb515..a700a802 100644 --- a/packages/platform/src/react/chat.types.ts +++ b/packages/platform/src/react/chat.types.ts @@ -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 @@ -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; diff --git a/packages/platform/typedoc.mintlify.json b/packages/platform/typedoc.mintlify.json index 521bd2c3..871d47bb 100644 --- a/packages/platform/typedoc.mintlify.json +++ b/packages/platform/typedoc.mintlify.json @@ -15,5 +15,6 @@ "maxTypeConversionDepth": 3, "hideBreadcrumbs": true, "disableSources": true, - "hidePageTitle": true + "hidePageTitle": true, + "intentionallyNotExported": ["src/client/modules/builder.events.generated.ts:SecretField"] } From 1fa87b4dfe64bfd111d124a931c89c887ae34b0f Mon Sep 17 00:00:00 2001 From: amitbardos Date: Mon, 19 Oct 2026 17:33:49 +0300 Subject: [PATCH 2/3] chore(platform): keep types-to-expose sorted after the merge Co-Authored-By: Claude Opus 5.5 --- .../scripts/mintlify-post-processing/types-to-expose.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/platform/scripts/mintlify-post-processing/types-to-expose.json b/packages/platform/scripts/mintlify-post-processing/types-to-expose.json index dcfc7bd1..97a7e8e3 100644 --- a/packages/platform/scripts/mintlify-post-processing/types-to-expose.json +++ b/packages/platform/scripts/mintlify-post-processing/types-to-expose.json @@ -6,13 +6,13 @@ "Base44Chat", "Base44ChatBackend", "Base44ChatOptions", - "ChatModule", - "ChatSession", "ChatAnswer", "ChatConnection", "ChatError", "ChatItem", + "ChatModule", "ChatQuestion", + "ChatSession", "ChatStatus", "ChatStep", "ChoiceEntry", From e7d4a015b05f897cb6ac0e89377f0581ee274b3e Mon Sep 17 00:00:00 2001 From: amitbardos Date: Mon, 19 Oct 2026 17:34:13 +0300 Subject: [PATCH 3/3] chore(platform): point typedoc at the renamed chat.events.generated.ts Co-Authored-By: Claude Opus 5.5 --- packages/platform/typedoc.mintlify.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/platform/typedoc.mintlify.json b/packages/platform/typedoc.mintlify.json index 871d47bb..30e709be 100644 --- a/packages/platform/typedoc.mintlify.json +++ b/packages/platform/typedoc.mintlify.json @@ -16,5 +16,5 @@ "hideBreadcrumbs": true, "disableSources": true, "hidePageTitle": true, - "intentionallyNotExported": ["src/client/modules/builder.events.generated.ts:SecretField"] + "intentionallyNotExported": ["src/client/modules/chat.events.generated.ts:SecretField"] }