feat: manually mirror opencoze's code from bytedance

Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf

frontend/packages/common/chat-area/plugin-chat-background/.storybook/main.js

@@ -0,0 +1,31 @@
+import { mergeConfig } from 'vite';
+import svgr from 'vite-plugin-svgr';
+
+/** @type { import('@storybook/react-vite').StorybookConfig } */
+const config = {
+  stories: ['../stories/**/*.mdx', '../stories/**/*.stories.tsx'],
+  addons: [
+    '@storybook/addon-links',
+    '@storybook/addon-essentials',
+    '@storybook/addon-onboarding',
+    '@storybook/addon-interactions',
+  ],
+  framework: {
+    name: '@storybook/react-vite',
+    options: {},
+  },
+  docs: {
+    autodocs: 'tag',
+  },
+  viteFinal: config =>
+    mergeConfig(config, {
+      plugins: [
+        svgr({
+          svgrOptions: {
+            native: false,
+          },
+        }),
+      ],
+    }),
+};
+export default config;

frontend/packages/common/chat-area/plugin-chat-background/.storybook/preview.js

@@ -0,0 +1,14 @@
+/** @type { import('@storybook/react').Preview } */
+const preview = {
+  parameters: {
+    actions: { argTypesRegex: "^on[A-Z].*" },
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/i,
+      },
+    },
+  },
+};
+
+export default preview;

frontend/packages/common/chat-area/plugin-chat-background/.stylelintrc.js

@@ -0,0 +1,5 @@
+const { defineConfig } = require('@coze-arch/stylelint-config');
+
+module.exports = defineConfig({
+  extends: [],
+});

frontend/packages/common/chat-area/plugin-chat-background/README.md

@@ -0,0 +1,16 @@
+# @coze-common/chat-area-plugin-chat-background
+
+> Project template for react component with storybook.
+
+## Features
+
+- [x] eslint & ts
+- [x] esm bundle
+- [x] umd bundle
+- [x] storybook
+
+## Commands
+
+- init: `rush update`
+- dev: `npm run dev`
+- build: `npm run build`

frontend/packages/common/chat-area/plugin-chat-background/config/rush-project.json

@@ -0,0 +1,12 @@
+{
+  "operationSettings": [
+    {
+      "operationName": "test:cov",
+      "outputFolderNames": ["coverage"]
+    },
+    {
+      "operationName": "ts-check",
+      "outputFolderNames": ["./dist"]
+    }
+  ]
+}

frontend/packages/common/chat-area/plugin-chat-background/eslint.config.js

@@ -0,0 +1,7 @@
+const { defineConfig } = require('@coze-arch/eslint-config');
+
+module.exports = defineConfig({
+  packageRoot: __dirname,
+  preset: 'web',
+  rules: {},
+});

frontend/packages/common/chat-area/plugin-chat-background/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@coze-common/chat-area-plugin-chat-background",
+  "version": "0.0.1",
+  "description": "chat area plugin chat-background",
+  "license": "Apache-2.0",
+  "author": "zhangnan.615@bytedance.com",
+  "maintainers": [],
+  "main": "src/index.ts",
+  "scripts": {
+    "build": "exit 0",
+    "lint": "eslint ./ --cache",
+    "test": "vitest --run --passWithNoTests",
+    "test:cov": "npm run test -- --coverage"
+  },
+  "dependencies": {
+    "@coze-arch/bot-api": "workspace:*",
+    "@coze-common/chat-area": "workspace:*",
+    "@coze-common/chat-uikit": "workspace:*",
+    "@coze-studio/bot-detail-store": "workspace:*",
+    "classnames": "^2.3.2",
+    "immer": "^10.0.3",
+    "mitt": "^3.0.1",
+    "zustand": "^4.4.7"
+  },
+  "devDependencies": {
+    "@coze-arch/bot-typings": "workspace:*",
+    "@coze-arch/eslint-config": "workspace:*",
+    "@coze-arch/i18n": "workspace:*",
+    "@coze-arch/stylelint-config": "workspace:*",
+    "@coze-arch/ts-config": "workspace:*",
+    "@coze-arch/vitest-config": "workspace:*",
+    "@testing-library/jest-dom": "^6.1.5",
+    "@testing-library/react": "^14.1.2",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@types/react": "18.2.37",
+    "@types/react-dom": "18.2.15",
+    "@vitest/coverage-v8": "~3.0.5",
+    "react": "~18.2.0",
+    "react-dom": "~18.2.0",
+    "stylelint": "^15.11.0",
+    "vite-plugin-svgr": "~3.3.0",
+    "vitest": "~3.0.5"
+  },
+  "peerDependencies": {
+    "react": ">=18.2.0",
+    "react-dom": ">=18.2.0"
+  },
+  "// deps": "immer@^10.0.3 为脚本自动补齐，请勿改动"
+}
+

