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

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

@@ -1,141 +0,0 @@
-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/types/goals/index.js

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

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

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

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

@@ -1,53 +0,0 @@
-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/sync/commands/goals.js

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

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

@@ -1,20 +0,0 @@
-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/types/goals/index.d.ts

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

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

@@ -1,33 +0,0 @@
-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

@@ -1,51 +0,0 @@
-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/sync/commands/goals.d.ts

@@ -1,33 +0,0 @@
-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;
-};