@doist/comms-sdk 1.0.1 → 2.0.0

package/dist/cjs/clients/workspace-users-client.js

@@ -65,12 +65,13 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
      * @param args - The arguments for getting a user by ID.
      * @param args.workspaceId - The workspace ID.
      * @param args.userId - The user's ID.
-     * @returns The workspace user object.
+     * @returns The workspace user object, reduced to the restricted shape when
+     * the viewer may not see the user's full profile.
      *
      * @example
      * ```typescript
      * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
-     * console.log(user.fullName, user.email)
+     * console.log(user.fullName, isRestrictedWorkspaceUser(user) ? null : user.email)
      * ```
      */
     getUserById(args) {
@@ -81,7 +82,7 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, user_id: args.userId },
             customFetch: this.customFetch,
-        }).then((response) => entities_1.WorkspaceUserSchema.parse(response.data));
+        }).then((response) => entities_1.VisibleWorkspaceUserSchema.parse(response.data));
     }
     /**
      * Gets a user by email.
@@ -89,7 +90,8 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
      * @param args - The arguments for getting a user by email.
      * @param args.workspaceId - The workspace ID.
      * @param args.email - The user's email.
-     * @returns The workspace user object.
+     * @returns The workspace user object, reduced to the restricted shape when
+     * the viewer may not see the user's full profile.
      *
      * @example
      * ```typescript
@@ -107,7 +109,7 @@ class WorkspaceUsersClient extends base_client_1.BaseClient {
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, email: args.email },
             customFetch: this.customFetch,
-        }).then((response) => entities_1.WorkspaceUserSchema.parse(response.data));
+        }).then((response) => entities_1.VisibleWorkspaceUserSchema.parse(response.data));
     }
     /**
      * Gets the user's info in the context of the workspace.

package/dist/cjs/types/entities.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResultSchema = exports.ConversationSearchResultSchema = exports.ThreadSearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.ConversationMessageObjectSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.CommentObjectSchema = exports.ConversationSchema = exports.ConversationObjectSchema = exports.GroupSchema = exports.ThreadSchema = exports.ThreadObjectSchema = exports.ChannelSchema = exports.ChannelObjectSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.RequestAttachmentSchema = exports.AttachmentSchema = exports.HookSubscribeResponseSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
+exports.SearchResultSchema = exports.ConversationSearchResultSchema = exports.ThreadSearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.ConversationMessageObjectSchema = exports.VisibleWorkspaceUserSchema = exports.RestrictedWorkspaceUserSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.CommentObjectSchema = exports.ConversationSchema = exports.ConversationObjectSchema = exports.GroupSchema = exports.ThreadSchema = exports.ThreadObjectSchema = exports.ChannelSchema = exports.ChannelObjectSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.RequestAttachmentSchema = exports.AttachmentSchema = exports.HookSubscribeResponseSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
 exports.createChannelSchema = createChannelSchema;
 exports.createThreadSchema = createThreadSchema;
 exports.createConversationSchema = createConversationSchema;
 exports.createCommentSchema = createCommentSchema;
+exports.isRestrictedWorkspaceUser = isRestrictedWorkspaceUser;
 exports.createConversationMessageSchema = createConversationMessageSchema;
 exports.createInboxThreadObjectSchema = createInboxThreadObjectSchema;
 exports.createInboxThreadSchema = createInboxThreadSchema;
@@ -319,6 +320,39 @@ exports.WorkspaceUserSchema = exports.BaseUserSchema.extend({
     timeFormat: zod_1.z.string().nullable().optional(),
     version: zod_1.z.number(),
 });
+// Reduced user shape the backend substitutes when the viewer may not see a
+// user's full profile — the user has been removed from the workspace, or the
+// viewer is a guest with no visibility of them. `full_name` / `short_name`
+// carry the first name only, and neither `timezone` nor `user_type` is sent,
+// so those cannot be modelled on this branch.
+exports.RestrictedWorkspaceUserSchema = exports.BaseUserSchema.omit({ timezone: true }).extend({
+    restricted: zod_1.z.literal(true),
+    version: zod_1.z.number(),
+});
+// A workspace user as the current viewer sees them. Endpoints that resolve a
+// single user by id or email return either shape, discriminated by
+// `restricted`; narrow with {@link isRestrictedWorkspaceUser}. Endpoints that
+// list a workspace's own members always return the full shape.
+exports.VisibleWorkspaceUserSchema = zod_1.z.union([
+    exports.WorkspaceUserSchema,
+    exports.RestrictedWorkspaceUserSchema,
+]);
+/**
+ * Narrows a {@link VisibleWorkspaceUser} to the reduced shape, which has no
+ * `timezone` and no `userType`.
+ *
+ * @param user - The user to check.
+ * @returns `true` when the viewer only gets the restricted profile.
+ *
+ * @example
+ * ```typescript
+ * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
+ * const zone = isRestrictedWorkspaceUser(user) ? 'UTC' : user.timezone
+ * ```
+ */
+function isRestrictedWorkspaceUser(user) {
+    return user.restricted === true;
+}
 // ConversationMessage entity from API. `id` is widened to `string | number`
 // (coerced to a string post-parse) because the backend currently emits
 // either shape depending on the endpoint; the URL/reaction helpers accept

