@doist/todoist-sdk 10.1.4 → 10.1.5

package/dist/cjs/clients/backup-client.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BackupClient = void 0;
 const endpoints_1 = require("../consts/endpoints");
 const http_client_1 = require("../transport/http-client");
-const headers_1 = require("../utils/headers");
+const file_response_1 = require("../utils/file-response");
 const validators_1 = require("../utils/validators");
 const base_client_1 = require("./base-client");
 /**
@@ -35,31 +35,13 @@ class BackupClient extends base_client_1.BaseClient {
             if (!response.ok) {
                 throw new Error(`Failed to download backup: ${response.status} ${response.statusText}`);
             }
-            const text = await response.text();
-            const buffer = new TextEncoder().encode(text).buffer;
-            return {
-                ok: response.ok,
-                status: response.status,
-                statusText: response.statusText,
-                headers: response.headers,
-                text: () => Promise.resolve(text),
-                json: () => response.json(),
-                arrayBuffer: () => Promise.resolve(buffer),
-            };
+            return (0, file_response_1.wrapAsFileResponse)(response, 'downloadBackup');
         }
         const response = await fetch(url, fetchOptions);
         if (!response.ok) {
             throw new Error(`Failed to download backup: ${response.status} ${response.statusText}`);
         }
-        return {
-            ok: response.ok,
-            status: response.status,
-            statusText: response.statusText,
-            headers: (0, headers_1.headersToRecord)(response.headers),
-            text: () => response.text(),
-            json: () => response.json(),
-            arrayBuffer: () => response.arrayBuffer(),
-        };
+        return (0, file_response_1.wrapAsFileResponse)(response, 'downloadBackup');
     }
 }
 exports.BackupClient = BackupClient;

package/dist/cjs/clients/upload-client.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UploadClient = void 0;
 const endpoints_1 = require("../consts/endpoints");
 const http_client_1 = require("../transport/http-client");
-const headers_1 = require("../utils/headers");
+const file_response_1 = require("../utils/file-response");
 const multipart_upload_1 = require("../utils/multipart-upload");
 const validators_1 = require("../utils/validators");
 const base_client_1 = require("./base-client");
@@ -71,32 +71,13 @@ class UploadClient extends base_client_1.BaseClient {
             if (!response.ok) {
                 throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
             }
-            // Convert text to ArrayBuffer for custom fetch implementations that lack arrayBuffer()
-            const text = await response.text();
-            const buffer = new TextEncoder().encode(text).buffer;
-            return {
-                ok: response.ok,
-                status: response.status,
-                statusText: response.statusText,
-                headers: response.headers,
-                text: () => Promise.resolve(text),
-                json: () => response.json(),
-                arrayBuffer: () => Promise.resolve(buffer),
-            };
+            return (0, file_response_1.wrapAsFileResponse)(response, 'viewAttachment');
         }
         const response = await fetch(fileUrl, fetchOptions);
         if (!response.ok) {
             throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
         }
-        return {
-            ok: response.ok,
-            status: response.status,
-            statusText: response.statusText,
-            headers: (0, headers_1.headersToRecord)(response.headers),
-            text: () => response.text(),
-            json: () => response.json(),
-            arrayBuffer: () => response.arrayBuffer(),
-        };
+        return (0, file_response_1.wrapAsFileResponse)(response, 'viewAttachment');
     }
 }
 exports.UploadClient = UploadClient;

package/dist/cjs/test-utils/obsidian-fetch-adapter.js

@@ -48,6 +48,7 @@ function createObsidianFetchAdapter(requestUrl) {
             // Wrap Obsidian's direct properties as methods returning promises
             text: () => Promise.resolve(response.text),
             json: () => Promise.resolve(response.json),
+            arrayBuffer: () => Promise.resolve(response.arrayBuffer),
         };
     };
 }

package/dist/cjs/transport/fetch-with-retry.js

@@ -92,6 +92,7 @@ function convertResponseToCustomFetch(response) {
         headers: headersToObject(response.headers),
         text: () => clonedResponse.text(),
         json: () => response.json(),
+        arrayBuffer: () => response.arrayBuffer(),
     };
 }
 /**

package/dist/cjs/utils/file-response.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapAsFileResponse = wrapAsFileResponse;
+const headers_1 = require("./headers");
+/**
+ * Wraps either a native `Response` or a `CustomFetchResponse` into the SDK's
+ * `FileResponse` shape (binary endpoints: `viewAttachment`, `downloadBackup`).
+ *
+ * `arrayBuffer()` is resolved lazily. A customFetch implementation that omits
+ * `arrayBuffer()` is still valid for callers that only read `text()`/`json()`;
+ * the descriptive error is thrown only if the caller actually requests binary
+ * bytes. This avoids the lossy `text()` → `TextEncoder` round-trip that
+ * corrupts non-UTF-8 bytes (every `0x80`-`0xFF` byte not part of a valid UTF-8
+ * sequence is replaced with `U+FFFD`).
+ */
+function wrapAsFileResponse(response, context) {
+    const headers = response.headers instanceof Headers ? (0, headers_1.headersToRecord)(response.headers) : response.headers;
+    return {
+        ok: response.ok,
+        status: response.status,
+        statusText: response.statusText,
+        headers,
+        text: () => response.text(),
+        json: () => response.json(),
+        arrayBuffer: () => {
+            if (typeof response.arrayBuffer !== 'function') {
+                throw new Error(`customFetch response must implement arrayBuffer() for ${context} (binary endpoint); reading the body via text() corrupts non-UTF-8 bytes`);
+            }
+            return response.arrayBuffer();
+        },
+    };
+}

