@lobehub/chat 0.147.11 → 0.147.13

package/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 # Changelog
 
+### [Version 0.147.13](https://github.com/lobehub/lobe-chat/compare/v0.147.12...v0.147.13)
+
+<sup>Released on **2024-04-14**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the service with browser db invoke.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the service with browser db invoke, closes [#2038](https://github.com/lobehub/lobe-chat/issues/2038) ([43a2791](https://github.com/lobehub/lobe-chat/commit/43a2791))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+### [Version 0.147.12](https://github.com/lobehub/lobe-chat/compare/v0.147.11...v0.147.12)
+
+<sup>Released on **2024-04-14**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Move client db to a new folder.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Move client db to a new folder, closes [#2037](https://github.com/lobehub/lobe-chat/issues/2037) ([ebe65bb](https://github.com/lobehub/lobe-chat/commit/ebe65bb))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.147.11](https://github.com/lobehub/lobe-chat/compare/v0.147.10...v0.147.11)
 
 <sup>Released on **2024-04-14**</sup>

package/contributing/Basic/Feature-Development.md

@@ -128,8 +128,8 @@ When building the LobeChat application, the Model is responsible for interacting
 In `src/database/model/sessionGroup.ts`, the `SessionGroupModel` is defined as follows:
 
 ```typescript
-import { BaseModel } from '@/database/core';
-import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/schemas/sessionGroup';
+import { BaseModel } from '@/database/client/core';
+import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/client/schemas/sessionGroup';
 import { nanoid } from '@/utils/uuid';
 
 class _SessionGroupModel extends BaseModel {

package/contributing/Basic/Feature-Development.zh-CN.md

@@ -128,8 +128,8 @@ export class LocalDB extends Dexie {
 在 `src/database/model/sessionGroup.ts` 中定义 `SessionGroupModel`：
 
 ```typescript
-import { BaseModel } from '@/database/core';
-import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/schemas/sessionGroup';
+import { BaseModel } from '@/database/client/core';
+import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/client/schemas/sessionGroup';
 import { nanoid } from '@/utils/uuid';
 
 class _SessionGroupModel extends BaseModel {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.147.11",
+  "version": "0.147.13",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",

package/src/database/{core → client/core}/__tests__/db-upgrade.test.ts

@@ -1,7 +1,7 @@
 import Dexie from 'dexie';
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
-import { LocalDB } from '../db';
+import { BrowserDB } from '../db';
 import { dbSchemaV3 } from '../schemas';
 import { LOBE_CHAT_LOCAL_DB_NAME } from '../types/db';
 
@@ -28,7 +28,7 @@ describe('LocalDB migration', () => {
     dbV3.close();
 
     // 创建新的数据库实例，包含版本4的迁移逻辑
-    const dbV4 = new LocalDB();
+    const dbV4 = new BrowserDB();
     await dbV4.open();
 
     // 验证迁移后的数据

package/src/database/{core → client/core}/__tests__/db.test.ts

@@ -1,15 +1,14 @@
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
-import { DBModel } from '@/database/core/types/db';
-import { DB_File } from '@/database/schemas/files';
-
-import { LocalDB } from '../db';
+import { DB_File } from '../../schemas/files';
+import { BrowserDB } from '../db';
+import { DBModel } from '../types/db';
 
 describe('LocalDB', () => {
-  let db: LocalDB;
+  let db: BrowserDB;
 
   beforeEach(() => {
-    db = new LocalDB();
+    db = new BrowserDB();
   });
 
   afterEach(async () => {

package/src/database/{core → client/core}/db.ts

@@ -1,15 +1,15 @@
 import Dexie, { Transaction } from 'dexie';
 
-import { DB_File } from '@/database/schemas/files';
-import { DB_Message } from '@/database/schemas/message';
-import { DB_Plugin } from '@/database/schemas/plugin';
-import { DB_Session } from '@/database/schemas/session';
-import { DB_SessionGroup } from '@/database/schemas/sessionGroup';
-import { DB_Topic } from '@/database/schemas/topic';
-import { DB_User } from '@/database/schemas/user';
 import { MigrationLLMSettings } from '@/migrations/FromV3ToV4';
 import { uuid } from '@/utils/uuid';
 
+import { DB_File } from '../schemas/files';
+import { DB_Message } from '../schemas/message';
+import { DB_Plugin } from '../schemas/plugin';
+import { DB_Session } from '../schemas/session';
+import { DB_SessionGroup } from '../schemas/sessionGroup';
+import { DB_Topic } from '../schemas/topic';
+import { DB_User } from '../schemas/user';
 import { migrateSettingsToUser } from './migrations/migrateSettingsToUser';
 import {
   dbSchemaV1,
@@ -33,14 +33,14 @@ export interface LobeDBSchemaMap {
 }
 
 // Define a local DB
-export class LocalDB extends Dexie {
-  public files: LobeDBTable<'files'>;
-  public sessions: LobeDBTable<'sessions'>;
-  public messages: LobeDBTable<'messages'>;
-  public topics: LobeDBTable<'topics'>;
-  public plugins: LobeDBTable<'plugins'>;
-  public sessionGroups: LobeDBTable<'sessionGroups'>;
-  public users: LobeDBTable<'users'>;
+export class BrowserDB extends Dexie {
+  public files: BrowserDBTable<'files'>;
+  public sessions: BrowserDBTable<'sessions'>;
+  public messages: BrowserDBTable<'messages'>;
+  public topics: BrowserDBTable<'topics'>;
+  public plugins: BrowserDBTable<'plugins'>;
+  public sessionGroups: BrowserDBTable<'sessionGroups'>;
+  public users: BrowserDBTable<'users'>;
 
   constructor() {
     super(LOBE_CHAT_LOCAL_DB_NAME);
@@ -155,7 +155,7 @@ export class LocalDB extends Dexie {
   };
 }
 
-export const LocalDBInstance = new LocalDB();
+export const browserDB = new BrowserDB();
 
 // ================================================ //
 // ================================================ //
@@ -164,10 +164,10 @@ export const LocalDBInstance = new LocalDB();
 // ================================================ //
 
 // types helper
-export type LocalDBSchema = {
+export type BrowserDBSchema = {
   [t in keyof LobeDBSchemaMap]: {
     model: LobeDBSchemaMap[t];
     table: Dexie.Table<DBModel<LobeDBSchemaMap[t]>, string>;
   };
 };
-type LobeDBTable<T extends keyof LobeDBSchemaMap> = LocalDBSchema[T]['table'];
+type BrowserDBTable<T extends keyof LobeDBSchemaMap> = BrowserDBSchema[T]['table'];

package/src/database/{core → client/core}/index.ts

@@ -1,3 +1,3 @@
-export { LocalDBInstance } from './db';
+export { browserDB } from './db';
 export * from './model';
 export { dataSync } from './sync';

package/src/database/{core → client/core}/migrations/migrateSettingsToUser/index.ts

@@ -1,4 +1,4 @@
-import { DB_Settings } from '@/database/schemas/user';
+import { DB_Settings } from '@/database/client/schemas/user';
 
 import { V4Settings } from './type';
 

package/src/database/{core → client/core}/model.ts

@@ -3,16 +3,16 @@ import { ZodObject } from 'zod';
 
 import { nanoid } from '@/utils/uuid';
 
-import { LocalDB, LocalDBInstance, LocalDBSchema } from './db';
+import { BrowserDB, BrowserDBSchema, browserDB } from './db';
 import { dataSync } from './sync';
 import { DBBaseFieldsSchema } from './types/db';
 
-export class BaseModel<N extends keyof LocalDBSchema = any, T = LocalDBSchema[N]['table']> {
-  protected readonly db: LocalDB;
+export class BaseModel<N extends keyof BrowserDBSchema = any, T = BrowserDBSchema[N]['table']> {
+  protected readonly db: BrowserDB;
   private readonly schema: ZodObject<any>;
-  private readonly _tableName: keyof LocalDBSchema;
+  private readonly _tableName: keyof BrowserDBSchema;
 
-  constructor(table: N, schema: ZodObject<any>, db = LocalDBInstance) {
+  constructor(table: N, schema: ZodObject<any>, db = browserDB) {
     this.db = db;
     this.schema = schema;
     this._tableName = table;
@@ -31,7 +31,7 @@ export class BaseModel<N extends keyof LocalDBSchema = any, T = LocalDBSchema[N]
   /**
    * create a new record
    */
-  protected async _addWithSync<T = LocalDBSchema[N]['model']>(
+  protected async _addWithSync<T = BrowserDBSchema[N]['model']>(
     data: T,
     id: string | number = nanoid(),
     primaryKey: string = 'id',
@@ -71,7 +71,7 @@ export class BaseModel<N extends keyof LocalDBSchema = any, T = LocalDBSchema[N]
    * @param options.generateId
    * @param options.createWithNewId
    */
-  protected async _batchAdd<T = LocalDBSchema[N]['model']>(
+  protected async _batchAdd<T = BrowserDBSchema[N]['model']>(
     dataArray: T[],
     options: {
       /**

package/src/database/{core → client/core}/sync.ts

@@ -11,7 +11,7 @@ import {
   StartDataSyncParams,
 } from '@/types/sync';
 
-import { LobeDBSchemaMap, LocalDBInstance } from './db';
+import { LobeDBSchemaMap, browserDB } from './db';
 
 const LOG_NAME_SPACE = 'DataSync';
 
@@ -201,7 +201,7 @@ class DataSync {
     onEvent: OnSyncEvent,
     onSyncStatusChange: OnSyncStatusChange,
   ) => {
-    const table = LocalDBInstance[tableKey];
+    const table = browserDB[tableKey];
     const yItemMap = this.getYMap(tableKey);
     const updateSyncEvent = throttle(onEvent, 1000);
 
@@ -249,7 +249,7 @@ class DataSync {
   };
 
   private loadDataFromDBtoYjs = async (tableKey: keyof LobeDBSchemaMap) => {
-    const table = LocalDBInstance[tableKey];
+    const table = browserDB[tableKey];
     const items = await table.toArray();
     const yItemMap = this.getYMap(tableKey);
 

package/src/database/{models → client/models}/__DEBUG.ts

@@ -1,9 +1,9 @@
 // This file is for debugging purposes only.
 // DON'T USE IT IN PRODUCTION.
 import { DEFAULT_AGENT_CONFIG } from '@/const/settings';
-import { DBModel } from '@/database/core/types/db';
-import { DB_Message } from '@/database/schemas/message';
-import { DB_Topic } from '@/database/schemas/topic';
+import { DBModel } from '@/database/client/core/types/db';
+import { DB_Message } from '@/database/client/schemas/message';
+import { DB_Topic } from '@/database/client/schemas/topic';
 
 import { BaseModel } from '../core';
 import { DB_Session, DB_SessionSchema } from '../schemas/session';

package/src/database/{models → client/models}/__tests__/file.test.ts

@@ -1,8 +1,7 @@
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
-import { DB_File } from '@/database/schemas/files';
-
-import { LocalDB } from '../../core/db';
+import { BrowserDB } from '../../core/db';
+import { DB_File } from '../../schemas/files';
 import { FileModel } from '../file';
 
 // Assuming LocalDB is already mocked or using an in-memory database
@@ -25,7 +24,7 @@ describe('_FileModel', () => {
 
   afterEach(async () => {
     // Clean up the database after each test
-    const db = new LocalDB();
+    const db = new BrowserDB();
     await db.files.clear();
     db.close();
   });

package/src/database/{models → client/models}/__tests__/session.test.ts

@@ -1,9 +1,9 @@
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
 import { DEFAULT_AGENT_CONFIG } from '@/const/settings';
-import { CreateMessageParams, MessageModel } from '@/database/models/message';
-import { SessionGroupModel } from '@/database/models/sessionGroup';
-import { TopicModel } from '@/database/models/topic';
+import { CreateMessageParams, MessageModel } from '@/database/client/models/message';
+import { SessionGroupModel } from '@/database/client/models/sessionGroup';
+import { TopicModel } from '@/database/client/models/topic';
 import { LobeAgentConfig } from '@/types/agent';
 import {
   LobeAgentSession,

package/src/database/{models → client/models}/__tests__/sessionGroup.test.ts

@@ -1,6 +1,6 @@
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
-import { SessionModel } from '@/database/models/session';
+import { SessionModel } from '@/database/client/models/session';
 import { SessionGroups } from '@/types/session';
 
 import { DB_SessionGroup } from '../../schemas/sessionGroup';

package/src/database/{models → client/models}/__tests__/topic.test.ts

@@ -1,9 +1,9 @@
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
-import { DBModel } from '@/database/core/types/db';
-import { CreateMessageParams, MessageModel } from '@/database/models/message';
-import { DB_Message } from '@/database/schemas/message';
-import { DB_Topic } from '@/database/schemas/topic';
+import { DBModel } from '@/database/client/core/types/db';
+import { CreateMessageParams, MessageModel } from '@/database/client/models/message';
+import { DB_Message } from '@/database/client/schemas/message';
+import { DB_Topic } from '@/database/client/schemas/topic';
 import { nanoid } from '@/utils/uuid';
 import * as uuidUtils from '@/utils/uuid';
 

package/src/database/{models → client/models}/file.ts

@@ -1,4 +1,4 @@
-import { DB_File, DB_FileSchema } from '@/database/schemas/files';
+import { DB_File, DB_FileSchema } from '@/database/client/schemas/files';
 import { nanoid } from '@/utils/uuid';
 
 import { BaseModel } from '../core';

package/src/database/{models → client/models}/message.ts

@@ -1,8 +1,8 @@
 import { DeepPartial } from 'utility-types';
 
-import { BaseModel } from '@/database/core';
-import { DBModel } from '@/database/core/types/db';
-import { DB_Message, DB_MessageSchema } from '@/database/schemas/message';
+import { BaseModel } from '@/database/client/core';
+import { DBModel } from '@/database/client/core/types/db';
+import { DB_Message, DB_MessageSchema } from '@/database/client/schemas/message';
 import { ChatMessage } from '@/types/message';
 import { nanoid } from '@/utils/uuid';
 

package/src/database/{models → client/models}/plugin.ts

@@ -1,6 +1,6 @@
 import { LobeChatPluginManifest } from '@lobehub/chat-plugin-sdk';
 
-import { BaseModel } from '@/database/core';
+import { BaseModel } from '@/database/client/core';
 import { LobeTool } from '@/types/tool';
 import { merge } from '@/utils/merge';
 

package/src/database/{models → client/models}/session.ts

@@ -1,9 +1,9 @@
 import { DeepPartial } from 'utility-types';
 
 import { DEFAULT_AGENT_LOBE_SESSION } from '@/const/session';
-import { BaseModel } from '@/database/core';
-import { DBModel } from '@/database/core/types/db';
-import { DB_Session, DB_SessionSchema } from '@/database/schemas/session';
+import { BaseModel } from '@/database/client/core';
+import { DBModel } from '@/database/client/core/types/db';
+import { DB_Session, DB_SessionSchema } from '@/database/client/schemas/session';
 import { LobeAgentConfig } from '@/types/agent';
 import {
   ChatSessionList,

package/src/database/{models → client/models}/sessionGroup.ts

@@ -1,5 +1,5 @@
-import { BaseModel } from '@/database/core';
-import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/schemas/sessionGroup';
+import { BaseModel } from '@/database/client/core';
+import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/client/schemas/sessionGroup';
 import { SessionGroups } from '@/types/session';
 import { nanoid } from '@/utils/uuid';
 

package/src/database/{models → client/models}/topic.ts

@@ -1,7 +1,7 @@
-import { BaseModel } from '@/database/core';
-import { DBModel } from '@/database/core/types/db';
-import { MessageModel } from '@/database/models/message';
-import { DB_Topic, DB_TopicSchema } from '@/database/schemas/topic';
+import { BaseModel } from '@/database/client/core';
+import { DBModel } from '@/database/client/core/types/db';
+import { MessageModel } from '@/database/client/models/message';
+import { DB_Topic, DB_TopicSchema } from '@/database/client/schemas/topic';
 import { ChatTopic } from '@/types/topic';
 import { nanoid } from '@/utils/uuid';
 

package/src/database/{models → client/models}/user.ts

@@ -1,6 +1,6 @@
 import { DeepPartial } from 'utility-types';
 
-import { BaseModel } from '@/database/core';
+import { BaseModel } from '@/database/client/core';
 import { GlobalSettings } from '@/types/settings';
 import { uuid } from '@/utils/uuid';
 

package/src/database/{schemas → client/schemas}/user.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-import { AgentSchema } from '@/database/schemas/session';
+import { AgentSchema } from '@/database/client/schemas/session';
 import { LobeMetaDataSchema } from '@/types/meta';
 
 const settingsSchema = z.object({

package/src/features/PluginDevModal/UrlManifestForm.tsx

@@ -7,7 +7,7 @@ import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 
 import ManifestPreviewer from '@/components/ManifestPreviewer';
-import { pluginService } from '@/services/plugin';
+import { toolService } from '@/services/tool';
 import { useToolStore } from '@/store/tool';
 import { pluginSelectors } from '@/store/tool/selectors';
 import { PluginInstallError } from '@/types/tool/plugin';
@@ -77,7 +77,7 @@ const UrlManifestForm = memo<{ form: FormInstance; isEditMode: boolean }>(
 
                 try {
                   const useProxy = form.getFieldValue(proxyKey);
-                  const data = await pluginService.getPluginManifest(value, useProxy);
+                  const data = await toolService.getPluginManifest(value, useProxy);
                   setManifest(data);
 
                   form.setFieldsValue({ identifier: data.identifier, manifest: data });

package/src/services/__tests__/__snapshots__/{plugin.test.ts.snap → tool.test.ts.snap}

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`PluginService > can parse the OpenAI plugin 1`] = `
+exports[`ToolService > can parse the OpenAI plugin 1`] = `
 {
   "api": [],
   "homepage": "https://products.wolframalpha.com/api/commercial-termsofuse",
@@ -78,7 +78,7 @@ getWolframCloudResults guidelines:
 }
 `;
 
-exports[`PluginService > getPluginManifest > support OpenAPI manifest > should get plugin manifest 1`] = `
+exports[`ToolService > getPluginManifest > support OpenAPI manifest > should get plugin manifest 1`] = `
 {
   "$schema": "../node_modules/@lobehub/chat-plugin-sdk/schema.json",
   "api": [

package/src/services/__tests__/chat.test.ts

@@ -9,7 +9,6 @@ import { DalleManifest } from '@/tools/dalle';
 import { ChatMessage } from '@/types/message';
 import { ChatStreamPayload } from '@/types/openai/chat';
 import { LobeTool } from '@/types/tool';
-import { FetchSSEOptions, fetchSSE } from '@/utils/fetch';
 
 import { chatService } from '../chat';