@qlover/create-app 1.0.2 → 2.0.0

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

@@ -1,64 +0,0 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
-import {
-  ExecutorContextInterface,
-  ExecutorError,
-  LifecyclePluginInterface
-} from '@qlover/fe-corekit';
-import { inject, injectable } from 'inversify';
-import type { I18nServiceInterface } from '../port/I18nServiceInterface';
-import type { LoggerInterface } from '@qlover/logger';
-
-/**
- * When throw error, it will be converted to i18n key
- *
- * If the error thrown is an i18n key, it will be converted to the corresponding text
- */
-@injectable()
-export class I18nKeyErrorPlugin implements LifecyclePluginInterface<
-  ExecutorContextInterface<unknown, unknown>
-> {
-  public readonly pluginName = 'I18nKeyErrorPlugin';
-
-  constructor(
-    @inject(IOCIdentifier.Logger) protected logger: LoggerInterface,
-    @inject(IOCIdentifier.I18nServiceInterface)
-    protected i18nService: I18nServiceInterface
-  ) {}
-
-  protected translateById(id: string): string {
-    return this.i18nService.t(id);
-  }
-
-  /**
-   * @override
-   */
-  public onError(
-    context: ExecutorContextInterface<unknown, unknown>
-  ): ExecutorError | void {
-    const { error } = context;
-
-    if (!error) {
-      return;
-    }
-
-    if (error instanceof ExecutorError) {
-      const i18nText = this.translateById(error.id);
-      this.logger.error('i18nText', i18nText);
-      return new ExecutorError(error.id, i18nText);
-    }
-
-    if (error instanceof Error) {
-      const i18nKey = error.message;
-
-      if (i18nKey && typeof i18nKey === 'string') {
-        const i18nText = this.translateById(i18nKey);
-
-        if (i18nText && i18nText !== i18nKey) {
-          this.logger.debug('I18nKeyErrorPlugin Error:', i18nText);
-          // Use i18nText as cause (string) so ExecutorError.message will be the translated text
-          return new ExecutorError(i18nKey, i18nText);
-        }
-      }
-    }
-  }
-}

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

@@ -1,45 +0,0 @@
-import { Container } from 'inversify';
-import type { IOCIdentifierMap } from '@config/IOCIdentifier';
-import type {
-  IOCContainerInterface,
-  ServiceIdentifier
-} from '@qlover/corekit-bridge';
-
-export class InversifyContainer implements IOCContainerInterface {
-  protected container: Container;
-
-  constructor() {
-    this.container = new Container({
-      // allow `@injectable` decorator, auto bind injectable classes
-      autobind: true,
-      // use singleton scope
-      defaultScope: 'Singleton'
-    });
-  }
-
-  /**
-   * @override
-   */
-  public bind<T>(key: ServiceIdentifier<T>, value: T): void {
-    this.container.bind<T>(key).toConstantValue(value);
-  }
-
-  /**
-   * @override
-   */
-  public get<K extends keyof IOCIdentifierMap>(
-    serviceIdentifier: K
-  ): IOCIdentifierMap[K];
-  /**
-   * @override
-   */
-  public get<T>(serviceIdentifier: ServiceIdentifier<T>): T;
-  /**
-   * @override
-   */
-  public get<T, K extends keyof IOCIdentifierMap>(
-    serviceIdentifier: ServiceIdentifier<T> | K
-  ): T | IOCIdentifierMap[K] {
-    return this.container.get<T>(serviceIdentifier);
-  }
-}

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

@@ -1,23 +0,0 @@
-import { routerPrefix } from '@config/common';
-import { injectable } from 'inversify';
-
-/**
- * Get Publish Assets Path
- *
- * - If router has prefix, the path will be `prefix/path`
- * - If router has no prefix, the path will be `path`
- */
-@injectable()
-export class PublicAssetsPath {
-  constructor(protected prefix: string = routerPrefix) {}
-
-  public getPath(path: string): string {
-    if (!this.prefix) {
-      return path.startsWith('/') ? path : `/${path}`;
-    }
-    const prefix = this.prefix.endsWith('/')
-      ? this.prefix.slice(0, -1)
-      : this.prefix;
-    return prefix + (path.startsWith('/') ? path : `/${path}`);
-  }
-}

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

