@doist/todoist-api-typescript 7.5.0 → 7.6.0

package/dist/cjs/types/requests.js

@@ -1,5 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REMINDER_DELIVERY_SERVICES = void 0;
+exports.MOVED_ID_OBJECT_TYPES = exports.ID_MAPPING_OBJECT_TYPES = exports.EMAIL_OBJECT_TYPES = exports.REMINDER_DELIVERY_SERVICES = void 0;
 /** Available reminder delivery services. */
 exports.REMINDER_DELIVERY_SERVICES = ['email', 'push'];
+// Email forwarding types
+/** Object types that support email forwarding. */
+exports.EMAIL_OBJECT_TYPES = ['project', 'project_comments', 'task'];
+// ID mapping types
+/** Object types that support ID mappings. */
+exports.ID_MAPPING_OBJECT_TYPES = [
+    'sections',
+    'tasks',
+    'comments',
+    'reminders',
+    'location_reminders',
+    'projects',
+];
+/** Object types that support moved ID lookups. */
+exports.MOVED_ID_OBJECT_TYPES = [
+    'sections',
+    'tasks',
+    'comments',
+    'reminders',
+    'location_reminders',
+];

package/dist/cjs/utils/validators.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validateFolderArray = exports.validateFolder = exports.validateCollaboratorStateArray = exports.validateCollaboratorState = exports.validateCollaboratorArray = exports.validateCollaborator = exports.validateFilterArray = exports.validateFilter = exports.validateWorkspaceArray = exports.validateWorkspace = exports.validateJoinWorkspaceResult = exports.validateWorkspacePlanDetails = exports.validateWorkspaceInvitationArray = exports.validateWorkspaceInvitation = exports.validateWorkspaceUser = exports.validateAttachment = exports.validateActivityEventArray = exports.validateActivityEvent = exports.validateCurrentUser = exports.validateProductivityStats = exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateTaskArray = exports.validateTask = void 0;
-exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = void 0;
+exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validateFolderArray = exports.validateFolder = exports.validateCollaboratorStateArray = exports.validateCollaboratorState = exports.validateCollaboratorArray = exports.validateCollaborator = exports.validateFilterArray = exports.validateFilter = exports.validateMovedIdArray = exports.validateMovedId = exports.validateIdMappingArray = exports.validateIdMapping = exports.validateBackupArray = exports.validateBackup = exports.validateWorkspaceInsights = exports.validateProjectProgress = exports.validateProjectHealthContext = exports.validateProjectHealth = exports.validateProjectActivityStats = exports.validateWorkspaceUserTaskArray = exports.validateWorkspaceUserTask = exports.validateMemberActivityInfoArray = exports.validateMemberActivityInfo = exports.validateWorkspaceArray = exports.validateWorkspace = exports.validateJoinWorkspaceResult = exports.validateWorkspacePlanDetails = exports.validateWorkspaceInvitationArray = exports.validateWorkspaceInvitation = exports.validateWorkspaceUser = exports.validateAttachment = exports.validateActivityEventArray = exports.validateActivityEvent = exports.validateCurrentUser = exports.validateProductivityStats = exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateTaskArray = exports.validateTask = void 0;
+exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = void 0;
 exports.isWorkspaceProject = isWorkspaceProject;
 exports.isPersonalProject = isPersonalProject;
 exports.validateProject = validateProject;
