chore: add jsdocs

Author: isekovanic

package/src/components/AITypingIndicatorView/hooks/useAIState.ts

@@ -14,14 +14,20 @@ export const AIStates = {
   Thinking: 'AI_STATE_THINKING',
 };
 
+/**
+ * A hook that returns the current state of the AI.
+ * @param {Channel} channel - The channel for which we want to know the AI state.
+ * @returns {{ aiState: AIState }} The current AI state for the given channel.
+ */
 export const useAIState = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >(
   channel?: Channel<StreamChatGenerics>,
-) => {
-  const { client } = useChatContext();
+): { aiState: AIState } => {
+  const { client } = useChatContext<StreamChatGenerics>();
+  const { isOnline } = useIsOnline<StreamChatGenerics>(client);
+
   const [aiState, setAiState] = useState<AIState>(AIStates.Idle);
-  const { isOnline } = useIsOnline(client);
 
   useEffect(() => {
     if (!isOnline) {

package/src/components/Message/hooks/useStreamingMessage.ts

@@ -13,13 +13,21 @@ export type UseStreamingMessageProps<
 const DEFAULT_LETTER_INTERVAL = 0;
 const DEFAULT_RENDERING_LETTER_COUNT = 2;
 
+/**
+ * A hook that returns text in a streamed, typewriter fashion. The speed of streaming is
+ * configurable.
+ * @param {number} [letterInterval=0] - The timeout between each typing animation in milliseconds.
+ * @param {number} [renderingLetterCount=2] - The number of letters to be rendered each time we update.
+ * @param {string} text - The text that we want to render in a typewriter fashion.
+ * @returns {{ streamedMessageText: string }} - A substring of the text property, up until we've finished rendering the typewriter animation.
+ */
 export const useStreamingMessage = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >({
   letterInterval = DEFAULT_LETTER_INTERVAL,
   renderingLetterCount = DEFAULT_RENDERING_LETTER_COUNT,
   text,
-}: UseStreamingMessageProps<StreamChatGenerics>) => {
+}: UseStreamingMessageProps<StreamChatGenerics>): { streamedMessageText: string } => {
   const [streamedMessageText, setStreamedMessageText] = useState<string>(text);
   const textCursor = useRef<number>(text.length);