npm - @qlover/create-app - Versions diffs - 0.10.1 → 0.10.2 - Mend

@qlover/create-app 0.10.1 → 0.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (108) hide show

package/dist/templates/next-app/src/pages/[locale]/about.tsx ADDED Viewed

@@ -0,0 +1,61 @@
+import { useMemo } from 'react';
+import { PagesRouteParams } from '@/server/PagesRouteParams';
+import type { PagesRouteParamsType } from '@/server/PagesRouteParams';
+import { ClientSeo } from '@/uikit/components/ClientSeo';
+import { PagesRoutePage } from '@/uikit/components-pages/PagesRoutePage';
+import { useI18nInterface } from '@/uikit/hook/useI18nInterface';
+import { aboutI18n, i18nConfig } from '@config/i18n';
+import { COMMON_ADMIN_TITLE } from '@config/Identifier';
+import type { GetStaticPropsContext } from 'next';
+interface AboutProps {
+  messages: Record<string, string>;
+}
+const namespace = 'page_about';
+export default function About({}: AboutProps) {
+  const i18nInterface = useMemo(() => {
+    return {
+      ...aboutI18n,
+      adminTitle: COMMON_ADMIN_TITLE
+    };
+  }, []);
+  const seoMetadata = useI18nInterface(i18nInterface);
+  return (
+    <PagesRoutePage
+      data-testid="AboutPage"
+      tt={{ title: seoMetadata.title, adminTitle: seoMetadata.adminTitle }}
+      showAdminButton={false}
+    >
+      <ClientSeo i18nInterface={seoMetadata} />
+      <div data-testid="About" className="bg-primary h-screen">
+        {seoMetadata.title}
+      </div>
+    </PagesRoutePage>
+  );
+}
+export async function getStaticProps({
+  params
+}: GetStaticPropsContext<PagesRouteParamsType>) {
+  const pageParams = new PagesRouteParams(params);
+  const messages = await pageParams.getI18nMessages(namespace);
+  return {
+    props: {
+      messages
+    }
+  };
+}
+export async function getStaticPaths() {
+  return {
+    paths: i18nConfig.supportedLngs.map((locale) => ({
+      params: { locale }
+    })),
+    fallback: false
+  };
+}

package/dist/templates/next-app/src/pages/_app.tsx ADDED Viewed

@@ -0,0 +1,50 @@
+import dynamic from 'next/dynamic';
+import { withRouter } from 'next/router';
+import { NextIntlClientProvider } from 'next-intl';
+import '@/styles/css/index.css';
+import type { PagesRouterProps } from '@/base/types/PagesRouter';
+import { BootstrapsProvider } from '@/uikit/components/BootstrapsProvider';
+import { IOCProvider } from '@/uikit/components/IOCProvider';
+import { i18nConfig } from '@config/i18n';
+import { themeConfig } from '@config/theme';
+/**
+ * 动态导入 ClientRootProvider，禁用 SSR，确保只在客户端渲染
+ *
+ * 为什么需要禁用 SSR？
+ * 1. ClientRootProvider 内部使用了 AntdRegistry（来自 @ant-design/nextjs-registry），
+ *    该组件主要针对 App Router 设计，在 Pages Router 的 SSR 环境中可能存在兼容性问题
+ * 2. ClientRootProvider 使用了 useIOC() hook，该 hook 在服务端渲染时可能无法正常工作
+ * 3. ThemeProvider 和 AntdThemeProvider 可能依赖浏览器 API（如 localStorage、window 等），
+ *    在服务端渲染时会导致错误或页面一直处于加载状态
+ *
+ * 通过在 Pages Router 中使用 dynamic import 并设置 ssr: false，
+ * 可以确保 ClientRootProvider 只在客户端渲染，避免 SSR 相关的问题
+ */
+const ClientRootProvider = dynamic(
+  () =>
+    import('@/uikit/components/ClientRootProvider').then(
+      (mod) => mod.ClientRootProvider
+    ),
+  {
+    ssr: false
+  }
+);
+function App({ Component, pageProps, router }: PagesRouterProps) {
+  const locale = (router.query.locale as string) || i18nConfig.fallbackLng;
+  return (
+    <IOCProvider data-testid="IOCProvider">
+      <NextIntlClientProvider locale={locale} messages={pageProps.messages}>
+        <BootstrapsProvider>
+          <ClientRootProvider themeConfig={themeConfig}>
+            <Component {...pageProps} />
+          </ClientRootProvider>
+        </BootstrapsProvider>
+      </NextIntlClientProvider>
+    </IOCProvider>
+  );
+}
+export default withRouter(App);

