Merge branch 'main' into docs/install

plugins/inference-plugin/src/index.ts

@@ -7,7 +7,6 @@
  */
 
 import {
-  ChatCompletionMessage,
   ChatCompletionRole,
   EventName,
   MessageRequest,

plugins/inference-plugin/src/module.ts

@@ -109,10 +109,10 @@ async function validateModelStatus(): Promise<InitModelResponse> {
           return { error: undefined };
         }
       }
-      return { error: "Model is not loaded successfully" };
+      return { error: "Model loading failed" };
     })
     .catch((err) => {
-      return { error: `Model is not loaded successfully. ${err.message}` };
+      return { error: `Model loading failed. ${err.message}` };
     });
 }
 

plugins/model-plugin/src/@types/schema.ts

@@ -0,0 +1,21 @@
+interface Version {
+  name: string
+  quantMethod: string
+  bits: number
+  size: number
+  maxRamRequired: number
+  usecase: string
+  downloadLink: string
+}
+interface ModelSchema {
+  id: string
+  name: string
+  shortDescription: string
+  avatarUrl: string
+  longDescription: string
+  author: string
+  version: string
+  modelUrl: string
+  tags: string[]
+  versions: Version[]
+}

plugins/model-plugin/src/helpers/modelParser.ts

@@ -1,37 +1,32 @@
-export const parseToModel = (model) => {
+import { ModelCatalog } from '@janhq/core'
+
+export function parseToModel(schema: ModelSchema): ModelCatalog {
   const modelVersions = []
-  model.versions.forEach((v) => {
+  schema.versions.forEach((v) => {
     const version = {
-      id: `${model.author}-${v.name}`,
       name: v.name,
       quantMethod: v.quantMethod,
       bits: v.bits,
       size: v.size,
       maxRamRequired: v.maxRamRequired,
       usecase: v.usecase,
       downloadLink: v.downloadLink,
-      productId: model.id,
     }
     modelVersions.push(version)
   })
 
-  const product = {
-    id: model.id,
-    name: model.name,
-    shortDescription: model.shortDescription,
-    avatarUrl: model.avatarUrl,
-    author: model.author,
-    version: model.version,
-    modelUrl: model.modelUrl,
-    nsfw: model.nsfw,
-    tags: model.tags,
-    greeting: model.defaultGreeting,
-    type: model.type,
-    createdAt: model.createdAt,
-    longDescription: model.longDescription,
-    status: 'Downloadable',
+  const model: ModelCatalog = {
+    id: schema.id,
+    name: schema.name,
+    shortDescription: schema.shortDescription,
+    avatarUrl: schema.avatarUrl,
+    author: schema.author,
+    version: schema.version,
+    modelUrl: schema.modelUrl,
+    tags: schema.tags,
+    longDescription: schema.longDescription,
     releaseDate: 0,
     availableVersions: modelVersions,
   }
-  return product
+  return model
 }

web/containers/Layout/TopBar/index.tsx

@@ -10,7 +10,9 @@ const TopBar = () => {
     <div className="fixed left-0 top-0 z-50 flex h-12 w-full border-b border-border bg-background/50">
       <div className="relative left-16 flex w-[calc(100%-64px)] items-center justify-between space-x-4 pl-6 pr-2">
         <div>
-          <span className="font-medium">{viewStateName}</span>
+          <span className="font-medium">
+            {viewStateName.replace(/([A-Z])/g, ' $1').trim()}
+          </span>
         </div>
         <CommandSearch />
         {/* Command without trigger interface */}

web/hooks/useActiveModel.ts

@@ -33,7 +33,10 @@ export function useActiveModel() {
     const model = downloadedModels.find((e) => e.id === modelId)
 
     if (!model) {
-      alert(`Model ${modelId} not found! Please re-download the model first.`)
+      toaster({
+        title: `Model ${modelId} not found!`,
+        description: `Please download the model first.`,
+      })
       setStateModel(() => ({
         state: 'start',
         loading: false,

web/hooks/useCreateConversation.ts

@@ -20,11 +20,10 @@ export const useCreateConversation = () => {
   const addNewConvoState = useSetAtom(addNewConversationStateAtom)
 
   const requestCreateConvo = async (model: Model) => {
-    const summary = model.name
     const mappedConvo: Thread = {
       id: generateConversationId(),
       modelId: model.id,
-      summary,
+      summary: model.name,
       createdAt: new Date().toISOString(),
       updatedAt: new Date().toISOString(),
       messages: [],
@@ -35,7 +34,7 @@ export const useCreateConversation = () => {
       waitingForResponse: false,
     })
 
-    pluginManager
+    await pluginManager
       .get<ConversationalPlugin>(PluginType.Conversational)
       ?.saveConversation(mappedConvo)
     setUserConversations([mappedConvo, ...userConversations])

web/hooks/useDeleteConversation.ts

@@ -16,19 +16,13 @@ import {
   getActiveConvoIdAtom,
   setActiveConvoIdAtom,
 } from '@/helpers/atoms/Conversation.atom'
-import {
-  showingProductDetailAtom,
-  showingAdvancedPromptAtom,
-} from '@/helpers/atoms/Modal.atom'
 
 export default function useDeleteConversation() {
   const { activeModel } = useActiveModel()
   const [userConversations, setUserConversations] = useAtom(
     userConversationsAtom
   )
   const setCurrentPrompt = useSetAtom(currentPromptAtom)
-  const setShowingProductDetail = useSetAtom(showingProductDetailAtom)
-  const setShowingAdvancedPrompt = useSetAtom(showingAdvancedPromptAtom)
   const activeConvoId = useAtomValue(getActiveConvoIdAtom)
 
   const setActiveConvoId = useSetAtom(setActiveConvoIdAtom)
@@ -45,18 +39,16 @@ export default function useDeleteConversation() {
         )
         setUserConversations(currentConversations)
         deleteMessages(activeConvoId)
+        setCurrentPrompt('')
         toaster({
-          title: 'Succes delete a chat',
-          description: `Delete chat with ${activeModel?.name} has been completed`,
+          title: 'Chat successfully deleted.',
+          description: `Chat with ${activeModel?.name} has been successfully deleted.`,
         })
         if (currentConversations.length > 0) {
           setActiveConvoId(currentConversations[0].id)
         } else {
           setActiveConvoId(undefined)
         }
-        setCurrentPrompt('')
-        setShowingProductDetail(false)
-        setShowingAdvancedPrompt(false)
       } catch (err) {
         console.error(err)
       }

web/hooks/useDeleteModel.ts

@@ -20,8 +20,8 @@ export default function useDeleteModel() {
     // reload models
     setDownloadedModels(downloadedModels.filter((e) => e.id !== model.id))
     toaster({
-      title: 'Delete a Model',
-      description: `Model ${model.id} has been deleted.`,
+      title: 'Model Deletion Successful',
+      description: `The model ${model.id} has been successfully deleted.`,
     })
   }
 

web/hooks/useGetConfiguredModels.ts

@@ -20,14 +20,13 @@ export function useGetConfiguredModels() {
   const [models, setModels] = useState<ModelCatalog[]>([])
 
   async function getConfiguredModels(): Promise<ModelCatalog[]> {
-    return (
-      ((await pluginManager
-        .get<ModelPlugin>(PluginType.Model)
-        ?.getConfiguredModels()) as ModelCatalog[]) ?? []
-    )
+    const models = await pluginManager
+      .get<ModelPlugin>(PluginType.Model)
+      ?.getConfiguredModels()
+    return models ?? []
   }
 
-  const fetchModels = async () => {
+  async function fetchModels() {
     setLoading(true)
     let models = await getConfiguredModels()
     if (process.env.NODE_ENV === 'development') {
@@ -37,10 +36,8 @@ export function useGetConfiguredModels() {
     setModels(models)
   }
 
-  // TODO allow user for filter
   useEffect(() => {
     fetchModels()
-    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [])
 
   return { loading, models }

web/hooks/useGetDownloadedModels.ts

@@ -12,11 +12,10 @@ export function useGetDownloadedModels() {
   const [downloadedModels, setDownloadedModels] = useAtom(downloadedModelAtom)
 
   async function getDownloadedModels(): Promise<Model[]> {
-    const models =
-      ((await pluginManager
-        .get<ModelPlugin>(PluginType.Model)
-        ?.getDownloadedModels()) as Model[]) ?? []
-    return models
+    const models = await pluginManager
+      .get<ModelPlugin>(PluginType.Model)
+      ?.getDownloadedModels()
+    return models ?? []
   }
 
   useEffect(() => {

web/hooks/useGetInputState.ts

@@ -10,23 +10,23 @@ import { currentConversationAtom } from '@/helpers/atoms/Conversation.atom'
 
 export default function useGetInputState() {
   const [inputState, setInputState] = useState<InputType>('loading')
-  const currentConvo = useAtomValue(currentConversationAtom)
+  const currentThread = useAtomValue(currentConversationAtom)
   const { activeModel } = useActiveModel()
   const { downloadedModels } = useGetDownloadedModels()
 
   const handleInputState = (
-    convo: Thread | undefined,
+    thread: Thread | undefined,
     currentModel: Model | undefined
   ) => {
-    if (convo == null) return
+    if (thread == null) return
     if (currentModel == null) {
       setInputState('loading')
       return
     }
 
     // check if convo model id is in downloaded models
     const isModelAvailable = downloadedModels.some(
-      (model) => model.id === convo.modelId
+      (model) => model.id === thread.modelId
     )
 
     if (!isModelAvailable) {
@@ -35,7 +35,7 @@ export default function useGetInputState() {
       return
     }
 
-    if (convo.modelId !== currentModel.id) {
+    if (thread.modelId !== currentModel.id) {
       // in case convo model and active model is different,
       // ask user to init the required model
       setInputState('model-mismatch')
@@ -46,11 +46,11 @@ export default function useGetInputState() {
   }
 
   useEffect(() => {
-    handleInputState(currentConvo, activeModel)
+    handleInputState(currentThread, activeModel)
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [])
 
-  return { inputState, currentConvo }
+  return { inputState, currentThread }
 }
 
 type InputType = 'available' | 'loading' | 'model-mismatch' | 'model-not-found'

web/hooks/useGetSystemResources.ts

@@ -34,14 +34,15 @@ export default function useGetSystemResources() {
   useEffect(() => {
     getSystemResources()
 
-    // Fetch interval - every 3s
+    // Fetch interval - every 5s
+    // TODO: Will we really need this?
+    // There is a possibility that this will be removed and replaced by the process event hook?
     const intervalId = setInterval(() => {
       getSystemResources()
     }, 5000)
 
-    // clean up
+    // clean up interval
     return () => clearInterval(intervalId)
-    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [])
 
   return {