@base44-preview/sdk 0.8.18-pr.70.4e2bede → 0.8.18-pr.76.8d342cf

package/dist/modules/connectors.types.d.ts

@@ -11,7 +11,9 @@ export interface ConnectorAccessTokenResponse {
 /**
  * Connectors module for managing OAuth tokens for external services.
  *
- * This module allows you to retrieve OAuth access tokens for external services that the app has connected to. Connectors are app-scoped. When an app builder connects an integration like Google Calendar or Slack, all users of the app share that same connection.
+ * This module allows you to retrieve OAuth access tokens for external services
+ * that the app has connected to. Use these tokens to make API
+ * calls to external services.
  *
  * Unlike the integrations module that provides pre-built functions, connectors give you
  * raw OAuth tokens so you can call external service APIs directly with full control over
@@ -24,9 +26,9 @@ export interface ConnectorsModule {
     /**
      * Retrieves an OAuth access token for a specific external integration type.
      *
-     * Returns the OAuth token string for an external service that an app builder
-     * has connected to. This token represents the connected app builder's account
-     * and can be used to make authenticated API calls to that external service on behalf of the app.
+     * Returns the OAuth token string for an external service that the app
+     * has connected to. You can then use this token to make authenticated API calls
+     * to that external service.
      *
      * @param integrationType - The type of integration, such as `'googlecalendar'`, `'slack'`, or `'github'`.
      * @returns Promise resolving to the access token string.

package/dist/modules/custom-integrations.types.d.ts

@@ -8,13 +8,18 @@ export interface CustomIntegrationCallParams {
      */
     payload?: Record<string, any>;
     /**
-     * Path parameters to substitute in the URL. For example, `{ owner: "user", repo: "repo" }`.
+     * Path parameters to substitute in the URL (e.g., `{ owner: "user", repo: "repo" }`).
      */
     pathParams?: Record<string, string>;
     /**
      * Query string parameters to append to the URL.
      */
     queryParams?: Record<string, any>;
+    /**
+     * Additional headers to send with this specific request.
+     * These are merged with the integration's configured headers.
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Response from a custom integration call.
@@ -36,17 +41,61 @@ export interface CustomIntegrationCallResponse {
     data: any;
 }
 /**
- * Module for calling custom pre-configured API integrations.
+ * Module for calling custom workspace-level API integrations.
+ *
+ * Custom integrations allow workspace administrators to connect any external API
+ * by importing an OpenAPI specification. Apps in the workspace can then call
+ * these integrations using this module.
+ *
+ * Unlike the built-in integrations (like `Core`), custom integrations:
+ * - Are defined per-workspace by importing OpenAPI specs
+ * - Use a slug-based identifier instead of package names
+ * - Proxy requests through Base44's backend (credentials never exposed to frontend)
+ *
+ * @example
+ * ```typescript
+ * // Call a custom GitHub integration
+ * const response = await base44.integrations.custom.call(
+ *   "github",                              // integration slug (defined by workspace admin)
+ *   "get:/repos/{owner}/{repo}/issues",   // endpoint in method:path format
+ *   {
+ *     pathParams: { owner: "myorg", repo: "myrepo" },
+ *     queryParams: { state: "open", per_page: 100 }
+ *   }
+ * );
  *
- * Custom integrations allow workspace administrators to connect any external API by importing an OpenAPI specification. Apps in the workspace can then call these integrations using this module.
+ * if (response.success) {
+ *   console.log("Issues:", response.data);
+ * } else {
+ *   console.error("API returned error:", response.status_code);
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Call with request body payload
+ * const response = await base44.integrations.custom.call(
+ *   "github",
+ *   "post:/repos/{owner}/{repo}/issues",
+ *   {
+ *     pathParams: { owner: "myorg", repo: "myrepo" },
+ *     payload: {
+ *       title: "Bug report",
+ *       body: "Something is broken",
+ *       labels: ["bug"]
+ *     }
+ *   }
+ * );
+ * ```
+ * @internal
  */
 export interface CustomIntegrationsModule {
     /**
      * Call a custom integration endpoint.
      *
-     * @param slug - The integration's unique identifier, as defined by the workspace admin.
-     * @param operationId - The endpoint in `method:path` format. For example, `"get:/contacts"`, or `"post:/users/{id}"`. The method is the HTTP verb in lowercase and the path matches the OpenAPI specification.
-     * @param params - Optional parameters including payload, pathParams, and queryParams.
+     * @param slug - The integration's unique identifier (slug), as defined by the workspace admin.
+     * @param operationId - The endpoint identifier in method:path format (e.g., "get:/repos/{owner}/{repo}/issues", "get:/users/{username}").
+     * @param params - Optional parameters including payload, pathParams, queryParams, and headers.
      * @returns Promise resolving to the integration call response.
      *
      * @throws {Error} If slug is not provided.
@@ -54,36 +103,6 @@ export interface CustomIntegrationsModule {
      * @throws {Base44Error} If the integration or operation is not found (404).
      * @throws {Base44Error} If the external API call fails (502).
      * @throws {Base44Error} If the request times out (504).
-     *
-     * @example
-     * ```typescript
-     * // Call a custom CRM integration
-     * const response = await base44.integrations.custom.call(
-     *   "my-crm",
-     *   "get:/contacts",
-     *   { queryParams: { limit: 10 } }
-     * );
-     *
-     * if (response.success) {
-     *   console.log("Contacts:", response.data);
-     * }
-     * ```
-     *
-     * @example
-     * ```typescript
-     * // Call with path params and request body
-     * const response = await base44.integrations.custom.call(
-     *   "github",
-     *   "post:/repos/{owner}/{repo}/issues",
-     *   {
-     *     pathParams: { owner: "myorg", repo: "myrepo" },
-     *     payload: {
-     *       title: "Bug report",
-     *       body: "Something is broken"
-     *     }
-     *   }
-     * );
-     * ```
      */
     call(slug: string, operationId: string, params?: CustomIntegrationCallParams): Promise<CustomIntegrationCallResponse>;
 }

package/dist/modules/entities.types.d.ts

@@ -1,11 +1,9 @@
 /**
  * Event types for realtime entity updates.
- * @internal
  */
 export type RealtimeEventType = "create" | "update" | "delete";
 /**
  * Payload received when a realtime event occurs.
- * @internal
  */
 export interface RealtimeEvent {
     /** The type of change that occurred */
@@ -19,7 +17,6 @@ export interface RealtimeEvent {
 }
 /**
  * Callback function invoked when a realtime event occurs.
- * @internal
  */
 export type RealtimeCallback = (event: RealtimeEvent) => void;
 /**
@@ -290,7 +287,6 @@ export interface EntityHandler {
      * // Later, clean up the subscription
      * unsubscribe();
      * ```
-     * @internal
      */
     subscribe(callback: RealtimeCallback): () => void;
 }

package/dist/modules/integrations.types.d.ts

@@ -320,28 +320,22 @@ export interface CoreIntegrations {
     CreateFileSignedUrl(params: CreateFileSignedUrlParams): Promise<CreateFileSignedUrlResult>;
 }
 /**
- * Integrations module for calling integration methods.
+ * Integrations module for calling integration endpoints.
  *
- * This module provides access to integration methods for interacting with external services. Unlike the connectors module that gives you raw OAuth tokens, integrations provide pre-built functions that Base44 executes on your behalf.
+ * This module provides access to integration endpoints for interacting with external
+ * services. Integrations are organized into packages. Base44 provides built-in integrations
+ * in the `Core` package.
  *
- * There are two types of integrations:
+ * Unlike the connectors module that gives you raw OAuth tokens, integrations provide
+ * pre-built functions that Base44 executes on your behalf.
  *
- * - **Built-in integrations** (`Core`): Pre-built functions provided by Base44 for common tasks such as AI-powered text generation, image creation, file uploads, and email. Access core integration methods using:
- *   ```
- *   base44.integrations.Core.FunctionName(params)
- *   ```
- *
- * - **Custom integrations** (`custom`): Pre-configured external APIs. Custom integration calls are proxied through Base44's backend, so credentials are never exposed to the frontend. Access custom integration methods using:
- *   ```
- *   base44.integrations.custom.call(slug, operationId, params)
- *   ```
- *
- *   <Info>To call a custom integration, it must be pre-configured by a workspace administrator who imports an OpenAPI specification.</Info>
+ * Integration endpoints are accessed dynamically using the pattern:
+ * `base44.integrations.PackageName.EndpointName(params)`
  *
  * This module is available to use with a client in all authentication modes:
  *
- * - **Anonymous or User authentication** (`base44.integrations`): Integration methods are invoked with the current user's permissions. Anonymous users invoke methods without authentication, while authenticated users invoke methods with their authentication context.
- * - **Service role authentication** (`base44.asServiceRole.integrations`): Integration methods are invoked with elevated admin-level permissions. The methods execute with admin authentication context.
+ * - **Anonymous or User authentication** (`base44.integrations`): Integration endpoints are invoked with the current user's permissions. Anonymous users invoke endpoints without authentication, while authenticated users invoke endpoints with their authentication context.
+ * - **Service role authentication** (`base44.asServiceRole.integrations`): Integration endpoints are invoked with elevated admin-level permissions. The endpoints execute with admin authentication context.
  */
 export type IntegrationsModule = {
     /**
@@ -349,7 +343,23 @@ export type IntegrationsModule = {
      */
     Core: CoreIntegrations;
     /**
-     * Custom integrations module for calling pre-configured external APIs.
+     * Custom integrations module for calling workspace-level API integrations.
+     *
+     * Allows calling external APIs that workspace admins have configured
+     * by importing OpenAPI specifications.
+     *
+     * @example
+     * ```typescript
+     * const response = await base44.integrations.custom.call(
+     *   "github",                              // integration slug
+     *   "get:/repos/{owner}/{repo}/issues",   // endpoint in method:path format
+     *   {
+     *     pathParams: { owner: "myorg", repo: "myrepo" },
+     *     queryParams: { state: "open" }
+     *   }
+     * );
+     * ```
+     * @internal
      */
     custom: CustomIntegrationsModule;
 } & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.18-pr.70.4e2bede",
+  "version": "0.8.18-pr.76.8d342cf",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",