@natrave/shared-entities 1.4.12 → 1.4.13

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.
Files changed (2) hide show
  1. package/README.md +52 -0
  2. package/package.json +7 -7
package/README.md ADDED
@@ -0,0 +1,52 @@
1
+ # @natrave/shared-entities
2
+
3
+ Biblioteca de entidades TypeORM utilizadas nos serviços da plataforma **NaTrave**. Agrupa modelos
4
+ que representam torneios, jogadores, times, pagamentos, notificações e outros domínios
5
+ compartilhados.
6
+
7
+ ## Requisitos
8
+
9
+ - Node.js 20+
10
+ - `pnpm` como gerenciador de pacotes
11
+
12
+ ## Instalação
13
+
14
+ ```bash
15
+ pnpm install
16
+ ```
17
+
18
+ ## Build
19
+
20
+ Para gerar os arquivos JavaScript e declarações TypeScript no diretório `dist`:
21
+
22
+ ```bash
23
+ pnpm run build
24
+ ```
25
+
26
+ ## Estrutura
27
+
28
+ As entidades estão organizadas por domínio dentro da pasta `src/`:
29
+
30
+ - `tournaments` – regras e entidades de torneios
31
+ - `players` – informações de jogadores
32
+ - `teams` – composição de times
33
+ - `facilities` – quadras e locais de jogo
34
+ - `notifications` – modelos relacionados a notificações
35
+ - `payments` – objetos de pagamento
36
+ - `coupons` – cupons e promoções
37
+ - `central-auth` e `app-auth` – entidades de autenticação
38
+
39
+ O arquivo `src/index.ts` reexporta todas as entidades para facilitar o consumo por outros pacotes.
40
+
41
+ ## Lint
42
+
43
+ Para verificar o estilo de código com ESLint e Prettier:
44
+
45
+ ```bash
46
+ pnpm run lint
47
+ ```
48
+
49
+ ## Contribuição
50
+
51
+ Pull requests são bem‑vindos. Certifique‑se de executar o lint antes de enviar mudanças e descreva
52
+ no CHANGELOG o que foi alterado.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@natrave/shared-entities",
3
- "version": "1.4.12",
3
+ "version": "1.4.13",
4
4
  "description": "Entidades compartilhadass da NaTrave",
5
5
  "module": "dist/index.js",
6
6
  "main": "dist/index.js",
@@ -27,10 +27,10 @@
27
27
  "devDependencies": {
28
28
  "@changesets/cli": "^2.29.5",
29
29
  "@eslint/js": "^9.30.1",
30
- "@typescript-eslint/eslint-plugin": "^8.35.1",
31
- "@typescript-eslint/parser": "^8.35.1",
32
- "esbuild": "^0.25.5",
33
- "eslint": "^9.30.0",
30
+ "@typescript-eslint/eslint-plugin": "^8.36.0",
31
+ "@typescript-eslint/parser": "^8.36.0",
32
+ "esbuild": "^0.25.6",
33
+ "eslint": "^9.30.1",
34
34
  "eslint-config-prettier": "^10.1.5",
35
35
  "eslint-import-resolver-typescript": "^4.4.4",
36
36
  "eslint-plugin-import": "^2.32.0",
@@ -45,8 +45,8 @@
45
45
  "dependencies": {
46
46
  "@natrave/auth-service-types": "^1.1.63",
47
47
  "@natrave/facility-service-types": "^0.0.9",
48
- "@natrave/notification-service-types": "^1.1.65",
49
- "@natrave/tournaments-service-types": "^1.2.31",
48
+ "@natrave/notification-service-types": "^1.1.68",
49
+ "@natrave/tournaments-service-types": "^1.2.36",
50
50
  "reflect-metadata": "^0.2.2",
51
51
  "typeorm": "^0.3.25"
52
52
  },