@natrave/shared-entities 1.1.1

package/.changeset/README.md

@@ -0,0 +1,9 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool
+that works with multi-package repos, or single-package repos to help you version and publish your
+code. You can find the full documentation for it
+[in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/release.yml

@@ -0,0 +1,80 @@
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Criar Release & Publicar no npm
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 🚀 Checkout do código
+        uses: actions/checkout@v4
+
+      - name: 📦 Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: 🔑 Ativar e preparar Corepack (pnpm)
+        run: |
+          corepack enable
+          corepack prepare pnpm@latest --activate
+
+      - name: 📥 Instalar dependências
+        run: pnpm install --frozen-lockfile
+
+      - name: 🔎 Rodar lint e checagem de tipos
+        run: |
+          pnpm lint
+          pnpm check:types
+
+      - name: 🚀 Criar versão se necessário
+        id: version
+        run: pnpm changeset version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🔄 Commitar alterações de versão
+        run: |
+          # Configurar usuário do Git para o commit
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Adicionar todas as alterações
+          git add .
+
+          # Verificar se há alterações para commit
+          if git diff-index --quiet HEAD; then
+            echo "✅ Nenhuma alteração para commitar."
+          else
+            # Commitar as alterações
+            git commit -m "chore(release): commit version bump e changesets"
+            # Fazer push para a branch atual
+            git push origin HEAD:${{ github.ref }}
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: ⏭️ Pular publicação se não houver mudanças
+        if: steps.version.outputs.skipped == 'true'
+        run: echo "🟡 Nenhuma mudança detectada, pulando publicação."
+
+      - name: 🔍 Verificar se NPM_TOKEN está configurado
+        run: |
+          if [ -z "$NODE_AUTH_TOKEN" ]; then
+            echo "❌ NPM_TOKEN não está configurado corretamente!"
+            exit 1
+          else
+            echo "✅ NPM_TOKEN está configurado corretamente."
+          fi
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: 📦 Publicar no npm
+        if: steps.version.outputs.skipped != 'true'
+        run: pnpm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+echo "🔍 Rodando Lint-Staged..."
+pnpm exec lint-staged || (echo "❌ Lint-Staged falhou! Corrija os erros antes de commitar." && exit 1)
+
+echo "✅ Código validado com sucesso! Commit permitido."

package/.husky/pre-push

@@ -0,0 +1,4 @@
+echo "🔍 Rodando Lint antes do push..."
+pnpm lint || (echo "❌ Lint falhou! Corrija os erros antes de fazer push." && exit 1)
+
+echo "✅ Código validado com sucesso! Push permitido."

package/.lintstagedrc.json

@@ -0,0 +1,5 @@
+{
+  "**/*.ts": ["eslint --fix --cache --max-warnings=0", "prettier --write"],
+  "*.json": ["prettier --write"],
+  "*.md": ["prettier --write"]
+}

package/.prettierignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

package/.prettierrc.json

@@ -0,0 +1,12 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "semi": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "quoteProps": "preserve",
+  "proseWrap": "always"
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @natrave/shared-entities
+
+## 1.1.1
+
+### Patch Changes
+
+- 56516cc: build
+
+## 1.1.0
+
+### Minor Changes
+
+- 3db4aa9: entidades iniciais

package/eslint.config.js

@@ -0,0 +1,84 @@
+import js from '@eslint/js';
+import tseslint from '@typescript-eslint/eslint-plugin';
+import tsparser from '@typescript-eslint/parser';
+import prettier from 'eslint-plugin-prettier';
+import importPlugin from 'eslint-plugin-import';
+import unusedImports from 'eslint-plugin-unused-imports';
+
+export default [
+  js.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parser: tsparser,
+      sourceType: 'module',
+      parserOptions: {
+        project: ['./tsconfig.json'],
+      },
+    },
+    ignores: ['**/*.d.ts', 'dist/', 'node_modules/'],
+    plugins: {
+      '@typescript-eslint': tseslint,
+      prettier,
+      import: importPlugin,
+      'unused-imports': unusedImports,
+    },
+    settings: {
+      'import/resolver': {
+        typescript: {
+          project: './tsconfig.json',
+        },
+        node: {
+          extensions: ['.js', '.ts'],
+        },
+      },
+    },
+    rules: {
+      'prettier/prettier': 'error',
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+        },
+      ],
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/consistent-type-imports': 'error',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      'import/extensions': [
+        'error',
+        'ignorePackages',
+        {
+          js: 'never',
+          ts: 'never',
+        },
+      ],
+      'import/order': [
+        'error',
+        {
+          groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+          'newlines-between': 'always',
+          alphabetize: { order: 'asc', caseInsensitive: true },
+        },
+      ],
+      'import/no-unresolved': 'error',
+      'import/no-absolute-path': 'error',
+      'import/no-duplicates': 'error',
+      'import/no-extraneous-dependencies': [
+        'error',
+        {
+          devDependencies: ['**/*.test.ts', '**/*.spec.ts'],
+        },
+      ],
+      'unused-imports/no-unused-imports': 'error',
+      'unused-imports/no-unused-vars': [
+        'warn',
+        { vars: 'all', args: 'after-used', argsIgnorePattern: '^_' },
+      ],
+    },
+  },
+];

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@natrave/shared-entities",
+  "version": "1.1.1",
+  "description": "Entidades compartilhadass da NaTrave",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/na-trave/shared-entities.git"
+  },
+  "keywords": [
+    "typescript",
+    "shared-entities",
+    "natrave"
+  ],
+  "author": "NaTrave!",
+  "license": "MIT",
+  "private": false,
+  "devDependencies": {
+    "@changesets/cli": "^2.28.1",
+    "@eslint/js": "^9.23.0",
+    "@typescript-eslint/eslint-plugin": "^8.27.0",
+    "@typescript-eslint/parser": "^8.27.0",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-import-resolver-typescript": "^4.2.2",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.4",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.0",
+    "prettier": "^3.5.3",
+    "ts-node": "^10.9.2"
+  },
+  "dependencies": {
+    "@natrave/tournaments-service-types": "^1.1.0",
+    "reflect-metadata": "^0.2.2",
+    "typeorm": "^0.3.21"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "lint": "eslint src --ext .ts",
+    "check:types": "tsc --noEmit"
+  }
+}

