Skip to content

feat: default data interfaces #2683

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.

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
merged 1 commit into from
Apr 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 0 additions & 9 deletions src/@types/stream-chat-common-custom-data.d.ts

This file was deleted.

39 changes: 39 additions & 0 deletions src/@types/stream-chat-custom-data.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import 'stream-chat';

import {
DefaultAttachmentData,
DefaultChannelData,
DefaultCommandData,
DefaultEventData,
DefaultMemberData,
DefaultMessageData,
DefaultPollData,
DefaultPollOptionData,
DefaultReactionData,
DefaultThreadData,
DefaultUserData,
} from '../types/defaultDataInterfaces';

declare module 'stream-chat' {
interface CustomChannelData extends DefaultChannelData {}

interface CustomAttachmentData extends DefaultAttachmentData {}

interface CustomCommandData extends DefaultCommandData {}

interface CustomEventData extends DefaultEventData {}

interface CustomMemberData extends DefaultMemberData {}

interface CustomMessageData extends DefaultMessageData {}

interface CustomPollOptionData extends DefaultPollOptionData {}

interface CustomPollData extends DefaultPollData {}

interface CustomReactionData extends DefaultReactionData {}

interface CustomUserData extends DefaultUserData {}

interface CustomThreadData extends DefaultThreadData {}
}
26 changes: 26 additions & 0 deletions src/types/defaultDataInterfaces.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/* eslint-disable @typescript-eslint/no-empty-object-type */
export interface DefaultChannelData {
image?: string;
name?: string;
subtitle?: string;
}

export interface DefaultAttachmentData {}

export interface DefaultCommandData {}

export interface DefaultEventData {}

export interface DefaultMemberData {}

export interface DefaultMessageData {}

export interface DefaultPollOptionData {}

export interface DefaultPollData {}

export interface DefaultReactionData {}

export interface DefaultUserData {}

export interface DefaultThreadData {}
1 change: 1 addition & 0 deletions src/types/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export type { ChannelUnreadUiState } from './types';
export type * from './defaultDataInterfaces';
47 changes: 2 additions & 45 deletions src/types/types.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
import type { PropsWithChildren } from 'react';
import type { LoadingIndicatorProps } from '../components/Loading/LoadingIndicator';
import type {
APIErrorResponse,
Attachment,
ErrorFromResponse,
Event,
Mute,
ChannelState as StreamChannelState,
} from 'stream-chat';
import type { Attachment, ChannelState as StreamChannelState } from 'stream-chat';

export type UnknownType = Record<string, unknown>;
export type PropsWithChildrenOnly = PropsWithChildren<Record<never, never>>;
Expand All @@ -21,42 +14,6 @@ export type CustomTrigger = {

export type CustomMessageType = 'channel.intro' | 'message.date';

export type DefaultAttachmentType = UnknownType & {
asset_url?: string;
file_size?: number;
id?: string;
images?: Array<{
image_url?: string;
thumb_url?: string;
}>;
};

export type DefaultChannelType = UnknownType & {
frozen?: boolean;
image?: string;
member_count?: number;
subtitle?: string;
};

export type DefaultMessageType = UnknownType & {
customType?: CustomMessageType;
date?: string | Date;
error?: ErrorFromResponse<APIErrorResponse>;
errorStatusCode?: number;
event?: Event;
unread?: boolean;
};

export type DefaultUserTypeInternal = {
image?: string;
status?: string;
};

export type DefaultUserType = UnknownType &
DefaultUserTypeInternal & {
mutes?: Array<Mute>;
};

export type GiphyVersions =
| 'original'
| 'fixed_height'
Expand Down Expand Up @@ -117,7 +74,7 @@ export type VideoAttachmentSizeHandler = (

export type ChannelUnreadUiState = Omit<ValuesType<StreamChannelState['read']>, 'user'>;

// todo: fix export from stream-chat - for some reason not exported
// TODO: fix export from stream-chat - for some reason not exported
export type SendMessageOptions = {
force_moderation?: boolean;
is_pending_message?: boolean;
Expand Down