package/dist/esm/clients/workspace-users-client.js

@@ -1,5 +1,5 @@
 import { request } from '../transport/http-client.js';
-import { WorkspaceUserSchema } from '../types/entities.js';
+import { VisibleWorkspaceUserSchema, WorkspaceUserSchema, } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for `/api/v1/workspace_users/`. The backend's `add` endpoint
@@ -62,12 +62,13 @@ export class WorkspaceUsersClient extends BaseClient {
      * @param args - The arguments for getting a user by ID.
      * @param args.workspaceId - The workspace ID.
      * @param args.userId - The user's ID.
-     * @returns The workspace user object.
+     * @returns The workspace user object, reduced to the restricted shape when
+     * the viewer may not see the user's full profile.
      *
      * @example
      * ```typescript
      * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
-     * console.log(user.fullName, user.email)
+     * console.log(user.fullName, isRestrictedWorkspaceUser(user) ? null : user.email)
      * ```
      */
     getUserById(args) {
@@ -78,7 +79,7 @@ export class WorkspaceUsersClient extends BaseClient {
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, user_id: args.userId },
             customFetch: this.customFetch,
-        }).then((response) => WorkspaceUserSchema.parse(response.data));
+        }).then((response) => VisibleWorkspaceUserSchema.parse(response.data));
     }
     /**
      * Gets a user by email.
@@ -86,7 +87,8 @@ export class WorkspaceUsersClient extends BaseClient {
      * @param args - The arguments for getting a user by email.
      * @param args.workspaceId - The workspace ID.
      * @param args.email - The user's email.
-     * @returns The workspace user object.
+     * @returns The workspace user object, reduced to the restricted shape when
+     * the viewer may not see the user's full profile.
      *
      * @example
      * ```typescript
@@ -104,7 +106,7 @@ export class WorkspaceUsersClient extends BaseClient {
             apiToken: this.apiToken,
             payload: { id: args.workspaceId, email: args.email },
             customFetch: this.customFetch,
-        }).then((response) => WorkspaceUserSchema.parse(response.data));
+        }).then((response) => VisibleWorkspaceUserSchema.parse(response.data));
     }
     /**
      * Gets the user's info in the context of the workspace.

package/dist/esm/types/entities.js

@@ -309,6 +309,39 @@ export const WorkspaceUserSchema = BaseUserSchema.extend({
     timeFormat: z.string().nullable().optional(),
     version: z.number(),
 });
+// Reduced user shape the backend substitutes when the viewer may not see a
+// user's full profile — the user has been removed from the workspace, or the
+// viewer is a guest with no visibility of them. `full_name` / `short_name`
+// carry the first name only, and neither `timezone` nor `user_type` is sent,
+// so those cannot be modelled on this branch.
+export const RestrictedWorkspaceUserSchema = BaseUserSchema.omit({ timezone: true }).extend({
+    restricted: z.literal(true),
+    version: z.number(),
+});
+// A workspace user as the current viewer sees them. Endpoints that resolve a
+// single user by id or email return either shape, discriminated by
+// `restricted`; narrow with {@link isRestrictedWorkspaceUser}. Endpoints that
+// list a workspace's own members always return the full shape.
+export const VisibleWorkspaceUserSchema = z.union([
+    WorkspaceUserSchema,
+    RestrictedWorkspaceUserSchema,
+]);
+/**
+ * Narrows a {@link VisibleWorkspaceUser} to the reduced shape, which has no
+ * `timezone` and no `userType`.
+ *
+ * @param user - The user to check.
+ * @returns `true` when the viewer only gets the restricted profile.
+ *
+ * @example
+ * ```typescript
+ * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
+ * const zone = isRestrictedWorkspaceUser(user) ? 'UTC' : user.timezone
+ * ```
+ */
+export function isRestrictedWorkspaceUser(user) {
+    return user.restricted === true;
+}
 // ConversationMessage entity from API. `id` is widened to `string | number`
 // (coerced to a string post-parse) because the backend currently emits
 // either shape depending on the endpoint; the URL/reaction helpers accept

package/dist/types/clients/workspace-users-client.d.ts

