@qlover/create-app 0.7.5 → 0.7.7

package/dist/templates/next-app/src/app/[locale]/page.tsx

@@ -0,0 +1,106 @@
+import Image from 'next/image';
+
+export default async function Home() {
+  return (
+    <div
+      data-testid="Home"
+      className="font-sans grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20"
+    >
+      <main className="flex flex-col gap-[32px] row-start-2 items-center sm:items-start">
+        <Image
+          className="dark:invert"
+          src="/next.svg"
+          alt="Next.js logo"
+          width={180}
+          height={38}
+          priority
+        />
+        <ol className="font-mono list-inside list-decimal text-sm/6 text-center sm:text-left">
+          <li className="mb-2 tracking-[-.01em]">
+            Get started by editing{' '}
+            <code className="bg-black/[.05] dark:bg-white/[.06] font-mono font-semibold px-1 py-0.5 rounded">
+              src/app/page.tsx
+            </code>
+            .
+          </li>
+          <li className="tracking-[-.01em]">
+            Save and see your changes instantly.
+          </li>
+        </ol>
+
+        <div className="flex gap-4 items-center flex-col sm:flex-row">
+          <a
+            className="rounded-full border border-solid border-transparent transition-colors flex items-center justify-center bg-foreground text-background gap-2 hover:bg-[#383838] dark:hover:bg-[#ccc] font-medium text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5 sm:w-auto"
+            href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
+            target="_blank"
+            rel="noopener noreferrer"
+          >
+            <Image
+              className="dark:invert"
+              src="/vercel.svg"
+              alt="Vercel logomark"
+              width={20}
+              height={20}
+            />
+            Deploy now
+          </a>
+          <a
+            className="rounded-full border border-solid border-black/[.08] dark:border-white/[.145] transition-colors flex items-center justify-center hover:bg-[#f2f2f2] dark:hover:bg-[#1a1a1a] hover:border-transparent font-medium text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5 w-full sm:w-auto md:w-[158px]"
+            href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
+            target="_blank"
+            rel="noopener noreferrer"
+          >
+            Read our docs
+          </a>
+        </div>
+      </main>
+      <footer className="row-start-3 flex gap-[24px] flex-wrap items-center justify-center">
+        <a
+          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
+          href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <Image
+            aria-hidden
+            src="/file.svg"
+            alt="File icon"
+            width={16}
+            height={16}
+          />
+          Learn
+        </a>
+        <a
+          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
+          href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <Image
+            aria-hidden
+            src="/window.svg"
+            alt="Window icon"
+            width={16}
+            height={16}
+          />
+          Examples
+        </a>
+        <a
+          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
+          href="https://nextjs.org?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <Image
+            aria-hidden
+            src="/globe.svg"
+            alt="Globe icon"
+            width={16}
+            height={16}
+          />
+          Go to nextjs.org →
+        </a>
+      </footer>
+    </div>
+  );
+}

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

@@ -0,0 +1,15 @@
+import { name, version } from '../../../package.json';
+import type { EnvConfigInterface } from '@qlover/corekit-bridge';
+
+export class AppConfig implements EnvConfigInterface {
+  /**
+   * Current environment mode for Vite
+   * @description Represents the running environment (development, production, etc.)
+   * Automatically set based on the current .env file being used
+   */
+  readonly env: string = process.env.APP_ENV!;
+  readonly appName: string = name;
+  readonly appVersion: string = version;
+
+  readonly userTokenKey: string = '_user_token';
+}

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

@@ -0,0 +1,33 @@
+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'
+    });
+  }
+
+  bind<T>(key: ServiceIdentifier<T>, value: T): void {
+    this.container.bind<T>(key).toConstantValue(value);
+  }
+
+  get<K extends keyof IOCIdentifierMap>(
+    serviceIdentifier: K
+  ): IOCIdentifierMap[K];
+  get<T>(serviceIdentifier: ServiceIdentifier<T>): T;
+  get<T, K extends keyof IOCIdentifierMap>(
+    serviceIdentifier: ServiceIdentifier<T> | K
+  ): T | IOCIdentifierMap[K] {
+    return this.container.get<T>(serviceIdentifier);
+  }
+}

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