package/src/app-auth/index.ts

@@ -0,0 +1,5 @@
+export * from './password-resets';
+export * from './refresh-tokens';
+export * from './user-auth-providers';
+export * from './user-verifications';
+export * from './users';

package/src/app-auth/password-resets/index.ts

@@ -0,0 +1 @@
+export { PasswordReset } from './password-reset.entity';

package/src/app-auth/password-resets/password-reset.entity.ts

@@ -0,0 +1,52 @@
+import {
+  Entity,
+  Column,
+  PrimaryGeneratedColumn,
+  CreateDateColumn,
+  ManyToOne,
+  JoinColumn,
+  Unique,
+} from 'typeorm';
+
+import { User } from 'app-auth/users';
+
+/**
+ * Entidade que representa um reset de senha.
+ *
+ * @remarks
+ * Esta entidade armazena os dados relacionados ao processo de reset de senha de um usuário,
+ * incluindo a data de criação, expiração e o momento em que o reset foi utilizado (se aplicável).
+ * Também associa o reset ao respectivo usuário, garantindo a integridade da operação.
+ *
+ * @public
+ */
+@Entity('password_resets')
+@Unique(['token', 'userId'])
+export class PasswordReset {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn({ name: 'created_at', type: 'timestamptz' })
+  createdAt: Date;
+
+  @Column({ name: 'expires_at', type: 'timestamptz' })
+  expiresAt: Date;
+
+  @Column({ name: 'used_at', type: 'timestamptz', nullable: true })
+  usedAt: Date | null;
+
+  @Column({ name: 'user_id', type: 'uuid' })
+  userId: string;
+
+  @Column({ type: 'varchar', length: 255 })
+  token: string;
+
+  /** RELAÇÕES */
+
+  /**
+   * Relação com o usuário ao qual o reset de senha está associado.
+   */
+  @ManyToOne(() => User, (user) => user.passwordResets, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'user_id' })
+  user: User;
+}

package/src/app-auth/refresh-tokens/index.ts

@@ -0,0 +1 @@
+export { RefreshToken } from './refresh-token.entity';

package/src/app-auth/refresh-tokens/refresh-token.entity.ts

@@ -0,0 +1,52 @@
+import {
+  Entity,
+  Column,
+  PrimaryGeneratedColumn,
+  CreateDateColumn,
+  ManyToOne,
+  Unique,
+  JoinColumn,
+} from 'typeorm';
+
+import { User } from 'app-auth/users';
+
+/**
+ * Entidade que representa um refresh token.
+ *
+ * @remarks
+ * Esta entidade armazena os dados relativos a um token de atualização utilizado para manter
+ * a sessão de um usuário ativa. Ela inclui a data de criação, expiração, e a data de revogação
+ * (caso aplicável), além de armazenar o token propriamente dito e sua associação com um usuário.
+ *
+ * @public
+ */
+@Entity('refresh_tokens')
+@Unique(['token'])
+export class RefreshToken {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @CreateDateColumn({ name: 'created_at', type: 'timestamptz' })
+  createdAt: Date;
+
+  @Column({ name: 'expires_at', type: 'timestamptz' })
+  expiresAt: Date;
+
+  @Column({ name: 'revoked_at', type: 'timestamptz', nullable: true })
+  revokedAt: Date | null;
+
+  @Column({ type: 'varchar', length: 255, unique: true })
+  token: string;
+
+  @Column({ name: 'user_id', type: 'uuid' })
+  userId: string;
+
+  /** RELAÇÕES */
+
+  /**
+   * Relação com o usuário ao qual o refresh token pertence.
+   */
+  @ManyToOne(() => User, (user) => user.refreshTokens, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'user_id' })
+  user: User;
+}

package/src/app-auth/user-auth-providers/enums/auth-provider.enum.ts

