@base44-preview/sdk 0.8.42-pr.254.6a358ec → 0.8.42-pr.256.fb681e4

package/dist/index.d.ts

@@ -14,6 +14,6 @@ export type { AppLogsModule } from "./modules/app-logs.types.js";
 export type { ActorsModule, ActorClient, ActorRef, Connection, ActorSubscription, ActorConnectOptions, ActorNameRegistry, ActorRegistry, } from "./modules/actors.types.js";
 export type { SsoModule, SsoAccessTokenResponse } from "./modules/sso.types.js";
 export { Actor, type Conn } from "./actor.js";
-export type { ConnectorsModule, UserConnectorsModule, } from "./modules/connectors.types.js";
+export type { ConnectorsModule, UserConnectorsModule, ConnectorApiRequest, ConnectorApiResponse, } from "./modules/connectors.types.js";
 export type { CustomIntegrationsModule, CustomIntegrationCallParams, CustomIntegrationCallResponse, } from "./modules/custom-integrations.types.js";
 export type { GetAccessTokenOptions, SaveAccessTokenOptions, RemoveAccessTokenOptions, GetLoginUrlOptions, } from "./utils/auth-utils.types.js";

package/dist/modules/connectors.js

@@ -68,6 +68,46 @@ export function createConnectorsModule(axios, appId) {
                 connectionConfig: (_a = data.connection_config) !== null && _a !== void 0 ? _a : null,
             };
         },
+        async callApi(integrationType, request) {
+            assertNonEmptyString(integrationType, "Integration type");
+            return proxyCall(axios, `/apps/${appId}/connectors/${integrationType}/call`, request);
+        },
+    };
+}
+function assertNonEmptyString(value, label) {
+    if (!value || typeof value !== "string") {
+        throw new Error(`${label} is required and must be a string`);
+    }
+}
+/**
+ * POST a request to the connector proxy and normalize the response.
+ *
+ * The proxy reports upstream outcomes in the body rather than as HTTP status, so
+ * a provider 4xx/5xx arrives here as a resolved response with `success: false` —
+ * only Base44-side failures reject through the axios error interceptor.
+ *
+ * @internal
+ */
+async function proxyCall(axios, url, request) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    if (!request || typeof request !== "object") {
+        throw new Error("Request is required and must be an object");
+    }
+    assertNonEmptyString(request.path, "Request path");
+    const response = await axios.post(url, {
+        method: ((_a = request.method) !== null && _a !== void 0 ? _a : "GET").toUpperCase(),
+        path: request.path,
+        query: (_b = request.query) !== null && _b !== void 0 ? _b : {},
+        headers: (_c = request.headers) !== null && _c !== void 0 ? _c : {},
+        body: (_d = request.body) !== null && _d !== void 0 ? _d : null,
+    });
+    const data = response;
+    return {
+        success: data.success,
+        status: (_e = data.status_code) !== null && _e !== void 0 ? _e : null,
+        data: data.data,
+        headers: (_f = data.headers) !== null && _f !== void 0 ? _f : {},
+        creditsCharged: (_g = data.credits_charged) !== null && _g !== void 0 ? _g : 0,
     };
 }
 /**

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

@@ -41,6 +41,52 @@ export interface AppUserConnectorConnectionResponse {
     /** Key-value configuration for the connection, or `null` if the connector does not provide one. */
     connectionConfig: Record<string, string> | null;
 }
