@doist/todoist-api-typescript 5.4.0 → 5.5.0

package/dist/TodoistApi.d.ts

@@ -1,4 +1,4 @@
-import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser } from './types/entities';
+import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats } 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.
@@ -339,4 +339,10 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteComment(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves productivity stats for the authenticated user.
+     *
+     * @returns A promise that resolves to the productivity stats.
+     */
+    getProductivityStats(): Promise<ProductivityStats>;
 }

package/dist/TodoistApi.js

@@ -992,6 +992,24 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves productivity stats for the authenticated user.
+     *
+     * @returns A promise that resolves to the productivity stats.
+     */
+    TodoistApi.prototype.getProductivityStats = 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_PRODUCTIVITY, this.authToken)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, (0, validators_1.validateProductivityStats)(response.data)];
+                }
+            });
+        });
+    };
     return TodoistApi;
 }());
 exports.TodoistApi = TodoistApi;

package/dist/consts/endpoints.d.ts

@@ -19,6 +19,7 @@ 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 ENDPOINT_REST_PRODUCTIVITY: string;
 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_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.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_PRODUCTIVITY = 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';
@@ -35,6 +35,7 @@ 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.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_TASKS + '/completed/stats';
 exports.PROJECT_ARCHIVE = 'archive';
 exports.PROJECT_UNARCHIVE = 'unarchive';
 exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_TASKS + '/quick';

package/dist/types/entities.d.ts

@@ -577,6 +577,86 @@ export declare const CurrentUserSchema: z.ZodObject<{
  * @see https://todoist.com/api/v1/docs#tag/User
  */
 export type CurrentUser = z.infer<typeof CurrentUserSchema>;
+export declare const ProductivityStatsSchema: z.ZodObject<{
+    completedCount: z.ZodNumber;
+    daysItems: z.ZodArray<z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            completed: z.ZodNumber;
+        }, z.core.$strip>>;
+        totalCompleted: z.ZodNumber;
+        date: z.ZodString;
+    }, z.core.$strip>>;
+    goals: z.ZodObject<{
+        currentDailyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        currentWeeklyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        dailyGoal: z.ZodNumber;
+        ignoreDays: z.ZodArray<z.ZodNumber>;
+        karmaDisabled: z.ZodNumber;
+        lastDailyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        lastWeeklyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        maxDailyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        maxWeeklyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        user: z.ZodString;
+        userId: z.ZodString;
+        vacationMode: z.ZodNumber;
+        weeklyGoal: z.ZodNumber;
+    }, z.core.$strip>;
+    karma: z.ZodNumber;
+    karmaGraphData: z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        karmaAvg: z.ZodNumber;
+    }, z.core.$strip>>;
+    karmaLastUpdate: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    karmaUpdateReasons: z.ZodArray<z.ZodObject<{
+        time: z.ZodString;
+        newKarma: z.ZodNumber;
+        positiveKarma: z.ZodNumber;
+        negativeKarma: z.ZodNumber;
+        positiveKarmaReasons: z.ZodArray<z.ZodAny>;
+        negativeKarmaReasons: z.ZodArray<z.ZodAny>;
+    }, z.core.$strip>>;
+    projectColors: z.ZodRecord<z.ZodString, z.ZodString>;
+    weekItems: z.ZodArray<z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            completed: z.ZodNumber;
+        }, z.core.$strip>>;
+        totalCompleted: z.ZodNumber;
+        from: z.ZodString;
+        to: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Represents the Productivity stats for the authenticated user.
+ * @see https://developer.todoist.com/api/v1/#tag/User/operation/get_productivity_stats_api_v1_tasks_completed_stats_get
+ */
+export type ProductivityStats = z.infer<typeof ProductivityStatsSchema>;
 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.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;
