@doist/todoist-api-typescript 6.1.12 → 6.2.0

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

@@ -79,6 +79,7 @@ exports.DEFAULT_TASK = {
     noteCount: DEFAULT_NOTE_COUNT,
     dayOrder: exports.DEFAULT_ORDER,
     isCollapsed: DEFAULT_IS_COLLAPSED,
+    isUncompletable: false,
     url: DEFAULT_TASK_URL,
 };
 exports.INVALID_TASK = Object.assign(Object.assign({}, exports.DEFAULT_TASK), { due: '2020-01-31' });
@@ -106,6 +107,7 @@ exports.TASK_WITH_OPTIONALS_AS_NULL = {
     description: exports.DEFAULT_TASK_DESCRIPTION,
     dayOrder: exports.DEFAULT_ORDER,
     isCollapsed: DEFAULT_IS_COLLAPSED,
+    isUncompletable: false,
     noteCount: DEFAULT_NOTE_COUNT,
     url: DEFAULT_TASK_URL,
 };

package/dist/cjs/todoist-api.js

@@ -7,6 +7,7 @@ const validators_1 = require("./utils/validators");
 const url_helpers_1 = require("./utils/url-helpers");
 const multipart_upload_1 = require("./utils/multipart-upload");
 const activity_helpers_1 = require("./utils/activity-helpers");
+const uncompletable_helpers_1 = require("./utils/uncompletable-helpers");
 const zod_1 = require("zod");
 const uuid_1 = require("uuid");
 const types_1 = require("./types");