@@ -1,55 +0,0 @@
-import type { I18nServiceInterface } from '@/base/port/I18nServiceInterface';
-import type {
-  ExecutorContextInterface,
-  LifecyclePluginInterface,
-  RequestAdapterConfig
-} from '@qlover/fe-corekit';
-
-export class RequestLanguages implements LifecyclePluginInterface<
-  ExecutorContextInterface<RequestAdapterConfig, unknown>
-> {
-  public readonly pluginName = 'RequestLanguages';
-
-  constructor(
-    protected i18nService: I18nServiceInterface,
-    protected headerName = 'accept-language'
-  ) {}
-
-  public buildAcceptLanguage(langs: string[]): string {
-    return langs
-      .map((lang, index) => {
-        const q = Math.max(1 - index * 0.1, 0.1).toFixed(1);
-        return index === 0 ? lang : `${lang};q=${q}`;
-      })
-      .join(',');
-  }
-
-  /**
-   * @override
-   */
-  public onBefore(
-    context: ExecutorContextInterface<RequestAdapterConfig, unknown>
-  ): void {
-    const currentLanguage = this.i18nService.getCurrentLanguage();
-    const languages = this.i18nService.getSupportedLanguages();
-
-    if (!context.parameters.headers) {
-      context.setParameters({
-        ...context.parameters,
-        headers: {}
-      });
-    }
-
-    const languageValue = this.buildAcceptLanguage(
-      Array.from(new Set([currentLanguage, ...languages]))
-    );
-
-    context.setParameters({
-      ...context.parameters,
-      headers: {
-        ...context.parameters.headers,
-        [this.headerName]: languageValue
-      }
-    });
-  }
-}

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

@@ -1,80 +0,0 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
-import { type ApiCatchPluginResponse } from '@qlover/corekit-bridge';
-import {
-  type LifecyclePluginInterface,
-  type ExecutorContextInterface,
-  type RequestAdapterFetchConfig,
-  type RequestAdapterResponse
-} from '@qlover/fe-corekit';
-import { injectable, inject } from 'inversify';
-import type { LoggerInterface } from '@qlover/logger';
-
-@injectable()
-export class RequestLogger implements LifecyclePluginInterface<
-  ExecutorContextInterface<RequestAdapterFetchConfig, unknown>
-> {
-  public readonly pluginName = 'RequestLogger';
-
-  constructor(@inject(IOCIdentifier.Logger) public logger: LoggerInterface) {}
-
-  /**
-   * @override
-   */
-  public onBefore(
-    context: ExecutorContextInterface<RequestAdapterFetchConfig, unknown>
-  ): void {
-    this.logger.log(
-      `%c[Request before]%c [${new Date().toLocaleString()}] ${context.parameters.method} ${context.parameters.url}`,
-      'color: #0ff;',
-      'color: inherit;',
-      context.parameters
-    );
-  }
-
-  /**
-   * @override
-   */
-  public async onSuccess({
-    parameters,
-    returnValue
-  }: ExecutorContextInterface<
-    RequestAdapterFetchConfig,
-    unknown
-  >): Promise<void> {
-    const _returnValue = returnValue as RequestAdapterResponse &
-      ApiCatchPluginResponse;
-
-    // If the apiCatchResult is not null, it means that the error has been caught
-    // from `ApiCatchPlugin`
-    if (_returnValue.apiCatchResult) {
-      this.loggerError(parameters, _returnValue.apiCatchResult);
-      return;
-    }
-
-    this.logger.log(
-      `%c[Request success]%c [${new Date().toLocaleString()}] ${parameters.method} ${parameters.url}`,
-      'color: #0f0;',
-      'color: inherit;',
-      _returnValue
-    );
-  }
-
-  /**
-   * @override
-   */
-  public onError({
-    parameters,
-    error
-  }: ExecutorContextInterface<RequestAdapterFetchConfig, unknown>): void {
-    this.loggerError(parameters, error);
-  }
-
-  public loggerError(config: RequestAdapterFetchConfig, error: unknown): void {
-    this.logger.log(
-      `%c[Request error]%c [${new Date().toLocaleString()}] ${config.method} ${config.url}`,
-      'color: #f00;',
-      'color: inherit;',
-      error
-    );
-  }
-}

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

