emoji-kitchen-data 0.0.1

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/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Jakub Grzywacz
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ of this software and associated documentation files (the "Software"), to deal
6
+ in the Software without restriction, including without limitation the rights
7
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in all
12
+ copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,105 @@
1
+ # Emoji Kitchen Data
2
+
3
+ This library provides a up-to-date version of emoji combinations from Google's Emoji Kitchen in JSON format, for easier use and analysis. [Learn more](https://emojipedia.org/emoji-kitchen).
4
+
5
+ ## Details
6
+
7
+ To save space, these files mostly store unique combinations. Therefore, to check if a specific combination exists, you need to look for it in both possible orders (e.g., 😃 and 😀 are stored only as the pair 😀 and 😃).
8
+
9
+ ## Files
10
+
11
+ `data.json`:
12
+
13
+ ```json
14
+ {
15
+ "emojis": [
16
+ {
17
+ "emoji": "😀",
18
+ "id": 1
19
+ },
20
+ {
21
+ "emoji": "😃",
22
+ "id": 2
23
+ }
24
+ ],
25
+ "combinations": [
26
+ {
27
+ "id": 1,
28
+ "emojiIds": [
29
+ 1, 2, 3
30
+ // ...
31
+ ]
32
+ },
33
+ {
34
+ "id": 2,
35
+ "emojiIds": [
36
+ 2, 3, 4
37
+ // ...
38
+ ]
39
+ }
40
+ ],
41
+ "categories": [
42
+ {
43
+ "name": "Smileys and emotions",
44
+ "startEmojiId": 1
45
+ },
46
+ {
47
+ "name": "People",
48
+ "startEmojiId": 163
49
+ }
50
+ // ...
51
+ ]
52
+ }
53
+ ```
54
+
55
+ `data-by-emoji.json`:
56
+
57
+ ```json
58
+ {
59
+ "😀": {
60
+ "category": "Smileys and emotions",
61
+ "combinations": [
62
+ "😀",
63
+ "😃",
64
+ "😄"
65
+ // ...
66
+ ]
67
+ },
68
+ "😃": {
69
+ "category": "Smileys and emotions",
70
+ "combinations": [
71
+ "😃",
72
+ "😄",
73
+ "😁"
74
+ // ...
75
+ ]
76
+ }
77
+ // ...
78
+ }
79
+ ```
80
+
81
+ ## Development
82
+
83
+ 1. `yarn install`
84
+
85
+ Install dependencies.
86
+
87
+ 2. `.env`
88
+
89
+ Copy `.env.example` to `.env` and update the API URL.
90
+
91
+ 2. `yarn run update`
92
+
93
+ Executes all commands in order:
94
+
95
+ - `yarn run download`: downloads the latest data dump from the API,
96
+ - `yarn run convert`: converts downloaded file from `.pb` to human readable `.json`,
97
+ - `yarn run process`: process the file to `data.json` and `data-by-emoji.json`.
98
+
99
+ ## License
100
+
101
+ The source code for this project is open-sourced under the MIT License. See the [LICENSE](/LICENSE) file for details.
102
+
103
+ ## Disclaimer
104
+
105
+ This project is not affiliated with or officially endorsed by Google.