frontend/packages/common/chat-area/plugin-chat-background/src/custom-components/chat-background-ui/index.module.less

@@ -0,0 +1,11 @@
+.mask {
+  pointer-events: none;
+
+  position: absolute;
+  z-index: 10;
+
+  width: 100%;
+  height: 216px;
+
+  background: linear-gradient(180deg, rgba(99, 99, 99, 40%) 0%, rgba(99, 99, 99, 0%) 100%);
+}

frontend/packages/common/chat-area/plugin-chat-background/src/custom-components/chat-background-ui/index.tsx

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import { useShallow } from 'zustand/react/shallow';
+import { WithRuleImgBackground } from '@coze-common/chat-uikit';
+import {
+  type CustomComponent,
+  useReadonlyPlugin,
+  PluginName,
+} from '@coze-common/chat-area';
+
+import { type BackgroundPluginBizContext } from '../../types/biz-context';
+
+import styles from './index.module.less';
+
+export const ChatBackgroundUI: CustomComponent['MessageListFloatSlot'] = ({
+  headerNode,
+}) => {
+  const plugin = useReadonlyPlugin<BackgroundPluginBizContext>(
+    PluginName.ChatBackground,
+  );
+  const { useChatBackgroundContext } = plugin.pluginBizContext.storeSet;
+  const backgroundImageInfo = useChatBackgroundContext(
+    useShallow(state => state.backgroundImageInfo),
+  );
+  const isBackgroundMode =
+    !!backgroundImageInfo?.mobile_background_image?.origin_image_url;
+
+  return isBackgroundMode ? (
+    <>
+      {headerNode ? <div className={styles.mask}></div> : null}
+      <WithRuleImgBackground backgroundInfo={backgroundImageInfo} />
+    </>
+  ) : null;
+};

frontend/packages/common/chat-area/plugin-chat-background/src/index.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import mitt from 'mitt';
+import { type PluginRegistryEntry } from '@coze-common/chat-area';
+
+import {
+  type BackgroundPluginBizContext,
+  type ChatBackgroundEvent,
+} from './types/biz-context';
+import { createBackgroundImageStore } from './store';
+import { BizPlugin } from './plugin';
+
+export const chatBackgroundEvent = mitt<ChatBackgroundEvent>();
+export {
+  ChatBackgroundEvent,
+  ChatBackgroundEventName,
+} from './types/biz-context';
+
+export const createChatBackgroundPlugin = () => {
+  const useChatBackgroundContext = createBackgroundImageStore('chatBackground');
+
+  // eslint-disable-next-line @typescript-eslint/naming-convention -- 插件命名大写开头符合预期
+  const ChatBackgroundPlugin: PluginRegistryEntry<BackgroundPluginBizContext> =
+    {
+      createPluginBizContext() {
+        return {
+          storeSet: {
+            useChatBackgroundContext,
+          },
+          chatBackgroundEvent,
+        };
+      },
+      Plugin: BizPlugin,
+    };
+  return {
+    ChatBackgroundPlugin,
+  };
+};