package/dist/templates/next-app/src/pages/_document.tsx ADDED Viewed

@@ -0,0 +1,13 @@
+import { Html, Head, Main, NextScript } from 'next/document';
+export default function Document() {
+  return (
+    <Html data-testid="PagesRootLayout">
+      <Head />
+      <body>
+        <Main />
+        <NextScript />
+      </body>
+    </Html>
+  );
+}

package/dist/templates/next-app/src/{middleware.ts → proxy.ts} RENAMED Viewed

@@ -20,6 +20,7 @@ export const config = {
     // - Next.js internals (_next/*)
     // - Static files (*.svg, *.png, *.jpg, *.jpeg, *.gif, *.ico)
     // - Other static assets and special files
-    '/((?!api|_next|.*\\.(?:svg|png|jpg|jpeg|gif|ico)|favicon.ico|sitemap.xml|sitemap-0.xml).*)'
+    // - Manifest file (manifest.webmanifest)
+    '/((?!api|_next|.*\\.(?:svg|png|jpg|jpeg|gif|ico)|favicon.ico|sitemap.xml|sitemap-0.xml|manifest.webmanifest).*)'
   ]
 };

package/dist/templates/next-app/src/server/AppPageRouteParams.ts ADDED Viewed

@@ -0,0 +1,94 @@
+import { cookies } from 'next/headers';
+import { notFound } from 'next/navigation';
+import { getMessages, getTranslations } from 'next-intl/server';
+import { TranslateI18nInterface } from '@/base/cases/TranslateI18nInterface';
+import { filterMessagesByNamespace } from '@/i18n/loadMessages';
+import { i18nConfig } from '@config/i18n';
+import type { LocaleType, PageI18nInterface } from '@config/i18n';
+import { themeConfig } from '@config/theme';
+import type { RouteParamsnHandlerInterface } from './port/RouteParamsnHandlerInterface';
+export interface PageWithParams {
+  params?: Promise<PageParamsType>;
+}
+export interface PageParamsType {
+  locale?: string;
+}
+/**
+ * 用于 src/app/page 路由的参数管理工具
+ */
+export class AppPageRouteParams<
+  T extends PageParamsType
+> implements RouteParamsnHandlerInterface {
+  private locale: string | null;
+  constructor(protected readonly params: T) {
+    this.locale = this.params.locale || i18nConfig.fallbackLng;
+  }
+  public getLocale(defaultLocale?: string): string {
+    if (this.locale) {
+      return this.locale;
+    }
+    this.locale = this.params.locale || defaultLocale || i18nConfig.fallbackLng;
+    return this.locale;
+  }
+  public getI18nWithNotFound(): string {
+    const locale = this.getLocale();
+    if (!i18nConfig.supportedLngs.includes(locale as LocaleType)) {
+      notFound();
+    }
+    return locale;
+  }
+  /**
+   * 获取 i18n 消息
+   * 使用 next-intl 的 getMessages 加载消息
+   *
+   * @param namespace - 可选的命名空间（单个字符串或字符串数组），会与默认命名空间 ['common', 'api'] 合并
+   * @returns Promise<Record<string, string>> 返回翻译消息对象
+   */
+  public async getI18nMessages(
+    namespace?: string | string[]
+  ): Promise<Record<string, string>> {
+    const locale = this.getLocale();
+    const messages = await getMessages({ locale });
+    // 将默认命名空间和用户提供的命名空间合并
+    const defaultNamespaces = [...i18nConfig.defaultNamespaces];
+    const userNamespaces = namespace
+      ? Array.isArray(namespace)
+        ? namespace
+        : [namespace]
+      : [];
+    // 合并并去重
+    const namespaces = [...new Set([...defaultNamespaces, ...userNamespaces])];
+    return filterMessagesByNamespace(messages, namespaces);
+  }
+  public async getI18nInterface<T extends PageI18nInterface>(
+    i18nInterface: T,
+    _namespace?: string
+  ): Promise<T> {
+    const t = await getTranslations({
+      locale: this.getLocale()
+      // namespace: namespace
+    });
+    return TranslateI18nInterface.translate<T>(i18nInterface, t);
+  }
+  public async getTheme(): Promise<string> {
+    const cookieStore = await cookies();
+    return (
+      cookieStore.get(themeConfig.storageKey)?.value ||
+      themeConfig.supportedThemes[0]
+    );
+  }
+}

