@doist/comms-sdk 3.4.1 → 3.5.0

package/dist/esm/types/entities.js

@@ -49,6 +49,10 @@ export const AttachmentSchema = z.object(attachmentShape).loose();
 // this strips unknown keys so caller typos / off-spec fields are dropped instead
 // of being forwarded on the wire. Use this for `*Args` request schemas.
 export const RequestAttachmentSchema = z.object(attachmentShape);
+// Clients that don't model `scope` can store `{}`, and the backend omits unset fields.
+export const StatusEffectSchema = z.object({
+    scope: z.object({ mode: z.string().optional() }).optional(),
+});
 // Shared user status. It lives on the Todoist account, so Comms, Todoist and
 // automations all see the same one. `activeUntil` is an RFC 3339 string, and an
 // expired status is returned as `null` rather than as an expired object.
@@ -58,10 +62,8 @@ export const UserStatusSchema = z.object({
     activeUntil: z.string().nullable().optional(),
     effects: z
         .object({
-        // Clients that don't model `scope` can store `{}`, and the backend omits unset fields.
-        pauseNotifications: z
-            .object({ scope: z.object({ mode: z.string().optional() }).optional() })
-            .optional(),
+        pauseNotifications: StatusEffectSchema.optional(),
+        pauseActivity: StatusEffectSchema.optional(),
     })
         .optional(),
 });

package/dist/types/types/entities.d.ts

@@ -54,6 +54,11 @@ export declare const RequestAttachmentSchema: z.ZodObject<{
     videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>;
 export type RequestAttachment = z.infer<typeof RequestAttachmentSchema>;
+export declare const StatusEffectSchema: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodObject<{
+        mode: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const UserStatusSchema: z.ZodObject<{
     message: z.ZodString;
     emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -64,6 +69,11 @@ export declare const UserStatusSchema: z.ZodObject<{
                 mode: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
+        pauseActivity: z.ZodOptional<z.ZodObject<{
+            scope: z.ZodOptional<z.ZodObject<{
+                mode: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type UserStatus = z.infer<typeof UserStatusSchema>;
@@ -93,6 +103,11 @@ export declare const BaseUserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
@@ -122,6 +137,11 @@ export declare const UserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     email: z.ZodEmail;
@@ -1638,6 +1658,11 @@ export declare const WorkspaceUserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1663,6 +1688,11 @@ export declare const RestrictedWorkspaceUserSchema: z.ZodObject<{
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     id: z.ZodNumber;
@@ -1708,6 +1738,11 @@ export declare const VisibleWorkspaceUserSchema: z.ZodUnion<readonly [z.ZodObjec
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1731,6 +1766,11 @@ export declare const VisibleWorkspaceUserSchema: z.ZodUnion<readonly [z.ZodObjec
                     mode: z.ZodOptional<z.ZodString>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
+            pauseActivity: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
     id: z.ZodNumber;

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

@@ -185,6 +185,11 @@ export type UpdateUserArgs = {
     /** Theme ID (0-12). String aliases like `'dark'` are also accepted. */
     theme?: number | string;
 };
+type StatusEffectArgs = {
+    scope?: {
+        mode: 'all';
+    };
+};
 export type SetStatusArgs = {
     /** 1 to 80 characters once trimmed. */
     message: string;
@@ -193,11 +198,9 @@ export type SetStatusArgs = {
     activeUntil?: Date | string | null;
     effects?: {
         /** Holds back Comms notifications while the status is active. They are not sent later. */
-        pauseNotifications?: {
-            scope?: {
-                mode: 'all';
-            };
-        };
+        pauseNotifications?: StatusEffectArgs;
+        /** Meant to pause Karma and streaks while the status is active. Comms drops it until Doist/comms-backend#1081 ships. */
+        pauseActivity?: StatusEffectArgs;
     };
 };
 type SearchArgsCommon = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "3.4.1",
+    "version": "3.5.0",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",