@doist/todoist-sdk 14.1.0 → 15.0.0

package/dist/cjs/utils/colors.js

@@ -1,143 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultColor = exports.colors = exports.taupe = exports.grey = exports.charcoal = exports.salmon = exports.magenta = exports.lavender = exports.violet = exports.grape = exports.blue = exports.lightBlue = exports.skyBlue = exports.teal = exports.mintGreen = exports.green = exports.limeGreen = exports.oliveGreen = exports.yellow = exports.orange = exports.red = exports.berryRed = void 0;
-exports.getColorByKey = getColorByKey;
-exports.berryRed = {
-    key: 'berry_red',
-    displayName: 'Berry Red',
-    hexValue: '#b8255f',
-};
-exports.red = {
-    key: 'red',
-    displayName: 'Red',
-    hexValue: '#db4035',
-};
-exports.orange = {
-    key: 'orange',
-    displayName: 'Orange',
-    hexValue: '#ff9933',
-};
-exports.yellow = {
-    key: 'yellow',
-    displayName: 'Yellow',
-    hexValue: '#fad000',
-};
-exports.oliveGreen = {
-    key: 'olive_green',
-    displayName: 'Olive Green',
-    hexValue: '#afb83b',
-};
-exports.limeGreen = {
-    key: 'lime_green',
-    displayName: 'Lime Green',
-    hexValue: '#7ecc49',
-};
-exports.green = {
-    key: 'green',
-    displayName: 'Green',
-    hexValue: '#299438',
-};
-exports.mintGreen = {
-    key: 'mint_green',
-    displayName: 'Mint Green',
-    hexValue: '#6accbc',
-};
-exports.teal = {
-    key: 'teal',
-    displayName: 'Teal',
-    hexValue: '#158fad',
-};
-exports.skyBlue = {
-    key: 'sky_blue',
-    displayName: 'Sky Blue',
-    hexValue: '#14aaf5',
-};
-exports.lightBlue = {
-    key: 'light_blue',
-    displayName: 'Light Blue',
-    hexValue: '#96c3eb',
-};
-exports.blue = {
-    key: 'blue',
-    displayName: 'Blue',
-    hexValue: '#4073ff',
-};
-exports.grape = {
-    key: 'grape',
-    displayName: 'Grape',
-    hexValue: '#884dff',
-};
-exports.violet = {
-    key: 'violet',
-    displayName: 'Violet',
-    hexValue: '#af38eb',
-};
-exports.lavender = {
-    key: 'lavender',
-    displayName: 'Lavender',
-    hexValue: '#eb96eb',
-};
-exports.magenta = {
-    key: 'magenta',
-    displayName: 'Magenta',
-    hexValue: '#e05194',
-};
-exports.salmon = {
-    key: 'salmon',
-    displayName: 'Salmon',
-    hexValue: '#ff8d85',
-};
-exports.charcoal = {
-    key: 'charcoal',
-    displayName: 'Charcoal',
-    hexValue: '#808080',
-};
-exports.grey = {
-    key: 'grey',
-    displayName: 'Grey',
-    hexValue: '#b8b8b8',
-};
-exports.taupe = {
-    key: 'taupe',
-    displayName: 'Taupe',
-    hexValue: '#ccac93',
-};
-exports.colors = [
-    exports.berryRed,
-    exports.red,
-    exports.orange,
-    exports.yellow,
-    exports.oliveGreen,
-    exports.limeGreen,
-    exports.green,
-    exports.mintGreen,
-    exports.teal,
-    exports.skyBlue,
-    exports.lightBlue,
-    exports.blue,
-    exports.grape,
-    exports.violet,
-    exports.lavender,
-    exports.magenta,
-    exports.salmon,
-    exports.charcoal,
-    exports.grey,
-    exports.taupe,
-];
-exports.defaultColor = exports.charcoal;
-/**
- * Retrieves a {@link Color} object by its key identifier.
- *
- * @param colorKey - The unique key identifier of the color to find (e.g., 'berry_red', 'sky_blue')
- * @returns The matching Color object if found, otherwise returns the default color (charcoal)
- *
- * @example
- * ```typescript
- * const color = getColorByKey('berry_red');
- * console.log(color.hexValue); // '#b8255f'
- * ```
- */
-function getColorByKey(colorKey) {
-    const color = exports.colors.find((color) => color.key === colorKey);
-    return color !== null && color !== void 0 ? color : exports.defaultColor;
-}

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

