neko-ui 2.6.7 → 2.7.0

package/lib/@moneko/mock/api.md

@@ -1,177 +0,0 @@
-[TOC]
-
-# @moneko/mock
-
-!> 在项目启动目录 mock 文件夹下创建 mock 脚本，达到模拟响应数据的效果
-
-## 函数方式
-
-!> (req: RequestFormData, res: Response) => void
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'GET /api/account': (req, res) => {
-    const resp = {
-      success: true,
-      message: '请求成功',
-      result: {
-        inme: '人大',
-        effte: '2022/7/1',
-      },
-    };
-
-    res.status(200).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 获取 Restful Api 参数
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'GET /api/account/:id': (req, res) => {
-    const resp = {
-      success: true,
-      message: '请求成功',
-      result: {
-        id: req.params.id,
-        csaa: '人额',
-        currency: req.params.id,
-        effee: '2022/7/1',
-      },
-    };
-
-    res.status(200).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 获取 POST 请求体数据
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'POST /api/login_by_username': (req, res) => {
-    const resp = {
-      status: 200,
-      message: '请求成功',
-      result: {
-        password: req.body.password,
-        username: req.body.username,
-      },
-    };
-
-    res.status(resp.status).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 模拟上传文件，返回文件 base64
-
-```typescript
-import type { MockConfiguration } from '@moneko/core';
-
-const conf: MockConfiguration = {
-  'POST /api/upload_file': (req, res) => {
-    const { files } = req;
-
-    const strBase64 = Buffer.from(files[0].buffer).toString('base64');
-
-    const resp = {
-      status: 200,
-      message: '上传成功',
-      result: 'data:image/jpeg;base64,' + strBase64,
-    };
-
-    res.status(resp.status).send(resp);
-  },
-};
-
-export default conf;
-```
-
-### 使用 YApi JSON Schema 生成数据
-
-```typescript
-import { yApiSchemaMock } from '@moneko/mock';
-import type { MockConfiguration } from '@moneko/mock';
-
-const getYApiOption = (id: string) => {
-  return {
-    // yapi host
-    host: 'http://yapihost',
-    // yapi open api token
-    token: 'yapi open api token',
-    // yapi 接口id
-    id,
-  };
-};
-
-const conf: MockConfiguration = {
-  'POST /getids/list': async (req, res) => {
-    const mockData = await yApiSchemaMock(getYApiOption('7610'), {
-      result: {
-        page: req.body.pageNum,
-        itemsPerPage: req.body.pageSize,
-        keyword: req.body.keyword,
-      },
-    });
-
-    res.status(200).send(mockData);
-  },
-};
-
-export default conf;
-```
-
-### 使用 YApi 高级 Mock
-
-```typescript
-import { yApiMock } from '@moneko/mock';
-import type { MockConfiguration, YApiOption } from '@moneko/mock';
-
-const yApi: YApiOption = {
-  // yapi host
-  host: 'http://yapihost:8080',
-  projectId: 143,
-  pathRewrite: '^/api/',
-};
-
-const conf: MockConfiguration = {
-  'POST /api/getids/list': async (req, res) => {
-    // 此时 mockData 将是来自 POST http://yapihost:8080/mock/143/getids/list 响应的数据
-    const resp = await yApiMock(req, yApi);
-
-    res.status(200).send(resp);
-  },
-};
-
-export default conf;
-```
-
-## KV 方式
-
-```typescript
-import type { MockConfiguration } from '@moneko/mock';
-
-const conf: MockConfiguration = {
-  'POST /api/use/fun': {
-    status: 200,
-    message: '上传成功',
-    effectiveDate: '2022/7/1',
-  },
-};
-
-export default conf;
-```

package/lib/@moneko/request/api.md

@@ -1,31 +0,0 @@
-[TOC]
-
-# @moneko/request
-
-> 数据请求
-
-## 设置响应拦截器、请求前缀
-
-```typescript
-// @/services/index.ts
-import { extend } from '@moneko/request';
-export { request } from '@moneko/request';
-
-extend({
-  interceptor: {
-    response: (resp) => resp,
-  },
-  prefixUrl: '/api',
-});
-```
-
-## 调用 request 案例
-
-```typescript
-import { request } from '@/services';
-
-// 实际访问 /api/list
-export const getApi = () => request('/list');
-// 实际访问 /api/list
-export const postApi = (params = {}) => request('/list', { data: params, method: 'POST' });
-```

package/lib/@moneko/routes/doc.md

@@ -1,81 +0,0 @@
-[TOC]
-
-# 约定式路由
-
-> 通过内置的虚拟模块 @app/routes 获取约定式路由, 在编译期间动态生成,均采用懒加载;
-
-1. 路由根据 `src/pages` 文件夹内的 `index.ts` 和 `index.tsx` 路径信息自动生成
-2. 比如 `src/pages/user/index.tsx` 会生成一个 path 为 `/user/:id` 的路由
-3. 文件夹名称以 `$` 开头将创建为动态路由
-4. 比如 `src/pages/user/$id/index.tsx` 会生成一个 path 为 `/user/:id` 的动态路由
-
-<div style="display:flex;gap: 16px;align-items:center;">
-
-<div>
-
-```treeview
-项目根目录
-`-- src
-    `-- pages
-        |-- user
-        |   |-- $id
-        |   |   `-- index.tsx
-        |   `-- index.tsx
-        `-- index.tsx
-```
-
-</div>
-
-将创建出以下路由
-
-1. `/`
-2. `/user`
-3. `/user/:id`
-
-</div>
-
-## 使用
-
-> 或参考 [demo](https://github.com/monako97/demo-micro-app-solid)
-
-## 读取路由数据
-
-```ts
-import routes from '@app/routes';
-
-console.log(routes);
-```
-
-## 自定义路由
-
-!> 当创建的约定式路由不足以满足您的需求时, 您可以通过创建 `src/router/index.ts` 来对其进行补充, 最终通过 `@app/routes` 获取的数据将是合并后的路由数据
-
-```js
-// src/router/index.ts
-import { lazy } from 'solid-js';
-import type { RouteConfig } from '@app/routes';
-
-const router: RouteConfig[] = [
-  {
-    path: '/',
-    // 补充路由
-    component: lazy(() => import('@/layout')),
-    children: [
-      // 自定义路由
-      {
-        path: 'about',
-        children: [
-          {
-            path: '/',
-            component: lazy(() => import('@/pages/home')),
-          },
-        ],
-      },
-    ],
-  },
-];
-
-export default router;
-```
-
-> React 应用与 Solid应用稍有差别, 具体可参考 [React demo](https://github.com/monako97/demo-micro-app-react) 和 [Solid demo](https://github.com/monako97/demo-micro-app-solid)

package/lib/@moneko/sso/api.md

@@ -1,158 +0,0 @@
-[TOC]
-
-# SSO React 共享状态对象
-
-> Shared Store Object `共享状态对象`
-> 通过 useSyncExternalStore 衔接的外部状态管理
-
-## 安装依赖
-
-```shell
-npm install shared-store-object -S
-# or
-yarn add shared-store-object -S
-```
-
-## 使用方式
-
-> 页面 render 后在任意位置使用, 可通过简单的方式进行创建、修改、回收（回收的对象将无法继续使用）
-
-```jsx
-// 引入 或 import { sso } from '@moneko/react';
-import sso from 'shared-store-object';
-
-// 创建公共状态
-const like = sso({
-  count: 0,
-  inc() {
-    store.count++;
-  },
-});
-
-// 使用
-const App = () => {
-  const { count, inc } = like;
-
-  return (
-    <div>
-      <p>{count}</p>
-      <button onClick={inc}>inc</button>
-      {/* 直接修改 */}
-      <button onClick={() => like.count++}>add</button>
-      {/* 函数函数修改 */}
-      <button onClick={() => like('count', (prev) => prev + 1)}>func</button>
-    </div>
-  );
-};
-
-// 也可以直接在 react 函数外操作
-like.count++;
-```
-
-## 计算属性
-
-> 在第二个入参中配置计算属性
-
-```jsx
-// 使用
-const store = sso(
-  {
-    count: 0,
-    inc() {
-      store.count++;
-    },
-  },
-  // 在这里配置计算属性
-  {
-    age() {
-      return store.count * 2 + 1;
-    },
-  },
-);
-
-const App = () => {
-  const { count, age } = store;
-
-  return (
-    <div>
-      <p>count: {count}</p>
-      <p>age: {age}</p>
-      <button onClick={() => store.inc()}>add</button>
-    </div>
-  );
-};
-```
-
-## 回收
-
-> 当作 react 的 useState 来使用，并在组件卸载时手动回收
-
-```jsx
-// 使用
-const App = () => {
-  const store = useRef(sso({ count: 0 }));
-  // 结构出 deps 对象
-  const { count } = store.current;
-
-  useEffect(() => {
-    return () => {
-      // 回收之后将无法继续使用store
-      store.current();
-    };
-  }, []);
-  return (
-    <div>
-      <p>{count}</p>
-      <button onClick={() => store.count++}>add</button>
-    </div>
-  );
-};
-```
-
-## 配置项
-
-> 通过 `next` 参数传递的 `iteration` 函数决定是否需要进行迭代
-
-### 全局
-
-> 所有的 sso 都将使用这个配置
-
-```javascript
-sso.config({
-  next(iteration, key, data) {
-    console.log('global', key, data);
-    // 不执行 iteration 函数数据将不会改变
-    iteration();
-  },
-});
-```
-
-### 私有
-
-> 为单独的对象设置私有的配置, 权限高于全局配置
-
-```typescript
-const app = sso({
-  count: 0,
-});
-
-app((): Partial<SSOConfig> => {
-  return {
-    next(iteration, key, data) {
-      console.log('app', key, data);
-      // 不执行 iteration 函数数据将不会改变
-      iteration();
-    },
-  };
-});
-```
-
-## 批量更新
-
-> 当使用 React < 18 时使用批量更新。
-
-```javascript
-sso.config({
-  next: ReactDOM.unstable_batchedUpdates,
-});
-```