@qlover/create-app 1.0.1 → 1.1.0

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

@@ -0,0 +1,53 @@
+import { logger } from '@/core/globals';
+import { i18nWarnMissingTranslation } from '@config/common';
+import type { PageI18nInterface } from '@config/i18n';
+import type { Formats, useTranslations } from 'next-intl';
+
+/**
+ * Translate I18n Interface tools class
+ *
+ * @param i18nInterface - The i18n interface to translate
+ * @param t - The translations function
+ * @returns The translated i18n interface
+ */
+export class TranslateI18nUtil {
+  public static translate<T extends PageI18nInterface | Record<string, string>>(
+    source: T,
+    t: ReturnType<typeof useTranslations>
+  ): T {
+    return Object.fromEntries(
+      Object.entries(source).map(([key, value]) => {
+        if (typeof value === 'string') {
+          return [key, t(value)];
+        }
+        return [key, value];
+      })
+    ) as T;
+  }
+
+  public static overrideTranslateT(
+    t: ReturnType<typeof useTranslations>
+  ): ReturnType<typeof useTranslations> {
+    return function ot(
+      key: string,
+      values?: Record<string, string | number | Date> | undefined,
+      formats?: Formats | undefined
+    ) {
+      try {
+        if (!i18nWarnMissingTranslation) {
+          return t(key, values, formats);
+        }
+
+        if (t.has(key)) {
+          return t(key, values, formats);
+        }
+
+        logger.warn(`[i18n] Missing translation: ${key}`);
+      } catch (e) {
+        logger.error(`[i18n] Error translation: ${key}`, String(e));
+        return t.raw(key);
+      }
+      return key;
+    } as ReturnType<typeof useTranslations>;
+  }
+}

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

@@ -70,9 +70,6 @@ export class ZodColumnBuilder<
     ];
   }
 
-  /**
-   * @override
-   */
   public zod2BaseOption(
     key: string,
     zod: ZodType
@@ -99,9 +96,6 @@ export class ZodColumnBuilder<
     };
   }
 
