README

Pacote privado para projetos Laravel que usam o padrão Navpi. Ele é consumido via Composer com repositório VCS no projeto cliente.

Visão geral

• Pacote privado, não publicado no Packagist.
• Namespace principal: Bildvitta\Navpi\.
• Provider e facade são carregados automaticamente pelo Laravel.
• A configuração é publicada em config/navpi-php.php.
• Não há variáveis de ambiente próprias neste pacote.

Requisitos

• PHP ^8.1
• Laravel com autodiscovery de pacotes
• Acesso ao repositório privado no GitHub

Acesso aos Repositórios Privados

No projeto cliente, adicione o repositório VCS em composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/appnave/nave-navpi-server"
    }
  ]
}

Instale o pacote:

composer require appnave/nave-navpi-server

Autenticação local do Composer com token do GitHub:

composer config -g github-oauth.github.com <YOUR_TOKEN>

No GitHub Actions, configure COMPOSER_AUTH:

env:
  COMPOSER_AUTH: >-
    {"github-oauth":{"github.com":"${{ secrets.COMPOSER_GITHUB_TOKEN }}"}}

Se o projeto cliente usar outros pacotes privados, repita o mesmo padrão de repositories e autenticação para cada dependência.

Instalação Local

No repositório do pacote:

composer install

No projeto Laravel cliente:

composer require appnave/nave-navpi-server
php artisan vendor:publish --tag=config --provider="Bildvitta\Navpi\NavpiPhpServiceProvider"

Exemplo mínimo de uso:

use Bildvitta\Navpi\Fields;
use Bildvitta\Navpi\NavpiResource;

class CustomResource extends NavpiResource
{
    protected function fieldsMap()
    {
        return [
            'name' => (new Fields\TextField('name'))
                ->label('Nome completo')
                ->exceptActions(['filters']),
        ];
    }
}

Comandos Úteis

composer test
composer test-coverage
composer check-style
composer fix-style

Informações Adicionais

• A classe base do pacote é Bildvitta\Navpi\NavpiResource.
• A facade registrada é NavpiPhp.
• O arquivo de configuração publicado é config/navpi-php.php.
• O recurso usa fieldsMap() para definir os campos expostos.

Contribuição

Veja os detalhes em CONTRIBUTING.md.

Alterações

Veja o histórico em CHANGELOG.md.

Segurança

Se encontrar uma falha de segurança, envie um e-mail para backend@bild.com.br.

Licença

MIT. Consulte LICENSE.md.