@todoist/sdk 0.0.1 → 19.0.0

package/dist/types/types/sync/user-preferences.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+/** Available date format options. */
+export declare const DATE_FORMATS: readonly ["DD/MM/YYYY", "MM/DD/YYYY"];
+/** User date format preference. */
+export type DateFormat = (typeof DATE_FORMATS)[number];
+/** Available time format options. */
+export declare const TIME_FORMATS: readonly ["24h", "12h"];
+/** User time format preference. */
+export type TimeFormat = (typeof TIME_FORMATS)[number];
+/** Available days of the week. */
+export declare const DAYS_OF_WEEK: readonly ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"];
+/** Day of the week. */
+export type DayOfWeek = (typeof DAYS_OF_WEEK)[number];
+export declare const DATE_FORMAT_FROM_API: {
+    readonly 0: "DD/MM/YYYY";
+    readonly 1: "MM/DD/YYYY";
+};
+export declare const TIME_FORMAT_FROM_API: {
+    readonly 0: "24h";
+    readonly 1: "12h";
+};
+export declare const DAY_OF_WEEK_FROM_API: {
+    readonly 1: "Monday";
+    readonly 2: "Tuesday";
+    readonly 3: "Wednesday";
+    readonly 4: "Thursday";
+    readonly 5: "Friday";
+    readonly 6: "Saturday";
+    readonly 7: "Sunday";
+};
+export declare const DATE_FORMAT_TO_API: Record<DateFormat, 0 | 1>;
+export declare const TIME_FORMAT_TO_API: Record<TimeFormat, 0 | 1>;
+export declare const DAY_OF_WEEK_TO_API: Record<DayOfWeek, 1 | 2 | 3 | 4 | 5 | 6 | 7>;
+/** Zod read-schema: parse API 0/1 integer, emit boolean */
+export declare const BooleanFromZeroOneSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>, z.ZodTransform<boolean, 0 | 1>>;
+/** Zod read-schemas: parse API numbers, emit descriptive strings */
+export declare const DateFormatSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>, z.ZodTransform<"DD/MM/YYYY" | "MM/DD/YYYY", 0 | 1>>;
+export declare const TimeFormatSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>, z.ZodTransform<"24h" | "12h", 0 | 1>>;
+export declare const DayOfWeekSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<6>, z.ZodLiteral<7>]>, z.ZodTransform<"Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday", 1 | 2 | 3 | 4 | 5 | 6 | 7>>;

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

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

package/dist/types/types/tasks/requests.d.ts

