@doist/todoist-api-typescript 7.9.0 → 7.10.0

package/dist/esm/types/workspaces/requests.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/workspaces/types.js

@@ -1,134 +0,0 @@
-import { z } from 'zod';
-import { DueDateSchema, DeadlineSchema } from '../tasks/types.js';
-/** Available project collaborator roles. */
-export const COLLABORATOR_ROLES = [
-    'CREATOR',
-    'ADMIN',
-    'READ_WRITE',
-    'EDIT_ONLY',
-    'COMPLETE_ONLY',
-];
-/**
- * Available workspace roles.
- */
-export const WORKSPACE_ROLES = ['ADMIN', 'MEMBER', 'GUEST'];
-export const WorkspaceRoleSchema = z.enum(WORKSPACE_ROLES);
-export const WorkspaceUserSchema = z.object({
-    userId: z.string(),
-    workspaceId: z.string(),
-    userEmail: z.string(),
-    fullName: z.string(),
-    timezone: z.string(),
-    role: WorkspaceRoleSchema,
-    imageId: z.string().nullable(),
-    isDeleted: z.boolean().default(false),
-});
-export const WorkspaceInvitationSchema = z.object({
-    id: z.string().default('0'),
-    inviterId: z.string(),
-    userEmail: z.string(),
-    workspaceId: z.string(),
-    role: WorkspaceRoleSchema,
-    isExistingUser: z.boolean(),
-});
-export const PlanPriceSchema = z.object({
-    currency: z.string(),
-    amount: z.union([z.number(), z.string()]),
-    interval: z.string().optional(),
-});
-export const FormattedPriceListingSchema = z.object({
-    currency: z.string().optional(),
-    amount: z.number().optional(),
-    interval: z.string().optional(),
-    formatted: z.string().optional(),
-});
-/** Available workspace plan names. */
-export const WORKSPACE_CURRENT_PLANS = ['Business', 'Starter'];
-/** Available workspace plan statuses. */
-export const WORKSPACE_PLAN_STATUSES = [
-    'Active',
-    'Downgraded',
-    'Cancelled',
-    'NeverSubscribed',
-];
-export const WorkspacePlanDetailsSchema = z.object({
-    currentMemberCount: z.number(),
-    currentPlan: z.enum(WORKSPACE_CURRENT_PLANS),
-    currentPlanStatus: z.enum(WORKSPACE_PLAN_STATUSES),
-    downgradeAt: z.string().nullable(),
-    currentActiveProjects: z.number(),
-    maximumActiveProjects: z.number(),
-    priceList: z.array(FormattedPriceListingSchema),
-    workspaceId: z.number(),
-    isTrialing: z.boolean(),
-    trialEndsAt: z.string().nullable(),
-    cancelAtPeriodEnd: z.boolean(),
-    hasTrialed: z.boolean(),
-    planPrice: PlanPriceSchema.nullable(),
-    hasBillingPortal: z.boolean(),
-    hasBillingPortalSwitchToAnnual: z.boolean(),
-});
-export const JoinWorkspaceResultSchema = z.object({
-    customSortingApplied: z.boolean(),
-    projectSortPreference: z.string(),
-    role: WorkspaceRoleSchema,
-    userId: z.string(),
-    workspaceId: z.string(),
-});
-/**
- * Available workspace plans.
- */
-export const WORKSPACE_PLANS = ['STARTER', 'BUSINESS'];
-export const WorkspacePlanSchema = z.enum(WORKSPACE_PLANS);
-/**
- * Workspace resource limits.
- */
-export const WorkspaceLimitsSchema = z
-    .object({
-    current: z.record(z.string(), z.any()).nullable(),
-    next: z.record(z.string(), z.any()).nullable(),
-})
-    .catchall(z.any());
-/**
- * Workspace properties (flexible object for unknown fields).
- */
-export const WorkspacePropertiesSchema = z.record(z.string(), z.unknown());
-/**
- * Represents a workspace in Todoist.
- */
-export const WorkspaceSchema = z.object({
-    id: z.string(),
-    name: z.string(),
-    plan: WorkspacePlanSchema,
-    role: WorkspaceRoleSchema,
-    inviteCode: z.string(),
-    isLinkSharingEnabled: z.boolean(),
-    isGuestAllowed: z.boolean(),
-    limits: WorkspaceLimitsSchema,
-    logoBig: z.string().nullish(),
-    logoMedium: z.string().nullish(),
-    logoSmall: z.string().nullish(),
-    logoS640: z.string().nullish(),
-    createdAt: z.string(),
-    creatorId: z.string(),
-    properties: WorkspacePropertiesSchema,
-});
-export const MemberActivityInfoSchema = z.object({
-    userId: z.string(),
-    tasksAssigned: z.number().int(),
-    tasksOverdue: z.number().int(),
-});
-export const WorkspaceUserTaskSchema = z.object({
-    id: z.string(),
-    content: z.string(),
-    responsibleUid: z.string().nullable(),
-    due: DueDateSchema.nullable(),
-    deadline: DeadlineSchema.nullable(),
-    labels: z.array(z.string()),
-    notesCount: z.number().int(),
-    projectId: z.string(),
-    projectName: z.string(),
-    priority: z.number().int(),
-    description: z.string(),
-    isOverdue: z.boolean(),
-});

