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,70 @@
# @coze-foundation/space-store
基座中的空间store
## Overview
This package is part of the Coze Studio monorepo and provides state management functionality. It includes hook, adapter, store.
## Getting Started
### Installation
Add this package to your `package.json`:
```json
{
"dependencies": {
"@coze-foundation/space-store": "workspace:*"
}
}
```
Then run:
```bash
rush update
```
### Usage
```typescript
import { /* exported functions/components */ } from '@coze-foundation/space-store';
// Example usage
// TODO: Add specific usage examples
```
## Features
- Hook
- Adapter
- Store
## API Reference
### Exports
- `useSpaceStore`
- `useSpace, useSpaceList, useRefreshSpaces`
- `useSpaceApp`
For detailed API documentation, please refer to the TypeScript definitions.
## Development
This package is built with:
- TypeScript
- Modern JavaScript
- Vitest for testing
- ESLint for code quality
## Contributing
This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.
## License
Apache-2.0

View File

@@ -0,0 +1,73 @@
/*
* 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-next-line @coze-arch/no-batch-import-or-export, @typescript-eslint/consistent-type-imports
import * as zustand from 'zustand';
import { act } from '@testing-library/react';
const { create: actualCreate, createStore: actualCreateStore } =
// @ts-expect-error -- UT 忽略
await vi.importActual<typeof zustand>('zustand');
// a variable to hold reset functions for all stores declared in the app
export const storeResetFns = new Set<() => void>();
const createUncurried = <T>(stateCreator: zustand.StateCreator<T>) => {
const store = actualCreate(stateCreator);
const initialState = store.getState();
storeResetFns.add(() => {
store.setState(initialState, true);
});
return store;
};
// when creating a store, we get its initial state, create a reset function and add it in the set
export const create = (<T>(stateCreator: zustand.StateCreator<T>) => {
console.log('zustand create mock');
// to support curried version of create
return typeof stateCreator === 'function'
? createUncurried(stateCreator)
: createUncurried;
}) as typeof zustand.create;
const createStoreUncurried = <T>(stateCreator: zustand.StateCreator<T>) => {
const store = actualCreateStore(stateCreator);
const initialState = store.getState();
storeResetFns.add(() => {
store.setState(initialState, true);
});
return store;
};
// when creating a store, we get its initial state, create a reset function and add it in the set
export const createStore = (<T>(stateCreator: zustand.StateCreator<T>) => {
console.log('zustand createStore mock');
// to support curried version of createStore
return typeof stateCreator === 'function'
? createStoreUncurried(stateCreator)
: createStoreUncurried;
}) as typeof zustand.createStore;
// reset all stores after each test run
afterEach(() => {
act(() => {
storeResetFns.forEach(resetFn => {
resetFn();
});
});
});

View File

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

View File

@@ -0,0 +1,6 @@
{
"codecov": {
"coverage": 0,
"incrementCoverage": 0
}
}

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,52 @@
{
"name": "@coze-foundation/space-store",
"version": "0.0.1",
"description": "基座中的空间store",
"license": "Apache-2.0",
"author": "yuwenbinjie@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-arch/bot-error": "workspace:*",
"@coze-arch/bot-flags": "workspace:*",
"@coze-arch/logger": "workspace:*",
"@coze-arch/report-events": "workspace:*",
"@coze-foundation/enterprise-store-adapter": "workspace:*",
"@coze-foundation/space-store-adapter": "workspace:*",
"classnames": "^2.3.2",
"immer": "^10.0.3",
"react-router-dom": "^6.22.0",
"zustand": "^4.4.7"
},
"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"
},
"// deps": "immer@^10.0.3 为脚本自动补齐,请勿改动"
}

View File

@@ -0,0 +1,18 @@
/*
* 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.
*/
vi.stubGlobal('IS_DEV_MODE', false);
vi.mock('zustand');

View File