@@ -1,32 +0,0 @@
-"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/cjs/utils/headers.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.headersToRecord = headersToRecord;
-/**
- * Converts a native Fetch `Headers` object into a plain `Record<string, string>`.
- * Used when wrapping a native `fetch` response into the SDK's `FileResponse`
- * shape (which expects headers as a plain record for symmetry with
- * `CustomFetchResponse`).
- */
-function headersToRecord(headers) {
-    const result = {};
-    headers.forEach((value, key) => {
-        result[key] = value;
-    });
-    return result;
-}

package/dist/cjs/utils/index.js

@@ -1,31 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyWebhookSignature = exports.parseWebhookPayload = exports.createCommand = exports.getSectionUrl = exports.getProjectUrl = exports.getTaskUrl = void 0;
-__exportStar(require("./colors"), exports);
-__exportStar(require("./sanitization"), exports);
-var url_helpers_1 = require("./url-helpers");
-Object.defineProperty(exports, "getTaskUrl", { enumerable: true, get: function () { return url_helpers_1.getTaskUrl; } });
-Object.defineProperty(exports, "getProjectUrl", { enumerable: true, get: function () { return url_helpers_1.getProjectUrl; } });
-Object.defineProperty(exports, "getSectionUrl", { enumerable: true, get: function () { return url_helpers_1.getSectionUrl; } });
-var sync_helpers_1 = require("./sync-helpers");
-Object.defineProperty(exports, "createCommand", { enumerable: true, get: function () { return sync_helpers_1.createCommand; } });
-__exportStar(require("./project-helpers"), exports);
-__exportStar(require("./task-sorting"), exports);
-__exportStar(require("./view-options"), exports);
-var webhook_parser_1 = require("./webhook-parser");
-Object.defineProperty(exports, "parseWebhookPayload", { enumerable: true, get: function () { return webhook_parser_1.parseWebhookPayload; } });
-Object.defineProperty(exports, "verifyWebhookSignature", { enumerable: true, get: function () { return webhook_parser_1.verifyWebhookSignature; } });

package/dist/cjs/utils/multipart-upload.js