@@ -1,40 +0,0 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
-import { inject, injectable } from 'inversify';
-import type { RequestCatcherInterface } from '@qlover/corekit-bridge';
-import type { RequestAdapterResponse } from '@qlover/fe-corekit';
-import type { LoggerInterface } from '@qlover/logger';
-
-@injectable()
-export class RequestStatusCatcher implements RequestCatcherInterface<RequestAdapterResponse> {
-  constructor(
-    @inject(IOCIdentifier.Logger) protected logger: LoggerInterface
-  ) {}
-
-  /**
-   * default handler
-   * @override
-   */
-  public default(context: RequestAdapterResponse<unknown, unknown>): void {
-    this.logger.warn(`RequestStatusCatcher default handler`, context);
-  }
-
-  /**
-   * handler
-   * @override
-   */
-  public handler(context: RequestAdapterResponse<unknown, unknown>): void {
-    const { status } = context;
-
-    const _handler = this[`case${status}` as keyof RequestStatusCatcher];
-
-    if (typeof _handler === 'function') {
-      return _handler.call(this, context);
-    }
-
-    return this.default(context);
-  }
-
-  public case200(_context: RequestAdapterResponse<unknown, unknown>): void {
-    // this.logger.info(`RequestStatusCatcher case200 handler`, context);
-  }
-}

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

@@ -1,23 +0,0 @@
-import { RequestState } from '@qlover/corekit-bridge';
-import type {
-  ResourceQuery,
-  ResourceStateInterface
-} from '@qlover/corekit-bridge';
-
-export interface PaginationInterface<T> {
-  list: T[];
-  total: number;
-  page: number;
-  pageSize: number;
-}
-
-export class ResourceState implements ResourceStateInterface {
-  public searchParams: ResourceQuery = {
-    page: 1,
-    pageSize: 10,
-    orderBy: 'updated_at',
-    order: 1
-  };
-  public initState = new RequestState<unknown>();
-  public listState = new RequestState<PaginationInterface<unknown>>();
-}

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

@@ -1,173 +0,0 @@
-import isString from 'lodash/isString';
-import type { RouteMeta } from '../types/Page';
-import type { LoggerInterface } from '@qlover/logger';
-import type { ComponentType, LazyExoticComponent, ReactNode } from 'react';
-import type { RouteObject } from 'react-router-dom';
-
-/**
- * Component mapping type for lazy-loaded components
- * @description Maps component identifiers to their lazy-loaded implementations
- */
-export type ComponentValue = Record<string, () => unknown>;
-
-/**
- * Route component type definition supporting both regular and lazy-loaded components
- */
-type RouteComponentType<T = unknown> =
-  | ComponentType<T>
-  | LazyExoticComponent<ComponentType<T>>;
-
-/**
- * Extended route configuration interface
- * @description Extends React Router's RouteObject with additional meta information
- */
-export type RouteConfigValue = Omit<RouteObject, 'element' | 'children'> & {
-  /**
-   * Component identifier string that maps to a component in componentMaps
-   *
-   * TODO: support `ReactNode`
-   *
-   * @description Used to lookup the actual component implementation
-   */
-  element?: string;
-
-  /**
-   * Nested route configurations
-   */
-  children?: RouteConfigValue[];
-
-  /**
-   * Additional metadata for the route
-   * @description Can store any route-specific data like permissions, titles, etc.
-   */
-  meta?: RouteMeta;
-};
-
-/**
- * Route rendering function type
- * @description Function to customize how route components are rendered
- */
-export type RouterLoaderRender = (
-  route: Omit<RouteConfigValue, 'element'> & {
-    element: () => RouteComponentType;
-  }
-) => ReactNode;
-
-/**
- * Router loader configuration options
- */
-export type RouterLoaderOptions = {
-  /**
-   * Route configuration array
-   * @description Defines the application's routing structure
-   */
-  routes?: RouteConfigValue[];
-
-  /**
-   * Component mapping object
-   * @description Maps component identifiers to their actual implementations
-   * @example
-   * {
-   *   'Home': () => import('./pages/Home'),
-   *   'About': () => import('./pages/About')
-   * }
-   */
-  componentMaps?: ComponentValue;
-
-  /**
-   * Custom route rendering function
-   * @description Controls how route components are rendered
-   * @required
-   */
-  render: RouterLoaderRender;
-
-  /**
-   * Logger
-   */
-  logger?: LoggerInterface;
-};
-
-/**
- * Router Configuration Loader
- *
- * Significance: Manages dynamic route configuration and component loading
- * Core idea: Separate route definitions from component implementations
- * Main function: Transform route configurations into React Router compatible routes
- * Main purpose: Enable dynamic and code-split routing with lazy loading
- *
- * @example
- * const loader = new RouterLoader({
- *   routes: [{
- *     path: '/',
- *     element: 'Home',
- *     children: [{
- *       path: 'about',
- *       element: 'About'
- *     }]
- *   }],
- *   componentMaps: {
- *     'Home': () => import('./pages/Home'),
- *     'About': () => import('./pages/About')
- *   },
- *   render: (route) => <Suspense><route.element /></Suspense>
- * });
- */
-export class RouterLoader {
-  constructor(protected options: RouterLoaderOptions) {
-    if (!options.render) {
-      throw new Error('RouterLoader render is required');
-    }
-  }
-
-  /**
-   * Get the component mapping object
-   * @returns Component mapping dictionary
-   */
-  public getComponentMaps(): ComponentValue {
-    const { componentMaps = {} } = this.options;
-    return componentMaps;
-  }
-
-  /**
-   * Retrieve a component implementation by its identifier
-   * @param element Component identifier string
-   * @returns Component loader function
-   * @throws Error if component is not found in componentMaps
-   */
-  public getComponent(element: string): () => RouteComponentType {
-    const maps = this.getComponentMaps();
-    const component = maps[element];
-
-    if (!component) {
-      throw new Error(`Component not found: ${element}`);
-    }
-
-    return component as () => RouteComponentType;
-  }
-
-  /**
-   * Transform a route configuration into a React Router compatible route
-   * @param route Route configuration object
-   * @returns React Router route object
-   */
-  public toRoute(route: RouteConfigValue): RouteObject {
-    const { render } = this.options;
-    const { element, children, ...rest } = route;
-
-    if (!element || !isString(element)) {
-      this.options.logger?.warn(
-        `Invalid route, path is: ${route.path}, element is: ${element}`
-      );
-    }
-
-    const componet = this.getComponent(element || '404');
-    const Element = render({ ...rest, element: componet });
-
-    // @ts-expect-error
-    return {
-      ...rest,
-      element: Element,
-      children: children?.map((child) => this.toRoute(child))
-    };
-  }
-}

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

