@doist/todoist-api-typescript 5.6.0 → 5.6.3

package/dist/TodoistApi.d.ts

@@ -1,5 +1,5 @@
 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, SearchCompletedTasksArgs } 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, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse } 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.
@@ -352,4 +352,11 @@ export declare class TodoistApi {
      * @returns A promise that resolves to the productivity stats.
      */
     getProductivityStats(): Promise<ProductivityStats>;
+    /**
+     * Retrieves activity logs with optional filters.
+     *
+     * @param args - Optional filter parameters for activity logs.
+     * @returns A promise that resolves to a paginated response of activity events.
+     */
+    getActivityLogs(args?: GetActivityLogsArgs): Promise<GetActivityLogsResponse>;
 }

package/dist/TodoistApi.js

@@ -1032,6 +1032,29 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves activity logs with optional filters.
+     *
+     * @param args - Optional filter parameters for activity logs.
+     * @returns A promise that resolves to a paginated response of activity events.
+     */
+    TodoistApi.prototype.getActivityLogs = 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_ACTIVITIES, this.authToken, args)];
+                    case 1:
+                        _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
+                        return [2 /*return*/, {
+                                results: (0, validators_1.validateActivityEventArray)(results),
+                                nextCursor: nextCursor,
+                            }];
+                }
+            });
+        });
+    };
     return TodoistApi;
 }());
 exports.TodoistApi = TodoistApi;

package/dist/consts/endpoints.d.ts

@@ -21,6 +21,7 @@ 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 ENDPOINT_REST_ACTIVITIES = "activities";
 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_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_SEARCH = 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_ACTIVITIES = 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_SEARCH = 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';
@@ -37,6 +37,7 @@ exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS + '/arc
 exports.ENDPOINT_REST_PROJECT_COLLABORATORS = 'collaborators';
 exports.ENDPOINT_REST_USER = 'user';
 exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_TASKS + '/completed/stats';
+exports.ENDPOINT_REST_ACTIVITIES = 'activities';
 exports.PROJECT_ARCHIVE = 'archive';
 exports.PROJECT_UNARCHIVE = 'unarchive';
 exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_TASKS + '/quick';

package/dist/types/entities.d.ts

