@doist/todoist-api-typescript 4.0.0 → 4.0.2

package/README.md

@@ -24,7 +24,7 @@ api.getTasks()
 
 ### Documentation
 
-For more detailed reference documentation, have a look at the [Todoist API v1 Documentation](https://todoist.com/api/v1).
+For more detailed reference documentation, have a look at the [Todoist API v1 Documentation](https://todoist.com/api/v1/docs).
 
 ### Migration Guide
 

package/dist/TodoistApi.js

@@ -55,6 +55,7 @@ var validators_1 = require("./utils/validators");
 var zod_1 = require("zod");
 var uuid_1 = require("uuid");
 var types_1 = require("./types");
+var projectConverter_1 = require("./utils/projectConverter");
 var MAX_COMMAND_COUNT = 100;
 /**
  * Joins path segments using `/` separator.
@@ -110,7 +111,7 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.getTask = function (id) {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var response, task;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -118,7 +119,8 @@ var TodoistApi = /** @class */ (function () {
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
-                        return [2 /*return*/, (0, validators_1.validateTask)(response.data)];
+                        task = (0, taskConverters_1.getTaskFromRawTaskResponse)(response.data);
+                        return [2 /*return*/, (0, validators_1.validateTask)(task)];
                 }
             });
         });
@@ -132,12 +134,13 @@ var TodoistApi = /** @class */ (function () {
     TodoistApi.prototype.getTasks = function (args) {
         if (args === void 0) { args = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var _a, results, nextCursor;
+            var _a, rawResults, nextCursor, results;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_TASKS, this.authToken, args)];
                     case 1:
-                        _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
+                        _a = (_b.sent()).data, rawResults = _a.results, nextCursor = _a.nextCursor;
+                        results = rawResults.map(taskConverters_1.getTaskFromRawTaskResponse);
                         return [2 /*return*/, {
                                 results: (0, validators_1.validateTaskArray)(results),
                                 nextCursor: nextCursor,
@@ -154,12 +157,13 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.getTasksByFilter = function (args) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, results, nextCursor;
+            var _a, rawResults, nextCursor, results;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_TASKS_FILTER, this.authToken, args)];
                     case 1:
-                        _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
+                        _a = (_b.sent()).data, rawResults = _a.results, nextCursor = _a.nextCursor;
+                        results = rawResults.map(taskConverters_1.getTaskFromRawTaskResponse);
                         return [2 /*return*/, {
                                 results: (0, validators_1.validateTaskArray)(results),
                                 nextCursor: nextCursor,
@@ -177,13 +181,14 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.addTask = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var response, task;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, endpoints_1.ENDPOINT_REST_TASKS, this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
-                        return [2 /*return*/, (0, validators_1.validateTask)(response.data)];
+                        task = (0, taskConverters_1.getTaskFromRawTaskResponse)(response.data);
+                        return [2 /*return*/, (0, validators_1.validateTask)(task)];
                 }
             });
         });
@@ -218,7 +223,7 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.updateTask = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var response, task;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -226,7 +231,8 @@ var TodoistApi = /** @class */ (function () {
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
-                        return [2 /*return*/, (0, validators_1.validateTask)(response.data)];
+                        task = (0, taskConverters_1.getTaskFromRawTaskResponse)(response.data);
+                        return [2 /*return*/, (0, validators_1.validateTask)(task)];
                 }
             });
         });
@@ -358,7 +364,7 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.getProject = function (id) {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var response, project;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -366,7 +372,8 @@ var TodoistApi = /** @class */ (function () {
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
-                        return [2 /*return*/, (0, validators_1.validateProject)(response.data)];
+                        project = (0, projectConverter_1.getProjectFromRawProjectResponse)(response.data);
+                        return [2 /*return*/, (0, validators_1.validateProject)(project)];
                 }
             });
         });