@@ -1,26 +0,0 @@
-import type { PageI18nInterface } from '@config/i18n/PageI18nInterface';
-import type { TFunction } from 'i18next';
-
-/**
- * Translate I18n Interface tools class
- *
- * @param i18nInterface - The i18n interface to translate
- * @param t - The translations function
- * @returns The translated i18n interface
- */
-export class TranslateI18nInterface {
-  public static translate<T extends PageI18nInterface | Record<string, string>>(
-    source: T,
-    t: TFunction<string, string>
-  ): T {
-    return Object.fromEntries(
-      Object.entries(source).map(([key, value]) => {
-        if (typeof value === 'string') {
-          // 禁用命名空间分隔符，避免冒号被解析为命名空间
-          return [key, t(value, { nsSeparator: false })];
-        }
-        return [key, value];
-      })
-    ) as T;
-  }
-}

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

@@ -1,23 +0,0 @@
-import { StoreInterface } from '@qlover/corekit-bridge';
-import type { StoreStateInterface, RequestState } from '@qlover/corekit-bridge';
-
-export interface ExecutorPageStateInterface extends StoreStateInterface {
-  helloState: RequestState<any>;
-}
-
-/**
- * Executor Page Bridge Interface
- *
- * This interface provides a bridge for the ExecutorPage component to interact with the ExecutorController.
- * It allows the ExecutorPage component to subscribe to the ExecutorController's state and trigger actions.
- *
- * @example
- * const executorPageBridge = new ExecutorPageBridge();
- */
-export abstract class ExecutorPageBridgeInterface extends StoreInterface<ExecutorPageStateInterface> {
-  public selector = {
-    helloState: (state: ExecutorPageStateInterface) => state.helloState
-  };
-
-  public abstract onTestPlugins: () => Promise<void>;
-}

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

