hula-emojis 1.2.2 → 1.2.4
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.
- package/CHANGELOG.md +9 -1
- package/LICENSE.md +21 -0
- package/README.md +104 -11
- package/hula-emojis.d.ts +9 -0
- package/package.json +6 -5
package/CHANGELOG.md
CHANGED
package/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 HulaSpark
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,14 +1,107 @@
|
|
|
1
|
-
---
|
|
2
|
-
Author: 目棃
|
|
3
|
-
Description: 说明文档
|
|
4
|
-
Date: 2024-12-10
|
|
5
|
-
Update: 2024-12-11
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
> 本文档 [`Frontmatter`](https://github.com/BTMuli/MuCli#Frontmatter) 由 [MuCli](https://github.com/BTMuli/Mucli) 自动生成于 `2024-12-10 15:46:35`
|
|
9
|
-
>
|
|
10
|
-
> 更新于 `2024-12-11 09:57:47`
|
|
11
|
-
|
|
12
1
|
# HuLa-Emojis
|
|
13
2
|
|
|
3
|
+
[](https://npmjs.org/package/hula-emojis)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
14
8
|
HuLa 表情包数据。
|
|
9
|
+
|
|
10
|
+
## 使用
|
|
11
|
+
|
|
12
|
+
```shell
|
|
13
|
+
pnpm i hula-emojis
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import HulaEmojis from "hula-emojis";
|
|
18
|
+
|
|
19
|
+
const emojisBbs = HulaEmojis.MihoyoBbs;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## 类型声明
|
|
23
|
+
|
|
24
|
+
详见 [hula-emojis.d.ts](./hula-emojis.d.ts)。
|
|
25
|
+
|
|
26
|
+
单个表情包的数据结构如下：
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
/**
|
|
30
|
+
* @description 单个表情包类型
|
|
31
|
+
* @since 1.0.0
|
|
32
|
+
* @type HulaEmojiItem
|
|
33
|
+
* @property {string} name 表情包名称
|
|
34
|
+
* @property {string} identifier 表情包标识符
|
|
35
|
+
* @property {string} url 表情包地址
|
|
36
|
+
* @property [string] staticUrl 静态表情包地址
|
|
37
|
+
* @property [number] id 表情包ID
|
|
38
|
+
* @property [number] sortOrder 排序序号
|
|
39
|
+
*/
|
|
40
|
+
type HulaEmojiItem = {
|
|
41
|
+
name: string;
|
|
42
|
+
identifier: string;
|
|
43
|
+
url: string;
|
|
44
|
+
staticUrl?: string;
|
|
45
|
+
id?: number;
|
|
46
|
+
sortOrder?: number;
|
|
47
|
+
};
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
表情包系列的数据结构如下：
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
/**
|
|
54
|
+
* @description 表情包系列类型
|
|
55
|
+
* @since 1.0.0
|
|
56
|
+
* @type HulaEmojiSeries
|
|
57
|
+
* @property {string} name 表情包系列名称
|
|
58
|
+
* @property {string} identifier 表情包系列标识符
|
|
59
|
+
* @property {number} num 表情包数量
|
|
60
|
+
* @property {string} cover 表情包封面
|
|
61
|
+
* @property [number] sortOrder 排序序号
|
|
62
|
+
* @property [number] id 系列ID
|
|
63
|
+
* @property {HulaEmojiItem[]} emojis 表情包列表
|
|
64
|
+
*/
|
|
65
|
+
type HulaEmojiSeries = {
|
|
66
|
+
name: string;
|
|
67
|
+
identifier: string;
|
|
68
|
+
num: number;
|
|
69
|
+
cover: string;
|
|
70
|
+
sortOrder?: number;
|
|
71
|
+
id?: number;
|
|
72
|
+
emojis: HulaEmojiItem[];
|
|
73
|
+
};
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
按平台分类的表情包数据结构如下：
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
/**
|
|
80
|
+
* @description 表情包元数据类型
|
|
81
|
+
* @since 1.0.0
|
|
82
|
+
* @type HulaEmojiData
|
|
83
|
+
* @property {string} name 平台名称
|
|
84
|
+
* @property {string} version 版本号
|
|
85
|
+
* @property {HulaEmojiType} identifier 平台标识符
|
|
86
|
+
* @property {number} updateTime 更新时间
|
|
87
|
+
* @property {HulaEmojiSeries[]} series 表情包系列列表
|
|
88
|
+
* @return HulaEmojiData
|
|
89
|
+
*/
|
|
90
|
+
type HulaEmojiData = {
|
|
91
|
+
name: string;
|
|
92
|
+
version: string;
|
|
93
|
+
identifier: HulaEmojiType;
|
|
94
|
+
updateTime: number;
|
|
95
|
+
series: HulaEmojiSeries[];
|
|
96
|
+
};
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
目前来源平台有：
|
|
100
|
+
|
|
101
|
+
- [米游社](https://bbs.mihoyo.com/ys/)
|
|
102
|
+
- [Bilibili](https://www.bilibili.com/)
|
|
103
|
+
- [知乎](https://www.zhihu.com/)
|
|
104
|
+
|
|
105
|
+
## LICENSE
|
|
106
|
+
|
|
107
|
+
项目遵循 [MIT License](./LICENSE.md) 开源协议。
|
package/hula-emojis.d.ts
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
* @property [string] staticUrl 静态表情包地址
|
|
15
15
|
* @property [number] id 表情包ID
|
|
16
16
|
* @property [number] sortOrder 排序序号
|
|
17
|
+
* @return HulaEmojiItem
|
|
17
18
|
*/
|
|
18
19
|
declare type HulaEmojiItem = {
|
|
19
20
|
name: string;
|
|
@@ -35,6 +36,7 @@ declare type HulaEmojiItem = {
|
|
|
35
36
|
* @property [number] sortOrder 排序序号
|
|
36
37
|
* @property [number] id 系列ID
|
|
37
38
|
* @property {HulaEmojiItem[]} emojis 表情包列表
|
|
39
|
+
* @return HulaEmojiSeries
|
|
38
40
|
*/
|
|
39
41
|
export declare type HulaEmojiSeries = {
|
|
40
42
|
name: string;
|
|
@@ -70,6 +72,13 @@ export declare type HulaEmojiType = keyof typeof HulaEmojiTypeEnum;
|
|
|
70
72
|
/**
|
|
71
73
|
* @description 表情包元数据类型
|
|
72
74
|
* @since 1.0.0
|
|
75
|
+
* @type HulaEmojiData
|
|
76
|
+
* @property {string} name 平台名称
|
|
77
|
+
* @property {string} version 版本号
|
|
78
|
+
* @property {HulaEmojiType} identifier 平台标识符
|
|
79
|
+
* @property {number} updateTime 更新时间
|
|
80
|
+
* @property {HulaEmojiSeries[]} series 表情包系列列表
|
|
81
|
+
* @return HulaEmojiData
|
|
73
82
|
*/
|
|
74
83
|
export declare type HulaEmojiData = {
|
|
75
84
|
name: string;
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hula-emojis",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.4",
|
|
4
4
|
"description": "The emojis package of Hula",
|
|
5
5
|
"main": "dist/data.json",
|
|
6
6
|
"types": "hula-emojis.d.ts",
|
|
7
7
|
"type": "module",
|
|
8
|
-
"packageManager": "pnpm@9.15.
|
|
8
|
+
"packageManager": "pnpm@9.15.4",
|
|
9
9
|
"scripts": {
|
|
10
10
|
"status": "tsx scripts/status.mts",
|
|
11
11
|
"build": "tsx scripts/build.mts && tsx scripts/status.mts",
|
|
@@ -20,16 +20,17 @@
|
|
|
20
20
|
"dist",
|
|
21
21
|
"CHANGELOG.md",
|
|
22
22
|
"README.md",
|
|
23
|
-
"hula-emojis.d.ts"
|
|
23
|
+
"hula-emojis.d.ts",
|
|
24
|
+
"LICENSE.md"
|
|
24
25
|
],
|
|
25
26
|
"devDependencies": {
|
|
26
27
|
"@types/fs-extra": "^11.0.4",
|
|
27
28
|
"fs-extra": "^11.2.0",
|
|
28
29
|
"ora": "^8.1.1",
|
|
29
|
-
"@types/node": "^22.10.
|
|
30
|
+
"@types/node": "^22.10.6",
|
|
30
31
|
"app-root-path": "^3.1.0",
|
|
31
32
|
"axios": "^1.7.9",
|
|
32
33
|
"tsx": "^4.19.2",
|
|
33
|
-
"typescript": "^5.7.
|
|
34
|
+
"typescript": "^5.7.3"
|
|
34
35
|
}
|
|
35
36
|
}
|