@@ -380,12 +387,13 @@ var TodoistApi = /** @class */ (function () {
     TodoistApi.prototype.getProjects = function (args) {
         if (args === void 0) { args = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var _a, results, nextCursor;
+            var _a, rawResults, nextCursor, results;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_PROJECTS, this.authToken, args)];
                     case 1:
-                        _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
+                        _a = (_b.sent()).data, rawResults = _a.results, nextCursor = _a.nextCursor;
+                        results = rawResults.map(projectConverter_1.getProjectFromRawProjectResponse);
                         return [2 /*return*/, {
                                 results: (0, validators_1.validateProjectArray)(results),
                                 nextCursor: nextCursor,
@@ -403,13 +411,14 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.addProject = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var response, project;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, endpoints_1.ENDPOINT_REST_PROJECTS, this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
-                        return [2 /*return*/, (0, validators_1.validateProject)(response.data)];
+                        project = (0, projectConverter_1.getProjectFromRawProjectResponse)(response.data);
+                        return [2 /*return*/, (0, validators_1.validateProject)(project)];
                 }
             });
         });
@@ -424,7 +433,7 @@ var TodoistApi = /** @class */ (function () {
      */
     TodoistApi.prototype.updateProject = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
-            var response;
+            var response, project;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -432,7 +441,8 @@ var TodoistApi = /** @class */ (function () {
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
-                        return [2 /*return*/, (0, validators_1.validateProject)(response.data)];
+                        project = (0, projectConverter_1.getProjectFromRawProjectResponse)(response.data);
+                        return [2 /*return*/, (0, validators_1.validateProject)(project)];
                 }
             });
         });

package/dist/authentication.d.ts

