@doist/todoist-api-typescript 5.2.0 → 5.3.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 { 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.
@@ -139,6 +139,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

@@ -434,6 +434,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,6 +15,8 @@ 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 PROJECT_ARCHIVE = "archive";
 export declare const PROJECT_UNARCHIVE = "unarchive";

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_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,6 +31,8 @@ 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.PROJECT_ARCHIVE = 'archive';
 exports.PROJECT_UNARCHIVE = 'unarchive';

package/dist/testUtils/testDefaults.d.ts

@@ -80,6 +80,7 @@ export declare const PROJECT_WITH_OPTIONALS_AS_NULL: PersonalProject;
 export declare const DEFAULT_SECTION: Section;
 export declare const INVALID_SECTION: {
     projectId: undefined;
+    url: string;
     id: string;
     userId: string;
     addedAt: string;

package/dist/testUtils/testDefaults.js

@@ -46,6 +46,7 @@ var DEFAULT_IS_COLLAPSED = false;
 // URL constants using the helper functions
 var DEFAULT_TASK_URL = (0, urlHelpers_1.getTaskUrl)(exports.DEFAULT_TASK_ID, exports.DEFAULT_TASK_CONTENT);
 var DEFAULT_PROJECT_URL = (0, urlHelpers_1.getProjectUrl)(exports.DEFAULT_PROJECT_ID, exports.DEFAULT_PROJECT_NAME);
+var DEFAULT_SECTION_URL = (0, urlHelpers_1.getSectionUrl)(DEFAULT_SECTION_ID, DEFAULT_SECTION_NAME);
 exports.DEFAULT_AUTH_TOKEN = 'AToken';
 exports.DEFAULT_REQUEST_ID = 'ARequestID';
 exports.INVALID_ENTITY_ID = 1234;
@@ -154,6 +155,7 @@ exports.DEFAULT_SECTION = {
     isArchived: false,
     isDeleted: false,
     isCollapsed: false,
+    url: DEFAULT_SECTION_URL,
 };
 exports.INVALID_SECTION = __assign(__assign({}, exports.DEFAULT_SECTION), { projectId: undefined });
 exports.DEFAULT_LABEL = {

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;
@@ -331,7 +331,7 @@ export type WorkspaceProject = z.infer<typeof WorkspaceProjectSchema>;
  * @see https://todoist.com/api/v1/docs#tag/Projects
  */
 export type ProjectViewStyle = 'list' | 'board' | 'calendar';
-export declare const SectionSchema: z.ZodObject<{
+export declare const SectionSchema: z.ZodPipe<z.ZodObject<{
     id: z.ZodString;
     userId: z.ZodString;
     projectId: z.ZodString;
@@ -343,7 +343,32 @@ export declare const SectionSchema: z.ZodObject<{
     isArchived: z.ZodBoolean;
     isDeleted: z.ZodBoolean;
     isCollapsed: z.ZodBoolean;
-}, z.core.$strip>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+}>>;
 /**
  * Represents a section in a Todoist project.
  * @see https://todoist.com/api/v1/docs#tag/Sections

package/dist/types/entities.js

@@ -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) });
 });
@@ -119,7 +119,8 @@ exports.WorkspaceProjectSchema = exports.BaseProjectSchema.extend({
 }).transform(function (data) {
     return __assign(__assign({}, data), { url: (0, urlHelpers_1.getProjectUrl)(data.id, data.name) });
 });
-exports.SectionSchema = zod_1.z.object({
+exports.SectionSchema = zod_1.z
+    .object({
     id: zod_1.z.string(),
     userId: zod_1.z.string(),
     projectId: zod_1.z.string(),
@@ -131,6 +132,9 @@ exports.SectionSchema = zod_1.z.object({
     isArchived: zod_1.z.boolean(),
     isDeleted: zod_1.z.boolean(),
     isCollapsed: zod_1.z.boolean(),
+})
+    .transform(function (data) {
+    return __assign(__assign({}, data), { url: (0, urlHelpers_1.getSectionUrl)(data.id, data.name) });
 });
 exports.LabelSchema = zod_1.z.object({
     id: zod_1.z.string(),

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/urlHelpers.d.ts

@@ -14,3 +14,11 @@ export declare function getTaskUrl(taskId: string, content?: string): string;
  * @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;

package/dist/utils/urlHelpers.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTaskUrl = getTaskUrl;
 exports.getProjectUrl = getProjectUrl;
+exports.getSectionUrl = getSectionUrl;
 var endpoints_1 = require("../consts/endpoints");
 /**
  * Generate the URL for a given task.
@@ -27,6 +28,18 @@ function getProjectUrl(projectId, name) {
     var path = slug ? "".concat(slug, "-").concat(projectId) : projectId;
     return "".concat(endpoints_1.TODOIST_WEB_URI, "/project/").concat(path);
 }
+/**
+ * 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.
+ */
+function getSectionUrl(sectionId, name) {
+    var slug = name ? slugify(name) : undefined;
+    var path = slug ? "".concat(slug, "-").concat(sectionId) : sectionId;
+    return "".concat(endpoints_1.TODOIST_WEB_URI, "/section/").concat(path);
+}
 /**
  * Slugify function borrowed from Django.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "5.2.0",
+    "version": "5.3.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",