@@ -1,10 +0,0 @@
-import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
-
-export interface I18nServiceInterface extends BootstrapExecutorPlugin {
-  t(key: string, params?: Record<string, unknown>): string;
-  changeLanguage(language: string): void;
-  changeLoading(loading: boolean): void;
-  getCurrentLanguage(): string;
-  isValidLanguage(language: string): boolean;
-  getSupportedLanguages(): string[];
-}

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

@@ -1,38 +0,0 @@
-import type {
-  EnvConfigInterface,
-  IOCContainerInterface,
-  IOCFunctionInterface,
-  IOCRegisterInterface
-} from '@qlover/corekit-bridge';
-
-/**
- * IOC register options
- */
-export type IocRegisterOptions = {
-  /**
-   * The pathname of the current page
-   */
-  pathname: string;
-
-  /**
-   * The app config
-   */
-  appConfig: EnvConfigInterface;
-};
-
-export interface IOCInterface<
-  IdentifierMap,
-  IOCContainer extends IOCContainerInterface
-> {
-  create(
-    options: IocRegisterOptions
-  ): IOCFunctionInterface<IdentifierMap, IOCContainer>;
-}
-
-/**
- * 提供一个快捷的注册器类型名
- */
-export interface IOCRegister extends IOCRegisterInterface<
-  IOCContainerInterface,
-  IocRegisterOptions
-> {}

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

@@ -1,21 +0,0 @@
-import { StoreInterface } from '@qlover/corekit-bridge';
-import type { StoreStateInterface } from '@qlover/corekit-bridge';
-
-export interface JSONStoragePageStateInterface extends StoreStateInterface {
-  testKey1?: number;
-  testKey2?: number;
-  expireTime: number;
-  requestTimeout: number;
-}
-
-export abstract class JSONStoragePageBridgeInterface extends StoreInterface<JSONStoragePageStateInterface> {
-  public selector = {
-    requestTimeout: (state: JSONStoragePageStateInterface) =>
-      state.requestTimeout
-  };
-
-  public abstract changeRandomTestKey1: () => void;
-  public abstract onChangeRandomTestKey2: () => void;
-  public abstract changeExpireTime: (expireTime: number) => void;
-  public abstract changeRequestTimeout: (requestTimeout: number) => void;
-}

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

@@ -1,23 +0,0 @@
-import { StoreInterface } from '@qlover/corekit-bridge';
-import type { StoreStateInterface, RequestState } from '@qlover/corekit-bridge';
-
-export interface RequestPageStateInterface extends StoreStateInterface {
-  helloState: RequestState<unknown>;
-  ipInfoState: RequestState<unknown>;
-  randomUserState: RequestState<unknown>;
-  abortState: RequestState<unknown>;
-  apiCatchResultState: RequestState<unknown>;
-}
-
-export abstract class RequestPageBridgeInterface extends StoreInterface<RequestPageStateInterface> {
-  public abstract onHello: () => void;
-  public abstract onIpInfo: () => void;
-  public abstract onRandomUser: () => void;
-  public abstract onTriggerApiCatchResult: () => void;
-  public abstract onTriggerAbortRequest: () => void;
-  public abstract stopAbortRequest: () => void;
-
-  public emitState(state: Partial<RequestPageStateInterface>): void {
-    this.emit(this.cloneState(state));
-  }
-}

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

@@ -1,5 +0,0 @@
-export interface RequestStatusInterface {
-  loading: boolean;
-  result: unknown | null;
-  error: unknown | null;
-}

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

@@ -1,29 +0,0 @@
-import { StoreInterface } from '@qlover/corekit-bridge';
-import type { RouteConfigValue } from '../cases/RouterLoader';
-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 {
-  routes: RouteConfigValue[];
-  localeRoutes: boolean;
-}
-
-export abstract class RouteServiceInterface extends StoreInterface<RouteServiceStateInterface> {
-  public abstract get logger(): LoggerInterface;
-
-  public abstract getRoutes(): RouteConfigValue[];
-  public abstract changeRoutes(routes: RouteConfigValue[]): void;
-  public abstract goto(
-    path: string,
-    options?: NavigateOptions & { navigate?: NavigateFunction }
-  ): void;
-  public abstract gotoLogin(): void;
-  public abstract replaceToHome(): void;
-  public abstract redirectToDefault(navigate: NavigateFunction): void;
-  public abstract i18nGuard(
-    currentPath: string,
-    lng: string,
-    navigate?: NavigateFunction
-  ): void;
-}