package/dist/templates/next-app/src/server/NextApiServer.ts ADDED Viewed

@@ -0,0 +1,53 @@
+import { ExecutorError } from '@qlover/fe-corekit';
+import { NextResponse } from 'next/server';
+import {
+  isAppApiErrorInterface,
+  isAppApiSuccessInterface,
+  type AppApiResult
+} from '@/base/port/AppApiInterface';
+import type { BootstrapServerContextValue } from '@/core/bootstraps/BootstrapServer';
+import { BootstrapServer } from '@/core/bootstraps/BootstrapServer';
+import { AppErrorApi } from './AppErrorApi';
+import { AppSuccessApi } from './AppSuccessApi';
+import type { PromiseTask } from '@qlover/fe-corekit';
+export class NextApiServer extends BootstrapServer {
+  protected isAppApiResult(result: unknown): result is AppApiResult {
+    return isAppApiSuccessInterface(result) || isAppApiErrorInterface(result);
+  }
+  async run<Result>(
+    task?: PromiseTask<Result | AppApiResult, BootstrapServerContextValue>
+  ): Promise<AppApiResult> {
+    const result = await this.execNoError(task);
+    // Is result is AppApiResult, return it directly
+    if (this.isAppApiResult(result)) {
+      return result;
+    }
+    // If result is ExecutorError, return AppErrorApi
+    if (result instanceof ExecutorError) {
+      return new AppErrorApi(result.id, result.message);
+    }
+    // If result is Error, return AppErrorApi
+    if (result instanceof Error) {
+      return new AppErrorApi('SERVER_ERROR', result.message);
+    }
+    return new AppSuccessApi(result);
+  }
+  async runWithJson<Result>(
+    task?: PromiseTask<Result | AppApiResult, BootstrapServerContextValue>
+  ): Promise<NextResponse> {
+    const result = await this.run(task);
+    if (!result.success) {
+      return NextResponse.json(result, { status: 400 });
+    }
+    return NextResponse.json(result);
+  }
+}

package/dist/templates/next-app/src/server/PagesRouteParams.ts ADDED Viewed

