@qlover/create-app 1.1.0 → 2.0.0

package/dist/templates/react-app/src/base/apis/feApi/FeApiAdapter.ts

@@ -1,14 +0,0 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
-import { RequestAdapterFetch } from '@qlover/fe-corekit';
-import { inject, injectable } from 'inversify';
-import type { AppConfig } from '@/base/cases/AppConfig';
-
-@injectable()
-export class FeApiAdapter extends RequestAdapterFetch {
-  constructor(@inject(IOCIdentifier.AppConfig) appConfig: AppConfig) {
-    super({
-      responseType: 'json',
-      baseURL: appConfig.feApiBaseUrl
-    });
-  }
-}

package/dist/templates/react-app/src/base/apis/feApi/FeApiBootstarp.ts

@@ -1,86 +0,0 @@
-import { I } from '@config/IOCIdentifier';
-import {
-  type BootstrapContext,
-  type BootstrapExecutorPlugin,
-  type ApiMockPluginConfig,
-  ApiPickDataPlugin
-} from '@qlover/corekit-bridge';
-import {
-  RequestPlugin,
-  ResponsePlugin,
-  type RequestAdapterConfig,
-  type RequestAdapterResponse
-} from '@qlover/fe-corekit';
-import type { AppConfig } from '@/base/cases/AppConfig';
-import { RequestLogger } from '@/base/cases/RequestLogger';
-import type { UserService } from '@/base/services/UserService';
-import { FeApi } from './FeApi';
-
-export interface RequestTransactionInterface<Request, Response> {
-  request: Request;
-  response: Response;
-}
-
-/**
- * FeApiConfig
- *
- * @description
- * FeApiConfig is the config for the FeApi.
- *
- * extends:
- */
-export type FeApiConfig<Request = unknown> = RequestAdapterConfig<Request> &
-  ApiMockPluginConfig & {};
-
-/**
- * FeApiResponse
- *
- * @description
- * FeApiResponse is the response for the FeApi.
- *
- * extends:
- * - RequestAdapterResponse<Request, Response>
- */
-export interface FeApiResponse<
-  Request = unknown,
-  Response = unknown
-> extends RequestAdapterResponse<Request, Response> {}
-
-/**
- * FeApi common transaction
- *
- * FIXME: maybe we can add data to RequestTransactionInterface
- *
- * add data property
- */
-export interface FeApiTransaction<
-  Request = unknown,
-  Response = unknown
-> extends RequestTransactionInterface<
-  FeApiConfig<Request>,
-  FeApiResponse<Request, Response>['data']
-> {
-  data: FeApiConfig<Request>['data'];
-}
-
-export class FeApiBootstarp implements BootstrapExecutorPlugin {
-  public readonly pluginName = 'FeApiBootstarp';
-
-  /**
-   * @override
-   */
-  public onBefore({ parameters: { ioc } }: BootstrapContext): void {
-    const appConfig = ioc.get<AppConfig>(I.AppConfig);
-    ioc
-      .get<FeApi>(FeApi)
-      .use(
-        new RequestPlugin({
-          tokenPrefix: appConfig.openAiTokenPrefix,
-          token: () => ioc.get<UserService>(I.UserServiceInterface).getToken()
-        })
-      )
-      .use(ioc.get(ResponsePlugin))
-      .use(ioc.get(RequestLogger))
-      .use(ioc.get(ApiPickDataPlugin));
-  }
-}

package/dist/templates/react-app/src/base/apis/feApi/FeApiType.ts

@@ -1,21 +0,0 @@
-import type { FeApiTransaction } from './FeApiBootstarp';
-
-export type FeApiGetIpInfo = FeApiTransaction<
-  undefined,
-  {
-    status: string;
-    country: string;
-    countryCode: string;
-    region: string;
-    regionName: string;
-    city: string;
-    zip: string;
-    lat: number;
-    lon: number;
-    timezone: string;
-    isp: string;
-    org: string;
-    as: string;
-    query: string;
-  }
->;

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

