@doist/todoist-api-typescript 5.6.3 → 5.6.4

package/dist/TodoistApi.js

@@ -51,6 +51,8 @@ exports.TodoistApi = void 0;
 var restClient_1 = require("./restClient");
 var endpoints_1 = require("./consts/endpoints");
 var validators_1 = require("./utils/validators");
+var urlHelpers_1 = require("./utils/urlHelpers");
+var activity_helpers_1 = require("./utils/activity-helpers");
 var zod_1 = require("zod");
 var uuid_1 = require("uuid");
 var types_1 = require("./types");
@@ -1040,15 +1042,23 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.getActivityLogs = function () {
         return __awaiter(this, arguments, void 0, function (args) {
-            var _a, results, nextCursor;
+            var processedArgs, _a, results, nextCursor, normalizedResults;
             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 0:
+                        processedArgs = __assign(__assign(__assign(__assign({}, args), (args.since instanceof Date && { since: (0, urlHelpers_1.formatDateToYYYYMMDD)(args.since) })), (args.until instanceof Date && { until: (0, urlHelpers_1.formatDateToYYYYMMDD)(args.until) })), (args.objectType && { objectType: (0, activity_helpers_1.normalizeObjectTypeForApi)(args.objectType) }));
+                        return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_ACTIVITIES, this.authToken, processedArgs)
+                            // Convert legacy API object types back to modern SDK types
+                        ];
                     case 1:
                         _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
+                        normalizedResults = results.map(function (event) {
+                            var normalizedType = (0, activity_helpers_1.denormalizeObjectTypeFromApi)(event.objectType);
+                            return __assign(__assign({}, event), { objectType: normalizedType || event.objectType });
+                        });
                         return [2 /*return*/, {
-                                results: (0, validators_1.validateActivityEventArray)(results),
+                                results: (0, validators_1.validateActivityEventArray)(normalizedResults),
                                 nextCursor: nextCursor,
                             }];
                 }

package/dist/types/entities.d.ts