frontend/packages/common/chat-area/plugin-chat-background/src/plugin.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import {
+  PluginMode,
+  PluginName,
+  ReadonlyChatAreaPlugin,
+  createCustomComponents,
+  createReadonlyLifeCycleServices,
+  type ReadonlyLifeCycleServiceGenerator,
+} from '@coze-common/chat-area';
+
+import { type BackgroundPluginBizContext } from './types/biz-context';
+import { bizAppLifeCycleService } from './services/life-cycle/app';
+import { ChatBackgroundUI } from './custom-components/chat-background-ui';
+
+export const bizLifeCycleServiceGenerator: ReadonlyLifeCycleServiceGenerator<
+  BackgroundPluginBizContext
+> = plugin => ({
+  appLifeCycleService: bizAppLifeCycleService(plugin),
+});
+
+export class BizPlugin extends ReadonlyChatAreaPlugin<BackgroundPluginBizContext> {
+  public pluginMode = PluginMode.Readonly;
+
+  public pluginName = PluginName.ChatBackground;
+
+  public lifeCycleServices = createReadonlyLifeCycleServices(
+    this,
+    bizLifeCycleServiceGenerator,
+  );
+
+  public customComponents = createCustomComponents({
+    MessageListFloatSlot: ChatBackgroundUI,
+  });
+}

frontend/packages/common/chat-area/plugin-chat-background/src/services/life-cycle/app.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import { type ReadonlyAppLifeCycleServiceGenerator } from '@coze-common/chat-area';
+
+import {
+  ChatBackgroundEventName,
+  type BackgroundPluginBizContext,
+} from '../../types/biz-context';
+
+export const bizAppLifeCycleService: ReadonlyAppLifeCycleServiceGenerator<
+  BackgroundPluginBizContext
+> = plugin => ({
+  onBeforeInitial: () => {
+    const { chatBackgroundEvent, storeSet } = plugin.pluginBizContext;
+
+    const { setBackgroundInfo } = storeSet.useChatBackgroundContext.getState();
+
+    chatBackgroundEvent.on(
+      ChatBackgroundEventName.OnBackgroundChange,
+      backgroundInfo => {
+        setBackgroundInfo(backgroundInfo);
+      },
+    );
+  },
+
+  onAfterInitial: ctx => {
+    const { setBackgroundInfo, clearBackgroundStore } =
+      plugin.pluginBizContext.storeSet.useChatBackgroundContext.getState();
+    const ctxBackgroundInfo = ctx.messageListFromService.backgroundInfo;
+    if (ctxBackgroundInfo) {
+      setBackgroundInfo(ctxBackgroundInfo);
+    } else {
+      clearBackgroundStore();
+    }
+  },
+
+  onBeforeDestroy: () => {
+    const { chatBackgroundEvent } = plugin.pluginBizContext;
+    chatBackgroundEvent.all.clear();
+  },
+});

frontend/packages/common/chat-area/plugin-chat-background/src/store.ts

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import { devtools } from 'zustand/middleware';
+import { create } from 'zustand';
+import { type BackgroundImageInfo } from '@coze-arch/bot-api/developer_api';
+
+interface BackgroundImageState {
+  backgroundImageInfo: BackgroundImageInfo;
+}
+
+interface BackgroundImageAction {
+  setBackgroundInfo: (backgroundImageInfo: BackgroundImageInfo) => void;
+  clearBackgroundStore: () => void;
+}
+
+export const createBackgroundImageStore = (mark: string) =>
+  create<BackgroundImageState & BackgroundImageAction>()(
+    devtools(
+      set => ({
+        backgroundImageInfo: {
+          mobile_background_image: {},
+          web_background_image: {},
+        },
+        clearBackgroundStore: () =>
+          set(
+            {
+              backgroundImageInfo: {
+                mobile_background_image: {},
+                web_background_image: {},
+              },
+            },
+            false,
+            'clearBackgroundStore',
+          ),
+        setBackgroundInfo: info => {
+          set({ backgroundImageInfo: info }, false, 'setBackgroundInfo');
+        },
+      }),
+      {
+        name: `botStudio.ChatBackground.${mark}`,
+        enabled: IS_DEV_MODE,
+      },
+    ),
+  );
+
+export type BackgroundImageStore = ReturnType<
+  typeof createBackgroundImageStore
+>;