+/**
+ * A request to forward to a metered connector's API through the Base44 proxy.
+ */
+export interface ConnectorApiRequest {
+    /** HTTP method for the upstream request. Defaults to `'GET'`. */
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD";
+    /**
+     * Path relative to the connector's API root, starting with `/`, such as `'/2/tweets'`.
+     *
+     * Must not be an absolute URL. Query parameters may be included here or passed
+     * separately as {@link query}; either way they are forwarded and priced identically.
+     */
+    path: string;
+    /** Query parameters. Merged into the request URL alongside any already present in {@link path}. */
+    query?: Record<string, string | number | boolean | Array<string | number>>;
+    /** Extra request headers. Only headers the connector explicitly allows are forwarded; the rest are dropped. */
+    headers?: Record<string, string>;
+    /** JSON request body. Ignored for `GET`, `HEAD`, and `DELETE`. */
+    body?: unknown;
+}
+/**
+ * The upstream API's response, as returned by the Base44 connector proxy.
+ */
+export interface ConnectorApiResponse<T = unknown> {
+    /** `true` when the upstream API returned a 2xx status. */
+    success: boolean;
+    /** The upstream HTTP status code, or `null` if the request never reached the provider. */
+    status: number | null;
+    /** The parsed upstream response body. */
+    data: T;
+    /** The subset of upstream response headers the connector exposes, typically rate-limit counters. */
+    headers: Record<string, string>;
+    /** Integration credits billed to the workspace for this call. */
+    creditsCharged: number;
+}
+/**
+ * Raw proxy response shape. Mapped to {@link ConnectorApiResponse} before being returned.
+ * @internal
+ */
+export interface ConnectorProxyRawResponse {
+    success: boolean;
+    status_code: number | null;
+    data: unknown;
+    headers: Record<string, string>;
+    credits_charged: number;
+}
 /**
  * Connectors module for managing OAuth tokens for external services.
  *
@@ -71,6 +117,17 @@ export interface AppUserConnectorConnectionResponse {
  * 3. In a backend function, call {@linkcode getCurrentAppUserConnection | getCurrentAppUserConnection()} using the service role client (`base44.asServiceRole.connectors`) with the connector ID to retrieve the app user's token.
  * 4. Use the returned `accessToken` to call the external service's API directly. Some connectors also return a `connectionConfig` with additional values such as a subdomain for building the API URL.
  *
+ * ## Metered connectors
+ *
+ * A few [platform connectors](#shared-connectors) are backed by paid third-party APIs that charge Base44 per call. For those, the OAuth token is **not** available to your code — {@linkcode getConnection | getConnection()} rejects with a `403`. Call them with {@linkcode callApi | callApi()} instead: Base44 attaches the credential server-side, forwards the request, and bills your workspace's integration credits for the call.
+ *
+ * This applies to platform connectors only. A workspace-registered or app user connector runs on **your own** OAuth app, so the provider invoices you directly and there is nothing for Base44 to meter — those keep normal token access via {@linkcode getWorkspaceConnection | getWorkspaceConnection()} and {@linkcode getCurrentAppUserConnection | getCurrentAppUserConnection()}.
+ *
+ * Two things to keep in mind when writing against a metered connector:
+ *
+ * - **Cost varies by endpoint, sometimes sharply.** The same connector can charge two orders of magnitude more for one endpoint than another, so avoid putting an expensive call inside a loop and batch wherever the provider supports it. Each response reports what it actually cost as `creditsCharged`.
+ * - **An upstream error is returned, not thrown.** A `4xx` or `5xx` from the provider comes back as `success: false` with the provider's own `status` and `data`, because it is a normal outcome of a call that Base44 completed. Only Base44-side failures — no connection, credits exhausted, a rejected request — reject the promise.
+ *
  * ## Available connectors
  *
  * The connectors below can be used as shared connectors or as app user connectors. For a shared platform connector, pass the integration type string to {@linkcode getConnection | getConnection()}. For a connector you register in Workspace Settings with your own OAuth app, use the connector ID with {@linkcode getWorkspaceConnection | getWorkspaceConnection()} for a shared token, or with {@linkcode getCurrentAppUserConnection | getCurrentAppUserConnection()} for a per-user token.
@@ -328,6 +385,41 @@ export interface ConnectorsModule {
      * ```
      */
     getCurrentAppUserConnection(connectorId: string): Promise<AppUserConnectorConnectionResponse>;
+    /**
+     * Calls a [metered connector's](#metered-connectors) API through the Base44 proxy.
+     *
+     * Use this for a shared platform connector identified by an integration type. Base44 adds the OAuth credential to the outgoing request, forwards it, and bills the workspace for the call, so you never handle the token yourself.
+     *
+     * @param integrationType - The type of integration, such as `'x'`. See [Available connectors](#available-connectors).
+     * @param request - The upstream request to forward. See {@link ConnectorApiRequest}.
+     * @returns Promise resolving to a {@link ConnectorApiResponse}. Note that an upstream error is reported in `success` and `status`, not thrown — only Base44-side failures reject.
+     *
+     * @example
+     * ```typescript
+     * // Post to X
+     * const res = await base44.asServiceRole.connectors.callApi('x', {
+     *   method: 'POST',
+     *   path: '/2/tweets',
+     *   body: { text: 'Shipped!' },
+     * });
+     *
+     * if (!res.success) {
+     *   console.error('X rejected the post', res.status, res.data);
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Read, with query parameters and a look at what the call cost
+     * const res = await base44.asServiceRole.connectors.callApi('x', {
+     *   path: '/2/tweets/search/recent',
+     *   query: { query: 'base44', max_results: 10 },
+     * });
+     *
+     * console.log(`${res.creditsCharged} credits`, res.data);
+     * ```
+     */
+    callApi<T = unknown>(integrationType: ConnectorIntegrationType, request: ConnectorApiRequest): Promise<ConnectorApiResponse<T>>;
 }
 /**
  * User-scoped connectors module for managing app user OAuth connections.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.42-pr.254.6a358ec",
+  "version": "0.8.42-pr.256.fb681e4",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",