@doist/todoist-api-typescript 6.5.0 → 6.6.0

package/dist/cjs/types/sync/resources/user.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncUserSchema = void 0;
+const zod_1 = require("zod");
+const FeaturesSchema = zod_1.z
+    .object({
+    karmaDisabled: zod_1.z.boolean(),
+    restriction: zod_1.z.number().int(),
+    karmaVacation: zod_1.z.boolean(),
+    dateistLang: zod_1.z.any(),
+    beta: zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1)]),
+    hasPushReminders: zod_1.z.boolean(),
+    dateistInlineDisabled: zod_1.z.boolean(),
+    autoInviteDisabled: zod_1.z.boolean().optional(),
+    goldTheme: zod_1.z.boolean().optional(),
+    migratedFromTdb: zod_1.z.boolean().optional(),
+})
+    .passthrough();
+const TzInfoSchema = zod_1.z
+    .object({
+    timezone: zod_1.z.string(),
+    hours: zod_1.z.number().int(),
+    minutes: zod_1.z.number().int(),
+    isDst: zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1)]),
+    gmtString: zod_1.z.string(),
+})
+    .passthrough();
+const JoinableWorkspaceSchema = zod_1.z
+    .object({
+    workspaceId: zod_1.z.string(),
+    workspaceName: zod_1.z.string(),
+    memberCount: zod_1.z.number().int(),
+})
+    .passthrough();
+const GettingStartedGuideProjectSchema = zod_1.z
+    .object({
+    onboardingUseCase: zod_1.z.string(),
+    projectId: zod_1.z.string(),
+    completed: zod_1.z.boolean(),
+    closed: zod_1.z.boolean(),
+})
+    .passthrough();
+/**
+ * Sync API user resource.
+ *
+ * This is a superset of the REST `CurrentUserSchema` — the Sync API returns
+ * many additional fields for features, onboarding state, and account details.
+ */
+exports.SyncUserSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    email: zod_1.z.string(),
+    fullName: zod_1.z.string(),
+    activatedUser: zod_1.z.boolean(),
+    autoReminder: zod_1.z.number().int(),
+    avatarBig: zod_1.z.string().optional(),
+    avatarMedium: zod_1.z.string().optional(),
+    avatarS640: zod_1.z.string().optional(),
+    avatarSmall: zod_1.z.string().optional(),
+    businessAccountId: zod_1.z.string().nullable(),
+    dailyGoal: zod_1.z.number().int(),
+    dateFormat: zod_1.z.number().int(),
+    dateistLang: zod_1.z.string().nullable(),
+    daysOff: zod_1.z.array(zod_1.z.number().int()),
+    featureIdentifier: zod_1.z.string(),
+    features: FeaturesSchema,
+    freeTrailExpires: zod_1.z.string().optional(),
+    hasMagicNumber: zod_1.z.boolean(),
+    hasPassword: zod_1.z.boolean(),
+    hasStartedATrial: zod_1.z.boolean().optional(),
+    imageId: zod_1.z.string().nullable(),
+    inboxProjectId: zod_1.z.string(),
+    isCelebrationsEnabled: zod_1.z.boolean(),
+    isPremium: zod_1.z.boolean(),
+    joinableWorkspace: JoinableWorkspaceSchema.nullable(),
+    joinedAt: zod_1.z.string(),
+    gettingStartedGuideProjects: zod_1.z.array(GettingStartedGuideProjectSchema).nullable(),
+    karma: zod_1.z.number(),
+    karmaTrend: zod_1.z.string(),
+    lang: zod_1.z.string(),
+    mfaEnabled: zod_1.z.boolean().optional(),
+    mobileHost: zod_1.z.string().nullable(),
+    mobileNumber: zod_1.z.string().nullable(),
+    nextWeek: zod_1.z.number().int(),
+    onboardingLevel: zod_1.z.string().nullable().optional(),
+    onboardingRole: zod_1.z.string().nullable().optional(),
+    onboardingPersona: zod_1.z.string().nullable().optional(),
+    onboardingInitiated: zod_1.z.boolean().nullable().optional(),
+    onboardingCompleted: zod_1.z.boolean().nullable().optional(),
+    onboardingSkipped: zod_1.z.boolean().optional(),
+    onboardingTeamMode: zod_1.z.boolean().nullable().optional(),
+    onboardingUseCases: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    premiumStatus: zod_1.z.enum([
+        'not_premium',
+        'current_personal_plan',
+        'legacy_personal_plan',
+        'teams_business_member',
+    ]),
+    premiumUntil: zod_1.z.string().nullable(),
+    rambleSessionsUsage: zod_1.z
+        .object({
+        currentCount: zod_1.z.number().int(),
+        limit: zod_1.z.number().int(),
+        remaining: zod_1.z.number().int(),
+        resetDate: zod_1.z.string(),
+    })
+        .nullable()
+        .optional(),
+    shareLimit: zod_1.z.number().int(),
+    sortOrder: zod_1.z.number().int(),
+    startDay: zod_1.z.number().int(),
+    startPage: zod_1.z.string(),
+    themeId: zod_1.z.string(),
+    timeFormat: zod_1.z.number().int(),
+    token: zod_1.z.string(),
+    tzInfo: TzInfoSchema,
+    uniquePrefix: zod_1.z.number().int(),
+    verificationStatus: zod_1.z.string(),
+    websocketUrl: zod_1.z.string(),
+    weekendStartDay: zod_1.z.number().int(),
+    weeklyGoal: zod_1.z.number().int(),
+})
+    .passthrough();

