@qlover/create-app 1.1.0 → 2.0.0

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

@@ -1,20 +0,0 @@
-import type { UserInfo, UserCredential } from '@/base/apis/userApi/UserApiType';
-import type { UserServiceInterface as CorekitBridgeUserServiceInterface } from '@qlover/corekit-bridge';
-
-export interface UserServiceInterface extends CorekitBridgeUserServiceInterface<
-  UserInfo,
-  UserCredential
-> {
-  // You can add your own methods here
-
-  /**
-   * 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

@@ -1,61 +0,0 @@
-import { I } from '@config/IOCIdentifier';
-import {
-  ExecutorContextInterface,
-  LifecycleExecutor,
-  LifecyclePluginInterface
-} 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 {
-  BootstrapPluginOptions,
-  IOCContainerInterface
-} from '@qlover/corekit-bridge';
-import type { LoggerInterface } from '@qlover/logger';
-
-@injectable()
-export class BaseLayoutService {
-  protected executor: LifecycleExecutor = new LifecycleExecutor();
-
-  constructor(
-    @inject(I.Logger) protected logger: LoggerInterface,
-    @inject(I.RouteServiceInterface)
-    protected routeService: RouteServiceInterface,
-    @inject(I.UserServiceInterface)
-    protected userService: UserServiceInterface
-  ) {
-    this.use(new UserBootstrap(userService));
-  }
-
-  public use(
-    plugin: LifecyclePluginInterface<ExecutorContextInterface<unknown, unknown>>
-  ): this {
-    this.executor.use(plugin);
-    return this;
-  }
-
-  public handler(): Promise<{ success: boolean }> {
-    return Promise.resolve({
-      success: true
-    });
-  }
-
-  public async starup(ioc: IOCContainerInterface): Promise<unknown> {
-    const context: BootstrapPluginOptions = {
-      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

@@ -1,146 +0,0 @@
-/* eslint-disable import/no-named-as-default-member */
-import { useLocaleRoutes } from '@config/common';
-import { i18nConfig } from '@config/i18n/i18nConfig';
-import {
-  type StoreStateInterface,
-  StoreInterface
-} from '@qlover/corekit-bridge';
-import i18n from 'i18next';
-import LanguageDetector from 'i18next-browser-languagedetector';
-import HttpApi from 'i18next-http-backend';
-import merge from 'lodash/merge';
-import { initReactI18next } from 'react-i18next';
-import type { LocaleType } from '@config/i18n/i18nConfig';
-import type { I18nServiceInterface } from '../port/I18nServiceInterface';
-
-const { supportedLngs, fallbackLng } = i18nConfig;
-
-export class I18nServiceState implements StoreStateInterface {
-  public loading: boolean = false;
-  constructor(public language: LocaleType) {}
-}
-
-export class I18nService
-  extends StoreInterface<I18nServiceState>
-  implements I18nServiceInterface
-{
-  public readonly pluginName = 'I18nService';
-
-  public selector = {
-    loading: (state: I18nServiceState) => state.loading,
-    language: (state: I18nServiceState) => state.language
-  };
-
-  constructor(protected pathname: string) {
-    super(() => new I18nServiceState(i18n.language as LocaleType));
-  }
-
-  /**
-   * @override
-   */
-  public onBefore(): void {
-    const debug = false;
-
-    i18n
-      .use(HttpApi)
-      .use(LanguageDetector)
-      .use(initReactI18next)
-      .init(
-        merge({}, i18nConfig, {
-          debug,
-          detection: {
-            order: useLocaleRoutes
-              ? ['pathLanguageDetector', 'navigator', 'localStorage']
-              : ['localStorage', 'navigator'],
-            caches: useLocaleRoutes ? [] : ['localStorage']
-          }
-        })
-      );
-
-    // add custom detector
-    // custom language detector
-    const pathLanguageDetector = {
-      name: 'pathLanguageDetector',
-      lookup: () => {
-        const paths = this.pathname.split('/');
-
-        for (const path of paths) {
-          if (this.isValidLanguage(path)) {
-            return path;
-          }
-        }
-
-        return fallbackLng;
-      }
-    };
-    i18n.services.languageDetector.addDetector(pathLanguageDetector);
-
-    // Sync i18n.language with state.language
-    i18n.on('languageChanged', (lng: string) => {
-      if (this.isValidLanguage(lng) && this.state.language !== lng) {
-        this.emit({ ...this.state, language: lng as LocaleType });
-      }
-    });
-  }
-
-  /**
-   * @override
-   */
-  public async changeLanguage(language: LocaleType): Promise<void> {
-    await i18n.changeLanguage(language);
-    // Sync state with i18n.language
-    this.emit({ ...this.state, language });
-  }
-
-  /**
-   * @override
-   */
-  public changeLoading(loading: boolean): void {
-    this.emit({ ...this.state, loading });
-  }
-
-  /**
-   * @override
-   */
-  public getCurrentLanguage(): LocaleType {
-    return i18n.language as LocaleType;
-  }
-
-  /**
-   * check if the language is supported
-   * @override
-   * @param language - language to check
-   * @returns true if the language is supported, false otherwise
-   */
-  public isValidLanguage(language: string): language is LocaleType {
-    return supportedLngs.includes(language as LocaleType);
-  }
-
-  /**
-   * @override
-   */
-  public getSupportedLanguages(): LocaleType[] {
-    return [...supportedLngs];
-  }
-
-  /**
-   * translate the key
-   * @override
-   * @param key - key to translate
-   * @param params - params to pass to the translation
-   * @returns translated value
-   */
-  public t(key: string, params?: Record<string, unknown>): string {
-    const i18nValue = i18n.t(key, {
-      lng: i18n.language,
-      nsSeparator: false,
-      ...params
-    });
-
-    if (!i18nValue || i18nValue === key) {
-      return key;
-    }
-
-    return i18nValue;
-  }
-}

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

@@ -1,162 +0,0 @@
-import { routerPrefix } from '@config/common';
-import { I } from '@config/IOCIdentifier';
-import {
-  RequestState,
-  type ResourceStateInterface,
-  type ResourceServiceInterface,
-  type ResourceInterface,
-  type ResourceQuery,
-  ResourceStore
-} from '@qlover/corekit-bridge';
-import { inject, injectable } from 'inversify';
-import type { LocaleType } from '@config/i18n/i18nConfig';
-import { I18nService } from './I18nService';
-import { PaginationInterface, ResourceState } from '../cases/ResourceState';
-
-export interface IdentifierRecord {
-  id: string;
-  locale: LocaleType;
-  localeValue: string;
-}
-
-@injectable()
-export class IdentifierService<T> implements ResourceServiceInterface<
-  T,
-  ResourceStore<ResourceStateInterface>
-> {
-  public readonly unionKey: string = 'id';
-  public readonly serviceName: string = 'IdentifierService';
-  public readonly store: ResourceStore<ResourceStateInterface>;
-  // Not implemented
-  public readonly resourceApi!: ResourceInterface<T>;
-  private unsubscribe: (() => void) | null = null;
-
-  constructor(
-    @inject(I.I18nServiceInterface)
-    protected readonly i18nService: I18nService
-  ) {
-    this.store = new ResourceStore(() => new ResourceState());
-  }
-
-  /**
-   * @override
-   */
-  public getStore(): ResourceStore<ResourceStateInterface> {
-    return this.store;
-  }
-
-  protected async init(): Promise<unknown> {
-    this.store.changeInitState(new RequestState(true));
-
-    try {
-      const result = await this.search({
-        locale: this.i18nService.getCurrentLanguage() as LocaleType
-      });
-
-      this.store.changeInitState(new RequestState(false, result).end());
-      return result;
-    } catch (error) {
-      this.store.changeInitState(new RequestState(false, null, error).end());
-
-      return error;
-    }
-  }
-
-  /**
-   * @override
-   */
-  public async created(): Promise<unknown> {
-    this.unsubscribe = this.i18nService.observe(
-      (state) => state.language,
-      () => {
-        this.init();
-      }
-    );
-
-    return this.init();
-  }
-
-  /**
-   * @override
-   */
-  public destroyed(): void {
-    this.unsubscribe?.();
-    this.unsubscribe = null;
-
-    this.store.reset();
-  }
-
-  /**
-   * @override
-   */
-  public updated(): void {}
-
-  /**
-   * @override
-   */
-  public async search(
-    params: Partial<ResourceQuery & { locale: LocaleType }>
-  ): Promise<PaginationInterface<IdentifierRecord>> {
-    this.store.changeListState(
-      new RequestState(true, this.store.state.listState.result)
-    );
-
-    const locale = params.locale!;
-
-    const response = await fetch(
-      `${routerPrefix}/locales/${locale}/common.json`
-    );
-    const data = await response.json();
-
-    let index = 0;
-    const resultList: IdentifierRecord[] = Object.entries(data).map(
-      ([key, value]) => ({
-        index: (index += 1),
-        id: key,
-        locale: locale,
-        localeValue: value as string
-      })
-    );
-
-    const result: PaginationInterface<IdentifierRecord> = {
-      list: resultList,
-      total: resultList.length,
-      page: 1,
-      pageSize: 10
-    };
-
-    this.store.changeListState(new RequestState(false, result).end());
-
-    return result;
-  }
-
-  public refresh(): Promise<unknown> {
-    return this.search(this.store.state.searchParams);
-  }
-
-  /**
-   * @override
-   */
-  public async update(_data: Partial<T>): Promise<unknown> {
-    return Promise.resolve(null);
-  }
-
-  /**
-   * @override
-   */
-  public create(_data: T): Promise<unknown> {
-    return Promise.resolve(null);
-  }
-  /**
-   * @override
-   */
-  public remove(_data: T): Promise<unknown> {
-    return Promise.resolve(null);
-  }
-  /**
-   * @override
-   */
-  public export(_data: T): Promise<unknown> {
-    return Promise.resolve(null);
-  }
-}

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

@@ -1,115 +0,0 @@
-import { i18nConfig } from '@config/i18n/i18nConfig';
-import type { RouteConfigValue } from '@/base/cases/RouterLoader';
-import { RouteServiceInterface } from '../port/RouteServiceInterface';
-import type { I18nServiceInterface } from '../port/I18nServiceInterface';
-import type {
-  UIBridgeInterface,
-  StoreStateInterface
-} from '@qlover/corekit-bridge';
-import type { LoggerInterface } from '@qlover/logger';
-import type { NavigateFunction, NavigateOptions } from 'react-router-dom';
-
-export type RouterServiceOptions = {
-  routerPrefix: string;
-  routes: RouteConfigValue[];
-  /**
-   * Whether to use locale routes
-   *
-   * @default `false`
-   */
-  hasLocalRoutes?: boolean;
-  logger: LoggerInterface;
-};
-
-export class RouterServiceState implements StoreStateInterface {
-  constructor(
-    public routes: RouteConfigValue[] = [],
-    public localeRoutes: boolean = false
-  ) {}
-}
-
-export class RouteService extends RouteServiceInterface {
-  constructor(
-    protected uiBridge: UIBridgeInterface<NavigateFunction>,
-    protected i18nService: I18nServiceInterface,
-    protected options: RouterServiceOptions
-  ) {
-    super(
-      () => new RouterServiceState(options.routes, !!options.hasLocalRoutes)
-    );
-  }
-
-  public override get logger(): LoggerInterface {
-    return this.options.logger;
-  }
-
-  protected composePath(path: string): string {
-    if (this.state.localeRoutes) {
-      const targetLang = this.i18nService.getCurrentLanguage();
-      return `/${targetLang}${path}`;
-    }
-    return path.startsWith('/') ? path : `/${path}`;
-  }
-
-  public override getRoutes(): RouteConfigValue[] {
-    return this.state.routes;
-  }
-
-  public override changeRoutes(routes: RouteConfigValue[]): void {
-    this.emit(this.cloneState({ routes }));
-  }
-
-  public override goto(
-    path: string,
-    options?: NavigateOptions & {
-      navigate?: NavigateFunction;
-    }
-  ): void {
-    const { navigate, ...rest } = options || {};
-    path = this.composePath(path);
-    this.logger.debug('Goto path => ', path);
-
-    (navigate || this.uiBridge.getUIBridge())?.(path, rest);
-  }
-
-  public override gotoLogin(): void {
-    this.goto('/login', { replace: true });
-  }
-
-  public override replaceToHome(): void {
-    this.goto('/', { replace: true });
-  }
-
-  public override redirectToDefault(navigate?: NavigateFunction): void {
-    this.goto('/', { replace: true, navigate });
-  }
-
-  public override i18nGuard(
-    currentPath: string,
-    lng: string,
-    navigate?: NavigateFunction
-  ): void {
-    // 只在使用本地化路由时才检查
-    if (!this.state.localeRoutes) {
-      return;
-    }
-
-    const _navigate = navigate || this.uiBridge.getUIBridge();
-
-    lng = lng || i18nConfig.fallbackLng;
-
-    // 如果没有语言参数或语言无效
-    if (!this.i18nService.isValidLanguage(lng)) {
-      // 重定向到默认语言？
-      if (i18nConfig.noValidRedirectFallbackLng) {
-        const newPath = currentPath.replace(lng, i18nConfig.fallbackLng);
-
-        _navigate?.(newPath, { replace: true });
-        return;
-      }
-
-      // 不支持的语言直接404
-      _navigate?.('/404', { replace: true });
-    }
-  }
-}

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

@@ -1,45 +0,0 @@
-import { LOCAL_NO_USER_TOKEN } from '@config/Identifier';
-import { I } from '@config/IOCIdentifier';
-import { ExecutorError } from '@qlover/fe-corekit';
-import { inject, injectable } from 'inversify';
-import type { UserServiceInterface } from '../port/UserServiceInterface';
-import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
-
-@injectable()
-export class UserBootstrap implements BootstrapExecutorPlugin {
-  public readonly pluginName = 'UserBootstrap';
-
-  constructor(
-    @inject(I.UserServiceInterface)
-    protected userService: UserServiceInterface
-  ) {}
-
-  /**
-   * @override
-   */
-  public onBefore(): void {
-    const userService = this.userService;
-
-    if (userService.isAuthenticated()) {
-      return;
-    }
-
-    // 如果用户凭证存在，则刷新用户信息, 更新状态
-    const credential = userService.getCredential();
-    if (userService.isUserCredential(credential)) {
-      userService.getStore().start();
-
-      userService.refreshUserInfo().then((user) => {
-        userService.getStore().success(user);
-      });
-
-      return;
-    }
-
-    const newError = new ExecutorError(LOCAL_NO_USER_TOKEN);
-
-    userService.getStore().failed(newError);
-
-    throw newError;
-  }
-}

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

@@ -1,88 +0,0 @@
-import { I } from '@config/IOCIdentifier';
-import { UserService as CorekitBridgeUserService } from '@qlover/corekit-bridge';
-import { inject, injectable } from 'inversify';
-import { isObject, isString } from 'lodash';
-import { UserApi } from '@/base/apis/userApi/UserApi';
-import type { UserInfo, UserCredential } from '@/base/apis/userApi/UserApiType';
-import { AppConfig } from '../cases/AppConfig';
-import { UserServiceInterface } from '../port/UserServiceInterface';
-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 CorekitBridgeUserService<UserInfo, UserCredential>
-  implements UserServiceInterface
-{
-  constructor(
-    @inject(UserApi)
-    userApi: UserServiceGateway<UserInfo, UserCredential>,
-    @inject(I.AppConfig) appConfig: AppConfig,
-    @inject(I.LocalStorageEncrypt)
-    storage: SyncStorageInterface<string>,
-    @inject(I.Logger)
-    logger: LoggerInterface
-  ) {
-    super({
-      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
-      }
-    });
-  }
-
-  /**
-   * @override
-   * @returns
-   */
-  public getToken(): string {
-    return this.getCredential()?.token ?? '';
-  }
-
-  /**
-   * @override
-   */
-  public 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
-   */
-  public isUserCredential(value: unknown): value is UserCredential {
-    return isObject(value) && 'token' in value && isString(value.token);
-  }
-
-  /**
-   * @override
-   */
-  public override isAuthenticated(): boolean {
-    if (!super.isAuthenticated()) {
-      return false;
-    }
-
-    if (!this.isUserInfo(this.getUser())) {
-      return false;
-    }
-
-    if (!this.isUserCredential(this.getCredential())) {
-      return false;
-    }
-
-    return true;
-  }
-}

package/dist/templates/react-app/src/base/types/Page.ts

@@ -1,47 +0,0 @@
-import type { TFunction } from 'i18next';
-import type { UseTranslationResponse } from 'react-i18next';
-
-export interface BasePageProvider<T extends Record<string, string>> {
-  meta: Omit<RouteMeta, 'i18nInterface'> & {
-    i18nInterface?: T;
-  };
-  i18n: UseTranslationResponse<string, string>;
-  t: TFunction<string, string>;
-  /**
-   * 已经翻译后的 i18n interface
-   */
-  i18nInterface: T;
-  tt: T;
-}
-
-type RouteCategory = 'main' | 'auth' | 'common';
-
-export interface RouteMeta {
-  /**
-   * The title of the route
-   */
-  title?: string;
-
-  /**
-   * The description of the route
-   */
-  description?: string;
-
-  /**
-   * The icon of the route
-   */
-  icon?: string;
-
-  category?: RouteCategory;
-  /**
-   * from app.router.json
-   *
-   * @default 'common'
-   */
-  localNamespace?: string;
-
-  /**
-   * The i18n interface of the route
-   */
-  i18nInterface?: Record<string, string>;
-}