@doist/todoist-sdk 8.3.0 → 8.4.0-next.1

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

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

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

@@ -27,6 +27,7 @@ __exportStar(require("./workspaces"), exports);
 __exportStar(require("./folders"), exports);
 __exportStar(require("./workspace-filters"), exports);
 __exportStar(require("./workspace-goals"), exports);
+__exportStar(require("./goals"), exports);
 __exportStar(require("./notifications"), exports);
 __exportStar(require("./sharing"), exports);
 __exportStar(require("./view-options"), exports);

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

@@ -32,6 +32,7 @@ exports.SYNC_RESOURCE_TYPES = [
     'role_actions',
     'folders',
     'workspace_goals',
+    'goals',
     'day_orders',
     'calendars',
     'calendar_accounts',

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoalSchema = exports.GoalProgressSchema = exports.GOAL_OWNER_TYPES = void 0;
+const zod_1 = require("zod");
+/** Available goal owner types. */
+exports.GOAL_OWNER_TYPES = ['USER', 'WORKSPACE'];
+exports.GoalProgressSchema = zod_1.z
+    .object({
+    totalItemCount: zod_1.z.number().int(),
+    completedItemCount: zod_1.z.number().int(),
+    percentage: zod_1.z.number(),
+})
+    .passthrough();
+exports.GoalSchema = zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    ownerType: zod_1.z.enum(exports.GOAL_OWNER_TYPES),
+    ownerId: zod_1.z.string(),
+    name: zod_1.z.string(),
+    description: zod_1.z.string().nullable(),
+    deadline: zod_1.z.string().nullable(),
+    parentGoalId: zod_1.z.string().nullable(),
+    childOrder: zod_1.z.number().int(),
+    isCompleted: zod_1.z.boolean(),
+    completedAt: zod_1.z.coerce.date().nullable(),
+    responsibleUid: zod_1.z.string().nullable(),
+    isDeleted: zod_1.z.boolean(),
+    progress: exports.GoalProgressSchema.optional(),
+    creatorUid: zod_1.z.string(),
+    createdAt: zod_1.z.coerce.date(),
+    updatedAt: zod_1.z.coerce.date(),
+})
+    .passthrough();

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

@@ -21,6 +21,7 @@ __exportStar(require("./tooltips"), exports);
 __exportStar(require("./notes"), exports);
 __exportStar(require("./workspace-filters"), exports);
 __exportStar(require("./workspace-goals"), exports);
+__exportStar(require("./goals"), exports);
 __exportStar(require("./calendars"), exports);
 __exportStar(require("./reminders"), exports);
 __exportStar(require("./completed-info"), exports);

package/dist/cjs/utils/validators.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validateFolderArray = exports.validateFolder = exports.validateCollaboratorStateArray = exports.validateCollaboratorState = exports.validateCollaboratorArray = exports.validateCollaborator = exports.validateFilterArray = exports.validateFilter = exports.validateMovedIdArray = exports.validateMovedId = exports.validateIdMappingArray = exports.validateIdMapping = exports.validateBackupArray = exports.validateBackup = exports.validateWorkspaceInsights = exports.validateProjectProgress = exports.validateProjectHealthContext = exports.validateProjectHealth = exports.validateProjectActivityStats = exports.validateWorkspaceUserTaskArray = exports.validateWorkspaceUserTask = exports.validateMemberActivityInfoArray = exports.validateMemberActivityInfo = exports.validateWorkspaceArray = exports.validateWorkspace = exports.validateJoinWorkspaceResult = exports.validateWorkspacePlanDetails = exports.validateWorkspaceInvitationArray = exports.validateWorkspaceInvitation = exports.validateWorkspaceUser = exports.validateAttachment = exports.validateActivityEventArray = exports.validateActivityEvent = exports.validateCurrentUser = exports.validateProductivityStats = exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateWorkspaceProjectArray = exports.validateWorkspaceProject = exports.validateTaskArray = exports.validateTask = void 0;
-exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = void 0;
+exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateGoalArray = exports.validateGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = void 0;
 exports.isWorkspaceProject = isWorkspaceProject;
 exports.isPersonalProject = isPersonalProject;
 exports.validateProject = validateProject;