@@ -0,0 +1,44 @@
/*
* 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 { useLocation } from 'react-router-dom';
import { renderHook } from '@testing-library/react-hooks';
import { useSpaceApp } from '../use-space-app';
vi.mock('react-router-dom', () => ({
useLocation: vi.fn(),
}));
describe('useSpaceApp', () => {
it('should return subpathName as spaceApp when url pattern matches', () => {
const mockLocationArr = [
['/space/123/app1', 'app1'],
['/space/123/app2/123', 'app2'],
];
mockLocationArr.forEach(([pathname, spaceApp]) => {
vi.mocked(useLocation).mockReturnValueOnce({ pathname } as any);
const { result } = renderHook(() => useSpaceApp());
expect(result.current).toEqual(spaceApp);
});
});
it('should return undefined when url pattern not matches', () => {
vi.mocked(useLocation).mockReturnValueOnce({ pathname: '/space' } as any);
const { result } = renderHook(() => useSpaceApp());
expect(result.current).toEqual(undefined);
});
});

View File

@@ -0,0 +1,36 @@
/*
* 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 { useLocation } from 'react-router-dom';
/**
* 从URL上获取工作空间子模块
* @param pathname
* @returns 工作子模块字符串,如果不匹配则返回 undefined
*/
const getSpaceApp = (pathname: string): string | undefined => {
// 以 /space/ 开头,后面跟 spaceId再跟子模块只允许字母、数字、-、_
const match = pathname.match(/^\/space\/[^/]+\/([A-Za-z0-9_-]+)/);
return match ? match[1] : undefined;
};
export const useSpaceApp = () => {
const { pathname } = useLocation();
const spaceApp = getSpaceApp(pathname);
return spaceApp;
};

View File

@@ -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 { useSpaceStore } from '@coze-foundation/space-store-adapter';
export { useSpace, useSpaceList, useRefreshSpaces } from './space/hooks';
export { useSpaceApp } from './hooks/use-space-app';

View File

@@ -0,0 +1,76 @@
/*
* 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 Mock } from 'vitest';
import { renderHook } from '@testing-library/react-hooks';
import { useSpaceStore } from '@coze-foundation/space-store-adapter';
import { useRefreshSpaces } from '../hooks';
vi.mock('@coze-foundation/space-store-adapter', () => ({
useSpaceStore: {
getState: vi.fn(),
},
}));
vi.mock('@coze-foundation/enterprise-store-adapter', () => ({
useCurrentEnterpriseInfo: () => null,
}));
describe('useRefreshSpaces', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('should set loading to true and fetch spaces when refresh is true', async () => {
const mockFetchSpaces = vi.fn().mockResolvedValue([]);
(useSpaceStore.getState as Mock).mockReturnValue({
inited: true,
fetchSpaces: mockFetchSpaces,
});
const { result, waitForNextUpdate } = renderHook(() =>
useRefreshSpaces(true),
);
expect(result.current).toBe(true);
expect(mockFetchSpaces).toHaveBeenCalledTimes(1);
await waitForNextUpdate();
expect(result.current).toBe(false);
});
it('should set loading to false when refresh is false and spaces are already initialized', () => {
(useSpaceStore.getState as Mock).mockReturnValue({
inited: true,
fetchSpaces: vi.fn(),
});
const { result } = renderHook(() => useRefreshSpaces(false));
expect(result.current).toBe(false);
});
it('should set loading to false when refresh is undefined and spaces are already initialized', () => {
(useSpaceStore.getState as Mock).mockReturnValue({
inited: true,
fetchSpaces: vi.fn(),
});
const { result } = renderHook(() => useRefreshSpaces());
expect(result.current).toBe(false);
});
});

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.
*/
import { type Mock } from 'vitest';
import { renderHook } from '@testing-library/react-hooks';
import { useSpaceStore } from '@coze-foundation/space-store-adapter';
import { useSpaceList } from '../hooks';
vi.mock('@coze-foundation/space-store-adapter', () => ({
useSpaceStore: vi.fn(),
}));
vi.mock('@coze-foundation/enterprise-store-adapter', () => ({
useCurrentEnterpriseInfo: () => null,
}));
describe('useRefreshSpaces', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('should return correct state from useSpaceList & useRefreshSpaces', async () => {
const mockSpaceList = [
{
id: '1',
name: 'Space 1',
},
];
useSpaceStore.getState = vi.fn();
const mockFetchSpaces = vi.fn().mockResolvedValue([]);
(useSpaceStore.getState as Mock).mockReturnValue({
inited: true,
fetchSpaces: mockFetchSpaces,
});
vi.mocked(useSpaceStore).mockReturnValue([]);
const { result, waitForNextUpdate } = renderHook(() => useSpaceList(true));
expect(result.current.spaces).toEqual([]);
expect(result.current.loading).toEqual(true);
vi.mocked(useSpaceStore).mockReturnValue(mockSpaceList);
await waitForNextUpdate();
expect(result.current.spaces).toEqual(mockSpaceList);
expect(result.current.loading).toBe(false);
});
});

