feat: manually mirror opencoze's code from bytedance

Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf

frontend/packages/data/knowledge/common/hooks/.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/data/knowledge/common/hooks/.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/data/knowledge/common/hooks/.stylelintrc.js

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

frontend/packages/data/knowledge/common/hooks/README.md

@@ -0,0 +1,16 @@
+# @coze-data/knowledge-common-hooks
+
+> 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/data/knowledge/common/hooks/config/rush-project.json

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

frontend/packages/data/knowledge/common/hooks/eslint.config.js

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

frontend/packages/data/knowledge/common/hooks/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@coze-data/knowledge-common-hooks",
+  "version": "0.0.1",
+  "description": "知识库通用hooks",
+  "license": "Apache-2.0",
+  "author": "haozhenfei@bytedance.com",
+  "maintainers": [],
+  "exports": {
+    ".": "./src/index.tsx",
+    "./use-case": "./src/use-case/index.tsx"
+  },
+  "main": "src/index.tsx",
+  "typesVersions": {
+    "*": {
+      "use-case": [
+        "./src/use-case/index.tsx"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "exit 0",
+    "lint": "eslint ./ --cache",
+    "test": "vitest --run --passWithNoTests",
+    "test:cov": "npm run test -- --coverage"
+  },
+  "dependencies": {
+    "@coze-arch/bot-api": "workspace:*",
+    "@coze-arch/bot-error": "workspace:*",
+    "@coze-arch/bot-studio-store": "workspace:*",
+    "@coze-arch/coze-design": "0.0.6-alpha.346d77",
+    "@coze-arch/i18n": "workspace:*",
+    "@coze-arch/logger": "workspace:*",
+    "@coze-data/knowledge-common-services": "workspace:*",
+    "ahooks": "^3.7.8",
+    "classnames": "^2.3.2"
+  },
+  "devDependencies": {
+    "@coze-arch/bot-typings": "workspace:*",
+    "@coze-arch/eslint-config": "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",
+    "react-router-dom": "^6.22.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"
+  }
+}
+

frontend/packages/data/knowledge/common/hooks/src/index.tsx

@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+ 
+export { useKnowledgeNavigate } from './use-case/use-knowledge-navigate';
+export { useGetKnowledgeListInfo } from './use-case/use-get-knowledge-list-info';
+export { useTosContent } from './use-case/use-tos-content';

frontend/packages/data/knowledge/common/hooks/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/data/knowledge/common/hooks/src/use-case/index.tsx

@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+ 
+export { useGetKnowledgeListInfo } from './use-get-knowledge-list-info';
+export { useKnowledgeNavigate } from './use-knowledge-navigate';
+export { useTosContent } from './use-tos-content';

frontend/packages/data/knowledge/common/hooks/src/use-case/use-get-knowledge-list-info.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 { useRequest } from 'ahooks';
+import { useSpaceStore } from '@coze-arch/bot-studio-store';
+import { useErrorHandler } from '@coze-arch/logger';
+import { I18n } from '@coze-arch/i18n';
+import { CustomError } from '@coze-arch/bot-error';
+import { KnowledgeApi } from '@coze-arch/bot-api';
+import { Toast } from '@coze-arch/coze-design';
+
+export const useGetKnowledgeListInfo = (params: { datasetID: string }) => {
+  const spaceId = useSpaceStore(s => s.space.id);
+  const cacheKey = `dataset-${params.datasetID}`;
+  const capture = useErrorHandler();
+  return useRequest(
+    async () => {
+      if (!params.datasetID) {
+        throw new CustomError(
+          'useListDataSetReq_error',
+          'datasetid cannot be empty',
+        );
+      }
+      const res = await KnowledgeApi.ListDataset({
+        filter: {
+          dataset_ids: [params.datasetID],
+        },
+        space_id: spaceId,
+      });
+
+      if (res?.total) {
+        return res?.dataset_list?.find(i => i.dataset_id === params.datasetID);
+      } else if (res?.total !== 0) {
+        capture(new CustomError('useListDataSetReq_error', res.msg || ''));
+      }
+    },
+    {
+      cacheKey,
+      setCache: data => sessionStorage.setItem(cacheKey, JSON.stringify(data)),
+      getCache: () => JSON.parse(sessionStorage.getItem(cacheKey) || '{}'),
+      onError: error => {
+        Toast.error({
+          content: I18n.t('Network_error'),
+          showClose: false,
+        });
+        capture(error);
+      },
+    },
+  );
+};

frontend/packages/data/knowledge/common/hooks/src/use-case/use-knowledge-navigate.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 {
+  useNavigate,
+  type To,
+  type Path,
+  type NavigateOptions,
+} from 'react-router-dom';
+
+import { getKnowledgeIDEQuery } from '@coze-data/knowledge-common-services/use-case';
+
+/** knowledge 模块专用的 useNavigate，用于持久化公共 query 参数 */
+export const useKnowledgeNavigate: typeof useNavigate = () => {
+  const navigate = useNavigate();
+  const knowledgePageQuery = getKnowledgeIDEQuery();
+  const overwriteNavigate = (to: To | number, opt?: NavigateOptions) => {
+    if (typeof to === 'string') {
+      const toPathname = to.startsWith('/') ? to : `${location.pathname}/${to}`;
+      const urlObject = new URL(toPathname, window.location.origin);
+      Object.entries(knowledgePageQuery).forEach(([queryKey, queryValue]) => {
+        if (queryValue && !urlObject.searchParams.has(queryKey)) {
+          urlObject.searchParams.set(queryKey, queryValue);
+        }
+      });
+      const { pathname, search } = urlObject;
+      return navigate(`${pathname}${search}`, opt);
+    }
+    if (isPathType(to)) {
+      const { search } = to;
+      const searchParams = new URLSearchParams(search);
+      Object.entries(knowledgePageQuery).forEach(([queryKey, queryValue]) => {
+        if (queryValue && !searchParams.has(queryKey)) {
+          searchParams.set(queryKey, queryValue);
+        }
+      });
+      return navigate({ ...to, search: searchParams.toString() }, opt);
+    }
+    if (isNumberType(to)) {
+      return navigate(to);
+    }
+    return navigate(to, opt);
+  };
+
+  return overwriteNavigate;
+};
+
+const isPathType = (to: To | number): to is Partial<Path> =>
+  typeof to === 'object';
+const isNumberType = (to: To | number): to is number => typeof to === 'number';

frontend/packages/data/knowledge/common/hooks/src/use-case/use-tos-content.tsx

@@ -0,0 +1,41 @@
+/*
+ * 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 { useRequest } from 'ahooks';
+
+export const useTosContent = (tosUrl?: string) => {
+  const {
+    data: content,
+    loading,
+    error,
+  } = useRequest(
+    async () => {
+      if (!tosUrl) {
+        return null;
+      }
+      const response = await fetch(tosUrl, { cache: 'no-cache' });
+      if (!response.ok) {
+        throw new Error('Failed to fetch content');
+      }
+      return response.json();
+    },
+    {
+      refreshDeps: [tosUrl],
+    },
+  );
+
+  return { content, loading, error };
+};

frontend/packages/data/knowledge/common/hooks/stories/demo.stories.tsx

@@ -0,0 +1,37 @@
+/*
+ * 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 { DemoComponent } from '../src';
+
+export default {
+  title: 'Example/Demo',
+  component: DemoComponent,
+  parameters: {
+    // Optional parameter to center the component in the Canvas. More info: https://storybook.js.org/docs/configure/story-layout
+    layout: 'centered',
+  },
+  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
+  tags: ['autodocs'],
+  // More on argTypes: https://storybook.js.org/docs/api/argtypes
+  argTypes: {},
+};
+
+// More on writing stories with args: https://storybook.js.org/docs/writing-stories/args
+export const Base = {
+  args: {
+    name: 'tecvan',
+  },
+};

frontend/packages/data/knowledge/common/hooks/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/data/knowledge/common/hooks/tsconfig.build.json

@@ -0,0 +1,51 @@
+{
+  "extends": "@coze-arch/ts-config/tsconfig.web.json",
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "jsx": "react-jsx",
+    "lib": ["DOM", "ESNext"],
+    "module": "ESNext",
+    "target": "ES2020",
+    "moduleResolution": "bundler",
+    "tsBuildInfoFile": "dist/tsconfig.build.tsbuildinfo"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"],
+  "references": [
+    {
+      "path": "../../../../arch/bot-api/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../arch/bot-error/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../arch/bot-store/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../arch/bot-typings/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../arch/i18n/tsconfig.build.json"
+    },
+    {
+      "path": "../../../../arch/logger/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": "../services/tsconfig.build.json"
+    }
+  ]
+}

frontend/packages/data/knowledge/common/hooks/tsconfig.json

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

frontend/packages/data/knowledge/common/hooks/tsconfig.misc.json

@@ -0,0 +1,20 @@
+{
+  "extends": "@coze-arch/ts-config/tsconfig.web.json",
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "rootDir": "./",
+    "outDir": "./dist",
+    "jsx": "react-jsx",
+    "lib": ["DOM", "ESNext"],
+    "module": "ESNext",
+    "target": "ES2020",
+    "moduleResolution": "bundler"
+  },
+  "include": ["__tests__", "vitest.config.ts", "stories"],
+  "exclude": ["./dist"],
+  "references": [
+    {
+      "path": "./tsconfig.build.json"
+    }
+  ]
+}

frontend/packages/data/knowledge/common/hooks/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',
+});