-  /**
-   * @override
-   */
   public getBaseOptions(input: Input): OptionMap<Value, Input> {
     return Object.entries(input.shape).reduce(
       (acc, [key, zod]) => {
@@ -129,9 +123,6 @@ export class ZodColumnBuilder<
     return this;
   }
 
-  /**
-   * @override
-   */
   public render<K extends keyof Input['shape']>(
     key: K,
     render: (
@@ -146,7 +137,6 @@ export class ZodColumnBuilder<
 
   /**
    * Translate all i18n keys in options to actual text
-   * @override
    * @param t - Translation function from next-intl
    * @returns this for chaining
    */

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

@@ -22,8 +22,5 @@ export abstract class AdminLayoutInterface extends StoreInterface<AdminPageState
     navItems: (state: AdminPageState) => state.navItems
   };
 
-  /**
-   * @override
-   */
   public abstract toggleSidebar(): void;
 }

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

@@ -1,6 +1,6 @@
 import type { LoginValidatorData } from '@/server/validators/LoginValidator';
 import type { UserSchema } from '@migrations/schema/UserSchema';
-import type { AppApiTransaction } from '../services/appApi/AppApiRequester';
+import type { AppApiTransaction } from '../services/AppApiRequester';
 
 export type UserApiLoginTransaction = AppApiTransaction<
   LoginValidatorData,

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

@@ -14,30 +14,12 @@ export class I18nServiceState implements StoreStateInterface {
   constructor(public language: I18nServiceLocale) {}
 }
 export abstract class I18nServiceInterface extends StoreInterface<I18nServiceState> {
-  /**
-   * @override
-   */
   public abstract t(key: string, params?: Record<string, unknown>): string;
-  /**
-   * @override
-   */
   public abstract changeLanguage(language: I18nServiceLocale): Promise<void>;
-  /**
-   * @override
-   */
   public abstract changeLoading(loading: boolean): void;
-  /**
-   * @override
-   */
   public abstract getCurrentLanguage(): Promise<I18nServiceLocale>;
-  /**
-   * @override
-   */
   public abstract isValidLanguage(
     language: string
   ): language is I18nServiceLocale;
-  /**
-   * @override
-   */
   public abstract getSupportedLanguages(): I18nServiceLocale[];
 }

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

@@ -1,5 +1,8 @@
 import type { UserCredential, UserSchema } from '@migrations/schema/UserSchema';
-import type { UserService as CorekitBridgeUserServiceInterface } from '@qlover/corekit-bridge';
+import type {
+  UserService as CorekitBridgeUserServiceInterface,
+  UserServiceGateway
+} from '@qlover/corekit-bridge';
 
 export interface UserServiceInterface extends CorekitBridgeUserServiceInterface<
   UserSchema,
@@ -13,8 +16,10 @@ export interface UserServiceInterface extends CorekitBridgeUserServiceInterface<
    * This is a extends method from the corekit-bridge UserServiceInterface.
    */
   getToken(): string;
-
-  isUserInfo(value: unknown): value is UserSchema;
-
-  isUserCredential(value: unknown): value is UserCredential;
 }
+
+export interface UserServiceGatewayInterface extends UserServiceGateway<
+  UserSchema,
+  UserCredential,
+  {}
+> {}

package/dist/templates/next-app/src/base/services/{appApi/AppApiRequester.ts → AppApiRequester.ts}

@@ -1,4 +1,8 @@
-import { LifecycleExecutor, RequestAdapterFetch, RequestExecutor } from '@qlover/fe-corekit';
+import {
+  LifecycleExecutor,
+  RequestAdapterFetch,
+  RequestExecutor
+} from '@qlover/fe-corekit';
 import { injectable } from 'inversify';
 import type { RequestEncryptPluginProps } from '@/base/cases/RequestEncryptPlugin';
 import type { AppApiResult } from '@/base/port/AppApiInterface';
@@ -14,11 +18,9 @@ export interface RequestTransactionInterface<Request, Response> {
 }
 
 export interface AppApiConfig<Request = unknown>
-  extends RequestAdapterConfig<Request>,
-    RequestEncryptPluginProps<Request> {}
+  extends RequestAdapterConfig<Request>, RequestEncryptPluginProps<Request> {}
 
-export interface AppApiRequesterContext
-  extends ExecutorContextInterface<AppApiConfig> {}
+export interface AppApiRequesterContext extends ExecutorContextInterface<AppApiConfig> {}
 
 /**
  * UserApiResponse
@@ -37,11 +39,13 @@ export type AppApiResponse<
 /**
  * UserApi common transaction
  */
-export interface AppApiTransaction<Request = unknown, Response = unknown>
-  extends RequestTransactionInterface<
-    AppApiConfig<Request>,
-    AppApiResponse<Request, Response>
-  > {
+export interface AppApiTransaction<
+  Request = unknown,
+  Response = unknown
+> extends RequestTransactionInterface<
+  AppApiConfig<Request>,
+  AppApiResponse<Request, Response>
+> {
   data: AppApiConfig<Request>['data'];
 }
 
@@ -53,7 +57,8 @@ export class AppApiRequester extends RequestExecutor<
   constructor() {
     super(
       new RequestAdapterFetch({
-        baseURL: '/api',
+        // TODO: ReqeustPlugin build url 最后需要带上/
+        baseURL: '/api/',
         responseType: 'json'
       }),
       new LifecycleExecutor()

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

@@ -0,0 +1,110 @@
+import { HttpMethods, RequestExecutor } from '@qlover/fe-corekit';
+import { inject, injectable } from 'inversify';
+import type {
+  UserApiLoginTransaction,
+  UserApiLogoutTransaction,
+  UserApiRegisterTransaction
+} from '@/base/port/AppUserApiInterface';
+import { UserCredential, UserSchema } from '@migrations/schema/UserSchema';
+import {
+  AppApiConfig,
+  AppApiRequester,
+  AppApiRequesterContext
+} from './AppApiRequester';
+import { UserServiceGatewayInterface } from '../port/UserServiceInterface';
+import type { LoginParams } from '@qlover/corekit-bridge';
+
+/**
+ * UserApi
+ *
+ * @description
+ * UserApi is a client for the user API.
+ *
+ */
+@injectable()
+export class AppUserGateway implements UserServiceGatewayInterface {
+  constructor(
+    @inject(AppApiRequester)
+    protected client: RequestExecutor<AppApiConfig, AppApiRequesterContext>
+  ) {}
+
+  /**
+   * @override
+   */
+  public getUserInfo(
+    _params?: unknown,
+    _config?: unknown
+  ): Promise<UserSchema | null> {
+    throw new Error('Method not implemented.');
+  }
+  /**
+   * @override
+   */
+  public refreshUserInfo(
+    _params?: unknown,
+    _config?: {} | undefined
+  ): Promise<UserSchema | null> {
+    throw new Error('Method not implemented.');
+  }
+
+  /**
+   * @override
+   */
+  public async login(
+    params: UserApiLoginTransaction['data'] & LoginParams
+  ): Promise<UserCredential> {
+    const response = await this.client.request<
+      UserApiLoginTransaction['response'],
+      UserApiLoginTransaction['request']
+    >({
+      url: '/user/login',
+      method: HttpMethods.POST,
+      data: params,
+      encryptProps: 'password'
+    });
+
+    if (!response.data.success) {
+      throw new Error(response.data.message);
+    }
+
+    return response.data.data as UserCredential;
+  }
+
+  /**
+   * @override
+   */
+  public async register(
+    params: UserApiRegisterTransaction['data']
+  ): Promise<UserSchema> {
+    const response = await this.client.request<
+      UserApiRegisterTransaction['response'],
+      UserApiRegisterTransaction['request']
+    >({
+      url: '/user/register',
+      method: HttpMethods.POST,
+      data: params,
+      encryptProps: 'password'
+    });
+
+    if (!response.data.success) {
+      throw new Error(response.data.message);
+    }
+
+    return response.data.data as UserSchema;
+  }
+
+  /**
+   * @override
+   */
+  public async logout<R = void>(_params?: unknown): Promise<R> {
+    await this.client.request<
+      UserApiLogoutTransaction['response'],
+      UserApiLogoutTransaction['request']
+    >({
+      url: '/user/logout',
+      method: HttpMethods.POST
+    });
+
+    return undefined as R;
+  }
+}

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

@@ -4,8 +4,8 @@ import {
   I18nServiceState
 } from '../port/I18nServiceInterface';
 import type { I18nServiceLocale } from '../port/I18nServiceInterface';
+import type { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
 import type { useTranslations } from 'next-intl';
-import { BootstrapExecutorPlugin } from '@qlover/corekit-bridge';
 
 type TranslationFunction = ReturnType<typeof useTranslations>;
 
@@ -21,16 +21,10 @@ export class I18nService
     super(() => new I18nServiceState(i18nConfig.fallbackLng));
   }
 
-  /**
-   * @override
-   */
   public setPathname(pathname: string): void {
     this.pathname = pathname;
   }
 
-  /**
-   * @override
-   */
   public setTranslator(translator: TranslationFunction): void {
     this.translator = translator;
   }

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

@@ -6,7 +6,7 @@ import {
   type ResourceInterface,
   type ResourceQuery
 } from '@qlover/corekit-bridge';
-import type { AppApiResponse } from '@/base/services/appApi/AppApiRequester';
+import type { AppApiResponse } from '@/base/services/AppApiRequester';
 import type { PaginationInterface } from '@/server/port/PaginationInterface';
 
 export class ResourceService<
@@ -90,9 +90,6 @@ export class ResourceService<
     return this.store.state.listState.result! as PaginationInterface<T>;
   }
 
-  /**
-   * @override
-   */
   public refresh(): Promise<unknown> {
     return this.search(this.store.state.searchParams);
   }

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

@@ -6,9 +6,15 @@ import {
   type UserCredential,
   type UserSchema
 } from '@migrations/schema/UserSchema';
-import { UserServiceApi } from '../cases/UserServiceApi';
-import type { UserServiceInterface } from '../port/UserServiceInterface';
-import type { UserServiceGateway } from '@qlover/corekit-bridge';
+import { AppUserGateway } from './AppUserGateway';
+import type {
+  UserServiceGatewayInterface,
+  UserServiceInterface
+} from '../port/UserServiceInterface';
+import type {
+  StoreInterface,
+  UserStateInterface
+} from '@qlover/corekit-bridge';
 
 @injectable()
 export class UserService
@@ -16,38 +22,43 @@ export class UserService
   implements UserServiceInterface
 {
   constructor(
-    @inject(UserServiceApi)
-    userApi: UserServiceGateway<UserSchema, UserCredential>
+    @inject(AppUserGateway)
+    userApi: UserServiceGatewayInterface
   ) {
-    super({
-      gateway: userApi
-      // next-js ssr 将 credential 存储在 cookie 中无需存储用户信息到本地
-      // store: {
-      //   storageKey: appConfig.userInfoKey,
-      //   credentialStorageKey: appConfig.userTokenKey,
-      //   persistUserInfo: true,
-      // }
-    });
+    super(userApi);
+  }
+
+  /**
+   * @override
+   */
+  public override get gateway(): UserServiceGatewayInterface {
+    return super.gateway as UserServiceGatewayInterface;
   }
 
   /**
    * @override
    */
   public getToken(): string {
-    return this.store.getCredential()?.credential_token ?? '';
+    return this.getStore().getCredential()?.credential_token ?? '';
+  }
+
+  public getUIStore(): StoreInterface<
+    UserStateInterface<UserSchema, UserCredential>
+  > {
+    return this.getStore().getStore();
   }
 
   /**
    * @override
    */
-  public isUserInfo(value: unknown): value is UserSchema {
+  public isUser(value: unknown): value is UserSchema {
     return userSchema.safeParse(value).success;
   }
 
   /**
    * @override
    */
-  public isUserCredential(value: unknown): value is UserCredential {
+  public isCredential(value: unknown): value is UserCredential {
     return (
       isObject(value) &&
       'credential_token' in value &&

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

@@ -1,15 +1,16 @@
+import { RequestExecutor } from '@qlover/fe-corekit';
 import { inject, injectable } from 'inversify';
 import type { PaginationInterface } from '@/server/port/PaginationInterface';
 import type { LocalesSchema } from '@migrations/schema/LocalesSchema';
 import type { LocaleType } from '@config/i18n';
+
 import {
   AppApiRequester,
+  AppApiRequesterContext,
   type AppApiConfig,
   type AppApiTransaction
-} from '../appApi/AppApiRequester';
+} from '../AppApiRequester';
 import type { ResourceInterface, ResourceQuery } from '@qlover/corekit-bridge';
-import { RequestExecutor } from '@qlover/fe-corekit';
-import { AdminApiRequesterContext } from './AdminApiRequester';
 
 export type AdminLocalesListTransaction = AppApiTransaction<
   ResourceQuery,
@@ -25,7 +26,7 @@ export type AdminLocalesUpdateTransaction = AppApiTransaction<
 export class AdminLocalesApi implements ResourceInterface<LocalesSchema> {
   constructor(
     @inject(AppApiRequester)
-    protected client: RequestExecutor<AppApiConfig, AdminApiRequesterContext>
+    protected client: RequestExecutor<AppApiConfig, AppApiRequesterContext>
   ) {}
 
   /**
@@ -87,9 +88,6 @@ export class AdminLocalesApi implements ResourceInterface<LocalesSchema> {
     });
   }
 
-  /**
-   * @override
-   */
   public import(data: {
     [key in LocaleType]?: File;
   }): Promise<unknown> {

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

@@ -1,3 +1,4 @@
+import { ExecutorContextInterface, RequestExecutor } from '@qlover/fe-corekit';
 import { inject, injectable } from 'inversify';
 import type { PaginationInterface } from '@/server/port/PaginationInterface';
 import type { UserSchema } from '@migrations/schema/UserSchema';
@@ -5,10 +6,10 @@ import {
   AppApiRequester,
   type AppApiConfig,
   type AppApiTransaction
-} from '../appApi/AppApiRequester';
+} from '../AppApiRequester';
 import type { ResourceInterface, ResourceQuery } from '@qlover/corekit-bridge';
-import { RequestExecutor } from '@qlover/fe-corekit';
-import { AdminApiRequesterContext } from './AdminApiRequester';
+
+export interface AdminApiRequesterContext extends ExecutorContextInterface<AppApiConfig> {}
 
 export type AdminUserListTransaction = AppApiTransaction<
   ResourceQuery,

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

@@ -1,11 +1,11 @@
-import {
+import { ExecutorError, isRequestAdapterResponse } from '@qlover/fe-corekit';
+import type { AppApiErrorInterface } from '@/base/port/AppApiInterface';
+import type { AppApiConfig } from '../AppApiRequester';
+import type {
   ExecutorContextInterface,
-  ExecutorError,
-  isRequestAdapterResponse,
+  HookRuntimes,
   LifecyclePluginInterface
 } from '@qlover/fe-corekit';
-import type { AppApiErrorInterface } from '@/base/port/AppApiInterface';
-import type { AppApiConfig } from './AppApiRequester';
 import type { LoggerInterface } from '@qlover/logger';
 
 export class AppApiPlugin implements LifecyclePluginInterface<
@@ -15,9 +15,6 @@ export class AppApiPlugin implements LifecyclePluginInterface<
 
   constructor(protected logger: LoggerInterface) {}
 
-  /**
-   * @override
-   */
   public isAppApiErrorInterface(value: unknown): value is AppApiErrorInterface {
     return (
       typeof value === 'object' &&
@@ -29,6 +26,19 @@ export class AppApiPlugin implements LifecyclePluginInterface<
     );
   }
 
+  /**
+   * @override
+   * @param ctx
+   */
+  public onBefore(
+    ctx: ExecutorContextInterface<AppApiConfig<unknown>, unknown, HookRuntimes>
+  ): void {
+    ctx.setParameters({
+      ...ctx.parameters,
+      // TODO: ReqeustPlugin 在处理路径后会保留baseUrl，然后拼接 url，但是 fetchAdapter 会再次组合两个参数导致重复
+      baseURL: ''
+    });
+  }
   /**
    * @override
    */
@@ -39,7 +49,10 @@ export class AppApiPlugin implements LifecyclePluginInterface<
     // Important: 当响应数据失败则抛出错误
     if (isRequestAdapterResponse(response)) {
       if (this.isAppApiErrorInterface(response.data)) {
-        throw new ExecutorError(response.data.message || response.data.id, response);
+        throw new ExecutorError(
+          response.data.message || response.data.id,
+          response
+        );
       }
     }
 
@@ -77,9 +90,6 @@ export class AppApiPlugin implements LifecyclePluginInterface<
     }
   }
 
-  /**
-   * @override
-   */
   protected async getResponseJson(response: Response): Promise<unknown> {
     try {
       return await response.json();
@@ -88,15 +98,13 @@ export class AppApiPlugin implements LifecyclePluginInterface<
     }
   }
 
-  /**
-   * @override
-   */
   protected loggerError(config: AppApiConfig, error: unknown): void {
     this.logger.error(
       `%c[AppApi ${config.method} ${config.url}]%c - ${new Date().toLocaleString()}`,
       'color: #f00;',
       'color: inherit;',
-      error
+      error,
+      config
     );
   }
 }

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

@@ -4,8 +4,8 @@ import { RequestEncryptPlugin } from '@/base/cases/RequestEncryptPlugin';
 import { StringEncryptor } from '@/base/cases/StringEncryptor';
 import { I } from '@config/IOCIdentifier';
 import { AppApiPlugin } from './AppApiPlugin';
-import { AppApiRequester } from './AppApiRequester';
-import type { AppApiConfig } from './AppApiRequester';
+import { AppApiRequester } from '../AppApiRequester';
+import type { AppApiConfig } from '../AppApiRequester';
 import type {
   BootstrapContext,
   BootstrapExecutorPlugin
@@ -35,9 +35,6 @@ export class AppUserApiBootstrap implements BootstrapExecutorPlugin {
     appUserApi.use(ioc.get(DialogErrorPlugin));
   }
 
-  /**
-   * @override
-   */
   protected requestDataSerializer(
     data: unknown,
     config: AppApiConfig

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

@@ -1,31 +1,29 @@
 import 'reflect-metadata';
-import {
-  type ServiceIdentifier,
-  type IOCContainerInterface,
-  type IOCFunctionInterface,
+import { LifecycleExecutor } from '@qlover/fe-corekit';
+import type { ServerInterface } from '@/server/port/ServerInterface';
+import { I, type IOCIdentifierMapServer } from '@config/IOCIdentifier';
+import { ServerIOC } from '../serverIoc/ServerIOC';
+import type {
+  ServiceIdentifier,
+  IOCContainerInterface,
+  IOCFunctionInterface,
   BootstrapPluginOptions
 } from '@qlover/corekit-bridge';
-import {
+import type {
+  ExecutorError,
   ExecutorAsyncTask,
   ExecutorContextInterface,
-  LifecycleExecutor,
-  LifecyclePluginInterface,
-  type ExecutorError
+  LifecyclePluginInterface
 } from '@qlover/fe-corekit';
-import type { ServerInterface } from '@/server/port/ServerInterface';
-import { I, type IOCIdentifierMapServer } from '@config/IOCIdentifier';
-import { ServerIOC } from '../serverIoc/ServerIOC';
 import type { LoggerInterface } from '@qlover/logger';
 
 export interface BootstrapServerContextOptions extends BootstrapPluginOptions {
   IOC: IOCFunctionInterface<IOCIdentifierMapServer, IOCContainerInterface>;
 }
 
-export interface BootstrapServerPlugin
-  extends LifecyclePluginInterface<BootstrapServerContext> {}
+export interface BootstrapServerPlugin extends LifecyclePluginInterface<BootstrapServerContext> {}
 
-export interface BootstrapServerContext
-  extends ExecutorContextInterface<BootstrapServerContextOptions> {}
+export interface BootstrapServerContext extends ExecutorContextInterface<BootstrapServerContextOptions> {}
 
 export class BootstrapServer implements ServerInterface {
   protected executor: LifecycleExecutor<
@@ -80,9 +78,6 @@ export class BootstrapServer implements ServerInterface {
     return this.IOC(identifier);
   }
 
-  /**
-   * @override
-   */
   public use(
     plugin:
       | BootstrapServerPlugin
@@ -126,3 +121,5 @@ export class BootstrapServer implements ServerInterface {
     );
   }
 }
+
+export const bootstrapServer = new BootstrapServer();