@@ -1,142 +0,0 @@
-import { RES_NO_TOKEN } from '@config/Identifier';
-import {
-  Aborter,
-  AborterConfig,
-  type AborterInterface,
-  ExecutorContextInterface,
-  ExecutorError,
-  LifecycleExecutor,
-  type RequestAdapterInterface,
-  RequestExecutor
-} from '@qlover/fe-corekit';
-import { inject, injectable } from 'inversify';
-import { UserApiAdapter } from './UserApiAdapter';
-import { UserApiConfig } from './UserApiBootstarp';
-import {
-  GetIpInfoTransaction,
-  UserApiGetUserInfoTransaction,
-  UserApiLoginTransaction,
-  UserApiRegisterTransaction,
-  UserApiTestApiCatchResultTransaction,
-  UserInfo,
-  UserCredential
-} from './UserApiType';
-import type { UserServiceGateway } from '@qlover/corekit-bridge';
-
-/**
- * UserApi
- *
- * @description
- * UserApi is a client for the user API.
- *
- */
-@injectable()
-export class UserApi
-  extends RequestExecutor<
-    UserApiConfig,
-    ExecutorContextInterface<UserApiConfig>
-  >
-  implements UserServiceGateway<UserInfo, UserCredential>
-{
-  constructor(
-    @inject(Aborter) protected abortPlugin: AborterInterface<AborterConfig>,
-    @inject(UserApiAdapter) adapter: RequestAdapterInterface<UserApiConfig>
-  ) {
-    super(
-      adapter,
-      new LifecycleExecutor<ExecutorContextInterface<UserApiConfig, unknown>>()
-    );
-  }
-
-  public stop(request: UserApiConfig): Promise<void> | void {
-    this.abortPlugin.abort(request);
-  }
-
-  public async getRandomUser(): Promise<GetIpInfoTransaction['response']> {
-    return this.request({
-      url: 'https://randomuser.me/api/',
-      method: 'GET',
-      disabledMock: true
-    });
-  }
-
-  public async testApiCatchResult(): Promise<
-    UserApiTestApiCatchResultTransaction['response']
-  > {
-    return this.request({
-      url: 'https://randomuser.me/api/?_name=ApiCatchResult',
-      method: 'GET',
-      disabledMock: true,
-      openApiCatch: true
-    });
-  }
-
-  /**
-   * @override
-   * @param params
-   * @returns
-   */
-  public async login(
-    params: UserApiLoginTransaction['data']
-  ): Promise<UserCredential> {
-    const response = await this.post<
-      UserApiLoginTransaction['response'],
-      UserApiLoginTransaction['data']
-    >('/api/login', params);
-
-    if (response.apiCatchResult) {
-      throw response.apiCatchResult;
-    }
-
-    if (!response.data.token) {
-      throw new ExecutorError(RES_NO_TOKEN);
-    }
-
-    return response.data;
-  }
-
-  /**
-   * @override
-   * @param params
-   * @returns
-   */
-  public register(
-    params: UserApiRegisterTransaction['data']
-  ): Promise<UserApiRegisterTransaction['response']['data']> {
-    // @ts-expect-error - TODO: implement
-    return this.post<UserApiRegisterTransaction>('/api/register', params);
-  }
-
-  /**
-   * @override
-   * @returns
-   */
-  public async refreshUserInfo(): Promise<UserInfo> {
-    return this.getUserInfo();
-  }
-
-  /**
-   * @override
-   * @returns
-   */
-  public logout(): Promise<any> {
-    return this.post('/api/logout');
-  }
-
-  /**
-   * @override
-   * @returns
-   */
-  public async getUserInfo(_credential?: UserCredential): Promise<UserInfo> {
-    const response = await this.get<
-      UserApiGetUserInfoTransaction['response'],
-      UserApiGetUserInfoTransaction['data']
-    >('/api/userinfo');
-
-    if (response.apiCatchResult) {
-      throw response.apiCatchResult;
-    }
-
-    return response.data;
-  }
-}

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