package/dist/esm/clients/backup-client.js

@@ -1,6 +1,6 @@
 import { ENDPOINT_REST_BACKUPS, ENDPOINT_REST_BACKUPS_DOWNLOAD } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { headersToRecord } from '../utils/headers.js';
+import { wrapAsFileResponse } from '../utils/file-response.js';
 import { validateBackupArray } from '../utils/validators.js';
 import { BaseClient } from './base-client.js';
 /**
@@ -32,30 +32,12 @@ export class BackupClient extends BaseClient {
             if (!response.ok) {
                 throw new Error(`Failed to download backup: ${response.status} ${response.statusText}`);
             }
-            const text = await response.text();
-            const buffer = new TextEncoder().encode(text).buffer;
-            return {
-                ok: response.ok,
-                status: response.status,
-                statusText: response.statusText,
-                headers: response.headers,
-                text: () => Promise.resolve(text),
-                json: () => response.json(),
-                arrayBuffer: () => Promise.resolve(buffer),
-            };
+            return wrapAsFileResponse(response, 'downloadBackup');
         }
         const response = await fetch(url, fetchOptions);
         if (!response.ok) {
             throw new Error(`Failed to download backup: ${response.status} ${response.statusText}`);
         }
-        return {
-            ok: response.ok,
-            status: response.status,
-            statusText: response.statusText,
-            headers: headersToRecord(response.headers),
-            text: () => response.text(),
-            json: () => response.json(),
-            arrayBuffer: () => response.arrayBuffer(),
-        };
+        return wrapAsFileResponse(response, 'downloadBackup');
     }
 }

package/dist/esm/clients/upload-client.js

@@ -1,6 +1,6 @@
 import { ENDPOINT_REST_UPLOADS } from '../consts/endpoints.js';
 import { isSuccess, request } from '../transport/http-client.js';
-import { headersToRecord } from '../utils/headers.js';
+import { wrapAsFileResponse } from '../utils/file-response.js';
 import { uploadMultipartFile } from '../utils/multipart-upload.js';
 import { validateAttachment } from '../utils/validators.js';
 import { BaseClient } from './base-client.js';
@@ -68,31 +68,12 @@ export class UploadClient extends BaseClient {
             if (!response.ok) {
                 throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
             }
-            // Convert text to ArrayBuffer for custom fetch implementations that lack arrayBuffer()
-            const text = await response.text();
-            const buffer = new TextEncoder().encode(text).buffer;
-            return {
-                ok: response.ok,
-                status: response.status,
-                statusText: response.statusText,
-                headers: response.headers,
-                text: () => Promise.resolve(text),
-                json: () => response.json(),
-                arrayBuffer: () => Promise.resolve(buffer),
-            };
+            return wrapAsFileResponse(response, 'viewAttachment');
         }
         const response = await fetch(fileUrl, fetchOptions);
         if (!response.ok) {
             throw new Error(`Failed to fetch attachment: ${response.status} ${response.statusText}`);
         }
-        return {
-            ok: response.ok,
-            status: response.status,
-            statusText: response.statusText,
-            headers: headersToRecord(response.headers),
-            text: () => response.text(),
-            json: () => response.json(),
-            arrayBuffer: () => response.arrayBuffer(),
-        };
+        return wrapAsFileResponse(response, 'viewAttachment');
     }
 }

package/dist/esm/test-utils/obsidian-fetch-adapter.js

@@ -45,6 +45,7 @@ export function createObsidianFetchAdapter(requestUrl) {
             // Wrap Obsidian's direct properties as methods returning promises
             text: () => Promise.resolve(response.text),
             json: () => Promise.resolve(response.json),
+            arrayBuffer: () => Promise.resolve(response.arrayBuffer),
         };
     };
 }

package/dist/esm/transport/fetch-with-retry.js

@@ -89,6 +89,7 @@ function convertResponseToCustomFetch(response) {
         headers: headersToObject(response.headers),
         text: () => clonedResponse.text(),
         json: () => response.json(),
+        arrayBuffer: () => response.arrayBuffer(),
     };
 }
 /**

package/dist/esm/utils/file-response.js

@@ -0,0 +1,29 @@
+import { headersToRecord } from './headers.js';
+/**
+ * Wraps either a native `Response` or a `CustomFetchResponse` into the SDK's
+ * `FileResponse` shape (binary endpoints: `viewAttachment`, `downloadBackup`).
+ *
+ * `arrayBuffer()` is resolved lazily. A customFetch implementation that omits
+ * `arrayBuffer()` is still valid for callers that only read `text()`/`json()`;
+ * the descriptive error is thrown only if the caller actually requests binary
+ * bytes. This avoids the lossy `text()` → `TextEncoder` round-trip that
+ * corrupts non-UTF-8 bytes (every `0x80`-`0xFF` byte not part of a valid UTF-8
+ * sequence is replaced with `U+FFFD`).
+ */
+export function wrapAsFileResponse(response, context) {
+    const headers = response.headers instanceof Headers ? headersToRecord(response.headers) : response.headers;
+    return {
+        ok: response.ok,
+        status: response.status,
+        statusText: response.statusText,
+        headers,
+        text: () => response.text(),
+        json: () => response.json(),
+        arrayBuffer: () => {
+            if (typeof response.arrayBuffer !== 'function') {
+                throw new Error(`customFetch response must implement arrayBuffer() for ${context} (binary endpoint); reading the body via text() corrupts non-UTF-8 bytes`);
+            }
+            return response.arrayBuffer();
+        },
+    };
+}

