nfse-nacional/nfse-php

This is my package nfse

v0.1.0-beta 2025-12-31 01:31 UTC

Requires

• php: ^8.4
• illuminate/support: ^11.47
• spatie/laravel-data: ^4.8

Requires (Dev)

• illuminate/translation: ^11.47
• illuminate/validation: ^11.47
• laravel/pint: ^1.0
• pestphp/pest: ^4.0
• spatie/ray: ^1.28
• spatie/typescript-transformer: dev-main

MIT

• a21ns1g4ts

• nfse

README

A maneira mais moderna e eficiente de integrar PHP com a NFS-e Nacional.

Este pacote é a fundação do ecossistema para integração com a NFS-e Nacional. O foco é garantir contratos sólidos, modelos de dados ricos (DTOs) e facilidade de uso para desenvolvedores PHP. Ele fornece um conjunto robusto de DTOs que simplificam a criação e validação dos XMLs, oferecendo uma interface fluida e uma documentação alinhada à realidade do desenvolvedor.

Instalação

Você pode instalar o pacote via composer:

composer require nfse-nacional/nfse-php

Uso

Exemplo básico de utilização dos DTOs:

use Nfse\Nfse\Dto\DpsData;

// Exemplo de instanciação (ajuste conforme sua necessidade)
$dps = DpsData::from([
    '@versao' => '1.00',
    'infDPS' => [
        // ... dados da DPS
    ]
]);

🗺️ Roadmap

Este projeto está em desenvolvimento ativo. Abaixo estão as fases planejadas:

Fase 1: Estrutura de Dados (DTOs) ✅

• Implementar DTOs usando spatie/laravel-data.
• Mapear campos do Excel (ANEXO_I...) usando atributos #[MapInputName].
• Implementar Dps, Prestador, Tomador, Servico, Valores.
• Adicionar validações (Constraints) nos DTOs.
• Testes unitários de validação.

Fase 2: Serialização ✅

• Implementar Serializer para XML (padrão ABRASF/Nacional).
• Garantir que a serialização respeite os XSDs oficiais.

Fase 3: Assinatura Digital ✅

• Criar SignerInterface.
• Implementar adaptador para assinatura XML (DSig).
• Suporte a certificado A1 (PKCS#12).

Fase 4: Utilitários ✅

• Helpers para cálculo de impostos (simples).
• Formatadores de documentos (CPF/CNPJ).
• Gerador de IDs (DPS/NFSe).

Fase 5: Documentação & Busca 🚀

• Docusaurus com busca local.
• Documentação de DTOs e Assinatura.
• Tutoriais avançados.

Fase 6: Web Services (Próximo) 📅

• Integração com Web Services da SEFIN Nacional.
• Envio de DPS.
• Consulta de NFSe.
• Eventos e Cancelamentos.

Fase 7: Testes E2E & CI/CD 📅

• Testes end-to-end com ambiente de homologação.
• GitHub Actions para CI/CD.
• Releases automáticas.

Para mais detalhes, consulte o arquivo ROADMAP.md.

Testing

composer test

Changelog

Por favor, veja CHANGELOG para mais informações sobre o que mudou recentemente.

Contributing

Por favor, veja CONTRIBUTING para detalhes.

Security

Se você descobrir alguma vulnerabilidade de segurança, por favor, envie um e-mail para o mantenedor em vez de usar o rastreador de problemas.

Credits

• A21ns1g4ts
• All Contributors

License

The MIT License (MIT). Please see License File for more information.