@qlover/create-app 0.10.1 → 0.10.3

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

@@ -17,15 +17,27 @@ export class InversifyContainer implements IOCContainerInterface {
     });
   }
 
-  bind<T>(key: ServiceIdentifier<T>, value: T): void {
+  /**
+   * @override
+   */
+  public bind<T>(key: ServiceIdentifier<T>, value: T): void {
     this.container.bind<T>(key).toConstantValue(value);
   }
 
-  get<K extends keyof IOCIdentifierMap>(
+  /**
+   * @override
+   */
+  public get<K extends keyof IOCIdentifierMap>(
     serviceIdentifier: K
   ): IOCIdentifierMap[K];
-  get<T>(serviceIdentifier: ServiceIdentifier<T>): T;
-  get<T, K extends keyof IOCIdentifierMap>(
+  /**
+   * @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/next-app/src/base/cases/NavigateBridge.ts

@@ -1,16 +1,32 @@
-import { injectable } from 'inversify';
+import { inject, injectable } from 'inversify';
+import type { useRouter } from '@/i18n/routing';
+import { I } from '@config/IOCIdentifier';
 import type { UIBridgeInterface } from '@qlover/corekit-bridge';
-import type { AppRouterInstance } from 'next/dist/shared/lib/app-router-context.shared-runtime';
+import type { LoggerInterface } from '@qlover/logger';
+
+type AppRouterInstance = ReturnType<typeof useRouter>;
 
 @injectable()
 export class NavigateBridge implements UIBridgeInterface<AppRouterInstance> {
   protected navigate: AppRouterInstance | null = null;
 
-  setUIBridge(ui: AppRouterInstance): void {
+  constructor(@inject(I.Logger) protected logger: LoggerInterface) {}
+
+  /**
+   * @override
+   */
+  public setUIBridge(ui: AppRouterInstance): void {
     this.navigate = ui;
   }
 
-  getUIBridge(): AppRouterInstance | null {
+  /**
+   * @override
+   */
+  public getUIBridge(): AppRouterInstance | null {
+    if (!this.navigate) {
+      this.logger.debug('NavigateBridge this.navigate is not set');
+    }
+
     return this.navigate;
   }
 }

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

@@ -20,11 +20,14 @@ export interface RequestEncryptPluginProps<
 }
 
 export class RequestEncryptPlugin implements ExecutorPlugin<RequestEncryptPluginProps> {
-  readonly pluginName = 'RequestEncryptPlugin';
+  public readonly pluginName = 'RequestEncryptPlugin';
 
   constructor(protected encryptor: Encryptor<string, string>) {}
 
-  onBefore(
+  /**
+   * @override
+   */
+  public onBefore(
     context: ExecutorContext<RequestEncryptPluginProps>
   ): void | Promise<void> {
     const { responseType, encryptProps } = context.parameters;
@@ -41,6 +44,9 @@ export class RequestEncryptPlugin implements ExecutorPlugin<RequestEncryptPlugin
     }
   }
 
+  /**
+   * @override
+   */
   protected encryptData<T extends object>(
     data: T,
     encryptProps?: string | string[]

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

@@ -6,12 +6,12 @@ import type {
 } from '@qlover/corekit-bridge';
 
 export class ResourceState implements ResourceStateInterface {
-  searchParams: ResourceQuery = {
+  public searchParams: ResourceQuery = {
     page: 1,
     pageSize: 10,
     orderBy: 'updated_at',
     order: 1
   };
-  initState = new RequestState<unknown>();
-  listState = new RequestState<PaginationInterface<unknown>>();
+  public initState = new RequestState<unknown>();
+  public listState = new RequestState<PaginationInterface<unknown>>();
 }

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

@@ -13,27 +13,45 @@ export class RouterService implements RouterInterface {
     protected uiBridge: UIBridgeInterface<AppRouterInstance>
   ) {}
 
-  protected padLocaleHref(href: RouterPathname): string {
-    return `/${this.locale}${href === '/' ? '' : href}`;
+  /**
+   * @override
+   */
+  public goto(href: RouterPathname): void {
+    this.uiBridge.getUIBridge()?.push(href as string);
   }
 
-  goto(href: RouterPathname): void {
-    this.uiBridge.getUIBridge()?.push(this.padLocaleHref(href));
-  }
-
-  gotoHome(): void {
+  /**
+   * @override
+   */
+  public gotoHome(): void {
     this.goto('/');
   }
 
-  gotoLogin(): void {
+  /**
+   * @override
+   */
+  public gotoLogin(): void {
     this.goto('/login');
   }
 
-  setLocale(locale: string): void {
+  /**
+   * @override
+   */
+  public replaceHome(): void {
+    this.uiBridge.getUIBridge()?.replace('/');
+  }
+
+  /**
+   * @override
+   */
+  public setLocale(locale: string): void {
     this.locale = locale;
   }
 
-  getLocale(): string {
+  /**
+   * @override
+   */
+  public getLocale(): string {
     return this.locale;
   }
 }

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

@@ -18,6 +18,9 @@ export class StringEncryptor implements Encryptor<string, string> {
     this.key = appConfig.stringEncryptorKey;
   }
 
+  /**
+   * @override
+   */
   protected encryptWithKey(str: string, key: string): string {
     const result = [];
     for (let i = 0; i < str.length; i++) {
@@ -31,6 +34,9 @@ export class StringEncryptor implements Encryptor<string, string> {
     return result.join('');
   }
 
+  /**
+   * @override
+   */
   protected decryptWithKey(str: string, key: string): string {
     const result = [];
     for (let i = 0; i < str.length; i++) {
@@ -43,7 +49,10 @@ export class StringEncryptor implements Encryptor<string, string> {
     return result.join('');
   }
 
-  encrypt(value: string): string {
+  /**
+   * @override
+   */
+  public encrypt(value: string): string {
     try {
       const encrypted = this.encryptWithKey(value, this.key);
       return this.base64Serializer.serialize(encrypted);
@@ -53,7 +62,10 @@ export class StringEncryptor implements Encryptor<string, string> {
     }
   }
 
-  decrypt(encryptedValue: string): string {
+  /**
+   * @override
+   */
+  public decrypt(encryptedValue: string): string {
     try {
       // 1. 先用 base64 反序列化
       const decoded = this.base64Serializer.deserialize(encryptedValue);

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

@@ -9,7 +9,7 @@ import type { useTranslations } from 'next-intl';
  * @returns The translated i18n interface
  */
 export class TranslateI18nInterface {
-  static translate<T extends PageI18nInterface | Record<string, string>>(
+  public static translate<T extends PageI18nInterface | Record<string, string>>(
     source: T,
     t: ReturnType<typeof useTranslations>
   ): T {

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

@@ -17,7 +17,10 @@ export class UserServiceApi implements UserServiceGateway<
 > {
   constructor(@inject(AppUserApi) protected appUserApi: AppUserApiInterface) {}
 
-  getUserInfo(_params?: unknown): Promise<UserSchema | null> {
+  /**
+   * @override
+   */
+  public getUserInfo(_params?: unknown): Promise<UserSchema | null> {
     if (_params && isWebUserSchema(_params).success) {
       return Promise.resolve(omit(_params, 'credential_token') as UserSchema);
     }
@@ -25,13 +28,19 @@ export class UserServiceApi implements UserServiceGateway<
     return Promise.resolve(null);
   }
 
-  refreshUserInfo<Params>(
+  /**
+   * @override
+   */
+  public refreshUserInfo<Params>(
     _params?: Params | undefined
   ): Promise<UserSchema | null> {
     return this.getUserInfo(_params);
   }
 
-  async login(params: LoginValidatorData): Promise<UserCredential> {
+  /**
+   * @override
+   */
+  public async login(params: LoginValidatorData): Promise<UserCredential> {
     const response = await this.appUserApi.login(params);
 
     if (!response.data.success) {
@@ -41,7 +50,10 @@ export class UserServiceApi implements UserServiceGateway<
     return response.data.data as UserCredential;
   }
 
-  async register(params: LoginValidatorData): Promise<UserSchema> {
+  /**
+   * @override
+   */
+  public async register(params: LoginValidatorData): Promise<UserSchema> {
     const response = await this.appUserApi.register(params);
 
     if (!response.data.success) {
@@ -51,7 +63,10 @@ export class UserServiceApi implements UserServiceGateway<
     return response.data.data as UserSchema;
   }
 
-  async logout<P = unknown, Result = void>(params?: P): Promise<Result> {
+  /**
+   * @override
+   */
+  public async logout<P = unknown, Result = void>(params?: P): Promise<Result> {
     const response = await this.appUserApi.logout(params);
 
     if (!response.data.success) {

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

@@ -45,7 +45,12 @@ export class ZodColumnBuilder<
     this.optionMap = optionMap ? merge(baseOptions, optionMap) : baseOptions;
   }
 
-  static zodType2RenderForm(zod: ZodType): ResourceTableFormType | undefined {
+  /**
+   * @override
+   */
+  public static zodType2RenderForm(
+    zod: ZodType
+  ): ResourceTableFormType | undefined {
     // @ts-expect-error - zod._def.typeName is not typed
     const typeName = zod._def?.typeName as ZodFirstPartyTypeKind;
 
@@ -65,7 +70,10 @@ export class ZodColumnBuilder<
     ];
   }
 
-  zod2BaseOption(
+  /**
+   * @override
+   */
+  public zod2BaseOption(
     key: string,
     zod: ZodType
   ): ResourceTableOption<z.infer<Input>> {
@@ -91,7 +99,10 @@ export class ZodColumnBuilder<
     };
   }
 
-  getBaseOptions(input: Input): OptionMap<Value, Input> {
+  /**
+   * @override
+   */
+  public getBaseOptions(input: Input): OptionMap<Value, Input> {
     return Object.entries(input.shape).reduce(
       (acc, [key, zod]) => {
         acc[key as keyof Input['shape']] = this.zod2BaseOption(
@@ -104,7 +115,10 @@ export class ZodColumnBuilder<
     );
   }
 
-  bind(
+  /**
+   * @override
+   */
+  public bind(
     key: keyof Input['shape'],
     params?: Partial<ResourceTableOption<z.infer<Input>>>
   ): this {
@@ -115,7 +129,10 @@ export class ZodColumnBuilder<
     return this;
   }
 
-  render<K extends keyof Input['shape']>(
+  /**
+   * @override
+   */
+  public render<K extends keyof Input['shape']>(
     key: K,
     render: (
       value: unknown,
@@ -129,10 +146,11 @@ export class ZodColumnBuilder<
 
   /**
    * Translate all i18n keys in options to actual text
+   * @override
    * @param t - Translation function from next-intl
    * @returns this for chaining
    */
-  translate(t: ReturnType<typeof useTranslations>): this {
+  public translate(t: ReturnType<typeof useTranslations>): this {
     Object.values(this.optionMap).forEach((option) => {
       const { tt } = option;
       // Translate title if it's a string (i18n key)
@@ -167,11 +185,15 @@ export class ZodColumnBuilder<
 
   /**
    * Build a single option by key
+   * @override
    * @param key - The key of the option to build
    * @param params - Optional additional parameters to merge
    * @returns The built option
    */
-  build(key: string, params?: unknown): ResourceTableOption<z.infer<Input>> {
+  public build(
+    key: string,
+    params?: unknown
+  ): ResourceTableOption<z.infer<Input>> {
     const option = this.optionMap[key as keyof Input['shape']];
     if (!option) {
       throw new Error(`Option with key "${key}" not found`);
@@ -190,10 +212,11 @@ export class ZodColumnBuilder<
 
   /**
    * Build all options
+   * @override
    * @param params - Optional additional parameters (currently unused)
    * @returns Array of all built options
    */
-  buildAll(_params?: unknown): ResourceTableOption<z.infer<Input>>[] {
+  public buildAll(_params?: unknown): ResourceTableOption<z.infer<Input>>[] {
     return Object.values(this.optionMap);
   }
 }

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

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

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

@@ -12,3 +12,25 @@ export interface AppApiSuccessInterface<T = unknown> {
 export type AppApiResult<T = unknown> =
   | AppApiErrorInterface
   | AppApiSuccessInterface<T>;
+
+export function isAppApiSuccessInterface(
+  result: unknown
+): result is AppApiSuccessInterface {
+  return (
+    typeof result === 'object' &&
+    result !== null &&
+    'success' in result &&
+    result.success === true
+  );
+}
+
+export function isAppApiErrorInterface(
+  result: unknown
+): result is AppApiErrorInterface {
+  return (
+    typeof result === 'object' &&
+    result !== null &&
+    'success' in result &&
+    result.success === false
+  );
+}

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

@@ -10,17 +10,37 @@ export type SupportedNamespace = typeof i18nConfig.fallbackLng;
 export type I18nServiceLocale = Locale;
 
 export class I18nServiceState implements StoreStateInterface {
-  loading: boolean = false;
+  public loading: boolean = false;
   constructor(public language: I18nServiceLocale) {}
 }
 export abstract class I18nServiceInterface
   extends StoreInterface<I18nServiceState>
   implements I18nServiceInterface
 {
-  abstract t(key: string, params?: Record<string, unknown>): 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[];
+  /**
+   * @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/IOCInterface.ts

@@ -21,4 +21,13 @@ export interface IOCInterface<
   create(
     options: IocRegisterOptions
   ): IOCFunctionInterface<IdentifierMap, IOCContainer>;
+
+  /**
+   * 该方法主要用于在应用启动前注册所有依赖
+   *
+   * 因为ssr渲染的原因可能需要在一些特定的环境下注册一些依赖
+   *
+   * @param options - 注册选项
+   */
+  register(options?: IocRegisterOptions): void;
 }

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

@@ -16,7 +16,7 @@ export class AdminPageEvent extends ResourceEvent {
     super(namespace, resource, undefined, schemaFormRef);
   }
 
-  override onDeleted(_params: ResourceTableEventCommonParams): void {
+  public override onDeleted(_params: ResourceTableEventCommonParams): void {
     this.uiDialog?.confirm({
       title: 'Confirm Delete',
       content: 'Are you sure you want to delete this item?',

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

@@ -5,7 +5,7 @@ export class AdminPageScheduler implements LifecycleInterface {
   /**
    * @override
    */
-  async created(parmas: {
+  public async created(parmas: {
     resource: ResourceService<unknown>;
   }): Promise<unknown> {
     const { resource } = parmas;
@@ -28,7 +28,7 @@ export class AdminPageScheduler implements LifecycleInterface {
   /**
    * @override
    */
-  destroyed(parmas: { resource: ResourceService<unknown> }): void {
+  public destroyed(parmas: { resource: ResourceService<unknown> }): void {
     const { resource } = parmas;
     const store = resource.getStore();
 
@@ -38,5 +38,5 @@ export class AdminPageScheduler implements LifecycleInterface {
   /**
    * @override
    */
-  updated(): void {}
+  public updated(): void {}
 }

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

@@ -9,7 +9,7 @@ import type { useTranslations } from 'next-intl';
 type TranslationFunction = ReturnType<typeof useTranslations>;
 
 export class I18nService extends I18nServiceInterface {
-  readonly pluginName = 'I18nService';
+  public readonly pluginName = 'I18nService';
   protected pathname: string = '';
   protected translator: TranslationFunction | null = null;
 
@@ -17,20 +17,28 @@ export class I18nService extends I18nServiceInterface {
     super(() => new I18nServiceState(i18nConfig.fallbackLng));
   }
 
-  setPathname(pathname: string): void {
+  /**
+   * @override
+   */
+  public setPathname(pathname: string): void {
     this.pathname = pathname;
   }
 
-  setTranslator(translator: TranslationFunction): void {
+  /**
+   * @override
+   */
+  public setTranslator(translator: TranslationFunction): void {
     this.translator = translator;
   }
 
   /**
    * @override
    */
-  async onBefore(): Promise<void> {}
+  public async onBefore(): Promise<void> {}
 
-  override async changeLanguage(language: I18nServiceLocale): Promise<void> {
+  public override async changeLanguage(
+    language: I18nServiceLocale
+  ): Promise<void> {
     try {
       this.changeLoading(true);
 
@@ -46,23 +54,25 @@ export class I18nService extends I18nServiceInterface {
     }
   }
 
-  override changeLoading(loading: boolean): void {
+  public override changeLoading(loading: boolean): void {
     this.emit({ ...this.state, loading });
   }
 
-  override async getCurrentLanguage(): Promise<I18nServiceLocale> {
+  public override async getCurrentLanguage(): Promise<I18nServiceLocale> {
     return this.state.language;
   }
 
-  override isValidLanguage(language: string): language is I18nServiceLocale {
+  public override isValidLanguage(
+    language: string
+  ): language is I18nServiceLocale {
     return i18nConfig.supportedLngs.includes(language as I18nServiceLocale);
   }
 
-  override getSupportedLanguages(): I18nServiceLocale[] {
+  public override getSupportedLanguages(): I18nServiceLocale[] {
     return [...i18nConfig.supportedLngs];
   }
 
-  override t(
+  public override t(
     key: string,
     params?: Record<string, string | number | Date>
   ): string {

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

@@ -14,7 +14,7 @@ export class ResourceService<
   Store extends ResourceStore<ResourceStateInterface> =
     ResourceStore<ResourceStateInterface>
 > implements ResourceServiceInterface<T> {
-  readonly unionKey: string = 'id';
+  public readonly unionKey: string = 'id';
 
   constructor(
     readonly serviceName: string,
@@ -22,14 +22,17 @@ export class ResourceService<
     readonly resourceApi: ResourceInterface<T>
   ) {}
 
-  getStore(): Store {
+  /**
+   * @override
+   */
+  public getStore(): Store {
     return this.store;
   }
 
   /**
    * @override
    */
-  async created(): Promise<unknown> {
+  public async created(): Promise<unknown> {
     this.store.changeInitState(new RequestState(true));
 
     try {
@@ -47,16 +50,19 @@ export class ResourceService<
   /**
    * @override
    */
-  destroyed(): void {
+  public destroyed(): void {
     this.store.reset();
   }
 
   /**
    * @override
    */
-  updated(): void {}
+  public updated(): void {}
 
-  async search(
+  /**
+   * @override
+   */
+  public async search(
     params: Partial<ResourceQuery>
   ): Promise<PaginationInterface<T>> {
     this.store.changeListState(
@@ -84,11 +90,17 @@ export class ResourceService<
     return this.store.state.listState.result! as PaginationInterface<T>;
   }
 
-  refresh(): Promise<unknown> {
+  /**
+   * @override
+   */
+  public refresh(): Promise<unknown> {
     return this.search(this.store.state.searchParams);
   }
 
-  async update(data: Partial<T>): Promise<unknown> {
+  /**
+   * @override
+   */
+  public async update(data: Partial<T>): Promise<unknown> {
     const result = await this.resourceApi.update(data);
 
     // 更新本地列表数据
@@ -109,13 +121,22 @@ export class ResourceService<
     return result;
   }
 
-  create(data: T): Promise<unknown> {
+  /**
+   * @override
+   */
+  public create(data: T): Promise<unknown> {
     return this.resourceApi.create(data);
   }
-  remove(data: T): Promise<unknown> {
+  /**
+   * @override
+   */
+  public remove(data: T): Promise<unknown> {
     return this.resourceApi.remove(data);
   }
-  export(data: T): Promise<unknown> {
+  /**
+   * @override
+   */
+  public export(data: T): Promise<unknown> {
     return this.resourceApi.export(data);
   }
 }