@doist/todoist-sdk 9.1.2 → 9.2.0-next.1

package/dist/esm/clients/goals-client.js

@@ -0,0 +1,141 @@
+import { z } from 'zod';
+import { ENDPOINT_REST_GOALS, ENDPOINT_REST_GOALS_SEARCH, GOAL_COMPLETE, GOAL_TASKS, GOAL_UNCOMPLETE, } from '../consts/endpoints.js';
+import { isSuccess, request } from '../transport/http-client.js';
+import { generatePath } from '../utils/request-helpers.js';
+import { validateGoal, validateGoalArray } from '../utils/validators.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all goal-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public goal method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export class GoalsClient extends BaseClient {
+    async getGoals(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_GOALS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateGoalArray(results),
+            nextCursor,
+        };
+    }
+    async searchGoals(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_GOALS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateGoalArray(results),
+            nextCursor,
+        };
+    }
+    async getGoal(id) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return validateGoal(response.data);
+    }
+    async addGoal(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_GOALS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async updateGoal(id, args, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async deleteGoal(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return isSuccess(response);
+    }
+    async completeGoal(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id, GOAL_COMPLETE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async uncompleteGoal(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id, GOAL_UNCOMPLETE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async linkTaskToGoal({ goalId, taskId }, requestId) {
+        z.string().parse(goalId);
+        z.string().parse(taskId);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, goalId, GOAL_TASKS),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: { itemId: taskId },
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async unlinkTaskFromGoal({ goalId, taskId }, requestId) {
+        z.string().parse(goalId);
+        z.string().parse(taskId);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, goalId, GOAL_TASKS, taskId),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return isSuccess(response);
+    }
+}

package/dist/esm/consts/endpoints.js

@@ -70,6 +70,11 @@ export const ENDPOINT_GET_TOKEN = 'access_token';
 export const ENDPOINT_REVOKE = 'revoke';
 export const ENDPOINT_REGISTER = 'register';
 export const ENDPOINT_REST_FOLDERS = 'folders';
+export const ENDPOINT_REST_GOALS = 'goals';
+export const ENDPOINT_REST_GOALS_SEARCH = ENDPOINT_REST_GOALS + '/search';
+export const GOAL_COMPLETE = 'complete';
+export const GOAL_UNCOMPLETE = 'uncomplete';
+export const GOAL_TASKS = 'items';
 // Workspace endpoints
 export const ENDPOINT_REST_WORKSPACES = 'workspaces';
 export const ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';

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

@@ -277,6 +277,30 @@ export const DEFAULT_COLLABORATOR_STATE = {
     state: 'active',
     isDeleted: false,
 };
+export const DEFAULT_GOAL_ID = '550e8400-e29b-41d4-a716-446655440000';
+export const DEFAULT_GOAL = {
+    id: DEFAULT_GOAL_ID,
+    ownerType: 'USER',
+    ownerId: DEFAULT_USER_ID,
+    name: 'Ship v2',
+    description: 'Launch the new version',
+    deadline: '2026-04-03',
+    parentGoalId: null,
+    childOrder: 0,
+    isCompleted: false,
+    completedAt: null,
+    responsibleUid: null,
+    isDeleted: false,
+    progress: {
+        totalTaskCount: 5,
+        completedTaskCount: 2,
+        percentage: 40,
+    },
+    creatorUid: DEFAULT_USER_ID,
+    createdAt: defaultDate(),
+    updatedAt: defaultDate(),
+};
+export const DEFAULT_GOAL_NO_PROGRESS = Object.assign(Object.assign({}, DEFAULT_GOAL), { id: 'e5f6g7h8-e29b-41d4-a716-446655440001', progress: undefined });
 export const DEFAULT_APP_ID = '42';
 export const DEFAULT_INSTALLATION_ID = '1001';
 export const DEFAULT_UI_EXTENSION_ID = '2002';

package/dist/esm/todoist-api.js

@@ -4,6 +4,7 @@ import { BackupClient } from './clients/backup-client.js';
 import { CommentClient } from './clients/comment-client.js';
 import { EmailClient } from './clients/email-client.js';
 import { FolderClient } from './clients/folder-client.js';
+import { GoalsClient } from './clients/goals-client.js';
 import { IdMappingClient } from './clients/id-mapping-client.js';
 import { InsightsClient } from './clients/insights-client.js';
 import { LabelClient } from './clients/label-client.js';
@@ -58,6 +59,7 @@ export class TodoistApi {
         this.activityClient = new ActivityClient(clientDeps);
         this.productivityClient = new ProductivityClient(clientDeps);
         this.workspaceClient = new WorkspaceClient(clientDeps);
+        this.goalsClient = new GoalsClient(clientDeps);
         this.appClient = new AppClient(clientDeps);
         this.uiExtensionClient = new UiExtensionClient(clientDeps);
     }
@@ -939,6 +941,37 @@ export class TodoistApi {
     async deleteFolder(id, requestId) {
         return this.folderClient.deleteFolder(id, requestId);
     }
+    // ── Goals ──
+    async getGoals(args) {
+        return this.goalsClient.getGoals(args);
+    }
+    async searchGoals(args) {
+        return this.goalsClient.searchGoals(args);
+    }
+    async getGoal(id) {
+        return this.goalsClient.getGoal(id);
+    }
+    async addGoal(args, requestId) {
+        return this.goalsClient.addGoal(args, requestId);
+    }
+    async updateGoal(id, args, requestId) {
+        return this.goalsClient.updateGoal(id, args, requestId);
+    }
+    async deleteGoal(id, requestId) {
+        return this.goalsClient.deleteGoal(id, requestId);
+    }
+    async completeGoal(id, requestId) {
+        return this.goalsClient.completeGoal(id, requestId);
+    }
+    async uncompleteGoal(id, requestId) {
+        return this.goalsClient.uncompleteGoal(id, requestId);
+    }
+    async linkTaskToGoal(args, requestId) {
+        return this.goalsClient.linkTaskToGoal(args, requestId);
+    }
+    async unlinkTaskFromGoal(args, requestId) {
+        return this.goalsClient.unlinkTaskFromGoal(args, requestId);
+    }
     // ── Backups ──
     /**
      * Retrieves a list of available backups.

package/dist/esm/types/goals/index.js

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

package/dist/esm/types/goals/requests.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/goals/types.js

@@ -0,0 +1,53 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { z } from 'zod';
+/** Available goal owner types. */
+export const GOAL_OWNER_TYPES = ['USER', 'WORKSPACE'];
+/**
+ * Progress of a {@link Goal}.
+ *
+ * The REST API returns these counts under `total_item_count` / `completed_item_count`,
+ * reflecting the backend's generic "item" terminology. The SDK normalizes them to
+ * `totalTaskCount` / `completedTaskCount` so the public surface consistently speaks
+ * in "tasks" (matching the rest of the SDK). The `preprocess` step below performs
+ * that rename after the transport layer's snake_case → camelCase conversion — do not
+ * remove it without also changing the downstream field names.
+ */
+export const GoalProgressSchema = z.preprocess((raw) => {
+    if (raw === null || raw === undefined || typeof raw !== 'object' || Array.isArray(raw)) {
+        return raw;
+    }
+    const _a = raw, { totalItemCount, completedItemCount, totalTaskCount, completedTaskCount } = _a, rest = __rest(_a, ["totalItemCount", "completedItemCount", "totalTaskCount", "completedTaskCount"]);
+    return Object.assign(Object.assign({}, rest), { totalTaskCount: totalTaskCount !== null && totalTaskCount !== void 0 ? totalTaskCount : totalItemCount, completedTaskCount: completedTaskCount !== null && completedTaskCount !== void 0 ? completedTaskCount : completedItemCount });
+}, z.looseObject({
+    totalTaskCount: z.number().int(),
+    completedTaskCount: z.number().int(),
+    percentage: z.number(),
+}));
+export const GoalSchema = z.looseObject({
+    id: z.string(),
+    ownerType: z.enum(GOAL_OWNER_TYPES),
+    ownerId: z.string(),
+    name: z.string(),
+    description: z.string().nullable(),
+    deadline: z.string().nullable(),
+    parentGoalId: z.string().nullable(),
+    childOrder: z.number().int(),
+    isCompleted: z.boolean(),
+    completedAt: z.coerce.date().nullable(),
+    responsibleUid: z.string().nullable(),
+    isDeleted: z.boolean(),
+    progress: GoalProgressSchema.optional(),
+    creatorUid: z.string(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+});

package/dist/esm/types/index.js

@@ -9,6 +9,7 @@ export * from './productivity/index.js';
 export * from './activity/index.js';
 export * from './workspaces/index.js';
 export * from './folders/index.js';
+export * from './goals/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';

package/dist/esm/types/sync/commands/goals.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/sync/commands/index.js

@@ -11,6 +11,7 @@ export * from './workspaces.js';
 export * from './folders.js';
 export * from './workspace-filters.js';
 export * from './workspace-goals.js';
+export * from './goals.js';
 export * from './notifications.js';
 export * from './sharing.js';
 export * from './view-options.js';

package/dist/esm/types/sync/resource-types.js

@@ -29,6 +29,7 @@ export const SYNC_RESOURCE_TYPES = [
     'role_actions',
     'folders',
     'workspace_goals',
+    'goals',
     'day_orders',
     'calendars',
     'calendar_accounts',

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

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { GoalSchema } from '../goals/types.js';
 import { LabelSchema } from '../labels/types.js';
 import { ProjectSchema } from '../projects/types.js';
 import { SectionSchema } from '../sections/types.js';
@@ -43,6 +44,7 @@ export const SyncResponseSchema = z.looseObject({
     projectViewOptionsDefaults: z.array(ProjectViewOptionsDefaultsSchema).optional(),
     roleActions: z.array(z.record(z.string(), z.unknown())).optional(),
     folders: z.array(FolderSchema).optional(),
+    goals: z.array(GoalSchema).optional(),
     workspaceGoals: z.array(WorkspaceGoalSchema).optional(),
     dayOrders: z.record(z.string(), z.number()).optional(),
     calendars: z.array(CalendarSchema).optional(),

package/dist/esm/utils/validators.js

@@ -3,6 +3,7 @@ import { ActivityEventSchema } from '../types/activity/types.js';
 import { AppSchema, AppWithUserCountSchema, AppSecretsSchema, AppVerificationTokenSchema, AppTestTokenSchema, AppDistributionTokenSchema, AppByDistributionTokenSchema, AppWebhookSchema, AppInstallationSchema, UserAuthorizationSchema, } from '../types/apps/types.js';
 import { BackupSchema } from '../types/backups/types.js';
 import { AttachmentSchema, CommentSchema } from '../types/comments/types.js';
+import { GoalSchema } from '../types/goals/types.js';
 import { IdMappingSchema, MovedIdSchema } from '../types/id-mappings/types.js';
 import { ProjectActivityStatsSchema, ProjectHealthSchema, ProjectHealthContextSchema, ProjectProgressSchema, WorkspaceInsightsSchema, } from '../types/insights/types.js';
 import { LabelSchema } from '../types/labels/types.js';
@@ -58,6 +59,7 @@ export const { validate: validateFilter, validateArray: validateFilterArray } =
 export const { validate: validateCollaborator, validateArray: validateCollaboratorArray } = createValidator(CollaboratorSchema);
 export const { validate: validateCollaboratorState, validateArray: validateCollaboratorStateArray, } = createValidator(CollaboratorStateSchema);
 export const { validate: validateFolder, validateArray: validateFolderArray } = createValidator(FolderSchema);
+export const { validate: validateGoal, validateArray: validateGoalArray } = createValidator(GoalSchema);
 export const { validate: validateNote, validateArray: validateNoteArray } = createValidator(NoteSchema);
 export const { validate: validateTooltips } = createValidator(TooltipsSchema);
 export const { validate: validateWorkspaceFilter, validateArray: validateWorkspaceFilterArray } = createValidator(WorkspaceFilterSchema);

package/dist/types/clients/goals-client.d.ts

@@ -0,0 +1,20 @@
+import type { AddGoalArgs, GetGoalsArgs, GetGoalsResponse, Goal, SearchGoalsArgs, TaskLinkingArgs, UpdateGoalArgs } from '../types/goals/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all goal-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public goal method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class GoalsClient extends BaseClient {
+    getGoals(args?: GetGoalsArgs): Promise<GetGoalsResponse>;
+    searchGoals(args: SearchGoalsArgs): Promise<GetGoalsResponse>;
+    getGoal(id: string): Promise<Goal>;
+    addGoal(args: AddGoalArgs, requestId?: string): Promise<Goal>;
+    updateGoal(id: string, args: UpdateGoalArgs, requestId?: string): Promise<Goal>;
+    deleteGoal(id: string, requestId?: string): Promise<boolean>;
+    completeGoal(id: string, requestId?: string): Promise<Goal>;
+    uncompleteGoal(id: string, requestId?: string): Promise<Goal>;
+    linkTaskToGoal({ goalId, taskId }: TaskLinkingArgs, requestId?: string): Promise<Goal>;
+    unlinkTaskFromGoal({ goalId, taskId }: TaskLinkingArgs, requestId?: string): Promise<boolean>;
+}

package/dist/types/consts/endpoints.d.ts

@@ -59,6 +59,11 @@ export declare const ENDPOINT_GET_TOKEN = "access_token";
 export declare const ENDPOINT_REVOKE = "revoke";
 export declare const ENDPOINT_REGISTER = "register";
 export declare const ENDPOINT_REST_FOLDERS = "folders";
+export declare const ENDPOINT_REST_GOALS = "goals";
+export declare const ENDPOINT_REST_GOALS_SEARCH: string;
+export declare const GOAL_COMPLETE = "complete";
+export declare const GOAL_UNCOMPLETE = "uncomplete";
+export declare const GOAL_TASKS = "items";
 export declare const ENDPOINT_REST_WORKSPACES = "workspaces";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS = "workspaces/invitations";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS_ALL = "workspaces/invitations/all";

package/dist/types/test-utils/msw-setup.d.ts

@@ -18,7 +18,7 @@ export declare function getLastRequest(): CapturedRequest | undefined;
 export declare function getAllRequests(): CapturedRequest[];
 export declare function clearCapturedRequests(): void;
 export declare const handlers: never[];
-export declare const server: import("msw/node").SetupServerApi;
+export declare const server: import("msw/node").SetupServer;
 export declare function mockApiResponse<T extends DefaultBodyType>({ endpoint, data, options, }: {
     endpoint: string;
     data: T;

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

@@ -1,4 +1,4 @@
-import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, WorkspaceProject, Reminder, Folder, App, AppWithUserCount, AppSecrets, AppVerificationToken, AppTestToken, AppDistributionToken, AppWebhook, AppInstallation, UserAuthorization, UiExtension } from '../types/index.js';
+import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, WorkspaceProject, Reminder, Folder, Goal, App, AppWithUserCount, AppSecrets, AppVerificationToken, AppTestToken, AppDistributionToken, AppWebhook, AppInstallation, UserAuthorization, UiExtension } from '../types/index.js';
 import type { Collaborator, CollaboratorState } from '../types/sync/resources/collaborators.js';
 import type { Note } from '../types/sync/resources/notes.js';
 export declare const DEFAULT_TASK_ID = "1234";
@@ -264,6 +264,9 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
 export declare const DEFAULT_FOLDER: Folder;
 export declare const DEFAULT_COLLABORATOR: Collaborator;
 export declare const DEFAULT_COLLABORATOR_STATE: CollaboratorState;
+export declare const DEFAULT_GOAL_ID = "550e8400-e29b-41d4-a716-446655440000";
+export declare const DEFAULT_GOAL: Goal;
+export declare const DEFAULT_GOAL_NO_PROGRESS: Goal;
 export declare const DEFAULT_APP_ID = "42";
 export declare const DEFAULT_INSTALLATION_ID = "1001";
 export declare const DEFAULT_UI_EXTENSION_ID = "2002";

package/dist/types/todoist-api.d.ts

@@ -5,6 +5,7 @@ import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/inde
 import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
 import { GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs } from './types/emails/index.js';
 import { GetFoldersArgs, GetFoldersResponse, AddFolderArgs, UpdateFolderArgs } from './types/folders/index.js';
+import type { AddGoalArgs, GetGoalsArgs, GetGoalsResponse, Goal, SearchGoalsArgs, TaskLinkingArgs, UpdateGoalArgs } from './types/goals/index.js';
 import { CustomFetch, FileResponse } from './types/http.js';
 import { IdMapping, MovedId, GetIdMappingsArgs, GetMovedIdsArgs } from './types/id-mappings/index.js';
 import { ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs } from './types/insights/index.js';
@@ -75,6 +76,7 @@ export declare class TodoistApi {
     private readonly activityClient;
     private readonly productivityClient;
     private readonly workspaceClient;
+    private readonly goalsClient;
     private readonly appClient;
     private readonly uiExtensionClient;
     constructor(
@@ -787,6 +789,16 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteFolder(id: string, requestId?: string): Promise<boolean>;
+    getGoals(args?: GetGoalsArgs): Promise<GetGoalsResponse>;
+    searchGoals(args: SearchGoalsArgs): Promise<GetGoalsResponse>;
+    getGoal(id: string): Promise<Goal>;
+    addGoal(args: AddGoalArgs, requestId?: string): Promise<Goal>;
+    updateGoal(id: string, args: UpdateGoalArgs, requestId?: string): Promise<Goal>;
+    deleteGoal(id: string, requestId?: string): Promise<boolean>;
+    completeGoal(id: string, requestId?: string): Promise<Goal>;
+    uncompleteGoal(id: string, requestId?: string): Promise<Goal>;
+    linkTaskToGoal(args: TaskLinkingArgs, requestId?: string): Promise<Goal>;
+    unlinkTaskFromGoal(args: TaskLinkingArgs, requestId?: string): Promise<boolean>;
     /**
      * Retrieves a list of available backups.
      *

package/dist/types/types/goals/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

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

@@ -0,0 +1,33 @@
+import type { SearchArgs } from '../common.js';
+import type { Workspace } from '../workspaces/index.js';
+import type { Goal, GoalOwnerType } from './types.js';
+export type GetGoalsArgs = {
+    ownerType?: GoalOwnerType;
+    workspaceId?: Workspace['id'];
+    cursor?: string | null;
+    limit?: number;
+};
+export type SearchGoalsArgs = SearchArgs & {
+    ownerType?: GoalOwnerType;
+};
+export type GetGoalsResponse = {
+    results: Goal[];
+    nextCursor: string | null;
+};
+export type AddGoalArgs = {
+    name: string;
+    workspaceId?: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type UpdateGoalArgs = {
+    name?: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type TaskLinkingArgs = {
+    goalId: string;
+    taskId: string;
+};

package/dist/types/types/goals/types.d.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+/** Available goal owner types. */
+export declare const GOAL_OWNER_TYPES: readonly ["USER", "WORKSPACE"];
+/** Goal owner type. */
+export type GoalOwnerType = (typeof GOAL_OWNER_TYPES)[number];
+/**
+ * Progress of a {@link Goal}.
+ *
+ * The REST API returns these counts under `total_item_count` / `completed_item_count`,
+ * reflecting the backend's generic "item" terminology. The SDK normalizes them to
+ * `totalTaskCount` / `completedTaskCount` so the public surface consistently speaks
+ * in "tasks" (matching the rest of the SDK). The `preprocess` step below performs
+ * that rename after the transport layer's snake_case → camelCase conversion — do not
+ * remove it without also changing the downstream field names.
+ */
+export declare const GoalProgressSchema: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
+    totalTaskCount: z.ZodNumber;
+    completedTaskCount: z.ZodNumber;
+    percentage: z.ZodNumber;
+}, z.core.$loose>>;
+export type GoalProgress = z.infer<typeof GoalProgressSchema>;
+export declare const GoalSchema: z.ZodObject<{
+    id: z.ZodString;
+    ownerType: z.ZodEnum<{
+        USER: "USER";
+        WORKSPACE: "WORKSPACE";
+    }>;
+    ownerId: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    deadline: z.ZodNullable<z.ZodString>;
+    parentGoalId: z.ZodNullable<z.ZodString>;
+    childOrder: z.ZodNumber;
+    isCompleted: z.ZodBoolean;
+    completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    isDeleted: z.ZodBoolean;
+    progress: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
+        totalTaskCount: z.ZodNumber;
+        completedTaskCount: z.ZodNumber;
+        percentage: z.ZodNumber;
+    }, z.core.$loose>>>;
+    creatorUid: z.ZodString;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+}, z.core.$loose>;
+/**
+ * Represents a goal in Todoist.
+ * Goals support dual ownership: personal (ownerType=USER) and workspace (ownerType=WORKSPACE).
+ */
+export type Goal = z.infer<typeof GoalSchema>;

package/dist/types/types/index.d.ts

@@ -9,6 +9,7 @@ export * from './productivity/index.js';
 export * from './activity/index.js';
 export * from './workspaces/index.js';
 export * from './folders/index.js';
+export * from './goals/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';

package/dist/types/types/sync/commands/goals.d.ts

@@ -0,0 +1,33 @@
+import type { GoalOwnerType } from '../../goals/types.js';
+export type GoalAddArgs = {
+    ownerType: GoalOwnerType;
+    ownerId: string;
+    name: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type GoalUpdateArgs = {
+    id: string;
+    name?: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type GoalCompleteArgs = {
+    id: string;
+};
+export type GoalUncompleteArgs = {
+    id: string;
+};
+export type GoalDeleteArgs = {
+    id: string;
+};
+export type GoalLinkItemArgs = {
+    goalId: string;
+    itemId: string;
+};
+export type GoalUnlinkItemArgs = {
+    goalId: string;
+    itemId: string;
+};

package/dist/types/types/sync/commands/index.d.ts

@@ -1,6 +1,7 @@
 import type { CalendarUpdateArgs, CalendarAccountUpdateArgs, CalendarAccountRestoreTaskCalendarArgs } from './calendars.js';
 import type { FilterAddArgs, FilterUpdateArgs, FilterUpdateOrdersArgs, FilterDeleteArgs } from './filters.js';
 import type { FolderAddArgs, FolderUpdateArgs, FolderDeleteArgs } from './folders.js';
+import type { GoalAddArgs, GoalUpdateArgs, GoalCompleteArgs, GoalUncompleteArgs, GoalDeleteArgs, GoalLinkItemArgs, GoalUnlinkItemArgs } from './goals.js';
 import type { LabelAddArgs, LabelRenameArgs, LabelUpdateArgs, LabelUpdateOrdersArgs, LabelDeleteArgs, LabelDeleteOccurrencesArgs } from './labels.js';
 import type { NoteAddArgs, NoteUpdateArgs, NoteDeleteArgs, NoteReactionAddArgs, NoteReactionRemoveArgs } from './notes.js';
 import type { LiveNotificationsMarkUnreadArgs, LiveNotificationsMarkReadArgs, LiveNotificationsMarkReadAllArgs, LiveNotificationsSetLastReadArgs } from './notifications.js';
@@ -96,6 +97,13 @@ export type SyncCommandsMap = {
     workspace_goal_delete: WorkspaceGoalDeleteArgs;
     workspace_goal_project_add: WorkspaceGoalProjectAddArgs;
     workspace_goal_project_remove: WorkspaceGoalProjectRemoveArgs;
+    goal_add: GoalAddArgs;
+    goal_update: GoalUpdateArgs;
+    goal_complete: GoalCompleteArgs;
+    goal_uncomplete: GoalUncompleteArgs;
+    goal_delete: GoalDeleteArgs;
+    goal_link_item: GoalLinkItemArgs;
+    goal_unlink_item: GoalUnlinkItemArgs;
     live_notifications_mark_unread: LiveNotificationsMarkUnreadArgs;
     live_notifications_mark_read: LiveNotificationsMarkReadArgs;
     live_notifications_mark_read_all: LiveNotificationsMarkReadAllArgs;
@@ -163,6 +171,7 @@ export * from './workspaces.js';
 export * from './folders.js';
 export * from './workspace-filters.js';
 export * from './workspace-goals.js';
+export * from './goals.js';
 export * from './notifications.js';
 export * from './sharing.js';
 export * from './view-options.js';

package/dist/types/types/sync/resource-types.d.ts

@@ -1,5 +1,5 @@
 /**
  * All available Sync API resource types.
  */
-export declare const SYNC_RESOURCE_TYPES: readonly ["labels", "projects", "items", "notes", "project_notes", "sections", "filters", "reminders", "reminders_location", "locations", "user", "live_notifications", "collaborators", "collaborator_states", "user_settings", "notification_settings", "user_plan_limits", "completed_info", "stats", "workspaces", "workspace_users", "workspace_filters", "view_options", "project_view_options_defaults", "role_actions", "folders", "workspace_goals", "day_orders", "calendars", "calendar_accounts", "suggestions", "tooltips"];
+export declare const SYNC_RESOURCE_TYPES: readonly ["labels", "projects", "items", "notes", "project_notes", "sections", "filters", "reminders", "reminders_location", "locations", "user", "live_notifications", "collaborators", "collaborator_states", "user_settings", "notification_settings", "user_plan_limits", "completed_info", "stats", "workspaces", "workspace_users", "workspace_filters", "view_options", "project_view_options_defaults", "role_actions", "folders", "workspace_goals", "goals", "day_orders", "calendars", "calendar_accounts", "suggestions", "tooltips"];
 export type SyncResourceType = (typeof SYNC_RESOURCE_TYPES)[number];