@@ -125,6 +125,8 @@ exports.validateNoteArray = createArrayValidator(exports.validateNote);
 exports.validateTooltips = createValidator(resources_1.TooltipsSchema);
 exports.validateWorkspaceFilter = createValidator(resources_1.WorkspaceFilterSchema);
 exports.validateWorkspaceFilterArray = createArrayValidator(exports.validateWorkspaceFilter);
+exports.validateGoal = createValidator(resources_1.GoalSchema);
+exports.validateGoalArray = createArrayValidator(exports.validateGoal);
 exports.validateWorkspaceGoal = createValidator(resources_1.WorkspaceGoalSchema);
 exports.validateWorkspaceGoalArray = createArrayValidator(exports.validateWorkspaceGoal);
 exports.validateCalendar = createValidator(resources_1.CalendarSchema);
@@ -151,7 +153,7 @@ exports.validateUserSettings = createValidator(resources_1.UserSettingsSchema);
 exports.validateSuggestion = createValidator(resources_1.SuggestionSchema);
 exports.validateSuggestionArray = createArrayValidator(exports.validateSuggestion);
 function parseSyncResponse(raw) {
-    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, raw), ('items' in raw ? { items: (0, exports.validateTaskArray)(raw.items) } : {})), ('projects' in raw ? { projects: validateProjectArray(raw.projects) } : {})), ('sections' in raw ? { sections: (0, exports.validateSectionArray)(raw.sections) } : {})), ('labels' in raw ? { labels: (0, exports.validateLabelArray)(raw.labels) } : {})), ('notes' in raw ? { notes: (0, exports.validateNoteArray)(raw.notes) } : {})), ('projectNotes' in raw ? { projectNotes: (0, exports.validateNoteArray)(raw.projectNotes) } : {})), ('filters' in raw ? { filters: (0, exports.validateFilterArray)(raw.filters) } : {})), ('reminders' in raw ? { reminders: (0, exports.validateReminderArray)(raw.reminders) } : {})), ('remindersLocation' in raw
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, raw), ('items' in raw ? { items: (0, exports.validateTaskArray)(raw.items) } : {})), ('projects' in raw ? { projects: validateProjectArray(raw.projects) } : {})), ('sections' in raw ? { sections: (0, exports.validateSectionArray)(raw.sections) } : {})), ('labels' in raw ? { labels: (0, exports.validateLabelArray)(raw.labels) } : {})), ('notes' in raw ? { notes: (0, exports.validateNoteArray)(raw.notes) } : {})), ('projectNotes' in raw ? { projectNotes: (0, exports.validateNoteArray)(raw.projectNotes) } : {})), ('filters' in raw ? { filters: (0, exports.validateFilterArray)(raw.filters) } : {})), ('reminders' in raw ? { reminders: (0, exports.validateReminderArray)(raw.reminders) } : {})), ('remindersLocation' in raw
         ? { remindersLocation: (0, exports.validateLocationReminderArray)(raw.remindersLocation) }
         : {})), ('user' in raw ? { user: (0, exports.validateSyncUser)(raw.user) } : {})), ('liveNotifications' in raw
         ? { liveNotifications: (0, exports.validateLiveNotificationArray)(raw.liveNotifications) }
@@ -171,7 +173,7 @@ function parseSyncResponse(raw) {
         ? {
             projectViewOptionsDefaults: (0, exports.validateProjectViewOptionsDefaultsArray)(raw.projectViewOptionsDefaults),
         }
-        : {})), ('folders' in raw ? { folders: (0, exports.validateFolderArray)(raw.folders) } : {})), ('workspaceGoals' in raw
+        : {})), ('folders' in raw ? { folders: (0, exports.validateFolderArray)(raw.folders) } : {})), ('goals' in raw ? { goals: (0, exports.validateGoalArray)(raw.goals) } : {})), ('workspaceGoals' in raw
         ? { workspaceGoals: (0, exports.validateWorkspaceGoalArray)(raw.workspaceGoals) }
         : {})), ('calendars' in raw ? { calendars: (0, exports.validateCalendarArray)(raw.calendars) } : {})), ('calendarAccounts' in raw
         ? { calendarAccounts: (0, exports.validateCalendarAccountArray)(raw.calendarAccounts) }

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/resources/goals.js

@@ -0,0 +1,30 @@
+import { z } from 'zod';
+/** Available goal owner types. */
+export const GOAL_OWNER_TYPES = ['USER', 'WORKSPACE'];
+export const GoalProgressSchema = z
+    .object({
+    totalItemCount: z.number().int(),
+    completedItemCount: z.number().int(),
+    percentage: z.number(),
+})
+    .passthrough();
+export const GoalSchema = z
+    .object({
+    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(),
+})
+    .passthrough();

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

@@ -5,6 +5,7 @@ export * from './tooltips.js';
 export * from './notes.js';
 export * from './workspace-filters.js';
 export * from './workspace-goals.js';
+export * from './goals.js';
 export * from './calendars.js';
 export * from './reminders.js';
 export * from './completed-info.js';

package/dist/esm/utils/validators.js

@@ -10,7 +10,7 @@ import { SectionSchema } from '../types/sections/types.js';
 import { TaskSchema } from '../types/tasks/types.js';
 import { UserSchema, CurrentUserSchema } from '../types/users/types.js';
 import { WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, WorkspaceSchema, MemberActivityInfoSchema, WorkspaceUserTaskSchema, } from '../types/workspaces/types.js';
-import { FilterSchema, CollaboratorSchema, CollaboratorStateSchema, FolderSchema, NoteSchema, TooltipsSchema, WorkspaceFilterSchema, WorkspaceGoalSchema, CalendarSchema, CalendarAccountSchema, ReminderSchema, LocationReminderSchema, CompletedInfoSchema, ViewOptionsSchema, ProjectViewOptionsDefaultsSchema, UserPlanLimitsSchema, LiveNotificationSchema, SyncWorkspaceSchema, SyncUserSchema, UserSettingsSchema, SuggestionSchema, } from '../types/sync/resources/index.js';
+import { FilterSchema, CollaboratorSchema, CollaboratorStateSchema, FolderSchema, NoteSchema, TooltipsSchema, WorkspaceFilterSchema, GoalSchema, WorkspaceGoalSchema, CalendarSchema, CalendarAccountSchema, ReminderSchema, LocationReminderSchema, CompletedInfoSchema, ViewOptionsSchema, ProjectViewOptionsDefaultsSchema, UserPlanLimitsSchema, LiveNotificationSchema, SyncWorkspaceSchema, SyncUserSchema, UserSettingsSchema, SuggestionSchema, } from '../types/sync/resources/index.js';
 function createValidator(schema) {
     return (input) => schema.parse(input);
 }
@@ -115,6 +115,8 @@ export const validateNoteArray = createArrayValidator(validateNote);
 export const validateTooltips = createValidator(TooltipsSchema);
 export const validateWorkspaceFilter = createValidator(WorkspaceFilterSchema);
 export const validateWorkspaceFilterArray = createArrayValidator(validateWorkspaceFilter);
+export const validateGoal = createValidator(GoalSchema);
+export const validateGoalArray = createArrayValidator(validateGoal);
 export const validateWorkspaceGoal = createValidator(WorkspaceGoalSchema);
 export const validateWorkspaceGoalArray = createArrayValidator(validateWorkspaceGoal);
 export const validateCalendar = createValidator(CalendarSchema);
@@ -141,7 +143,7 @@ export const validateUserSettings = createValidator(UserSettingsSchema);
 export const validateSuggestion = createValidator(SuggestionSchema);
 export const validateSuggestionArray = createArrayValidator(validateSuggestion);
 export function parseSyncResponse(raw) {
-    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, raw), ('items' in raw ? { items: validateTaskArray(raw.items) } : {})), ('projects' in raw ? { projects: validateProjectArray(raw.projects) } : {})), ('sections' in raw ? { sections: validateSectionArray(raw.sections) } : {})), ('labels' in raw ? { labels: validateLabelArray(raw.labels) } : {})), ('notes' in raw ? { notes: validateNoteArray(raw.notes) } : {})), ('projectNotes' in raw ? { projectNotes: validateNoteArray(raw.projectNotes) } : {})), ('filters' in raw ? { filters: validateFilterArray(raw.filters) } : {})), ('reminders' in raw ? { reminders: validateReminderArray(raw.reminders) } : {})), ('remindersLocation' in raw
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, raw), ('items' in raw ? { items: validateTaskArray(raw.items) } : {})), ('projects' in raw ? { projects: validateProjectArray(raw.projects) } : {})), ('sections' in raw ? { sections: validateSectionArray(raw.sections) } : {})), ('labels' in raw ? { labels: validateLabelArray(raw.labels) } : {})), ('notes' in raw ? { notes: validateNoteArray(raw.notes) } : {})), ('projectNotes' in raw ? { projectNotes: validateNoteArray(raw.projectNotes) } : {})), ('filters' in raw ? { filters: validateFilterArray(raw.filters) } : {})), ('reminders' in raw ? { reminders: validateReminderArray(raw.reminders) } : {})), ('remindersLocation' in raw
         ? { remindersLocation: validateLocationReminderArray(raw.remindersLocation) }
         : {})), ('user' in raw ? { user: validateSyncUser(raw.user) } : {})), ('liveNotifications' in raw
         ? { liveNotifications: validateLiveNotificationArray(raw.liveNotifications) }
@@ -161,7 +163,7 @@ export function parseSyncResponse(raw) {
         ? {
             projectViewOptionsDefaults: validateProjectViewOptionsDefaultsArray(raw.projectViewOptionsDefaults),
         }
-        : {})), ('folders' in raw ? { folders: validateFolderArray(raw.folders) } : {})), ('workspaceGoals' in raw
+        : {})), ('folders' in raw ? { folders: validateFolderArray(raw.folders) } : {})), ('goals' in raw ? { goals: validateGoalArray(raw.goals) } : {})), ('workspaceGoals' in raw
         ? { workspaceGoals: validateWorkspaceGoalArray(raw.workspaceGoals) }
         : {})), ('calendars' in raw ? { calendars: validateCalendarArray(raw.calendars) } : {})), ('calendarAccounts' in raw
         ? { calendarAccounts: validateCalendarAccountArray(raw.calendarAccounts) }

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

@@ -0,0 +1,33 @@
+import type { GoalOwnerType } from '../resources/goals.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];

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

@@ -0,0 +1,37 @@
+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];
+export declare const GoalProgressSchema: z.ZodObject<{
+    totalItemCount: z.ZodNumber;
+    completedItemCount: 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.ZodObject<{
+        totalItemCount: z.ZodNumber;
+        completedItemCount: z.ZodNumber;
+        percentage: z.ZodNumber;
+    }, z.core.$loose>>;
+    creatorUid: z.ZodString;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+}, z.core.$loose>;
+export type Goal = z.infer<typeof GoalSchema>;

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