package/dist/cjs/types/sync/resources/view-options.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectViewOptionsDefaultsSchema = exports.ViewOptionsSchema = void 0;
+const zod_1 = require("zod");
+const ViewTypeSchema = zod_1.z.enum([
+    'TODAY',
+    'UPCOMING',
+    'PROJECT',
+    'LABEL',
+    'FILTER',
+    'WORKSPACE_FILTER',
+    'SEARCH',
+    'TEMPLATE_PREVIEW',
+    'TASK_DETAIL',
+    'AUTOMATION',
+    'ASSIGNED',
+    'OVERDUE',
+    'WORKSPACE_OVERVIEW',
+]);
+const ViewModeSchema = zod_1.z.enum(['LIST', 'BOARD', 'CALENDAR']);
+const GroupedBySchema = zod_1.z
+    .enum([
+    'ASSIGNEE',
+    'ADDED_DATE',
+    'DUE_DATE',
+    'DEADLINE',
+    'LABEL',
+    'PRIORITY',
+    'PROJECT',
+    'WORKSPACE',
+])
+    .nullable();
+const SortedBySchema = zod_1.z
+    .enum([
+    'MANUAL',
+    'ALPHABETICALLY',
+    'ASSIGNEE',
+    'DUE_DATE',
+    'DEADLINE',
+    'ADDED_DATE',
+    'PRIORITY',
+    'PROJECT',
+    'WORKSPACE',
+])
+    .nullable();
+const SortOrderSchema = zod_1.z.enum(['ASC', 'DESC']).nullable();
+const CalendarSettingsSchema = zod_1.z
+    .object({
+    layout: zod_1.z.enum(['WEEK', 'MONTH']).optional(),
+})
+    .passthrough();
+exports.ViewOptionsSchema = zod_1.z
+    .object({
+    viewType: ViewTypeSchema,
+    objectId: zod_1.z.string().optional(),
+    groupedBy: GroupedBySchema.optional(),
+    filteredBy: zod_1.z.string().nullable().optional(),
+    viewMode: ViewModeSchema.optional(),
+    showCompletedTasks: zod_1.z.boolean().optional(),
+    sortedBy: SortedBySchema.optional(),
+    sortOrder: SortOrderSchema.optional(),
+})
+    .passthrough();
+exports.ProjectViewOptionsDefaultsSchema = zod_1.z
+    .object({
+    projectId: zod_1.z.string(),
+    viewMode: ViewModeSchema.nullable().optional(),
+    groupedBy: GroupedBySchema.optional(),
+    sortedBy: SortedBySchema.optional(),
+    sortOrder: SortOrderSchema.optional(),
+    showCompletedTasks: zod_1.z.boolean().optional(),
+    filteredBy: zod_1.z.string().nullable().optional(),
+    calendarSettings: CalendarSettingsSchema.nullable().optional(),
+})
+    .passthrough();