package/dist/esm/utils/activity-helpers.js

@@ -1,53 +0,0 @@
-/**
- * Converts modern SDK object type naming to legacy API naming.
- * Maps 'task' -> 'item' and 'comment' -> 'note' for API requests.
- * Other values pass through unchanged.
- *
- * @internal
- * @param objectType The object type using modern naming.
- * @returns The object type using legacy API naming.
- */
-export function normalizeObjectTypeForApi(objectType) {
-    if (!objectType)
-        return objectType;
-    if (objectType === 'task')
-        return 'item';
-    if (objectType === 'comment')
-        return 'note';
-    return objectType;
-}
-/**
- * Converts legacy API object type naming to modern SDK naming.
- * Maps 'item' -> 'task' and 'note' -> 'comment' for SDK responses.
- * Other values pass through unchanged.
- *
- * @internal
- * @param objectType The object type using legacy API naming.
- * @returns The object type using modern SDK naming.
- */
-export function denormalizeObjectTypeFromApi(objectType) {
-    if (!objectType)
-        return objectType;
-    if (objectType === 'item')
-        return 'task';
-    if (objectType === 'note')
-        return 'comment';
-    return objectType;
-}
-/**
- * Normalizes an `ActivityObjectEventType` filter string for the API,
- * converting modern object type names to legacy API names.
- * e.g. 'task:added' -> 'item:added', 'comment:' -> 'note:', ':deleted' -> ':deleted'
- *
- * @internal
- */
-export function normalizeObjectEventTypeForApi(filter) {
-    var _a, _b;
-    const colonIndex = filter.indexOf(':');
-    if (colonIndex === -1) {
-        return (_a = normalizeObjectTypeForApi(filter)) !== null && _a !== void 0 ? _a : filter;
-    }
-    const objectPart = filter.slice(0, colonIndex);
-    const eventPart = filter.slice(colonIndex); // includes the colon
-    return `${(_b = normalizeObjectTypeForApi(objectPart)) !== null && _b !== void 0 ? _b : objectPart}${eventPart}`;
-}

package/dist/esm/utils/case-conversion.js

@@ -1,61 +0,0 @@
-import camelcase from 'camelcase';
-import emojiRegex from 'emoji-regex';
-/**
- * Checks if a string is a solitary emoji
- */
-function isEmojiKey(input) {
-    const regex = emojiRegex();
-    const match = input.match(regex);
-    return match !== null && match.join('') === input;
-}
-/**
- * Custom camelCase function that preserves emoji strings
- */
-export function customCamelCase(input) {
-    // If the value is a solitary emoji string, return the key as-is
-    if (isEmojiKey(input)) {
-        return input;
-    }
-    return camelcase(input);
-}
-/**
- * Converts object keys from snake_case to camelCase recursively
- */
-export function camelCaseKeys(obj) {
-    if (obj === null || obj === undefined) {
-        return obj;
-    }
-    if (Array.isArray(obj)) {
-        return obj.map((item) => camelCaseKeys(item));
-    }
-    if (typeof obj === 'object' && obj.constructor === Object) {
-        const converted = {};
-        for (const [key, value] of Object.entries(obj)) {
-            const camelKey = customCamelCase(key);
-            converted[camelKey] = camelCaseKeys(value);
-        }
-        return converted;
-    }
-    return obj;
-}
-/**
- * Converts object keys from camelCase to snake_case recursively
- */
-export function snakeCaseKeys(obj) {
-    if (obj === null || obj === undefined) {
-        return obj;
-    }
-    if (Array.isArray(obj)) {
-        return obj.map((item) => snakeCaseKeys(item));
-    }
-    if (typeof obj === 'object' && obj.constructor === Object) {
-        const converted = {};
-        for (const [key, value] of Object.entries(obj)) {
-            // Convert camelCase to snake_case
-            const snakeKey = key.replace(/([A-Z])/g, '_$1').toLowerCase();
-            converted[snakeKey] = snakeCaseKeys(value);
-        }
-        return converted;
-    }
-    return obj;
-}

package/dist/esm/utils/colors.js