@@ -0,0 +1,24 @@
+/**
+ * Enum que representa os provedores de autenticação.
+ *
+ * @remarks
+ * Este enum fornece valores para identificar o provedor de autenticação utilizado pelo usuário.
+ *
+ * @public
+ */
+export enum AuthProvider {
+  /**
+   * Provedor de autenticação do Google.
+   */
+  GOOGLE = 'google',
+
+  /**
+   * Provedor de autenticação do Meta.
+   */
+  META = 'meta',
+
+  /**
+   * Provedor de autenticação da Apple.
+   */
+  APPLE = 'apple',
+}

package/src/app-auth/user-auth-providers/index.ts

@@ -0,0 +1,3 @@
+export { AuthProvider } from './enums/auth-provider.enum';
+
+export { UserAuthProvider } from './user-auth-provider.entity';

package/src/app-auth/user-auth-providers/user-auth-provider.entity.ts

@@ -0,0 +1,58 @@
+import {
+  Entity,
+  Column,
+  PrimaryGeneratedColumn,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  JoinColumn,
+  Unique,
+} from 'typeorm';
+
+import { User } from 'app-auth/users';
+
+import { AuthProvider } from './enums/auth-provider.enum';
+
+/**
+ * Entidade que representa um provedor de autenticação associado a um usuário.
+ *
+ * @remarks
+ * Esta entidade armazena os dados relacionados aos provedores de autenticação, incluindo o token do provedor,
+ * o identificador do usuário no provedor e a associação com o usuário local.
+ * Uma combinação única de provider e providerUserId é garantida para evitar duplicatas.
+ *
+ * @public
+ */
+@Entity('user_auth_providers')
+@Unique(['provider', 'providerUserId'])
+export class UserAuthProvider {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn({ name: 'created_at', type: 'timestamptz' })
+  createdAt: Date;
+
+  @UpdateDateColumn({ name: 'updated_at', type: 'timestamptz' })
+  updatedAt: Date;
+
+  @Column({ name: 'user_id', type: 'uuid' })
+  userId: string;
+
+  @Column({ type: 'enum', enum: AuthProvider })
+  provider: AuthProvider;
+
+  @Column({ name: 'provider_user_id', type: 'text' })
+  providerUserId: string;
+
+  @Column({ name: 'provider_token', type: 'text', nullable: true })
+  providerToken: string | null;
+
+  /** RELAÇÕES */
+
+  /**
+   * Relação com o usuário ao qual o provedor de autenticação está associado.
+   */
+  @ManyToOne(() => User, (user) => user.userAuthProviders, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'user_id' })
+  user: User;
+}

package/src/app-auth/user-verifications/enums/verification-type.enum.ts

@@ -0,0 +1,19 @@
+/**
+ * Enum que representa os tipos de verificação.
+ *
+ * @remarks
+ * Este enum fornece valores para indicar o tipo de verificação de usuário, seja por email ou telefone.
+ *
+ * @public
+ */
+export enum VerificationType {
+  /**
+   * Verificação via email.
+   */
+  EMAIL = 'email',
+
+  /**
+   * Verificação via telefone.
+   */
+  PHONE = 'phone',
+}

package/src/app-auth/user-verifications/index.ts

@@ -0,0 +1,3 @@
+export { VerificationType } from './enums/verification-type.enum';
+
+export { UserVerification } from './user-verification.entity';

package/src/app-auth/user-verifications/user-verification.entity.ts

@@ -0,0 +1,62 @@
+import {
+  Entity,
+  Column,
+  PrimaryGeneratedColumn,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  JoinColumn,
+} from 'typeorm';
+
+import { User } from 'app-auth/users';
+
+import { VerificationType } from './enums/verification-type.enum';
+
+/**
+ * Entidade que representa uma verificação de usuário.
+ *
+ * @remarks
+ * Esta entidade armazena os dados relacionados a uma verificação de usuário, incluindo
+ * as datas de criação, expiração e verificação (se aplicável), o status do token e o tipo
+ * de verificação (por exemplo, email ou telefone). Também associa a verificação ao respectivo usuário.
+ *
+ * @public
+ */
+@Entity('user_verifications')
+export class UserVerification {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn({ name: 'created_at', type: 'timestamptz' })
+  createdAt: Date;
+
+  @UpdateDateColumn({ name: 'updated_at', type: 'timestamptz' })
+  updatedAt: Date;
+
+  @Column({ name: 'expires_at', type: 'timestamptz' })
+  expiresAt: Date;
+
+  @Column({ name: 'verified_at', type: 'timestamptz', nullable: true })
+  verifiedAt: Date | null;
+
+  @Column({ type: 'boolean', default: false })
+  isInvalid: boolean;
+
+  @Column({ type: 'varchar', length: 255, unique: true })
+  token: string;
+
+  @Column({ name: 'user_id', type: 'uuid' })
+  userId: string;
+
+  @Column({ type: 'enum', enum: VerificationType })
+  type: VerificationType;
+
+  /** RELAÇÕES */
+
+  /**
+   * Relação com o usuário ao qual a verificação está associada.
+   */
+  @ManyToOne(() => User, (user) => user.verifications, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'user_id' })
+  user: User;
+}

package/src/app-auth/users/index.ts

@@ -0,0 +1 @@
+export { User } from './user.entity';