@@ -1,14 +0,0 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
-import { RequestAdapterFetch } from '@qlover/fe-corekit';
-import { inject, injectable } from 'inversify';
-import type { AppConfig } from '@/base/cases/AppConfig';
-
-@injectable()
-export class UserApiAdapter extends RequestAdapterFetch {
-  constructor(@inject(IOCIdentifier.AppConfig) appConfig: AppConfig) {
-    super({
-      responseType: 'json',
-      baseURL: appConfig.feApiBaseUrl
-    });
-  }
-}

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

@@ -1,86 +0,0 @@
-import { IOCIdentifier } from '@config/IOCIdentifier';
-import {
-  type BootstrapContext,
-  type BootstrapExecutorPlugin,
-  type ApiMockPluginOptions,
-  type ApiCatchPluginConfig,
-  type ApiCatchPluginResponse
-} from '@qlover/corekit-bridge';
-import {
-  Aborter,
-  AborterPlugin,
-  RequestPlugin,
-  ResponsePlugin,
-  type AborterConfig,
-  type RequestAdapterConfig,
-  type RequestAdapterResponse
-} from '@qlover/fe-corekit';
-import { RequestLanguages } from '@/base/cases/RequestLanguages';
-import { RequestLogger } from '@/base/cases/RequestLogger';
-import { UserApi } from './UserApi';
-import type { RequestTransactionInterface } from '../feApi/FeApiBootstarp';
-
-/**
- * UserApiConfig
- *
- * @description
- * UserApiConfig is the config for the UserApi.
- *
- * extends:
- * - ApiMockPluginOptions
- * - ApiCatchPluginConfig
- */
-export interface UserApiConfig<Request = unknown>
-  extends
-    RequestAdapterConfig<Request>,
-    ApiMockPluginOptions,
-    ApiCatchPluginConfig,
-    AborterConfig {}
-
-/**
- * UserApiResponse
- *
- * @description
- * UserApiResponse is the response for the UserApi.
- *
- * extends:
- * - RequestAdapterResponse<Request, Response>
- */
-export interface UserApiResponse<Request = unknown, Response = unknown>
-  extends RequestAdapterResponse<Request, Response>, ApiCatchPluginResponse {}
-
-/**
- * UserApi common transaction
- *
- * FIXME: maybe we can add data to RequestTransactionInterface
- *
- * add data property
- */
-export interface UserApiTransaction<
-  Request = unknown,
-  Response = unknown
-> extends RequestTransactionInterface<
-  UserApiConfig<Request>,
-  UserApiResponse<Request, Response>
-> {
-  data: UserApiConfig<Request>['data'];
-}
-
-export class UserApiBootstarp implements BootstrapExecutorPlugin {
-  public readonly pluginName = 'UserApiBootstarp';
-
-  /**
-   * @override
-   */
-  public onBefore({ parameters: { ioc } }: BootstrapContext): void {
-    ioc
-      .get<UserApi>(UserApi)
-      .use(new RequestPlugin())
-      .use(ioc.get(ResponsePlugin))
-      .use(new AborterPlugin(ioc.get(Aborter)))
-      .use(new RequestLanguages(ioc.get(IOCIdentifier.I18nServiceInterface)))
-      .use(ioc.get(IOCIdentifier.ApiMockPlugin))
-      .use(ioc.get(IOCIdentifier.ApiCatchPlugin))
-      .use(ioc.get(RequestLogger));
-  }
-}

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