@@ -1,179 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadMultipartFile = uploadMultipartFile;
-const fetch_with_retry_1 = require("../transport/fetch-with-retry");
-const case_conversion_1 = require("./case-conversion");
-/**
- * Helper function to determine content-type from filename extension.
- * @param fileName - The filename to analyze
- * @returns The appropriate MIME type
- */
-function getContentTypeFromFileName(fileName) {
-    const extension = fileName.toLowerCase().split('.').pop();
-    switch (extension) {
-        case 'png':
-            return 'image/png';
-        case 'jpg':
-        case 'jpeg':
-            return 'image/jpeg';
-        case 'gif':
-            return 'image/gif';
-        case 'webp':
-            return 'image/webp';
-        case 'svg':
-            return 'image/svg+xml';
-        default:
-            return 'application/octet-stream';
-    }
-}
-/**
- * Uploads a file using multipart/form-data.
- *
- * This is a shared utility for uploading files to Todoist endpoints that require
- * multipart/form-data content type (e.g., file uploads, workspace logo uploads).
- *
- * Supports both browser (Blob/File) and Node.js (Buffer/ReadableStream/path) environments.
- *
- * @param baseUrl - The base API URL (e.g., https://api.todoist.com/api/v1/)
- * @param authToken - The authentication token
- * @param endpoint - The relative endpoint path (e.g., 'uploads', 'workspaces/logo')
- * @param file - The file content (Blob/File for browser, or Buffer/ReadableStream/path for Node)
- * @param fileName - Optional file name (required for Buffer/Stream, optional for paths and File objects)
- * @param additionalFields - Additional form fields to include (e.g., project_id, workspace_id)
- * @param requestId - Optional request ID for idempotency
- * @returns The response data from the server
- *
- * @example
- * ```typescript
- * // Upload from a file path
- * const result = await uploadMultipartFile(
- *   'https://api.todoist.com/api/v1/',
- *   'my-token',
- *   'uploads',
- *   '/path/to/file.pdf',
- *   undefined,
- *   { project_id: '12345' }
- * )
- *
- * // Upload from a Buffer
- * const buffer = Buffer.from('file content')
- * const result = await uploadMultipartFile(
- *   'https://api.todoist.com/api/v1/',
- *   'my-token',
- *   'uploads',
- *   buffer,
- *   'document.pdf',
- *   { project_id: '12345' }
- * )
- * ```
- */
-async function uploadMultipartFile(args) {
-    const { baseUrl, authToken, endpoint, file, fileName, additionalFields, requestId, customFetch, } = args;
-    // Build the full URL
-    const url = `${baseUrl}${endpoint}`;
-    let body;
-    const headers = {
-        Authorization: `Bearer ${authToken}`,
-    };
-    if (requestId) {
-        headers['X-Request-Id'] = requestId;
-    }
-    if (file instanceof Blob) {
-        // Browser path: use native FormData
-        const form = new globalThis.FormData();
-        const resolvedFileName = fileName || (file instanceof File ? file.name : undefined) || 'upload';
-        form.append('file', file, resolvedFileName);
-        for (const [key, value] of Object.entries(additionalFields)) {
-            if (value !== undefined && value !== null) {
-                form.append(key, value.toString());
-            }
-        }
-        // Don't set Content-Type — let fetch set it with the correct multipart boundary
-        body = form;
-    }
-    else {
-        // Node path: dynamically import Node-only modules
-        const [FormDataModule, fsModule, pathModule] = await Promise.all([
-            Promise.resolve().then(() => __importStar(require('form-data'))),
-            Promise.resolve().then(() => __importStar(require('fs'))),
-            Promise.resolve().then(() => __importStar(require('path'))),
-        ]);
-        const FormData = FormDataModule.default;
-        const form = new FormData();
-        if (typeof file === 'string') {
-            // File path - create read stream
-            const resolvedFileName = fileName || pathModule.basename(file);
-            form.append('file', fsModule.createReadStream(file), resolvedFileName);
-        }
-        else if (Buffer.isBuffer(file)) {
-            // Buffer - require fileName
-            if (!fileName) {
-                throw new Error('fileName is required when uploading from a Buffer');
-            }
-            const contentType = getContentTypeFromFileName(fileName);
-            form.append('file', file, {
-                filename: fileName,
-                contentType: contentType,
-            });
-        }
-        else {
-            // Stream - require fileName
-            if (!fileName) {
-                throw new Error('fileName is required when uploading from a stream');
-            }
-            form.append('file', file, fileName);
-        }
-        for (const [key, value] of Object.entries(additionalFields)) {
-            if (value !== undefined && value !== null) {
-                form.append(key, value.toString());
-            }
-        }
-        Object.assign(headers, form.getHeaders());
-        body = form;
-    }
-    // Make the request using fetch
-    const response = await (0, fetch_with_retry_1.fetchWithRetry)({
-        url,
-        options: {
-            method: 'POST',
-            body,
-            headers,
-            timeout: 30000, // 30 second timeout for file uploads
-        },
-        customFetch,
-    });
-    return (0, case_conversion_1.camelCaseKeys)(response.data);
-}

package/dist/cjs/utils/processing-helpers.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.customCamelCase = customCamelCase;
-const camelcase_1 = __importDefault(require("camelcase"));
-const emoji_regex_1 = __importDefault(require("emoji-regex"));
-function isEmojiKey(key) {
-    const regex = (0, emoji_regex_1.default)();
-    return regex.test(key);
-}
-function customCamelCase(input) {
-    // If the value is a solitary emoji string, return the key as-is
-    if (isEmojiKey(input))
-        return input;
-    return (0, camelcase_1.default)(input);
-}