@@ -670,3 +670,35 @@ export declare const ColorSchema: z.ZodObject<{
  * @see https://todoist.com/api/v1/docs#tag/Colors
  */
 export type Color = z.infer<typeof ColorSchema>;
+/**
+ * Type hints for known object types. Accepts any string for forward compatibility.
+ */
+export type ActivityObjectType = 'item' | 'note' | 'project' | (string & Record<string, never>);
+/**
+ * Type hints for known event types. Accepts any string for forward compatibility.
+ */
+export type ActivityEventType = 'added' | 'updated' | 'deleted' | 'completed' | 'uncompleted' | 'archived' | 'unarchived' | 'shared' | 'left' | (string & Record<string, never>);
+/**
+ * Flexible object containing event-specific data.
+ * Uses z.record to accept any properties for forward compatibility.
+ */
+export declare const ActivityEventExtraDataSchema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+export type ActivityEventExtraData = z.infer<typeof ActivityEventExtraDataSchema>;
+/**
+ * Activity log event schema. Accepts unknown fields for forward compatibility.
+ */
+export declare const ActivityEventSchema: z.ZodObject<{
+    objectType: z.ZodString;
+    objectId: z.ZodString;
+    eventType: z.ZodString;
+    eventDate: z.ZodString;
+    id: z.ZodNullable<z.ZodString>;
+    parentProjectId: z.ZodNullable<z.ZodString>;
+    parentItemId: z.ZodNullable<z.ZodString>;
+    initiatorId: z.ZodNullable<z.ZodString>;
+    extraData: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$catchall<z.ZodAny>>;
+/**
+ * Represents an activity log event in Todoist.
+ */
+export type ActivityEvent = z.infer<typeof ActivityEventSchema>;

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.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;
+exports.ActivityEventSchema = exports.ActivityEventExtraDataSchema = 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
@@ -296,3 +296,24 @@ exports.ColorSchema = zod_1.z.object({
      */
     value: zod_1.z.string(),
 });
+/**
+ * Flexible object containing event-specific data.
+ * Uses z.record to accept any properties for forward compatibility.
+ */
+exports.ActivityEventExtraDataSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.any()).nullable();
+/**
+ * Activity log event schema. Accepts unknown fields for forward compatibility.
+ */
+exports.ActivityEventSchema = zod_1.z
+    .object({
+    objectType: zod_1.z.string(),
+    objectId: zod_1.z.string(),
+    eventType: zod_1.z.string(),
+    eventDate: zod_1.z.string(),
+    id: zod_1.z.string().nullable(),
+    parentProjectId: zod_1.z.string().nullable(),
+    parentItemId: zod_1.z.string().nullable(),
+    initiatorId: zod_1.z.string().nullable(),
+    extraData: exports.ActivityEventExtraDataSchema,
+})
+    .catchall(zod_1.z.any());

package/dist/types/requests.d.ts

@@ -1,5 +1,5 @@
 import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
-import type { Comment, Duration, Label, PersonalProject, ProjectViewStyle, Section, Task, User, WorkspaceProject } from './entities';
+import type { ActivityEvent, Comment, Duration, Label, PersonalProject, ProjectViewStyle, Section, Task, User, WorkspaceProject } from './entities';
 /**
  * Arguments for creating a new task.
  * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/create_task_api_v1_tasks_post
@@ -380,3 +380,31 @@ export type AddCommentArgs = {
 export type UpdateCommentArgs = {
     content: string;
 };
+/**
+ * Arguments for retrieving activity logs.
+ */
+export type GetActivityLogsArgs = {
+    objectType?: string;
+    eventType?: string;
+    objectId?: string;
+    parentProjectId?: string;
+    parentItemId?: string;
+    includeParentObject?: boolean;
+    includeChildObjects?: boolean;
+    initiatorId?: string;
+    initiatorIdNull?: boolean | null;
+    ensureLastState?: boolean;
+    annotateNotes?: boolean;
+    annotateParents?: boolean;
+    since?: string;
+    until?: string;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving activity logs.
+ */
+export type GetActivityLogsResponse = {
+    results: ActivityEvent[];
+    nextCursor: string | null;
+};

package/dist/utils/index.d.ts

@@ -1,2 +1,3 @@
 export * from './colors';
 export * from './sanitization';
+export * from './urlHelpers';

package/dist/utils/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./colors"), exports);
 __exportStar(require("./sanitization"), exports);
+__exportStar(require("./urlHelpers"), exports);

package/dist/utils/validators.d.ts

@@ -1,4 +1,4 @@
-import { type Task, type Section, type Label, type Comment, type User, type CurrentUser, type ProductivityStats, 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, type ActivityEvent } from '../types/entities';
 export declare function validateTask(input: unknown): Task;
 export declare function validateTaskArray(input: unknown[]): Task[];
 /**
@@ -30,3 +30,5 @@ 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;
+export declare function validateActivityEvent(input: unknown): ActivityEvent;
+export declare function validateActivityEventArray(input: unknown[]): ActivityEvent[];

package/dist/utils/validators.js

@@ -16,6 +16,8 @@ exports.validateUser = validateUser;
 exports.validateUserArray = validateUserArray;
 exports.validateProductivityStats = validateProductivityStats;
 exports.validateCurrentUser = validateCurrentUser;
+exports.validateActivityEvent = validateActivityEvent;
+exports.validateActivityEventArray = validateActivityEventArray;
 var entities_1 = require("../types/entities");
 function validateTask(input) {
     return entities_1.TaskSchema.parse(input);
@@ -83,3 +85,9 @@ function validateProductivityStats(input) {
 function validateCurrentUser(input) {
     return entities_1.CurrentUserSchema.parse(input);
 }
+function validateActivityEvent(input) {
+    return entities_1.ActivityEventSchema.parse(input);
+}
+function validateActivityEventArray(input) {
+    return input.map(validateActivityEvent);
+}

package/package.json

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