@doist/todoist-api-typescript 5.2.1 → 5.4.0

package/dist/TodoistApi.d.ts

@@ -1,5 +1,5 @@
-import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task } from './types/entities';
-import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse } from './types/requests';
+import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser } from './types/entities';
+import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse } from './types/requests';
 /**
  * A client for interacting with the Todoist API v1.
  * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
@@ -33,6 +33,12 @@ export declare class TodoistApi {
      * Optional custom API base URL. If not provided, defaults to Todoist's standard API endpoint
      */
     baseUrl?: string);
+    /**
+     * Retrieves information about the authenticated user.
+     *
+     * @returns A promise that resolves to the current user's information.
+     */
+    getUser(): Promise<CurrentUser>;
     /**
      * Retrieves a single active (non-completed) task by its ID.
      *
@@ -139,6 +145,13 @@ export declare class TodoistApi {
      * @returns A promise that resolves to an array of projects.
      */
     getProjects(args?: GetProjectsArgs): Promise<GetProjectsResponse>;
+    /**
+     * Retrieves all archived projects with optional filters.
+     *
+     * @param args - Optional filters for retrieving archived projects.
+     * @returns A promise that resolves to an array of archived projects.
+     */
+    getArchivedProjects(args?: GetArchivedProjectsArgs): Promise<GetArchivedProjectsResponse>;
     /**
      * Creates a new project with the provided parameters.
      *

package/dist/TodoistApi.js

@@ -101,6 +101,24 @@ var TodoistApi = /** @class */ (function () {
         this.authToken = authToken;
         this.syncApiBase = (0, endpoints_1.getSyncBaseUri)(baseUrl);
     }
+    /**
+     * Retrieves information about the authenticated user.
+     *
+     * @returns A promise that resolves to the current user's information.
+     */
+    TodoistApi.prototype.getUser = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_USER, this.authToken)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, (0, validators_1.validateCurrentUser)(response.data)];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a single active (non-completed) task by its ID.
      *
@@ -434,6 +452,29 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves all archived projects with optional filters.
+     *
+     * @param args - Optional filters for retrieving archived projects.
+     * @returns A promise that resolves to an array of archived projects.
+     */
+    TodoistApi.prototype.getArchivedProjects = function () {
+        return __awaiter(this, arguments, void 0, function (args) {
+            var _a, results, nextCursor;
+            if (args === void 0) { args = {}; }
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_PROJECTS_ARCHIVED, this.authToken, args)];
+                    case 1:
+                        _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
+                        return [2 /*return*/, {
+                                results: (0, validators_1.validateProjectArray)(results),
+                                nextCursor: nextCursor,
+                            }];
+                }
+            });
+        });
+    };
     /**
      * Creates a new project with the provided parameters.
      *

package/dist/consts/endpoints.d.ts

@@ -7,7 +7,6 @@ export declare const ENDPOINT_REST_TASKS = "tasks";
 export declare const ENDPOINT_REST_TASKS_FILTER: string;
 export declare const ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE: string;
 export declare const ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE: string;
-export declare const ENDPOINT_REST_PROJECTS = "projects";
 export declare const ENDPOINT_REST_SECTIONS = "sections";
 export declare const ENDPOINT_REST_LABELS = "labels";
 export declare const ENDPOINT_REST_LABELS_SHARED: string;
@@ -16,7 +15,10 @@ export declare const ENDPOINT_REST_LABELS_SHARED_REMOVE: string;
 export declare const ENDPOINT_REST_COMMENTS = "comments";
 export declare const ENDPOINT_REST_TASK_CLOSE = "close";
 export declare const ENDPOINT_REST_TASK_REOPEN = "reopen";
+export declare const ENDPOINT_REST_PROJECTS = "projects";
+export declare const ENDPOINT_REST_PROJECTS_ARCHIVED: string;
 export declare const ENDPOINT_REST_PROJECT_COLLABORATORS = "collaborators";
+export declare const ENDPOINT_REST_USER = "user";
 export declare const PROJECT_ARCHIVE = "archive";
 export declare const PROJECT_UNARCHIVE = "unarchive";
 export declare const ENDPOINT_SYNC_QUICK_ADD: string;

package/dist/consts/endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
+exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
 var BASE_URI = 'https://api.todoist.com';
@@ -23,7 +23,6 @@ exports.ENDPOINT_REST_TASKS = 'tasks';
 exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS + '/filter';
 exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS + '/completed/by_completion_date';
 exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS + '/completed/by_due_date';
-exports.ENDPOINT_REST_PROJECTS = 'projects';
 exports.ENDPOINT_REST_SECTIONS = 'sections';
 exports.ENDPOINT_REST_LABELS = 'labels';
 exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS + '/shared';
@@ -32,7 +31,10 @@ exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED
 exports.ENDPOINT_REST_COMMENTS = 'comments';
 exports.ENDPOINT_REST_TASK_CLOSE = 'close';
 exports.ENDPOINT_REST_TASK_REOPEN = 'reopen';
+exports.ENDPOINT_REST_PROJECTS = 'projects';
+exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS + '/archived';
 exports.ENDPOINT_REST_PROJECT_COLLABORATORS = 'collaborators';
+exports.ENDPOINT_REST_USER = 'user';
 exports.PROJECT_ARCHIVE = 'archive';
 exports.PROJECT_UNARCHIVE = 'unarchive';
 exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_TASKS + '/quick';

package/dist/types/entities.d.ts

@@ -199,7 +199,7 @@ export declare const PersonalProjectSchema: z.ZodPipe<z.ZodObject<{
     isCollapsed: z.ZodBoolean;
     isShared: z.ZodBoolean;
     parentId: z.ZodNullable<z.ZodString>;
-    inboxProject: z.ZodBoolean;
+    inboxProject: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, z.core.$strip>, z.ZodTransform<{
     url: string;
     id: string;
@@ -528,10 +528,55 @@ export declare const UserSchema: z.ZodObject<{
     email: z.ZodString;
 }, z.core.$strip>;
 /**
- * Represents a user in Todoist.
+ * Represents a user in Todoist (simplified for collaborators).
  * @see https://todoist.com/api/v1/docs#tag/User
  */
 export type User = z.infer<typeof UserSchema>;
