@base44-preview/sdk 0.8.52-pr.304.d2a318a → 0.8.52-pr.305.970f972

package/dist/modules/ai-gateway.types.d.ts

@@ -42,7 +42,7 @@ export interface AiGatewayModuleConfig {
 /**
  * AI Gateway module for calling Base44's managed AI models from your own code.
  *
- * `connection()` hands you a `baseURL`, `token`, and `headers` that
+ * Call `connection()` to get a `baseURL`, `token`, and `headers` that
  * authenticate as your Base44 app. An OpenAI-compatible client is any library, such as the `openai`
  * SDK or the Vercel AI SDK, that has the same request and response format
  * as OpenAI's API and lets you point it at a custom `baseURL`
@@ -51,15 +51,15 @@ export interface AiGatewayModuleConfig {
  * against the provider directly, no separate account, API key, or billing
  * setup with the underlying model provider required.
  *
- * By default, `connection()` uses the OpenAI-compatible provider. Pass
- * `{ provider: "typesafe" }` to connect to TypeSafe for structured evaluations
- * with `@ai-sdk/typesafe-ai`.
+ * The optional `provider` picks the API you connect to:
+ *
+ * - `openai` (default): OpenAI-compatible chat completions, image, and video endpoints.
+ * - `typesafe`: structured evaluations with the `jev` model.
  *
  * Call `connection()` from a backend function rather than the browser. This
  * keeps your instructions, tools, and business logic server-side, and lets
- * you enforce your own auth, rate, and spend limits around the call. The
- * `token` it returns is the caller's regular session token, the same one
- * used for every other SDK call.
+ * you enforce your own auth, rate, and spend limits around the call. Which
+ * token it returns depends on the authentication mode, described below.
  *
  * ## OpenAI-compatible models
  *
@@ -71,18 +71,52 @@ export interface AiGatewayModuleConfig {
  *
  * The gateway also serves OpenAI's image endpoints, `/images/generations`
  * and `/images/edits`, so you can generate images and edit them using
- * reference images. Image requests use their own set of models: pass
+ * reference images. Image requests use their own set of models. Pass
  * `'automatic'` to let Base44 choose one, or pin a model such as
  * `'gemini_3_1_flash_image'` or `'gpt_image_2'`. For request options, the
  * full model list, and limits, see [Generate images with the AI Gateway](/developers/references/sdk/getting-started/ai-gateway-images).
  *
+ * ## Video
+ *
+ * The gateway also serves OpenAI's video endpoints, `/videos`, so you can
+ * generate video from a prompt, from a still image, or from existing media.
+ * Video generation is asynchronous. `POST /videos` returns a job, and you poll
+ * `GET /videos/{id}` until its status is `completed` or `failed`, which can
+ * take minutes. Video models are their own set, and there's no `automatic`
+ * option, so pin a model such as `'veo_3_1_fast'` or `'seedance_2'`. For
+ * request options, the full model list, and limits, see
+ * [Generate video with the AI Gateway](/developers/references/sdk/getting-started/ai-gateway-video).
+ *
+ * ## Structured evaluations
+ *
+ * The `typesafe` provider runs the `jev` evaluation model through
+ * `@ai-sdk/typesafe-ai` and `experimental_evaluate` from the `ai` package,
+ * version 7.0.105 or later. Pass `evaluationModel("jev")`, and note that the
+ * gateway rejects other model IDs, such as `"jev-latest"`. Give it some app
+ * state and a set of questions, each a `choice`, `score`, or `boolean`. Choice
+ * and score answers come back with `probabilities` per option, and boolean
+ * answers with a single `probability` of `true`. Use it to classify, score, or
+ * route records, then apply your own thresholds and actions in code.
+ *
  * ## Authentication Modes
  *
- * There's no permission difference between modes. Both just determine which
- * token `connection()` returns:
+ * The mode determines which token `connection()` returns:
  *
  * - **User authentication** (`base44.aiGateway`): Returns the signed-in app user's token.
- * - **Service role authentication** (`base44.asServiceRole.aiGateway`): Returns the service-role token instead, for calling the gateway when there's no signed-in user, such as from a scheduled automation.
+ * - **Service role authentication** (`base44.asServiceRole.aiGateway`): Returns the service-role token instead.
+ *
+ * Use service role, as every example here does. An app that restricts Core
+ * integrations rejects user-token gateway calls unless it's shared privately
+ * or with your workspace, and most new apps have that restriction on from the
+ * start. A user-token call therefore works while you're building and starts
+ * failing the moment you share the app publicly. Service role also works when
+ * there's no signed-in user at all, such as from a scheduled automation.
+ *
+ * The mode changes which token you get and nothing else. It grants the model
+ * no extra reach, because the gateway runs a model and never touches your
+ * data. Access to your app's data comes from the `base44.entities` calls you
+ * write around the gateway call, so pick the mode for those on their own
+ * merits rather than matching this one.
  *
  * ## Billing and limits
  *
@@ -111,7 +145,7 @@ export interface AiGatewayModule {
      *
      * // Runs inside a backend function
      * const base44 = createClientFromRequest(request);
-     * const { baseURL, token, headers } = base44.aiGateway.connection();
+     * const { baseURL, token, headers } = base44.asServiceRole.aiGateway.connection();
      * const openai = new OpenAI({ baseURL, apiKey: token, defaultHeaders: headers });
      *
      * const response = await openai.chat.completions.create({
@@ -133,7 +167,7 @@ export interface AiGatewayModule {
      * // Runs inside a backend function, reviewing a return request
      * const base44 = createClientFromRequest(request);
      * const returnRequest = await base44.entities.ReturnRequest.get(returnId);
-     * const { baseURL, token, headers } = base44.aiGateway.connection();
+     * const { baseURL, token, headers } = base44.asServiceRole.aiGateway.connection();
      * // Point any OpenAI-compatible client at `baseURL` with `apiKey: token` and `headers`.
      * const models = createOpenAICompatible({ name: "base44", baseURL, apiKey: token, headers });
      *
@@ -174,7 +208,7 @@ export interface AiGatewayModule {
      *
      * // Runs inside a backend function
      * const base44 = createClientFromRequest(request);
-     * const { baseURL, token, headers } = base44.aiGateway.connection();
+     * const { baseURL, token, headers } = base44.asServiceRole.aiGateway.connection();
      * const models = createOpenAICompatible({ name: "base44", baseURL, apiKey: token, headers });
      *
      * const { image } = await generateImage({
@@ -187,6 +221,69 @@ export interface AiGatewayModule {
      * const file = new File([image.uint8Array], "lighthouse.png", { type: image.mediaType });
      * const { file_url } = await base44.integrations.Core.UploadFile({ file });
      * ```
+     *
+     * @example
+     * ```typescript
+     * // Start a video and record the job to poll later
+     * import { createClientFromRequest } from "@base44/sdk";
+     *
+     * // Runs inside a backend function
+     * const base44 = createClientFromRequest(request);
+     * const { baseURL, token, headers } = base44.asServiceRole.aiGateway.connection();
+     *
+     * const response = await fetch(`${baseURL}/videos`, {
+     *   method: "POST",
+     *   headers: { ...headers, Authorization: `Bearer ${token}`, "Content-Type": "application/json" },
+     *   body: JSON.stringify({
+     *     model: "veo_3_1_fast",
+     *     prompt: "A lighthouse beam sweeping across a calm sea at dawn",
+     *     seconds: 8,
+     *   }),
+     * });
+     *
+     * // Video generation takes minutes, so store the id and poll it from a later request
+     * const { id } = await response.json();
+     * await base44.asServiceRole.entities.Clip.update(clipId, { video_id: id });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Route a support ticket with a structured evaluation
+     * import { createClientFromRequest } from "@base44/sdk";
+     * import { experimental_evaluate as evaluate } from "ai";
+     * import { createTypeSafeAi } from "@ai-sdk/typesafe-ai";
+     *
+     * // Runs inside a backend function
+     * const base44 = createClientFromRequest(request);
+     * const { baseURL, token, headers } = base44.asServiceRole.aiGateway.connection({ provider: "typesafe" });
+     * const typesafe = createTypeSafeAi({ baseURL, apiKey: token, headers });
+     *
+     * const { answers, providerMetadata } = await evaluate({
+     *   model: typesafe.evaluationModel("jev"),
+     *   maxRetries: 0, // Avoid automatic replays of billed requests
+     *   state: { message: "Please refund today's duplicate charge." },
+     *   questions: {
+     *     department: {
+     *       type: "choice",
+     *       instructions: "Which team should handle this?",
+     *       criteria: { billing: "Payments and refunds", support: "Other requests" },
+     *     },
+     *     urgency: {
+     *       type: "score",
+     *       instructions: "How urgent is this?",
+     *       criteria: ["No deadline", "Requested today", "Immediate emergency"],
+     *     },
+     *     refund: { type: "boolean", instructions: "Is a refund explicitly requested?" },
+     *   },
+     * });
+     *
+     * // answers.department → { type: "choice", choice: "billing", probabilities: { billing: 0.97, support: 0.03 } }
+     * // answers.urgency    → { type: "score", score: 1.2, probabilities: { 0: 0.1, 1: 0.6, 2: 0.3 } }
+     * // answers.refund     → { type: "boolean", probability: 0.99 }
+     * // Choice and score confidence is in providerMetadata.typesafe.confidence
+     * // Pick your own thresholds and act on them in code
+     * const autoRefund = answers.department.choice === "billing" && answers.refund.probability > 0.9;
+     * ```
      */
     connection(options?: AiGatewayConnectionOptions): AiGatewayConnection;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.52-pr.304.d2a318a",
+  "version": "0.8.52-pr.305.970f972",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,6 @@
   ],
   "scripts": {
     "build": "tsc",
-    "lint": "eslint src",
     "test": "npm run test:types && vitest run",
     "test:types": "tsc --noEmit -p tsconfig.type-tests.json",
     "test:unit": "vitest run tests/unit",
@@ -31,24 +30,6 @@
     "socket.io-client": "^4.8.3",
     "uuid": "^13.0.2"
   },
