@internxt/sdk 1.17.3 → 1.17.4

package/dist/mail/index.d.ts

@@ -1,5 +1,6 @@
 import { ApiSecurity, ApiUrl, AppDetails } from '../shared';
-import { MailboxResponse, EmailListResponse, EmailResponse, EmailCreatedResponse, SendEmailRequest, DraftEmailRequest, UpdateEmailRequest, ListEmailsQuery, EmailDomainsResponse, SetupMailAccountPayload, SearchFiltersQuery, MailAccountKeysResponse, MailAccountResponse, LookupRecipientKeysResponse, EncryptedKeystore, KeystoreType, RecipientWithPublicKey, HybridEncryptedEmail, EmailPublicParameters, PwdProtectedEmail } from './types';
+import { RequestCanceler } from '../shared/http/client';
+import { MailboxResponse, EmailListResponse, EmailResponse, EmailCreatedResponse, SendEmailRequest, DraftEmailRequest, UpdateEmailRequest, ListEmailsQuery, EmailDomainsResponse, SetupMailAccountPayload, SearchFiltersQuery, MailAccountKeysResponse, MailAccountResponse, LookupRecipientKeysResponse, EncryptedKeystore, KeystoreType, RecipientWithPublicKey, HybridEncryptedEmail, EmailPublicParameters, PwdProtectedEmail, UploadAttachmentResponse, DownloadAttachmentResponse, DownloadAttachmentPayload } from './types';
 export declare class MailApi {
     private readonly client;
     private readonly appDetails;
@@ -133,6 +134,32 @@ export declare class MailApi {
      * @returns The public, encrypted private and recovery keys plus the salt
      */
     getMailAccountKeys(address?: string): Promise<MailAccountKeysResponse>;
+    /**
+     * Uploading an attachment to the S3 so we can attach it to an email
+     * @param file - File to upload
+     * @returns
+     *    - `blobId` - The blob id of the attachment
+     *    - `name` - The name of the attachment
+     *    - `type` - The content type of the attachment
+     *    - `size` - The size of the attachment
+     *
+     */
+    uploadAttachment(file: File): {
+        promise: Promise<UploadAttachmentResponse>;
+        requestCanceler: RequestCanceler;
+    };
+    /**
+     * Downloads an attachment of the given email as raw bytes, together with the
+     * metadata exposed by the response headers (filename, content type and
+     * content length). The caller decides how to consume the bytes (write them
+     * to disk, wrap them in a `Blob`, etc.).
+     *
+     * @param id - The id of the email that owns the attachment
+     * @param blobId - The blob id of the attachment
+     * @param query - Optional `name` and `type` overrides forwarded to the backend
+     * @returns The attachment bytes plus filename, content type and length
+     */
+    downloadAttachment(id: string, blobId: string, query?: DownloadAttachmentPayload): Promise<DownloadAttachmentResponse>;
     /**
      * Returns the needed headers for the module requests
      * @private

package/dist/mail/index.js

@@ -177,6 +177,43 @@ class MailApi {
         const params = address ? { address } : {};
         return this.client.getWithParams('/users/me/mail-account/keys', params, this.headers());
     }
+    /**
+     * Uploading an attachment to the S3 so we can attach it to an email
+     * @param file - File to upload
+     * @returns
+     *    - `blobId` - The blob id of the attachment
+     *    - `name` - The name of the attachment
+     *    - `type` - The content type of the attachment
+     *    - `size` - The size of the attachment
+     *
+     */
+    uploadAttachment(file) {
+        const formData = new FormData();
+        formData.append('attachments', file, file.name);
+        return this.client.postFormCancellable('/email/attachment', formData, this.headers());
+    }
+    /**
+     * Downloads an attachment of the given email as raw bytes, together with the
+     * metadata exposed by the response headers (filename, content type and
+     * content length). The caller decides how to consume the bytes (write them
+     * to disk, wrap them in a `Blob`, etc.).
+     *
+     * @param id - The id of the email that owns the attachment
+     * @param blobId - The blob id of the attachment
+     * @param query - Optional `name` and `type` overrides forwarded to the backend
+     * @returns The attachment bytes plus filename, content type and length
+     */
+    async downloadAttachment(id, blobId, query = {}) {
+        const { data, headers } = await this.client.getBinary(`/email/${id}/attachment/${blobId}`, query, this.headers());
+        const contentLengthHeader = headers['content-length'];
+        const contentLength = contentLengthHeader ? Number(contentLengthHeader) : undefined;
+        return {
+            data,
+            contentType: headers['content-type'] ?? 'application/octet-stream',
+            contentLength: Number.isFinite(contentLength) ? contentLength : undefined,
+            fileName: parseContentDispositionFilename(headers['content-disposition']),
+        };
+    }
     /**
      * Returns the needed headers for the module requests
      * @private
@@ -192,3 +229,18 @@ class MailApi {
     }
 }
 exports.MailApi = MailApi;
+function parseContentDispositionFilename(header) {
+    if (!header)
+        return undefined;
+    const utf8Match = /filename\*\s*=\s*(?:UTF-8|utf-8)''([^;]+)/i.exec(header);
+    if (utf8Match) {
+        try {
+            return decodeURIComponent(utf8Match[1].trim());
+        }
+        catch {
+            return utf8Match[1].trim();
+        }
+    }
+    const asciiMatch = /filename\s*=\s*"?([^";]+)"?/i.exec(header);
+    return asciiMatch ? asciiMatch[1].trim() : undefined;
+}

package/dist/mail/schema.d.ts

@@ -187,6 +187,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/email/attachment': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Upload an attachment
+         * @description Uploads an attachment and get the info to attach it to an user email.
+         */
+        post: operations['EmailController_uploadAttachment'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/email/{id}/attachment/{blobId}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Download an attachment
+         * @description Streams the bytes of an attachment from the given email. Optional `name` and `type` query params set the response filename and content-type.
+         */
+        get: operations['EmailController_downloadAttachment'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/users/me/mail-account': {
         parameters: {
             query?: never;
@@ -428,6 +468,19 @@ export interface components {
             /** @description Filter by attachment presence */
             hasAttachment?: boolean;
         };
+        EmailAttachmentDto: {
+            /** @example T1a2b3c… */
+            blobId: string;
+            /** @example photo.jpg */
+            name: string;
+            /** @example image/jpeg */
+            type: string;
+            /**
+             * @description Size in bytes
+             * @example 4096
+             */
+            size: number;
+        };
         EmailResponseDto: {
             /** @example Ma1f09b… */
             id: string;
@@ -470,6 +523,7 @@ export interface components {
             textBody: string | null;
             /** @example <p>Hi team, here are the notes…</p> */
             htmlBody: string | null;
+            attachments: components['schemas']['EmailAttachmentDto'][];
         };
         LookupRecipientKeysRequestDto: {
             /**
@@ -500,6 +554,19 @@ export interface components {
             /** @description De-identified wrapped keys, one per recipient */
             wrappedKeys: components['schemas']['EncryptedWrappedKeyDto'][];
         };
+        AttachmentRefDto: {
+            /** @example T1a2b3c… */
+            blobId: string;
+            /** @example photo.jpg */
+            name: string;
+            /** @example image/jpeg */
+            type: string;
+            /**
+             * @description Size in bytes
+             * @example 4096
+             */
+            size: number;
+        };
         SendEmailRequestDto: {
             /** @description Primary recipients (at least one required) */
             to: components['schemas']['EmailAddressDto'][];
@@ -518,6 +585,8 @@ export interface components {
              */
             htmlBody?: string;
             encryption?: components['schemas']['EncryptionBlockDto'];
+            /** @description Attachments to include, referenced by blobId previously obtained from POST /email/attachment */
+            attachments?: components['schemas']['AttachmentRefDto'][];
         };
         EmailCreatedResponseDto: {
             /**
@@ -536,6 +605,21 @@ export interface components {
             textBody?: string;
             /** @example <p>Still working on this…</p> */
             htmlBody?: string;
+            /** @description Attachments to include, referenced by blobId previously obtained from POST /email/attachment */
+            attachments?: components['schemas']['AttachmentRefDto'][];
+        };
+        UploadAttachmentResponseDto: {
+            /** @example T1a2b3c… */
+            blobId: string;
+            /**
+             * @description Size in bytes
+             * @example 4096
+             */
+            size: number;
+            /** @example image/jpeg */
+            type: string;
+            /** @example photo.jpg */
+            name: string;
         };
         UpdateEmailRequestDto: {
             /**
@@ -897,6 +981,51 @@ export interface operations {
             };
         };
     };
+    EmailController_uploadAttachment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Upload attachment successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['UploadAttachmentResponseDto'];
+                };
+            };
+        };
+    };
+    EmailController_downloadAttachment: {
+        parameters: {
+            query?: {
+                type?: unknown;
+                name?: unknown;
+            };
+            header?: never;
+            path: {
+                /** @description Email ID */
+                id: string;
+                /** @description Attachment blob ID */
+                blobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     UserController_getMailAccount: {
         parameters: {
             query?: never;

package/dist/mail/types.d.ts

@@ -16,6 +16,15 @@ export type EmailAddress = components['schemas']['EmailAddressDto'];
 export type ListEmailsQuery = operations['EmailController_list']['parameters']['query'];
 export type SearchFiltersQuery = operations['EmailController_search']['requestBody']['content']['application/json'];
 export type EmailDomainsResponse = components['schemas']['MailDomainDto'][];
+export type UploadAttachmentResponse = components['schemas']['UploadAttachmentResponseDto'];
+export type DownloadAttachmentPayload = operations['EmailController_downloadAttachment']['parameters']['query'];
+export type AttachmentRef = components['schemas']['EmailAttachmentDto'];
+export type DownloadAttachmentResponse = {
+    data: ArrayBuffer;
+    contentType: string;
+    contentLength?: number;
+    fileName?: string;
+};
 export type SetupMailAccountPayload = {
     address: string;
     domain: string;

package/dist/shared/http/client.d.ts

@@ -47,6 +47,21 @@ export declare class HttpClient {
      * @param headers
      */
     getWithParams<Response>(url: URL, params: Parameters, headers: Headers): Promise<Response>;
+    /**
+     * Requests a GET that returns raw binary bytes together with the response
+     * headers. Useful for endpoints that stream files where the caller needs
+     * `Content-Type`, `Content-Length` or `Content-Disposition`.
+     *
+     * Bypasses the response interceptor so headers are preserved.
+     *
+     * @param url
+     * @param params
+     * @param headers
+     */
+    getBinary(url: URL, params: Parameters, headers: Headers): Promise<{
+        data: ArrayBuffer;
+        headers: Record<string, string>;
+    }>;
     /**
      * Requests a GET with option to cancel
      * @param url
@@ -77,6 +92,16 @@ export declare class HttpClient {
      * @param headers
      */
     postForm<Response>(url: URL, params: Parameters, headers: Headers): Promise<Response>;
+    /**
+     * Requests a POST FORM with option to cancel
+     * @param url
+     * @param params
+     * @param headers
+     */
+    postFormCancellable<Response>(url: URL, params: Parameters, headers: Headers): {
+        promise: Promise<Response>;
+        requestCanceler: RequestCanceler;
+    };
     /**
      * Requests a POST with option to cancel
      * @param url

package/dist/shared/http/client.js

@@ -72,6 +72,38 @@ class HttpClient {
     async getWithParams(url, params, headers) {
         return await this.execute(() => this.axios.get(url, { params, headers }));
     }
+    /**
+     * Requests a GET that returns raw binary bytes together with the response
+     * headers. Useful for endpoints that stream files where the caller needs
+     * `Content-Type`, `Content-Length` or `Content-Disposition`.
+     *
+     * Bypasses the response interceptor so headers are preserved.
+     *
+     * @param url
+     * @param params
+     * @param headers
+     */
+    async getBinary(url, params, headers) {
+        return await this.execute(async () => {
+            try {
+                const response = await axios_1.default.get(url, {
+                    baseURL: this.axios.defaults.baseURL,
+                    params,
+                    headers,
+                    responseType: 'arraybuffer',
+                    transformResponse: (raw) => raw,
+                });
+                return {
+                    data: response.data,
+                    headers: response.headers,
+                };
+            }
+            catch (error) {
+                this.normalizeError(error);
+                throw error;
+            }
+        });
+    }
     /**
      * Requests a GET with option to cancel
      * @param url
@@ -120,6 +152,22 @@ class HttpClient {
     async postForm(url, params, headers) {
         return await this.execute(() => this.axios.postForm(url, params, { headers }));
     }
+    /**
+     * Requests a POST FORM with option to cancel
+     * @param url
+     * @param params
+     * @param headers
+     */
+    postFormCancellable(url, params, headers) {
+        let currentCancel = () => { };
+        const requestCanceler = { cancel: (message) => currentCancel(message) };
+        const promise = this.execute(() => {
+            const source = axios_1.default.CancelToken.source();
+            currentCancel = source.cancel;
+            return this.axios.postForm(url, params, { headers, cancelToken: source.token });
+        });
+        return { promise, requestCanceler };
+    }
     /**
      * Requests a POST with option to cancel
      * @param url

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@internxt/sdk",
   "author": "Internxt <hello@internxt.com>",
-  "version": "1.17.3",
+  "version": "1.17.4",
   "description": "An sdk for interacting with Internxt's services",
   "repository": {
     "type": "git",