frontend/packages/common/chat-area/plugin-chat-background/src/types/biz-context.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import { type Emitter } from 'mitt';
+import { type BackgroundImageInfo } from '@coze-arch/bot-api/developer_api';
+
+import { type BackgroundImageStore } from '../store';
+
+export enum ChatBackgroundEventName {
+  OnBackgroundChange = 'onBackgroundChange',
+}
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export type ChatBackgroundEvent = {
+  [ChatBackgroundEventName.OnBackgroundChange]: BackgroundImageInfo;
+};
+
+export interface BackgroundPluginBizContext {
+  storeSet: {
+    useChatBackgroundContext: BackgroundImageStore;
+  };
+  chatBackgroundEvent: Emitter<ChatBackgroundEvent>;
+}

frontend/packages/common/chat-area/plugin-chat-background/src/typings.d.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+/// <reference types='@coze-arch/bot-typings' />

frontend/packages/common/chat-area/plugin-chat-background/stories/hello.mdx

@@ -0,0 +1,34 @@
+import { Meta } from "@storybook/blocks";
+
+<Meta title="Hello world" />
+
+<div className="sb-container">
+  <div className='sb-section-title'>
+    # Hello world
+
+    Hello world
+  </div>
+</div>
+
+<style>
+  {`
+  .sb-container {
+    margin-bottom: 48px;
+  }
+
+  .sb-section {
+    width: 100%;
+    display: flex;
+    flex-direction: row;
+    gap: 20px;
+  }
+
+  img {
+    object-fit: cover;
+  }
+
+  .sb-section-title {
+    margin-bottom: 32px;
+  }
+  `}
+</style>

frontend/packages/common/chat-area/plugin-chat-background/tsconfig.build.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@coze-arch/ts-config/tsconfig.web.json",
+  "compilerOptions": {
+    "types": [],
+    "strictNullChecks": true,
+    "noImplicitAny": true,
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "tsBuildInfoFile": "./dist/tsconfig.build.tsbuildinfo"
+  },
+  "include": ["src"],
+  "references": [
+    {
+      "path": "../../../arch/bot-api/tsconfig.build.json"
+    },
+    {
+      "path": "../../../arch/bot-typings/tsconfig.build.json"
+    },
+    {
+      "path": "../../../arch/i18n/tsconfig.build.json"
+    },
+    {
+      "path": "../chat-area/tsconfig.build.json"
+    },
+    {
+      "path": "../chat-uikit/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../config/eslint-config/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../config/stylelint-config/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../config/ts-config/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../config/vitest-config/tsconfig.build.json"
+    },
+    {
+      "path": "../../../studio/stores/bot-detail/tsconfig.build.json"
+    }
+  ]
+}

frontend/packages/common/chat-area/plugin-chat-background/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "composite": true
+  },
+  "references": [
+    {
+      "path": "./tsconfig.build.json"
+    },
+    {
+      "path": "./tsconfig.misc.json"
+    }
+  ],
+  "exclude": ["**/*"]
+}

frontend/packages/common/chat-area/plugin-chat-background/tsconfig.misc.json

@@ -0,0 +1,18 @@
+{
+  "extends": "@coze-arch/ts-config/tsconfig.web.json",
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "include": ["__tests__", "stories", "vitest.config.ts", "tailwind.config.ts"],
+  "exclude": ["./dist"],
+  "references": [
+    {
+      "path": "./tsconfig.build.json"
+    }
+  ],
+  "compilerOptions": {
+    "rootDir": "./",
+    "outDir": "./dist",
+    "types": ["vitest/globals"],
+    "strictNullChecks": true,
+    "noImplicitAny": true
+  }
+}

frontend/packages/common/chat-area/plugin-chat-background/vitest.config.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+import { defineConfig } from '@coze-arch/vitest-config';
+
+export default defineConfig({
+  dirname: __dirname,
+  preset: 'web',
+});