From e3daa4526f3cf363ab7c9bef49e4d10606c04b53 Mon Sep 17 00:00:00 2001 From: danielle korn Date: Sun, 6 Sep 2026 11:23:25 +0300 Subject: [PATCH] fix(docs): repair two rendering defects in the SDK reference 1. Four auth examples and two integrations examples lost their first line of code. The pipeline promotes a leading // comment to the Mintlify code-block title, and an example without one has its first real line consumed instead. inviteUser, resetPasswordRequest, resetPassword and changePassword each published a try block with no try, and an orphaned closing brace. These six are live on the site today. Each now opens with a comment that describes the example. 2. connectors.callApi() published its query parameter as Record. TypeDoc truncates long inline unions, so the union is given a name, ConnectorApiQueryValue, and appended into the connectors page. It renders as Record with the definition alongside the method. Both fix the cause. Neither touches the post-processing pipeline. --- scripts/mintlify-post-processing/appended-articles.json | 5 ++++- scripts/mintlify-post-processing/types-to-expose.json | 3 ++- src/modules/auth.types.ts | 4 ++++ src/modules/connectors.types.ts | 9 ++++++++- src/modules/integrations.types.ts | 2 ++ 5 files changed, 20 insertions(+), 3 deletions(-) diff --git a/scripts/mintlify-post-processing/appended-articles.json b/scripts/mintlify-post-processing/appended-articles.json index 37180997..f9c0df98 100644 --- a/scripts/mintlify-post-processing/appended-articles.json +++ b/scripts/mintlify-post-processing/appended-articles.json @@ -4,10 +4,13 @@ "interfaces/ConnectorIntegrationTypeRegistry", "interfaces/UserConnectorsModule", "interfaces/ConnectorApiRequest", + "type-aliases/ConnectorApiQueryValue", "interfaces/ConnectorApiResponse", "type-aliases/ConnectorApiResponsePhase" ], - "interfaces/AppModule": ["interfaces/AppPublicSettingsResponse"], + "interfaces/AppModule": [ + "interfaces/AppPublicSettingsResponse" + ], "type-aliases/EntitiesModule": [ "interfaces/EntityHandler", "type-aliases/EntityRecord", diff --git a/scripts/mintlify-post-processing/types-to-expose.json b/scripts/mintlify-post-processing/types-to-expose.json index 5d7ef016..72a30f7d 100644 --- a/scripts/mintlify-post-processing/types-to-expose.json +++ b/scripts/mintlify-post-processing/types-to-expose.json @@ -9,12 +9,14 @@ "AppModule", "AppPublicSettingsResponse", "AuthModule", + "ConnectorApiQueryValue", "ConnectorApiRequest", "ConnectorApiResponse", "ConnectorApiResponsePhase", "ConnectorIntegrationType", "ConnectorIntegrationTypeRegistry", "ConnectorsModule", + "CoreIntegrations", "CustomIntegrationsModule", "DeleteManyResult", "DeleteResult", @@ -27,7 +29,6 @@ "FunctionsModule", "ImportResult", "IntegrationsModule", - "CoreIntegrations", "SortField", "SsoModule", "UpdateManyResult" diff --git a/src/modules/auth.types.ts b/src/modules/auth.types.ts index 0f95a8a1..f0b0a528 100644 --- a/src/modules/auth.types.ts +++ b/src/modules/auth.types.ts @@ -357,6 +357,7 @@ export interface AuthModule { * * @example * ```typescript + * // Invite a user and handle failure * try { * await base44.auth.inviteUser('newuser@example.com', 'user'); * console.log('Invitation sent successfully!'); @@ -491,6 +492,7 @@ export interface AuthModule { * * @example * ```typescript + * // Request a password reset email * try { * await base44.auth.resetPasswordRequest('user@example.com'); * console.log('Password reset email sent!'); @@ -513,6 +515,7 @@ export interface AuthModule { * * @example * ```typescript + * // Complete a password reset with the emailed token * try { * await base44.auth.resetPassword({ * resetToken: 'token-from-email', @@ -538,6 +541,7 @@ export interface AuthModule { * * @example * ```typescript + * // Change the password for a signed-in user * try { * await base44.auth.changePassword({ * userId: 'user-123', diff --git a/src/modules/connectors.types.ts b/src/modules/connectors.types.ts index 2f8b67c4..4f8c796d 100644 --- a/src/modules/connectors.types.ts +++ b/src/modules/connectors.types.ts @@ -64,6 +64,13 @@ export type ConnectorApiResponsePhase = /** * A request to forward to a metered connector's API through the Base44 proxy. */ +/** A value acceptable as a query parameter on {@link ConnectorApiRequest.query}. */ +export type ConnectorApiQueryValue = + | string + | number + | boolean + | Array; + export interface ConnectorApiRequest { /** HTTP method for the upstream request. Defaults to `'GET'`. */ method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD"; @@ -81,7 +88,7 @@ export interface ConnectorApiRequest { */ path: string; /** Query parameters. Merged into the request URL alongside any already present in {@link path}. */ - query?: Record>; + query?: Record; /** Extra request headers. Only headers the connector explicitly allows are forwarded; the rest are dropped. */ headers?: Record; /** JSON request body. Ignored for `GET` and `HEAD`. */ diff --git a/src/modules/integrations.types.ts b/src/modules/integrations.types.ts index c4f37fa7..1b6c0b49 100644 --- a/src/modules/integrations.types.ts +++ b/src/modules/integrations.types.ts @@ -401,6 +401,7 @@ export type IntegrationsModule = { * * @example * ```typescript + * // Summarise text with an LLM * const response = await base44.integrations.Core.InvokeLLM({ * prompt: 'Explain quantum computing', * model: 'gpt_5' @@ -414,6 +415,7 @@ export type IntegrationsModule = { * * @example * ```typescript + * // Call a custom integration endpoint * const result = await base44.integrations.custom.call( * 'github', * 'get:/repos/{owner}/{repo}',