godeep-states

Módulo Nuxt que fornece stores Pinia e rotas de servidor para integração com a API GoDeep, removendo a responsabilidade de gerenciamento de estado do front-end do cliente.

• ✨  Release Notes

Features

• 🗄️  Stores Pinia pré-configurados para todas as funcionalidades do GoDeep
• 🔌  Rotas de servidor para proxy de API
• 🔄  Persistência de estado com sessionStorage
• 📦  Integração completa com godeep-types
• 🚀  Auto-descoberta de stores pelo Nuxt

Quick Setup

Instale o módulo na sua aplicação Nuxt:

npm install godeep-states
# ou
bun add godeep-states

Adicione o módulo ao seu nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['godeep-states'],
  
  // Configure as variáveis de ambiente necessárias
  runtimeConfig: {
    public: {
      urlApi: process.env.URL_API,
      token: process.env.TOKEN_API,
    },
  },
})

Configure as variáveis de ambiente no seu .env:

URL_API=https://sua-api-godeep.com
TOKEN_API=seu-token-aqui

Pronto! Os stores estarão disponíveis automaticamente na sua aplicação ✨

Stores Disponíveis

O módulo fornece os seguintes stores Pinia:

• storeCarrinho - Gerenciamento de carrinho de compras
• storeHome - Dados da página inicial
• storeProduto - Detalhes e informações de produtos
• storeVitrine - Listagens e vitrines de produtos
• storeCategoria - Categorias de produtos
• storeBusca - Resultados de busca
• storeFavoritos - Lista de favoritos
• storeLogin - Autenticação e login
• storeCadastro - Cadastro de usuários
• storePedidos - Histórico de pedidos
• storeEnderecos - Gerenciamento de endereços
• storePagamentos - Métodos de pagamento
• storeConfiguracoes - Configurações da loja
• storeMenus - Menus de navegação
• storeBanner - Banners promocionais
• storeNewsletter - Inscrições em newsletter
• storePaginas - Páginas estáticas
• storeRedesSociais - Links de redes sociais
• storeAvaliacoes - Avaliações de produtos
• storeFiltros - Filtros de busca
• storeDadosCadastrais - Dados cadastrais do usuário

Uso

Os stores são auto-importados pelo Nuxt. Você pode usá-los diretamente nos seus componentes:

<script setup lang="ts">
const carrinhoStore = storeCarrinho()
const homeStore = storeHome()

// Usar os stores
await homeStore.buscarHome()
await carrinhoStore.adicionarProdutosCarrinho([...])
</script>

Rotas de Servidor

O módulo também fornece rotas de servidor:

• /api/front-api/** - Proxy para a API GoDeep
• /robots - Endpoint para robots.txt
• /robots.txt - Endpoint alternativo para robots.txt

Dependências

Este módulo requer:

• godeep-types - Tipos TypeScript e funções de tradução
• pinia - Gerenciamento de estado
• pinia-plugin-persistedstate - Persistência de estado

Contribution

# Instalar dependências
npm install

# Gerar stubs de tipos
npm run dev:prepare

# Desenvolver com o playground
npm run dev

# Build do playground
npm run dev:build

# Executar ESLint
npm run lint
npm run lint:fix

# Executar testes
npm run test
npm run test:watch

# Verificar tipos
npm run typecheck

# Publicar nova versão
npm run release