@@ -185,13 +186,15 @@ class TodoistApi {
      * @returns A promise that resolves to the created task.
      */
     async addTask(args, requestId) {
+        // Process content based on isUncompletable flag
+        const processedArgs = Object.assign(Object.assign({}, args), { content: (0, uncompletable_helpers_1.processTaskContent)(args.content, args.isUncompletable) });
         const response = await (0, rest_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: endpoints_1.ENDPOINT_REST_TASKS,
             apiToken: this.authToken,
             customFetch: this.customFetch,
-            payload: args,
+            payload: processedArgs,
             requestId: requestId,
         });
         return (0, validators_1.validateTask)(response.data);
@@ -203,13 +206,15 @@ class TodoistApi {
      * @returns A promise that resolves to the created task.
      */
     async quickAddTask(args) {
+        // Process text based on isUncompletable flag
+        const processedArgs = Object.assign(Object.assign({}, args), { text: (0, uncompletable_helpers_1.processTaskContent)(args.text, args.isUncompletable) });
         const response = await (0, rest_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: endpoints_1.ENDPOINT_SYNC_QUICK_ADD,
             apiToken: this.authToken,
             customFetch: this.customFetch,
-            payload: args,
+            payload: processedArgs,
         });
         return (0, validators_1.validateTask)(response.data);
     }
@@ -223,13 +228,16 @@ class TodoistApi {
      */
     async updateTask(id, args, requestId) {
         zod_1.z.string().parse(id);
+        // Process content if both content and isUncompletable are provided
+        const processedArgs = args.content && args.isUncompletable !== undefined
+            ? Object.assign(Object.assign({}, args), { content: (0, uncompletable_helpers_1.processTaskContent)(args.content, args.isUncompletable) }) : args;
         const response = await (0, rest_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: generatePath(endpoints_1.ENDPOINT_REST_TASKS, id),
             apiToken: this.authToken,
             customFetch: this.customFetch,
-            payload: args,
+            payload: processedArgs,
             requestId: requestId,
         });
         return (0, validators_1.validateTask)(response.data);

package/dist/cjs/types/entities.js

@@ -14,6 +14,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JoinWorkspaceResultSchema = exports.WorkspacePlanDetailsSchema = exports.FormattedPriceListingSchema = exports.PlanPriceSchema = exports.WorkspaceInvitationSchema = exports.WorkspaceUserSchema = exports.WorkspaceRoleSchema = exports.WORKSPACE_ROLES = exports.ActivityEventSchema = exports.ActivityEventExtraDataSchema = exports.ColorSchema = exports.ProductivityStatsSchema = exports.CurrentUserSchema = exports.TimezoneInfoSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.WorkspaceProjectSchema = exports.PersonalProjectSchema = exports.BaseProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
 const zod_1 = require("zod");
 const url_helpers_1 = require("../utils/url-helpers");
+const uncompletable_helpers_1 = require("../utils/uncompletable-helpers");
 exports.DueDateSchema = zod_1.z
     .object({
     isRecurring: zod_1.z.boolean(),
@@ -59,9 +60,12 @@ exports.TaskSchema = zod_1.z
     noteCount: zod_1.z.number().int(),
     dayOrder: zod_1.z.number().int(),
     isCollapsed: zod_1.z.boolean(),
+    isUncompletable: zod_1.z.boolean().default(false),
 })
     .transform((data) => {
-    return Object.assign(Object.assign({}, data), { url: (0, url_helpers_1.getTaskUrl)(data.id, data.content) });
+    // Auto-detect uncompletable status from content prefix
+    const isUncompletable = (0, uncompletable_helpers_1.hasUncompletablePrefix)(data.content);
+    return Object.assign(Object.assign({}, data), { isUncompletable, url: (0, url_helpers_1.getTaskUrl)(data.id, data.content) });
 });
 /**
  * Base schema for all project types in Todoist.

package/dist/cjs/utils/uncompletable-helpers.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addUncompletablePrefix = addUncompletablePrefix;
+exports.removeUncompletablePrefix = removeUncompletablePrefix;
+exports.hasUncompletablePrefix = hasUncompletablePrefix;
+exports.processTaskContent = processTaskContent;
+const UNCOMPLETABLE_PREFIX = '* ';
+/**
+ * Adds the uncompletable prefix (* ) to task content if not already present
+ * @param content - The task content
+ * @returns Content with uncompletable prefix added
+ */
+function addUncompletablePrefix(content) {
+    if (content.startsWith(UNCOMPLETABLE_PREFIX)) {
+        return content;
+    }
+    return UNCOMPLETABLE_PREFIX + content;
+}
+/**
+ * Removes the uncompletable prefix (* ) from task content if present
+ * @param content - The task content
+ * @returns Content with uncompletable prefix removed
+ */
+function removeUncompletablePrefix(content) {
+    if (content.startsWith(UNCOMPLETABLE_PREFIX)) {
+        return content.slice(UNCOMPLETABLE_PREFIX.length);
+    }
+    return content;
+}
+/**
+ * Checks if task content has the uncompletable prefix (* )
+ * @param content - The task content
+ * @returns True if content starts with uncompletable prefix
+ */
+function hasUncompletablePrefix(content) {
+    return content.startsWith(UNCOMPLETABLE_PREFIX);
+}
+/**
+ * Processes task content based on isUncompletable flag, with content prefix taking precedence
+ * @param content - The original task content
+ * @param isUncompletable - Optional flag to make task uncompletable
+ * @returns Processed content
+ *
+ * Logic:
+ * - If content already has * prefix, task is uncompletable regardless of flag
+ * - If content doesn't have * prefix and isUncompletable is true, add the prefix
+ * - If isUncompletable is undefined or false (and no prefix), leave content unchanged
+ */
+function processTaskContent(content, isUncompletable) {
+    // Content prefix takes precedence - if already has prefix, keep it
+    if (hasUncompletablePrefix(content)) {
+        return content;
+    }
+    // If content doesn't have prefix and user wants uncompletable, add it
+    if (isUncompletable === true) {
+        return addUncompletablePrefix(content);
+    }
+    // Otherwise, leave content unchanged
+    return content;
+}

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

@@ -76,6 +76,7 @@ export const DEFAULT_TASK = {
     noteCount: DEFAULT_NOTE_COUNT,
     dayOrder: DEFAULT_ORDER,
     isCollapsed: DEFAULT_IS_COLLAPSED,
+    isUncompletable: false,
     url: DEFAULT_TASK_URL,
 };
 export const INVALID_TASK = Object.assign(Object.assign({}, DEFAULT_TASK), { due: '2020-01-31' });
@@ -103,6 +104,7 @@ export const TASK_WITH_OPTIONALS_AS_NULL = {
     description: DEFAULT_TASK_DESCRIPTION,
     dayOrder: DEFAULT_ORDER,
     isCollapsed: DEFAULT_IS_COLLAPSED,
+    isUncompletable: false,
     noteCount: DEFAULT_NOTE_COUNT,
     url: DEFAULT_TASK_URL,
 };

package/dist/esm/todoist-api.js

@@ -4,6 +4,7 @@ import { validateAttachment, validateComment, validateCommentArray, validateCurr
 import { formatDateToYYYYMMDD } from './utils/url-helpers.js';
 import { uploadMultipartFile } from './utils/multipart-upload.js';
 import { normalizeObjectTypeForApi, denormalizeObjectTypeFromApi } from './utils/activity-helpers.js';
+import { processTaskContent } from './utils/uncompletable-helpers.js';
 import { z } from 'zod';
 import { v4 as uuidv4 } from 'uuid';
 import { TodoistRequestError } from './types/index.js';
@@ -182,13 +183,15 @@ export class TodoistApi {
      * @returns A promise that resolves to the created task.
      */
     async addTask(args, requestId) {
+        // Process content based on isUncompletable flag
+        const processedArgs = Object.assign(Object.assign({}, args), { content: processTaskContent(args.content, args.isUncompletable) });
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: ENDPOINT_REST_TASKS,
             apiToken: this.authToken,
             customFetch: this.customFetch,
-            payload: args,
+            payload: processedArgs,
             requestId: requestId,
         });
         return validateTask(response.data);
@@ -200,13 +203,15 @@ export class TodoistApi {
      * @returns A promise that resolves to the created task.
      */
     async quickAddTask(args) {
+        // Process text based on isUncompletable flag
+        const processedArgs = Object.assign(Object.assign({}, args), { text: processTaskContent(args.text, args.isUncompletable) });
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: ENDPOINT_SYNC_QUICK_ADD,
             apiToken: this.authToken,
             customFetch: this.customFetch,
-            payload: args,
+            payload: processedArgs,
         });
         return validateTask(response.data);
     }
@@ -220,13 +225,16 @@ export class TodoistApi {
      */
     async updateTask(id, args, requestId) {
         z.string().parse(id);
+        // Process content if both content and isUncompletable are provided
+        const processedArgs = args.content && args.isUncompletable !== undefined
+            ? Object.assign(Object.assign({}, args), { content: processTaskContent(args.content, args.isUncompletable) }) : args;
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: generatePath(ENDPOINT_REST_TASKS, id),
             apiToken: this.authToken,
             customFetch: this.customFetch,
-            payload: args,
+            payload: processedArgs,
             requestId: requestId,
         });
         return validateTask(response.data);

package/dist/esm/types/entities.js

@@ -11,6 +11,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 import { z } from 'zod';
 import { getProjectUrl, getTaskUrl, getSectionUrl } from '../utils/url-helpers.js';
+import { hasUncompletablePrefix } from '../utils/uncompletable-helpers.js';
 export const DueDateSchema = z
     .object({
     isRecurring: z.boolean(),
@@ -56,9 +57,12 @@ export const TaskSchema = z
     noteCount: z.number().int(),
     dayOrder: z.number().int(),
     isCollapsed: z.boolean(),
+    isUncompletable: z.boolean().default(false),
 })
     .transform((data) => {
-    return Object.assign(Object.assign({}, data), { url: getTaskUrl(data.id, data.content) });
+    // Auto-detect uncompletable status from content prefix
+    const isUncompletable = hasUncompletablePrefix(data.content);
+    return Object.assign(Object.assign({}, data), { isUncompletable, url: getTaskUrl(data.id, data.content) });
 });
 /**
  * Base schema for all project types in Todoist.

package/dist/esm/utils/uncompletable-helpers.js

@@ -0,0 +1,54 @@
+const UNCOMPLETABLE_PREFIX = '* ';
+/**
+ * Adds the uncompletable prefix (* ) to task content if not already present
+ * @param content - The task content
+ * @returns Content with uncompletable prefix added
+ */
+export function addUncompletablePrefix(content) {
+    if (content.startsWith(UNCOMPLETABLE_PREFIX)) {
+        return content;
+    }
+    return UNCOMPLETABLE_PREFIX + content;
+}
+/**
+ * Removes the uncompletable prefix (* ) from task content if present
+ * @param content - The task content
+ * @returns Content with uncompletable prefix removed
+ */
+export function removeUncompletablePrefix(content) {
+    if (content.startsWith(UNCOMPLETABLE_PREFIX)) {
+        return content.slice(UNCOMPLETABLE_PREFIX.length);
+    }
+    return content;
+}
+/**
+ * Checks if task content has the uncompletable prefix (* )
+ * @param content - The task content
+ * @returns True if content starts with uncompletable prefix
+ */
+export function hasUncompletablePrefix(content) {
+    return content.startsWith(UNCOMPLETABLE_PREFIX);
+}
+/**
+ * Processes task content based on isUncompletable flag, with content prefix taking precedence
+ * @param content - The original task content
+ * @param isUncompletable - Optional flag to make task uncompletable
+ * @returns Processed content
+ *
+ * Logic:
+ * - If content already has * prefix, task is uncompletable regardless of flag
+ * - If content doesn't have * prefix and isUncompletable is true, add the prefix
+ * - If isUncompletable is undefined or false (and no prefix), leave content unchanged
+ */
+export function processTaskContent(content, isUncompletable) {
+    // Content prefix takes precedence - if already has prefix, keep it
+    if (hasUncompletablePrefix(content)) {
+        return content;
+    }
+    // If content doesn't have prefix and user wants uncompletable, add it
+    if (isUncompletable === true) {
+        return addUncompletablePrefix(content);
+    }
+    // Otherwise, leave content unchanged
+    return content;
+}

package/dist/types/test-utils/test-defaults.d.ts

@@ -22,6 +22,7 @@ export declare const DEFAULT_DEADLINE: Deadline;
 export declare const DEFAULT_TASK: Task;
 export declare const INVALID_TASK: {
     due: string;
+    isUncompletable: boolean;
     url: string;
     id: string;
     userId: string;

package/dist/types/types/entities.d.ts

@@ -73,7 +73,9 @@ export declare const TaskSchema: z.ZodPipe<z.ZodObject<{
     noteCount: z.ZodNumber;
     dayOrder: z.ZodNumber;
     isCollapsed: z.ZodBoolean;
+    isUncompletable: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>, z.ZodTransform<{
+    isUncompletable: boolean;
     url: string;
     id: string;
     userId: string;
@@ -150,6 +152,7 @@ export declare const TaskSchema: z.ZodPipe<z.ZodObject<{
     noteCount: number;
     dayOrder: number;
     isCollapsed: boolean;
+    isUncompletable: boolean;
 }>>;
 /**
  * Represents a task in Todoist.

package/dist/types/types/requests.d.ts

@@ -18,6 +18,7 @@ export type AddTaskArgs = {
     dueLang?: string;
     deadlineLang?: string;
     deadlineDate?: string;
+    isUncompletable?: boolean;
 } & RequireOneOrNone<{
     dueDate?: string;
     dueDatetime?: string;
@@ -118,6 +119,7 @@ export type UpdateTaskArgs = {
     assigneeId?: string | null;
     deadlineDate?: string | null;
     deadlineLang?: string | null;
+    isUncompletable?: boolean;
 } & RequireOneOrNone<{
     dueDate?: string;
     dueDatetime?: string;
@@ -135,6 +137,7 @@ export type QuickAddTaskArgs = {
     reminder?: string;
     autoReminder?: boolean;
     meta?: boolean;
+    isUncompletable?: boolean;
 };
 /**
  * Response from quick adding a task.

package/dist/types/utils/uncompletable-helpers.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Adds the uncompletable prefix (* ) to task content if not already present
+ * @param content - The task content
+ * @returns Content with uncompletable prefix added
+ */
+export declare function addUncompletablePrefix(content: string): string;
+/**
+ * Removes the uncompletable prefix (* ) from task content if present
+ * @param content - The task content
+ * @returns Content with uncompletable prefix removed
+ */
+export declare function removeUncompletablePrefix(content: string): string;
+/**
+ * Checks if task content has the uncompletable prefix (* )
+ * @param content - The task content
+ * @returns True if content starts with uncompletable prefix
+ */
+export declare function hasUncompletablePrefix(content: string): boolean;
+/**
+ * Processes task content based on isUncompletable flag, with content prefix taking precedence
+ * @param content - The original task content
+ * @param isUncompletable - Optional flag to make task uncompletable
+ * @returns Processed content
+ *
+ * Logic:
+ * - If content already has * prefix, task is uncompletable regardless of flag
+ * - If content doesn't have * prefix and isUncompletable is true, add the prefix
+ * - If isUncompletable is undefined or false (and no prefix), leave content unchanged
+ */
+export declare function processTaskContent(content: string, isUncompletable?: boolean): string;

package/package.json

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