feat: manually mirror opencoze's code from bytedance
Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf
This commit is contained in:
68
frontend/packages/arch/utils/README.md
Normal file
68
frontend/packages/arch/utils/README.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# @coze-arch/utils
|
||||
|
||||
common utils for all apps
|
||||
|
||||
## Overview
|
||||
|
||||
This package is part of the Coze Studio monorepo and provides utilities functionality. It serves as a core component in the Coze ecosystem.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installation
|
||||
|
||||
Add this package to your `package.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"dependencies": {
|
||||
"@coze-arch/utils": "workspace:*"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then run:
|
||||
|
||||
```bash
|
||||
rush update
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
```typescript
|
||||
import { /* exported functions/components */ } from '@coze-arch/utils';
|
||||
|
||||
// Example usage
|
||||
// TODO: Add specific usage examples
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- Core functionality for Coze Studio
|
||||
- TypeScript support
|
||||
- Modern ES modules
|
||||
|
||||
## API Reference
|
||||
|
||||
### Exports
|
||||
|
||||
- `parseHashOrQuery`
|
||||
|
||||
|
||||
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
|
||||
21
frontend/packages/arch/utils/__tests__/index.test.ts
Normal file
21
frontend/packages/arch/utils/__tests__/index.test.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
/*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
describe('Hello World', () => {
|
||||
it('test', () => {
|
||||
expect(1).toBe(1);
|
||||
});
|
||||
});
|
||||
0
frontend/packages/arch/utils/__tests__/setup.ts
Normal file
0
frontend/packages/arch/utils/__tests__/setup.ts
Normal file
12
frontend/packages/arch/utils/config/rush-project.json
Normal file
12
frontend/packages/arch/utils/config/rush-project.json
Normal file
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"operationSettings": [
|
||||
{
|
||||
"operationName": "test:cov",
|
||||
"outputFolderNames": ["coverage"]
|
||||
},
|
||||
{
|
||||
"operationName": "ts-check",
|
||||
"outputFolderNames": ["./dist"]
|
||||
}
|
||||
]
|
||||
}
|
||||
7
frontend/packages/arch/utils/eslint.config.js
Normal file
7
frontend/packages/arch/utils/eslint.config.js
Normal file
@@ -0,0 +1,7 @@
|
||||
const { defineConfig } = require('@coze-arch/eslint-config');
|
||||
|
||||
module.exports = defineConfig({
|
||||
packageRoot: __dirname,
|
||||
preset: 'web',
|
||||
rules: {},
|
||||
});
|
||||
28
frontend/packages/arch/utils/package.json
Normal file
28
frontend/packages/arch/utils/package.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"name": "@coze-arch/utils",
|
||||
"version": "0.0.1",
|
||||
"description": "common utils for all apps",
|
||||
"license": "Apache-2.0",
|
||||
"author": "fanwenjie.fe@bytedance.com",
|
||||
"maintainers": [
|
||||
"sunzhiyuan.evan@bytedance.com"
|
||||
],
|
||||
"main": "src/index.ts",
|
||||
"scripts": {
|
||||
"build": "exit 0",
|
||||
"lint": "eslint ./ --cache",
|
||||
"test": "vitest --run --passWithNoTests",
|
||||
"test:cov": "npm run test -- --coverage"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@coze-arch/eslint-config": "workspace:*",
|
||||
"@coze-arch/ts-config": "workspace:*",
|
||||
"@coze-arch/vitest-config": "workspace:*",
|
||||
"@types/jest": "~29.2.4",
|
||||
"@types/node": "^18",
|
||||
"@vitest/coverage-v8": "~3.0.5",
|
||||
"sucrase": "^3.32.0",
|
||||
"vitest": "~3.0.5"
|
||||
}
|
||||
}
|
||||
|
||||
17
frontend/packages/arch/utils/src/index.ts
Normal file
17
frontend/packages/arch/utils/src/index.ts
Normal 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.
|
||||
*/
|
||||
|
||||
export { parseHashOrQuery } from './url/parse-hash-or-query';
|
||||
@@ -0,0 +1,70 @@
|
||||
/*
|
||||
* 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 { parseHashOrQuery } from '../parse-hash-or-query';
|
||||
|
||||
const baseQuery = 'keyA=123&keyB=false&keyC=test&%3F!a=%3F!a';
|
||||
const expectResult = {
|
||||
keyA: '123',
|
||||
keyB: 'false',
|
||||
keyC: 'test',
|
||||
'?!a': '?!a',
|
||||
};
|
||||
|
||||
// 老版本 parseHashOrQuery 实现,验证一下输出一致
|
||||
const parseHashOrQueryOld = (hashFragmentOrQueryString: string) => {
|
||||
const targetString =
|
||||
hashFragmentOrQueryString.startsWith('#') ||
|
||||
hashFragmentOrQueryString.startsWith('?')
|
||||
? hashFragmentOrQueryString.slice(1)
|
||||
: hashFragmentOrQueryString;
|
||||
|
||||
const params: Record<string, string> = {};
|
||||
|
||||
const regex = /([^&=]+)=([^&]*)/g;
|
||||
|
||||
let matchResult: RegExpExecArray | null = null;
|
||||
|
||||
// eslint-disable-next-line no-cond-assign
|
||||
while ((matchResult = regex.exec(targetString))) {
|
||||
const [, key, value] = matchResult;
|
||||
params[decodeURIComponent(key)] = decodeURIComponent(value);
|
||||
}
|
||||
|
||||
return params;
|
||||
};
|
||||
|
||||
describe('parseHashOrQuery', () => {
|
||||
it('parse query string starts with `?`', () => {
|
||||
const query = `?${baseQuery}`;
|
||||
const newRes = parseHashOrQuery(query);
|
||||
expect(newRes).toEqual(expectResult);
|
||||
expect(parseHashOrQueryOld(query)).toEqual(newRes);
|
||||
});
|
||||
|
||||
it('parse hash starts with `#`', () => {
|
||||
const query = `#${baseQuery}`;
|
||||
const newRes = parseHashOrQuery(query);
|
||||
expect(newRes).toEqual(expectResult);
|
||||
expect(parseHashOrQueryOld(query)).toEqual(newRes);
|
||||
});
|
||||
|
||||
it('parse plain string', () => {
|
||||
const newRes = parseHashOrQuery(baseQuery);
|
||||
expect(newRes).toEqual(expectResult);
|
||||
expect(parseHashOrQueryOld(baseQuery)).toEqual(newRes);
|
||||
});
|
||||
});
|
||||
35
frontend/packages/arch/utils/src/url/parse-hash-or-query.ts
Normal file
35
frontend/packages/arch/utils/src/url/parse-hash-or-query.ts
Normal file
@@ -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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @deprecated use query-string or URLSearchParams instead
|
||||
* @param queryString query or hash string
|
||||
* @returns key value pair as the parse result, if a key show up more than ones in query, the last value will be taken
|
||||
*/
|
||||
export const parseHashOrQuery = (queryString: string) => {
|
||||
if (queryString.startsWith('?') || queryString.startsWith('#')) {
|
||||
queryString = queryString.slice(1);
|
||||
}
|
||||
|
||||
const params = new URLSearchParams(queryString);
|
||||
const result: Record<string, string> = {};
|
||||
|
||||
for (const [key, value] of params.entries()) {
|
||||
result[key] = value;
|
||||
}
|
||||
|
||||
return result;
|
||||
};
|
||||
25
frontend/packages/arch/utils/tsconfig.build.json
Normal file
25
frontend/packages/arch/utils/tsconfig.build.json
Normal file
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"$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"
|
||||
},
|
||||
"exclude": ["./src/**/__tests__/**", "./src/**/__mocks__/**", "node_modules"],
|
||||
"include": ["src"],
|
||||
"references": [
|
||||
{
|
||||
"path": "../../../config/eslint-config/tsconfig.build.json"
|
||||
},
|
||||
{
|
||||
"path": "../../../config/ts-config/tsconfig.build.json"
|
||||
},
|
||||
{
|
||||
"path": "../../../config/vitest-config/tsconfig.build.json"
|
||||
}
|
||||
]
|
||||
}
|
||||
15
frontend/packages/arch/utils/tsconfig.json
Normal file
15
frontend/packages/arch/utils/tsconfig.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/tsconfig",
|
||||
"compilerOptions": {
|
||||
"composite": true
|
||||
},
|
||||
"references": [
|
||||
{
|
||||
"path": "./tsconfig.build.json"
|
||||
},
|
||||
{
|
||||
"path": "./tsconfig.misc.json"
|
||||
}
|
||||
],
|
||||
"exclude": ["**/*"]
|
||||
}
|
||||
18
frontend/packages/arch/utils/tsconfig.misc.json
Normal file
18
frontend/packages/arch/utils/tsconfig.misc.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"extends": "@coze-arch/ts-config/tsconfig.web.json",
|
||||
"$schema": "https://json.schemastore.org/tsconfig",
|
||||
"include": ["__tests__", "vitest.config.ts", "**/__tests__/*"],
|
||||
"exclude": ["./dist"],
|
||||
"references": [
|
||||
{
|
||||
"path": "./tsconfig.build.json"
|
||||
}
|
||||
],
|
||||
"compilerOptions": {
|
||||
"rootDir": "./",
|
||||
"outDir": "./dist",
|
||||
"types": ["vitest/globals"],
|
||||
"strictNullChecks": true,
|
||||
"noImplicitAny": true
|
||||
}
|
||||
}
|
||||
35
frontend/packages/arch/utils/vitest.config.ts
Normal file
35
frontend/packages/arch/utils/vitest.config.ts
Normal file
@@ -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 { defineConfig } from '@coze-arch/vitest-config';
|
||||
|
||||
export default defineConfig({
|
||||
dirname: __dirname,
|
||||
preset: 'web',
|
||||
test: {
|
||||
setupFiles: ['./__tests__/setup.ts'],
|
||||
coverage: {
|
||||
all: true,
|
||||
exclude: ['src/index.ts'],
|
||||
},
|
||||
},
|
||||
plugins: [
|
||||
{
|
||||
name: 'edenx-virtual-modules',
|
||||
enforce: 'pre',
|
||||
},
|
||||
],
|
||||
});
|
||||
Reference in New Issue
Block a user