style(projects): reduce ambiguity in theme configuration instructions.

* feat(packages): add @sa/alova

* typo(packages): add types & update code

* feat: add subpackage @sa/alova

---------

Co-authored-by: allenli178 <allenli178@qq.com>
Co-authored-by: 子殊 <yuyan@zishudeMac-mini.local>

package.json

@@ -59,44 +59,44 @@
     "dayjs": "1.11.13",
     "echarts": "5.5.1",
     "json5": "2.2.3",
-    "naive-ui": "2.39.0",
+    "naive-ui": "2.40.1",
     "nprogress": "0.2.0",
-    "pinia": "2.2.2",
-    "tailwind-merge": "2.5.2",
-    "vue": "3.5.7",
+    "pinia": "2.2.4",
+    "tailwind-merge": "2.5.3",
+    "vue": "3.5.11",
     "vue-draggable-plus": "0.5.3",
-    "vue-i18n": "10.0.1",
+    "vue-i18n": "10.0.4",
     "vue-router": "4.4.5"
   },
   "devDependencies": {
     "@elegant-router/vue": "0.3.8",
-    "@iconify/json": "2.2.251",
+    "@iconify/json": "2.2.258",
     "@sa/scripts": "workspace:*",
     "@sa/uno-preset": "workspace:*",
     "@soybeanjs/eslint-config": "1.4.1",
-    "@types/node": "22.5.5",
+    "@types/node": "22.7.5",
     "@types/nprogress": "0.2.3",
-    "@unocss/eslint-config": "0.62.4",
-    "@unocss/preset-icons": "0.62.4",
-    "@unocss/preset-uno": "0.62.4",
-    "@unocss/transformer-directives": "0.62.4",
-    "@unocss/transformer-variant-group": "0.62.4",
-    "@unocss/vite": "0.62.4",
+    "@unocss/eslint-config": "0.63.4",
+    "@unocss/preset-icons": "0.63.4",
+    "@unocss/preset-uno": "0.63.4",
+    "@unocss/transformer-directives": "0.63.4",
+    "@unocss/transformer-variant-group": "0.63.4",
+    "@unocss/vite": "0.63.4",
     "@vitejs/plugin-vue": "5.1.4",
     "@vitejs/plugin-vue-jsx": "4.0.1",
-    "eslint": "9.11.0",
+    "eslint": "9.12.0",
     "eslint-plugin-vue": "9.28.0",
     "lint-staged": "15.2.10",
-    "sass": "1.79.3",
+    "sass": "1.79.4",
     "simple-git-hooks": "2.11.1",
     "tsx": "4.19.1",
-    "typescript": "5.6.2",
+    "typescript": "5.6.3",
     "unplugin-icons": "0.19.3",
     "unplugin-vue-components": "0.27.4",
-    "vite": "5.4.6",
+    "vite": "5.4.8",
     "vite-plugin-progress": "0.0.7",
     "vite-plugin-svg-icons": "2.0.1",
-    "vite-plugin-vue-devtools": "7.4.5",
+    "vite-plugin-vue-devtools": "7.4.6",
     "vue-eslint-parser": "9.4.3",
     "vue-tsc": "2.1.6"
   },

packages/alova/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@sa/alova",
+  "version": "0.1.0",
+  "exports": {
+    ".": "./src/index.ts",
+    "./client": "./src/client.ts"
+  },
+  "typesVersions": {
+    "*": {
+      "*": ["./src/*"]
+    }
+  },
+  "dependencies": {
+    "@sa/utils": "workspace:*",
+    "alova": "3.0.20"
+  }
+}

packages/alova/src/client.ts

@@ -0,0 +1 @@
+export * from 'alova/client';

packages/alova/src/constant.ts

@@ -0,0 +1,2 @@
+/** the backend error code key */
+export const BACKEND_ERROR_CODE = 'BACKEND_ERROR';

packages/alova/src/index.ts