-  "devDependencies": {
-    "@types/hast": "^3.0.4",
-    "@types/node": "^25.0.1",
-    "@types/unist": "^3.0.3",
-    "@typescript-eslint/parser": "^8.51.0",
-    "@vitest/coverage-istanbul": "^4.1.9",
-    "@vitest/coverage-v8": "^4.1.9",
-    "@vitest/ui": "^4.1.9",
-    "dotenv": "^16.3.1",
-    "eslint": "^9.39.2",
-    "eslint-plugin-import": "^2.32.0",
-    "nock": "^13.4.0",
-    "typedoc": "^0.28.14",
-    "typedoc-plugin-markdown": "^4.9.0",
-    "typescript": "^5.3.2",
-    "typescript-eslint": "^8.51.0",
-    "vitest": "^4.1.9"
-  },
   "keywords": [
     "base44",
     "api",
@@ -58,10 +39,11 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/base44/javascript-sdk.git"
+    "url": "git+https://github.com/base44/javascript-sdk.git",
+    "directory": "packages/sdk"
   },
   "bugs": {
     "url": "https://github.com/base44/javascript-sdk/issues"
   },
-  "homepage": "https://github.com/base44/javascript-sdk#readme"
+  "homepage": "https://github.com/base44/javascript-sdk/tree/main/packages/sdk#readme"
 }