prisma-power-types 1.0.0

package/README.md

@@ -0,0 +1,367 @@
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+
+# Prisma Power Types 🚀
+
+Uma coleção de utilitários de TypeScript de alto nível para transformar de forma prática os modelos do Prisma em DTOs (Data Transfer Objects) seguros, dinâmicos e legíveis.
+
+## 📋 Pré-requisitos
+
+Apesar de esta biblioteca não utilizar diretamente nenhuma dependência, seu uso não faz muito sentido fora de ecossistemas que não utilizem o Prisma. Portanto, você vai precisar:
+
+- **TypeScript 4.5+:** Necessário para o suporte a Template Literal Types.
+
+- **Prisma:** Instalado e gerado no projeto (confira a documentação oficial do [Prisma](https://www.prisma.io/docs/)).
+
+## ✨ Motivação
+
+O Prisma gera tipos excelentes, mas criar interfaces de Criação, Atualização ou Filtros manualmente geralmente resulta em código repetitivo ou tipos "sujos" no IntelliSense. Esta biblioteca fornece utilitários que:
+
+1. **Automatizam metadados:** Removem `id` e _timestamps_ (`created_at`, `updated_at`, `deleted_at`).
+
+2. **Refinam a tipagem:** Transformam campos anuláveis em opcionais ou obrigatórios sob demanda.
+
+3. **Melhoram a DX:** Utilizam o utilitário `Prettify` para que você veja o objeto real ao passar o mouse, e não uma colcha de retalhos de `Omit` e `Pick`.
+
+## 📦 Instalação
+
+```bash
+npm i prisma-power-types
+# OU
+yarn add prisma-power-types
+```
+
+## 🛠️ Principais Utilitários
+
+Vamos primeiro definir o seguinte `schema` para os exemplos:
+
+```ini
+enum UserRole {
+  administrator
+  moderator
+  user
+}
+
+model User {
+  id String @id @default(uuid()) @db.Uuid
+
+  cpf String @unique @db.VarChar(11)
+  name String @db.VarChar(100)
+  email String? @unique @db.VarChar(255)
+  password String @db.Char(60)
+  role UserRole @default(user)
+  is_active Boolean @default(true)
+
+  created_at DateTime @default(now())
+  updated_at DateTime @updatedAt
+  deleted_at DateTime?
+}
+
+# Os timestamps precisam terminar com '_at' ou 'At' para que a omissão automática funcione (e.g. 'created_at', 'createdAt'). Eu particularmente prefiro o formato 'snake_case' para Banco de Dados.
+```
+
+> 💡 Aqui definimos `email` como opcional para um sistema de _"soft delete"_. Ao inativar um usuário, tornamos seu email nulo para que possamos reutilizá-lo no registro de novas contas. Isso é útil para empresas que utilizam emails institucionais.
+
+---
+
+### `PrismaElementCreate`
+
+Este utilitário gera um tipo para criação de registros, removendo metadados e permitindo ajustes finos de obrigatoriedade.
+
+```ts
+import { PrismaElementCreate } from 'prisma-power-types';
+import { User } from 'generated/prisma/client';
+
+// As chaves `id` e os timestamps são omitidas automaticamente.
+export type IUserCreate = PrismaElementCreate<
+  User,
+  'password' | 'is_active', // (opcional) Chaves que DEVEM ser para omitidas
+  'email', // (opcional) Chaves que DEVEM ser obrigatórias
+  'role' // (opcional) Chaves que DEVEM ser opcionais
+>;
+
+/**
+ *  O resultado é:
+ *
+ *  type IUserCreate = {
+ *    cpf: string;
+ *    name: string;
+ *    email: string; // Note que o `null` é removido.
+ *    role?: UserRole;
+ *  };
+ */
+```
+
+> **OBS:** O `PrismaElementCreate` substitui o tipo `null` por `undefined` de todas as propriedades restantes, tornando-as opcionais.
+
+### `PrismaElementIdentifier`
+
+Este utilitário gera um tipo que garante que uma busca seja feita exatamente pelo `id` **OU** por um campo único (como CPF ou email), mas nunca ambos ou nenhum.
+
+```ts
+import { PrismaElementIdentifier } from 'prisma-power-types';
+import { User } from 'generated/prisma/client';
+
+export type IUserIdentifier = PrismaElementIdentifier<User, 'cpf' | 'email'>;
+
+/**
+ * O resultado fica assim:
+ *
+ * type IUserIdentifier =
+ *  | { id: string }
+ *  | { cpf: string }
+ *  | { email: string };
+ */
+```
+
+> 💡 O mais legal aqui é que é totalmente seguro a transformação de `IUserIdentifier` em `Prisma.UserWhereUniqueInput` via _Type Assertion_.
+
+### `PrismaElementUpdate`
+
+Gera um tipo de atualização onde todos os campos (exceto metadados que são omitidos) são opcionais.
+
+```ts
+import { PrismaElementUpdate } from 'prisma-power-types';
+import { User } from 'generated/prisma/client';
+
+export type IUserUpdate = PrismaElementUpdate<User>;
+
+/**
+ * O IUserUpdate fica assim:
+ *
+ * type IUserUpdate = {
+ *   cpf?: string;
+ *   name?: string;
+ *   email?: string | null;
+ *   password?: string;
+ *   role?: UserRole;
+ *   is_active?: boolean;
+ * };
+ */
+```
+
+### `PrismaElementOrderBy` & `PrismaPagination`
+
+Tipagem inteligente para ordenação, incluindo suporte a nulls: 'first' | 'last' apenas para campos que permitem valores nulos no banco. Além de uma interface pré-definida para suporte a paginação.
+
+```ts
+import { PrismaElementOrderBy, PrismaPagination } from 'prisma-power-types';
+import { User } from 'generated/prisma/client';
+
+export type IUserOrderBy = PrismaElementOrderBy<
+  User,
+  'cpf' | 'name' | 'email' | 'is_active' // Campos que serão ordenáveis
+>;
+
+/**
+ * O IUserOrderBy fica assim:
+ *
+ * type IUserOrderBy = {
+ *   cpf: Prisma.SortOrder,
+ *   name: Prisma.SortOrder,
+ *   email: Prisma.SortOrderInput,
+ *   is_active: Prisma.SortOrder,
+ * }
+ */
+
+export interface IUserFilters extends PrismaPagination {
+  orderBy?: IUserOrderBy;
+}
+
+/**
+ * O IUserFilters fica assim:
+ *
+ * interface IUserFilters {
+ *   orderBy: IUserOrderBy;
+ *   page?: number;
+ *   limit?: number;
+ * }
+ */
+```
+
+## 🚀 Recomendações de Uso
+
+Para manter um projeto escalável e organizado, recomendo centralizar as transformações de tipos em arquivos dedicados e utilizá-los como contratos para seus DTOs.
+
+### Estrutura de Pastas Sugerida
+
+Organize seus tipos por domínio dentro de cada rota. Isso evita referências circulares e facilita a localização de definições:
+
+```text
+src/
+└─ routes/
+   └─ users/
+      ├─ dto/
+      │  ├─ users-create.dto.ts
+      │  └─ users-update.dto.ts
+      ├─ types/
+      │  └─ users.types.ts
+      ├─ users.service.ts
+      └─ users.controller.ts
+```
+
+### 1. Centralize as Definições (`users.types.ts`)
+
+Neste arquivo, você consome os modelos do Prisma e exporta as interfaces processadas pela biblioteca:
+
+```ts
+import { User } from 'generated/prisma/client';
+import { PrismaElementCreate, PrismaElementUpdate } from 'prisma-power-types';
+
+export type IUserCreate = PrismaElementCreate<
+  User,
+  'password' | 'is_active', // Removidos da criação
+  'email', // Torna obrigatório
+  'role' // Torna opcional
+>;
+
+export type IUserUpdate = PrismaElementUpdate<User>;
+```
+
+### 2. Implemente nos DTOs (`users-create.dto.ts`)
+
+Ao implementar os tipos gerados no seu DTO, o TypeScript garantirá que sua classe de validação (no exemplo estou usando o `class-validator`) esteja sempre em sincronia com as regras de negócio definidas nos seus tipos.
+
+```ts
+import { IsEmail, IsEnum, IsString, IsOptional, Length } from 'class-validator';
+import { UserRole } from 'generated/prisma/client';
+import { IUserCreate } from '../types/users.types';
+
+export class CreateUserDto implements IUserCreate {
+  @IsString()
+  @Length(11, 11)
+  cpf: string;
+
+  @IsString()
+  name: string;
+
+  @IsEmail()
+  email: string; // O TS exigirá que seja obrigatório conforme IUserCreate
+
+  @IsOptional()
+  @IsEnum(UserRole)
+  role?: UserRole; // O TS exigirá que seja opcional conforme IUserCreate
+}
+```
+
+> **Vantagem desta abordagem:** Se você alterar a obrigatoriedade de um campo no arquivo de tipos, o TypeScript apontará imediatamente um erro no seu DTO, evitando que você esqueça de atualizar as validações de entrada da API.
+
+## 🧬 Estrutura Base
+
+Para utilizar os utilitários, seus modelos devem ser compatíveis com a interface `PrismaElement`:
+
+```ts
+export interface PrismaElement {
+  id: string | number;
+  [key: string]: unknown;
+}
+```
+
+## 🔍 Utilitários de String (Low-level)
+
+### Filtros por Nome de Chave
+
+Utilizam _Template Literal Types_ para filtrar propriedades do objeto dinamicamente.
+
+| Utilitário              | Descrição                                                      |
+| ----------------------- | -------------------------------------------------------------- |
+| `PickByPrefix<T, S>`    | Seleciona propriedades cujas chaves começam com o prefixo `S`. |
+| `PickBySubstring<T, S>` | Seleciona propriedades cujas chaves contêm a substring `S`.    |
+| `PickBySuffix<T, S>`    | Seleciona propriedades cujas chaves terminam com o sufixo `S`. |
+| `OmitByPrefix<T, S>`    | Remove propriedades cujas chaves começam com o prefixo `S`.    |
+| `OmitBySubstring<T, S>` | Remove propriedades cujas chaves contêm a substring `S`.       |
+| `OmitBySuffix<T, S>`    | Remove propriedades cujas chaves terminam com o sufixo `S`.    |
+
+> Todos seguem o padrão: `<T extends object, S extends string>`.
+
+```ts
+type OnlyTimestamps = PickBySuffix<User, '_at'>;
+
+/**
+ * type OnlyTimestamps = {
+ *   created_at: Date;
+ *   updated_at: Date;
+ *   deleted_at: Date | null;
+ * }
+```
+
+### Filtros por Tipo de Valor
+
+| Utilitário            | Descrição                                                        |
+| --------------------- | ---------------------------------------------------------------- |
+| `PickByType<T, Type>` | Seleciona propriedades onde o valor é atribuível ao tipo `Type`. |
+| `OmitByType<T, Type>` | Remove propriedades onde o valor é atribuível ao tipo `Type`.    |
+
+> Os dois seguem o padrão: `<T extends object, Type>`.
+
+```ts
+// Seleciona apenas campos que podem ser nulos
+
+type NullableFields = PickByType<User, null>;
+
+/**
+ * type NullableFields = {
+ *   email: string | null;
+ *   deleted_at: Date | null;
+ * }
+ */
+```
+
+### Utilitários de Composição
+
+| Utilitário        | Descrição                                                                                  |
+| ----------------- | ------------------------------------------------------------------------------------------ |
+| `PickOneOf<T, K>` | Cria um tipo onde **exatamente uma** das chaves em `K` é obrigatória, proibindo as outras. |
+| `PickReq<T, K>`   | Seleciona as chaves `K` e as torna obrigatórias.                                           |
+| `PickOpt<T, K>`   | Seleciona as chaves `K` e as torna opcionais.                                              |
+
+### `Prettify`
+
+Esse tipo merece um destaque especial por ser o segredo por trás da experiência do desenvolvedor (DX) nesta biblioteca.
+
+Ao trabalhar com utilitários complexos como Omit, Pick e interseções (&), o TypeScript tende a exibir o "processo" e não o "resultado" no IntelliSense da sua IDE. Em vez de ver as propriedades reais do objeto, você acaba vendo algo como `Pick<User, "name"> & { role?: UserRole }`. O Prettify resolve isso "achatando" o tipo em um objeto literal único e legível.
+
+**O que o torna único:**
+
+- **Preservação de Tipos Nativos:** Diferente de versões simplificadas, nossa implementação não tenta "expandir" objetos nativos como `Date`, `Map`, `Set`, `Promise` ou `RegExp`. Isso evita que sua IDE exiba centenas de propriedades internas globais do JavaScript.
+
+- **Recursividade Inteligente:** Ele percorre toda a árvore de objetos, limpando tipos aninhados para que a legibilidade seja mantida em qualquer profundidade.
+
+- **Controle de Exclusão (Template E):** Este é o grande diferencial. O parâmetro genérico `E` permite definir tipos customizados que não devem ser expandidos.
+
+**Exemplo:** Se você tem um tipo `Decimal` (muito comum no Prisma para campos monetários), você pode passar `Prettify<SeuTipo, Decimal>`. Isso instrui o utilitário a tratar o `Decimal` como um valor atômico, impedindo que a IDE tente detalhar sua estrutura interna complexa.
+
+---
+
+## 💡 Dicas de Uso
+
+### Otimizando a Visualização (DX)
+
+O TypeScript tende a mostrar tipos complexos como `Pick<User, "name"> & Omit<...>` ao passar o mouse. Todos os utilitários de alto nível desta biblioteca já utilizam o `Prettify` internamente para garantir que você veja a estrutura final do objeto.
+
+---
+
+## 🤝 Contribuição
+
+Contribuições são muito bem-vindas! Se você encontrou um bug ou tem uma ideia para um novo utilitário:
+
+1. Faça um **Fork** do projeto.
+2. Crie uma **Branch** para sua feature (`git checkout -b feature/minha-feature`).
+3. Faça o **Commit** das alterações (`git commit -m 'Adicionando nova funcionalidade'`).
+4. Envie o **Push** para a branch (`git push origin feature/minha-feature`).
+5. Abra um **Pull Request**.
+
+---
+
+## 📄 Licença
+
+Distribuído sob a licença MIT.
+
+- Você é livre para utilizar essa biblioteca em projetos pessoais ou empresariais;
+- Fique a vontade para modificar os códigos de acordo com suas necessidades;
+- Você também pode distribuir versões modificadas desse projeto, só peço que mencione este repositório.
+
+---
+
+Criado por Bianca Maxine.
+
+Se este pacote te ajudou, considere dar uma ⭐️ no [Repositório do GitHub](https://github.com/biamaxine/prisma-power-types)!

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './types/pick.types';
+export * from './types/omit.types';
+export * from './types/prettify.type';
+export * from './types/prisma/prisma.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,6BAA6B,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/pick.types"), exports);
+__exportStar(require("./types/omit.types"), exports);
+__exportStar(require("./types/prettify.type"), exports);
+__exportStar(require("./types/prisma/prisma.types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,qDAAmC;AACnC,wDAAsC;AAEtC,8DAA4C"}

package/dist/types/omit.types.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Omite as propriedades de `T` cujas chaves começam com o prefixo `S`.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template S extends `string` - O prefixo a ser correspondido nas chaves.
+ */
+export type OmitByPrefix<T extends object, S extends string> = {
+    [K in keyof T as K extends `${S}${string}` ? never : K]: T[K];
+};
+/**
+ * Omite as propriedades de `T` cujas chaves contêm a substring `S`.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template S extends `string` - A substring a ser buscada nas chaves.
+ */
+export type OmitBySubstring<T extends object, S extends string> = {
+    [K in keyof T as K extends `${string}${S}${string}` ? never : K]: T[K];
+};
+/**
+ * Omite as propriedades de `T` cujas chaves terminam com o sufixo `S`.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template S extends `string` - O sufixo a ser correspondido nas chaves.
+ */
+export type OmitBySuffix<T extends object, S extends string> = {
+    [K in keyof T as K extends `${string}${S}` ? never : K]: T[K];
+};
+/**
+ * Omite as propriedades de `T` onde o tipo `Type` é atribuível ao valor da propriedade.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template Type O tipo a ser verificado contra as propriedades de T.
+ */
+export type OmitByType<T extends object, Type> = {
+    [K in keyof T as Type extends T[K] ? never : K]: T[K];
+};
+/**
+ * Omite um subconjunto de propriedades `K` de `T` e torna as restantes obrigatórias (Required).
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template K extends `keyof T` - As chaves a serem omitidas.
+ */
+export type OmitReq<T extends object, K extends keyof T> = Required<Omit<T, K>>;
+/**
+ * Omite um subconjunto de propriedades `K` de `T` e torna as restantes opcionais (Partial).
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template K extends `keyof T` - As chaves a serem omitidas.
+ */
+export type OmitOpt<T extends object, K extends keyof T> = Partial<Omit<T, K>>;
+//# sourceMappingURL=omit.types.d.ts.map

package/dist/types/omit.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.types.d.ts","sourceRoot":"","sources":["../../src/types/omit.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAC/D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,IAAI;KAC9C,CAAC,IAAI,MAAM,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/types/omit.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=omit.types.js.map

package/dist/types/omit.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.types.js","sourceRoot":"","sources":["../../src/types/omit.types.ts"],"names":[],"mappings":""}

package/dist/types/pick.types.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Seleciona as propriedades de `T` cujas chaves começam com o prefixo `S`.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template S extends `string` - O prefixo a ser correspondido nas chaves.
+ */
+export type PickByPrefix<T extends object, S extends string> = {
+    [K in keyof T as K extends `${S}${string}` ? K : never]: T[K];
+};
+/**
+ * Seleciona as propriedades de `T` cujas chaves contêm a substring `S`.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template S extends `string` - A substring a ser buscada nas chaves.
+ */
+export type PickBySubstring<T extends object, S extends string> = {
+    [K in keyof T as K extends `${string}${S}${string}` ? K : never]: T[K];
+};
+/**
+ * Seleciona as propriedades de `T` cujas chaves terminam com o sufixo `S`.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template S extends `string` - O sufixo a ser correspondido nas chaves.
+ */
+export type PickBySuffix<T extends object, S extends string> = {
+    [K in keyof T as K extends `${string}${S}` ? K : never]: T[K];
+};
+/**
+ * Cria um tipo onde exatamente uma das chaves em `K` é obrigatória (e não nula),
+ * enquanto as outras chaves especificadas são proibidas.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template K extends `keyof T` - As chaves a serem consideradas (padrão: todas as chaves de T).
+ */
+export type PickOneOf<T extends object, K extends keyof T = keyof T> = {
+    [P in K]: Required<Record<P, NonNullable<T[P]>>> & Partial<Record<Exclude<K, P>, never>>;
+}[K];
+/**
+ * Seleciona as propriedades de `T` onde o tipo `Type` é atribuível ao valor da propriedade.
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template Type O tipo a ser verificado contra as propriedades de T.
+ */
+export type PickByType<T extends object, Type> = {
+    [K in keyof T as Type extends T[K] ? K : never]: T[K];
+};
+/**
+ * Seleciona um subconjunto de propriedades `K` de `T` e as torna obrigatórias (Required).
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template K extends `keyof T` - As chaves a serem selecionadas.
+ */
+export type PickReq<T extends object, K extends keyof T> = Required<Pick<T, K>>;
+/**
+ * Seleciona um subconjunto de propriedades `K` de `T` e as torna opcionais (Partial).
+ *
+ * @template T extends `object` - O tipo do objeto de origem.
+ * @template K extends `keyof T` - As chaves a serem selecionadas.
+ */
+export type PickOpt<T extends object, K extends keyof T> = Partial<Pick<T, K>>;
+//# sourceMappingURL=pick.types.d.ts.map

package/dist/types/pick.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.types.d.ts","sourceRoot":"","sources":["../../src/types/pick.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAC/D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CACvE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI;KACpE,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC9C,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;CACxC,CAAC,CAAC,CAAC,CAAC;AAEL;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,IAAI;KAC9C,CAAC,IAAI,MAAM,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/types/pick.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pick.types.js.map

package/dist/types/pick.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.types.js","sourceRoot":"","sources":["../../src/types/pick.types.ts"],"names":[],"mappings":""}

package/dist/types/prettify.type.d.ts

@@ -0,0 +1,15 @@
+type NativeObjects<T> = unknown[] | Set<unknown> | Map<unknown, unknown> | Iterable<unknown> | Promise<unknown> | Function | Date | RegExp | Error | T;
+/**
+ * Expande recursivamente as propriedades de um tipo para melhorar a legibilidade em tooltips de IDEs.
+ *
+ * Este utilitário percorre a estrutura do objeto e "achata" as interseções e propriedades herdadas,
+ * facilitando a inspeção visual do tipo final. Tipos nativos e o tipo especificado em `E` são preservados.
+ *
+ * @template T - O tipo a ser processado/expandido.
+ * @template E - Um tipo que, se encontrado, interrompe a expansão recursiva (útil para evitar loops ou preservar definições).
+ */
+export type Prettify<T, E = never> = T extends NativeObjects<E> ? T : T extends object ? {
+    [K in keyof T]: Prettify<T[K], E>;
+} : T;
+export {};
+//# sourceMappingURL=prettify.type.d.ts.map

package/dist/types/prettify.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettify.type.d.ts","sourceRoot":"","sources":["../../src/types/prettify.type.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,CAAC,CAAC,IAChB,OAAO,EAAE,GACT,GAAG,CAAC,OAAO,CAAC,GACZ,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GACrB,QAAQ,CAAC,OAAO,CAAC,GACjB,OAAO,CAAC,OAAO,CAAC,GAEhB,QAAQ,GACR,IAAI,GACJ,MAAM,GACN,KAAK,GACL,CAAC,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAC/B,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GACtB,CAAC,GACD,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;CAAE,GACrC,CAAC,CAAC"}

package/dist/types/prettify.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=prettify.type.js.map

package/dist/types/prettify.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettify.type.js","sourceRoot":"","sources":["../../src/types/prettify.type.ts"],"names":[],"mappings":""}

package/dist/types/prisma/prisma.types.d.ts

@@ -0,0 +1,113 @@
+import { PickBySuffix, PickByType, PickOneOf } from '../pick.types';
+import { Prettify } from '../prettify.type';
+/**
+ * Interface base que todo modelo Prisma deve estender para ser compatível com estes utilitários.
+ *
+ * Garante a presença de um `id` e permite indexação por string.
+ */
+export interface PrismaElement {
+    /**
+     * Apesar de a propriedade aceitar ambos, é comum utilizarmos um único tipo para IDs no banco de dados.
+     *
+     * @type {string | number} - Suporte para UUID e autoincrement
+     */
+    id: string | number;
+    [key: string]: unknown;
+}
+declare const SortOrder: {
+    readonly asc: "asc";
+    readonly desc: "desc";
+};
+type SortOrder = keyof typeof SortOrder;
+declare const NullsOrder: {
+    readonly first: "first";
+    readonly last: "last";
+};
+type NullsOrder = keyof typeof NullsOrder;
+/**
+ * Estrutura para definir a ordenação de campos que podem ser nulos.
+ */
+interface SortOrderInput {
+    sort: SortOrder;
+    nulls?: NullsOrder;
+}
+/**
+ * Identifica as chaves de metadados padrão do Prisma que geralmente não devem ser manipuladas manualmente.
+ *
+ * Inclui 'id' e quaisquer chaves terminadas em '_at' (ex: created_at).
+ *
+ * @template T - O tipo do objeto de origem.
+ */
+type PrismaElementMetadata<T extends PrismaElement> = 'id' | keyof PickBySuffix<T, '_at' | 'At'>;
+/**
+ * Omite os metadados padrão e chaves adicionais especificadas de um tipo Prisma.
+ *
+ * @template T - O tipo do objeto de origem.
+ * @template K - Chaves adicionais a serem omitidas.
+ */
+type OmitElementMetadatas<T extends PrismaElement, K extends Exclude<keyof T, PrismaElementMetadata<T>> = never> = Omit<T, PrismaElementMetadata<T> | K>;
+/**
+ * Utilitário interno para modificar as propriedades de um tipo Prisma para operações de criação.
+ *
+ * @template T - O tipo do objeto de origem.
+ * @template O - Chaves a serem omitidas.
+ * @template R - Chaves a serem tornadas obrigatórias (não nulas).
+ * @template P - Chaves a serem tornadas opcionais.
+ * @template M - O tipo base com metadados já omitidos.
+ */
+type Modify<T extends PrismaElement, O extends Exclude<keyof T, PrismaElementMetadata<T>>, R extends Exclude<keyof T, PrismaElementMetadata<T> | O>, P extends Exclude<keyof T, PrismaElementMetadata<T> | O | R>, M = OmitElementMetadatas<T, O>> = {
+    [K in keyof M as K extends R ? K : never]: Exclude<M[K], null>;
+} & {
+    [K in keyof M as K extends P ? K : never]?: Exclude<M[K], null>;
+} & {
+    [K in keyof M as K extends R | P ? never : null extends M[K] ? K : never]?: Exclude<M[K], null>;
+} & {
+    [K in keyof M as K extends R | P ? never : null extends M[K] ? never : K]: M[K];
+};
+/**
+ * Cria um tipo otimizado para a criação de registros Prisma.
+ *
+ * Remove metadados automáticos e permite ajustar a obrigatoriedade dos campos.
+ *
+ * @template T - O tipo do modelo Prisma.
+ * @template O - Chaves a serem omitidas (além dos metadados padrão).
+ * @template R - Chaves que devem ser obrigatórias (remove `null`/`undefined`).
+ * @template P - Chaves que devem ser opcionais.
+ */
+export type PrismaElementCreate<T extends PrismaElement, O extends Exclude<keyof T, PrismaElementMetadata<T>> = never, R extends Exclude<keyof PickByType<T, null>, PrismaElementMetadata<T> | O> = never, P extends Exclude<keyof T, PrismaElementMetadata<T> | O | R> = never> = Prettify<Modify<T, O, R, P>>;
+/**
+ * Define um tipo que exige o `id` OU uma das chaves únicas especificadas.
+ *
+ * Útil para operações que buscam um registro por identificador único.
+ *
+ * @template T - O tipo do modelo Prisma.
+ * @template K - Chaves únicas adicionais (ex: 'email', 'uuid').
+ */
+export type PrismaElementIdentifier<T extends PrismaElement, K extends Exclude<keyof T, 'id'>> = Prettify<PickOneOf<T, 'id' | K>>;
+/**
+ * Interface padrão para parâmetros de paginação.
+ */
+export interface PrismaPagination {
+    page?: number;
+    limit?: number;
+}
+/**
+ * Define a estrutura de ordenação para consultas Prisma.
+ *
+ * @template T - O tipo do modelo Prisma.
+ * @template K - As chaves pelas quais a ordenação é permitida.
+ */
+export type PrismaElementOrderBy<T extends PrismaElement, K extends keyof T> = {
+    [P in K]?: null extends T[P] ? SortOrderInput | SortOrder : SortOrder;
+};
+/**
+ * Cria um tipo para atualização de registros Prisma.
+ *
+ * Remove metadados e torna todas as propriedades restantes opcionais.
+ *
+ * @template T - O tipo do modelo Prisma.
+ * @template O - Chaves adicionais a serem omitidas.
+ */
+export type PrismaElementUpdate<T extends PrismaElement, O extends Exclude<keyof T, PrismaElementMetadata<T>> = never> = Partial<OmitElementMetadatas<T, O>>;
+export {};
+//# sourceMappingURL=prisma.types.d.ts.map

package/dist/types/prisma/prisma.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prisma.types.d.ts","sourceRoot":"","sources":["../../../src/types/prisma/prisma.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAI5C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,QAAA,MAAM,SAAS;;;CAGL,CAAC;AAEX,KAAK,SAAS,GAAG,MAAM,OAAO,SAAS,CAAC;AAExC,QAAA,MAAM,UAAU;;;CAGN,CAAC;AAEX,KAAK,UAAU,GAAG,MAAM,OAAO,UAAU,CAAC;AAE1C;;GAEG;AACH,UAAU,cAAc;IACtB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAED;;;;;;GAMG;AACH,KAAK,qBAAqB,CAAC,CAAC,SAAS,aAAa,IAC9C,IAAI,GACJ,MAAM,YAAY,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;AAExC;;;;;GAKG;AACH,KAAK,oBAAoB,CACvB,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAC1D,IAAI,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAI1C;;;;;;;;GAQG;AACH,KAAK,MAAM,CACT,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,EACpD,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EACxD,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAC5D,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,IAC5B;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CAC/D,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CAChE,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAC5B,KAAK,GACL,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GACf,CAAC,GACD,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CACnC,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAC5B,KAAK,GACL,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GACf,KAAK,GACL,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACf,CAAC;AAIF;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,EAC5D,CAAC,SAAS,OAAO,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GACxE,KAAK,EACP,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,IAClE,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAIjC;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,IAC9B,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AAIrC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,aAAa,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI;KAC5E,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,GAAG,SAAS,GAAG,SAAS;CACtE,CAAC;AAIF;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,aAAa,EACvB,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAC1D,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/types/prisma/prisma.types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const SortOrder = {
+    asc: 'asc',
+    desc: 'desc',
+};
+const NullsOrder = {
+    first: 'first',
+    last: 'last',
+};
+//# sourceMappingURL=prisma.types.js.map

package/dist/types/prisma/prisma.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prisma.types.js","sourceRoot":"","sources":["../../../src/types/prisma/prisma.types.ts"],"names":[],"mappings":";;AAoBA,MAAM,SAAS,GAAG;IAChB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAIX,MAAM,UAAU,GAAG;IACjB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "prisma-power-types",
+  "version": "1.0.0",
+  "description": "Uma coleção de TS Utility Types para transformar de forma prática os modelos do Prisma em DTOs seguros, dinâmicos e legíveis.",
+  "author": "Bianca Maxine",
+  "github": "https://github.com/biamaxine",
+  "linkedin": "https://linkedin.com/in/biamaxine",
+  "email": "biamaxine.v@gmail.com",
+  "keywords": [
+    "prisma",
+    "typescript"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "node dist/index.js",
+    "build": "tsc",
+    "dev": "nodemon",
+    "lint": "eslint --fix"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^25.2.1",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^17.3.0",
+    "nodemon": "^3.1.11",
+    "prettier": "^3.8.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}