package/dist/types/types/http.d.ts

@@ -67,7 +67,12 @@ export declare function isNetworkError(error: Error): error is NetworkError;
  */
 export declare function isHttpError(error: Error): error is HttpError;
 /**
- * Custom fetch response interface that custom HTTP clients must implement
+ * Custom fetch response interface that custom HTTP clients must implement.
+ *
+ * `arrayBuffer()` is optional for back-compat with existing implementations,
+ * but must be provided when the fetch is used with binary endpoints
+ * (`viewAttachment`, `downloadBackup`) — those endpoints throw at runtime if
+ * it is missing rather than fall back to a lossy `text()` round-trip.
  */
 export type CustomFetchResponse = {
     ok: boolean;
@@ -76,6 +81,7 @@ export type CustomFetchResponse = {
     headers: Record<string, string>;
     text(): Promise<string>;
     json(): Promise<unknown>;
+    arrayBuffer?: () => Promise<ArrayBuffer>;
 };
 /**
  * Custom fetch function type for alternative HTTP clients

package/dist/types/utils/file-response.d.ts

@@ -0,0 +1,15 @@
+import type { CustomFetchResponse, FileResponse } from '../types/http.js';
+type AnyResponse = CustomFetchResponse | Response;
+/**
+ * Wraps either a native `Response` or a `CustomFetchResponse` into the SDK's
+ * `FileResponse` shape (binary endpoints: `viewAttachment`, `downloadBackup`).
+ *
+ * `arrayBuffer()` is resolved lazily. A customFetch implementation that omits
+ * `arrayBuffer()` is still valid for callers that only read `text()`/`json()`;
+ * the descriptive error is thrown only if the caller actually requests binary
+ * bytes. This avoids the lossy `text()` → `TextEncoder` round-trip that
+ * corrupts non-UTF-8 bytes (every `0x80`-`0xFF` byte not part of a valid UTF-8
+ * sequence is replaced with `U+FFFD`).
+ */
+export declare function wrapAsFileResponse(response: AnyResponse, context: 'viewAttachment' | 'downloadBackup'): FileResponse;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "10.1.4",
+    "version": "10.1.5",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",