View File

@@ -0,0 +1,58 @@
/*
* 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 { renderHook } from '@testing-library/react-hooks';
import { useSpaceStore } from '@coze-foundation/space-store-adapter';
import { useSpace } from '../hooks';
vi.mock('@coze-foundation/space-store-adapter', () => ({
useSpaceStore: vi.fn(),
}));
vi.mock('@coze-foundation/enterprise-store-adapter', () => ({
useCurrentEnterpriseInfo: () => null,
}));
describe('useRefreshSpaces', () => {
beforeEach(() => {
vi.clearAllMocks();
useSpaceStore.getState = vi.fn().mockReturnValue({
fetchSpaces: vi.fn(),
inited: true,
});
});
it('should return current space when id matches', () => {
const mockSpaceList = [
{
id: '1',
name: 'Space 1',
},
{
id: '2',
name: 'Space 2',
},
];
vi.mocked(useSpaceStore).mockImplementation(callback =>
callback({
spaceList: mockSpaceList,
}),
);
const { result } = renderHook(() => useSpace('1'));
expect(result.current.space).toEqual(mockSpaceList[0]);
});
});

View File

@@ -0,0 +1,72 @@
/*
* 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 { useEffect, useState } from 'react';
import { useSpaceStore } from '@coze-foundation/space-store-adapter';
import { useCurrentEnterpriseInfo } from '@coze-foundation/enterprise-store-adapter';
import { type BotSpace } from '@coze-arch/bot-api/developer_api';
export const useRefreshSpaces = (refresh?: boolean) => {
const [loading, setLoading] = useState(true);
const enterpriseInfo = useCurrentEnterpriseInfo();
// 企业发生变化,重新获取空间列表
useEffect(() => {
if (refresh || !useSpaceStore.getState().inited) {
setLoading(true);
useSpaceStore
.getState()
.fetchSpaces(true)
.finally(() => {
setLoading(false);
});
} else {
setLoading(false);
}
}, [enterpriseInfo?.organization_id, refresh]);
return loading;
};
export const useSpaceList: (refresh?: boolean) => {
spaces?: BotSpace[];
loading: boolean;
} = refresh => {
const spaces = useSpaceStore(s => s.spaceList);
const loading = useRefreshSpaces(refresh);
return {
spaces,
loading,
} as const;
};
export const useSpace: (
spaceId: string,
refresh?: boolean,
) => {
space?: BotSpace;
loading: boolean;
} = (spaceId, refresh) => {
const space = useSpaceStore(s =>
s.spaceList.find(spaceItem => spaceItem.id === spaceId),
);
const loading = useRefreshSpaces(refresh);
return {
space,
loading,
} as const;
};

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.
*/
declare const IS_DEV_MODE: boolean;

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,52 @@
{
"$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"],
"exclude": ["node_modules", "dist", "./src/**/*.test.ts"],
"references": [
{
"path": "../../arch/bot-api/tsconfig.build.json"
},
{
"path": "../../arch/bot-error/tsconfig.build.json"
},
{
"path": "../../arch/bot-flags/tsconfig.build.json"
},
{
"path": "../../arch/bot-typings/tsconfig.build.json"
},
{
"path": "../../arch/logger/tsconfig.build.json"
},
{
"path": "../../arch/report-events/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": "../enterprise-store-adapter/tsconfig.build.json"
},
{
"path": "../space-store-adapter/tsconfig.build.json"
}
]
}

View File

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

View File

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

View File

@@ -0,0 +1,29 @@
/*
* 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',
test: {
coverage: {
all: true,
exclude: ['src/index.ts'],
},
setupFiles: ['./setup-vitest.ts'],
},
});