UNPKG

@schemifyjs/types

Version:

Tipos compartidos entre los paquetes CLI y Core de SchemifyJS

120 lines (81 loc) • 2.34 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# @schemify/types > 📦 Shared TypeScript contracts and interfaces for the [Schemify](https://github.com/Schemify/schemify-microservice) ecosystem. [English](#english) | [Español](#español) --- ## English ### 📚 Overview `@schemify/types` is the canonical source of shared types and contracts used across all Schemify-based microservices. It ensures strong typing, interoperability, and consistency between: - gRPC DTOs - Kafka messages - Domain events - Common utility types (e.g. pagination, errors) --- ### 📦 Installation ```bash npm install @schemify/types ```` --- ### 🧠 Usage Import types in your microservices or libraries: ```ts import { CreateExampleDto, ExampleEvent } from '@schemify/types'; ``` All types are generated or curated to match the shared protocol contracts defined in the repo [`schemify-microservice`](https://github.com/Schemify/schemify-microservice). --- ### 🔧 Structure ``` @schemify/types ├── grpc/ │ ├── example.proto.ts │ └── ... ├── kafka/ │ ├── events/ │ ├── topics.ts │ └── ... ├── common/ │ ├── pagination.ts │ ├── error.ts │ └── ... └── index.ts ``` --- ## Español ### 📚 Descripción `@schemify/types` es el paquete central de tipos y contratos compartidos entre todos los microservicios basados en Schemify. Asegura un tipado fuerte, interoperabilidad y coherencia entre: * DTOs para gRPC * Mensajes Kafka * Eventos de dominio * Tipos comunes (paginación, errores, etc.) --- ### 📦 Instalación ```bash npm install @schemify/types ``` --- ### 🧠 Uso Importa los tipos en tus microservicios o librerías: ```ts import { CreateExampleDto, ExampleEvent } from '@schemify/types'; ``` Los tipos están alineados con los contratos definidos en el repositorio [`schemify-microservice`](https://github.com/Schemify/schemify-microservice). --- ### 🔧 Estructura ``` @schemify/types ├── grpc/ │ ├── example.proto.ts │ └── ... ├── kafka/ │ ├── events/ │ ├── topics.ts │ └── ... ├── common/ │ ├── pagination.ts │ ├── error.ts │ └── ... └── index.ts ``` --- > ✅ Ideal for monorepos, package sharing, and scalable microservice boundaries.