@@ -0,0 +1,77 @@
+import { createAlova } from 'alova';
+import type { AlovaDefaultCacheAdapter, AlovaGenerics, AlovaGlobalCacheAdapter, AlovaRequestAdapter } from 'alova';
+import VueHook from 'alova/vue';
+import type { VueHookType } from 'alova/vue';
+import adapterFetch from 'alova/fetch';
+import { createServerTokenAuthentication } from 'alova/client';
+import type { FetchRequestInit } from 'alova/fetch';
+import { BACKEND_ERROR_CODE } from './constant';
+import type { CustomAlovaConfig, RequestOptions } from './type';
+
+export const createAlovaRequest = <
+  RequestConfig = FetchRequestInit,
+  ResponseType = Response,
+  ResponseHeader = Headers,
+  L1Cache extends AlovaGlobalCacheAdapter = AlovaDefaultCacheAdapter,
+  L2Cache extends AlovaGlobalCacheAdapter = AlovaDefaultCacheAdapter
+>(
+  customConfig: CustomAlovaConfig<
+    AlovaGenerics<any, any, RequestConfig, ResponseType, ResponseHeader, L1Cache, L2Cache, any>
+  >,
+  options: RequestOptions<AlovaGenerics<any, any, RequestConfig, ResponseType, ResponseHeader, L1Cache, L2Cache, any>>
+) => {
+  const { tokenRefresher } = options;
+  const { onAuthRequired, onResponseRefreshToken } = createServerTokenAuthentication<
+    VueHookType,
+    AlovaRequestAdapter<RequestConfig, ResponseType, ResponseHeader>
+  >({
+    refreshTokenOnSuccess: {
+      isExpired: (response, method) => tokenRefresher?.isExpired(response, method) || false,
+      handler: async (response, method) => tokenRefresher?.handler(response, method)
+    },
+    refreshTokenOnError: {
+      isExpired: (response, method) => tokenRefresher?.isExpired(response, method) || false,
+      handler: async (response, method) => tokenRefresher?.handler(response, method)
+    }
+  });
+
+  const instance = createAlova({
+    ...customConfig,
+    timeout: customConfig.timeout ?? 10 * 1000,
+    requestAdapter: (customConfig.requestAdapter as any) ?? adapterFetch(),
+    statesHook: VueHook,
+    beforeRequest: onAuthRequired(options.onRequest as any),
+    responded: onResponseRefreshToken({
+      onSuccess: async (response, method) => {
+        // check if http status is success
+        let error: any = null;
+        let transformedData: any = null;
+        try {
+          if (await options.isBackendSuccess(response)) {
+            transformedData = await options.transformBackendResponse(response);
+          } else {
+            error = new Error('the backend request error');
+            error.code = BACKEND_ERROR_CODE;
+          }
+        } catch (err) {
+          error = err;
+        }
+
+        if (error) {
+          await options.onError?.(error, response, method);
+          throw error;
+        }
+
+        return transformedData;
+      },
+      onComplete: options.onComplete,
+      onError: (error, method) => options.onError?.(error, null, method)
+    })
+  });
+
+  return instance;
+};
+
+export { BACKEND_ERROR_CODE };
+export type * from './type';
+export type * from 'alova';

packages/alova/src/type.ts

@@ -0,0 +1,52 @@
+import type { AlovaGenerics, AlovaOptions, AlovaRequestAdapter, Method, ResponseCompleteHandler } from 'alova';
+
+export type CustomAlovaConfig<AG extends AlovaGenerics> = Omit<
+  AlovaOptions<AG>,
+  'statesHook' | 'beforeRequest' | 'responded' | 'requestAdapter'
+> & {
+  /** request adapter. all request of alova will be sent by it. */
+  requestAdapter?: AlovaRequestAdapter<AG['RequestConfig'], AG['Response'], AG['ResponseHeader']>;
+};
+
+export interface RequestOptions<AG extends AlovaGenerics> {
+  /**
+   * The hook before request
+   *
+   * For example: You can add header token in this hook
+   *
+   * @param method alova Method Instance
+   */
+  onRequest?: AlovaOptions<AG>['beforeRequest'];
+  /**
+   * The hook to check backend response is success or not
+   *
+   * @param response alova response
+   */
+  isBackendSuccess: (response: AG['Response']) => Promise<boolean>;
+
+  /** The config to refresh token */
+  tokenRefresher?: {
+    /** detect the token is expired */
+    isExpired(response: AG['Response'], Method: Method<AG>): Promise<boolean> | boolean;
+    /** refresh token handler */
+    handler(response: AG['Response'], Method: Method<AG>): Promise<void>;
+  };
+
+  /** The hook after backend request complete */
+  onComplete?: ResponseCompleteHandler<AG>;
+
+  /**
+   * The hook to handle error
+   *
+   * For example: You can show error message in this hook
+   *
+   * @param error
+   */
+  onError?: (error: any, response: AG['Response'] | null, methodInstance: Method<AG>) => any | Promise<any>;
+  /**
+   * transform backend response when the responseType is json
+   *
+   * @param response alova response
+   */
+  transformBackendResponse: (response: AG['Response']) => any;
+}