@@ -0,0 +1,25 @@
+import {
+  StoreInterface,
+  type StoreStateInterface
+} from '@qlover/corekit-bridge';
+import type { i18nConfig } from '@config/i18n';
+
+export type SupportedLocale = (typeof i18nConfig.supportedLngs)[number];
+export type SupportedNamespace = typeof i18nConfig.fallbackLng;
+export type I18nServiceLocale = SupportedLocale;
+
+export class I18nServiceState implements StoreStateInterface {
+  loading: boolean = false;
+  constructor(public language: I18nServiceLocale) {}
+}
+export abstract class I18nServiceInterface
+  extends StoreInterface<I18nServiceState>
+  implements I18nServiceInterface
+{
+  abstract t(key: string, params?: Record<string, unknown>): Promise<string>;
+  abstract changeLanguage(language: I18nServiceLocale): Promise<void>;
+  abstract changeLoading(loading: boolean): void;
+  abstract getCurrentLanguage(): Promise<I18nServiceLocale>;
+  abstract isValidLanguage(language: string): language is I18nServiceLocale;
+  abstract getSupportedLanguages(): I18nServiceLocale[];
+}

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

@@ -0,0 +1,11 @@
+import { ImagicaAuthService } from '@brain-toolkit/bridge';
+import type { ExecutorPlugin } from '@qlover/fe-corekit';
+
+export abstract class UserServiceInterface
+  extends ImagicaAuthService
+  implements ExecutorPlugin
+{
+  readonly pluginName = 'UserService';
+
+  abstract getToken(): string | null;
+}

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

@@ -0,0 +1,115 @@
+import { useLocaleRoutes } from '@config/common';
+import { i18nConfig } from '@config/i18n';
+import {
+  I18nServiceInterface,
+  I18nServiceState
+} from '../port/I18nServiceInterface';
+import type { I18nServiceLocale } from '../port/I18nServiceInterface';
+import type { useTranslations } from 'next-intl';
+
+type TranslationFunction = ReturnType<typeof useTranslations>;
+
+export class I18nService extends I18nServiceInterface {
+  readonly pluginName = 'I18nService';
+  private initialized: boolean = false;
+  private pathname: string = '';
+  private translator: TranslationFunction | null = null;
+
+  constructor() {
+    super(() => new I18nServiceState(i18nConfig.fallbackLng));
+  }
+
+  private async ensureInitialized(): Promise<void> {
+    if (!this.initialized) {
+      throw new Error('I18nService not initialized');
+    }
+  }
+
+  setPathname(pathname: string): void {
+    this.pathname = pathname;
+  }
+
+  setTranslator(translator: TranslationFunction): void {
+    this.translator = translator;
+  }
+
+  /**
+   * @override
+   */
+  async onBefore(): Promise<void> {
+    if (this.initialized) {
+      return;
+    }
+
+    this.initialized = true;
+
+    // 初始化语言状态
+    const currentLang = this.getCurrentLanguageFromPath();
+    if (this.isValidLanguage(currentLang)) {
+      this.emit({ ...this.state, language: currentLang });
+    }
+  }
+
+  private getCurrentLanguageFromPath(): string {
+    const paths = this.pathname.split('/');
+
+    for (const path of paths) {
+      if (this.isValidLanguage(path)) {
+        return path;
+      }
+    }
+
+    return i18nConfig.fallbackLng;
+  }
+
+  override async changeLanguage(language: I18nServiceLocale): Promise<void> {
+    try {
+      this.changeLoading(true);
+      await this.ensureInitialized();
+
+      // 在这里我们只需要更新状态，因为实际的语言切换会通过路由处理
+      this.emit({ ...this.state, language });
+
+      // 如果不使用本地化路由，则保存语言设置到本地存储
+      if (!useLocaleRoutes && typeof window !== 'undefined') {
+        window.localStorage.setItem('i18nextLng', language);
+      }
+    } finally {
+      this.changeLoading(false);
+    }
+  }
+
+  override changeLoading(loading: boolean): void {
+    this.emit({ ...this.state, loading });
+  }
+
+  override async getCurrentLanguage(): Promise<I18nServiceLocale> {
+    await this.ensureInitialized();
+    return this.getCurrentLanguageFromPath() as I18nServiceLocale;
+  }
+
+  override isValidLanguage(language: string): language is I18nServiceLocale {
+    return i18nConfig.supportedLngs.includes(language as I18nServiceLocale);
+  }
+
+  override getSupportedLanguages(): I18nServiceLocale[] {
+    return [...i18nConfig.supportedLngs];
+  }
+
+  override async t(
+    key: string,
+    params?: Record<string, string | number | Date>
+  ): Promise<string> {
+    await this.ensureInitialized();
+
+    if (!this.translator) {
+      return key;
+    }
+
+    try {
+      return this.translator(key, params);
+    } catch {
+      return key;
+    }
+  }
+}

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