@@ -670,10 +670,21 @@ export declare const ColorSchema: z.ZodObject<{
  * @see https://todoist.com/api/v1/docs#tag/Colors
  */
 export type Color = z.infer<typeof ColorSchema>;
+/**
+ * @deprecated Use 'task' instead. This will be removed in the next major version.
+ */
+type DeprecatedItem = 'item';
+/**
+ * @deprecated Use 'comment' instead. This will be removed in the next major version.
+ */
+type DeprecatedNote = 'note';
 /**
  * Type hints for known object types. Accepts any string for forward compatibility.
+ * Supports both modern naming ('task', 'comment') and legacy naming ('item', 'note').
+ *
+ * **Note**: The legacy values 'item' and 'note' are deprecated. Use 'task' and 'comment' instead.
  */
-export type ActivityObjectType = 'item' | 'note' | 'project' | (string & Record<string, never>);
+export type ActivityObjectType = 'task' | 'comment' | 'project' | DeprecatedItem | DeprecatedNote | (string & Record<string, never>);
 /**
  * Type hints for known event types. Accepts any string for forward compatibility.
  */
@@ -702,3 +713,4 @@ export declare const ActivityEventSchema: z.ZodObject<{
  * Represents an activity log event in Todoist.
  */
 export type ActivityEvent = z.infer<typeof ActivityEventSchema>;
+export {};

package/dist/types/requests.d.ts

@@ -1,5 +1,5 @@
 import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
-import type { ActivityEvent, Comment, Duration, Label, PersonalProject, ProjectViewStyle, Section, Task, User, WorkspaceProject } from './entities';
+import type { ActivityEvent, ActivityEventType, ActivityObjectType, 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
@@ -383,24 +383,94 @@ export type UpdateCommentArgs = {
 /**
  * Arguments for retrieving activity logs.
  */
-export type GetActivityLogsArgs = {
-    objectType?: string;
-    eventType?: string;
+type GetActivityLogsArgsBase = {
+    /**
+     * Type of object to filter by (e.g., 'task', 'comment', 'project').
+     * Accepts both modern naming ('task', 'comment') and legacy naming ('item', 'note').
+     */
+    objectType?: ActivityObjectType;
+    /**
+     * Type of event to filter by (e.g., 'added', 'updated', 'deleted', 'completed', 'uncompleted', 'archived', 'unarchived', 'shared', 'left').
+     */
+    eventType?: ActivityEventType;
+    /**
+     * Filter by the ID of a specific object.
+     */
     objectId?: string;
+    /**
+     * Filter events by parent project ID.
+     */
     parentProjectId?: string;
+    /**
+     * Filter events by parent task ID.
+     */
     parentItemId?: string;
+    /**
+     * When true, includes the parent object data in the response.
+     */
     includeParentObject?: boolean;
+    /**
+     * When true, includes child object data in the response.
+     */
     includeChildObjects?: boolean;
+    /**
+     * Filter by the user ID who initiated the event.
+     */
     initiatorId?: string;
+    /**
+     * When true, filters for events with no initiator (system-generated events).
+     * When false, filters for events with an initiator.
+     * When null or undefined, no filtering on initiator is applied.
+     */
     initiatorIdNull?: boolean | null;
+    /**
+     * When true, ensures the last state of objects is included in the response.
+     */
     ensureLastState?: boolean;
+    /**
+     * When true, includes comment annotations in the response.
+     */
     annotateNotes?: boolean;
+    /**
+     * When true, includes parent object annotations in the response.
+     */
     annotateParents?: boolean;
-    since?: string;
-    until?: string;
+    /**
+     * Pagination cursor for retrieving the next page of results.
+     */
     cursor?: string | null;
+    /**
+     * Maximum number of results to return per page.
+     */
     limit?: number;
 };
+type GetActivityLogsArgsWithDate = GetActivityLogsArgsBase & {
+    /**
+     * Start date for filtering events (inclusive).
+     */
+    since?: Date;
+    /**
+     * End date for filtering events (inclusive).
+     */
+    until?: Date;
+};
+/**
+ * @deprecated String dates (YYYY-MM-DD format) are deprecated. Use Date objects instead.
+ * This type will be removed in the next major version.
+ */
+type GetActivityLogsArgsWithString = GetActivityLogsArgsBase & {
+    /**
+     * Start date for filtering events in YYYY-MM-DD format (inclusive).
+     * @deprecated Use Date object instead. String format will be removed in the next major version.
+     */
+    since?: string;
+    /**
+     * End date for filtering events in YYYY-MM-DD format (inclusive).
+     * @deprecated Use Date object instead. String format will be removed in the next major version.
+     */
+    until?: string;
+};
+export type GetActivityLogsArgs = GetActivityLogsArgsWithDate | GetActivityLogsArgsWithString;
 /**
  * Response from retrieving activity logs.
  */
@@ -408,3 +478,4 @@ export type GetActivityLogsResponse = {
     results: ActivityEvent[];
     nextCursor: string | null;
 };
+export {};

package/dist/utils/activity-helpers.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Converts modern SDK object type naming to legacy API naming.
+ * Maps 'task' -> 'item' and 'comment' -> 'note' for API requests.
+ * Other values pass through unchanged.
+ *
+ * @internal
+ * @param objectType The object type using modern naming.
+ * @returns The object type using legacy API naming.
+ */
+export declare function normalizeObjectTypeForApi(objectType: string | undefined): string | undefined;
+/**
+ * Converts legacy API object type naming to modern SDK naming.
+ * Maps 'item' -> 'task' and 'note' -> 'comment' for SDK responses.
+ * Other values pass through unchanged.
+ *
+ * @internal
+ * @param objectType The object type using legacy API naming.
+ * @returns The object type using modern SDK naming.
+ */
+export declare function denormalizeObjectTypeFromApi(objectType: string | undefined): string | undefined;

package/dist/utils/activity-helpers.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeObjectTypeForApi = normalizeObjectTypeForApi;
+exports.denormalizeObjectTypeFromApi = denormalizeObjectTypeFromApi;
+/**
+ * Converts modern SDK object type naming to legacy API naming.
+ * Maps 'task' -> 'item' and 'comment' -> 'note' for API requests.
+ * Other values pass through unchanged.
+ *
+ * @internal
+ * @param objectType The object type using modern naming.
+ * @returns The object type using legacy API naming.
+ */
+function normalizeObjectTypeForApi(objectType) {
+    if (!objectType)
+        return objectType;
+    if (objectType === 'task')
+        return 'item';
+    if (objectType === 'comment')
+        return 'note';
+    return objectType;
+}
+/**
+ * Converts legacy API object type naming to modern SDK naming.
+ * Maps 'item' -> 'task' and 'note' -> 'comment' for SDK responses.
+ * Other values pass through unchanged.
+ *
+ * @internal
+ * @param objectType The object type using legacy API naming.
+ * @returns The object type using modern SDK naming.
+ */
+function denormalizeObjectTypeFromApi(objectType) {
+    if (!objectType)
+        return objectType;
+    if (objectType === 'item')
+        return 'task';
+    if (objectType === 'note')
+        return 'comment';
+    return objectType;
+}

package/dist/utils/index.d.ts

@@ -1,3 +1,3 @@
 export * from './colors';
 export * from './sanitization';
-export * from './urlHelpers';
+export { getTaskUrl, getProjectUrl, getSectionUrl } from './urlHelpers';

package/dist/utils/index.js

@@ -14,6 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSectionUrl = exports.getProjectUrl = exports.getTaskUrl = void 0;
 __exportStar(require("./colors"), exports);
 __exportStar(require("./sanitization"), exports);
-__exportStar(require("./urlHelpers"), exports);
+var urlHelpers_1 = require("./urlHelpers");
+Object.defineProperty(exports, "getTaskUrl", { enumerable: true, get: function () { return urlHelpers_1.getTaskUrl; } });
+Object.defineProperty(exports, "getProjectUrl", { enumerable: true, get: function () { return urlHelpers_1.getProjectUrl; } });
+Object.defineProperty(exports, "getSectionUrl", { enumerable: true, get: function () { return urlHelpers_1.getSectionUrl; } });

package/dist/utils/urlHelpers.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Formats a Date object to YYYY-MM-DD string format.
+ *
+ * @internal
+ * @param date The Date object to format.
+ * @returns The formatted date string in YYYY-MM-DD format.
+ */
+export declare function formatDateToYYYYMMDD(date: Date): string;
 /**
  * Generate the URL for a given task.
  *

package/dist/utils/urlHelpers.js

@@ -1,9 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDateToYYYYMMDD = formatDateToYYYYMMDD;
 exports.getTaskUrl = getTaskUrl;
 exports.getProjectUrl = getProjectUrl;
 exports.getSectionUrl = getSectionUrl;
 var endpoints_1 = require("../consts/endpoints");
+/**
+ * Formats a Date object to YYYY-MM-DD string format.
+ *
+ * @internal
+ * @param date The Date object to format.
+ * @returns The formatted date string in YYYY-MM-DD format.
+ */
+function formatDateToYYYYMMDD(date) {
+    var year = date.getFullYear();
+    var month = String(date.getMonth() + 1).padStart(2, '0');
+    var day = String(date.getDate()).padStart(2, '0');
+    return "".concat(year, "-").concat(month, "-").concat(day);
+}
 /**
  * Generate the URL for a given task.
  *

package/package.json

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