@doist/todoist-sdk 10.2.0-next.3 → 10.2.0

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

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GoalsClient = void 0;
-const zod_1 = require("zod");
 const endpoints_1 = require("../consts/endpoints");
 const http_client_1 = require("../transport/http-client");
 const request_helpers_1 = require("../utils/request-helpers");
@@ -43,7 +42,7 @@ class GoalsClient extends base_client_1.BaseClient {
         };
     }
     async getGoal(id) {
-        zod_1.z.string().parse(id);
+        validators_1.IdSchema.parse(id);
         const response = await (0, http_client_1.request)({
             httpMethod: 'GET',
             baseUri: this.syncApiBase,
@@ -66,7 +65,7 @@ class GoalsClient extends base_client_1.BaseClient {
         return (0, validators_1.validateGoal)(response.data);
     }
     async updateGoal(id, args, requestId) {
-        zod_1.z.string().parse(id);
+        validators_1.IdSchema.parse(id);
         const response = await (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -79,7 +78,7 @@ class GoalsClient extends base_client_1.BaseClient {
         return (0, validators_1.validateGoal)(response.data);
     }
     async deleteGoal(id, requestId) {
-        zod_1.z.string().parse(id);
+        validators_1.IdSchema.parse(id);
         const response = await (0, http_client_1.request)({
             httpMethod: 'DELETE',
             baseUri: this.syncApiBase,
@@ -91,7 +90,7 @@ class GoalsClient extends base_client_1.BaseClient {
         return (0, http_client_1.isSuccess)(response);
     }
     async completeGoal(id, requestId) {
-        zod_1.z.string().parse(id);
+        validators_1.IdSchema.parse(id);
         const response = await (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -103,7 +102,7 @@ class GoalsClient extends base_client_1.BaseClient {
         return (0, validators_1.validateGoal)(response.data);
     }
     async uncompleteGoal(id, requestId) {
-        zod_1.z.string().parse(id);
+        validators_1.IdSchema.parse(id);
         const response = await (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -115,8 +114,8 @@ class GoalsClient extends base_client_1.BaseClient {
         return (0, validators_1.validateGoal)(response.data);
     }
     async linkTaskToGoal({ goalId, taskId }, requestId) {
-        zod_1.z.string().parse(goalId);
-        zod_1.z.string().parse(taskId);
+        validators_1.IdSchema.parse(goalId);
+        validators_1.IdSchema.parse(taskId);
         const response = await (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -129,8 +128,8 @@ class GoalsClient extends base_client_1.BaseClient {
         return (0, validators_1.validateGoal)(response.data);
     }
     async unlinkTaskFromGoal({ goalId, taskId }, requestId) {
-        zod_1.z.string().parse(goalId);
-        zod_1.z.string().parse(taskId);
+        validators_1.IdSchema.parse(goalId);
+        validators_1.IdSchema.parse(taskId);
         const response = await (0, http_client_1.request)({
             httpMethod: 'DELETE',
             baseUri: this.syncApiBase,

package/dist/cjs/todoist-api.js

@@ -945,33 +945,101 @@ class TodoistApi {
         return this.folderClient.deleteFolder(id, requestId);
     }
     // ── Goals ──
+    /**
+     * Retrieves a paginated list of goals.
+     *
+     * @param args - Optional filters including owner type, workspace ID, cursor, and limit.
+     * @returns A promise that resolves to a paginated list of goals.
+     */
     async getGoals(args) {
         return this.goalsClient.getGoals(args);
     }
+    /**
+     * Searches for goals matching a query.
+     *
+     * @param args - Search parameters including query string and optional owner type.
+     * @returns A promise that resolves to a paginated list of matching goals.
+     */
     async searchGoals(args) {
         return this.goalsClient.searchGoals(args);
     }
+    /**
+     * Retrieves a single goal by its ID.
+     *
+     * @param id - The unique identifier of the goal.
+     * @returns A promise that resolves to the goal.
+     */
     async getGoal(id) {
         return this.goalsClient.getGoal(id);
     }
+    /**
+     * Creates a new goal.
+     *
+     * @param args - Goal attributes including name and optional workspace, description, deadline, and responsible user.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created goal.
+     */
     async addGoal(args, requestId) {
         return this.goalsClient.addGoal(args, requestId);
     }
+    /**
+     * Updates an existing goal.
+     *
+     * @param id - The unique identifier of the goal to update.
+     * @param args - Attributes to update on the goal.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async updateGoal(id, args, requestId) {
         return this.goalsClient.updateGoal(id, args, requestId);
     }
+    /**
+     * Deletes a goal by its ID.
+     *
+     * @param id - The unique identifier of the goal to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
     async deleteGoal(id, requestId) {
         return this.goalsClient.deleteGoal(id, requestId);
     }
+    /**
+     * Marks a goal as complete.
+     *
+     * @param id - The unique identifier of the goal to complete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async completeGoal(id, requestId) {
         return this.goalsClient.completeGoal(id, requestId);
     }
+    /**
+     * Marks a previously completed goal as incomplete.
+     *
+     * @param id - The unique identifier of the goal to uncomplete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async uncompleteGoal(id, requestId) {
         return this.goalsClient.uncompleteGoal(id, requestId);
     }
+    /**
+     * Links a task to a goal so it contributes to goal progress.
+     *
+     * @param args - The goal ID and task ID to link.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async linkTaskToGoal(args, requestId) {
         return this.goalsClient.linkTaskToGoal(args, requestId);
     }
+    /**
+     * Unlinks a previously linked task from a goal.
+     *
+     * @param args - The goal ID and task ID to unlink.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
     async unlinkTaskFromGoal(args, requestId) {
         return this.goalsClient.unlinkTaskFromGoal(args, requestId);
     }

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

@@ -1,8 +1,7 @@
-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 { IdSchema, validateGoal, validateGoalArray } from '../utils/validators.js';
 import { BaseClient } from './base-client.js';
 /**
  * Internal sub-client handling all goal-domain endpoints.
@@ -40,7 +39,7 @@ export class GoalsClient extends BaseClient {
         };
     }
     async getGoal(id) {
-        z.string().parse(id);
+        IdSchema.parse(id);
         const response = await request({
             httpMethod: 'GET',
             baseUri: this.syncApiBase,
@@ -63,7 +62,7 @@ export class GoalsClient extends BaseClient {
         return validateGoal(response.data);
     }
     async updateGoal(id, args, requestId) {
-        z.string().parse(id);
+        IdSchema.parse(id);
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -76,7 +75,7 @@ export class GoalsClient extends BaseClient {
         return validateGoal(response.data);
     }
     async deleteGoal(id, requestId) {
-        z.string().parse(id);
+        IdSchema.parse(id);
         const response = await request({
             httpMethod: 'DELETE',
             baseUri: this.syncApiBase,
@@ -88,7 +87,7 @@ export class GoalsClient extends BaseClient {
         return isSuccess(response);
     }
     async completeGoal(id, requestId) {
-        z.string().parse(id);
+        IdSchema.parse(id);
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -100,7 +99,7 @@ export class GoalsClient extends BaseClient {
         return validateGoal(response.data);
     }
     async uncompleteGoal(id, requestId) {
-        z.string().parse(id);
+        IdSchema.parse(id);
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -112,8 +111,8 @@ export class GoalsClient extends BaseClient {
         return validateGoal(response.data);
     }
     async linkTaskToGoal({ goalId, taskId }, requestId) {
-        z.string().parse(goalId);
-        z.string().parse(taskId);
+        IdSchema.parse(goalId);
+        IdSchema.parse(taskId);
         const response = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
@@ -126,8 +125,8 @@ export class GoalsClient extends BaseClient {
         return validateGoal(response.data);
     }
     async unlinkTaskFromGoal({ goalId, taskId }, requestId) {
-        z.string().parse(goalId);
-        z.string().parse(taskId);
+        IdSchema.parse(goalId);
+        IdSchema.parse(taskId);
         const response = await request({
             httpMethod: 'DELETE',
             baseUri: this.syncApiBase,

package/dist/esm/todoist-api.js

@@ -942,33 +942,101 @@ export class TodoistApi {
         return this.folderClient.deleteFolder(id, requestId);
     }
     // ── Goals ──
+    /**
+     * Retrieves a paginated list of goals.
+     *
+     * @param args - Optional filters including owner type, workspace ID, cursor, and limit.
+     * @returns A promise that resolves to a paginated list of goals.
+     */
     async getGoals(args) {
         return this.goalsClient.getGoals(args);
     }
+    /**
+     * Searches for goals matching a query.
+     *
+     * @param args - Search parameters including query string and optional owner type.
+     * @returns A promise that resolves to a paginated list of matching goals.
+     */
     async searchGoals(args) {
         return this.goalsClient.searchGoals(args);
     }
+    /**
+     * Retrieves a single goal by its ID.
+     *
+     * @param id - The unique identifier of the goal.
+     * @returns A promise that resolves to the goal.
+     */
     async getGoal(id) {
         return this.goalsClient.getGoal(id);
     }
+    /**
+     * Creates a new goal.
+     *
+     * @param args - Goal attributes including name and optional workspace, description, deadline, and responsible user.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created goal.
+     */
     async addGoal(args, requestId) {
         return this.goalsClient.addGoal(args, requestId);
     }
+    /**
+     * Updates an existing goal.
+     *
+     * @param id - The unique identifier of the goal to update.
+     * @param args - Attributes to update on the goal.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async updateGoal(id, args, requestId) {
         return this.goalsClient.updateGoal(id, args, requestId);
     }
+    /**
+     * Deletes a goal by its ID.
+     *
+     * @param id - The unique identifier of the goal to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
     async deleteGoal(id, requestId) {
         return this.goalsClient.deleteGoal(id, requestId);
     }
+    /**
+     * Marks a goal as complete.
+     *
+     * @param id - The unique identifier of the goal to complete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async completeGoal(id, requestId) {
         return this.goalsClient.completeGoal(id, requestId);
     }
+    /**
+     * Marks a previously completed goal as incomplete.
+     *
+     * @param id - The unique identifier of the goal to uncomplete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async uncompleteGoal(id, requestId) {
         return this.goalsClient.uncompleteGoal(id, requestId);
     }
+    /**
+     * Links a task to a goal so it contributes to goal progress.
+     *
+     * @param args - The goal ID and task ID to link.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     async linkTaskToGoal(args, requestId) {
         return this.goalsClient.linkTaskToGoal(args, requestId);
     }
+    /**
+     * Unlinks a previously linked task from a goal.
+     *
+     * @param args - The goal ID and task ID to unlink.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
     async unlinkTaskFromGoal(args, requestId) {
         return this.goalsClient.unlinkTaskFromGoal(args, requestId);
     }

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

@@ -789,15 +789,83 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteFolder(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves a paginated list of goals.
+     *
+     * @param args - Optional filters including owner type, workspace ID, cursor, and limit.
+     * @returns A promise that resolves to a paginated list of goals.
+     */
     getGoals(args?: GetGoalsArgs): Promise<GetGoalsResponse>;
+    /**
+     * Searches for goals matching a query.
+     *
+     * @param args - Search parameters including query string and optional owner type.
+     * @returns A promise that resolves to a paginated list of matching goals.
+     */
     searchGoals(args: SearchGoalsArgs): Promise<GetGoalsResponse>;
+    /**
+     * Retrieves a single goal by its ID.
+     *
+     * @param id - The unique identifier of the goal.
+     * @returns A promise that resolves to the goal.
+     */
     getGoal(id: string): Promise<Goal>;
+    /**
+     * Creates a new goal.
+     *
+     * @param args - Goal attributes including name and optional workspace, description, deadline, and responsible user.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created goal.
+     */
     addGoal(args: AddGoalArgs, requestId?: string): Promise<Goal>;
+    /**
+     * Updates an existing goal.
+     *
+     * @param id - The unique identifier of the goal to update.
+     * @param args - Attributes to update on the goal.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     updateGoal(id: string, args: UpdateGoalArgs, requestId?: string): Promise<Goal>;
+    /**
+     * Deletes a goal by its ID.
+     *
+     * @param id - The unique identifier of the goal to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
     deleteGoal(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Marks a goal as complete.
+     *
+     * @param id - The unique identifier of the goal to complete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     completeGoal(id: string, requestId?: string): Promise<Goal>;
+    /**
+     * Marks a previously completed goal as incomplete.
+     *
+     * @param id - The unique identifier of the goal to uncomplete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     uncompleteGoal(id: string, requestId?: string): Promise<Goal>;
+    /**
+     * Links a task to a goal so it contributes to goal progress.
+     *
+     * @param args - The goal ID and task ID to link.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated goal.
+     */
     linkTaskToGoal(args: TaskLinkingArgs, requestId?: string): Promise<Goal>;
+    /**
+     * Unlinks a previously linked task from a goal.
+     *
+     * @param args - The goal ID and task ID to unlink.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
     unlinkTaskFromGoal(args: TaskLinkingArgs, requestId?: string): Promise<boolean>;
     /**
      * Retrieves a list of available backups.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "10.2.0-next.3",
+    "version": "10.2.0",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",
@@ -41,11 +41,14 @@
         "build:fix-dts": "node scripts/fix-dts-imports.cjs",
         "build:post": "echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
         "build": "npm-run-all clean build:cjs build:esm build:fix-esm build:fix-dts build:post",
-        "attw": "npx @arethetypeswrong/cli --pack --ignore-rules fallback-condition false-esm",
+        "attw": "attw --pack --ignore-rules fallback-condition false-esm",
         "integrity-checks": "npm-run-all clean check test build attw",
         "prepublishOnly": "npm run integrity-checks",
         "prepare": "npm run build"
     },
+    "overrides": {
+        "fflate": "0.8.2"
+    },
     "dependencies": {
         "camelcase": "6.3.0",
         "emoji-regex": "10.6.0",
@@ -56,6 +59,7 @@
         "zod": "4.3.6"
     },
     "devDependencies": {
+        "@arethetypeswrong/cli": "0.18.2",
         "@semantic-release/changelog": "6.0.3",
         "@semantic-release/git": "10.0.1",
         "conventional-changelog-conventionalcommits": "9.3.1",