Skip to content

fix: adjust ChannelResponse, ChannelData & PollResponse #1493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arnautov-anton merged 2 commits into from
Mar 12, 2025
Merged

fix: adjust ChannelResponse, ChannelData & PollResponse #1493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d2552d
Adjust types according to OpenAPI spec
arnautov-anton Mar 11, 2025
07e5cae
fix(polls): enforce_unique_votes -> enforce_unique_vote
arnautov-anton Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/poll.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ export class Poll {
];
ownAnswer = event.poll_vote;
} else if (event.poll_vote.option_id) {
if (event.poll.enforce_unique_votes) {
if (event.poll.enforce_unique_vote) {
ownVotesByOptionId = { [event.poll_vote.option_id]: event.poll_vote };
} else {
ownVotesByOptionId = Object.entries(ownVotesByOptionId).reduce<
Expand Down
1 change: 1 addition & 0 deletions src/thread.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ export class Thread {
threadData: ThreadResponse;
}) {
const channel = client.channel(threadData.channel.type, threadData.channel.id, {
// @ts-expect-error name is a "custom" property
name: threadData.channel.name,
});
channel._hydrateMembers({
Expand Down
32 changes: 16 additions & 16 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,10 @@ export type ChannelResponse = CustomChannelData & {
frozen: boolean;
id: string;
type: string;
blocked?: boolean;
auto_translation_enabled?: boolean;
auto_translation_language?: TranslationLanguages | '';
auto_translation_language?: TranslationLanguages;
hide_messages_before?: string;
config?: ChannelConfigWithInfo;
cooldown?: number;
created_at?: string;
Expand All @@ -282,7 +284,7 @@ export type ChannelResponse = CustomChannelData & {
member_count?: number;
members?: ChannelMemberResponse[];
muted?: boolean;
name?: string; // FIXME: I believe this property should live in CustomChannelData
mute_expires_at?: string;
own_capabilities?: string[];
team?: string;
truncated_at?: string;
Expand Down Expand Up @@ -1668,10 +1670,10 @@ export type ChannelFilters = QueryFilters<
name?:
| RequireOnlyOne<
{
$autocomplete?: ChannelResponse['name'];
} & QueryFilter<ChannelResponse['name']>
$autocomplete?: string;
} & QueryFilter<string>
>
| PrimitiveFilter<ChannelResponse['name']>;
| PrimitiveFilter<string>;
pinned?: boolean;
} & {
[Key in keyof Omit<ChannelResponse, 'name' | 'members' | keyof CustomChannelData>]:
Expand Down Expand Up @@ -2294,13 +2296,13 @@ export type ChannelConfigWithInfo = ChannelConfigFields &
commands?: CommandResponse[];
};

export type ChannelData = CustomChannelData & {
blocked?: boolean;
created_by?: UserResponse | null;
created_by_id?: UserResponse['id'];
members?: string[] | Array<NewMemberPayload>;
name?: string;
};
export type ChannelData = CustomChannelData &
Partial<{
blocked: boolean;
created_by: UserResponse | null;
created_by_id: UserResponse['id'];
members: string[] | Array<NewMemberPayload>;
}>;

export type ChannelMute = {
user: UserResponse;
Expand Down Expand Up @@ -2831,7 +2833,6 @@ export type TokenOrProvider = null | string | TokenProvider | undefined;
export type TokenProvider = () => Promise<string>;

export type TranslationLanguages =
| ''
| 'af'
| 'am'
| 'ar'
Expand Down Expand Up @@ -2887,7 +2888,8 @@ export type TranslationLanguages =
| 'ur'
| 'vi'
| 'zh'
| 'zh-TW';
| 'zh-TW'
| (string & {});

export type TypingStartEvent = Event;

Expand Down Expand Up @@ -3248,7 +3250,6 @@ export type UpdatePollAPIResponse = {

export type PollResponse = CustomPollData &
PollEnrichData & {
cid: string;
created_at: string;
created_by: UserResponse | null;
created_by_id: string;
Expand All @@ -3261,7 +3262,6 @@ export type PollResponse = CustomPollData &
allow_answers?: boolean;
allow_user_suggested_options?: boolean;
description?: string;
enforce_unique_votes?: boolean;
is_closed?: boolean;
voting_visibility?: VotingVisibility;
};
Expand Down
Loading