@@ -0,0 +1,23 @@
+import { CookieStorage } from '@qlover/corekit-bridge';
+import { injectable, inject } from 'inversify';
+import { AppConfig } from '../cases/AppConfig';
+import { UserServiceInterface } from '../port/UserServiceInterface';
+
+@injectable()
+export class UserService extends UserServiceInterface {
+  constructor(@inject(AppConfig) protected appConfig: AppConfig) {
+    super({
+      credentialStorage: {
+        key: appConfig.userTokenKey,
+        storage: new CookieStorage()
+      },
+      requestConfig: {
+        env: appConfig.env !== 'production' ? 'development' : 'production'
+      }
+    });
+  }
+
+  getToken(): string | null {
+    return this.store.getCredential();
+  }
+}

package/dist/templates/next-app/src/core/IOC.ts

@@ -0,0 +1,58 @@
+// ! dont't import tsx, only ts file
+import type { InversifyContainer } from '@/base/cases/InversifyContainer';
+import { BootstrapClient } from './bootstraps/BootstrapClient';
+import type { IOCRegisterInterface } from '@qlover/corekit-bridge';
+
+/**
+ * IOC register options
+ */
+export type IocRegisterOptions = {
+  /**
+   * The app config
+   */
+  appConfig: Record<string, unknown>;
+};
+
+/**
+ * IOC container
+ *
+ * This is a alias of IOCContainerInterface, use it without care about the implementation.
+ *
+ * Need to achieve the effect: when the implementation class on the right side of the equal sign changes, the IOCContainer will change automatically
+ */
+export type IOCContainer = InversifyContainer;
+
+/**
+ * IOC register interface.
+ *
+ * This is shortcut interface, implement this interface, you can use any IOC container.
+ *
+ * Need to achieve the effect: when the implementation class on the right side of the equal sign changes, the IOCContainer will change automatically
+ */
+export type IOCRegister = IOCRegisterInterface<
+  IOCContainer,
+  IocRegisterOptions
+>;
+
+/**
+ * IOC function
+ *
+ * This is the only and main exported content of the file
+ *
+ * @example use A class
+ * ```ts
+ * const userService = IOC(UserService);
+ * ```
+ *
+ * @example use A string identifier
+ *
+ * string identifier is shortcut for `IOCIdentifierMap` type, string key of `IOCIdentifier`
+ *
+ * ```ts
+ * const logger = IOC('Logger'); // Logger instance
+ *
+ * // or
+ * const logger = IOC(IOCIdentifier.Logger);
+ * ```
+ */
+export const IOC = BootstrapClient.createSingletonIOC();

package/dist/templates/next-app/src/core/IocRegisterImpl.ts