@@ -1,70 +0,0 @@
-import type { UserApiTransaction } from './UserApiBootstarp';
-import type { LoginParams } from '@qlover/corekit-bridge';
-
-export type UserInfo = {
-  name: string;
-  email: string;
-  picture: string;
-};
-
-export type GetIpInfoTransaction = UserApiTransaction<
-  undefined,
-  {
-    status: string;
-    country: string;
-    countryCode: string;
-    region: string;
-    regionName: string;
-    city: string;
-    zip: string;
-    lat: number;
-    lon: number;
-    timezone: string;
-    isp: string;
-    org: string;
-    as: string;
-    query: string;
-  }
->;
-
-export type UserApiGetRandomUser = UserApiTransaction<
-  undefined,
-  {
-    results: unknown[];
-    info: {
-      seed: string;
-      results: number;
-      page: number;
-      version: string;
-    };
-  }
->;
-
-export type UserApiGetUserInfoTransaction = UserApiTransaction<
-  string,
-  UserInfo
->;
-
-export type UserCredential = {
-  token: string;
-};
-
-export type UserApiLoginTransaction = UserApiTransaction<
-  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<
-  RegisterFormData,
-  UserInfo
->;

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

@@ -1,123 +0,0 @@
-import type { EnvConfigInterface } from '@qlover/corekit-bridge';
-
-/**
- * Application Configuration Management
- *
- * Significance: Centralized configuration management for the application
- * Core idea: Single source of truth for all environment and application settings
- * Main function: Provide typed access to application configuration values
- * Main purpose: Maintain consistent configuration across the application
- *
- * Configuration values are automatically injected from the project's .env files:
- * - .env: Default environment variables
- * - .env.development: Development environment variables
- * - .env.production: Production environment variables
- * - .env.local: Local overrides (git ignored)
- *
- * Environment variables should be prefixed with VITE_ to be exposed to the client side.
- * Example .env file:
- * ```
- * VITE_APP_NAME=MyApp
- * VITE_API_BASE_URL=http://api.example.com
- * VITE_USER_TOKEN_KEY=user_token
- * ```
- *
- * @example
- * const config = new AppConfig();
- * console.log(config.appName); // Value from VITE_APP_NAME
- * console.log(config.aiApiBaseUrl); // Value from VITE_AI_API_BASE_URL
- */
-export class AppConfig implements EnvConfigInterface {
-  constructor(
-    /**
-     * Current environment mode for Vite
-     * @description Represents the running environment (development, production, etc.)
-     * Automatically set based on the current .env file being used
-     *
-     * from vite.config `VITE_USER_NODE_ENV`
-     */
-    readonly env: string = import.meta.env.VITE_USER_NODE_ENV
-  ) {}
-
-  /**
-   * Application name identifier
-   * @description Injected from VITE_APP_NAME environment variable
-   */
-  public readonly appName = '';
-
-  /**
-   * Current version of the application
-   * @description Injected from VITE_APP_VERSION environment variable
-   */
-  public readonly appVersion = '';
-
-  /**
-   * Storage key for user authentication token
-   * @description Injected from VITE_USER_TOKEN_STORAGE_KEY environment variable
-   */
-  public readonly userTokenStorageKey = '__fe_user_token__';
-
-  /**
-   * Storage key for user information
-   * @description Injected from VITE_USER_INFO_STORAGE_KEY environment variable
-   */
-  public readonly userInfoStorageKey = '__fe_user_info__';
-
-  /**
-   * Available OpenAI model configurations
-   * @description List of supported OpenAI models for the application
-   */
-  public readonly openAiModels = [
-    'gpt-4o-mini',
-    'gpt-3.5-turbo',
-    'gpt-3.5-turbo-2',
-    'gpt-4',
-    'gpt-4-32k'
-  ];
-
-  /** Base URL for OpenAI API endpoints */
-  public readonly openAiBaseUrl = '';
-
-  /** Authentication token for OpenAI API */
-  public readonly openAiToken = '';
-
-  /** Prefix for OpenAI authentication token */
-  public readonly openAiTokenPrefix = '';
-
-  /** Flag indicating if OpenAI token is required */
-  public readonly openAiRequireToken = true;
-
-  /** Default login username */
-  public readonly loginUser = '';
-
-  /** Default login password */
-  public readonly loginPassword = '';
-
-  /** Base URL for frontend API endpoints */
-  public readonly feApiBaseUrl = '';
-
-  /** Base URL for user-related API endpoints */
-  public readonly userApiBaseUrl = '';
-
-  /** Base URL for AI service API endpoints */
-  public readonly aiApiBaseUrl = 'https://api.openai.com/v1';
-
-  /** Authentication token for AI service API */
-  public readonly aiApiToken = '';
-
-  /** Prefix for AI service authentication token */
-  public readonly aiApiTokenPrefix = 'Bearer';
-
-  /** Flag indicating if AI service token is required */
-  public readonly aiApiRequireToken = true;
-
-  /**
-   * Project startup href, usually from window.location.href
-   */
-  public readonly bootHref = '';
-
-  /** Flag indicating if the current environment is production */
-  public get isProduction(): boolean {
-    return this.env === 'production';
-  }
-}

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

