Viniciustda/OiTenta / .agents/skills/module-repository
module-repository
VerifiedCria contratos de repositório padronizados para agregados dos módulos de negócio, reaproveitando interfaces compartilhadas de persistência e gerando também uma implementação em memória para apoiar testes dos casos de uso.
Module Repository
Use esta skill quando o pedido for criar ou completar o contrato de repositorio de um agregado dentro de modules/, junto com uma implementacao fake/in-memory reutilizavel para testes de casos de uso.
Esta skill cobre somente:
- interface de repositorio no dominio
- tipos auxiliares minimos do contrato
- exports do agregado e do modulo de teste
- implementacao fake/in-memory simples e funcional
Esta skill nao cria:
- Prisma
- backend Nest
- controller
- migration
- seed
- adaptadores de infraestrutura real
Entradas obrigatorias
moduloou umpathinequivoco dentro demodules/<modulo>/agregadoou opathexplicito do arquivo de repositorio de destinotipo de repositoriocrudcustom
entidade principalmanipulada pelo repositorio
Entradas obrigatorias quando tipo=custom
- lista de metodos desejados
- assinatura esperada ou intencao de cada metodo quando houver ambiguidade relevante
Sem essas entradas, interrompa e peca somente os dados faltantes.
Perguntas objetivas permitidas:
Informe o modulo ou um path dentro de modules/.Informe o agregado ou o path explicito do repositorio.Deseja um repositorio "crud" ou "custom"?Qual entidade principal esse repositorio manipula?Liste os metodos customizados e a assinatura esperada de cada um.
Leituras obrigatorias
Antes de gerar qualquer arquivo, leia obrigatoriamente:
packages/shared/src/db/create.repository.tspackages/shared/src/db/update.repository.tspackages/shared/src/db/delete.repository.tspackages/shared/src/db/find-by-id.repository.tspackages/shared/src/db/find-page.repository.tspackages/shared/src/db/crud.repository.tspackages/shared/src/db/index.tsmodules/auth/src/user/provider/user.repository.tsmodules/auth/src/user/model/user.entity.tsmodules/auth/test/mock/fake-user.repository.ts
Depois disso, consulte tambem os materiais internos desta skill:
references/mandatory-readings.mdreferences/repository-pattern.mdreferences/few-shots/user.repository.example.tsreferences/few-shots/fake-user.repository.example.ts
Resolucao de destino
Aceite exatamente dois modos:
- Por convencao:
modules/<modulo>/src/<aggregate>/provider/<aggregate>.repository.ts
- Por path explicito informado pelo usuario
Regras:
- Validar que
modules/<modulo>existe. - Se o agregado vier por nome, validar que
modules/<modulo>/src/<aggregate>existe ou que a estrutura minima do agregado ja foi criada. - Se o usuario informar um path dentro do agregado, normalize para o arquivo alvo em
provider/<aggregate>.repository.tsquando a intencao estiver clara. - Se o destino for por convencao, o nome do arquivo deve ser sempre
<aggregate>.repository.tsemkebab-case. - O repositorio deve ficar dentro da pasta
provider. - Preserve convencoes locais ja existentes quando houver um path explicito valido.
Arquivos que a skill deve criar ou atualizar
modules/<modulo>/src/<aggregate>/provider/<aggregate>.repository.tsmodules/<modulo>/src/<aggregate>/provider/index.tsmodules/<modulo>/src/<aggregate>/index.tsquando necessario para expor./providermodules/<modulo>/test/mock/fake-<aggregate>.repository.tsmodules/<modulo>/test/mock/index.ts
Preserve exports existentes. Nunca apague export valido para simplificar.
Workflow
- Validar entradas obrigatorias.
- Resolver
modulo,aggregatee o path final do repositorio. - Confirmar que o modulo existe e que o agregado e valido.
- Ler as referencias obrigatorias do projeto e as referencias internas desta skill.
- Ler os arquivos atuais do agregado:
modules/<modulo>/src/<aggregate>/model/**modules/<modulo>/src/<aggregate>/provider/index.ts, se existirmodules/<modulo>/src/<aggregate>/index.ts, se existirmodules/<modulo>/test/mock/index.ts, se existir
- Descobrir os nomes reais ja usados para entidade, tipos auxiliares e exports.
- Gerar a interface do repositorio seguindo as regras abaixo.
- Gerar a fake/in-memory implementando o contrato recem-criado.
- Atualizar os
index.tsnecessarios sem perder exports existentes. - Reportar o que foi criado ou ajustado e qualquer placeholder introduzido.
Regras da interface
- O contrato deve seguir o padrao
export interface <EntityName>Repository. - Reaproveite contratos de
@poupig/sharedsempre que houver encaixe claro. - Evite reescrever assinaturas que ja existem em
CreateRepository,UpdateRepository,DeleteRepository,FindByIdRepository,FindPageRepositoryouCrudRepository. - Use os tipos reais da entidade e dos parametros relacionados ao agregado quando existirem.
- Se tipos auxiliares ainda nao existirem e nao der para inferir com seguranca, crie placeholders tipados, pequenos e didaticos no proprio arquivo do repositorio.
- Nao invente regras de negocio nem campos detalhados de dominio.
- O arquivo deve ser estrutural: contrato e tipos minimos, sem infraestrutura real.
Quando tipo=crud
Prefira:
export interface <EntityName>Repository extends CrudRepository<
<CreateInput>,
<UpdateInput>,
<EntityName>,
<PageParams>,
<IdType>
> {}
Regras:
- Peca ou infira com seguranca:
- entidade principal
- tipo de entrada de criacao
- tipo de entrada de atualizacao
- tipo de parametros de paginacao, quando houver
findPage
- Se nao for possivel inferir com seguranca, crie placeholders como:
<EntityName>CreateInput<EntityName>UpdateInput<EntityName>PageParams
- Prefira um contrato enxuto e facil de evoluir.
- Se o repositorio nao precisar de
findPage, nao forceCrudRepository; componha interfaces granulares quando isso deixar o contrato mais fiel ao pedido.
Quando tipo=custom
Regras:
- Exija a lista de metodos desejados.
- Crie cada metodo com nome, parametros e retorno coerentes com a intencao informada.
- Se houver ambiguidade relevante sobre parametros ou retorno, interrompa e peca esclarecimento antes de inventar uma assinatura.
- Se um metodo descrito pelo usuario corresponder claramente a
create,update,delete,findByIdoufindPage, prefira compor a interface com os contratos compartilhados em vez de duplicar assinatura manual. - Quando fizer sentido, combine contratos compartilhados com metodos adicionais no mesmo
interface.
Regras da fake/in-memory
- Sempre gere tambem uma fake/in-memory.
- A fake nao usa framework de mock.
- A fake deve ser uma classe simples, concreta e funcional.
- O objetivo e suportar testes reais de casos de uso sem backend.
- O destino preferencial e
modules/<modulo>/test/mock/fake-<aggregate>.repository.ts. - Se o modulo ja tiver uma convencao de testes mais especifica, preserve-a.
- A classe fake deve implementar a interface do repositorio recem-criada.
- Priorize
Map,Arrayou combinacao simples das duas para armazenamento. - Priorize clareza e previsibilidade, nao realismo de infraestrutura.
Fake para crud
- Implemente comportamento funcional para os metodos do contrato.
- Para
create, persista em memoria e retorne a entidade salva. - Para
update, substitua o item existente e falhe de forma simples quando o registro nao existir. - Para
delete, remova o item em memoria. - Para
findById, retorne a entidade ounull. - Para
findPage, monte umPageResult<TEntity>simples, coerente com o padrao do projeto. - Use
entity.idcomo chave quando o id for string, seguindo o padrao atual do projeto.
Fake para custom
- Implemente versoes simples e coerentes dos metodos definidos.
- Se o metodo representar busca, filtre os dados em memoria.
- Se o metodo representar comando, atualize o armazenamento e retorne o minimo necessario para testes.
- Nao simule integracoes externas nem dependencias de framework.
Convencoes de import e export
- Reaproveite o namespace compartilhado exposto pelo projeto, por exemplo
@poupig/shared. - No repositorio de dominio, prefira importar a entidade a partir de
../model. - Na fake, prefira importar contrato, entidade e tipos do proprio modulo a partir de
../../srcquando essa convencao local existir. - Atualize
provider/index.tscomexport * from "./<aggregate>.repository"; - Garanta que
src/<aggregate>/index.tsexponha./providerquando necessario. - Atualize
test/mock/index.tscomexport * from "./fake-<aggregate>.repository";
Guardrails
- Nao prosseguir sem modulo, agregado e tipo claramente definidos.
- Nao assumir que todo repositorio e CRUD.
- Nao criar implementacao Prisma, backend ou qualquer persistencia real.
- Nao editar arquivos fora do modulo alvo, exceto a propria skill quando estiver sendo criada ou atualizada.
- Nao duplicar contratos que ja existem em
packages/shared. - Nao criar assinaturas arbitrarias quando houver ambiguidade relevante.
- Nao remover exports existentes.
- Nao introduzir dependencias de framework na fake.
Saida esperada
- Interface de repositorio coerente com o agregado
- Tipos auxiliares minimos quando necessarios
- Fake/in-memory funcional para testes futuros
- Exports do agregado e de
test/mockatualizados
Consulte references/mandatory-readings.md para o checklist de leitura e references/repository-pattern.md para o padrao observado no projeto.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |