@doist/todoist-api-typescript 7.9.0 → 7.10.0

package/dist/types/utils/colors.d.ts

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

package/dist/types/utils/index.d.ts

@@ -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/types/utils/multipart-upload.d.ts

@@ -1,54 +0,0 @@
-import type { CustomFetch } from '../types/http.js';
-type UploadMultipartFileArgs = {
-    baseUrl: string;
-    authToken: string;
-    endpoint: string;
-    file: Buffer | NodeJS.ReadableStream | string | Blob;
-    fileName?: string;
-    additionalFields: Record<string, string | number | boolean>;
-    requestId?: string;
-    customFetch?: CustomFetch;
-};
-/**
- * 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 declare function uploadMultipartFile<T>(args: UploadMultipartFileArgs): Promise<T>;
-export {};

package/dist/types/utils/processing-helpers.d.ts

@@ -1 +0,0 @@
-export declare function customCamelCase(input: string): string;

package/dist/types/utils/sanitization.d.ts

@@ -1,35 +0,0 @@
-import { Task } from '../types/index.js';
-export type TaskWithSanitizedContent = Task & {
-    sanitizedContent: string;
-};
-/**
- * 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 declare function getSanitizedContent(input: string): string;
-/**
- * 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 declare function getSanitizedTasks(tasks: Task[]): TaskWithSanitizedContent[];

package/dist/types/utils/sync-helpers.d.ts

@@ -1,17 +0,0 @@
-import type { SyncCommandType, SyncCommandsMap, SyncCommand } from '../types/sync/commands/index.js';
-/**
- * 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 declare function createCommand<T extends SyncCommandType>(type: T, args: SyncCommandsMap[T], tempId?: string): SyncCommand<T>;

package/dist/types/utils/uncompletable-helpers.d.ts

@@ -1,30 +0,0 @@
-/**
- * Adds the uncompletable prefix (* ) to task content if not already present
- * @param content - The task content
- * @returns Content with uncompletable prefix added
- */
-export declare function addUncompletablePrefix(content: string): string;
-/**
- * Removes the uncompletable prefix (* ) from task content if present
- * @param content - The task content
- * @returns Content with uncompletable prefix removed
- */
-export declare function removeUncompletablePrefix(content: string): string;
-/**
- * Checks if task content has the uncompletable prefix (* )
- * @param content - The task content
- * @returns True if content starts with uncompletable prefix
- */
-export declare function hasUncompletablePrefix(content: string): boolean;
-/**
- * Processes task content based on isUncompletable flag, with content prefix taking precedence
- * @param content - The original task content
- * @param isUncompletable - Optional flag to make task uncompletable
- * @returns Processed content
- *
- * Logic:
- * - If content already has * prefix, task is uncompletable regardless of flag
- * - If content doesn't have * prefix and isUncompletable is true, add the prefix
- * - If isUncompletable is undefined or false (and no prefix), leave content unchanged
- */
-export declare function processTaskContent(content: string, isUncompletable?: boolean): string;

package/dist/types/utils/url-helpers.d.ts

@@ -1,32 +0,0 @@
-/**
- * Formats a Date object to YYYY-MM-DD string format.
- *
- * @internal
- * @param date The Date object to format.
- * @returns The formatted date string in YYYY-MM-DD format.
- */
-export declare function formatDateToYYYYMMDD(date: Date): string;
-/**
- * Generate the URL for a given task.
- *
- * @param taskId The ID of the task.
- * @param content The content of the task.
- * @returns The URL string for the task view.
- */
-export declare function getTaskUrl(taskId: string, content?: string): string;
-/**
- * Generate the URL for a given project.
- *
- * @param projectId The ID of the project.
- * @param name The name of the project.
- * @returns The URL string for the project view.
- */
-export declare function getProjectUrl(projectId: string, name?: string): string;
-/**
- * Generate the URL for a given section.
- *
- * @param sectionId The ID of the section.
- * @param name The name of the section.
- * @returns The URL string for the section view.
- */
-export declare function getSectionUrl(sectionId: string, name?: string): string;