@@ -0,0 +1,136 @@
+import { TranslateI18nInterface } from '@/base/cases/TranslateI18nInterface';
+import { loadMessages } from '@/i18n/loadMessages';
+import { i18nConfig } from '@config/i18n';
+import type { LocaleType, PageI18nInterface } from '@config/i18n';
+import { themeConfig } from '@config/theme';
+import type { RouteParamsnHandlerInterface } from './port/RouteParamsnHandlerInterface';
+import type { useTranslations } from 'next-intl';
+import type { ParsedUrlQuery } from 'querystring';
+export interface PagesRouteParamsType extends ParsedUrlQuery {
+  locale?: string | string[];
+}
+/**
+ * 用于 src/pages/** 路由的参数管理工具
+ *
+ * ⚠️ 注意：此类仅在服务器端使用（getStaticProps、getServerSideProps 中）
+ * 此类直接从 JSON 文件加载翻译消息，不依赖 next-intl/server，因此可以在 pages 目录中安全使用
+ *
+ * @example
+ * ```ts
+ * export async function getStaticProps({ params }: GetStaticPropsContext<PagesRouteParamsType>) {
+ *   const pageParams = new PagesRouteParams(params);
+ *   const messages = await pageParams.getI18nMessages();
+ *   return { props: { messages } };
+ * }
+ * ```
+ */
+export class PagesRouteParams implements RouteParamsnHandlerInterface {
+  private locale: string | null;
+  constructor(protected readonly params: PagesRouteParamsType = {}) {
+    const localeParam = Array.isArray(this.params.locale)
+      ? this.params.locale[0]
+      : this.params.locale;
+    this.locale = localeParam || i18nConfig.fallbackLng;
+  }
+  public getLocale(defaultLocale?: string): string {
+    if (this.locale) {
+      return this.locale;
+    }
+    const localeParam = Array.isArray(this.params.locale)
+      ? this.params.locale[0]
+      : this.params.locale;
+    this.locale = localeParam || defaultLocale || i18nConfig.fallbackLng;
+    return this.locale;
+  }
+  /**
+   * 获取 locale，如果 locale 不支持则抛出错误
+   * 注意：在 pages 目录中，应该在 getStaticProps/getServerSideProps 中返回 { notFound: true } 来处理不支持的 locale
+   *
+   * @returns 支持的 locale 字符串
+   * @throws 如果 locale 不支持
+   */
+  public getI18nWithNotFound(): string {
+    const locale = this.getLocale();
+    if (!i18nConfig.supportedLngs.includes(locale as LocaleType)) {
+      // 在 pages 目录中，应该返回 { notFound: true } 而不是调用 notFound()
+      // 这里抛出错误，由调用方在 getStaticProps/getServerSideProps 中处理
+      throw new Error(`Unsupported locale: ${locale}`);
+    }
+    return locale;
+  }
+  /**
+   * 获取 i18n 消息
+   * 使用公共方法加载消息，支持从 API 加载或动态导入 JSON 文件
+   * 不依赖 next-intl/server，适用于 getStaticProps/getServerSideProps
+   *
+   * @param namespace - 可选的命名空间（单个字符串或字符串数组），会与默认命名空间 ['common', 'api'] 合并
+   * @returns Promise<Record<string, string>> 返回翻译消息对象
+   */
+  public async getI18nMessages(
+    namespace?: string | string[]
+  ): Promise<Record<string, string>> {
+    const locale = this.getLocale();
+    // 将默认命名空间和用户提供的命名空间合并
+    const defaultNamespaces = [...i18nConfig.defaultNamespaces];
+    const userNamespaces = namespace
+      ? Array.isArray(namespace)
+        ? namespace
+        : [namespace]
+      : [];
+    // 合并并去重
+    const namespaces = [...new Set([...defaultNamespaces, ...userNamespaces])];
+    return loadMessages(locale, namespaces);
+  }
+  /**
+   * 获取翻译后的 i18n 接口
+   * 创建一个简单的翻译函数，基于加载的 messages
+   */
+  public async getI18nInterface<T extends PageI18nInterface>(
+    i18nInterface: T,
+    namespace?: string
+  ): Promise<T> {
+    const messages = await this.getI18nMessages(namespace);
+    // 创建一个简单的翻译函数
+    const t = (
+      key: string,
+      params?: Record<string, string | number | Date>
+    ) => {
+      const fullKey = namespace ? `${namespace}:${key}` : key;
+      let message = messages[fullKey] || messages[key] || key;
+      // 简单的参数替换
+      if (params) {
+        Object.entries(params).forEach(([paramKey, paramValue]) => {
+          message = message.replace(
+            new RegExp(`\\{${paramKey}\\}`, 'g'),
+            String(paramValue)
+          );
+        });
+      }
+      return message;
+    };
+    return TranslateI18nInterface.translate<T>(
+      i18nInterface,
+      t as ReturnType<typeof useTranslations>
+    );
+  }
+  public getTheme(): string {
+    return themeConfig.defaultTheme;
+  }
+}

package/dist/templates/next-app/src/server/{sqlBridges/SupabaseBridge.ts → SupabaseBridge.ts} RENAMED Viewed

