vsrepo 1.2.2 → 1.2.4

package/README.md

@@ -1,7 +1,7 @@
 # VSRepository
 
 ![npm](https://img.shields.io/npm/v/vsrepo?style=flat-square)
-![license](https://img.shields.io/github/license/jaobrabo123/vsrepository?style=flat-square&v=1)
+![NPM License](https://img.shields.io/npm/l/vsrepo)
 ![NPM Downloads](https://img.shields.io/npm/d18m/vsrepo.svg)
 
 Biblioteca de repository pattern para projetos que usam **Prisma**, com suporte completo a **TypeScript** e **type inference** automático.
@@ -497,6 +497,8 @@ Os filtros são sufixos aplicados ao nome do campo dentro do método. O campo em
 | `GreaterThanEqual` | `gte`                 | sim                  |
 | `LessThan`         | `lt`                  | sim                  |
 | `LessThanEqual`    | `lte`                 | sim                  |
+| `Between`          | `gte` + `lte`         | sim (tupla `[min, max]`) |
+| `NotBetween`       | `not.gte` + `not.lte` | sim (tupla `[min, max]`) |
 | `IsNull`           | `null`                | não                  |
 | `IsNotNull`        | `not: null`           | não                  |
 | `IsTrue`           | `true`                | não                  |
@@ -511,6 +513,37 @@ findByEmailStartsWithInsensitive // { email: { startsWith: valor, mode: 'insensi
 findByNomeInsensitive            // { nome: { equals: valor, mode: 'insensitive' } }
 ```
 
+`Between` e `NotBetween` recebem uma **tupla `[minValue, maxValue]`** e são ideais para filtros de intervalo em números, datas ou qualquer campo comparável:
+
+```ts
+methods: {
+  findManyByIdadeBetween:          { map: true },
+  findManyBySalarioNotBetween:     { map: true },
+  findManyByCriadoEmBetween:       { map: true },
+}
+
+// Uso
+await usuarioRepository.findManyByIdadeBetween([18, 65]);
+await usuarioRepository.findManyBySalarioNotBetween([1000, 5000]);
+await usuarioRepository.findManyByCriadoEmBetween([new Date("2024-01-01"), new Date("2024-12-31")]);
+```
+
+Gera (`findManyByIdadeBetween`):
+
+```ts
+{
+  idade: { gte: 18, lte: 65 }
+}
+```
+
+Gera (`findManyBySalarioNotBetween`):
+
+```ts
+{
+  salario: { not: { gte: 1000, lte: 5000 } }
+}
+```
+
 O sufixo `Optional` pode ser adicionado a qualquer campo para tornar o argumento opcional:
 
 ```ts
@@ -621,14 +654,18 @@ Exemplos:
 
 ```ts
 methods: {
-  findByPostagensSomeTituloContains:  { map: true },   // postagens: { some: { titulo: { contains: valor } } }
-  findByPerfilWith:                   { map: true },   // perfil: { is: {} }
-  findByPerfilWithout:                { map: true },   // perfil: { isNot: {} }
-  findByPostagensSome:                { map: true },   // postagens: { some: {} }
-  findByPostagensEveryAtivoIsTrue:    { map: true },   // postagens: { every: { ativo: true } }
+  findByPostagensSomeTituloContains:  { map: true },   // postagens: { some: { titulo: { contains: valor } } } >> (Busca usuários que o título de alguma postagem contém um valor)
+  findByPerfilWithDescricaoIsNotNull: { map: true },   // perfil: { is: { descricao: { not: null } } } >> (Busca usuários em que a descrição do perfil não é nula)
+  findByPerfilWithout:                { map: true },   // perfil: { isNot: {} } >> (Busca usuários sem perfil)
+  findByPostagensSome:                { map: true },   // postagens: { some: {} } >> (Busca usuários com alguma postagem)
+  findByPostagensEveryAtivoIsTrue:    { map: true },   // postagens: { every: { ativo: true } } >> (Busca usuários que todas as postagens estão ativas)
+  findByPostagensNone:                { map: true },   // postagens: { none: {} } >> (Busca usuários sem postagens)
 }
 ```
 
+> [!NOTE]
+> Teoricamente você pode usar `Every` sem `Field` (ele geraria { every: {} }), porém isso não produz um filtro efetivo. A condição é considerada verdadeira para qualquer relação, inclusive quando não existem registros relacionados, tornando o resultado equivalente a não aplicar filtro algum.
+
 ---
 
 ### Sufixos de paginação e ordenação
@@ -1076,10 +1113,11 @@ type UsuarioRepositoryExtended = RepositoryOf<typeof usuarioVSRepo, undefined, t
 
 ### Tipos do payload dos métodos `save` e `patch`
 
-Use `SaveObject` e `PatchObject` para extrair o tipo do payload esperado pelos métodos `save` e `patch` diretamente a partir de uma instância `VSRepository` configurada. Esses tipos já levam em conta as relações configuradas.
+Use `SaveObject` e `PatchObject` para extrair o tipo do payload esperado pelos métodos `save` e `patch` diretamente a partir de uma instância `VSRepository` configurada. Esses tipos combinam o input base do Prisma com as relações configuradas no repository.
 
 ```ts
-import type { SaveObject, PacthObject } from "../../generated/vsrepo";
+import type { SaveObject, PatchObject } from "../../generated/vsrepo";
+import type { Prisma } from "../../generated/prisma/client";
 
 const usuarioVSRepo = setupVSRepo<Usuario, "usuario">()({
   tableName: "usuario",
@@ -1091,10 +1129,10 @@ const usuarioVSRepo = setupVSRepo<Usuario, "usuario">()({
 });
 
 // Tipo do objeto aceito pelo .save()
-type UsuarioSavePayload = SaveObject<typeof usuarioVSRepo>;
+type UsuarioSavePayload = SaveObject<Prisma.UsuarioCreateInput, typeof usuarioVSRepo>;
 
 // Tipo do objeto aceito pelo .patch()
-type UsuarioPatchPayload = PacthObject<typeof usuarioVSRepo>;
+type UsuarioPatchPayload = PatchObject<Prisma.UsuarioUpdateInput, typeof usuarioVSRepo>;
 ```
 
 > Útil para tipar DTOs, funções auxiliares ou serviços que chamam `save`/`patch` e precisam do tipo correto do payload sem referenciar diretamente os tipos internos do Prisma.