@@ -0,0 +1,100 @@
+import { IOCIdentifier as I } from '@config/IOCIdentifier';
+import { I18nService } from '@/base/services/I18nService';
+import { logger, JSON } from './globals';
+import type { IOCContainer, IOCRegister, IocRegisterOptions } from './IOC';
+import type { IOCManagerInterface } from '@qlover/corekit-bridge';
+
+export class IocRegisterImpl implements IOCRegister {
+  constructor(protected options: IocRegisterOptions) {}
+
+  /**
+   * Register globals
+   *
+   * 一般用于注册全局
+   *
+   * @param ioc - IOC container
+   */
+  protected registerGlobals(ioc: IOCContainer): void {
+    const { appConfig } = this.options;
+    ioc.bind(I.JSONSerializer, JSON);
+    ioc.bind(I.Logger, logger);
+    ioc.bind(I.AppConfig, appConfig);
+    // ioc.bind(I.EnvConfigInterface, appConfig);
+    // ioc.bind(I.DialogHandler, dialogHandler);
+    // ioc.bind(I.UIDialogInterface, dialogHandler);
+    // ioc.bind(I.AntdStaticApiInterface, dialogHandler);
+    // ioc.bind(I.LocalStorage, globals.localStorage);
+    // ioc.bind(I.LocalStorageEncrypt, localStorageEncrypt);
+    // ioc.bind(I.CookieStorage, globals.cookieStorage);
+  }
+
+  /**
+   * 一般用于注册没有其他复杂依赖的项目实现类
+   *
+   * 比如:
+   * - 路由服务
+   * - 国际化服务
+   * - 主题服务
+   *
+   * @param ioc
+   */
+  protected registerImplement(ioc: IOCContainer): void {
+    ioc.bind(I.I18nServiceInterface, new I18nService());
+    // ioc.bind(
+    //   I.RouteServiceInterface,
+    //   new RouteService(
+    //     ioc.get(NavigateBridge),
+    //     ioc.get(I.I18nServiceInterface),
+    //     {
+    //       routes: useLocaleRoutes ? baseRoutes : baseNoLocaleRoutes,
+    //       logger: ioc.get(I.Logger),
+    //       hasLocalRoutes: useLocaleRoutes
+    //     }
+    //   )
+    // );
+    // ioc.bind(
+    //   I.ThemeService,
+    //   new ThemeService({
+    //     ...themeConfig,
+    //     storage: ioc.get<SyncStorageInterface<string, string>>(I.LocalStorage)
+    //   })
+    // );
+    // ioc.bind(I.I18nKeyErrorPlugin, ioc.get(I18nKeyErrorPlugin));
+    // ioc.bind(I.ProcesserExecutorInterface, ioc.get(ProcesserExecutor));
+    // ioc.bind(I.UserServiceInterface, ioc.get(UserService));
+    // ioc.bind(I.RequestCatcherInterface, ioc.get(RequestStatusCatcher));
+    // ioc.bind(I.ExecutorPageBridgeInterface, ioc.get(ExecutorPageBridge));
+    // ioc.bind(I.JSONStoragePageInterface, ioc.get(JSONStoragePageBridge));
+    // ioc.bind(I.RequestPageBridgeInterface, ioc.get(RequestPageBridge));
+  }
+
+  protected registerCommon(_ioc: IOCContainer): void {
+    // const { appConfig } = this.options;
+    // const logger = ioc.get(I.Logger);
+    // const feApiRequestCommonPlugin = new RequestCommonPlugin({
+    //   tokenPrefix: appConfig.openAiTokenPrefix,
+    //   requiredToken: true,
+    //   token: () => ioc.get(UserService).getToken()
+    // });
+    // const apiMockPlugin = new ApiMockPlugin(mockDataJson, logger);
+    // const apiCatchPlugin = new ApiCatchPlugin(
+    //   logger,
+    //   ioc.get(RequestStatusCatcher)
+    // );
+    // ioc.bind(I.FeApiCommonPlugin, feApiRequestCommonPlugin);
+    // ioc.bind(I.ApiMockPlugin, apiMockPlugin);
+    // ioc.bind(I.ApiCatchPlugin, apiCatchPlugin);
+  }
+
+  /**
+   * @override
+   */
+  register(
+    ioc: IOCContainer,
+    _manager: IOCManagerInterface<IOCContainer>
+  ): void {
+    this.registerGlobals(ioc);
+    this.registerCommon(ioc);
+    this.registerImplement(ioc);
+  }
+}

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

@@ -0,0 +1,98 @@
+import { Bootstrap, createIOCFunction } from '@qlover/corekit-bridge';
+import { isObject } from 'lodash';
+import { browserGlobalsName } from '@config/common';
+import { InversifyContainer } from '@/base/cases/InversifyContainer';
+import { BootstrapsRegistry } from './BootstrapsRegistry';
+import * as globals from '../globals';
+import { appConfig } from '../globals';
+import { IocRegisterImpl } from '../IocRegisterImpl';
+import type { IOCContainer } from '../IOC';
+import type { IOCIdentifierMap } from '@config/IOCIdentifier';
+import type {
+  EnvConfigInterface,
+  IOCContainerInterface,
+  IOCFunctionInterface,
+  IOCManagerInterface
+} from '@qlover/corekit-bridge';
+
+export type BootstrapAppArgs = {
+  /**
+   * 启动的根节点，通常是window
+   */
+  root: unknown;
+  /**
+   * 当前路径
+   */
+  pathname: string;
+  /**
+   * IOC容器
+   */
+  IOC: IOCFunctionInterface<IOCIdentifierMap, IOCContainerInterface>;
+};
+
+export class BootstrapClient {
+  private static _ioc: IOCFunctionInterface<
+    IOCIdentifierMap,
+    IOCContainerInterface
+  > | null = null;
+
+  static createSingletonIOC(): IOCFunctionInterface<
+    IOCIdentifierMap,
+    IOCContainerInterface
+  > {
+    if (BootstrapClient._ioc) {
+      return BootstrapClient._ioc;
+    }
+
+    BootstrapClient._ioc = createIOCFunction<IOCIdentifierMap>(
+      /**
+       * If not inversify, you can use any IOC container,
+       * then replace the InversifyContainer with your own IOC container
+       */
+      new InversifyContainer()
+    );
+
+    new IocRegisterImpl({
+      appConfig: appConfig as EnvConfigInterface
+    }).register(
+      BootstrapClient._ioc.implemention as IOCContainer,
+      BootstrapClient._ioc as IOCManagerInterface<IOCContainer>
+    );
+
+    return BootstrapClient._ioc;
+  }
+
+  static async main(args: BootstrapAppArgs): Promise<BootstrapAppArgs> {
+    const { root, IOC } = args;
+
+    if (!isObject(root)) {
+      throw new Error('root is not an object');
+    }
+
+    const { logger, appConfig } = globals;
+
+    const bootstrap = new Bootstrap({
+      root,
+      logger,
+      ioc: {
+        manager: IOC
+      },
+      globalOptions: {
+        sources: globals,
+        target: browserGlobalsName
+      }
+    });
+
+    try {
+      await bootstrap.initialize();
+
+      const bootstrapsRegistry = new BootstrapsRegistry(args);
+
+      await bootstrap.use(bootstrapsRegistry.register()).start();
+    } catch (error) {
+      logger.error(`${appConfig.appName} starup error:`, error);
+    }
+
+    return args;
+  }
+}

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

