@doist/todoist-api-typescript 2.1.2 → 2.2.0

package/dist/TodoistApi.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/dist/authentication.d.ts

@@ -1,14 +1,14 @@
-export declare type Permission = 'task:add' | 'data:read' | 'data:read_write' | 'data:delete' | 'project:delete';
-export declare type AuthTokenResponse = {
+export type Permission = 'task:add' | 'data:read' | 'data:read_write' | 'data:delete' | 'project:delete';
+export type AuthTokenResponse = {
     accessToken: string;
     state: string;
 };
-export declare type AuthTokenRequestArgs = {
+export type AuthTokenRequestArgs = {
     clientId: string;
     clientSecret: string;
     code: string;
 };
-export declare type RevokeAuthTokenRequestArgs = {
+export type RevokeAuthTokenRequestArgs = {
     clientId: string;
     clientSecret: string;
     accessToken: string;

package/dist/authentication.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/dist/restClient.js

@@ -25,7 +25,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/dist/testUtils/asserts.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/dist/testUtils/testDefaults.d.ts

@@ -1,4 +1,4 @@
-import { Label, Project, QuickAddTaskResponse, Section, Task, User, Comment, Attachment } from '../types';
+import { Label, Project, QuickAddTaskResponse, Section, Task, User, Comment, Attachment, Duration } from '../types';
 export declare const DEFAULT_AUTH_TOKEN = "AToken";
 export declare const DEFAULT_REQUEST_ID = "ARequestID";
 export declare const INVALID_ENTITY_ID = 1234;
@@ -7,6 +7,7 @@ export declare const DEFAULT_DUE_DATE: {
     string: string;
     date: string;
 };
+export declare const DEFAULT_DURATION: Duration;
 export declare const INVALID_DUE_DATE: {
     isRecurring: string;
     string: string;
@@ -32,6 +33,10 @@ export declare const INVALID_TASK: {
     createdAt: string;
     url: string;
     creatorId: string;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
     assigneeId?: string | null | undefined;
     assignerId?: string | null | undefined;
     parentId?: string | null | undefined;

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.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.INVALID_COMMENT = exports.DEFAULT_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.INVALID_DUE_DATE = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = void 0;
+exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.INVALID_COMMENT = exports.DEFAULT_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.INVALID_DUE_DATE = 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';
@@ -43,6 +43,10 @@ exports.DEFAULT_DUE_DATE = {
     string: 'a date string',
     date: DEFAULT_DATE,
 };
+exports.DEFAULT_DURATION = {
+    amount: 10,
+    unit: 'minute',
+};
 exports.INVALID_DUE_DATE = __assign(__assign({}, exports.DEFAULT_DUE_DATE), { isRecurring: 'false' });
 exports.DEFAULT_QUICK_ADD_RESPONSE = {
     id: DEFAULT_TASK_ID,
@@ -58,6 +62,7 @@ exports.DEFAULT_QUICK_ADD_RESPONSE = {
     checked: false,
     addedAt: DEFAULT_DATE,
     addedByUid: DEFAULT_CREATOR,
+    duration: exports.DEFAULT_DURATION,
     due: {
         date: DEFAULT_DATE,
         timezone: null,
@@ -83,9 +88,10 @@ exports.DEFAULT_TASK = {
     due: exports.DEFAULT_DUE_DATE,
     assigneeId: DEFAULT_ASSIGNEE,
     creatorId: DEFAULT_CREATOR,
+    duration: exports.DEFAULT_DURATION,
 };
 exports.INVALID_TASK = __assign(__assign({}, exports.DEFAULT_TASK), { due: exports.INVALID_DUE_DATE });
-exports.TASK_WITH_OPTIONALS_AS_NULL = __assign(__assign({}, exports.DEFAULT_TASK), { due: null, assigneeId: null, assignerId: null, parentId: null, sectionId: null });
+exports.TASK_WITH_OPTIONALS_AS_NULL = __assign(__assign({}, exports.DEFAULT_TASK), { due: null, assigneeId: null, assignerId: null, parentId: null, sectionId: null, duration: null });
 exports.DEFAULT_PROJECT = {
     id: DEFAULT_PROJECT_ID,
     name: DEFAULT_PROJECT_NAME,

package/dist/types/entities.d.ts

@@ -1,12 +1,12 @@
 import { Boolean, Number as NumberRunType, String, Array, Record, Static, Partial, Literal, Union } from 'runtypes';
 export declare const Int: import("runtypes").Constraint<NumberRunType, number, unknown>;
-export declare type TodoistEntity = {
+export type TodoistEntity = {
     id: string;
 };
-export declare type OrderedEntity = TodoistEntity & {
+export type OrderedEntity = TodoistEntity & {
     order: number;
 };
-export declare type EntityInHierarchy = OrderedEntity & {
+export type EntityInHierarchy = OrderedEntity & {
     parentId?: string | null;
 };
 export declare const DueDate: import("runtypes").Intersect<[Record<{
@@ -17,7 +17,12 @@ export declare const DueDate: import("runtypes").Intersect<[Record<{
     datetime: Union<[String, Literal<null>]>;
     timezone: Union<[String, Literal<null>]>;
 }, false>]>;
-export declare type DueDate = Static<typeof DueDate>;
+export type DueDate = Static<typeof DueDate>;
+export declare const Duration: Record<{
+    amount: import("runtypes").Constraint<NumberRunType, number, unknown>;
+    unit: Union<[Literal<"minute">, Literal<"day">]>;
+}, false>;
+export type Duration = Static<typeof Duration>;
 export declare const Task: import("runtypes").Intersect<[Record<{
     id: String;
     order: import("runtypes").Constraint<NumberRunType, number, unknown>;
@@ -31,6 +36,10 @@ export declare const Task: import("runtypes").Intersect<[Record<{
     createdAt: String;
     url: String;
     creatorId: String;
+    duration: Union<[Record<{
+        amount: import("runtypes").Constraint<NumberRunType, number, unknown>;
+        unit: Union<[Literal<"minute">, Literal<"day">]>;
+    }, false>, Literal<null>]>;
 }, false>, Partial<{
     due: Union<[import("runtypes").Intersect<[Record<{
         isRecurring: Boolean;
@@ -45,7 +54,7 @@ export declare const Task: import("runtypes").Intersect<[Record<{
     parentId: Union<[String, Literal<null>]>;
     sectionId: Union<[String, Literal<null>]>;
 }, false>]>;
-export declare type Task = Static<typeof Task>;
+export type Task = Static<typeof Task>;
 export declare const Project: import("runtypes").Intersect<[Record<{
     id: String;
     name: String;
@@ -61,14 +70,14 @@ export declare const Project: import("runtypes").Intersect<[Record<{
 }, false>, Partial<{
     parentId: Union<[String, Literal<null>]>;
 }, false>]>;
-export declare type Project = Static<typeof Project>;
+export type Project = Static<typeof Project>;
 export declare const Section: Record<{
     id: String;
     order: import("runtypes").Constraint<NumberRunType, number, unknown>;
     name: String;
     projectId: String;
 }, false>;
-export declare type Section = Static<typeof Section>;
+export type Section = Static<typeof Section>;
 export declare const Label: Record<{
     id: String;
     order: import("runtypes").Constraint<NumberRunType, number, unknown>;
@@ -76,7 +85,7 @@ export declare const Label: Record<{
     color: String;
     isFavorite: Boolean;
 }, false>;
-export declare type Label = Static<typeof Label>;
+export type Label = Static<typeof Label>;
 export declare const Attachment: import("runtypes").Intersect<[Record<{
     resourceType: String;
 }, false>, Partial<{
@@ -92,7 +101,7 @@ export declare const Attachment: import("runtypes").Intersect<[Record<{
     url: Union<[String, Literal<null>]>;
     title: Union<[String, Literal<null>]>;
 }, false>]>;
-export declare type Attachment = Static<typeof Attachment>;
+export type Attachment = Static<typeof Attachment>;
 export declare const Comment: import("runtypes").Intersect<[Record<{
     id: String;
     content: String;
@@ -116,14 +125,14 @@ export declare const Comment: import("runtypes").Intersect<[Record<{
         title: Union<[String, Literal<null>]>;
     }, false>]>, Literal<null>]>;
 }, false>]>;
-export declare type Comment = Static<typeof Comment>;
+export type Comment = Static<typeof Comment>;
 export declare const User: Record<{
     id: String;
     name: String;
     email: String;
 }, false>;
-export declare type User = Static<typeof User>;
-export declare type Color = {
+export type User = Static<typeof User>;
+export type Color = {
     /**
      * @deprecated No longer used
      */
@@ -149,7 +158,7 @@ export declare type Color = {
      */
     value: string;
 };
-export declare type QuickAddTaskResponse = {
+export type QuickAddTaskResponse = {
     id: string;
     projectId: string;
     content: string;
@@ -163,6 +172,7 @@ export declare type QuickAddTaskResponse = {
     checked: boolean;
     addedAt: string;
     addedByUid: string | null;
+    duration: Duration | null;
     due: {
         date: string;
         timezone: string | null;

package/dist/types/entities.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.User = exports.Comment = exports.Attachment = exports.Label = exports.Section = exports.Project = exports.Task = exports.DueDate = exports.Int = void 0;
+exports.User = exports.Comment = exports.Attachment = exports.Label = exports.Section = exports.Project = exports.Task = exports.Duration = exports.DueDate = exports.Int = void 0;
 var runtypes_1 = require("runtypes");
 exports.Int = runtypes_1.Number.withConstraint(function (n) { return Number.isInteger(n) || "".concat(n, " is not a valid entity id. Should be a string"); });
 exports.DueDate = (0, runtypes_1.Record)({
@@ -11,6 +11,10 @@ exports.DueDate = (0, runtypes_1.Record)({
     datetime: runtypes_1.String.Or(runtypes_1.Null),
     timezone: runtypes_1.String.Or(runtypes_1.Null),
 }));
+exports.Duration = (0, runtypes_1.Record)({
+    amount: runtypes_1.Number.withConstraint(function (n) { return n > 0 || 'Value should be greater than zero'; }),
+    unit: (0, runtypes_1.Union)((0, runtypes_1.Literal)('minute'), (0, runtypes_1.Literal)('day')),
+});
 exports.Task = (0, runtypes_1.Record)({
     id: runtypes_1.String,
     order: exports.Int,
@@ -24,6 +28,7 @@ exports.Task = (0, runtypes_1.Record)({
     createdAt: runtypes_1.String,
     url: runtypes_1.String,
     creatorId: runtypes_1.String,
+    duration: exports.Duration.Or(runtypes_1.Null),
 }).And((0, runtypes_1.Partial)({
     due: exports.DueDate.Or(runtypes_1.Null),
     assigneeId: runtypes_1.String.Or(runtypes_1.Null),

package/dist/types/http.d.ts

@@ -1 +1 @@
-export declare type HttpMethod = 'POST' | 'GET' | 'DELETE';
+export type HttpMethod = 'POST' | 'GET' | 'DELETE';

package/dist/types/requests.d.ts

@@ -1,4 +1,6 @@
-export declare type AddTaskArgs = {
+import type { RequireAllOrNone } from 'type-fest';
+import type { Duration } from './entities';
+export type AddTaskArgs = {
     content: string;
     description?: string;
     projectId?: string;
@@ -12,14 +14,17 @@ export declare type AddTaskArgs = {
     dueDate?: string;
     dueDatetime?: string;
     assigneeId?: string;
-};
-export declare type QuickAddTaskArgs = {
+} & RequireAllOrNone<{
+    duration?: Duration['amount'];
+    durationUnit?: Duration['unit'];
+}>;
+export type QuickAddTaskArgs = {
     text: string;
     note?: string;
     reminder?: string;
     autoReminder?: boolean;
 };
-export declare type GetTasksArgs = {
+export type GetTasksArgs = {
     projectId?: string;
     sectionId?: string;
     label?: string;
@@ -27,7 +32,7 @@ export declare type GetTasksArgs = {
     lang?: string;
     ids?: string[];
 };
-export declare type UpdateTaskArgs = {
+export type UpdateTaskArgs = {
     content?: string;
     description?: string;
     labels?: string[];
@@ -37,50 +42,53 @@ export declare type UpdateTaskArgs = {
     dueDate?: string | null;
     dueDatetime?: string | null;
     assigneeId?: string | null;
-};
-export declare type ProjectViewStyle = 'list' | 'board';
-export declare type AddProjectArgs = {
+} & RequireAllOrNone<{
+    duration?: Duration['amount'];
+    durationUnit?: Duration['unit'];
+}>;
+export type ProjectViewStyle = 'list' | 'board';
+export type AddProjectArgs = {
     name: string;
     parentId?: string;
     color?: string;
     isFavorite?: boolean;
     viewStyle?: ProjectViewStyle;
 };
-export declare type UpdateProjectArgs = {
+export type UpdateProjectArgs = {
     name?: string;
     color?: string;
     isFavorite?: boolean;
     viewStyle?: ProjectViewStyle;
 };
-export declare type AddSectionArgs = {
+export type AddSectionArgs = {
     name: string;
     projectId: string;
     order?: number;
 };
-export declare type UpdateSectionArgs = {
+export type UpdateSectionArgs = {
     name: string;
 };
-export declare type AddLabelArgs = {
+export type AddLabelArgs = {
     name: string;
     order?: number;
     color?: string;
     isFavorite?: boolean;
 };
-export declare type UpdateLabelArgs = {
+export type UpdateLabelArgs = {
     name?: string;
     order?: number;
     color?: string;
     isFavorite?: boolean;
 };
-export declare type GetTaskCommentsArgs = {
+export type GetTaskCommentsArgs = {
     taskId: string;
     projectId?: never;
 };
-export declare type GetProjectCommentsArgs = {
+export type GetProjectCommentsArgs = {
     projectId: string;
     taskId?: never;
 };
-declare type AddCommentArgs = {
+type AddCommentArgs = {
     content: string;
     attachment?: {
         fileName?: string;
@@ -89,22 +97,22 @@ declare type AddCommentArgs = {
         resourceType?: string;
     };
 };
-export declare type AddTaskCommentArgs = AddCommentArgs & {
+export type AddTaskCommentArgs = AddCommentArgs & {
     taskId: string;
     projectId?: never;
 };
-export declare type AddProjectCommentArgs = AddCommentArgs & {
+export type AddProjectCommentArgs = AddCommentArgs & {
     projectId: string;
     taskId?: never;
 };
-export declare type UpdateCommentArgs = {
+export type UpdateCommentArgs = {
     content: string;
 };
-export declare type RenameSharedLabelArgs = {
+export type RenameSharedLabelArgs = {
     name: string;
     newName: string;
 };
-export declare type RemoveSharedLabelArgs = {
+export type RemoveSharedLabelArgs = {
     name: string;
 };
 export {};

package/dist/utils/sanitization.d.ts

@@ -1,5 +1,5 @@
 import { Task } from '../types';
-export declare type TaskWithSanitizedContent = Task & {
+export type TaskWithSanitizedContent = Task & {
     sanitizedContent: string;
 };
 export declare function getSanitizedContent(input: string): string;

package/dist/utils/taskConverters.js

@@ -20,9 +20,9 @@ function getTaskFromQuickAddResponse(responseData) {
     var _a;
     var due = responseData.due
         ? __assign(__assign({ isRecurring: responseData.due.isRecurring, string: responseData.due.string, date: responseData.due.date }, (responseData.due.timezone !== null && { datetime: responseData.due.date })), (responseData.due.timezone !== null && { timezone: responseData.due.timezone })) : undefined;
-    var task = __assign(__assign(__assign({ id: responseData.id, order: responseData.childOrder, content: responseData.content, description: responseData.description, projectId: responseData.projectId, sectionId: responseData.sectionId ? responseData.sectionId : undefined, isCompleted: responseData.checked, labels: responseData.labels, priority: responseData.priority, commentCount: 0, createdAt: responseData.addedAt, url: getTaskUrlFromQuickAddResponse(responseData), creatorId: (_a = responseData.addedByUid) !== null && _a !== void 0 ? _a : '' }, (due !== undefined && { due: due })), (responseData.parentId !== null && { parentId: responseData.parentId })), (responseData.responsibleUid !== null && {
+    var task = __assign(__assign(__assign(__assign({ id: responseData.id, order: responseData.childOrder, content: responseData.content, description: responseData.description, projectId: responseData.projectId, sectionId: responseData.sectionId ? responseData.sectionId : undefined, isCompleted: responseData.checked, labels: responseData.labels, priority: responseData.priority, commentCount: 0, createdAt: responseData.addedAt, url: getTaskUrlFromQuickAddResponse(responseData), creatorId: (_a = responseData.addedByUid) !== null && _a !== void 0 ? _a : '' }, (due !== undefined && { due: due })), (responseData.parentId !== null && { parentId: responseData.parentId })), (responseData.responsibleUid !== null && {
         assigneeId: responseData.responsibleUid,
-    }));
+    })), { duration: responseData.duration });
     return task;
 }
 exports.getTaskFromQuickAddResponse = getTaskFromQuickAddResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",
@@ -32,27 +32,28 @@
         "uuid": "^9.0.0"
     },
     "devDependencies": {
-        "@doist/eslint-config": "8.0.1",
+        "@doist/eslint-config": "8.1.3",
         "@doist/prettier-config": "3.0.5",
         "@types/axios": "0.14.0",
-        "@types/jest": "27.5.2",
+        "@types/jest": "29.4.0",
         "@types/uuid": "8.3.4",
-        "@typescript-eslint/eslint-plugin": "5.42.0",
-        "@typescript-eslint/parser": "5.42.0",
-        "eslint": "8.26.0",
-        "eslint-config-prettier": "8.5.0",
+        "@typescript-eslint/eslint-plugin": "5.54.1",
+        "@typescript-eslint/parser": "5.54.1",
+        "eslint": "8.35.0",
+        "eslint-config-prettier": "8.7.0",
         "eslint-import-resolver-webpack": "0.13.2",
-        "eslint-plugin-import": "2.26.0",
+        "eslint-plugin-import": "2.27.5",
         "eslint-plugin-prettier": "4.2.1",
-        "husky": "8.0.1",
-        "jest": "28.1.3",
-        "lint-staged": "13.0.3",
+        "husky": "8.0.3",
+        "jest": "29.5.0",
+        "lint-staged": "13.1.4",
         "npm-run-all": "4.1.5",
-        "prettier": "2.7.1",
+        "prettier": "2.8.4",
         "rimraf": "3.0.2",
-        "ts-jest": "28.0.8",
+        "ts-jest": "29.0.5",
         "ts-node": "10.9.1",
-        "typescript": "4.8.4"
+        "type-fest": "^4.5.0",
+        "typescript": "4.9.5"
     },
     "prettier": "@doist/prettier-config",
     "husky": {