@@ -5,6 +5,7 @@ export * from './tooltips.js';
 export * from './notes.js';
 export * from './workspace-filters.js';
 export * from './workspace-goals.js';
+export * from './goals.js';
 export * from './calendars.js';
 export * from './reminders.js';
 export * from './completed-info.js';

package/dist/types/types/sync/resources/view-options.d.ts

@@ -33,13 +33,13 @@ export declare const GROUPED_BY_OPTIONS: readonly ["ASSIGNEE", "ADDED_DATE", "DU
 export type GroupedBy = (typeof GROUPED_BY_OPTIONS)[number];
 export declare const GroupedBySchema: z.ZodNullable<z.ZodEnum<{
     PROJECT: "PROJECT";
+    WORKSPACE: "WORKSPACE";
     LABEL: "LABEL";
     ASSIGNEE: "ASSIGNEE";
     ADDED_DATE: "ADDED_DATE";
     DUE_DATE: "DUE_DATE";
     DEADLINE: "DEADLINE";
     PRIORITY: "PRIORITY";
-    WORKSPACE: "WORKSPACE";
 }>>;
 /** Available sorting options. */
 export declare const SORTED_BY_OPTIONS: readonly ["MANUAL", "ALPHABETICALLY", "ASSIGNEE", "DUE_DATE", "DEADLINE", "ADDED_DATE", "PRIORITY", "PROJECT", "WORKSPACE"];
@@ -47,12 +47,12 @@ export declare const SORTED_BY_OPTIONS: readonly ["MANUAL", "ALPHABETICALLY", "A
 export type SortedBy = (typeof SORTED_BY_OPTIONS)[number];
 export declare const SortedBySchema: z.ZodNullable<z.ZodEnum<{
     PROJECT: "PROJECT";
+    WORKSPACE: "WORKSPACE";
     ASSIGNEE: "ASSIGNEE";
     ADDED_DATE: "ADDED_DATE";
     DUE_DATE: "DUE_DATE";
     DEADLINE: "DEADLINE";
     PRIORITY: "PRIORITY";
-    WORKSPACE: "WORKSPACE";
     MANUAL: "MANUAL";
     ALPHABETICALLY: "ALPHABETICALLY";
 }>>;
@@ -93,13 +93,13 @@ export declare const ViewOptionsSchema: z.ZodObject<{
     objectId: z.ZodOptional<z.ZodString>;
     groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         PROJECT: "PROJECT";
+        WORKSPACE: "WORKSPACE";
         LABEL: "LABEL";
         ASSIGNEE: "ASSIGNEE";
         ADDED_DATE: "ADDED_DATE";
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
     }>>>;
     filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     viewMode: z.ZodOptional<z.ZodEnum<{
@@ -110,12 +110,12 @@ export declare const ViewOptionsSchema: z.ZodObject<{
     showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
     sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         PROJECT: "PROJECT";
+        WORKSPACE: "WORKSPACE";
         ASSIGNEE: "ASSIGNEE";
         ADDED_DATE: "ADDED_DATE";
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
         MANUAL: "MANUAL";
         ALPHABETICALLY: "ALPHABETICALLY";
     }>>>;
@@ -134,22 +134,22 @@ export declare const ProjectViewOptionsDefaultsSchema: z.ZodObject<{
     }>>>;
     groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         PROJECT: "PROJECT";
+        WORKSPACE: "WORKSPACE";
         LABEL: "LABEL";
         ASSIGNEE: "ASSIGNEE";
         ADDED_DATE: "ADDED_DATE";
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
     }>>>;
     sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         PROJECT: "PROJECT";
+        WORKSPACE: "WORKSPACE";
         ASSIGNEE: "ASSIGNEE";
         ADDED_DATE: "ADDED_DATE";
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
         MANUAL: "MANUAL";
         ALPHABETICALLY: "ALPHABETICALLY";
     }>>>;

package/dist/types/types/sync/response.d.ts

@@ -3,7 +3,7 @@ import type { PersonalProject, WorkspaceProject } from '../projects/types.js';
 import type { Section } from '../sections/types.js';
 import type { Task } from '../tasks/types.js';
 import type { WorkspaceUser } from '../workspaces/types.js';
-import type { Filter, Collaborator, CollaboratorState, Folder, Note, Tooltips, WorkspaceFilter, WorkspaceGoal, Calendar, CalendarAccount, Reminder, CompletedInfo, ViewOptions, ProjectViewOptionsDefaults, UserPlanLimits, LiveNotification, SyncWorkspace, SyncUser, UserSettings, LocationReminder, Suggestion } from './resources/index.js';
+import type { Filter, Collaborator, CollaboratorState, Folder, Note, Tooltips, WorkspaceFilter, WorkspaceGoal, Goal, Calendar, CalendarAccount, Reminder, CompletedInfo, ViewOptions, ProjectViewOptionsDefaults, UserPlanLimits, LiveNotification, SyncWorkspace, SyncUser, UserSettings, LocationReminder, Suggestion } from './resources/index.js';
 export type SyncError = {
     error: string;
     errorCode: number;
@@ -43,6 +43,7 @@ export type SyncResponse = {
     roleActions?: Record<string, unknown>[];
     folders?: Folder[];
     workspaceGoals?: WorkspaceGoal[];
+    goals?: Goal[];
     dayOrders?: Record<string, number>;
     calendars?: Calendar[];
     calendarAccounts?: CalendarAccount[];

package/dist/types/utils/validators.d.ts

@@ -834,6 +834,54 @@ export declare const validateWorkspaceFilterArray: (input: unknown) => {
     createdAt: string;
     updatedAt: string;
 }[];
+export declare const validateGoal: (input: unknown) => {
+    [x: string]: unknown;
+    id: string;
+    ownerType: "USER" | "WORKSPACE";
+    ownerId: string;
+    name: string;
+    description: string | null;
+    deadline: string | null;
+    parentGoalId: string | null;
+    childOrder: number;
+    isCompleted: boolean;
+    completedAt: Date | null;
+    responsibleUid: string | null;
+    isDeleted: boolean;
+    creatorUid: string;
+    createdAt: Date;
+    updatedAt: Date;
+    progress?: {
+        [x: string]: unknown;
+        totalItemCount: number;
+        completedItemCount: number;
+        percentage: number;
+    } | undefined;
+};
+export declare const validateGoalArray: (input: unknown) => {
+    [x: string]: unknown;
+    id: string;
+    ownerType: "USER" | "WORKSPACE";
+    ownerId: string;
+    name: string;
+    description: string | null;
+    deadline: string | null;
+    parentGoalId: string | null;
+    childOrder: number;
+    isCompleted: boolean;
+    completedAt: Date | null;
+    responsibleUid: string | null;
+    isDeleted: boolean;
+    creatorUid: string;
+    createdAt: Date;
+    updatedAt: Date;
+    progress?: {
+        [x: string]: unknown;
+        totalItemCount: number;
+        completedItemCount: number;
+        percentage: number;
+    } | undefined;
+}[];
 export declare const validateWorkspaceGoal: (input: unknown) => {
     [x: string]: unknown;
     id: string;
@@ -1074,30 +1122,30 @@ export declare const validateViewOptions: (input: unknown) => {
     [x: string]: unknown;
     viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
     objectId?: string | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
+    groupedBy?: "PROJECT" | "WORKSPACE" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
     filteredBy?: string | null | undefined;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | undefined;
     showCompletedTasks?: boolean | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    sortedBy?: "PROJECT" | "WORKSPACE" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
 };
 export declare const validateViewOptionsArray: (input: unknown) => {
     [x: string]: unknown;
     viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
     objectId?: string | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
+    groupedBy?: "PROJECT" | "WORKSPACE" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
     filteredBy?: string | null | undefined;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | undefined;
     showCompletedTasks?: boolean | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    sortedBy?: "PROJECT" | "WORKSPACE" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
 }[];
 export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
     [x: string]: unknown;
     projectId: string;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    groupedBy?: "PROJECT" | "WORKSPACE" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
+    sortedBy?: "PROJECT" | "WORKSPACE" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
     showCompletedTasks?: boolean | undefined;
     filteredBy?: string | null | undefined;
@@ -1110,8 +1158,8 @@ export declare const validateProjectViewOptionsDefaultsArray: (input: unknown) =
     [x: string]: unknown;
     projectId: string;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    groupedBy?: "PROJECT" | "WORKSPACE" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
+    sortedBy?: "PROJECT" | "WORKSPACE" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
     showCompletedTasks?: boolean | undefined;
     filteredBy?: string | null | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "8.3.0",
+    "version": "8.4.0-next.1",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",