@@ -1,115 +0,0 @@
-import type {
-  AntdStaticApiInterface,
-  MessageApi,
-  ModalApi,
-  NotificationApi
-} from '@brain-toolkit/antd-theme-override/react';
-import type {
-  UIDialogInterface,
-  NotificationOptions
-} from '@qlover/corekit-bridge';
-import type { ModalFuncProps } from 'antd';
-
-export interface DialogHandlerOptions
-  extends NotificationOptions, ModalFuncProps {
-  content: string;
-}
-
-/**
- * Dialog Handler Implementation
- *
- * Implements the InteractionHubInterface using Ant Design components.
- * Provides concrete implementations for displaying notifications and confirmation dialogs.
- *
- * Features:
- * - Uses Ant Design's message component for notifications
- * - Uses Ant Design's Modal component for confirmations
- * - Supports customizable display durations
- * - Handles error objects appropriately
- *
- * @example
- * const dialog = new DialogHandler();
- * dialog.success('Data saved successfully');
- * dialog.confirm({
- *   title: 'Confirm Delete',
- *   content: 'Are you sure you want to delete this item?',
- *   onOk: () => handleDelete(),
- * });
- */
-export class DialogHandler
-  implements UIDialogInterface<DialogHandlerOptions>, AntdStaticApiInterface
-{
-  protected antds: {
-    message?: MessageApi;
-    modal?: ModalApi;
-    notification?: NotificationApi;
-  } = {};
-
-  /**
-   * @override
-   */
-  public setMessage(message: MessageApi): void {
-    this.antds.message = message;
-  }
-
-  /**
-   * @override
-   */
-  public setModal(modal: ModalApi): void {
-    this.antds.modal = modal;
-  }
-
-  /**
-   * @override
-   */
-  public setNotification(notification: NotificationApi): void {
-    this.antds.notification = notification;
-  }
-
-  /**
-   * Formats error message from various error types
-   */
-  protected formatErrorMessage(error: unknown): string {
-    if (error instanceof Error) return error.message;
-    if (typeof error === 'string') return error;
-    return 'An unknown error occurred';
-  }
-
-  /**
-   * @override
-   */
-  public success(msg: string, options?: NotificationOptions): void {
-    this.antds.message?.success({ content: msg, ...options });
-  }
-
-  /**
-   * @override
-   */
-  public error(msg: string, options?: NotificationOptions): void {
-    this.antds.message?.error({
-      content: options?.error ? this.formatErrorMessage(options.error) : msg,
-      ...options
-    });
-  }
-
-  /**
-   * @override
-   */
-  public info(msg: string, options?: NotificationOptions): void {
-    this.antds.message?.info({ content: msg, ...options });
-  }
-
-  /**
-   * @override
-   */
-  public warn(msg: string, options?: NotificationOptions): void {
-    this.antds.message?.warning({ content: msg, ...options });
-  }
-
-  /**
-   * @override
-   */
-  public confirm(options: DialogHandlerOptions): void {
-    this.antds.modal?.confirm(options);
-  }
-}