+export declare const TimezoneInfoSchema: z.ZodObject<{
+    gmtString: z.ZodString;
+    hours: z.ZodNumber;
+    isDst: z.ZodNumber;
+    minutes: z.ZodNumber;
+    timezone: z.ZodString;
+}, z.core.$strip>;
+export declare const CurrentUserSchema: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    fullName: z.ZodString;
+    avatarBig: z.ZodNullable<z.ZodString>;
+    avatarMedium: z.ZodNullable<z.ZodString>;
+    avatarS640: z.ZodNullable<z.ZodString>;
+    avatarSmall: z.ZodNullable<z.ZodString>;
+    businessAccountId: z.ZodNullable<z.ZodString>;
+    isPremium: z.ZodBoolean;
+    dateFormat: z.ZodNumber;
+    timeFormat: z.ZodNumber;
+    weeklyGoal: z.ZodNumber;
+    dailyGoal: z.ZodNumber;
+    completedCount: z.ZodNumber;
+    completedToday: z.ZodNumber;
+    karma: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    lang: z.ZodString;
+    nextWeek: z.ZodNumber;
+    startDay: z.ZodNumber;
+    startPage: z.ZodString;
+    tzInfo: z.ZodObject<{
+        gmtString: z.ZodString;
+        hours: z.ZodNumber;
+        isDst: z.ZodNumber;
+        minutes: z.ZodNumber;
+        timezone: z.ZodString;
+    }, z.core.$strip>;
+    inboxProjectId: z.ZodString;
+    daysOff: z.ZodArray<z.ZodNumber>;
+    weekendStartDay: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Represents the current authenticated user with detailed information.
+ * @see https://todoist.com/api/v1/docs#tag/User
+ */
+export type CurrentUser = z.infer<typeof CurrentUserSchema>;
 export declare const ColorSchema: z.ZodObject<{
     id: z.ZodNumber;
     key: z.ZodString;

package/dist/types/entities.js

@@ -22,7 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColorSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.WorkspaceProjectSchema = exports.PersonalProjectSchema = exports.BaseProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
+exports.ColorSchema = exports.CurrentUserSchema = exports.TimezoneInfoSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.WorkspaceProjectSchema = exports.PersonalProjectSchema = exports.BaseProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
 var zod_1 = require("zod");
 var urlHelpers_1 = require("../utils/urlHelpers");
 exports.DueDateSchema = zod_1.z
@@ -101,7 +101,7 @@ exports.BaseProjectSchema = zod_1.z.object({
  */
 exports.PersonalProjectSchema = exports.BaseProjectSchema.extend({
     parentId: zod_1.z.string().nullable(),
-    inboxProject: zod_1.z.boolean(),
+    inboxProject: zod_1.z.boolean().optional().default(false),
 }).transform(function (data) {
     return __assign(__assign({}, data), { url: (0, urlHelpers_1.getProjectUrl)(data.id, data.name) });
 });
@@ -191,6 +191,40 @@ exports.UserSchema = zod_1.z.object({
     name: zod_1.z.string(),
     email: zod_1.z.string(),
 });
+exports.TimezoneInfoSchema = zod_1.z.object({
+    gmtString: zod_1.z.string(),
+    hours: zod_1.z.number().int(),
+    isDst: zod_1.z.number().int(),
+    minutes: zod_1.z.number().int(),
+    timezone: zod_1.z.string(),
+});
+exports.CurrentUserSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    email: zod_1.z.string(),
+    fullName: zod_1.z.string(),
+    avatarBig: zod_1.z.string().nullable(),
+    avatarMedium: zod_1.z.string().nullable(),
+    avatarS640: zod_1.z.string().nullable(),
+    avatarSmall: zod_1.z.string().nullable(),
+    businessAccountId: zod_1.z.string().nullable(),
+    isPremium: zod_1.z.boolean(),
+    dateFormat: zod_1.z.number().int(),
+    timeFormat: zod_1.z.number().int(),
+    weeklyGoal: zod_1.z.number().int(),
+    dailyGoal: zod_1.z.number().int(),
+    completedCount: zod_1.z.number().int(),
+    completedToday: zod_1.z.number().int(),
+    karma: zod_1.z.number(),
+    karmaTrend: zod_1.z.string(),
+    lang: zod_1.z.string(),
+    nextWeek: zod_1.z.number().int(),
+    startDay: zod_1.z.number().int(),
+    startPage: zod_1.z.string(),
+    tzInfo: exports.TimezoneInfoSchema,
+    inboxProjectId: zod_1.z.string(),
+    daysOff: zod_1.z.array(zod_1.z.number().int()),
+    weekendStartDay: zod_1.z.number().int(),
+});
 exports.ColorSchema = zod_1.z.object({
     /** @deprecated No longer used */
     id: zod_1.z.number(),

package/dist/types/requests.d.ts

@@ -157,6 +157,22 @@ export type GetProjectsResponse = {
     results: (PersonalProject | WorkspaceProject)[];
     nextCursor: string | null;
 };
+/**
+ * Arguments for retrieving archived projects.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_archived_projects_api_v1_projects_archived_get
+ */
+export type GetArchivedProjectsArgs = {
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving archived projects.
+ * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_archived_projects_api_v1_projects_archived_get
+ */
+export type GetArchivedProjectsResponse = {
+    results: (PersonalProject | WorkspaceProject)[];
+    nextCursor: string | null;
+};
 /**
  * Arguments for creating a new project.
  * @see https://todoist.com/api/v1/docs#tag/Projects/operation/create_project_api_v1_projects_post

package/dist/utils/validators.d.ts

@@ -1,4 +1,4 @@
-import { type Task, type Section, type Label, type Comment, type User, type WorkspaceProject, type PersonalProject } from '../types/entities';
+import { type Task, type Section, type Label, type Comment, type User, type CurrentUser, type WorkspaceProject, type PersonalProject } from '../types/entities';
 export declare function validateTask(input: unknown): Task;
 export declare function validateTaskArray(input: unknown[]): Task[];
 /**
@@ -28,3 +28,4 @@ export declare function validateComment(input: unknown): Comment;
 export declare function validateCommentArray(input: unknown[]): Comment[];
 export declare function validateUser(input: unknown): User;
 export declare function validateUserArray(input: unknown[]): User[];
+export declare function validateCurrentUser(input: unknown): CurrentUser;

package/dist/utils/validators.js

@@ -14,6 +14,7 @@ exports.validateComment = validateComment;
 exports.validateCommentArray = validateCommentArray;
 exports.validateUser = validateUser;
 exports.validateUserArray = validateUserArray;
+exports.validateCurrentUser = validateCurrentUser;
 var entities_1 = require("../types/entities");
 function validateTask(input) {
     return entities_1.TaskSchema.parse(input);
@@ -75,3 +76,6 @@ function validateUser(input) {
 function validateUserArray(input) {
     return input.map(validateUser);
 }
+function validateCurrentUser(input) {
+    return entities_1.CurrentUserSchema.parse(input);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "5.2.1",
+    "version": "5.4.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",
@@ -15,7 +15,7 @@
         "format-fix": "npx prettier --write \"./**/*.{ts,tsx,json,md,yml,babelrc,html}\"",
         "lint": "eslint ./src --ext ts,tsx --fix",
         "lint-check": "eslint ./src --ext ts,tsx",
-        "ts-compile-check": "npx tsc -p tsconfig.json",
+        "ts-compile-check": "npx tsc -p tsconfig.typecheck.json",
         "audit": "npm audit --audit-level=moderate",
         "test": "jest",
         "build": "npx tsc -p tsconfig.json",