@airpower/enum 0.0.1 → 0.0.2

package/README.md

@@ -1,10 +1,5 @@
 <p align="center">
-  <img width="300" src="./docs/airpower-bg.svg"/>
-</p>
-
-<p align="center">
-  <img src="https://svg.hamm.cn?key=Lang&value=TypeScript&bg=green"/>
-  <img src="https://svg.hamm.cn?key=Build&value=Vite"/>
+  <img width="300" src="./assets/airpower-bg.svg"/>
 </p>
 
 <p align="center">
@@ -15,36 +10,62 @@
 
 ## 🎉 项目介绍
 
-**AirPower**, 一个基于TypeScript的开发工具包, 内置了枚举字典、i18n国际化、数据转换、装饰器、时间日期处理、加解密与散列、文件处理、常见数据结构处理等工具。
-
-此项目是独立的 **工具包** ，我们还提供了很多的工具包，例如：
-
-- **Vue3+TypeScript+ElementPlus+Vite** 的 **Web开发工具包**，
-  请查看 [AirPower4T](https://github.com/AirPowerTeam/AirPower4T)
-- **[@airpower/web](https://www.npmjs.com/package/@airpower/web)** 适用于 **Web** 开发 (开发中，**AirPower4T** 的重构版)
-- **[@airpower/uniapp](https://www.npmjs.com/package/@airpower/uniapp)** 适用于 **UniApp** 开发 (计划中)
-- **[@airpower/electron](https://www.npmjs.com/package/@airpower/electron)** 适用于 **Electron** 开发 (计划中)
-- **[@airpower/wechat](https://www.npmjs.com/package/@airpower/wechat)** 适用于 **微信小程序** 开发 (计划中)
+**AirPower-Enum** 是一个基于 `TypeScript` 的封装的类似 `Java` 枚举类的枚举字典处理工具。
 
 ## 💻 如何安装
 
 ```shell
-npm install airpower
+npm install @airpower/enum
 # or
-yarn add airpower
+yarn add @airpower/enum
 # or
-cnpm install airpower
+cnpm install @airpower/enum
 # or ...
 ```
 
-## 📖 参考文档
+## 📖 如何使用
+
+```ts
+import {Enum} from "@/airpower/enum";
+
+class UserGender extends Enum<string> {
+    static MALE = new UserGender("MALE", "男");
+    static FEMALE = new UserGender("FEMALE", "女");
+}
+
+class UserStatus extends Enum {
+    static NORMAL = new UserStatus(0, "正常");
+    static DISABLED = new UserStatus(1, "禁用");
+}
 
-**我们提供了一系列的使用文档，你可以 [点击这里阅读](docs/README.md)**
+// 扩展自定义属性
+
+class Platform extends Enum<number> {
+    static readonly MAC = new Platform(1, 'mac', 'apple.png')
+    static readonly WINDOWS = new Platform(2, 'windows', 'windows.png')
+    static readonly ANDROID = new Platform(3, 'android', 'android.png')
+
+    icon!: string
+
+    constructor(key: number, label?: string, icon?: string) {
+        super(key, label)
+        if (icon) {
+            this.icon = icon
+        }
+    }
+
+    static getIcon(this: EnumConstructor<number, Platform>, key: number) {
+        return this.get(key)!.icon
+    }
+}
+
+console.warn(Platform.getIcon(1))
+console.warn(Platform.MAC.icon)
+
+```
 
 ## ⏰ 欢迎反馈
 
 如有疑问，可以通过本仓库的 **Issues** 与我们联系，如果你有一些代码贡献，可以通过 **Pull Request** 将代码贡献，为这个项目添砖加瓦。
 
-> 高司令：“嗯？Java? 什么Java?”
-
 如果有更多的需求和建议，欢迎通过本仓库的 `Issues` 提出，也欢迎加入 QQ群 555156313 与我们及时反馈。

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@airpower/enum",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "AirPower-Enum 是一个基于 TypeScript 的封装的类似 Java 枚举类的枚举字典处理工具。",
   "author": {
     "name": "Hamm",
@@ -31,7 +31,7 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "docs"
+    "assets"
   ],
   "scripts": {
     "build": "tsc && vite build",

package/docs/README.md

@@ -1,9 +0,0 @@
-# 📖 食用文档
-
-- ### [基类](./base.md)
-- ### [配置与常量](./config.md)
-- ### [装饰器](./decorator.md)
-- ### [工具类](./helper.md)
-- ### [枚举字典](./enums.md)
-- ### [i18n](./i18n.md)
-- ### [数据转换](./transformer.md)

package/docs/base.md

@@ -1,140 +0,0 @@
-# 📖 基类
-
-**AirPower** 提供了 `AirPower` `IEntity` 等基类与接口，其中：
-
-## AirPower
-
-`AirPower` 是所有参与数据转换类的基类，它提供了一些基础的属性和方法，如：
-
-### 静态方法
-
-- #### `fromJson` 从 `JSON` 转换到当前类的对象
-
-    ```ts
-    const user = User.fromJson({
-      id: 1,
-      nickName: "Hamm"
-    })
-    ```
-
-- #### `fromJsonArray` 从 `JSON` 数组转换到当前类的对象数组
-
-    ```ts
-    const user = User.fromJsonArray([
-      {
-        id: 1,
-        nickName: "Hamm"
-      },
-      // ...
-    ])
-    ```
-
-- #### `parse` 转换 `JSON` 为实体
-
-    ```ts
-    const user = AirPower.parse(UserEntity, {
-      id: 1,
-    })
-    ```
-- #### `getModelConfig` 获取模型类配置项
-
-    ```ts
-    const modelConfig = UserEntity.getModelConfig()
-    ```
-
-- #### `getModelName` 获取模型类的可阅读名字
-
-    ```ts
-    // 用户
-    const modelName = UserEntity.getModelName()
-    ```
-
-- #### `getFieldName` 获取属性的可阅读名字
-
-    ```ts
-    // 昵称
-    const fieldName = UserEntity.getFieldName("nickName")
-    ```
-
-- #### `getFieldConfig` 获取属性的配置
-
-    ```ts
-    const fieldConfig = UserEntity.getFieldConfig("nickName")
-    ```
-
-- #### `newInstance` 创建一个当前类的实例
-
-    ```ts
-    const user = UserEntity.newInstance({})
-    ```
-
-### 实例方法
-
-- #### `copy` 复制当前对象
-
-    ```ts
-    const user = new User()
-    const user2 = user.copy()
-    ```    
-
-- #### `expose` 暴露指定的一些属性
-
-    ```ts
-    const user = new User()
-    user.expose("id", "nickname")
-    ```
-
-- #### `exclude` 排除指定的一些属性
-
-    ```ts
-    const user = new User()
-    user.exclude("password")
-    ```
-
-- #### `recoverBy` 使用 **JSON** 对象进行相同属性覆盖
-
-    ```ts
-    const user = new User()
-    user.recoverBy({
-        nickname: "Hamm"
-    })
-    ```    
-
-- #### `toJson` 将当前对象转换为 **JSON** 对象
-
-    ```ts
-    const user = new User()
-    const json = user.toJson()
-    ```    
-
-- #### `getModelConfig` 获取类标记的配置
-
-    ```ts
-    const user = new User()
-    const modelConfig = user.getModelConfig()
-    ```
-
-- #### `getModelName` 获取类标记的名称
-
-    ```ts
-    const user = new User()
-    const modelName = user.getModelName()
-    ```
-
-- #### `getFieldName` 获取类属性标记的名称
-
-    ```ts
-    const user = new User()
-    const fieldName = user.getFieldName("nickName")
-    ```
-
-- #### `getFieldConfig` 获取类属性标记的配置
-
-    ```ts
-    const user = new User()
-    const fieldConfig = user.getFieldConfig("nickName")
-    ```
-
-## `IEntity`
-
-`IEntity` 指定包含 `id` 属性。

package/docs/config.md

@@ -1,3 +0,0 @@
-# 📖 配置和常量
-
-`Constant` 中提供了一些常用的配置和常量。

package/docs/decorator.md

@@ -1,75 +0,0 @@
-# 📖 装饰器文档
-
-**AirPower** 提供了一些湿滑的装饰器，对数据转换、类和属性的扩展配置等提供了一些便捷的开发帮助。
-
-## @Model 类配置
-
-可以使用 `@Model()` 为类标记可读的 `label` 以及数据转换时候的统一前缀 `fieldPrefix`：
-
-```typescript
-// 配置装饰器
-@Model({
-  label: '用户',
-  fieldPrefix: 'user_'
-})
-class User extends AirPower {
-  nickname!: string
-
-  age!: number
-}
-
-const config = User.getModelConfig()
-console.log(config)
-```
-
-将正常打印配置的 `label` 和 `fieldPrefix`：
-
-```json
-{
-  "label": "用户",
-  "fieldPrefix": "user_"
-}
-```
-
-- **label**: 类的标签，如 `用户`
-- **fieldPrefix**: 统一属性的前缀，如 `user_`，将在 [数据转换](./transformer.md) 中使用到。
-
-## @Field 属性配置
-
-可以使用 `@Field` 对类的属性进行配置：
-
-```typescript
-class User extends AirPower {
-  @Field({
-    label: '昵称',
-    alias: 'name',
-  })
-  nickname!: string
-
-  @Field({
-    type: Number,
-  })
-  age!: number
-}
-
-const config = User.getFieldConfig('nickname')
-console.log(config)
-```
-
-将正常打印：
-
-```json
-{
-  "label": "昵称",
-  "alias": "name"
-}
-```
-
-### ```@Field()``` 中支持很多数据转换的配置，如：
-
-- **alias**: 属性别名，用于数据转换时候的映射
-- **label**: 属性描述
-- **type**: 属性类型，如 `Number` `String` `RoleEntity` 等，将递归数据转换
-- **array**: 是否是数组类型，将强制转换为数组类型
-- **ignorePrefix**: 这个属性是否忽略类标记的 `fieldPrefix`
-- **enums**: 枚举字典配置，用于数据转换时候的映射

package/docs/enums.md

@@ -1,50 +0,0 @@
-# 📖 枚举和字典
-
-**AirPower** 提供了 `IEnum` `Enum`  类和接口：
-
-## `IEnum`
-
-`IEnum` 定义了标准接口的属性：
-
-- `key` 字典的值
-- `label` [可选]字典的描述
-
-## `Enum`
-
-`Enum` 是一个枚举类，提供了一些枚举封装方法
-
-### 静态方法
-
-- `key` 创建一个只有 Key 的字典数组
-- `label` 创建一个字符串类型 label和key 一样的字典数组
-- `get` 查找枚举值
-- `getLabel` 获取枚举的标签
-- `toArray` 将枚举转为数组
-
-### 属性方法
-
-- `equalsKey` 判断 `Key` 是否相等
-- `notEqualsKey` 判断 `Label` 是否不相等
-
-## 声明枚举
-
-```typescript
-export class GenderEnum extends Enum {
-  static MALE = new GenderEnum(1, '男')
-  static FEMALE = new GenderEnum(2, '女')
-}
-
-export class GenderEnum extends Enum<string> {
-  static MALE = GenderEnum.label('男')
-  static FEMALE = GenderEnum.label('女')
-}
-
-export class GenderEnum extends Enum {
-  static MALE = GenderEnum.key(1)
-  static FEMALE = GenderEnum.key(2)
-}
-```
-
-## 配合装饰器使用
-
-枚举和字典都支持标记到 `@Field` 装饰器的 `enums` 属性上。

package/docs/helper.md

@@ -1,118 +0,0 @@
-# 工具库
-
-**AirPower** 提供了一些常用的工具类，你可以直接使用。
-
-## CryptoUtil 编码和加解密
-
-内置了 `AES加解密`、`SHA1`、`MD5`、`Base64` 等前端常用算法，可直接使用。
-
-```typescript
-CryptoUtil.aesEncrypt()
-CryptoUtil.aesDecrypt()
-CryptoUtil.sha1()
-CryptoUtil.md5()
-CryptoUtil.base64Encode()
-CryptoUtil.base64Decode()
-```
-
-## DateTimeUtil 时间与日期
-
-提供了日期时间在前端常用的一些转换方法：
-
-```typescript
-// 休眠
-await DateTimeUtil.sleep(3000)
-
-// 格式化到Unix秒时间戳(默认当前时间)
-DateTimeUtil.getUnixTimeStamps('2022-02-02 23:59:59')
-
-// 格式化到毫秒时间戳(默认当前时间)
-DateTimeUtil.getMilliTimeStamps('2022-02-02 23:59:59')
-
-// 格式化到友好字符串显示
-DateTimeUtil.getFriendlyDateTime('2022-02-02 23:59:59') // 三天前
-
-// 使用指定的模板格式化
-DateTimeFormatter.YYYY_MM_DD_HH_mm_ss.formatXXX(xxx)
-```
-
-## DecoratorUtil 装饰器
-
-装饰器助手类提供了一些设置和读取配置项的方法：
-
-```typescript
-// 反射添加属性
-DecoratorUtil.setProperty()
-
-// 设置一个类配置项
-DecoratorUtil.setClassConfig()
-
-// 递归获取指定类的配置项
-DecoratorUtil.getClassConfig()
-
-// 设置一个属性配置项
-DecoratorUtil.setFieldConfig()
-
-// 获取类指定属性的指定类型的配置
-DecoratorUtil.getFieldConfig()
-
-// 获取类标记了装饰器的属性列表
-DecoratorUtil.getFieldList()
-
-// 获取目标类指定属性列表的配置项列表
-DecoratorUtil.getFieldConfigList()
-
-// 获取目标类上指定属性的某个配置的值
-DecoratorUtil.getFieldConfigValue()
-```
-
-## FileUtil 文件
-
-提供了一些常用文件处理方法
-
-```typescript
-// 字节数转可读文件大小
-FileUtil.getFileSizeFriendly()
-
-// 获取静态文件的绝对地址
-FileUtil.getAbsoluteFileUrl()
-```
-
-## RandomUtil 随机生成
-
-提供了一些常用随机生成方法
-
-```typescript
-// 指定范围内获取随机整数
-RandomUtil.getRandNumber()
-
-// 获取随机数字字符串
-RandomUtil.getRandNumberString()
-
-// 获取随机字母字符串
-RandomUtil.getRandCharString()
-
-// 获取大小写混合随机字母字符串
-RandomUtil.getRandMixedCharString()
-
-// 获取字母加数字随机字符串
-RandomUtil.getRandNumberAndCharString()
-
-// 获取大小写字母加数字随机字符串
-RandomUtil.getRandNumberAndMixedCharString()
-```
-
-## StringUtil 字符串常见处理
-
-提供了一些字符串处理的常见方法
-
-```typescript
-// 获取字符串可视化长度
-StringUtil.getLength()
-
-// 获取字符串可视化位置的内容
-StringUtil.get()
-
-// 字符串可视化截取
-StringUtil.slice()
-```

package/docs/i18n.md

@@ -1,7 +0,0 @@
-# 📖 i18n 国际化
-
-这个可能和你在其他地方见过的不太一样。
-
-文档先欠着吧，可以先阅读这篇文章：
-
-[i18n国际化前端解决方案引发的关于魔法值的思考](https://juejin.cn/post/7345071716680990720)

package/docs/transformer.md

@@ -1,90 +0,0 @@
-# 📖 数据转换
-
-这一篇是需要重点讲的部分。
-
-## 强制类型和数组
-
-可以通过为 `@Field` 标记 `type` 来强制类型转换。
-
-```typescript
-class User extends AirPower {
-  @Field({
-    type: Number // 强制转换为数字类型
-  })
-  age!: number
-
-  @Field({
-    type: Role // 强制是Role类型
-  })
-  role!: Role
-
-  @Field({
-    type: Department, // 强制是Department类型
-    array: true // 指定是数组
-  })
-  departmentList: Department[] = []
-}
-```
-
-那么，如果使用 `User.fromJson(json)`，那么 `json` 中的数据就会按照标记的装饰器类型进行类型转换。
-
-**请注意，如果非简单类型，一定要标记 `type`，否则无法进行递归转换**
-
-## 别名转换
-
-别名转换适用于突然属性名称的变更，如 `nickname` -> `nickName`
-
-```typescript
-class User extends AirPower {
-  @Field({
-    alias: 'nickName'
-  })
-  nickname!: string
-}
-```
-
-## 固定前缀
-
-有时候，后端提供的数据都带了统一的属性前缀：
-
-```json
-{
-  "user_id": 123,
-  "user_name": "userName",
-  "user_age": 18
-}
-```
-
-此时，我们可以通过类的装饰器 `@Model` 来配置属性前缀：
-
-```typescript
-
-@Model({
-  prefix: 'user_'
-})
-class User extends AirPower {
-  id!: number
-  name!: string
-  age!: number
-}
-```
-
-如果，其中的某个属性不需要前缀，可以通过 `@Field` 的 `ignorePrefix` 来忽略：
-
-```typescript
-
-@Model({
-  prefix: 'user_'
-})
-class User extends AirPower {
-  // 其他需要前缀的属性
-  @Field({
-    ignorePrefix: true
-  })
-  bio!: string
-}
-```
-
-## 自定义转换
-
-`@ToJson` `@ToModel` 可完成自定义转换