@@ -1,139 +0,0 @@
-export const berryRed = {
-    key: 'berry_red',
-    displayName: 'Berry Red',
-    hexValue: '#b8255f',
-};
-export const red = {
-    key: 'red',
-    displayName: 'Red',
-    hexValue: '#db4035',
-};
-export const orange = {
-    key: 'orange',
-    displayName: 'Orange',
-    hexValue: '#ff9933',
-};
-export const yellow = {
-    key: 'yellow',
-    displayName: 'Yellow',
-    hexValue: '#fad000',
-};
-export const oliveGreen = {
-    key: 'olive_green',
-    displayName: 'Olive Green',
-    hexValue: '#afb83b',
-};
-export const limeGreen = {
-    key: 'lime_green',
-    displayName: 'Lime Green',
-    hexValue: '#7ecc49',
-};
-export const green = {
-    key: 'green',
-    displayName: 'Green',
-    hexValue: '#299438',
-};
-export const mintGreen = {
-    key: 'mint_green',
-    displayName: 'Mint Green',
-    hexValue: '#6accbc',
-};
-export const teal = {
-    key: 'teal',
-    displayName: 'Teal',
-    hexValue: '#158fad',
-};
-export const skyBlue = {
-    key: 'sky_blue',
-    displayName: 'Sky Blue',
-    hexValue: '#14aaf5',
-};
-export const lightBlue = {
-    key: 'light_blue',
-    displayName: 'Light Blue',
-    hexValue: '#96c3eb',
-};
-export const blue = {
-    key: 'blue',
-    displayName: 'Blue',
-    hexValue: '#4073ff',
-};
-export const grape = {
-    key: 'grape',
-    displayName: 'Grape',
-    hexValue: '#884dff',
-};
-export const violet = {
-    key: 'violet',
-    displayName: 'Violet',
-    hexValue: '#af38eb',
-};
-export const lavender = {
-    key: 'lavender',
-    displayName: 'Lavender',
-    hexValue: '#eb96eb',
-};
-export const magenta = {
-    key: 'magenta',
-    displayName: 'Magenta',
-    hexValue: '#e05194',
-};
-export const salmon = {
-    key: 'salmon',
-    displayName: 'Salmon',
-    hexValue: '#ff8d85',
-};
-export const charcoal = {
-    key: 'charcoal',
-    displayName: 'Charcoal',
-    hexValue: '#808080',
-};
-export const grey = {
-    key: 'grey',
-    displayName: 'Grey',
-    hexValue: '#b8b8b8',
-};
-export const taupe = {
-    key: 'taupe',
-    displayName: 'Taupe',
-    hexValue: '#ccac93',
-};
-export const colors = [
-    berryRed,
-    red,
-    orange,
-    yellow,
-    oliveGreen,
-    limeGreen,
-    green,
-    mintGreen,
-    teal,
-    skyBlue,
-    lightBlue,
-    blue,
-    grape,
-    violet,
-    lavender,
-    magenta,
-    salmon,
-    charcoal,
-    grey,
-    taupe,
-];
-export const defaultColor = 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'
- * ```
- */
-export function getColorByKey(colorKey) {
-    const color = colors.find((color) => color.key === colorKey);
-    return color !== null && color !== void 0 ? color : defaultColor;
-}

package/dist/esm/utils/index.js

@@ -1,4 +0,0 @@
-export * from './colors.js';
-export * from './sanitization.js';
-export { getTaskUrl, getProjectUrl, getSectionUrl } from './url-helpers.js';
-export { createCommand } from './sync-helpers.js';

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

@@ -1,142 +0,0 @@
-import { fetchWithRetry } from '../transport/fetch-with-retry.js';
-/**
- * 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' }
- * )
- * ```
- */
-export 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([
-            import('form-data'),
-            import('fs'),
-            import('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 fetchWithRetry({
-        url,
-        options: {
-            method: 'POST',
-            body,
-            headers,
-            timeout: 30000, // 30 second timeout for file uploads
-        },
-        customFetch,
-    });
-    return response.data;
-}

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

@@ -1,12 +0,0 @@
-import camelcase from 'camelcase';
-import emojiRegex from 'emoji-regex';
-function isEmojiKey(key) {
-    const regex = emojiRegex();
-    return regex.test(key);
-}
-export function customCamelCase(input) {
-    // If the value is a solitary emoji string, return the key as-is
-    if (isEmojiKey(input))
-        return input;
-    return camelcase(input);
-}

package/dist/esm/utils/sanitization.js

@@ -1,112 +0,0 @@
-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
- */
-export 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
- */
-export function getSanitizedTasks(tasks) {
-    return tasks.map((task) => (Object.assign(Object.assign({}, task), { sanitizedContent: getSanitizedContent(task.content) })));
-}

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

@@ -1,19 +0,0 @@
-import { v4 as uuidv4 } from '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
- * ```
- */
-export function createCommand(type, args, tempId) {
-    return Object.assign({ type, uuid: uuidv4(), args: args }, (tempId !== undefined ? { tempId } : {}));
-}