chore: ddp streamer typings (#28437)
Co-authored-by: Tasso Evangelista <tasso.evangelista@rocket.chat>pull/28455/head^2
Guilherme Gazzo
3 years ago
committed by
GitHub
parent
276d012e7c
commit
ffa1d9c48c
@ -0,0 +1,164 @@ |
||||
import type { |
||||
IMessage, |
||||
IRoom, |
||||
ISetting, |
||||
ISubscription, |
||||
IRole, |
||||
IEmoji, |
||||
ICustomSound, |
||||
INotificationDesktop, |
||||
IWebdavAccount, |
||||
VoipEventDataSignature, |
||||
IUser, |
||||
IOmnichannelRoom, |
||||
VideoConference, |
||||
} from '@rocket.chat/core-typings'; |
||||
|
||||
type StreamerKeyArgs<K, T extends unknown[]> = (key: K, cb: (...args: T) => void) => () => void; |
||||
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||
export interface StreamerEvents { |
||||
'roles': StreamerKeyArgs<'roles', [IRole]>; |
||||
|
||||
'notify-room': StreamerKeyArgs<`${string}/user-activity`, [username: string, activities: string]> & |
||||
StreamerKeyArgs< |
||||
`${string}/deleteMessageBulk`, |
||||
[args: { rid: IMessage['rid']; excludePinned: boolean; ignoreDiscussion: boolean; ts: Record<string, Date>; users: string[] }] |
||||
> & |
||||
StreamerKeyArgs<`${string}/deleteMessage`, [{ _id: IMessage['_id'] }]> & |
||||
StreamerKeyArgs<`${string}/videoconf`, [id: string]>; |
||||
|
||||
'room-messages': StreamerKeyArgs<string, [IMessage]>; |
||||
|
||||
'notify-all': StreamerKeyArgs< |
||||
'deleteEmojiCustom', |
||||
[ |
||||
{ |
||||
emojiData: IEmoji; |
||||
}, |
||||
] |
||||
> & |
||||
StreamerKeyArgs< |
||||
'updateCustomSound', |
||||
[ |
||||
{ |
||||
soundData: ICustomSound; |
||||
}, |
||||
] |
||||
> & |
||||
StreamerKeyArgs<'public-settings-changed', ['inserted' | 'updated' | 'removed' | 'changed', ISetting]>; |
||||
|
||||
'notify-user': StreamerKeyArgs<`${string}/rooms-changed`, [IRoom]> & |
||||
StreamerKeyArgs<`${string}/subscriptions-changed`, [ISubscription]> & |
||||
StreamerKeyArgs<`${string}/message`, [IMessage]> & |
||||
StreamerKeyArgs<`${string}/force_logout`, []> & |
||||
StreamerKeyArgs< |
||||
`${string}/webdav`, |
||||
[ |
||||
| { |
||||
type: 'changed'; |
||||
account: Partial<IWebdavAccount>; |
||||
} |
||||
| { |
||||
type: 'removed'; |
||||
account: { _id: IWebdavAccount['_id'] }; |
||||
}, |
||||
] |
||||
> & |
||||
StreamerKeyArgs<`${string}/e2ekeyRequest`, [string, string]> & |
||||
StreamerKeyArgs<`${string}/notification`, [INotificationDesktop]> & |
||||
StreamerKeyArgs<`${string}/voip.events`, [VoipEventDataSignature]> & |
||||
StreamerKeyArgs< |
||||
`${string}/call.hangup`, |
||||
[ |
||||
{ |
||||
roomId: string; |
||||
}, |
||||
] |
||||
>; |
||||
|
||||
'importers': StreamerKeyArgs<'progress', [{ rate: number; count: { completed: number; total: number } }]>; |
||||
|
||||
'notify-logged': StreamerKeyArgs<'banner-changed', [{ bannerId: string }]> & |
||||
StreamerKeyArgs< |
||||
'roles-change', |
||||
[ |
||||
{ |
||||
type: 'added' | 'removed' | 'changed'; |
||||
_id: IRole['_id']; |
||||
u: { |
||||
_id: IUser['_id']; |
||||
username: IUser['username']; |
||||
name: IUser['name']; |
||||
}; |
||||
scope?: IRoom['_id']; |
||||
}, |
||||
] |
||||
> & |
||||
StreamerKeyArgs<'Users:NameChanged', [Pick<IUser, '_id' | 'name'>]> & |
||||
StreamerKeyArgs<'voip.statuschanged', [boolean]> & |
||||
StreamerKeyArgs<'omnichannel.priority-changed', [{ id: 'added' | 'removed' | 'changed'; name: string }]>; |
||||
|
||||
'stdout': StreamerKeyArgs< |
||||
'stdout', |
||||
[ |
||||
{ |
||||
id: string; |
||||
string: string; |
||||
ts: Date; |
||||
}, |
||||
] |
||||
>; |
||||
|
||||
'room-data': StreamerKeyArgs<string, [IOmnichannelRoom]>; |
||||
'notify-room-users': StreamerKeyArgs< |
||||
`${string}/video-conference`, |
||||
[ |
||||
{ |
||||
action: string; |
||||
params: { |
||||
callId: VideoConference['_id']; |
||||
uid: IUser['_id']; |
||||
rid: IRoom['_id']; |
||||
}; |
||||
}, |
||||
] |
||||
> & |
||||
StreamerKeyArgs<`${string}/webrtc`, unknown[]> & |
||||
StreamerKeyArgs<`${string}/otr`, unknown[]> & |
||||
StreamerKeyArgs<`${string}/userData`, unknown[]>; |
||||
|
||||
// 'notify-logged': (
|
||||
// e:
|
||||
// | 'private-settings-changed'
|
||||
// | 'permissions-changed'
|
||||
// | 'roles-change'
|
||||
// | 'deleteCustomUserStatus'
|
||||
// | 'updateCustomUserStatus'
|
||||
// | 'deleteEmojiCustom'
|
||||
// | 'updateEmojiCustom'
|
||||
// | 'updateAvatar'
|
||||
// | 'Users:Deleted',
|
||||
// ) => [void];
|
||||
|
||||
// 'apps': (
|
||||
// e:
|
||||
// | 'app/added'
|
||||
// | 'app/removed'
|
||||
// | 'app/updated'
|
||||
// | 'app/statusUpdate'
|
||||
// | 'app/settingUpdate'
|
||||
// | 'command/added'
|
||||
// | 'command/disabled'
|
||||
// | 'command/updated'
|
||||
// | 'command/removed'
|
||||
// | 'actions/changed',
|
||||
// ) => [unknown];
|
||||
// 'user-presence': () => [void];
|
||||
} |
||||
|
||||
export type ServerStreamerNames = keyof StreamerEvents; |
||||
|
||||
export type ServerStreamerParameters<MethodName extends ServerStreamerNames> = Parameters<StreamerEvents[MethodName]>; |
||||
|
||||
export type ServerStreamerReturn<MethodName extends ServerStreamerNames> = ReturnType<StreamerEvents[MethodName]>; |
||||
@ -1,14 +1,53 @@ |
||||
import type { ServerStreamerNames, StreamerEvents } from '@rocket.chat/ui-contexts/src/ServerContext/streams'; |
||||
import { useContext, useMemo } from 'react'; |
||||
|
||||
import { ServerContext } from '../ServerContext'; |
||||
|
||||
export const useStream = ( |
||||
streamName: string, |
||||
export type ServerStreamFunction<StreamName extends ServerStreamerNames> = ( |
||||
args: StreamerEvents[StreamName], |
||||
callback: (...args: any) => void, |
||||
) => () => void; |
||||
|
||||
export function useStream<StreamName extends string>( |
||||
streamName: StreamName extends ServerStreamerNames ? never : StreamName, |
||||
options?: { |
||||
retransmit?: boolean; |
||||
retransmitToSelf?: boolean; |
||||
}, |
||||
): (key: string, cb: (...args: unknown[]) => void) => () => void; |
||||
export function useStream<StreamName extends ServerStreamerNames>( |
||||
streamName: StreamName, |
||||
options?: { |
||||
retransmit?: boolean | undefined; |
||||
retransmitToSelf?: boolean | undefined; |
||||
}, |
||||
): StreamerEvents[StreamName]; |
||||
export function useStream<StreamName extends ServerStreamerNames>( |
||||
streamName: StreamName, |
||||
options?: { |
||||
retransmit?: boolean | undefined; |
||||
retransmitToSelf?: boolean | undefined; |
||||
}, |
||||
): (<TEvent extends unknown[]>(eventName: string, callback: (...event: TEvent) => void) => () => void) => { |
||||
): StreamerEvents[StreamName] { |
||||
const { getStream } = useContext(ServerContext); |
||||
return useMemo(() => getStream(streamName, options), [getStream, streamName, options]); |
||||
}; |
||||
} |
||||
|
||||
/* |
||||
* @param streamName The name of the stream to subscribe to |
||||
* @returns A function that can be used to subscribe to the stream |
||||
* the main difference between this and useStream is that this function |
||||
* will only subscribe to the `stream + key` only once, but you can still add multiple callbacks |
||||
* to the same path |
||||
*/ |
||||
|
||||
export function useSingleStream<StreamName extends ServerStreamerNames>( |
||||
streamName: StreamName, |
||||
options?: { |
||||
retransmit?: boolean | undefined; |
||||
retransmitToSelf?: boolean | undefined; |
||||
}, |
||||
): StreamerEvents[StreamName] { |
||||
const { getSingleStream } = useContext(ServerContext); |
||||
return useMemo(() => getSingleStream(streamName, options), [getSingleStream, streamName, options]); |
||||
} |
||||
|
||||
Loading…
Reference in new issue