@@ -0,0 +1,197 @@
+import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
+import type { Duration, Task } from './types.js';
+/**
+ * Arguments for creating a new task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/create_task_api_v1_tasks_post
+ */
+export type AddTaskArgs = {
+    content: string;
+    description?: string;
+    projectId?: string;
+    sectionId?: string;
+    parentId?: string;
+    order?: number;
+    labels?: string[];
+    priority?: number;
+    assigneeId?: string;
+    dueString?: string;
+    dueLang?: string;
+    deadlineLang?: string;
+    deadlineDate?: string;
+    isUncompletable?: boolean;
+} & RequireOneOrNone<{
+    dueDate?: string;
+    dueDatetime?: string;
+}> & RequireAllOrNone<{
+    duration?: Duration['amount'];
+    durationUnit?: Duration['unit'];
+}>;
+/**
+ * Arguments for retrieving tasks.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type GetTasksArgs = {
+    projectId?: string;
+    sectionId?: string;
+    parentId?: string;
+    label?: string;
+    ids?: string[];
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving tasks by filter.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_by_filter_api_v1_tasks_filter_get
+ */
+export type GetTasksByFilterArgs = {
+    query: string;
+    lang?: string;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving completed tasks by completion date.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_completion_date_api_v1_tasks_completed_by_completion_date_get
+ */
+export type GetCompletedTasksByCompletionDateArgs = {
+    since: string;
+    until: string;
+    workspaceId?: string | null;
+    projectId?: string | null;
+    sectionId?: string | null;
+    parentId?: string | null;
+    filterQuery?: string | null;
+    filterLang?: string | null;
+    cursor?: string | null;
+    limit?: number;
+    publicKey?: string | null;
+};
+/**
+ * Arguments for retrieving completed tasks by due date.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_due_date_api_v1_tasks_completed_by_due_date_get
+ */
+export type GetCompletedTasksByDueDateArgs = {
+    since: string;
+    until: string;
+    workspaceId?: string | null;
+    projectId?: string | null;
+    sectionId?: string | null;
+    parentId?: string | null;
+    filterQuery?: string | null;
+    filterLang?: string | null;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for searching completed tasks.
+ */
+export type SearchCompletedTasksArgs = {
+    query: string;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type GetTasksResponse = {
+    results: Task[];
+    nextCursor: string | null;
+};
+/**
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_due_date_api_v1_tasks_completed_by_due_date_get
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_completion_date_api_v1_tasks_completed_by_completion_date_get
+ */
+export type GetCompletedTasksResponse = {
+    items: Task[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for updating a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/update_task_api_v1_tasks__task_id__post
+ */
+export type UpdateTaskArgs = {
+    content?: string;
+    description?: string;
+    labels?: string[];
+    priority?: number;
+    /**
+     * Sort order of the task within its parent/project.
+     * Internally mapped to `child_order` in the API payload.
+     */
+    order?: number;
+    /**
+     * Natural language due date.
+     * Use `"no date"` to clear a due date, or `null` as an SDK alias for the same behavior.
+     */
+    dueString?: (string & {}) | 'no date' | null;
+    dueLang?: string | null;
+    assigneeId?: string | null;
+    /**
+     * Deadline date in `YYYY-MM-DD` format.
+     * Use `null` to clear a task deadline.
+     */
+    deadlineDate?: string | null;
+    deadlineLang?: string | null;
+    isUncompletable?: boolean;
+} & RequireOneOrNone<{
+    dueDate?: string;
+    dueDatetime?: string;
+}> & RequireAllOrNone<{
+    duration?: Duration['amount'];
+    durationUnit?: Duration['unit'];
+}>;
+/**
+ * Arguments for quick adding a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
+ */
+export type QuickAddTaskArgs = {
+    text: string;
+    note?: string;
+    reminder?: string;
+    autoReminder?: boolean;
+    meta?: boolean;
+    isUncompletable?: boolean;
+};
+/**
+ * Response from quick adding a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
+ */
+/**
+ * Arguments for moving a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/move_task_api_v1_tasks__task_id__move_post
+ */
+export type MoveTaskArgs = RequireExactlyOne<{
+    projectId?: string;
+    sectionId?: string;
+    parentId?: string;
+}>;
+/**
+ * Arguments for getting all completed tasks.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_all_completed_items_api_v1_tasks_completed_get
+ */
+export type GetAllCompletedTasksArgs = {
+    /** Filter by project ID. */
+    projectId?: string | null;
+    /** Filter by label name. */
+    label?: string | null;
+    /** Number of results to return (max 200, default 30). */
+    limit?: number;
+    /** Number of results to skip (default 0). */
+    offset?: number;
+    /** Return items completed after this date. */
+    since?: Date | null;
+    /** Return items completed before this date. */
+    until?: Date | null;
+    /** Include comment data in the response. */
+    annotateNotes?: boolean;
+    /** Include task data in the response. */
+    annotateItems?: boolean;
+};
+/**
+ * Response from getting all completed tasks.
+ */
+export type GetAllCompletedTasksResponse = {
+    projects: Record<string, Record<string, unknown>>;
+    sections: Record<string, Record<string, unknown>>;
+    items: Task[];
+};

package/dist/types/types/tasks/types.d.ts

@@ -0,0 +1,162 @@
+import { z } from 'zod';
+export declare const DueDateSchema: z.ZodObject<{
+    isRecurring: z.ZodBoolean;
+    string: z.ZodString;
+    date: z.ZodString;
+    datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Represents a due date for a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type DueDate = z.infer<typeof DueDateSchema>;
+/** Available duration units for task deadlines. */
+export declare const DURATION_UNITS: readonly ["minute", "day"];
+/** Unit of time for a task duration. */
+export type DurationUnit = (typeof DURATION_UNITS)[number];
+export declare const DurationSchema: z.ZodObject<{
+    amount: z.ZodNumber;
+    unit: z.ZodEnum<{
+        minute: "minute";
+        day: "day";
+    }>;
+}, z.core.$strip>;
+/**
+ * Represents a duration for a task deadline.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks
+ */
+export type Duration = z.infer<typeof DurationSchema>;
+export declare const DeadlineSchema: z.ZodObject<{
+    date: z.ZodString;
+    lang: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a task deadline.
+ */
+export type Deadline = z.infer<typeof DeadlineSchema>;
+export declare const TaskSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    projectId: z.ZodString;
+    sectionId: z.ZodNullable<z.ZodString>;
+    parentId: z.ZodNullable<z.ZodString>;
+    addedByUid: z.ZodNullable<z.ZodString>;
+    assignedByUid: z.ZodNullable<z.ZodString>;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    labels: z.ZodArray<z.ZodString>;
+    deadline: z.ZodNullable<z.ZodObject<{
+        date: z.ZodString;
+        lang: z.ZodString;
+    }, z.core.$strip>>;
+    duration: z.ZodNullable<z.ZodObject<{
+        amount: z.ZodNumber;
+        unit: z.ZodEnum<{
+            minute: "minute";
+            day: "day";
+        }>;
+    }, z.core.$strip>>;
+    checked: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    addedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    updatedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    due: z.ZodNullable<z.ZodObject<{
+        isRecurring: z.ZodBoolean;
+        string: z.ZodString;
+        date: z.ZodString;
+        datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    priority: z.ZodNumber;
+    childOrder: z.ZodNumber;
+    content: z.ZodString;
+    description: z.ZodString;
+    dayOrder: z.ZodNumber;
+    isCollapsed: z.ZodBoolean;
+    isUncompletable: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodTransform<{
+    isUncompletable: boolean;
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: Date | null;
+    completedAt: Date | null;
+    updatedAt: Date | null;
+    due: {
+        isRecurring: boolean;
+        string: string;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: Date | null;
+    completedAt: Date | null;
+    updatedAt: Date | null;
+    due: {
+        isRecurring: boolean;
+        string: string;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+    isUncompletable: boolean;
+}>>;
+/**
+ * Represents a task in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks
+ */
+export type Task = z.infer<typeof TaskSchema>;

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

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/types/types/templates/requests.d.ts

@@ -0,0 +1,92 @@
+import type { Comment } from '../comments/types.js';
+import type { PersonalProject, WorkspaceProject } from '../projects/types.js';
+import type { Section } from '../sections/types.js';
+import type { Task } from '../tasks/types.js';
+/**
+ * Arguments for exporting a project as a template file.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/export_as_file_api_v1_templates_file_get
+ */
+export type ExportTemplateFileArgs = {
+    /** The project ID to export. */
+    projectId: string;
+    /** Whether to use relative dates in the export. */
+    useRelativeDates?: boolean;
+};
+/**
+ * Arguments for exporting a project as a template URL.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/export_as_url_api_v1_templates_url_get
+ */
+export type ExportTemplateUrlArgs = {
+    /** The project ID to export. */
+    projectId: string;
+    /** Whether to use relative dates in the export. */
+    useRelativeDates?: boolean;
+};
+/**
+ * Response from exporting a project as a template URL.
+ */
+export type ExportTemplateUrlResponse = {
+    fileName: string;
+    fileUrl: string;
+};
+/**
+ * Arguments for creating a project from a template file.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/create_project_from_file_api_v1_templates_create_project_from_file_post
+ */
+export type CreateProjectFromTemplateArgs = {
+    /** Name for the new project. */
+    name: string;
+    /** The template file content. */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** Optional file name (required for Buffer/Stream). */
+    fileName?: string;
+    /** Optional workspace ID. */
+    workspaceId?: string | null;
+};
+/**
+ * Response from creating a project from a template.
+ */
+export type CreateProjectFromTemplateResponse = {
+    status: string;
+    projectId: string;
+    templateType: string;
+    projects: (PersonalProject | WorkspaceProject)[];
+    sections: Section[];
+    tasks: Task[];
+    comments: Comment[];
+};
+/**
+ * Arguments for importing a template file into an existing project.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/import_into_project_from_file_api_v1_templates_import_into_project_from_file_post
+ */
+export type ImportTemplateIntoProjectArgs = {
+    /** The project ID to import into. */
+    projectId: string;
+    /** The template file content. */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** Optional file name (required for Buffer/Stream). */
+    fileName?: string;
+};
+/**
+ * Arguments for importing a template by ID into an existing project.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/import_into_project_from_template_id_api_v1_templates_import_into_project_from_template_id_post
+ */
+export type ImportTemplateFromIdArgs = {
+    /** The project ID to import into. */
+    projectId: string;
+    /** The template ID to import. */
+    templateId: string;
+    /** Locale for the import (default: 'en'). */
+    locale?: string;
+};
+/**
+ * Response from importing a template into a project.
+ */
+export type ImportTemplateResponse = {
+    status: string;
+    templateType: string;
+    projects: (PersonalProject | WorkspaceProject)[];
+    sections: Section[];
+    tasks: Task[];
+    comments: Comment[];
+};

package/dist/types/types/ui-extensions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

package/dist/types/types/ui-extensions/requests.d.ts

@@ -0,0 +1,108 @@
+import type { ComposerExtensionContext, ContextMenuExtensionContext, UiExtensionType } from './types.js';
+import { UiExtensionTypeEnum } from './types.js';
+/**
+ * Fields common to every UI extension variant — shared across all add/update
+ * request shapes.
+ */
+type BaseUiExtensionFields = {
+    /** HTTPS URL the extension loads. */
+    url: string;
+    /** Extension display name. */
+    name: string;
+    /** Extension description. */
+    description: string;
+    /** Rendered width in pixels. */
+    width?: number | null;
+    /** Rendered height in pixels. */
+    height?: number | null;
+    /** Optional HTTPS URL for the extension icon. */
+    icon?: string | null;
+    /** Extension definition version. Defaults to the backend default. */
+    defVersion?: number;
+    /** Minimum Cardist renderer version required, as a decimal version string (e.g. `'0.60'`). */
+    minimumCardistVersion?: string;
+    /** Optional client-specified extension ID (server generates one if omitted). */
+    extensionId?: string | null;
+};
+/** Arguments for adding a context-menu UI extension. */
+export type AddContextMenuExtensionArgs = BaseUiExtensionFields & {
+    /** The developer application (integration) ID the extension belongs to. */
+    integrationId: string;
+    extensionType: typeof UiExtensionTypeEnum.ContextMenu;
+    /** Where the extension appears. */
+    contextType: ContextMenuExtensionContext;
+};
+/** Arguments for adding a composer UI extension. */
+export type AddComposerExtensionArgs = BaseUiExtensionFields & {
+    /** The developer application (integration) ID the extension belongs to. */
+    integrationId: string;
+    extensionType: typeof UiExtensionTypeEnum.Composer;
+    /** Which composer the extension appears in. */
+    composerType: ComposerExtensionContext;
+};
+/** Arguments for adding a settings UI extension. */
+export type AddSettingsExtensionArgs = BaseUiExtensionFields & {
+    /** The developer application (integration) ID the extension belongs to. */
+    integrationId: string;
+    extensionType: typeof UiExtensionTypeEnum.Settings;
+};
+/**
+ * Arguments for adding a new UI extension to a developer application.
+ * Discriminated on `extensionType` so impossible combinations
+ * (e.g. `settings` + `contextType`) fail at compile time.
+ */
+export type AddUiExtensionArgs = AddContextMenuExtensionArgs | AddComposerExtensionArgs | AddSettingsExtensionArgs;
+/**
+ * Fields that are optional on every update variant.
+ */
+type UpdateUiExtensionFields = {
+    url?: string;
+    name?: string;
+    description?: string;
+    width?: number | null;
+    height?: number | null;
+    icon?: string | null;
+    defVersion?: number;
+    minimumCardistVersion?: string;
+    extensionId?: string | null;
+};
+/**
+ * Arguments for updating a context-menu UI extension.
+ * `extensionType` is required to discriminate the variant — callers
+ * already have it from the fetched `UiExtension`.
+ */
+export type UpdateContextMenuExtensionArgs = UpdateUiExtensionFields & {
+    extensionType: typeof UiExtensionTypeEnum.ContextMenu;
+    contextType?: ContextMenuExtensionContext;
+};
+/**
+ * Arguments for updating a composer UI extension.
+ */
+export type UpdateComposerExtensionArgs = UpdateUiExtensionFields & {
+    extensionType: typeof UiExtensionTypeEnum.Composer;
+    composerType?: ComposerExtensionContext;
+};
+/**
+ * Arguments for updating a settings UI extension.
+ */
+export type UpdateSettingsExtensionArgs = UpdateUiExtensionFields & {
+    extensionType: typeof UiExtensionTypeEnum.Settings;
+};
+/**
+ * Arguments for updating a UI extension — all value fields are optional
+ * but `extensionType` is required so TypeScript can discriminate which
+ * variant-specific fields (`contextType`, `composerType`) apply.
+ */
+export type UpdateUiExtensionArgs = UpdateContextMenuExtensionArgs | UpdateComposerExtensionArgs | UpdateSettingsExtensionArgs;
+export type { UiExtensionType };
+/**
+ * Arguments for uploading a UI extension icon.
+ */
+export type UploadUiExtensionIconArgs = {
+    /** The UI extension ID. */
+    uiExtensionId: string;
+    /** The icon file to upload (Buffer, Stream, or file path). */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** The file name (required for Buffer/Stream uploads). */
+    fileName?: string;
+};