package/dist/cjs/types/sync/resources/workspace-filters.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceFilterSchema = void 0;
+const zod_1 = require("zod");
+exports.WorkspaceFilterSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    workspaceId: zod_1.z.string(),
+    name: zod_1.z.string(),
+    query: zod_1.z.string(),
+    color: zod_1.z.string(),
+    itemOrder: zod_1.z.number().int(),
+    isDeleted: zod_1.z.boolean(),
+    isFavorite: zod_1.z.boolean(),
+    isFrozen: zod_1.z.boolean(),
+    creatorUid: zod_1.z.string(),
+    updaterUid: zod_1.z.string(),
+    createdAt: zod_1.z.string(),
+    updatedAt: zod_1.z.string(),
+})
+    .passthrough();

package/dist/cjs/types/sync/resources/workspace-goals.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceGoalSchema = exports.WorkspaceGoalProgressSchema = exports.WorkspaceGoalMilestoneSchema = void 0;
+const zod_1 = require("zod");
+exports.WorkspaceGoalMilestoneSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    title: zod_1.z.string(),
+    isCompleted: zod_1.z.boolean(),
+})
+    .passthrough();
+exports.WorkspaceGoalProgressSchema = zod_1.z
+    .object({
+    completedItems: zod_1.z.number().int(),
+    totalItems: zod_1.z.number().int(),
+})
+    .passthrough();
+exports.WorkspaceGoalSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    workspaceId: zod_1.z.string(),
+    title: zod_1.z.string(),
+    description: zod_1.z.string().nullable(),
+    deadline: zod_1.z.string().nullable(),
+    isDeleted: zod_1.z.boolean(),
+    projectIds: zod_1.z.array(zod_1.z.string()),
+    progress: exports.WorkspaceGoalProgressSchema.nullable(),
+    creatorUid: zod_1.z.string(),
+    createdAt: zod_1.z.string(),
+    updatedAt: zod_1.z.string(),
+})
+    .passthrough();

package/dist/cjs/types/sync/resources/workspaces.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncWorkspaceSchema = void 0;
+const zod_1 = require("zod");
+const entities_1 = require("../../entities");
+/**
+ * Sync API workspace resource.
+ *
+ * This is a superset of the REST `WorkspaceSchema` — the Sync API returns
+ * additional fields like description, isDeleted, isCollapsed, member counts,
+ * domain settings, and sorting preferences.
+ */
+exports.SyncWorkspaceSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    description: zod_1.z.string(),
+    logoBig: zod_1.z.string().optional(),
+    logoMedium: zod_1.z.string().optional(),
+    logoSmall: zod_1.z.string().optional(),
+    logoS640: zod_1.z.string().optional(),
+    creatorId: zod_1.z.string(),
+    createdAt: zod_1.z.string(),
+    isDeleted: zod_1.z.boolean(),
+    isCollapsed: zod_1.z.boolean(),
+    role: entities_1.WorkspaceRoleSchema,
+    plan: entities_1.WorkspacePlanSchema,
+    limits: entities_1.WorkspaceLimitsSchema,
+    inviteCode: zod_1.z.string().nullable().optional(),
+    isLinkSharingEnabled: zod_1.z.boolean().nullable().optional(),
+    isGuestAllowed: zod_1.z.boolean().nullable().optional(),
+    currentActiveProjects: zod_1.z.number().nullable(),
+    currentMemberCount: zod_1.z.number().nullable(),
+    currentTemplateCount: zod_1.z.number().nullable(),
+    pendingInvitations: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+    domainName: zod_1.z.string().optional(),
+    domainDiscovery: zod_1.z.boolean().optional(),
+    restrictEmailDomains: zod_1.z.boolean().optional(),
+    adminSortingApplied: zod_1.z.boolean(),
+    projectSortPreference: zod_1.z.string().optional(),
+    defaultCollaborators: zod_1.z
+        .object({
+        predefinedGroupIds: zod_1.z.array(zod_1.z.string()),
+        userIds: zod_1.z.array(zod_1.z.number()),
+    })
+        .optional(),
+    properties: entities_1.WorkspacePropertiesSchema.optional(),
+})
+    .passthrough();