@@ -74,6 +74,21 @@ exports.validateWorkspacePlanDetails = createValidator(entities_1.WorkspacePlanD
 exports.validateJoinWorkspaceResult = createValidator(entities_1.JoinWorkspaceResultSchema);
 exports.validateWorkspace = createValidator(entities_1.WorkspaceSchema);
 exports.validateWorkspaceArray = createArrayValidator(exports.validateWorkspace);
+exports.validateMemberActivityInfo = createValidator(entities_1.MemberActivityInfoSchema);
+exports.validateMemberActivityInfoArray = createArrayValidator(exports.validateMemberActivityInfo);
+exports.validateWorkspaceUserTask = createValidator(entities_1.WorkspaceUserTaskSchema);
+exports.validateWorkspaceUserTaskArray = createArrayValidator(exports.validateWorkspaceUserTask);
+exports.validateProjectActivityStats = createValidator(entities_1.ProjectActivityStatsSchema);
+exports.validateProjectHealth = createValidator(entities_1.ProjectHealthSchema);
+exports.validateProjectHealthContext = createValidator(entities_1.ProjectHealthContextSchema);
+exports.validateProjectProgress = createValidator(entities_1.ProjectProgressSchema);
+exports.validateWorkspaceInsights = createValidator(entities_1.WorkspaceInsightsSchema);
+exports.validateBackup = createValidator(entities_1.BackupSchema);
+exports.validateBackupArray = createArrayValidator(exports.validateBackup);
+exports.validateIdMapping = createValidator(entities_1.IdMappingSchema);
+exports.validateIdMappingArray = createArrayValidator(exports.validateIdMapping);
+exports.validateMovedId = createValidator(entities_1.MovedIdSchema);
+exports.validateMovedIdArray = createArrayValidator(exports.validateMovedId);
 // Sync resource validators
 exports.validateFilter = createValidator(resources_1.FilterSchema);
 exports.validateFilterArray = createArrayValidator(exports.validateFilter);
@@ -96,6 +111,8 @@ exports.validateCalendarAccount = createValidator(resources_1.CalendarAccountSch
 exports.validateCalendarAccountArray = createArrayValidator(exports.validateCalendarAccount);
 exports.validateReminder = createValidator(resources_1.ReminderSchema);
 exports.validateReminderArray = createArrayValidator(exports.validateReminder);
+exports.validateLocationReminder = createValidator(resources_1.LocationReminderSchema);
+exports.validateLocationReminderArray = createArrayValidator(exports.validateLocationReminder);
 exports.validateCompletedInfo = createValidator(resources_1.CompletedInfoSchema);
 exports.validateCompletedInfoArray = createArrayValidator(exports.validateCompletedInfo);
 exports.validateViewOptions = createValidator(resources_1.ViewOptionsSchema);

package/dist/esm/authentication.js

@@ -1,7 +1,7 @@
 import { request, isSuccess } from './transport/http-client.js';
 import { v4 as uuid } from 'uuid';
 import { TodoistRequestError } from './types/index.js';
-import { getAuthBaseUri, getSyncBaseUri, ENDPOINT_AUTHORIZATION, ENDPOINT_GET_TOKEN, ENDPOINT_REVOKE, } from './consts/endpoints.js';
+import { getAuthBaseUri, getSyncBaseUri, ENDPOINT_AUTHORIZATION, ENDPOINT_GET_TOKEN, ENDPOINT_REVOKE, ENDPOINT_REST_ACCESS_TOKENS_MIGRATE, } from './consts/endpoints.js';
 /** Available OAuth2 permission scopes. */
 export const PERMISSIONS = [
     'task:add',
@@ -51,7 +51,7 @@ export function getAuthStateParameter() {
  * ```
  *
  * @returns The full authorization URL to redirect users to
- * @see https://todoist.com/api/v1/docs#tag/Authorization/OAuth
+ * @see https://developer.todoist.com/api/v1/#tag/Authorization/OAuth
  */
 export function getAuthorizationUrl({ clientId, permissions, state, baseUrl, }) {
     if (!(permissions === null || permissions === void 0 ? void 0 : permissions.length)) {
@@ -119,7 +119,7 @@ export async function getAuthToken(args, options) {
  *
  * @returns True if revocation was successful
  * @see https://datatracker.ietf.org/doc/html/rfc7009
- * @see https://todoist.com/api/v1/docs#tag/Authorization
+ * @see https://developer.todoist.com/api/v1/#tag/Authorization
  */
 export async function revokeToken(args, options) {
     if (typeof options === 'string') {
@@ -151,3 +151,46 @@ export async function revokeToken(args, options) {
     });
     return isSuccess(response);
 }
+/**
+ * Migrates a personal API token to an OAuth access token.
+ *
+ * This allows applications to transition users from personal API tokens
+ * to proper OAuth tokens without requiring the user to go through the
+ * full OAuth authorization flow.
+ *
+ * @example
+ * ```typescript
+ * const { accessToken } = await migratePersonalToken({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ *   personalToken: 'user-personal-token',
+ *   scope: 'data:read_write,data:delete'
+ * })
+ * ```
+ *
+ * @returns The new OAuth token response
+ * @throws {@link TodoistRequestError} If the migration fails
+ */
+export async function migratePersonalToken(args, options) {
+    var _a;
+    const baseUrl = options === null || options === void 0 ? void 0 : options.baseUrl;
+    const customFetch = options === null || options === void 0 ? void 0 : options.customFetch;
+    try {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: getSyncBaseUri(baseUrl),
+            relativePath: ENDPOINT_REST_ACCESS_TOKENS_MIGRATE,
+            apiToken: undefined,
+            payload: Object.assign(Object.assign({}, args), { scope: args.scope.join(',') }),
+            customFetch,
+        });
+        if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
+            throw new TodoistRequestError('Personal token migration failed.', response.status, response.data);
+        }
+        return response.data;
+    }
+    catch (error) {
+        const err = error;
+        throw new TodoistRequestError('Personal token migration failed.', err.httpStatusCode, err.responseData);
+    }
+}

package/dist/esm/consts/endpoints.js

@@ -48,6 +48,18 @@ export const SECTION_ARCHIVE = 'archive';
 export const SECTION_UNARCHIVE = 'unarchive';
 export const ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = ENDPOINT_REST_PROJECTS + '/move_to_workspace';
 export const ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = ENDPOINT_REST_PROJECTS + '/move_to_personal';
+export const ENDPOINT_REST_TASKS_COMPLETED = ENDPOINT_REST_TASKS + '/completed';
+export const ENDPOINT_REST_TEMPLATES_FILE = 'templates/file';
+export const ENDPOINT_REST_TEMPLATES_URL = 'templates/url';
+export const ENDPOINT_REST_TEMPLATES_CREATE_FROM_FILE = 'templates/create_project_from_file';
+export const ENDPOINT_REST_TEMPLATES_IMPORT_FROM_FILE = 'templates/import_into_project_from_file';
+export const ENDPOINT_REST_TEMPLATES_IMPORT_FROM_ID = 'templates/import_into_project_from_template_id';
+export const ENDPOINT_REST_ACCESS_TOKENS_MIGRATE = 'access_tokens/migrate_personal_token';
+export const ENDPOINT_REST_BACKUPS = 'backups';
+export const ENDPOINT_REST_BACKUPS_DOWNLOAD = 'backups/download';
+export const ENDPOINT_REST_EMAILS = 'emails';
+export const ENDPOINT_REST_ID_MAPPINGS = 'id_mappings';
+export const ENDPOINT_REST_MOVED_IDS = 'moved_ids';
 export const ENDPOINT_SYNC_QUICK_ADD = ENDPOINT_REST_TASKS + '/quick';
 export const ENDPOINT_SYNC = 'sync';
 export const ENDPOINT_AUTHORIZATION = 'authorize';
@@ -69,6 +81,37 @@ export function getWorkspaceInvitationAcceptEndpoint(inviteCode) {
 export function getWorkspaceInvitationRejectEndpoint(inviteCode) {
     return `workspaces/invitations/${inviteCode}/reject`;
 }
+// Insights endpoints
+export function getProjectInsightsActivityStatsEndpoint(projectId) {
+    return `projects/${projectId}/insights/activity_stats`;
+}
+export function getProjectInsightsHealthEndpoint(projectId) {
+    return `projects/${projectId}/insights/health`;
+}
+export function getProjectInsightsHealthContextEndpoint(projectId) {
+    return `projects/${projectId}/insights/health/context`;
+}
+export function getProjectInsightsProgressEndpoint(projectId) {
+    return `projects/${projectId}/insights/progress`;
+}
+export function getProjectInsightsHealthAnalyzeEndpoint(projectId) {
+    return `projects/${projectId}/insights/health/analyze`;
+}
+export function getWorkspaceInsightsEndpoint(workspaceId) {
+    return `workspaces/${workspaceId}/insights`;
+}
+// Workspace members
+export const ENDPOINT_WORKSPACE_MEMBERS = 'workspaces/members';
+// Workspace user management (require workspace_id and/or user_id parameters)
+export function getWorkspaceUserTasksEndpoint(workspaceId, userId) {
+    return `workspaces/${workspaceId}/users/${userId}/tasks`;
+}
+export function getWorkspaceInviteUsersEndpoint(workspaceId) {
+    return `workspaces/${workspaceId}/users/invite`;
+}
+export function getWorkspaceUserEndpoint(workspaceId, userId) {
+    return `workspaces/${workspaceId}/users/${userId}`;
+}
 // Workspace projects (require workspace_id parameter)
 export function getWorkspaceActiveProjectsEndpoint(workspaceId) {
     return `workspaces/${workspaceId}/projects/active`;