feat: manually mirror opencoze's code from bytedance

Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf
This commit is contained in:
fanlv
2025-07-20 17:36:12 +08:00
commit 890153324f
14811 changed files with 1923430 additions and 0 deletions

View File

@@ -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;

View File

@@ -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;

View File

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

View File

@@ -0,0 +1,16 @@
# @coze-common/md-editor-adapter
> 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`

View File

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

View File

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

View File

@@ -0,0 +1,43 @@
{
"name": "@coze-common/md-editor-adapter",
"version": "0.0.1",
"description": "markdown editor adapter",
"license": "Apache-2.0",
"author": "haozhenfei@bytedance.com",
"maintainers": [],
"main": "src/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/coze-design": "0.0.6-alpha.346d77",
"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",
"stylelint": "^15.11.0",
"vite-plugin-svgr": "~3.3.0",
"vitest": "~3.0.5"
},
"peerDependencies": {
"react": ">=18.2.0",
"react-dom": ">=18.2.0"
}
}

View File

@@ -0,0 +1,120 @@
/*
* 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.
*/
/* eslint-disable @typescript-eslint/no-explicit-any */
import {
useRef,
useImperativeHandle,
forwardRef,
useState,
useEffect,
} from 'react';
import { TextArea, withField } from '@coze-arch/coze-design';
import {
type EditorInputProps,
type EditorHandle,
type Editor,
type Delta,
} from './types';
export const EditorFullInputInner = forwardRef<EditorHandle, EditorInputProps>(
(props: EditorInputProps, ref) => {
const {
value: propsValue,
onChange: propsOnChange,
getEditor,
...restProps
} = props;
const [value, setValue] = useState(propsValue);
// 创建一个可变引用以存储最新的value值
const valueRef = useRef(value);
// 当value更新时同步更新valueRef
useEffect(() => {
valueRef.current = value;
}, [value]);
const editorRef = useRef<Editor>({
setHTML: (htmlContent: string) => {
setValue(htmlContent);
},
setText: (text: string) => {
setValue(text);
},
setContent: (content: { deltas: Delta[] }) => {
setValue(content.deltas[0].insert);
},
getContent: () => ({
deltas: [{ insert: valueRef.current ?? '' }],
}),
getText: () => valueRef.current || '',
getRootContainer: () => null,
getContentState: () => ({
getZoneState: (zone: any) => null,
}),
selection: {
getSelection: () => ({
start: 0,
end: 0,
zoneId: '0',
}),
},
registerCommand: () => null,
scrollModule: {
scrollTo: () => null,
},
on: () => null,
});
useImperativeHandle(ref, () => ({
setDeltaContent(delta) {
editorRef.current && delta && editorRef.current.setContent(delta);
},
getEditor() {
return editorRef.current;
},
getMarkdown() {
return editorRef.current?.getText() || '';
},
}));
useEffect(() => {
getEditor?.(editorRef.current);
}, [getEditor]);
return (
<TextArea
{...restProps}
value={value}
onChange={v => {
setValue(v);
propsOnChange?.(v);
}}
/>
);
},
);
export const EditorInput: typeof EditorFullInputInner = withField(
EditorFullInputInner,
{
valueKey: 'value',
onKeyChangeFnName: 'onChange',
},
);

View File

@@ -0,0 +1,65 @@
/*
* 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.
*/
/* eslint-disable @typescript-eslint/no-extraneous-class */
/* eslint-disable @typescript-eslint/no-explicit-any */
import type React from 'react';
import { lazy } from 'react';
import { type EditorInputProps } from './types';
export {
DEFAULT_ZONE,
displayType,
type EditorInputProps,
type EditorHandle,
type Delta,
type Editor,
type IRenderContext,
ToolbarItemEnum,
ZoneDelta,
IApplyMetadata,
DeltaSet,
DeltaSetOptions,
EditorEventType,
} from './types';
export const Text: React.FC<any> = () => null;
export const ToolbarButton: React.FC<any> = () => null;
export class Plugin {}
export {
md2html,
checkAndGetMarkdown,
delta2md,
normalizeSchema,
} from './utils';
const LazyEditorFullInput: React.FC<EditorInputProps> = lazy(() =>
import('./editor').then(module => ({
default: module.EditorInput,
})),
);
const LazyEditorFullInputInner: React.FC<EditorInputProps> = lazy(() =>
import('./editor').then(module => ({
default: module.EditorFullInputInner,
})),
);
export { LazyEditorFullInput, LazyEditorFullInputInner };

View File

@@ -0,0 +1,216 @@
/*
* 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.
*/
/* eslint-disable @typescript-eslint/naming-convention */
/* eslint-disable @typescript-eslint/no-explicit-any */
import { type CSSProperties } from 'react';
import { type CommonFieldProps } from '@coze-arch/coze-design';
export interface Delta {
insert: string;
}
export interface Editor {
setHTML: (htmlContent: string) => void;
setContent: (content: { deltas: Delta[] }) => void;
getContent: () => {
deltas: Delta[];
};
setText: (text: string) => void;
getText: () => string;
getRootContainer: () => HTMLDivElement | null;
getContentState: () => any;
selection: any;
registerCommand: (command: string, callback: () => void) => void;
scrollModule: {
scrollTo: (props: any) => void;
};
on: (event: string, callback: (...args: any[]) => void) => void;
}
export interface EditorHandle {
setDeltaContent: (delta?: any) => void;
getMarkdown: () => string;
getEditor: () => Editor;
}
export interface EditorInputProps extends CommonFieldProps {
value?: string;
className?: string;
style?: CSSProperties;
onChange?: (value: string) => void;
onFocus?: () => void;
onBlur?: () => void;
placeholder?: string;
validateStatus?: 'error' | 'default';
/**
* 注册自定义插件
* @param plugins
*/
registerPlugins?: any;
/**
* 自定义toolbar
*/
registerToolItem?: any;
/** 自定义schema */
schema?: any;
businessKey?: string; // 用于注册toolbar
getMentionData?: (query?: string) => Promise<any[]>;
maxCount?: number; // 字符数显示,默认为-1不限制
disabled?: boolean; // 禁用
noToolbar?: boolean; // 隐藏工具栏
noExpand?: boolean; // 右下角展开icon
onExpand?: () => void; // 点击展开icon
/**
* 开启 plainText 模式后,输入内容与原生 textarea 不会有区别,会取消 markdown 支持,并隐藏 toolbar会覆盖 noToolbar 属性)
* @default false
*/
plainText?: boolean;
withInputTitle?: {
placeholder: string;
maxCount?: number;
onChange: (value: string) => void;
}; // 带标题编辑器(类似飞书,标题和正文在一起)
getUploadToken?: () => Promise<any>; // 自定义获取上传图片的token
getImgURL?: (req?: any) => Promise<any>; // 自定义根据图片uri获取图片url
getEditor?: (editor: Editor) => void;
}
export interface IRenderContext {
insert: string;
domAttributes: {
[key: string]: any;
};
key: string;
children: JSX.Element;
style: React.CSSProperties;
index: number;
zoneId: string;
}
export interface IApplyMetadata {
id: string;
type: string;
options: any;
}
export enum displayType {
inline = 'inline',
block = 'block',
}
export enum ToolbarItemEnum {
Bold = 'Bold',
Italic = 'Italic',
Underline = 'Underline',
Undo = 'Undo',
Redo = 'Redo',
Strikethrough = 'Strikethrough',
Blockquote = 'Blockquote',
UnorderedList = 'UnorderedList',
OrderedList = 'OrderedList',
Checkbox = 'Checkbox',
Indent = 'Indent',
H1 = 'H1',
H2 = 'H2',
H3 = 'H3',
AlignCenter = 'AlignCenter',
AlignLeft = 'AlignLeft',
AlignRight = 'AlignRight',
HorizontalLine = 'HorizontalLine',
Hyperlink = 'Hyperlink',
Image = 'Image',
Table = 'Table',
CodeBlock = 'CodeBlock',
Video = 'Video',
DIVIDER = 'DIVIDER',
ColorPicker = 'ColorPicker',
FontSizeDropdown = 'FontSizeDropdown',
AlignDropdown = 'AlignDropdown',
HeadingDropdown = 'HeadingDropdown',
FontFamilyDropdown = 'FontFamilyDropdown',
}
export const DEFAULT_ZONE = '0';
export const ZoneDelta: any = {};
export interface MentionType {
avatar_url: string;
cn_name: string;
en_name: string;
type: string;
id: string;
}
export interface Delta2mdResult {
markdown: string;
images?: string[];
links?: string[];
mentions?: MentionType[];
codeblocks: string[];
}
export class DeltaSet {
constructor(public deltas: Delta[]) {
this.deltas = deltas;
}
}
export type DeltaSetOptions =
| Delta[]
| {
[zoneId: string]: {
zoneId: string;
ops: any;
zoneType: any;
};
};
export enum EditorEventType {
DID_PASTE = 'didPaste',
RESIZE = 'resize',
RECT_CHANGE = 'rectchange',
SELECTION_CHANGE = 'selectionchange',
SELECTION_CHANGE_AND_DOM_UPDATE = 'editorUpdateDomSelection',
CONTENT_WILL_CHANGE = 'contentWillChange',
CONTENT_CHANGE = 'contentchange',
EDITABLE_CHANGE = 'editablechange',
PAINT = 'paint',
COPY = 'copy',
CUT = 'cut',
PASTE = 'paste',
WILL_DELETE_FROM_CUT = 'willDeleteFromCut',
INPUT = 'input',
BEFORE_INPUT = 'beforeinput',
KEYDOWN = 'keydown',
KEYPRESS = 'keypress',
KEYUP = 'keyup',
EXEC_COMMAND = 'execCommand',
ERROR = 'error',
DELETE_KEY = 'keyDelete',
FOCUS = 'focus',
BLUR = 'blur',
SCROLL_END = 'scrollend',
SCROLL = 'scroll',
KEYBAORDCHANGE = 'keyboardchange',
COMPOSITION_END = 'compositionend',
COMPOSITION_START = 'compositionstart',
COMPOSITION_UPDATE = 'compositionupdate',
REACT_CONTEXT_UPDATE = 'reactContextUpdate',
BEFORE_DOM_RENDERER_RECONCILE = 'beforeDomRendererReconcile',
AFTER_DOM_RENDERER_RECONCILE = 'afterDomRendererReconcile',
UNDO_DID_INIT = 'undoDidInit',
}

View File

@@ -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' />

View File

@@ -0,0 +1,57 @@
/*
* 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.
*/
/* eslint-disable @typescript-eslint/no-explicit-any */
import { type Delta, type Editor } from './types';
/**
* 空实现,用于开闭源统一
* @param md
* @returns
*/
export const md2html = (md: string) => md;
export const delta2md = (
delta: Delta,
zoneDelta: unknown,
ignoreAttr = false,
) => ({
markdown: delta.insert,
images: [],
links: [],
mentions: [],
codeblocks: [],
});
export const checkAndGetMarkdown = ({
editor,
}: {
editor: Editor;
validate: boolean;
onImageUploadProgress?: any;
}) => ({
content: editor.getText(),
images: [],
links: [],
});
/* eslint-disable @typescript-eslint/no-explicit-any */
export const normalizeSchema = (input: any): any => ({
'0': {
zoneType: input[0]?.zoneType,
zoneId: input[0]?.zoneId,
ops: input[0]?.ops,
},
});

View File

@@ -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',
},
};

View File

@@ -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>

View File

@@ -0,0 +1,36 @@
{
"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-typings/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"
}
]
}

View File

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

View File

@@ -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"
}
]
}

View File

@@ -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',
});