@doist/todoist-api-typescript 2.2.0 → 3.0.1

package/dist/TodoistApi.d.ts

@@ -1,5 +1,5 @@
 import { Task, Project, Label, User, Section, Comment } from './types/entities';
-import { AddLabelArgs, AddProjectArgs, AddSectionArgs, AddProjectCommentArgs, AddTaskArgs, AddTaskCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/requests';
+import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/requests';
 export declare class TodoistApi {
     authToken: string;
     constructor(authToken: string, baseUrl?: string);
@@ -44,12 +44,12 @@ export declare class TodoistApi {
      * Deletes a personal label
      */
     deleteLabel(id: string, requestId?: string): Promise<boolean>;
-    getSharedLabels(): Promise<string[]>;
+    getSharedLabels(args?: GetSharedLabelsArgs): Promise<string[]>;
     renameSharedLabel(args: RenameSharedLabelArgs): Promise<void>;
     removeSharedLabel(args: RemoveSharedLabelArgs): Promise<void>;
     getComments(args: GetTaskCommentsArgs | GetProjectCommentsArgs): Promise<Comment[]>;
     getComment(id: string): Promise<Comment>;
-    addComment(args: AddTaskCommentArgs | AddProjectCommentArgs, requestId?: string): Promise<Comment>;
+    addComment(args: AddCommentArgs, requestId?: string): Promise<Comment>;
     updateComment(id: string, args: UpdateCommentArgs, requestId?: string): Promise<Comment>;
     deleteComment(id: string, requestId?: string): Promise<boolean>;
 }

package/dist/TodoistApi.js

@@ -418,12 +418,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
-    TodoistApi.prototype.getSharedLabels = function () {
+    TodoistApi.prototype.getSharedLabels = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.restApiBase, endpoints_1.ENDPOINT_REST_LABELS_SHARED, this.authToken)];
+                    case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.restApiBase, endpoints_1.ENDPOINT_REST_LABELS_SHARED, this.authToken, args)];
                     case 1:
                         response = _a.sent();
                         return [2 /*return*/, response.data];

package/dist/authentication.d.ts

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

package/dist/testUtils/testDefaults.d.ts

@@ -33,10 +33,10 @@ export declare const INVALID_TASK: {
     createdAt: string;
     url: string;
     creatorId: string;
-    duration: {
+    duration?: {
         amount: number;
         unit: "minute" | "day";
-    } | null;
+    } | null | undefined;
     assigneeId?: string | null | undefined;
     assignerId?: string | null | undefined;
     parentId?: string | null | undefined;

package/dist/types/entities.d.ts

@@ -16,6 +16,7 @@ export declare const DueDate: import("runtypes").Intersect<[Record<{
 }, false>, Partial<{
     datetime: Union<[String, Literal<null>]>;
     timezone: Union<[String, Literal<null>]>;
+    lang: Union<[String, Literal<null>]>;
 }, false>]>;
 export type DueDate = Static<typeof DueDate>;
 export declare const Duration: Record<{
@@ -36,10 +37,6 @@ 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;
@@ -48,7 +45,12 @@ export declare const Task: import("runtypes").Intersect<[Record<{
     }, false>, Partial<{
         datetime: Union<[String, Literal<null>]>;
         timezone: Union<[String, Literal<null>]>;
+        lang: Union<[String, Literal<null>]>;
     }, false>]>, Literal<null>]>;
+    duration: Union<[Record<{
+        amount: import("runtypes").Constraint<NumberRunType, number, unknown>;
+        unit: Union<[Literal<"minute">, Literal<"day">]>;
+    }, false>, Literal<null>]>;
     assigneeId: Union<[String, Literal<null>]>;
     assignerId: Union<[String, Literal<null>]>;
     parentId: Union<[String, Literal<null>]>;
@@ -71,6 +73,7 @@ export declare const Project: import("runtypes").Intersect<[Record<{
     parentId: Union<[String, Literal<null>]>;
 }, false>]>;
 export type Project = Static<typeof Project>;
+export type ProjectViewStyle = 'list' | 'board';
 export declare const Section: Record<{
     id: String;
     order: import("runtypes").Constraint<NumberRunType, number, unknown>;

package/dist/types/entities.js

@@ -10,6 +10,7 @@ exports.DueDate = (0, runtypes_1.Record)({
 }).And((0, runtypes_1.Partial)({
     datetime: runtypes_1.String.Or(runtypes_1.Null),
     timezone: runtypes_1.String.Or(runtypes_1.Null),
+    lang: 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'; }),
@@ -28,9 +29,9 @@ 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),
+    duration: exports.Duration.Or(runtypes_1.Null),
     assigneeId: runtypes_1.String.Or(runtypes_1.Null),
     assignerId: runtypes_1.String.Or(runtypes_1.Null),
     parentId: runtypes_1.String.Or(runtypes_1.Null),

package/dist/types/requests.d.ts

@@ -1,5 +1,5 @@
-import type { RequireAllOrNone } from 'type-fest';
-import type { Duration } from './entities';
+import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
+import type { Duration, ProjectViewStyle } from './entities';
 export type AddTaskArgs = {
     content: string;
     description?: string;
@@ -9,12 +9,13 @@ export type AddTaskArgs = {
     order?: number;
     labels?: string[];
     priority?: number;
-    dueString?: string;
     dueLang?: string;
+    assigneeId?: string;
+    dueString?: string;
+} & RequireOneOrNone<{
     dueDate?: string;
     dueDatetime?: string;
-    assigneeId?: string;
-} & RequireAllOrNone<{
+}> & RequireAllOrNone<{
     duration?: Duration['amount'];
     durationUnit?: Duration['unit'];
 }>;
@@ -37,16 +38,16 @@ export type UpdateTaskArgs = {
     description?: string;
     labels?: string[];
     priority?: number;
-    dueString?: string | null;
     dueLang?: string | null;
-    dueDate?: string | null;
-    dueDatetime?: string | null;
     assigneeId?: string | null;
-} & RequireAllOrNone<{
+    dueString?: string;
+} & RequireOneOrNone<{
+    dueDate?: string;
+    dueDatetime?: string;
+}> & RequireAllOrNone<{
     duration?: Duration['amount'];
     durationUnit?: Duration['unit'];
 }>;
-export type ProjectViewStyle = 'list' | 'board';
 export type AddProjectArgs = {
     name: string;
     parentId?: string;
@@ -88,7 +89,7 @@ export type GetProjectCommentsArgs = {
     projectId: string;
     taskId?: never;
 };
-type AddCommentArgs = {
+export type AddCommentArgs = {
     content: string;
     attachment?: {
         fileName?: string;
@@ -96,18 +97,16 @@ type AddCommentArgs = {
         fileType?: string;
         resourceType?: string;
     };
-};
-export type AddTaskCommentArgs = AddCommentArgs & {
-    taskId: string;
-    projectId?: never;
-};
-export type AddProjectCommentArgs = AddCommentArgs & {
-    projectId: string;
-    taskId?: never;
-};
+} & RequireExactlyOne<{
+    taskId?: string;
+    projectId?: string;
+}>;
 export type UpdateCommentArgs = {
     content: string;
 };
+export type GetSharedLabelsArgs = {
+    omitPersonal?: boolean;
+};
 export type RenameSharedLabelArgs = {
     name: string;
     newName: string;
@@ -115,4 +114,3 @@ export type RenameSharedLabelArgs = {
 export type RemoveSharedLabelArgs = {
     name: string;
 };
-export {};

package/package.json

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