package/dist/cjs/types/sync/response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/utils/index.js

@@ -14,10 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSectionUrl = exports.getProjectUrl = exports.getTaskUrl = void 0;
+exports.createCommand = exports.getSectionUrl = exports.getProjectUrl = exports.getTaskUrl = void 0;
 __exportStar(require("./colors"), exports);
 __exportStar(require("./sanitization"), exports);
 var url_helpers_1 = require("./url-helpers");
 Object.defineProperty(exports, "getTaskUrl", { enumerable: true, get: function () { return url_helpers_1.getTaskUrl; } });
 Object.defineProperty(exports, "getProjectUrl", { enumerable: true, get: function () { return url_helpers_1.getProjectUrl; } });
 Object.defineProperty(exports, "getSectionUrl", { enumerable: true, get: function () { return url_helpers_1.getSectionUrl; } });
+var sync_helpers_1 = require("./sync-helpers");
+Object.defineProperty(exports, "createCommand", { enumerable: true, get: function () { return sync_helpers_1.createCommand; } });

package/dist/cjs/utils/multipart-upload.js

@@ -1,12 +1,39 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.uploadMultipartFile = uploadMultipartFile;
-const form_data_1 = __importDefault(require("form-data"));
-const fs_1 = require("fs");
-const path_1 = require("path");
 const fetch_with_retry_1 = require("./fetch-with-retry");
 /**
  * Helper function to determine content-type from filename extension.
@@ -37,11 +64,13 @@ function getContentTypeFromFileName(fileName) {
  * This is a shared utility for uploading files to Todoist endpoints that require
  * multipart/form-data content type (e.g., file uploads, workspace logo uploads).
  *
+ * Supports both browser (Blob/File) and Node.js (Buffer/ReadableStream/path) environments.
+ *
  * @param baseUrl - The base API URL (e.g., https://api.todoist.com/api/v1/)
  * @param authToken - The authentication token
  * @param endpoint - The relative endpoint path (e.g., 'uploads', 'workspaces/logo')
- * @param file - The file content (Buffer, ReadableStream, or file system path)
- * @param fileName - Optional file name (required for Buffer/Stream, optional for paths)
+ * @param file - The file content (Blob/File for browser, or Buffer/ReadableStream/path for Node)
+ * @param fileName - Optional file name (required for Buffer/Stream, optional for paths and File objects)
  * @param additionalFields - Additional form fields to include (e.g., project_id, workspace_id)
  * @param requestId - Optional request ID for idempotency
  * @returns The response data from the server
@@ -72,52 +101,74 @@ function getContentTypeFromFileName(fileName) {
  */
 async function uploadMultipartFile(args) {
     const { baseUrl, authToken, endpoint, file, fileName, additionalFields, requestId, customFetch, } = args;
-    const form = new form_data_1.default();
-    // Determine file type and add to form data
-    if (typeof file === 'string') {
-        // File path - create read stream
-        const filePath = file;
-        const resolvedFileName = fileName || (0, path_1.basename)(filePath);
-        form.append('file', (0, fs_1.createReadStream)(filePath), resolvedFileName);
+    // Build the full URL
+    const url = `${baseUrl}${endpoint}`;
+    let body;
+    const headers = {
+        Authorization: `Bearer ${authToken}`,
+    };
+    if (requestId) {
+        headers['X-Request-Id'] = requestId;
     }
-    else if (Buffer.isBuffer(file)) {
-        // Buffer - require fileName
-        if (!fileName) {
-            throw new Error('fileName is required when uploading from a Buffer');
+    if (file instanceof Blob) {
+        // Browser path: use native FormData
+        const form = new globalThis.FormData();
+        const resolvedFileName = fileName || (file instanceof File ? file.name : undefined) || 'upload';
+        form.append('file', file, resolvedFileName);
+        for (const [key, value] of Object.entries(additionalFields)) {
+            if (value !== undefined && value !== null) {
+                form.append(key, value.toString());
+            }
         }
-        // Detect content-type from filename extension
-        const contentType = getContentTypeFromFileName(fileName);
-        form.append('file', file, {
-            filename: fileName,
-            contentType: contentType,
-        });
+        // Don't set Content-Type — let fetch set it with the correct multipart boundary
+        body = form;
     }
     else {
-        // Stream - require fileName
-        if (!fileName) {
-            throw new Error('fileName is required when uploading from a stream');
+        // Node path: dynamically import Node-only modules
+        const [FormDataModule, fsModule, pathModule] = await Promise.all([
+            Promise.resolve().then(() => __importStar(require('form-data'))),
+            Promise.resolve().then(() => __importStar(require('fs'))),
+            Promise.resolve().then(() => __importStar(require('path'))),
+        ]);
+        const FormData = FormDataModule.default;
+        const form = new FormData();
+        if (typeof file === 'string') {
+            // File path - create read stream
+            const resolvedFileName = fileName || pathModule.basename(file);
+            form.append('file', fsModule.createReadStream(file), resolvedFileName);
         }
-        form.append('file', file, fileName);
-    }
-    // Add additional fields to the form
-    for (const [key, value] of Object.entries(additionalFields)) {
-        if (value !== undefined && value !== null) {
-            form.append(key, value.toString());
+        else if (Buffer.isBuffer(file)) {
+            // Buffer - require fileName
+            if (!fileName) {
+                throw new Error('fileName is required when uploading from a Buffer');
+            }
+            const contentType = getContentTypeFromFileName(fileName);
+            form.append('file', file, {
+                filename: fileName,
+                contentType: contentType,
+            });
         }
-    }
-    // Build the full URL
-    const url = `${baseUrl}${endpoint}`;
-    // Prepare headers
-    const headers = Object.assign({ Authorization: `Bearer ${authToken}` }, form.getHeaders());
-    if (requestId) {
-        headers['X-Request-Id'] = requestId;
+        else {
+            // Stream - require fileName
+            if (!fileName) {
+                throw new Error('fileName is required when uploading from a stream');
+            }
+            form.append('file', file, fileName);
+        }
+        for (const [key, value] of Object.entries(additionalFields)) {
+            if (value !== undefined && value !== null) {
+                form.append(key, value.toString());
+            }
+        }
+        Object.assign(headers, form.getHeaders());
+        body = form;
     }
     // Make the request using fetch
     const response = await (0, fetch_with_retry_1.fetchWithRetry)({
         url,
         options: {
             method: 'POST',
-            body: form, // FormData from 'form-data' package is compatible with fetch
+            body,
             headers,
             timeout: 30000, // 30 second timeout for file uploads
         },

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCommand = createCommand;
+const uuid_1 = require("uuid");
+/**
+ * Creates a strongly-typed Sync API command with an auto-generated UUID.
+ *
+ * @param type - The command type (e.g. `'item_add'`, `'project_update'`).
+ * @param args - The command arguments, constrained by the command type.
+ * @param tempId - Optional temporary ID for referencing the created resource in subsequent commands.
+ * @returns A fully formed `SyncCommand` ready to include in a sync request.
+ *
+ * @example
+ * ```typescript
+ * const cmd = createCommand('item_add', { content: 'Buy milk', priority: 2 })
+ * // cmd.type === 'item_add'
+ * // cmd.args is typed as TaskAddArgs
+ * ```
+ */
+function createCommand(type, args, tempId) {
+    return Object.assign({ type, uuid: (0, uuid_1.v4)(), args: args }, (tempId !== undefined ? { tempId } : {}));
+}