@utsp/types 0.17.3 → 0.17.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/README.md +26 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,36 +1,43 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# @utsp/types
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
> This package is currently in early development and should **NOT** be used in production.
|
|
6
|
-
> The API is unstable and subject to breaking changes without notice.
|
|
5
|
+
[](https://www.npmjs.com/package/@utsp/types)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Visit [**UTSP.dev**](https://utsp.dev/) for more information.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
The **Type definitions** for UTSP. This package contains shared interfaces, enums, and utility types used across the entire ecosystem to ensure type safety and consistency.
|
|
11
15
|
|
|
12
|
-
|
|
16
|
+
> [!WARNING]
|
|
17
|
+
> **PROTOTYPE - NOT READY FOR PRODUCTION**
|
|
18
|
+
> This package is under active development. The API is unstable and subject to breaking changes.
|
|
13
19
|
|
|
14
|
-
|
|
20
|
+
> [!NOTE]
|
|
21
|
+
> **Source Code Availability**
|
|
22
|
+
> While this package is licensed under MIT, the source code is currently being finalized for public release. It will be available on GitHub in the coming months.
|
|
15
23
|
|
|
16
|
-
|
|
17
|
-
- ❌ No documentation available yet
|
|
18
|
-
- ❌ Breaking changes expected
|
|
19
|
-
- ❌ Not recommended for production use
|
|
24
|
+
## ✨ Features
|
|
20
25
|
|
|
21
|
-
|
|
26
|
+
- **🧩 Core Interfaces**: Standardized definitions for the ecosystem.
|
|
27
|
+
- **📡 Network Schemas**: Types for binary packets and events.
|
|
28
|
+
- **⌨️ Input Definitions**: Strongly typed input schemas.
|
|
29
|
+
- **📦 Zero Dependencies**: Lightweight and safe for any target.
|
|
22
30
|
|
|
23
|
-
## Installation
|
|
31
|
+
## 📦 Installation
|
|
24
32
|
|
|
25
33
|
```bash
|
|
26
34
|
npm install @utsp/types
|
|
27
35
|
```
|
|
28
36
|
|
|
29
|
-
##
|
|
37
|
+
## 📖 Documentation
|
|
30
38
|
|
|
31
|
-
|
|
32
|
-
- [Issues](https://github.com/thp-software/utsp/issues)
|
|
39
|
+
For detailed guides on the protocol and application development, visit the official [**Documentation**](https://docs.utsp.dev/introduction).
|
|
33
40
|
|
|
34
|
-
## License
|
|
41
|
+
## 📄 License
|
|
35
42
|
|
|
36
|
-
MIT ©
|
|
43
|
+
MIT © 2026 [THP Software](https://github.com/thp-software)
|