+exports.ColorSchema = exports.ProductivityStatsSchema = 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
@@ -225,6 +225,61 @@ exports.CurrentUserSchema = zod_1.z.object({
     daysOff: zod_1.z.array(zod_1.z.number().int()),
     weekendStartDay: zod_1.z.number().int(),
 });
+var StreakSchema = zod_1.z.object({
+    count: zod_1.z.number(),
+    start: zod_1.z.string(),
+    end: zod_1.z.string(),
+});
+var CompletedItemSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    completed: zod_1.z.number(),
+});
+var ItemsWithDateSchema = zod_1.z.object({
+    items: zod_1.z.array(CompletedItemSchema),
+    totalCompleted: zod_1.z.number(),
+});
+var KarmaUpdateSchema = zod_1.z.object({
+    time: zod_1.z.string(),
+    newKarma: zod_1.z.number(),
+    positiveKarma: zod_1.z.number(),
+    negativeKarma: zod_1.z.number(),
+    positiveKarmaReasons: zod_1.z.array(zod_1.z.any()),
+    negativeKarmaReasons: zod_1.z.array(zod_1.z.any()),
+});
+exports.ProductivityStatsSchema = zod_1.z.object({
+    completedCount: zod_1.z.number(),
+    daysItems: zod_1.z.array(ItemsWithDateSchema.extend({
+        date: zod_1.z.string(),
+    })),
+    goals: zod_1.z.object({
+        currentDailyStreak: StreakSchema,
+        currentWeeklyStreak: StreakSchema,
+        dailyGoal: zod_1.z.number(),
+        ignoreDays: zod_1.z.array(zod_1.z.number()),
+        karmaDisabled: zod_1.z.number(),
+        lastDailyStreak: StreakSchema,
+        lastWeeklyStreak: StreakSchema,
+        maxDailyStreak: StreakSchema,
+        maxWeeklyStreak: StreakSchema,
+        user: zod_1.z.string(),
+        userId: zod_1.z.string(),
+        vacationMode: zod_1.z.number(),
+        weeklyGoal: zod_1.z.number(),
+    }),
+    karma: zod_1.z.number(),
+    karmaGraphData: zod_1.z.array(zod_1.z.object({
+        date: zod_1.z.string(),
+        karmaAvg: zod_1.z.number(),
+    })),
+    karmaLastUpdate: zod_1.z.number(),
+    karmaTrend: zod_1.z.string(),
+    karmaUpdateReasons: zod_1.z.array(KarmaUpdateSchema),
+    projectColors: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
+    weekItems: zod_1.z.array(ItemsWithDateSchema.extend({
+        from: zod_1.z.string(),
+        to: zod_1.z.string(),
+    })),
+});
 exports.ColorSchema = zod_1.z.object({
     /** @deprecated No longer used */
     id: zod_1.z.number(),

package/dist/utils/validators.d.ts

@@ -1,4 +1,4 @@
-import { type Task, type Section, type Label, type Comment, type User, type CurrentUser, type WorkspaceProject, type PersonalProject } from '../types/entities';
+import { type Task, type Section, type Label, type Comment, type User, type CurrentUser, type ProductivityStats, type WorkspaceProject, type PersonalProject } from '../types/entities';
 export declare function validateTask(input: unknown): Task;
 export declare function validateTaskArray(input: unknown[]): Task[];
 /**
@@ -28,4 +28,5 @@ 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 validateProductivityStats(input: unknown): ProductivityStats;
 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.validateProductivityStats = validateProductivityStats;
 exports.validateCurrentUser = validateCurrentUser;
 var entities_1 = require("../types/entities");
 function validateTask(input) {
@@ -76,6 +77,9 @@ function validateUser(input) {
 function validateUserArray(input) {
     return input.map(validateUser);
 }
+function validateProductivityStats(input) {
+    return entities_1.ProductivityStatsSchema.parse(input);
+}
 function validateCurrentUser(input) {
     return entities_1.CurrentUserSchema.parse(input);
 }

package/package.json

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