@doist/todoist-api-typescript 7.3.0 → 7.5.0

package/README.md

@@ -4,6 +4,8 @@ This is the official TypeScript API client for the Todoist REST API.
 
 ## Installation
 
+Requires Node 20.18.1+.
+
 ```
 npm install @doist/todoist-api-typescript
 ```

package/dist/cjs/authentication.js

@@ -1,13 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PERMISSIONS = void 0;
 exports.getAuthStateParameter = getAuthStateParameter;
 exports.getAuthorizationUrl = getAuthorizationUrl;
 exports.getAuthToken = getAuthToken;
 exports.revokeToken = revokeToken;
-const rest_client_1 = require("./rest-client");
+const http_client_1 = require("./transport/http-client");
 const uuid_1 = require("uuid");
 const types_1 = require("./types");
 const endpoints_1 = require("./consts/endpoints");
+/** Available OAuth2 permission scopes. */
+exports.PERMISSIONS = [
+    'task:add',
+    'data:read',
+    'data:read_write',
+    'data:delete',
+    'project:delete',
+    'backups:read',
+];
 /**
  * Creates a Basic Authentication header value from client credentials.
  * @param clientId - The OAuth client ID
@@ -80,7 +90,7 @@ async function getAuthToken(args, options) {
     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 (0, rest_client_1.request)({
+        const response = await (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: (0, endpoints_1.getAuthBaseUri)(baseUrl),
             relativePath: endpoints_1.ENDPOINT_GET_TOKEN,
@@ -135,7 +145,7 @@ async function revokeToken(args, options) {
         token,
         token_type_hint: 'access_token',
     };
-    const response = await (0, rest_client_1.request)({
+    const response = await (0, http_client_1.request)({
         httpMethod: 'POST',
         baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
         relativePath: endpoints_1.ENDPOINT_REVOKE,
@@ -146,5 +156,5 @@ async function revokeToken(args, options) {
         customHeaders: customHeaders,
         customFetch,
     });
-    return (0, rest_client_1.isSuccess)(response);
+    return (0, http_client_1.isSuccess)(response);
 }

package/dist/cjs/consts/endpoints.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = 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_SEARCH = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = 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_SEARCH = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS_SEARCH = 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_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REST_WORKSPACES = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = exports.SECTION_UNARCHIVE = exports.SECTION_ARCHIVE = exports.ENDPOINT_REST_PROJECT_JOIN = exports.ENDPOINT_REST_PROJECT_FULL = exports.ENDPOINT_REST_PROJECTS_PERMISSIONS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = 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_SEARCH = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_LOCATION_REMINDERS = exports.ENDPOINT_REST_REMINDERS = 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_SEARCH = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS_SEARCH = 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_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
 exports.getWorkspaceInvitationAcceptEndpoint = getWorkspaceInvitationAcceptEndpoint;
@@ -34,6 +35,8 @@ exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS + '/shared';
 exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED + '/rename';
 exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED + '/remove';
 exports.ENDPOINT_REST_COMMENTS = 'comments';
+exports.ENDPOINT_REST_REMINDERS = 'reminders';
+exports.ENDPOINT_REST_LOCATION_REMINDERS = 'location_reminders';
 exports.ENDPOINT_REST_TASK_CLOSE = 'close';
 exports.ENDPOINT_REST_TASK_REOPEN = 'reopen';
 exports.ENDPOINT_REST_TASK_MOVE = 'move';
@@ -47,6 +50,12 @@ exports.ENDPOINT_REST_ACTIVITIES = 'activities';
 exports.ENDPOINT_REST_UPLOADS = 'uploads';
 exports.PROJECT_ARCHIVE = 'archive';
 exports.PROJECT_UNARCHIVE = 'unarchive';
+exports.ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT = exports.ENDPOINT_REST_PROJECTS + '/archived/count';
+exports.ENDPOINT_REST_PROJECTS_PERMISSIONS = exports.ENDPOINT_REST_PROJECTS + '/permissions';
+exports.ENDPOINT_REST_PROJECT_FULL = 'full';
+exports.ENDPOINT_REST_PROJECT_JOIN = 'join';
+exports.SECTION_ARCHIVE = 'archive';
+exports.SECTION_UNARCHIVE = 'unarchive';
 exports.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = exports.ENDPOINT_REST_PROJECTS + '/move_to_workspace';
 exports.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = exports.ENDPOINT_REST_PROJECTS + '/move_to_personal';
 exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_TASKS + '/quick';
@@ -55,6 +64,7 @@ exports.ENDPOINT_AUTHORIZATION = 'authorize';
 exports.ENDPOINT_GET_TOKEN = 'access_token';
 exports.ENDPOINT_REVOKE = 'revoke';
 // Workspace endpoints
+exports.ENDPOINT_REST_WORKSPACES = 'workspaces';
 exports.ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';
 exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = 'workspaces/invitations/all';
 exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = 'workspaces/invitations/delete';

package/dist/cjs/test-utils/asserts.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertInstance = assertInstance;
 // Has to use 'any' to express constructor type
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// oxlint-disable-next-line no-explicit-any
 function assertInstance(value, type) {
     if (value instanceof type) {
         return;

package/dist/cjs/test-utils/test-defaults.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.INVALID_COMMENT = exports.DEFAULT_COMMENT = exports.DEFAULT_RAW_COMMENT = exports.INVALID_ATTACHMENT = exports.DEFAULT_ATTACHMENT = exports.INVALID_USER = exports.DEFAULT_USER = exports.INVALID_LABEL = exports.DEFAULT_LABEL = exports.INVALID_SECTION = exports.DEFAULT_SECTION = exports.PROJECT_WITH_OPTIONALS_AS_NULL = exports.INVALID_PROJECT = exports.DEFAULT_PROJECT = exports.TASK_WITH_OPTIONALS_AS_NULL = exports.INVALID_TASK = exports.DEFAULT_TASK = exports.DEFAULT_DEADLINE = exports.DEFAULT_DURATION = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = exports.DEFAULT_PROJECT_VIEW_STYLE = exports.DEFAULT_PROJECT_NAME = exports.DEFAULT_PROJECT_ID = exports.DEFAULT_ORDER = exports.DEFAULT_TASK_PRIORITY = exports.DEFAULT_TASK_DESCRIPTION = exports.DEFAULT_TASK_CONTENT = exports.DEFAULT_TASK_ID = void 0;
+exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.INVALID_COMMENT = exports.DEFAULT_LOCATION_REMINDER = exports.DEFAULT_ABSOLUTE_REMINDER = exports.DEFAULT_RELATIVE_REMINDER = exports.DEFAULT_REMINDER_ID = exports.DEFAULT_COMMENT = exports.DEFAULT_RAW_COMMENT = exports.INVALID_ATTACHMENT = exports.DEFAULT_ATTACHMENT = exports.INVALID_USER = exports.DEFAULT_USER = exports.INVALID_LABEL = exports.DEFAULT_LABEL = exports.INVALID_SECTION = exports.DEFAULT_SECTION = exports.PROJECT_WITH_OPTIONALS_AS_NULL = exports.INVALID_PROJECT = exports.DEFAULT_PROJECT = exports.TASK_WITH_OPTIONALS_AS_NULL = exports.INVALID_TASK = exports.DEFAULT_TASK = exports.DEFAULT_DEADLINE = exports.DEFAULT_DURATION = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = exports.DEFAULT_PROJECT_VIEW_STYLE = exports.DEFAULT_PROJECT_NAME = exports.DEFAULT_PROJECT_ID = exports.DEFAULT_ORDER = exports.DEFAULT_TASK_PRIORITY = exports.DEFAULT_TASK_DESCRIPTION = exports.DEFAULT_TASK_CONTENT = exports.DEFAULT_TASK_ID = void 0;
 const url_helpers_1 = require("../utils/url-helpers");
 exports.DEFAULT_TASK_ID = '1234';
 exports.DEFAULT_TASK_CONTENT = 'This is a task';
@@ -179,6 +179,38 @@ exports.DEFAULT_RAW_COMMENT = {
     itemId: exports.DEFAULT_TASK_ID,
 };
 exports.DEFAULT_COMMENT = Object.assign(Object.assign({}, exports.DEFAULT_RAW_COMMENT), { taskId: exports.DEFAULT_RAW_COMMENT.itemId, itemId: undefined });
+exports.DEFAULT_REMINDER_ID = '6XGgmFQrx44wfGHr';
+exports.DEFAULT_RELATIVE_REMINDER = {
+    id: exports.DEFAULT_REMINDER_ID,
+    itemId: exports.DEFAULT_TASK_ID,
+    notifyUid: DEFAULT_USER_ID,
+    isDeleted: false,
+    type: 'relative',
+    minuteOffset: 30,
+    due: exports.DEFAULT_DUE_DATE,
+    isUrgent: false,
+};
+exports.DEFAULT_ABSOLUTE_REMINDER = {
+    id: exports.DEFAULT_REMINDER_ID,
+    itemId: exports.DEFAULT_TASK_ID,
+    notifyUid: DEFAULT_USER_ID,
+    isDeleted: false,
+    type: 'absolute',
+    due: exports.DEFAULT_DUE_DATE,
+    isUrgent: true,
+};
+exports.DEFAULT_LOCATION_REMINDER = {
+    id: exports.DEFAULT_REMINDER_ID,
+    itemId: exports.DEFAULT_TASK_ID,
+    notifyUid: DEFAULT_USER_ID,
+    isDeleted: false,
+    type: 'location',
+    name: 'Aliados',
+    locLat: '41.148581',
+    locLong: '-8.610945000000015',
+    locTrigger: 'on_enter',
+    radius: 100,
+};
 exports.INVALID_COMMENT = Object.assign(Object.assign({}, exports.DEFAULT_RAW_COMMENT), { isDeleted: 'true' });
 exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK = Object.assign(Object.assign({}, exports.DEFAULT_RAW_COMMENT), { fileAttachment: null, uidsToNotify: null, reactions: null });
 exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = Object.assign(Object.assign({}, exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK), { taskId: exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK.itemId, itemId: undefined });