@doist/todoist-sdk 15.3.2 → 15.5.0

package/dist/esm/transport/sync-request.js

@@ -4,8 +4,17 @@ import { DATE_FORMAT_TO_API, TIME_FORMAT_TO_API, DAY_OF_WEEK_TO_API, } from '../
 import { spreadIfDefined } from '../utils/request-helpers.js';
 import { parseSyncResponse } from '../utils/validators.js';
 import { request } from './http-client.js';
+// An invalid Date would otherwise be sent as `null`, which the API reads as "no expiry".
+function serializeStatusActiveUntil(value) {
+    if (!(value instanceof Date))
+        return value;
+    if (Number.isNaN(value.getTime())) {
+        throw new TodoistArgumentError('status.activeUntil is an invalid Date');
+    }
+    return value.toISOString();
+}
 function serializeUserUpdateArgs(args) {
-    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, args), spreadIfDefined(args.dateFormat, (v) => ({
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, args), spreadIfDefined(args.dateFormat, (v) => ({
         dateFormat: DATE_FORMAT_TO_API[v],
     }))), spreadIfDefined(args.timeFormat, (v) => ({
         timeFormat: TIME_FORMAT_TO_API[v],
@@ -13,7 +22,13 @@ function serializeUserUpdateArgs(args) {
         startDay: DAY_OF_WEEK_TO_API[v],
     }))), spreadIfDefined(args.nextWeek, (v) => ({
         nextWeek: DAY_OF_WEEK_TO_API[v],
-    })));
+    }))), (args.status
+        ? {
+            status: Object.assign(Object.assign({}, args.status), spreadIfDefined(args.status.activeUntil, (v) => ({
+                activeUntil: serializeStatusActiveUntil(v),
+            }))),
+        }
+        : {}));
 }
 function serializeTaskUpdateDateCompleteArgs(args) {
     return Object.assign(Object.assign(Object.assign({}, args), { isForward: args.isForward ? 1 : 0 }), spreadIfDefined(args.resetSubtasks, (v) => ({

package/dist/esm/types/activity/types.js

@@ -1,4 +1,24 @@
 import { z } from 'zod';
+/**
+ * Known activity object types, using modern names (`task`, `comment`) rather
+ * than legacy API names (`item`, `note`).
+ */
+export const ACTIVITY_OBJECT_TYPES = ['task', 'comment', 'project'];
+/**
+ * Known activity event types.
+ */
+export const ACTIVITY_EVENT_TYPES = [
+    'added',
+    'updated',
+    'deleted',
+    'completed',
+    'uncompleted',
+    'archived',
+    'unarchived',
+    'shared',
+    'left',
+    'moved',
+];
 /**
  * Flexible object containing event-specific data.
  * Uses z.record to accept any properties for forward compatibility.

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

@@ -1,11 +1,14 @@
 import { z } from 'zod';
 import { WorkspaceRoleSchema } from '../../workspaces/types.js';
+import { UserStatusSchema } from './user-status.js';
 export const CollaboratorSchema = z.looseObject({
     id: z.string(),
     email: z.string(),
     fullName: z.string(),
     timezone: z.string(),
     imageId: z.string().nullable(),
+    /** The collaborator's shared status. Not related to {@link CollaboratorStatus}. */
+    status: UserStatusSchema.nullish(),
 });
 /** Available collaborator statuses. */
 export const COLLABORATOR_STATUSES = ['active', 'invited'];

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

@@ -14,4 +14,5 @@ export * from './live-notifications.js';
 export * from './workspaces.js';
 export * from './user.js';
 export * from './user-settings.js';
+export * from './user-status.js';
 export * from './suggestions.js';

package/dist/esm/types/sync/resources/user-status.js

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+/**
+ * `mode` stays a plain string and `scope` optional so that a new mode, or an effect another
+ * client stored without a scope, does not break parsing.
+ */
+export const UserStatusEffectSchema = z.looseObject({
+    scope: z.looseObject({ mode: z.string() }).optional(),
+});
+export const UserStatusEffectsSchema = z.looseObject({
+    pauseNotifications: UserStatusEffectSchema.optional(),
+    pauseActivity: UserStatusEffectSchema.optional(),
+});
+/**
+ * A user's status, shared across Todoist and Comms. The API returns `null` in its place
+ * when the user has no status or it has expired.
+ */
+export const UserStatusSchema = z.looseObject({
+    message: z.string(),
+    emoji: z.string().nullish(),
+    activeUntil: z.coerce.date().nullish(),
+    effects: UserStatusEffectsSchema.default({}),
+});

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

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { PREMIUM_STATUSES } from '../../users/types.js';
 import { BooleanFromZeroOneSchema, DateFormatSchema, DayOfWeekSchema, TimeFormatSchema, } from '../user-preferences.js';
+import { UserStatusSchema } from './user-status.js';
 export const FeaturesSchema = z.looseObject({
     karmaDisabled: z.union([z.boolean(), BooleanFromZeroOneSchema]),
     restriction: z.number().int(),
@@ -95,6 +96,7 @@ export const SyncUserSchema = z.looseObject({
     sortOrder: z.number().int(),
     startDay: DayOfWeekSchema,
     startPage: z.string(),
+    status: UserStatusSchema.nullish(),
     themeId: z.string(),
     timeFormat: TimeFormatSchema,
     token: z.string().optional(),

package/dist/esm/utils/colors.js

@@ -1,3 +1,4 @@
+import { colorForDisplay } from '@doist/sdk-kmp/shared-todoist-all';
 export const berryRed = {
     key: 'berry_red',
     displayName: 'Berry Red',
@@ -98,6 +99,11 @@ export const taupe = {
     displayName: 'Taupe',
     hexValue: '#ccac93',
 };
+/**
+ * Every color, in the order the apps show them. The keys mirror `TodoistColor` from
+ * `@doist/sdk-kmp/shared-todoist-all`, which a test checks; the display names and hex values are
+ * the SDK's own.
+ */
 export const colors = [
     berryRed,
     red,
@@ -134,6 +140,7 @@ export const defaultColor = charcoal;
  * ```
  */
 export function getColorByKey(colorKey) {
-    const color = colors.find((color) => color.key === colorKey);
-    return color !== null && color !== void 0 ? color : defaultColor;
+    var _a;
+    const { key } = colorForDisplay(colorKey);
+    return (_a = colors.find((color) => color.key === key)) !== null && _a !== void 0 ? _a : defaultColor;
 }

package/dist/types/types/activity/types.d.ts

@@ -1,13 +1,21 @@
 import { z } from 'zod';
+/**
+ * Known activity object types, using modern names (`task`, `comment`) rather
+ * than legacy API names (`item`, `note`).
+ */
+export declare const ACTIVITY_OBJECT_TYPES: readonly ["task", "comment", "project"];
+/**
+ * Known activity event types.
+ */
+export declare const ACTIVITY_EVENT_TYPES: readonly ["added", "updated", "deleted", "completed", "uncompleted", "archived", "unarchived", "shared", "left", "moved"];
 /**
  * Type hints for known object types. Accepts any string for forward compatibility.
  */
-export type ActivityObjectType = 'task' | 'comment' | 'project' | (string & Record<string, never>);
+export type ActivityObjectType = (typeof ACTIVITY_OBJECT_TYPES)[number] | (string & Record<string, never>);
 /**
  * Type hints for known event types. Accepts any string for forward compatibility.
  */
-export type ActivityEventType = 'added' | 'updated' | 'deleted' | 'completed' | 'uncompleted' | 'archived' | 'unarchived' | 'shared' | 'left' | (string & Record<string, never>);
-type ModernActivityObjectType = 'task' | 'comment' | 'project' | (string & Record<string, never>);
+export type ActivityEventType = (typeof ACTIVITY_EVENT_TYPES)[number] | (string & Record<string, never>);
 /**
  * Combined object:event filter string for the `objectEventTypes` parameter of `getActivityLogs`.
  *
@@ -21,7 +29,7 @@ type ModernActivityObjectType = 'task' | 'comment' | 'project' | (string & Recor
  * to be passed for forward compatibility, while still providing autocomplete for
  * the known combinations above.
  */
-export type ActivityObjectEventType = `${ModernActivityObjectType}:${ActivityEventType}` | `${ModernActivityObjectType}:` | `:${ActivityEventType}` | (string & Record<string, never>);
+export type ActivityObjectEventType = `${ActivityObjectType}:${ActivityEventType}` | `${ActivityObjectType}:` | `:${ActivityEventType}` | (string & Record<string, never>);
 /**
  * Flexible object containing event-specific data.
  * Uses z.record to accept any properties for forward compatibility.
@@ -46,4 +54,3 @@ export declare const ActivityEventSchema: z.ZodObject<{
  * Represents an activity log event in Todoist.
  */
 export type ActivityEvent = z.infer<typeof ActivityEventSchema>;
-export {};

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

@@ -1,4 +1,20 @@
 import type { DateFormat, DayOfWeek, TimeFormat } from '../user-preferences.js';
+export type UserStatusEffectArgs = {
+    scope?: {
+        mode: string;
+    };
+};
+/** The complete status to set. It replaces any existing status. */
+export type UserStatusArgs = {
+    message: string;
+    emoji?: string;
+    /** Must be in the future; omit it for no expiry. A `Date` is sent as an ISO 8601 string. */
+    activeUntil?: Date | string;
+    effects?: {
+        pauseNotifications?: UserStatusEffectArgs;
+        pauseActivity?: UserStatusEffectArgs;
+    };
+};
 export type UserUpdateArgs = {
     fullName?: string;
     autoReminder?: number;
@@ -9,6 +25,8 @@ export type UserUpdateArgs = {
     themeId?: string;
     timeFormat?: TimeFormat;
     timezone?: string;
+    /** `null` clears the status; omitting it leaves the current status unchanged. */
+    status?: UserStatusArgs | null;
 };
 export type DeleteCollaboratorArgs = {
     projectId: string;

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

@@ -5,6 +5,24 @@ export declare const CollaboratorSchema: z.ZodObject<{
     fullName: z.ZodString;
     timezone: z.ZodString;
     imageId: z.ZodNullable<z.ZodString>;
+    /** The collaborator's shared status. Not related to {@link CollaboratorStatus}. */
+    status: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        message: z.ZodString;
+        emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        activeUntil: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
+        effects: z.ZodDefault<z.ZodObject<{
+            pauseNotifications: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodString;
+                }, z.core.$loose>>;
+            }, z.core.$loose>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodString;
+                }, z.core.$loose>>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>>;
 }, z.core.$loose>;
 export type Collaborator = z.infer<typeof CollaboratorSchema>;
 /** Available collaborator statuses. */

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

@@ -14,4 +14,5 @@ export * from './live-notifications.js';
 export * from './workspaces.js';
 export * from './user.js';
 export * from './user-settings.js';
+export * from './user-status.js';
 export * from './suggestions.js';

package/dist/types/types/sync/resources/user-status.d.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+/**
+ * `mode` stays a plain string and `scope` optional so that a new mode, or an effect another
+ * client stored without a scope, does not break parsing.
+ */
+export declare const UserStatusEffectSchema: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodObject<{
+        mode: z.ZodString;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+export type UserStatusEffect = z.infer<typeof UserStatusEffectSchema>;
+export declare const UserStatusEffectsSchema: z.ZodObject<{
+    pauseNotifications: z.ZodOptional<z.ZodObject<{
+        scope: z.ZodOptional<z.ZodObject<{
+            mode: z.ZodString;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    pauseActivity: z.ZodOptional<z.ZodObject<{
+        scope: z.ZodOptional<z.ZodObject<{
+            mode: z.ZodString;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+export type UserStatusEffects = z.infer<typeof UserStatusEffectsSchema>;
+/**
+ * A user's status, shared across Todoist and Comms. The API returns `null` in its place
+ * when the user has no status or it has expired.
+ */
+export declare const UserStatusSchema: z.ZodObject<{
+    message: z.ZodString;
+    emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    activeUntil: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
+    effects: z.ZodDefault<z.ZodObject<{
+        pauseNotifications: z.ZodOptional<z.ZodObject<{
+            scope: z.ZodOptional<z.ZodObject<{
+                mode: z.ZodString;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>;
+        pauseActivity: z.ZodOptional<z.ZodObject<{
+            scope: z.ZodOptional<z.ZodObject<{
+                mode: z.ZodString;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+export type UserStatus = z.infer<typeof UserStatusSchema>;

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

@@ -115,6 +115,23 @@ export declare const SyncUserSchema: z.ZodObject<{
     sortOrder: z.ZodNumber;
     startDay: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<6>, z.ZodLiteral<7>]>, z.ZodTransform<"Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday", 3 | 2 | 1 | 7 | 4 | 5 | 6>>;
     startPage: z.ZodString;
+    status: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        message: z.ZodString;
+        emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        activeUntil: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
+        effects: z.ZodDefault<z.ZodObject<{
+            pauseNotifications: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodString;
+                }, z.core.$loose>>;
+            }, z.core.$loose>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodString;
+                }, z.core.$loose>>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>>;
     themeId: z.ZodString;
     timeFormat: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>, z.ZodTransform<"24h" | "12h", 0 | 1>>;
     token: z.ZodOptional<z.ZodString>;

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

@@ -448,6 +448,23 @@ export declare const SyncResponseSchema: z.ZodObject<{
         sortOrder: z.ZodNumber;
         startDay: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<6>, z.ZodLiteral<7>]>, z.ZodTransform<"Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday", 3 | 2 | 1 | 7 | 4 | 5 | 6>>;
         startPage: z.ZodString;
+        status: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            message: z.ZodString;
+            emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            activeUntil: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
+            effects: z.ZodDefault<z.ZodObject<{
+                pauseNotifications: z.ZodOptional<z.ZodObject<{
+                    scope: z.ZodOptional<z.ZodObject<{
+                        mode: z.ZodString;
+                    }, z.core.$loose>>;
+                }, z.core.$loose>>;
+                pauseActivity: z.ZodOptional<z.ZodObject<{
+                    scope: z.ZodOptional<z.ZodObject<{
+                        mode: z.ZodString;
+                    }, z.core.$loose>>;
+                }, z.core.$loose>>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>>;
         themeId: z.ZodString;
         timeFormat: z.ZodPipe<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>, z.ZodTransform<"24h" | "12h", 0 | 1>>;
         token: z.ZodOptional<z.ZodString>;
@@ -492,6 +509,23 @@ export declare const SyncResponseSchema: z.ZodObject<{
         fullName: z.ZodString;
         timezone: z.ZodString;
         imageId: z.ZodNullable<z.ZodString>;
+        status: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            message: z.ZodString;
+            emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            activeUntil: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
+            effects: z.ZodDefault<z.ZodObject<{
+                pauseNotifications: z.ZodOptional<z.ZodObject<{
+                    scope: z.ZodOptional<z.ZodObject<{
+                        mode: z.ZodString;
+                    }, z.core.$loose>>;
+                }, z.core.$loose>>;
+                pauseActivity: z.ZodOptional<z.ZodObject<{
+                    scope: z.ZodOptional<z.ZodObject<{
+                        mode: z.ZodString;
+                    }, z.core.$loose>>;
+                }, z.core.$loose>>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>>;
     }, z.core.$loose>>>;
     collaboratorStates: z.ZodOptional<z.ZodArray<z.ZodObject<{
         userId: z.ZodString;

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

@@ -99,6 +99,11 @@ export declare const taupe: {
     readonly displayName: "Taupe";
     readonly hexValue: "#ccac93";
 };
+/**
+ * Every color, in the order the apps show them. The keys mirror `TodoistColor` from
+ * `@doist/sdk-kmp/shared-todoist-all`, which a test checks; the display names and hex values are
+ * the SDK's own.
+ */
 export declare const colors: readonly [{
     readonly key: "berry_red";
     readonly displayName: "Berry Red";

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

@@ -772,6 +772,29 @@ export declare const validateCollaborator: (input: unknown) => {
     fullName: string;
     timezone: string;
     imageId: string | null;
+    status?: {
+        [x: string]: unknown;
+        message: string;
+        effects: {
+            [x: string]: unknown;
+            pauseNotifications?: {
+                [x: string]: unknown;
+                scope?: {
+                    [x: string]: unknown;
+                    mode: string;
+                } | undefined;
+            } | undefined;
+            pauseActivity?: {
+                [x: string]: unknown;
+                scope?: {
+                    [x: string]: unknown;
+                    mode: string;
+                } | undefined;
+            } | undefined;
+        };
+        emoji?: string | null | undefined;
+        activeUntil?: Date | null | undefined;
+    } | null | undefined;
 }, validateCollaboratorArray: (input: unknown) => {
     [x: string]: unknown;
     id: string;
@@ -779,6 +802,29 @@ export declare const validateCollaborator: (input: unknown) => {
     fullName: string;
     timezone: string;
     imageId: string | null;
+    status?: {
+        [x: string]: unknown;
+        message: string;
+        effects: {
+            [x: string]: unknown;
+            pauseNotifications?: {
+                [x: string]: unknown;
+                scope?: {
+                    [x: string]: unknown;
+                    mode: string;
+                } | undefined;
+            } | undefined;
+            pauseActivity?: {
+                [x: string]: unknown;
+                scope?: {
+                    [x: string]: unknown;
+                    mode: string;
+                } | undefined;
+            } | undefined;
+        };
+        emoji?: string | null | undefined;
+        activeUntil?: Date | null | undefined;
+    } | null | undefined;
 }[];
 export declare const validateCollaboratorState: (input: unknown) => {
     [x: string]: unknown;
@@ -1472,6 +1518,29 @@ export declare const validateSyncUser: (input: unknown) => {
         remaining: number;
         resetDate: Date;
     } | null | undefined;
+    status?: {
+        [x: string]: unknown;
+        message: string;
+        effects: {
+            [x: string]: unknown;
+            pauseNotifications?: {
+                [x: string]: unknown;
+                scope?: {
+                    [x: string]: unknown;
+                    mode: string;
+                } | undefined;
+            } | undefined;
+            pauseActivity?: {
+                [x: string]: unknown;
+                scope?: {
+                    [x: string]: unknown;
+                    mode: string;
+                } | undefined;
+            } | undefined;
+        };
+        emoji?: string | null | undefined;
+        activeUntil?: Date | null | undefined;
+    } | null | undefined;
     token?: string | undefined;
 };
 export declare const validateUserSettings: (input: unknown) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "15.3.2",
+    "version": "15.5.0",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",
@@ -46,7 +46,7 @@
         "fflate": "0.8.2"
     },
     "dependencies": {
-        "@doist/sdk-kmp": "0.2.3",
+        "@doist/sdk-kmp": "0.5.0",
         "camelcase": "6.3.0",
         "emoji-regex": "10.6.0",
         "ts-custom-error": "^3.2.0",