package/dist/cjs/utils/project-helpers.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWorkspaceProject = isWorkspaceProject;
-exports.isPersonalProject = isPersonalProject;
-/**
- * Type guard to check if a project is a workspace project.
- * @param project The project to check
- * @returns True if the project is a workspace project
- */
-function isWorkspaceProject(project) {
-    return 'workspaceId' in project;
-}
-/**
- * Type guard to check if a project is a personal project.
- * @param project The project to check
- * @returns True if the project is a personal project
- */
-function isPersonalProject(project) {
-    return !isWorkspaceProject(project);
-}

package/dist/cjs/utils/request-helpers.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatePath = generatePath;
-exports.spreadIfDefined = spreadIfDefined;
-/**
- * Joins path segments using `/` separator.
- * @param segments A list of **valid** path segments.
- * @returns A joined path.
- */
-function generatePath(...segments) {
-    return segments.join('/');
-}
-/**
- * Returns `fn(value)` spread into an object if `value` is defined, otherwise an empty object.
- *
- * Used to conditionally include a property on a payload object without
- * resorting to mutation or ternary-built object literals.
- */
-function spreadIfDefined(value, fn) {
-    return value !== undefined ? fn(value) : {};
-}

package/dist/cjs/utils/sanitization.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSanitizedContent = getSanitizedContent;
-exports.getSanitizedTasks = getSanitizedTasks;
-const BOLD_FORMAT = /(^|[\s!?,;>:]+)(?:\*\*|__|!!)(.+?)(\*\*|__|!!)(?=$|[\s!?,;><:]+)/gi;
-const ITALIC_FORMAT = /(^|[\s!?,;>:]+)(?:\*|_|!)(.+?)(\*|_|!)(?=$|[\s!?,;><:]+)/gi;
-const BOLD_ITALIC_FORMAT = /(^|[\s!?,;>:]+)(?:\*\*\*|___|!!!)(.+?)(\*\*\*|___|!!!)(?=$|[\s!?,;><:]+)/gi;
-const CODE_BLOCK_FORMAT = /```([\s\S]*?)```/gi;
-const CODE_INLINE_FORMAT = /`([^`]+)`/gi;
-const TODOIST_LINK = /((?:(?:onenote:)?[\w-]+):\/\/[^\s]+)\s+[[(]([^)]+)[\])]/gi;
-const MARKDOWN_LINK = /\[(.+?)\]\((.+?)\)/gi;
-const GMAIL_LINK = /\[\[gmail=(.+?),\s*(.+?)\]\]/gi;
-const OUTLOOK_LINK = /\[\[outlook=(.+?),\s*(.+?)\]\]/gi;
-const THUNDERBIRD_LINK = /\[\[thunderbird\n(.+)\n(.+)\n\s*\]\]/gi;
-const FAKE_SECTION_PREFIX = '* ';
-const FAKE_SECTION_SUFFIX = ':';
-function removeStyleFormatting(input) {
-    if (!input.includes('!') && !input.includes('*') && !input.includes('_')) {
-        return input;
-    }
-    function removeMarkdown(_match, prefix, text) {
-        return `${prefix}${text}`;
-    }
-    input = input.replace(BOLD_ITALIC_FORMAT, removeMarkdown);
-    input = input.replace(BOLD_FORMAT, removeMarkdown);
-    input = input.replace(ITALIC_FORMAT, removeMarkdown);
-    return input;
-}
-function removeCodeFormatting(input) {
-    function removeMarkdown(_match, text) {
-        return text;
-    }
-    input = input.replace(CODE_BLOCK_FORMAT, removeMarkdown);
-    input = input.replace(CODE_INLINE_FORMAT, removeMarkdown);
-    return input;
-}
-function removeFakeSectionFormatting(input) {
-    if (input.startsWith(FAKE_SECTION_PREFIX)) {
-        input = input.slice(FAKE_SECTION_PREFIX.length);
-    }
-    if (input.endsWith(FAKE_SECTION_SUFFIX)) {
-        input = input.slice(0, input.length - FAKE_SECTION_SUFFIX.length);
-    }
-    return input;
-}
-function removeMarkdownLinks(input) {
-    if (!input.includes('[') || !input.includes(']')) {
-        return input;
-    }
-    function removeMarkdown(_match, text) {
-        return text;
-    }
-    return input.replace(MARKDOWN_LINK, removeMarkdown);
-}
-function removeTodoistLinks(input) {
-    if (!input.includes('(') || !input.includes(')')) {
-        return input;
-    }
-    function removeMarkdown(_match, _url, text) {
-        return text;
-    }
-    return input.replace(TODOIST_LINK, removeMarkdown);
-}
-function removeAppLinks(input) {
-    if (input.includes('gmail')) {
-        input = input.replace(GMAIL_LINK, (_match, _id, text) => text);
-    }
-    if (input.includes('outlook')) {
-        input = input.replace(OUTLOOK_LINK, (_match, _id, text) => text);
-    }
-    if (input.includes('thunderbird')) {
-        input = input.replace(THUNDERBIRD_LINK, (_match, text) => text);
-    }
-    return input;
-}
-/**
- * Sanitizes a string by removing Todoist's formatting syntax (e.g. bold, italic, code blocks, links).
- *
- * @example
- * // Removes bold/italic formatting
- * getSanitizedContent('Some **bold** and *italic*') // 'Some bold and italic'
- *
- * // Removes markdown links
- * getSanitizedContent('A [markdown](http://url.com) link') // 'A markdown link'
- *
- * // Removes app-specific links
- * getSanitizedContent('A [[gmail=id, link from gmail]]') // 'A link from gmail'
- *
- * @param input - The string to sanitize
- * @returns The sanitized string with all formatting removed
- */
-function getSanitizedContent(input) {
-    input = removeStyleFormatting(input);
-    input = removeCodeFormatting(input);
-    input = removeFakeSectionFormatting(input);
-    input = removeMarkdownLinks(input);
-    input = removeTodoistLinks(input);
-    input = removeAppLinks(input);
-    return input;
-}
-/**
- * Takes an array of tasks and returns a new array with sanitized content
- * added as 'sanitizedContent' property to each task.
- *
- * @see {@link getSanitizedContent}
- *
- * @example
- * const tasks = [{ content: '**Bold** task', ... }]
- * getSanitizedTasks(tasks) // [{ content: '**Bold** task', sanitizedContent: 'Bold task', ... }]
- *
- * @param tasks - Array of Task objects to sanitize
- * @returns Array of tasks with added sanitizedContent property
- */
-function getSanitizedTasks(tasks) {
-    return tasks.map((task) => (Object.assign(Object.assign({}, task), { sanitizedContent: getSanitizedContent(task.content) })));
-}

package/dist/cjs/utils/sync-helpers.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCommand = createCommand;
-const uuid_1 = require("uuid");
-/**
- * Creates a strongly-typed Sync API command with an auto-generated UUID.
- *
- * @param type - The command type (e.g. `'item_add'`, `'project_update'`).
- * @param args - The command arguments, constrained by the command type.
- * @param tempId - Optional temporary ID for referencing the created resource in subsequent commands.
- * @returns A fully formed `SyncCommand` ready to include in a sync request.
- *
- * @example
- * ```typescript
- * const cmd = createCommand('item_add', { content: 'Buy milk', priority: 2 })
- * // cmd.type === 'item_add'
- * // cmd.args is typed as TaskAddArgs
- * ```
- */
-function createCommand(type, args, tempId) {
-    return Object.assign({ type, uuid: (0, uuid_1.v4)(), args: args }, (tempId !== undefined ? { tempId } : {}));
-}