feat(project): add common enums and types for user management and system operations

Author: Ohh-889

src/service/enums/common.ts

@@ -0,0 +1,16 @@
+/** Common enums */
+
+/**
+ * Enable status
+ *
+ * - "1": enabled
+ * - "2": disabled
+ */
+export enum EnableStatus {
+  /** Enabled */
+  ENABLED = '1',
+  /** Disabled */
+  DISABLED = '2'
+}
+
+export type EnableStatusValue = `${EnableStatus}`;

src/service/enums/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Service enums
+ *
+ * All service related enums
+ */
+
+export * from './common';
+export * from './system-manage';

src/service/enums/system-manage.ts

@@ -0,0 +1,46 @@
+/** System manage enums */
+
+/**
+ * User gender
+ *
+ * - "1": male
+ * - "2": female
+ */
+export enum UserGender {
+  /** Male */
+  MALE = '1',
+  /** Female */
+  FEMALE = '2'
+}
+
+export type UserGenderValue = `${UserGender}`;
+
+/**
+ * Menu type
+ *
+ * - "1": directory
+ * - "2": menu
+ */
+export enum MenuType {
+  /** Directory */
+  DIRECTORY = '1',
+  /** Menu */
+  MENU = '2'
+}
+
+export type MenuTypeValue = `${MenuType}`;
+
+/**
+ * Icon type
+ *
+ * - "1": iconify icon
+ * - "2": local icon
+ */
+export enum IconType {
+  /** Iconify icon */
+  ICONIFY = '1',
+  /** Local icon */
+  LOCAL = '2'
+}
+
+export type IconTypeValue = `${IconType}`;

src/service/types/auth.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Namespace Api.Auth
+ *
+ * Backend api module: "auth"
+ */
+declare namespace Api {
+  namespace Auth {
+    interface LoginToken {
+      refreshToken: string;
+      token: string;
+    }
+
+    interface UserInfo {
+      buttons: string[];
+      roles: string[];
+      userId: string;
+      userName: string;
+    }
+
+    type Info = {
+      token: LoginToken['token'];
+      userInfo: UserInfo;
+    };
+  }
+}

src/service/types/common.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Namespace Api.Common
+ *
+ * Common types and utilities
+ */
+declare namespace Api {
+  namespace Common {
+    /** common params of paginating */
+    interface PaginatingCommonParams {
+      /** current page number */
+      current: number;
+      /** page size */
+      size: number;
+      /** total count */
+      total: number;
+    }
+
+    /** common params of paginating query list data */
+    interface PaginatingQueryRecord<T = any> extends PaginatingCommonParams {
+      records: T[];
+    }
+
+    type CommonSearchParams = Pick<Common.PaginatingCommonParams, 'current' | 'size'>;
+
+    /**
+     * enable status
+     *
+     * - "1": enabled
+     * - "2": disabled
+     */
+    type EnableStatus = import('../enums').EnableStatusValue;
+
+    /** common record */
+    type CommonRecord<T = any> = {
+      /** record creator */
+      createBy: string;
+      /** record create time */
+      createTime: string;
+      /** record id */
+      id: number;
+      /** record status */
+      status: EnableStatus | null;
+      /** record updater */
+      updateBy: string;
+      /** record update time */
+      updateTime: string;
+    } & T;
+  }
+}

src/service/types/route.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Namespace Api.Route
+ *
+ * Backend api module: "route"
+ */
+declare namespace Api {
+  namespace Route {
+    type ElegantConstRoute = import('@soybean-react/vite-plugin-react-router').ElegantConstRoute;
+
+    interface MenuRoute extends ElegantConstRoute {
+      id: string;
+    }
+
+    interface UserRoute {
+      home: import('@soybean-react/vite-plugin-react-router').LastLevelRouteKey;
+      routes: string[];
+    }
+  }
+}

src/types/api.d.ts renamed to src/service/types/system-manage.d.ts

@@ -1,99 +1,9 @@
 /**
- * Namespace Api
+ * Namespace Api.SystemManage
  *
- * All backend api type
+ * Backend api module: "systemManage"
  */
 declare namespace Api {
-  namespace Common {
-    /** common params of paginating */
-    interface PaginatingCommonParams {
-      /** current page number */
-      current: number;
-      /** page size */
-      size: number;
-      /** total count */
-      total: number;
-    }
-
-    /** common params of paginating query list data */
-    interface PaginatingQueryRecord<T = any> extends PaginatingCommonParams {
-      records: T[];
-    }
-
-    type CommonSearchParams = Pick<Common.PaginatingCommonParams, 'current' | 'size'>;
-
-    /**
-     * enable status
-     *
-     * - "1": enabled
-     * - "2": disabled
-     */
-    type EnableStatus = '1' | '2';
-
-    /** common record */
-    type CommonRecord<T = any> = {
-      /** record creator */
-      createBy: string;
-      /** record create time */
-      createTime: string;
-      /** record id */
-      id: number;
-      /** record status */
-      status: EnableStatus | null;
-      /** record updater */
-      updateBy: string;
-      /** record update time */
-      updateTime: string;
-    } & T;
-  }
-
-  /**
-   * namespace Auth
-   *
-   * backend api module: "auth"
-   */
-  namespace Auth {
-    interface LoginToken {
-      refreshToken: string;
-      token: string;
-    }
-
-    interface UserInfo {
-      buttons: string[];
-      roles: string[];
-      userId: string;
-      userName: string;
-    }
-
-    type Info = {
-      token: LoginToken['token'];
-      userInfo: UserInfo;
-    };
-  }
-
-  /**
-   * namespace Route
-   *
-   * backend api module: "route"
-   */
-  namespace Route {
-    type ElegantConstRoute = import('@soybean-react/vite-plugin-react-router').ElegantConstRoute;
-
-    interface MenuRoute extends ElegantConstRoute {
-      id: string;
-    }
-
-    interface UserRoute {
-      home: import('@soybean-react/vite-plugin-react-router').LastLevelRouteKey;
-      routes: string[];
-    }
-  }
-
-  /**
-   * namespace SystemManage
-   *
-   * backend api module: "systemManage"
-   */
   namespace SystemManage {
     type CommonSearchParams = Pick<Common.PaginatingCommonParams, 'current' | 'size'>;
 
@@ -121,10 +31,10 @@ declare namespace Api {
     /**
      * user gender
      *
-     * - "1": "male"
-     * - "2": "female"
+     * - "1": male
+     * - "2": female
      */
-    type UserGender = '1' | '2';
+    type UserGender = import('../enums').UserGenderValue;
 
     /** user */
     type User = Common.CommonRecord<{
@@ -157,7 +67,7 @@ declare namespace Api {
      * - "1": directory
      * - "2": menu
      */
-    type MenuType = '1' | '2';
+    type MenuType = import('../enums').MenuTypeValue;
 
     type MenuButton = {
       /**
@@ -176,7 +86,7 @@ declare namespace Api {
      * - "1": iconify icon
      * - "2": local icon
      */
-    type IconType = '1' | '2';
+    type IconType = import('../enums').IconTypeValue;
 
     type MenuPropsOfRoute = Pick<
       import('@soybean-react/vite-plugin-react-router').RouteMeta,