@@ -1,4 +1,4 @@
-import { type WorkspaceUser } from '../types/entities.js';
+import { type VisibleWorkspaceUser, type WorkspaceUser } from '../types/entities.js';
 import { UserType } from '../types/enums.js';
 import type { GetUserByEmailArgs, GetUserByIdArgs, GetUserInfoArgs, GetUserLocalTimeArgs, GetWorkspaceUsersArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
@@ -39,22 +39,24 @@ export declare class WorkspaceUsersClient extends BaseClient {
      * @param args - The arguments for getting a user by ID.
      * @param args.workspaceId - The workspace ID.
      * @param args.userId - The user's ID.
-     * @returns The workspace user object.
+     * @returns The workspace user object, reduced to the restricted shape when
+     * the viewer may not see the user's full profile.
      *
      * @example
      * ```typescript
      * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
-     * console.log(user.fullName, user.email)
+     * console.log(user.fullName, isRestrictedWorkspaceUser(user) ? null : user.email)
      * ```
      */
-    getUserById(args: GetUserByIdArgs): Promise<WorkspaceUser>;
+    getUserById(args: GetUserByIdArgs): Promise<VisibleWorkspaceUser>;
     /**
      * Gets a user by email.
      *
      * @param args - The arguments for getting a user by email.
      * @param args.workspaceId - The workspace ID.
      * @param args.email - The user's email.
-     * @returns The workspace user object.
+     * @returns The workspace user object, reduced to the restricted shape when
+     * the viewer may not see the user's full profile.
      *
      * @example
      * ```typescript
@@ -64,7 +66,7 @@ export declare class WorkspaceUsersClient extends BaseClient {
      * })
      * ```
      */
-    getUserByEmail(args: GetUserByEmailArgs): Promise<WorkspaceUser>;
+    getUserByEmail(args: GetUserByEmailArgs): Promise<VisibleWorkspaceUser>;
     /**
      * Gets the user's info in the context of the workspace.
      *

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

@@ -1603,6 +1603,82 @@ export declare const WorkspaceUserSchema: z.ZodObject<{
     version: z.ZodNumber;
 }, z.core.$strip>;
 export type WorkspaceUser = z.infer<typeof WorkspaceUserSchema>;
+export declare const RestrictedWorkspaceUserSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    fullName: z.ZodString;
+    shortName: z.ZodString;
+    firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    removed: z.ZodBoolean;
+    imageId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarUrls: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        s35: z.ZodString;
+        s60: z.ZodString;
+        s195: z.ZodString;
+        s640: z.ZodString;
+    }, z.core.$strip>>>;
+    setupPending: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    restricted: z.ZodLiteral<true>;
+    version: z.ZodNumber;
+}, z.core.$strip>;
+export type RestrictedWorkspaceUser = z.infer<typeof RestrictedWorkspaceUserSchema>;
+export declare const VisibleWorkspaceUserSchema: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodNumber;
+    fullName: z.ZodString;
+    shortName: z.ZodString;
+    firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodString;
+    removed: z.ZodBoolean;
+    imageId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarUrls: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        s35: z.ZodString;
+        s60: z.ZodString;
+        s195: z.ZodString;
+        s640: z.ZodString;
+    }, z.core.$strip>>>;
+    restricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    setupPending: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    userType: z.ZodEnum<{
+        USER: "USER";
+        GUEST: "GUEST";
+        ADMIN: "ADMIN";
+    }>;
+    dateFormat: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    theme: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    timeFormat: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    version: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodNumber;
+    fullName: z.ZodString;
+    shortName: z.ZodString;
+    firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    removed: z.ZodBoolean;
+    imageId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarUrls: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        s35: z.ZodString;
+        s60: z.ZodString;
+        s195: z.ZodString;
+        s640: z.ZodString;
+    }, z.core.$strip>>>;
+    setupPending: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    restricted: z.ZodLiteral<true>;
+    version: z.ZodNumber;
+}, z.core.$strip>]>;
+export type VisibleWorkspaceUser = z.infer<typeof VisibleWorkspaceUserSchema>;
+/**
+ * Narrows a {@link VisibleWorkspaceUser} to the reduced shape, which has no
+ * `timezone` and no `userType`.
+ *
+ * @param user - The user to check.
+ * @returns `true` when the viewer only gets the restricted profile.
+ *
+ * @example
+ * ```typescript
+ * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
+ * const zone = isRestrictedWorkspaceUser(user) ? 'UTC' : user.timezone
+ * ```
+ */
+export declare function isRestrictedWorkspaceUser(user: VisibleWorkspaceUser): user is RestrictedWorkspaceUser;
 export declare const ConversationMessageObjectSchema: z.ZodObject<{
     id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
     content: z.ZodString;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "1.0.1",
+    "version": "2.0.0",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",
@@ -49,7 +49,7 @@
     "dependencies": {
         "camelcase": "9.0.0",
         "ts-custom-error": "3.3.1",
-        "undici": "7.28.0",
+        "undici": "7.29.0",
         "uuid": "11.1.1",
         "zod": "4.4.3"
     },