@@ -2,7 +2,7 @@
  * Permission scopes that can be requested during OAuth2 authorization.
  * @see {@link https://todoist.com/api/v1/docs#tag/Authorization}
  */
-export type Permission = 'task:add' | 'data:read' | 'data:read_write' | 'data:delete' | 'project:delete';
+export type Permission = 'task:add' | 'data:read' | 'data:read_write' | 'data:delete' | 'project:delete' | 'backups:read';
 /**
  * Parameters required to exchange an authorization code for an access token.
  * @see https://todoist.com/api/v1/docs#tag/Authorization/OAuth

package/dist/testUtils/testDefaults.d.ts

@@ -1,4 +1,4 @@
-import { Label, Project, QuickAddTaskResponse, Section, Task, User, RawComment, Attachment, Duration, Deadline } from '../types';
+import { Label, Project, QuickAddTaskResponse, Section, Task, User, RawComment, Attachment, Duration, Deadline, RawTask, RawProject } from '../types';
 export declare const DEFAULT_AUTH_TOKEN = "AToken";
 export declare const DEFAULT_REQUEST_ID = "ARequestID";
 export declare const INVALID_ENTITY_ID = 1234;
@@ -16,30 +16,30 @@ export declare const DEFAULT_TASK: Task;
 export declare const INVALID_TASK: {
     due: string;
     id: string;
-    assignerId: string | null;
-    assigneeId: string | null;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    order: number;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    priority: number;
     content: string;
     description: string;
+    assignerId: string | null;
+    assigneeId: string | null;
+    order: number;
     isCompleted: boolean;
-    labels: string[];
-    priority: number;
     creatorId: string;
     createdAt: string;
     url: string;
-    duration: {
-        amount: number;
-        unit: "minute" | "day";
-    } | null;
-    deadline: {
-        date: string;
-        lang: string;
-    } | null;
 };
-export declare const TASK_WITH_OPTIONALS_AS_NULL: Task;
+export declare const TASK_WITH_OPTIONALS_AS_NULL: RawTask;
 export declare const DEFAULT_PROJECT: Project;
 export declare const INVALID_PROJECT: {
     name: number;
@@ -48,26 +48,26 @@ export declare const INVALID_PROJECT: {
     order: number | null;
     url: string;
     color: string;
-    isShared: boolean;
     isFavorite: boolean;
+    viewStyle: string;
+    isShared: boolean;
     isInboxProject: boolean;
     isTeamInbox: boolean;
-    viewStyle: string;
 };
 export declare const PROJECT_WITH_OPTIONALS_AS_NULL: Project;
 export declare const DEFAULT_SECTION: Section;
 export declare const INVALID_SECTION: {
     projectId: undefined;
-    id: string;
-    name: string;
     userId: string;
+    id: string;
+    isDeleted: boolean;
     addedAt: string;
     updatedAt: string;
+    isCollapsed: boolean;
+    isArchived: boolean;
+    name: string;
     archivedAt: string | null;
     sectionOrder: number;
-    isArchived: boolean;
-    isDeleted: boolean;
-    isCollapsed: boolean;
 };
 export declare const DEFAULT_LABEL: Label;
 export declare const INVALID_LABEL: {
@@ -103,8 +103,8 @@ export declare const DEFAULT_COMMENT: {
     taskId: string | undefined;
     itemId: undefined;
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -155,8 +155,8 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_TASK: {
     taskId: string | undefined;
     itemId: undefined;
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -182,8 +182,8 @@ export declare const COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL: {
     taskId: string | undefined;
     itemId: undefined;
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -208,8 +208,8 @@ export declare const RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: RawComment;
 export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
     taskId: undefined;
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -231,3 +231,5 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
     projectId?: string | undefined;
     itemId?: string | undefined;
 };
+export declare const RAW_DEFAULT_TASK: RawTask;
+export declare const RAW_DEFAULT_PROJECT: RawProject;

package/dist/testUtils/testDefaults.js

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 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_QUICK_ADD_RESPONSE = exports.DEFAULT_DEADLINE = exports.DEFAULT_DURATION = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = void 0;
+exports.RAW_DEFAULT_PROJECT = exports.RAW_DEFAULT_TASK = 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_QUICK_ADD_RESPONSE = exports.DEFAULT_DEADLINE = exports.DEFAULT_DURATION = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = void 0;
 var DEFAULT_TASK_ID = '1234';
 var DEFAULT_TASK_CONTENT = 'This is a task';
 var DEFAULT_TASK_DESCRIPTION = 'A description';
@@ -100,7 +100,31 @@ exports.DEFAULT_TASK = {
     deadline: exports.DEFAULT_DEADLINE,
 };
 exports.INVALID_TASK = __assign(__assign({}, exports.DEFAULT_TASK), { due: '2020-01-31' });
-exports.TASK_WITH_OPTIONALS_AS_NULL = __assign(__assign({}, exports.DEFAULT_TASK), { due: null, assigneeId: null, assignerId: null, parentId: null, sectionId: null, duration: null });
+exports.TASK_WITH_OPTIONALS_AS_NULL = {
+    userId: DEFAULT_CREATOR,
+    id: DEFAULT_TASK_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    sectionId: null,
+    parentId: null,
+    addedByUid: DEFAULT_CREATOR,
+    assignedByUid: null,
+    responsibleUid: null,
+    labels: [],
+    deadline: null,
+    duration: null,
+    checked: false,
+    isDeleted: false,
+    addedAt: DEFAULT_DATE,
+    completedAt: null,
+    updatedAt: DEFAULT_DATE,
+    due: null,
+    priority: DEFAULT_TASK_PRIORITY,
+    childOrder: DEFAULT_ORDER,
+    content: DEFAULT_TASK_CONTENT,
+    description: DEFAULT_TASK_DESCRIPTION,
+    dayOrder: DEFAULT_ORDER,
+    isCollapsed: false,
+};
 exports.DEFAULT_PROJECT = {
     id: DEFAULT_PROJECT_ID,
     name: DEFAULT_PROJECT_NAME,
@@ -182,3 +206,49 @@ exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = __assign(__assign({
 exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = __assign(__assign({}, exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL), { taskId: exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL.itemId, itemId: undefined });
 exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = __assign(__assign({}, exports.DEFAULT_RAW_COMMENT), { itemId: undefined, projectId: DEFAULT_PROJECT_ID });
 exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = __assign(__assign({}, exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT), { taskId: undefined });
+exports.RAW_DEFAULT_TASK = {
+    userId: DEFAULT_CREATOR,
+    id: DEFAULT_TASK_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    sectionId: DEFAULT_SECTION_ID,
+    parentId: DEFAULT_PARENT_ID,
+    addedByUid: DEFAULT_CREATOR,
+    assignedByUid: DEFAULT_CREATOR,
+    responsibleUid: DEFAULT_ASSIGNEE,
+    labels: DEFAULT_LABELS,
+    deadline: exports.DEFAULT_DEADLINE,
+    duration: exports.DEFAULT_DURATION,
+    checked: false,
+    isDeleted: false,
+    addedAt: DEFAULT_DATE,
+    completedAt: null,
+    updatedAt: DEFAULT_DATE,
+    due: exports.DEFAULT_DUE_DATE,
+    priority: DEFAULT_TASK_PRIORITY,
+    childOrder: DEFAULT_ORDER,
+    content: DEFAULT_TASK_CONTENT,
+    description: DEFAULT_TASK_DESCRIPTION,
+    dayOrder: DEFAULT_ORDER,
+    isCollapsed: false,
+};
+exports.RAW_DEFAULT_PROJECT = {
+    id: DEFAULT_PROJECT_ID,
+    canAssignTasks: true,
+    childOrder: DEFAULT_ORDER,
+    color: DEFAULT_ENTITY_COLOR,
+    createdAt: DEFAULT_DATE,
+    isArchived: false,
+    isDeleted: false,
+    isFavorite: false,
+    isFrozen: false,
+    name: DEFAULT_PROJECT_NAME,
+    updatedAt: DEFAULT_DATE,
+    viewStyle: DEFAULT_PROJECT_VIEW_STYLE,
+    defaultOrder: DEFAULT_ORDER,
+    description: '',
+    publicAccess: false,
+    parentId: DEFAULT_PROJECT_ID,
+    inboxProject: false,
+    isCollapsed: false,
+    isShared: false,
+};

package/dist/types/entities.d.ts

@@ -59,6 +59,147 @@ export declare const DeadlineSchema: z.ZodObject<{
  */
 export interface Deadline extends z.infer<typeof DeadlineSchema> {
 }
+export declare const RawTaskSchema: z.ZodObject<{
+    userId: z.ZodString;
+    id: z.ZodString;
+    projectId: z.ZodString;
+    sectionId: z.ZodNullable<z.ZodString>;
+    parentId: z.ZodNullable<z.ZodString>;
+    addedByUid: z.ZodString;
+    assignedByUid: z.ZodNullable<z.ZodString>;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    labels: z.ZodArray<z.ZodString, "many">;
+    deadline: z.ZodNullable<z.ZodObject<{
+        date: z.ZodString;
+        lang: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        lang: string;
+    }, {
+        date: string;
+        lang: string;
+    }>>;
+    duration: z.ZodNullable<z.ZodObject<{
+        amount: z.ZodNumber;
+        unit: z.ZodEnum<["minute", "day"]>;
+    }, "strip", z.ZodTypeAny, {
+        amount: number;
+        unit: "minute" | "day";
+    }, {
+        amount: number;
+        unit: "minute" | "day";
+    }>>;
+    checked: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    addedAt: z.ZodString;
+    completedAt: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodString;
+    due: z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
+        isRecurring: z.ZodBoolean;
+        string: z.ZodString;
+        date: z.ZodString;
+    }, {
+        datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }>, "strip", z.ZodTypeAny, {
+        string: string;
+        isRecurring: boolean;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    }, {
+        string: string;
+        isRecurring: boolean;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    }>>;
+    priority: z.ZodNumber;
+    childOrder: z.ZodNumber;
+    content: z.ZodString;
+    description: z.ZodString;
+    dayOrder: z.ZodNumber;
+    isCollapsed: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    userId: string;
+    id: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string;
+    completedAt: string | null;
+    updatedAt: string;
+    due: {
+        string: string;
+        isRecurring: boolean;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+}, {
+    userId: string;
+    id: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string;
+    completedAt: string | null;
+    updatedAt: string;
+    due: {
+        string: string;
+        isRecurring: boolean;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+}>;
+export interface RawTask extends z.infer<typeof RawTaskSchema> {
+}
 export declare const TaskSchema: z.ZodObject<{
     id: z.ZodString;
     assignerId: z.ZodNullable<z.ZodString>;
@@ -120,19 +261,18 @@ export declare const TaskSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    assignerId: string | null;
-    assigneeId: string | null;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    order: number;
-    content: string;
-    description: string;
-    isCompleted: boolean;
     labels: string[];
-    priority: number;
-    creatorId: string;
-    createdAt: string;
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
     due: {
         string: string;
         isRecurring: boolean;
@@ -141,30 +281,30 @@ export declare const TaskSchema: z.ZodObject<{
         timezone?: string | null | undefined;
         lang?: string | null | undefined;
     } | null;
+    priority: number;
+    content: string;
+    description: string;
+    assignerId: string | null;
+    assigneeId: string | null;
+    order: number;
+    isCompleted: boolean;
+    creatorId: string;
+    createdAt: string;
     url: string;
-    duration: {
-        amount: number;
-        unit: "minute" | "day";
-    } | null;
-    deadline: {
-        date: string;
-        lang: string;
-    } | null;
 }, {
     id: string;
-    assignerId: string | null;
-    assigneeId: string | null;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    order: number;
-    content: string;
-    description: string;
-    isCompleted: boolean;
     labels: string[];
-    priority: number;
-    creatorId: string;
-    createdAt: string;
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
     due: {
         string: string;
         isRecurring: boolean;
@@ -173,15 +313,16 @@ export declare const TaskSchema: z.ZodObject<{
         timezone?: string | null | undefined;
         lang?: string | null | undefined;
     } | null;
+    priority: number;
+    content: string;
+    description: string;
+    assignerId: string | null;
+    assigneeId: string | null;
+    order: number;
+    isCompleted: boolean;
+    creatorId: string;
+    createdAt: string;
     url: string;
-    duration: {
-        amount: number;
-        unit: "minute" | "day";
-    } | null;
-    deadline: {
-        date: string;
-        lang: string;
-    } | null;
 }>;
 /**
  * Represents a task in Todoist.
@@ -189,6 +330,69 @@ export declare const TaskSchema: z.ZodObject<{
  */
 export interface Task extends z.infer<typeof TaskSchema> {
 }
+export declare const RawProjectSchema: z.ZodObject<{
+    id: z.ZodString;
+    canAssignTasks: z.ZodBoolean;
+    childOrder: z.ZodNullable<z.ZodNumber>;
+    color: z.ZodString;
+    createdAt: z.ZodString;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isFrozen: z.ZodBoolean;
+    name: z.ZodString;
+    updatedAt: z.ZodString;
+    viewStyle: z.ZodString;
+    defaultOrder: z.ZodNullable<z.ZodNumber>;
+    description: z.ZodString;
+    publicAccess: z.ZodBoolean;
+    parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    inboxProject: z.ZodOptional<z.ZodBoolean>;
+    isCollapsed: z.ZodBoolean;
+    isShared: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    isDeleted: boolean;
+    updatedAt: string;
+    childOrder: number | null;
+    description: string;
+    isCollapsed: boolean;
+    createdAt: string;
+    canAssignTasks: boolean;
+    color: string;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number | null;
+    publicAccess: boolean;
+    isShared: boolean;
+    parentId?: string | null | undefined;
+    inboxProject?: boolean | undefined;
+}, {
+    id: string;
+    isDeleted: boolean;
+    updatedAt: string;
+    childOrder: number | null;
+    description: string;
+    isCollapsed: boolean;
+    createdAt: string;
+    canAssignTasks: boolean;
+    color: string;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number | null;
+    publicAccess: boolean;
+    isShared: boolean;
+    parentId?: string | null | undefined;
+    inboxProject?: boolean | undefined;
+}>;
+export interface RawProject extends z.infer<typeof RawProjectSchema> {
+}
 export declare const ProjectSchema: z.ZodObject<{
     id: z.ZodString;
     parentId: z.ZodNullable<z.ZodString>;
@@ -207,24 +411,24 @@ export declare const ProjectSchema: z.ZodObject<{
     order: number | null;
     url: string;
     color: string;
+    isFavorite: boolean;
     name: string;
+    viewStyle: string;
     isShared: boolean;
-    isFavorite: boolean;
     isInboxProject: boolean;
     isTeamInbox: boolean;
-    viewStyle: string;
 }, {
     id: string;
     parentId: string | null;
     order: number | null;
     url: string;
     color: string;
+    isFavorite: boolean;
     name: string;
+    viewStyle: string;
     isShared: boolean;
-    isFavorite: boolean;
     isInboxProject: boolean;
     isTeamInbox: boolean;
-    viewStyle: string;
 }>;
 /**
  * Represents a project in Todoist.
@@ -249,29 +453,29 @@ export declare const SectionSchema: z.ZodObject<{
     isDeleted: z.ZodBoolean;
     isCollapsed: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
+    userId: string;
     id: string;
     projectId: string;
-    name: string;
-    userId: string;
+    isDeleted: boolean;
     addedAt: string;
     updatedAt: string;
+    isCollapsed: boolean;
+    isArchived: boolean;
+    name: string;
     archivedAt: string | null;
     sectionOrder: number;
-    isArchived: boolean;
-    isDeleted: boolean;
-    isCollapsed: boolean;
 }, {
+    userId: string;
     id: string;
     projectId: string;
-    name: string;
-    userId: string;
+    isDeleted: boolean;
     addedAt: string;
     updatedAt: string;
+    isCollapsed: boolean;
+    isArchived: boolean;
+    name: string;
     archivedAt: string | null;
     sectionOrder: number;
-    isArchived: boolean;
-    isDeleted: boolean;
-    isCollapsed: boolean;
 }>;
 /**
  * Represents a section in a Todoist project.
@@ -289,14 +493,14 @@ export declare const LabelSchema: z.ZodObject<{
     id: string;
     order: number | null;
     color: string;
-    name: string;
     isFavorite: boolean;
+    name: string;
 }, {
     id: string;
     order: number | null;
     color: string;
-    name: string;
     isFavorite: boolean;
+    name: string;
 }>;
 /**
  * Represents a label in Todoist.
@@ -404,8 +608,8 @@ export declare const RawCommentSchema: z.ZodEffects<z.ZodObject<{
     isDeleted: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -428,8 +632,8 @@ export declare const RawCommentSchema: z.ZodEffects<z.ZodObject<{
     itemId?: string | undefined;
 }, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -452,8 +656,8 @@ export declare const RawCommentSchema: z.ZodEffects<z.ZodObject<{
     itemId?: string | undefined;
 }>, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -476,8 +680,8 @@ export declare const RawCommentSchema: z.ZodEffects<z.ZodObject<{
     itemId?: string | undefined;
 }, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -558,8 +762,8 @@ export declare const CommentSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     isDeleted: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -582,8 +786,8 @@ export declare const CommentSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     itemId?: string | undefined;
 }, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -606,8 +810,8 @@ export declare const CommentSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     itemId?: string | undefined;
 }>, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -630,8 +834,8 @@ export declare const CommentSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     itemId?: string | undefined;
 }, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -655,8 +859,8 @@ export declare const CommentSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
 }>, {
     taskId: string | undefined;
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;
@@ -678,8 +882,8 @@ export declare const CommentSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     projectId?: string | undefined;
 }, {
     id: string;
-    content: string;
     isDeleted: boolean;
+    content: string;
     postedAt: string;
     fileAttachment: {
         resourceType: string;

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.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.ProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
+exports.ColorSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.ProjectSchema = exports.RawProjectSchema = exports.TaskSchema = exports.RawTaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
 var zod_1 = require("zod");
 exports.DueDateSchema = zod_1.z
     .object({
@@ -43,6 +43,31 @@ exports.DeadlineSchema = zod_1.z.object({
     date: zod_1.z.string(),
     lang: zod_1.z.string(),
 });
+exports.RawTaskSchema = zod_1.z.object({
+    userId: zod_1.z.string(),
+    id: zod_1.z.string(),
+    projectId: zod_1.z.string(),
+    sectionId: zod_1.z.string().nullable(),
+    parentId: zod_1.z.string().nullable(),
+    addedByUid: zod_1.z.string(),
+    assignedByUid: zod_1.z.string().nullable(),
+    responsibleUid: zod_1.z.string().nullable(),
+    labels: zod_1.z.array(zod_1.z.string()),
+    deadline: exports.DeadlineSchema.nullable(),
+    duration: exports.DurationSchema.nullable(),
+    checked: zod_1.z.boolean(),
+    isDeleted: zod_1.z.boolean(),
+    addedAt: zod_1.z.string(),
+    completedAt: zod_1.z.string().nullable(),
+    updatedAt: zod_1.z.string(),
+    due: exports.DueDateSchema.nullable(),
+    priority: zod_1.z.number().int(),
+    childOrder: zod_1.z.number().int(),
+    content: zod_1.z.string(),
+    description: zod_1.z.string(),
+    dayOrder: zod_1.z.number().int(),
+    isCollapsed: zod_1.z.boolean(),
+});
 exports.TaskSchema = zod_1.z.object({
     id: zod_1.z.string(),
     assignerId: zod_1.z.string().nullable(),
@@ -63,6 +88,27 @@ exports.TaskSchema = zod_1.z.object({
     duration: exports.DurationSchema.nullable(),
     deadline: exports.DeadlineSchema.nullable(),
 });
+exports.RawProjectSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    canAssignTasks: zod_1.z.boolean(),
+    childOrder: zod_1.z.number().int().nullable(),
+    color: zod_1.z.string(),
+    createdAt: zod_1.z.string(),
+    isArchived: zod_1.z.boolean(),
+    isDeleted: zod_1.z.boolean(),
+    isFavorite: zod_1.z.boolean(),
+    isFrozen: zod_1.z.boolean(),
+    name: zod_1.z.string(),
+    updatedAt: zod_1.z.string(),
+    viewStyle: zod_1.z.string(),
+    defaultOrder: zod_1.z.number().int().nullable(),
+    description: zod_1.z.string(),
+    publicAccess: zod_1.z.boolean(),
+    parentId: zod_1.z.string().nullable().optional(),
+    inboxProject: zod_1.z.boolean().optional(),
+    isCollapsed: zod_1.z.boolean(),
+    isShared: zod_1.z.boolean(),
+});
 exports.ProjectSchema = zod_1.z.object({
     id: zod_1.z.string(),
     parentId: zod_1.z.string().nullable(),

package/dist/utils/projectConverter.d.ts

@@ -0,0 +1,2 @@
+import { Project, RawProject } from '../types';
+export declare function getProjectFromRawProjectResponse(responseData: RawProject): Project;

package/dist/utils/projectConverter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectFromRawProjectResponse = void 0;
+var showProjectEndpoint = 'https://todoist.com/showProject';
+function getProjectUrlFromProjectId(projectId) {
+    return "".concat(showProjectEndpoint, "?id=").concat(projectId);
+}
+function getProjectFromRawProjectResponse(responseData) {
+    var _a, _b;
+    var project = {
+        id: responseData.id,
+        parentId: (_a = responseData.parentId) !== null && _a !== void 0 ? _a : null, // workspace projects do not have a parent
+        order: responseData.childOrder,
+        color: responseData.color,
+        name: responseData.name,
+        isShared: responseData.isShared,
+        isFavorite: responseData.isFavorite,
+        isInboxProject: (_b = responseData.inboxProject) !== null && _b !== void 0 ? _b : false, // workspace projects do not set this flag
+        isTeamInbox: false, // this flag is no longer used
+        url: getProjectUrlFromProjectId(responseData.id),
+        viewStyle: responseData.viewStyle,
+    };
+    return project;
+}
+exports.getProjectFromRawProjectResponse = getProjectFromRawProjectResponse;

package/dist/utils/taskConverters.d.ts

@@ -1,2 +1,3 @@
-import { QuickAddTaskResponse, Task } from '../types';
+import { QuickAddTaskResponse, RawTask, Task } from '../types';
 export declare function getTaskFromQuickAddResponse(responseData: QuickAddTaskResponse): Task;
+export declare function getTaskFromRawTaskResponse(responseData: RawTask): Task;

package/dist/utils/taskConverters.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTaskFromQuickAddResponse = void 0;
+exports.getTaskFromRawTaskResponse = exports.getTaskFromQuickAddResponse = void 0;
 var showTaskEndpoint = 'https://todoist.com/showTask';
-function getTaskUrlFromQuickAddResponse(responseData) {
-    return "".concat(showTaskEndpoint, "?id=").concat(responseData.id);
+function getTaskUrlFromTaskId(taskId) {
+    return "".concat(showTaskEndpoint, "?id=").concat(taskId);
 }
 function getTaskFromQuickAddResponse(responseData) {
     var _a;
@@ -18,7 +18,7 @@ function getTaskFromQuickAddResponse(responseData) {
         labels: responseData.labels,
         priority: responseData.priority,
         createdAt: responseData.addedAt,
-        url: getTaskUrlFromQuickAddResponse(responseData),
+        url: getTaskUrlFromTaskId(responseData.id),
         creatorId: (_a = responseData.addedByUid) !== null && _a !== void 0 ? _a : '',
         parentId: responseData.parentId,
         duration: responseData.duration,
@@ -30,3 +30,27 @@ function getTaskFromQuickAddResponse(responseData) {
     return task;
 }
 exports.getTaskFromQuickAddResponse = getTaskFromQuickAddResponse;
+function getTaskFromRawTaskResponse(responseData) {
+    var task = {
+        id: responseData.id,
+        assignerId: responseData.assignedByUid,
+        assigneeId: responseData.responsibleUid,
+        projectId: responseData.projectId,
+        sectionId: responseData.sectionId,
+        parentId: responseData.parentId,
+        order: responseData.childOrder,
+        content: responseData.content,
+        description: responseData.description,
+        isCompleted: responseData.checked,
+        labels: responseData.labels,
+        priority: responseData.priority,
+        creatorId: responseData.addedByUid,
+        createdAt: responseData.addedAt,
+        due: responseData.due,
+        url: getTaskUrlFromTaskId(responseData.id),
+        duration: responseData.duration,
+        deadline: responseData.deadline,
+    };
+    return task;
+}
+exports.getTaskFromRawTaskResponse = getTaskFromRawTaskResponse;

package/dist/utils/validators.js

@@ -2,7 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateProjectArray = exports.validateProject = exports.validateTaskArray = exports.validateTask = void 0;
 var entities_1 = require("../types/entities");
+var projectConverter_1 = require("./projectConverter");
+var taskConverters_1 = require("./taskConverters");
 function validateTask(input) {
+    var rawTaskParse = entities_1.RawTaskSchema.safeParse(input);
+    if (rawTaskParse.success) {
+        var task = (0, taskConverters_1.getTaskFromRawTaskResponse)(rawTaskParse.data);
+        return task;
+    }
     return entities_1.TaskSchema.parse(input);
 }
 exports.validateTask = validateTask;
@@ -11,6 +18,11 @@ function validateTaskArray(input) {
 }
 exports.validateTaskArray = validateTaskArray;
 function validateProject(input) {
+    var rawProjectParse = entities_1.RawProjectSchema.safeParse(input);
+    if (rawProjectParse.success) {
+        var project = (0, projectConverter_1.getProjectFromRawProjectResponse)(rawProjectParse.data);
+        return project;
+    }
     return entities_1.ProjectSchema.parse(input);
 }
 exports.validateProject = validateProject;

package/package.json

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