@@ -0,0 +1,47 @@
+import { IOCIdentifier } from '@config/IOCIdentifier';
+import { IocIdentifierTest } from './IocIdentifierTest';
+import { printBootstrap } from './PrintBootstrap';
+import type { BootstrapAppArgs } from './BootstrapClient';
+import type { IOCIdentifierMap } from '@config/IOCIdentifier';
+import type {
+  BootstrapExecutorPlugin,
+  EnvConfigInterface,
+  IOCContainerInterface,
+  IOCFunctionInterface
+} from '@qlover/corekit-bridge';
+
+export class BootstrapsRegistry {
+  constructor(protected args: BootstrapAppArgs) {}
+
+  get IOC(): IOCFunctionInterface<IOCIdentifierMap, IOCContainerInterface> {
+    return this.args.IOC;
+  }
+
+  get appConfig(): EnvConfigInterface {
+    return this.IOC(IOCIdentifier.AppConfig);
+  }
+
+  register(): BootstrapExecutorPlugin[] {
+    const IOC = this.IOC;
+
+    const i18nService = IOC(IOCIdentifier.I18nServiceInterface);
+    i18nService.setPathname(this.args.pathname);
+
+    const bootstrapList: BootstrapExecutorPlugin[] = [
+      i18nService
+      // new UserApiBootstarp(),
+      // new FeApiBootstarp(),
+      // AiApiBootstarp,
+      // IOC(IOCIdentifier.I18nKeyErrorPlugin)
+    ];
+
+    if (!this.appConfig.isProduction) {
+      bootstrapList.push(printBootstrap);
+    }
+
+    bootstrapList.push(IocIdentifierTest);
+    // TODO: 需要使用到
+
+    return bootstrapList;
+  }
+}

package/dist/templates/next-app/src/core/bootstraps/IocIdentifierTest.ts

@@ -0,0 +1,26 @@
+import { IOCIdentifier } from '@config/IOCIdentifier';
+import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
+
+export const IocIdentifierTest: BootstrapExecutorPlugin = {
+  pluginName: 'IocIdentifierTest',
+  onSuccess({ parameters: { logger, ioc } }) {
+    const errorList: string[] = [];
+    const keyList: string[] = Object.keys(IOCIdentifier);
+    keyList.forEach((key) => {
+      try {
+        const value = ioc.get(key);
+        if (value === undefined) {
+          errorList.push(key);
+        }
+      } catch {
+        errorList.push(key);
+      }
+    });
+
+    if (errorList.length > 0) {
+      logger.warn(`IOC ${errorList.join(', ')} is not found`);
+    } else {
+      logger.info(`IOC all identifiers are found ${keyList.length}`);
+    }
+  }
+};

package/dist/templates/next-app/src/core/bootstraps/PrintBootstrap.ts

@@ -0,0 +1,18 @@
+import { browserGlobalsName } from '@config/common';
+import { AppConfig } from '@/base/cases/AppConfig';
+import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
+
+export const printBootstrap: BootstrapExecutorPlugin = {
+  pluginName: 'PrintBootstrap',
+  onSuccess({ parameters: { logger, ioc } }) {
+    const appConfig = ioc.get<AppConfig>(AppConfig);
+    logger.info(
+      'bootstrap in(' +
+        appConfig.env +
+        ')success!\n\n' +
+        `You can use \`%cwindow.${browserGlobalsName}%c\` to access the globals`,
+      'color: #0ff; font-weight: bold;',
+      'all: unset;'
+    );
+  }
+};