@qlover/create-app 0.9.0 → 0.10.0

package/dist/templates/react-app/eslint.config.mjs

@@ -7,10 +7,7 @@ import unusedImports from 'eslint-plugin-unused-imports';
 import qloverEslint from '@qlover/eslint-plugin';
 import tseslint from 'typescript-eslint';
 import globals from 'globals';
-import {
-  disableGlobals,
-  restrictSpecificGlobals
-} from './makes/eslint-utils.mjs';
+import { restrictSpecificGlobals } from './makes/eslint-utils.mjs';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -186,10 +183,14 @@ const eslintConfig = [
       'prettier/prettier': [
         'error',
         {
-          semi: true,
           singleQuote: true,
           trailingComma: 'none',
           endOfLine: 'lf'
+        },
+        {
+          // 仅用于单独部署时对 eslint prettier 插件自动查找 prettierrc 时报错
+          // 注意: vscode 等编辑器会失效, 作为单独项目开发时可以去掉
+          usePrettierrc: false
         }
       ],
       // 默认禁用 export default

package/dist/templates/react-app/package.json

@@ -32,7 +32,7 @@
     "dev:force": "vite --mode localhost --force",
     "dev:staging": "vite --mode staging",
     "dev:prod": "vite --mode production",
-    "build": "npm run lint && vite build",
+    "build": "vite build",
     "build:staging": "npm run lint && vite build --mode staging",
     "build:prod": "npm run lint && vite build --mode production",
     "build:analyze": "vite build --mode production && start dist/stats.html",

package/dist/templates/react-app/src/base/apis/userApi/UserApi.ts

@@ -6,20 +6,20 @@ import {
 } from '@qlover/fe-corekit';
 import { inject, injectable } from 'inversify';
 import { AppError } from '@/base/cases/AppError';
-import { RegisterFormData } from '@/base/services/UserService';
 import { UserApiAdapter } from './UserApiAdapter';
 import { UserApiConfig } from './UserApiBootstarp';
 import {
   GetIpInfoTransaction,
   UserApiGetUserInfoTransaction,
   UserApiLoginTransaction,
+  UserApiRegisterTransaction,
   UserApiTestApiCatchResultTransaction,
-  UserInfo
+  UserInfo,
+  UserCredential
 } from './UserApiType';
 import type {
-  LoginResponseData,
-  UserAuthApiInterface,
-  UserAuthStoreInterface
+  UserAuthStoreInterface,
+  UserServiceGateway
 } from '@qlover/corekit-bridge';
 
 /**
@@ -32,7 +32,7 @@ import type {
 @injectable()
 export class UserApi
   extends RequestTransaction<UserApiConfig>
-  implements UserAuthApiInterface<UserInfo>
+  implements UserServiceGateway<UserInfo, UserCredential>
 {
   protected store: UserAuthStoreInterface<UserInfo> | null = null;
 
@@ -85,7 +85,7 @@ export class UserApi
    */
   async login(
     params: UserApiLoginTransaction['data']
-  ): Promise<LoginResponseData> {
+  ): Promise<UserCredential> {
     const response = await this.post<UserApiLoginTransaction>(
       '/api/login',
       params
@@ -108,24 +108,33 @@ export class UserApi
    * @returns
    */
   register(
-    params: RegisterFormData
-  ): Promise<UserApiLoginTransaction['response']> {
-    return this.post<UserApiLoginTransaction>('/api/register', params);
+    params: UserApiRegisterTransaction['data']
+  ): Promise<UserApiRegisterTransaction['response']['data']> {
+    // @ts-expect-error - TODO: implement
+    return this.post<UserApiRegisterTransaction>('/api/register', params);
   }
 
   /**
    * @override
    * @returns
    */
-  logout(): Promise<void> {
-    return Promise.resolve();
+  async refreshUserInfo(): Promise<UserInfo> {
+    return this.getUserInfo();
   }
 
   /**
    * @override
    * @returns
    */
-  async getUserInfo(): Promise<UserInfo> {
+  logout(): Promise<any> {
+    return this.post('/api/logout');
+  }
+
+  /**
+   * @override
+   * @returns
+   */
+  async getUserInfo(_credential?: UserCredential): Promise<UserInfo> {
     const response =
       await this.get<UserApiGetUserInfoTransaction>('/api/userinfo');
 

package/dist/templates/react-app/src/base/apis/userApi/UserApiBootstarp.ts

@@ -2,7 +2,7 @@ import { IOCIdentifier } from '@config/IOCIdentifier';
 import {
   type BootstrapContext,
   type BootstrapExecutorPlugin,
-  type ApiMockPluginConfig,
+  type ApiMockPluginOptions,
   type ApiCatchPluginConfig,
   type ApiCatchPluginResponse
 } from '@qlover/corekit-bridge';
@@ -23,12 +23,12 @@ import type {
  * UserApiConfig is the config for the UserApi.
  *
  * extends:
- * - ApiMockPluginConfig
+ * - ApiMockPluginOptions
  * - ApiCatchPluginConfig
  */
 export interface UserApiConfig<Request = unknown>
   extends RequestAdapterConfig<Request>,
-    ApiMockPluginConfig,
+    ApiMockPluginOptions,
     ApiCatchPluginConfig {}
 
 /**

package/dist/templates/react-app/src/base/apis/userApi/UserApiType.ts

@@ -1,4 +1,5 @@
 import type { UserApiTransaction } from './UserApiBootstarp';
+import type { LoginParams } from '@qlover/corekit-bridge';
 
 export type UserInfo = {
   name: string;
@@ -44,22 +45,26 @@ export type UserApiGetUserInfoTransaction = UserApiTransaction<
   UserInfo
 >;
 
+export type UserCredential = {
+  token: string;
+};
+
 export type UserApiLoginTransaction = UserApiTransaction<
-  { username: string; password: string },
-  {
-    token: string;
-  }
+  LoginParams & { username?: string },
+  UserCredential
 >;
 
 export type UserApiTestApiCatchResultTransaction = UserApiGetRandomUser;
 
+export interface RegisterFormData {
+  username: string;
+  email: string;
+  password: string;
+  confirmPassword: string;
+  agreeToTerms: boolean;
+}
+
 export type UserApiRegisterTransaction = UserApiTransaction<
-  {
-    username: string;
-    email: string;
-    password: string;
-    confirmPassword: string;
-    agreeToTerms: boolean;
-  },
-  UserApiTransaction['response']['data']
+  RegisterFormData,
+  UserInfo
 >;

package/dist/templates/react-app/src/base/cases/I18nKeyErrorPlugin.ts

@@ -1,7 +1,11 @@
 import { IOCIdentifier } from '@config/IOCIdentifier';
+import {
+  ExecutorError,
+  type ExecutorContext,
+  type ExecutorPlugin
+} from '@qlover/fe-corekit';
 import { inject, injectable } from 'inversify';
 import type { I18nServiceInterface } from '../port/I18nServiceInterface';
-import type { ExecutorContext, ExecutorPlugin } from '@qlover/fe-corekit';
 import type { LoggerInterface } from '@qlover/logger';
 
 /**
@@ -19,14 +23,27 @@ export class I18nKeyErrorPlugin implements ExecutorPlugin {
     protected i18nService: I18nServiceInterface
   ) {}
 
+  protected translateById(id: string): string {
+    return this.i18nService.t(id);
+  }
+
   onError(context: ExecutorContext<unknown>): Error | void {
     const { error } = context;
 
+    if (!error) {
+      return;
+    }
+
+    if (error instanceof ExecutorError) {
+      const i18nText = this.translateById(error.id);
+      return new ExecutorError(error.id, i18nText);
+    }
+
     if (error instanceof Error) {
       const i18nKey = error.message;
 
       if (i18nKey && typeof i18nKey === 'string') {
-        const i18nText = this.i18nService.t(i18nKey);
+        const i18nText = this.translateById(i18nKey);
 
         if (i18nText && i18nText !== i18nKey) {
           this.logger.debug('I18nKeyErrorPlugin Error:', i18nText);

package/dist/templates/react-app/src/base/port/RouteServiceInterface.ts

@@ -1,9 +1,7 @@
 import { StoreInterface } from '@qlover/corekit-bridge';
 import type { RouteConfigValue } from '../cases/RouterLoader';
-import type {
-  LoggerInterface,
-  StoreStateInterface
-} from '@qlover/corekit-bridge';
+import type { StoreStateInterface } from '@qlover/corekit-bridge';
+import type { LoggerInterface } from '@qlover/logger';
 import type { NavigateFunction, NavigateOptions } from 'react-router-dom';
 
 export interface RouteServiceStateInterface extends StoreStateInterface {

package/dist/templates/react-app/src/base/port/UserServiceInterface.ts

@@ -1,12 +1,18 @@
-import { UserAuthService } from '@qlover/corekit-bridge';
-import type { UserInfo } from '@/base/apis/userApi/UserApiType';
-import type { ExecutorPlugin } from '@qlover/fe-corekit';
+import type { UserInfo, UserCredential } from '@/base/apis/userApi/UserApiType';
+import type { UserServiceInterface as CorekitBridgeUserServiceInterface } from '@qlover/corekit-bridge';
 
-export abstract class UserServiceInterface
-  extends UserAuthService<UserInfo>
-  implements ExecutorPlugin
-{
-  readonly pluginName = 'UserService';
+export interface UserServiceInterface
+  extends CorekitBridgeUserServiceInterface<UserInfo, UserCredential> {
+  // You can add your own methods here
 
-  abstract getToken(): string | null;
+  /**
+   * Get the user token
+   *
+   * This is a extends method from the corekit-bridge UserServiceInterface.
+   */
+  getToken(): string;
+
+  isUserInfo(value: unknown): value is UserInfo;
+
+  isUserCredential(value: unknown): value is UserCredential;
 }

package/dist/templates/react-app/src/base/services/BaseLayoutService.ts

@@ -0,0 +1,55 @@
+import { I } from '@config/IOCIdentifier';
+import { AsyncExecutor, ExecutorPlugin } from '@qlover/fe-corekit';
+import { injectable, inject } from 'inversify';
+import { UserBootstrap } from './UserBootstrap';
+import type { RouteServiceInterface } from '../port/RouteServiceInterface';
+import type { UserServiceInterface } from '../port/UserServiceInterface';
+import type {
+  BootstrapContextValue,
+  IOCContainerInterface
+} from '@qlover/corekit-bridge';
+import type { LoggerInterface } from '@qlover/logger';
+
+@injectable()
+export class BaseLayoutService {
+  protected executor: AsyncExecutor = new AsyncExecutor();
+
+  constructor(
+    @inject(I.Logger) protected logger: LoggerInterface,
+    @inject(I.RouteServiceInterface)
+    protected routeService: RouteServiceInterface,
+    @inject(I.UserServiceInterface)
+    protected userService: UserServiceInterface
+  ) {
+    this.use(new UserBootstrap(userService));
+  }
+
+  use(plugin: ExecutorPlugin): this {
+    this.executor.use(plugin);
+    return this;
+  }
+
+  handler(): Promise<{ success: boolean }> {
+    return Promise.resolve({
+      success: true
+    });
+  }
+
+  async starup(ioc: IOCContainerInterface): Promise<unknown> {
+    const context: BootstrapContextValue = {
+      root: {},
+      logger: this.logger,
+      ioc: ioc
+    };
+
+    try {
+      const result = await this.executor.exec(context, this.handler.bind(this));
+      this.logger.info('BaseLayoutService starup success!');
+      return result;
+    } catch (err) {
+      this.logger.error('BaseLayoutService starup failed!', err);
+
+      this.routeService.gotoLogin();
+    }
+  }
+}

package/dist/templates/react-app/src/base/services/I18nService.ts

@@ -119,6 +119,7 @@ export class I18nService
   t(key: string, params?: Record<string, unknown>): string {
     const i18nValue = i18n.t(key, {
       lng: i18n.language,
+      nsSeparator: false,
       ...params
     });
 

package/dist/templates/react-app/src/base/services/UserBootstrap.ts

@@ -0,0 +1,43 @@
+import { LOCAL_NO_USER_TOKEN } from '@config/Identifier';
+import { I } from '@config/IOCIdentifier';
+import { inject, injectable } from 'inversify';
+import { AppError } from '../cases/AppError';
+import type { UserServiceInterface } from '../port/UserServiceInterface';
+import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
+
+@injectable()
+export class UserBootstrap implements BootstrapExecutorPlugin {
+  readonly pluginName = 'UserBootstrap';
+
+  constructor(
+    @inject(I.UserServiceInterface)
+    protected userService: UserServiceInterface
+  ) {}
+
+  async onBefore(): Promise<void> {
+    const userService = this.userService;
+
+    if (userService.isAuthenticated()) {
+      return;
+    }
+
+    // 如果用户凭证存在，则刷新用户信息, 更新状态
+    const credential = userService.getCredential();
+    if (userService.isUserCredential(credential)) {
+      userService.getStore().start();
+
+      const user = await userService.refreshUserInfo();
+
+      userService.getStore().success(user);
+
+      return;
+    }
+
+    const newError = new AppError(LOCAL_NO_USER_TOKEN);
+
+    userService.getStore().failed(newError);
+
+    // 否则还是抛出错误
+    throw newError;
+  }
+}

package/dist/templates/react-app/src/base/services/UserGatewayPlugin.ts

@@ -0,0 +1,16 @@
+import type { UserInfo, UserCredential } from '@/base/apis/userApi/UserApiType';
+import type { RouteServiceInterface } from '../port/RouteServiceInterface';
+import type { UserServicePluginInterface } from '@qlover/corekit-bridge';
+
+export class UserGatewayPlugin
+  implements UserServicePluginInterface<UserInfo, UserCredential>
+{
+  readonly pluginName = 'UserGatewayPlugin';
+
+  constructor(protected routerService: RouteServiceInterface) {}
+
+  onLogoutSuccess(): void {
+    this.routerService.reset();
+    this.routerService.gotoLogin();
+  }
+}

package/dist/templates/react-app/src/base/services/UserService.ts

@@ -1,51 +1,41 @@
-import * as errKeys from '@config/Identifier/common/common.error';
-import { IOCIdentifier } from '@config/IOCIdentifier';
+import { I } from '@config/IOCIdentifier';
 import {
-  type UserAuthApiInterface,
-  type UserAuthState,
-  LoginResponseData,
-  UserAuthStore
+  UserService as CorekitBridgeUserService,
+  GatewayExecutor
 } from '@qlover/corekit-bridge';
-import { type SyncStorageInterface } from '@qlover/fe-corekit';
 import { inject, injectable } from 'inversify';
+import { isObject, isString } from 'lodash';
 import { UserApi } from '@/base/apis/userApi/UserApi';
-import type {
-  UserApiLoginTransaction,
-  UserInfo
-} from '@/base/apis/userApi/UserApiType';
-import { AppError } from '@/base/cases/AppError';
+import type { UserInfo, UserCredential } from '@/base/apis/userApi/UserApiType';
 import { AppConfig } from '../cases/AppConfig';
-import { RouteServiceInterface } from '../port/RouteServiceInterface';
 import { UserServiceInterface } from '../port/UserServiceInterface';
-
-export interface UserApiState extends UserAuthState<UserInfo> {}
-
-export interface RegisterFormData {
-  username: string;
-  email: string;
-  password: string;
-  confirmPassword: string;
-  agreeToTerms: boolean;
-}
+import type { UserServiceGateway } from '@qlover/corekit-bridge';
+import type { SyncStorageInterface } from '@qlover/fe-corekit';
+import type { LoggerInterface } from '@qlover/logger';
 
 @injectable()
-export class UserService extends UserServiceInterface {
+export class UserService
+  extends CorekitBridgeUserService<UserInfo, UserCredential>
+  implements UserServiceInterface
+{
   constructor(
-    @inject(IOCIdentifier.RouteServiceInterface)
-    protected routerService: RouteServiceInterface,
     @inject(UserApi)
-    userApi: UserAuthApiInterface<UserInfo>,
-    @inject(IOCIdentifier.AppConfig) appConfig: AppConfig,
-    @inject(IOCIdentifier.LocalStorageEncrypt)
-    storage: SyncStorageInterface<string, string>
+    userApi: UserServiceGateway<UserInfo, UserCredential>,
+    @inject(I.AppConfig) appConfig: AppConfig,
+    @inject(I.LocalStorageEncrypt)
+    storage: SyncStorageInterface<string>,
+    @inject(I.Logger)
+    logger: LoggerInterface
   ) {
-    super(userApi, {
-      userStorage: {
-        key: appConfig.userInfoStorageKey,
-        storage: storage
-      },
-      credentialStorage: {
-        key: appConfig.userTokenStorageKey,
+    super({
+      executor: new GatewayExecutor(),
+      gateway: userApi,
+      logger: logger,
+      store: {
+        storageKey: appConfig.userInfoStorageKey,
+        credentialStorageKey: appConfig.userTokenStorageKey,
+        // Not production environment persists user information, for testing and development
+        persistUserInfo: !appConfig.isProduction,
         storage: storage
       }
     });
@@ -53,60 +43,41 @@ export class UserService extends UserServiceInterface {
 
   /**
    * @override
+   * @returns
    */
-  override get store(): UserAuthStore<UserApiState> {
-    return super.store as UserAuthStore<UserApiState>;
+  getToken(): string {
+    return this.getCredential()?.token ?? '';
   }
 
-  override getToken(): string | null {
-    return this.store.getCredential();
+  isUserInfo(value: unknown): value is UserInfo {
+    return (
+      isObject(value) &&
+      'name' in value &&
+      isString(value.name) &&
+      'email' in value &&
+      isString(value.email) &&
+      'picture' in value &&
+      isString(value.picture)
+    );
   }
 
-  /**
-   * @override
-   */
-  async onBefore(): Promise<void> {
-    if (this.isAuthenticated()) {
-      return;
-    }
-
-    const userToken = this.getToken();
+  isUserCredential(value: unknown): value is UserCredential {
+    return isObject(value) && 'token' in value && isString(value.token);
+  }
 
-    if (!userToken) {
-      throw new AppError(errKeys.LOCAL_NO_USER_TOKEN);
+  override isAuthenticated(): boolean {
+    if (!super.isAuthenticated()) {
+      return false;
     }
 
-    if (userToken) {
-      this.store.authSuccess();
+    if (!this.isUserInfo(this.getUser())) {
+      return false;
     }
 
-    await this.userInfo();
-    this.store.authSuccess();
-  }
-
-  override async logout(): Promise<void> {
-    await super.logout();
-
-    this.routerService.reset();
-    this.routerService.gotoLogin();
-  }
-
-  override async register(
-    params: RegisterFormData
-  ): Promise<LoginResponseData> {
-    const response = (await this.api.register(
-      params
-    )) as UserApiLoginTransaction['response'];
-
-    if (response.data?.token) {
-      try {
-        await this.userInfo({ token: response.data?.token });
-        this.store.authSuccess();
-      } catch (error) {
-        this.store.authFailed(error);
-      }
+    if (!this.isUserCredential(this.getCredential())) {
+      return false;
     }
 
-    throw new AppError(errKeys.LOCAL_NO_USER_TOKEN);
+    return true;
   }
 }

package/dist/templates/react-app/src/core/bootstraps/BootstrapClient.ts

@@ -1,6 +1,11 @@
-import { envBlackList, envPrefix, browserGlobalsName } from '@config/common';
+import {
+  envBlackList,
+  envPrefix,
+  browserGlobalsName,
+  omitInjectedGlobals
+} from '@config/common';
 import { Bootstrap } from '@qlover/corekit-bridge';
-import { isObject } from 'lodash';
+import { isObject, omit } from 'lodash';
 import type { IOCInterface, IOCRegister } from '@/base/port/IOCInterface';
 import type { IOCIdentifierMap } from '@config/IOCIdentifier';
 import * as globals from '../globals';
@@ -78,7 +83,7 @@ export class BootstrapClient {
         blackList: envBlackList
       },
       globalOptions: {
-        sources: globals,
+        sources: omit(globals, omitInjectedGlobals),
         target: browserGlobalsName
       }
     });

package/dist/templates/react-app/src/core/bootstraps/BootstrapsRegistry.ts

@@ -1,10 +1,11 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
+import { I } from '@config/IOCIdentifier';
 import { AiApiBootstarp } from '@/base/apis/AiApi';
 import { FeApiBootstarp } from '@/base/apis/feApi/FeApiBootstarp';
 import { UserApiBootstarp } from '@/base/apis/userApi/UserApiBootstarp';
 import type { IOCIdentifierMap } from '@config/IOCIdentifier';
 import { IocIdentifierTest } from './IocIdentifierTest';
 import { printBootstrap } from './PrintBootstrap';
+import { saveAppInfo } from './SaveAppInfo';
 import type {
   BootstrapExecutorPlugin,
   EnvConfigInterface,
@@ -24,18 +25,19 @@ export class BootstrapsRegistry implements BootstrapsRegistryInterface {
   ) {}
 
   get appConfig(): EnvConfigInterface {
-    return this.IOC(IOCIdentifier.AppConfig);
+    return this.IOC(I.AppConfig);
   }
 
   register(): BootstrapExecutorPlugin[] {
     const IOC = this.IOC;
 
     const bootstrapList = [
-      IOC(IOCIdentifier.I18nServiceInterface),
+      IOC(I.I18nServiceInterface),
       new UserApiBootstarp(),
       new FeApiBootstarp(),
       AiApiBootstarp,
-      IOC(IOCIdentifier.I18nKeyErrorPlugin)
+      saveAppInfo,
+      IOC(I.I18nKeyErrorPlugin)
     ];
 
     if (!this.appConfig.isProduction) {
@@ -43,8 +45,6 @@ export class BootstrapsRegistry implements BootstrapsRegistryInterface {
     }
 
     bootstrapList.push(IocIdentifierTest);
-    // TODO: 需要使用到
-    bootstrapList.push(IOC(IOCIdentifier.ProcesserExecutorInterface));
 
     return bootstrapList;
   }

package/dist/templates/react-app/src/core/bootstraps/SaveAppInfo.ts

@@ -0,0 +1,28 @@
+import { I } from '@config/IOCIdentifier';
+import type { AppConfig } from '@/base/cases/AppConfig';
+import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
+import type { SyncStorageInterface } from '@qlover/fe-corekit';
+
+/**
+ * 保存应用信息到本地存储
+ *
+ * 包含以下:
+ *
+ * - 应用名称
+ * - 应用版本
+ */
+export const saveAppInfo: BootstrapExecutorPlugin = {
+  pluginName: 'SaveAppInfo',
+  onSuccess({ parameters: { ioc, logger } }) {
+    const appConfig = ioc.get<AppConfig>(I.AppConfig);
+    const localStorage = ioc.get<SyncStorageInterface<string>>(I.LocalStorage);
+
+    const key = appConfig.appName + '_appInfo';
+    localStorage.setItem(key, {
+      appName: appConfig.appName,
+      appVersion: appConfig.appVersion
+    });
+
+    logger.info(`Saved app info to localStorage: ${key}`);
+  }
+};