@@ -59,6 +59,8 @@ export class SupabaseBridge implements DBBridgeInterface {
     result: PostgrestSingleResponse<unknown>
   ): Promise<SupabaseBridgeResponse<unknown>> {
     if (result.error) {
+      this.logger.error('', result);
       if (this.hasPausedProject(result)) {
         throw new Error(
           'Project is paused, Please Restore project: https://supabase.com/dashboard'

package/dist/templates/next-app/src/server/controllers/AdminLocalesController.ts ADDED Viewed

@@ -0,0 +1,74 @@
+import { inject, injectable } from 'inversify';
+import { AdminLocalesService } from '@/server/services/AdminLocalesService';
+import type { LocalesSchema } from '@migrations/schema/LocalesSchema';
+import {
+  ApiLocaleService,
+  type ImportLocalesData
+} from '../services/ApiLocaleService';
+import {
+  LocalesImportValidator,
+  LocalesValidator
+} from '../validators/LocalesValidator';
+import { PaginationValidator } from '../validators/PaginationValidator';
+import type { AdminLocalesControllerInterface } from '../port/AdminLocalesControllerInterface';
+import type { BridgeOrderBy } from '../port/DBBridgeInterface';
+import type { UpsertResult } from '../port/LocalesRepositoryInterface';
+import type { PaginationInterface } from '../port/PaginationInterface';
+import type { ValidatorInterface } from '../port/ValidatorInterface';
+import type { PaginationParams } from '../validators/PaginationValidator';
+@injectable()
+export class AdminLocalesController implements AdminLocalesControllerInterface {
+  constructor(
+    @inject(AdminLocalesService)
+    protected adminLocalesService: AdminLocalesService,
+    @inject(PaginationValidator)
+    protected paginationValidator: ValidatorInterface<PaginationParams>,
+    @inject(ApiLocaleService)
+    protected apiLocaleService: ApiLocaleService,
+    @inject(LocalesValidator)
+    protected localesValidator: ValidatorInterface<Partial<LocalesSchema>>,
+    @inject(LocalesImportValidator)
+    protected localesImportValidator: ValidatorInterface<ImportLocalesData>
+  ) {}
+  async getLocales(query: {
+    page: number;
+    pageSize: number;
+    orders?: BridgeOrderBy;
+  }): Promise<PaginationInterface<LocalesSchema>> {
+    const paginationParams = await this.paginationValidator.getThrow(query);
+    const result = await this.apiLocaleService.getLocales({
+      page: paginationParams.page,
+      pageSize: paginationParams.pageSize,
+      orderBy: paginationParams?.orders
+    });
+    return result;
+  }
+  async createLocale(
+    body: Omit<LocalesSchema, 'id' | 'created_at' | 'updated_at'>
+  ): Promise<{ success: boolean }> {
+    const localesParams = await this.localesValidator.getThrow(body);
+    await this.apiLocaleService.create(localesParams);
+    return {
+      success: true
+    };
+  }
+  async updateLocale(body: Partial<LocalesSchema>): Promise<void> {
+    await this.apiLocaleService.update(body);
+  }
+  async importLocales(formData: unknown): Promise<UpsertResult> {
+    const localesParams = await this.localesImportValidator.getThrow({
+      values: formData
+    });
+    const result = await this.apiLocaleService.importLocales(localesParams);
+    return result;
+  }
+}

package/dist/templates/next-app/src/server/controllers/AdminUserController.ts ADDED Viewed

@@ -0,0 +1,39 @@
+import { inject, injectable } from 'inversify';
+import type { UserSchema } from '@migrations/schema/UserSchema';
+import { UserRepository } from '../repositorys/UserRepository';
+import { ApiUserService } from '../services/ApiUserService';
+import { PaginationValidator } from '../validators/PaginationValidator';
+import type { AdminUserControllerInterface } from '../port/AdminUserControllerInterface';
+import type { BridgeOrderBy } from '../port/DBBridgeInterface';
+import type { PaginationInterface } from '../port/PaginationInterface';
+import type { UserRepositoryInterface } from '../port/UserRepositoryInterface';
+import type { ValidatorInterface } from '../port/ValidatorInterface';
+import type { PaginationParams } from '../validators/PaginationValidator';
+@injectable()
+export class AdminUserController implements AdminUserControllerInterface {
+  constructor(
+    @inject(UserRepository)
+    protected userRepository: UserRepositoryInterface,
+    @inject(PaginationValidator)
+    protected paginationValidator: ValidatorInterface<PaginationParams>,
+    @inject(ApiUserService)
+    protected apiUserService: ApiUserService
+  ) {}
+  async getUsers(query: {
+    page: number;
+    pageSize: number;
+    orderBy?: BridgeOrderBy;
+  }): Promise<PaginationInterface<UserSchema>> {
+    const paginationParams = await this.paginationValidator.getThrow(query);
+    const result = await this.apiUserService.getUsers({
+      page: paginationParams.page,
+      pageSize: paginationParams.pageSize
+    });
+    return result;
+  }
+}

package/dist/templates/next-app/src/server/controllers/LocalesController.ts ADDED Viewed

@@ -0,0 +1,33 @@
+import { inject, injectable } from 'inversify';
+import { i18nConfig } from '@config/i18n';
+import type { LocaleType } from '@config/i18n';
+import { ApiLocaleService } from '../services/ApiLocaleService';
+import type {
+  LocalesControllerInterface,
+  LocalesControllerJsonQuery
+} from '../port/LocalesControllerInterface';
+@injectable()
+export class LocalesController implements LocalesControllerInterface {
+  constructor(
+    @inject(ApiLocaleService)
+    protected apiLocaleService: ApiLocaleService
+  ) {}
+  async json(
+    query: LocalesControllerJsonQuery
+  ): Promise<Record<string, string>> {
+    const locale = query.locale as LocaleType;
+    if (!locale || !i18nConfig.supportedLngs.includes(locale)) {
+      return {};
+    }
+    const result = await this.apiLocaleService.getLocalesJson(
+      locale,
+      query.orderBy
+    );
+    return result;
+  }
+}

package/dist/templates/next-app/src/server/controllers/UserController.ts ADDED Viewed

@@ -0,0 +1,77 @@
+import { ExecutorError } from '@qlover/fe-corekit';
+import { inject, injectable } from 'inversify';
+import { StringEncryptor } from '@/base/cases/StringEncryptor';
+import type { UserSchema } from '@migrations/schema/UserSchema';
+import { ServerAuth } from '../ServerAuth';
+import { UserService } from '../services/UserService';
+import {
+  LoginValidator,
+  type LoginValidatorData
+} from '../validators/LoginValidator';
+import type { ServerAuthInterface } from '../port/ServerAuthInterface';
+import type { UserControllerInerface } from '../port/UserControllerInerface';
+import type { UserServiceInterface } from '../port/UserServiceInterface';
+import type { ValidatorInterface } from '../port/ValidatorInterface';
+import type { Encryptor } from '@qlover/fe-corekit';
+@injectable()
+export class UserController implements UserControllerInerface {
+  constructor(
+    @inject(ServerAuth) protected serverAuth: ServerAuthInterface,
+    @inject(StringEncryptor)
+    protected stringEncryptor: Encryptor<string, string>,
+    @inject(LoginValidator)
+    protected loginValidator: ValidatorInterface<LoginValidatorData>,
+    @inject(UserService) protected userService: UserServiceInterface
+  ) {}
+  async login(requestBody: LoginValidatorData): Promise<UserSchema> {
+    try {
+      if (requestBody.password) {
+        requestBody.password = this.stringEncryptor.decrypt(
+          requestBody.password
+        );
+      }
+    } catch {
+      throw new ExecutorError(
+        'encrypt_password_failed',
+        'Encrypt password failed'
+      );
+    }
+    const body = await this.loginValidator.getThrow(requestBody);
+    const user = await this.userService.login(body);
+    await this.serverAuth.setAuth(user.credential_token);
+    return user;
+  }
+  async register(requestBody: LoginValidatorData): Promise<UserSchema> {
+    try {
+      if (requestBody.password) {
+        requestBody.password = this.stringEncryptor.decrypt(
+          requestBody.password
+        );
+      }
+    } catch {
+      throw new ExecutorError(
+        'encrypt_password_failed',
+        'Encrypt password failed'
+      );
+    }
+    const body = await this.loginValidator.getThrow(requestBody);
+    const user = await this.userService.register({
+      email: body.email,
+      password: body.password
+    });
+    return user;
+  }
+  async logout(): Promise<void> {
+    return await this.userService.logout();
+  }
+}

package/dist/templates/next-app/src/server/port/AIControllerInterface.ts ADDED Viewed

@@ -0,0 +1,8 @@
+import type { AppApiResult } from '@/base/port/AppApiInterface';
+import type { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
+export interface AIControllerInterface {
+  completions(body: {
+    messages: ChatCompletionMessageParam[];
+  }): Promise<AppApiResult<unknown>>;
+}