packages/alova/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "preserve",
+    "lib": ["DOM", "ESNext"],
+    "baseUrl": ".",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "types": ["node"],
+    "strict": true,
+    "strictNullChecks": true,
+    "noUnusedLocals": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

packages/ofetch/package.json

@@ -10,6 +10,6 @@
     }
   },
   "dependencies": {
-    "ofetch": "1.4.0"
+    "ofetch": "1.4.1"
   }
 }

packages/scripts/package.json

@@ -14,14 +14,14 @@
   },
   "devDependencies": {
     "@soybeanjs/changelog": "0.3.24",
-    "bumpp": "9.5.2",
-    "c12": "1.11.2",
+    "bumpp": "9.7.1",
+    "c12": "2.0.1",
     "cac": "6.7.14",
     "consola": "3.2.3",
     "enquirer": "2.4.1",
     "execa": "9.4.0",
     "kolorist": "1.8.0",
-    "npm-check-updates": "17.1.2",
+    "npm-check-updates": "17.1.3",
     "rimraf": "6.0.1"
   }
 }

src/locales/langs/en-us.ts

@@ -113,7 +113,7 @@ const local: App.I18n.Schema = {
     },
     tab: {
       visible: 'Tab Visible',
-      cache: 'Tab Cache',
+      cache: 'Tag Bar Info Cache',
       height: 'Tab Height',
       mode: {
         title: 'Tab Mode',

src/locales/langs/zh-cn.ts

@@ -113,7 +113,7 @@ const local: App.I18n.Schema = {
     },
     tab: {
       visible: '显示标签栏',
-      cache: '缓存标签页',
+      cache: '标签栏信息缓存',
       height: '标签栏高度',
       mode: {
         title: '标签栏风格',

src/typings/global.d.ts

@@ -14,14 +14,6 @@ declare global {
     $notification?: import('naive-ui').NotificationProviderInst;
   }
 
-  interface ViewTransition {
-    ready: Promise<void>;
-  }
-
-  export interface Document {
-    startViewTransition?: (callback: () => Promise<void> | void) => ViewTransition;
-  }
-
   /** Build time of the project */
   export const BUILD_TIME: string;
 }

src/views/_builtin/login/modules/code-login.vue

@@ -40,7 +40,7 @@ async function handleSubmit() {
 </script>
 
 <template>
-  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false">
+  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false" @keyup.enter="handleSubmit">
     <NFormItem path="phone">
       <NInput v-model:value="model.phone" :placeholder="$t('page.login.common.phonePlaceholder')" />
     </NFormItem>

src/views/_builtin/login/modules/pwd-login.vue

@@ -75,7 +75,7 @@ async function handleAccountLogin(account: Account) {
 </script>
 
 <template>
-  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false">
+  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false" @keyup.enter="handleSubmit">
     <NFormItem path="userName">
       <NInput v-model:value="model.userName" :placeholder="$t('page.login.common.userNamePlaceholder')" />
     </NFormItem>

src/views/_builtin/login/modules/register.vue

@@ -46,7 +46,7 @@ async function handleSubmit() {
 </script>
 
 <template>
-  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false">
+  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false" @keyup.enter="handleSubmit">
     <NFormItem path="phone">
       <NInput v-model:value="model.phone" :placeholder="$t('page.login.common.phonePlaceholder')" />
     </NFormItem>

src/views/_builtin/login/modules/reset-pwd.vue

@@ -45,7 +45,7 @@ async function handleSubmit() {
 </script>
 
 <template>
-  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false">
+  <NForm ref="formRef" :model="model" :rules="rules" size="large" :show-label="false" @keyup.enter="handleSubmit">
     <NFormItem path="phone">
       <NInput v-model:value="model.phone" :placeholder="$t('page.login.common.phonePlaceholder')" />
     </NFormItem>