@blinkdotnew/sdk 2.5.1 → 2.6.0

package/dist/index.d.mts

@@ -310,8 +310,8 @@ interface TableOperations<T = any> {
 declare class BlinkError extends Error {
     code?: string | undefined;
     status?: number | undefined;
-    details?: any;
-    constructor(message: string, code?: string | undefined, status?: number | undefined, details?: any);
+    details?: any | undefined;
+    constructor(message: string, code?: string | undefined, status?: number | undefined, details?: any | undefined);
 }
 interface StorageUploadOptions {
     /**
@@ -798,6 +798,32 @@ interface SendEmailRequest {
     subject: string;
     html?: string;
     text?: string;
+    /**
+     * Pick which sender this email goes out from.
+     *
+     * Two accepted shapes — the server disambiguates by whether the value
+     * contains an `@` character:
+     *   - **Full address** (any string containing `@`, e.g.
+     *     `"support@mail.acme.com"`) — sends from that specific verified
+     *     sender. The address must be set up in Settings → Email beforehand;
+     *     unverified addresses are rejected by the server with HTTP 403. On
+     *     the SDK side this surfaces as a `BlinkNotificationsError` whose
+     *     `.status === 403` and `.details?.code === 'UNVERIFIED_SENDER'` —
+     *     the SDK-level `.code` is always `'NOTIFICATIONS_ERROR'`, so branch
+     *     on `.status` + `.details` (not `.code`) to detect this case.
+     *   - **Display name** (any string without `@`, e.g. `"Acme Support"`) —
+     *     keeps the project's default sender address but overrides the
+     *     visible name in the recipient's inbox. Useful for tagging different
+     *     message types ("Acme Receipts", "Acme Updates") without verifying
+     *     more senders.
+     *
+     * A display name MUST NOT contain `@`. If it does, the server interprets
+     * it as a sending address and rejects with 403 `UNVERIFIED_SENDER`.
+     *
+     * Omit to use the project's default sender (the one flagged "Default"
+     * in Settings → Email — same one auth emails like password reset and
+     * magic links use).
+     */
     from?: string;
     replyTo?: string;
     cc?: string | string[];
@@ -1007,17 +1033,17 @@ declare class HttpClient {
      * Stream AI text generation - uses Vercel AI SDK's pipeUIMessageStreamToResponse (Data Stream Protocol)
      */
     streamAiText(prompt: string, options: {
-        model?: string | undefined;
-        messages?: {
+        model?: string;
+        messages?: Array<{
             role: string;
             content: string | any[];
-        }[] | undefined;
-        search?: boolean | undefined;
-        maxSteps?: number | undefined;
-        experimental_continueSteps?: boolean | undefined;
-        maxTokens?: number | undefined;
-        temperature?: number | undefined;
-        signal?: AbortSignal | undefined;
+        }>;
+        search?: boolean;
+        maxSteps?: number;
+        experimental_continueSteps?: boolean;
+        maxTokens?: number;
+        temperature?: number;
+        signal?: AbortSignal;
     } | undefined, onChunk: (chunk: string) => void): Promise<any>;
     aiObject(prompt: string, options?: {
         model?: string;
@@ -1031,11 +1057,11 @@ declare class HttpClient {
      * Stream AI object generation - uses Vercel AI SDK's pipeTextStreamToResponse
      */
     streamAiObject(prompt: string, options: {
-        model?: string | undefined;
-        output?: "object" | "array" | "enum" | undefined;
+        model?: string;
+        output?: "object" | "array" | "enum";
         schema?: any;
-        enum?: string[] | undefined;
-        signal?: AbortSignal | undefined;
+        enum?: string[];
+        signal?: AbortSignal;
     } | undefined, onPartial: (partial: any) => void): Promise<any>;
     aiImage(prompt: string, options?: {
         model?: string;

package/dist/index.d.ts

@@ -310,8 +310,8 @@ interface TableOperations<T = any> {
 declare class BlinkError extends Error {
     code?: string | undefined;
     status?: number | undefined;
-    details?: any;
-    constructor(message: string, code?: string | undefined, status?: number | undefined, details?: any);
+    details?: any | undefined;
+    constructor(message: string, code?: string | undefined, status?: number | undefined, details?: any | undefined);
 }
 interface StorageUploadOptions {
     /**
@@ -798,6 +798,32 @@ interface SendEmailRequest {
     subject: string;
     html?: string;
     text?: string;
+    /**
+     * Pick which sender this email goes out from.
+     *
+     * Two accepted shapes — the server disambiguates by whether the value
+     * contains an `@` character:
+     *   - **Full address** (any string containing `@`, e.g.
+     *     `"support@mail.acme.com"`) — sends from that specific verified
+     *     sender. The address must be set up in Settings → Email beforehand;
+     *     unverified addresses are rejected by the server with HTTP 403. On
+     *     the SDK side this surfaces as a `BlinkNotificationsError` whose
+     *     `.status === 403` and `.details?.code === 'UNVERIFIED_SENDER'` —
+     *     the SDK-level `.code` is always `'NOTIFICATIONS_ERROR'`, so branch
+     *     on `.status` + `.details` (not `.code`) to detect this case.
+     *   - **Display name** (any string without `@`, e.g. `"Acme Support"`) —
+     *     keeps the project's default sender address but overrides the
+     *     visible name in the recipient's inbox. Useful for tagging different
+     *     message types ("Acme Receipts", "Acme Updates") without verifying
+     *     more senders.
+     *
+     * A display name MUST NOT contain `@`. If it does, the server interprets
+     * it as a sending address and rejects with 403 `UNVERIFIED_SENDER`.
+     *
+     * Omit to use the project's default sender (the one flagged "Default"
+     * in Settings → Email — same one auth emails like password reset and
+     * magic links use).
+     */
     from?: string;
     replyTo?: string;
     cc?: string | string[];
@@ -1007,17 +1033,17 @@ declare class HttpClient {
      * Stream AI text generation - uses Vercel AI SDK's pipeUIMessageStreamToResponse (Data Stream Protocol)
      */
     streamAiText(prompt: string, options: {
-        model?: string | undefined;
-        messages?: {
+        model?: string;
+        messages?: Array<{
             role: string;
             content: string | any[];
-        }[] | undefined;
-        search?: boolean | undefined;
-        maxSteps?: number | undefined;
-        experimental_continueSteps?: boolean | undefined;
-        maxTokens?: number | undefined;
-        temperature?: number | undefined;
-        signal?: AbortSignal | undefined;
+        }>;
+        search?: boolean;
+        maxSteps?: number;
+        experimental_continueSteps?: boolean;
+        maxTokens?: number;
+        temperature?: number;
+        signal?: AbortSignal;
     } | undefined, onChunk: (chunk: string) => void): Promise<any>;
     aiObject(prompt: string, options?: {
         model?: string;
@@ -1031,11 +1057,11 @@ declare class HttpClient {
      * Stream AI object generation - uses Vercel AI SDK's pipeTextStreamToResponse
      */
     streamAiObject(prompt: string, options: {
-        model?: string | undefined;
-        output?: "object" | "array" | "enum" | undefined;
+        model?: string;
+        output?: "object" | "array" | "enum";
         schema?: any;
-        enum?: string[] | undefined;
-        signal?: AbortSignal | undefined;
+        enum?: string[];
+        signal?: AbortSignal;
     } | undefined, onPartial: (partial: any) => void): Promise<any>;
     aiImage(prompt: string, options?: {
         model?: string;