README

Retrieve Packagist package details and vendor statistics from Laravel.

Table of Contents

• Framework Support
• Requirements
• Installation
• Upgrading
• Quick Start
• Blade
• Livewire
• Vue, React, and Svelte
• API Methods
• Features
• Configuration
• Changing Frameworks
• Artisan Commands
• Install Options
• Testing
• License

Framework Support

Older Laravel versions remain covered for existing applications. Follow Laravel's support policy when choosing a version for a new application.

This is a server-side API package. It has no routes, dashboard, views, or CSS dependencies. Your application's current frontend and theme stay in place when Composer updates the package.

Requirements

• PHP 7.1.3 or later, subject to your Laravel version's requirements.
• Laravel 5.4 through 13.
• PHP cURL and JSON extensions.
• An HTTPS connection to Packagist, or a compatible configured endpoint.

Installation

composer require jeremykenedy/laravel-packagist
php artisan packagist:install

Laravel 5.5 and later discover the service provider automatically. For Laravel 5.4, add this entry to providers in config/app.php:

jeremykenedy\LaravelPackagist\LaravelPackagistServiceProvider::class,

The install command publishes configuration and translations. If the configuration already exists, it asks before publishing missing files. Existing files are preserved, including with --force. Publishing is optional; the package works with its defaults.

The original publishing commands remain available:

php artisan vendor:publish --provider="jeremykenedy\LaravelPackagist\LaravelPackagistServiceProvider"
php artisan vendor:publish --tag=laravelpackagist-config
php artisan vendor:publish --tag=laravelpackagist-lang

Translations are published under your application's language directory in vendor/laravelpackagist. This supports both the older resources/lang directory and newer applications using lang.

Upgrading

composer update jeremykenedy/laravel-packagist
php artisan packagist:update

Composer updates do not publish files, change application configuration, install frontend packages, or add routes. The optional update command only publishes missing configuration and translations. It never overwrites customized files. New defaults are loaded from the package; review the configuration file if you want to override them.

Existing method names, arguments, translations, static calls, facade access, and cache keys remain available. Both historical package cache formats are readable, so a cache flush is not required. Package details now respect vendorItemCacheTime; earlier releases incorrectly used vendorListCacheTime for those entries. Both defaults remain 100 minutes.

Quick Start

use jeremykenedy\LaravelPackagist\App\Services\PackagistApiServices;

$package = PackagistApiServices::getVendorsPackageDetails('laravel/framework');
$downloads = PackagistApiServices::getPackageTotalDownloads('laravel/framework');
$packages = PackagistApiServices::getPackagistVendorRepositoriesList('laravel');

The PackagistApiServices class alias and jeremykenedy\LaravelPackagist\LaravelPackagistFacade are also available. Vendor methods use laravelpackagist.vendor.default when no vendor is supplied.

The following examples belong in your application. They do not require a frontend integration package.

Blade

Fetch data in your controller:

public function show()
{
    return view('packages.show', [
        'downloads' => PackagistApiServices::getPackageTotalDownloads('laravel/framework'),
    ]);
}

Render it in Blade:

<p>Total downloads: {{ $downloads }}</p>

Livewire

Load the statistic in your component:

public $downloads;

public function mount()
{
    $this->downloads = PackagistApiServices::getPackageTotalDownloads('laravel/framework');
}

Use {{ $downloads }} in its Blade view. Import PackagistApiServices in the component class.

Vue, React, and Svelte

Expose the data through an application endpoint in routes/web.php:

use Illuminate\Support\Facades\Route;
use jeremykenedy\LaravelPackagist\App\Services\PackagistApiServices;

Route::get('/package-downloads', function () {
    return response()->json([
        'downloads' => PackagistApiServices::getPackageTotalDownloads('laravel/framework'),
    ]);
});

Vue:

<script setup>
import { onMounted, ref } from 'vue';

const downloads = ref('Loading...');
onMounted(async () => {
    try {
        const response = await fetch('/package-downloads');
        if (!response.ok) throw new Error('Request failed');
        downloads.value = (await response.json()).downloads;
    } catch {
        downloads.value = 'Unavailable';
    }
});
</script>

<template><p>Total downloads: {{ downloads }}</p></template>

React:

import { useEffect, useState } from 'react';

export default function PackageDownloads() {
    const [downloads, setDownloads] = useState('Loading...');

    useEffect(() => {
        let active = true;
        fetch('/package-downloads')
            .then(response => {
                if (!response.ok) throw new Error('Request failed');
                return response.json();
            })
            .then(data => { if (active) setDownloads(data.downloads); })
            .catch(() => { if (active) setDownloads('Unavailable'); });
        return () => { active = false; };
    }, []);

    return <p>Total downloads: {downloads}</p>;
}

Svelte:

<script>
    import { onMount } from 'svelte';

    let downloads = 'Loading...';
    onMount(async () => {
        try {
            const response = await fetch('/package-downloads');
            if (!response.ok) throw new Error('Request failed');
            downloads = (await response.json()).downloads;
        } catch {
            downloads = 'Unavailable';
        }
    });
</script>

<p>Total downloads: {downloads}</p>

API Methods

For compatibility, missing or malformed package names and unavailable packages return translated error strings. Missing optional statistics return null. An unavailable vendor list returns an empty collection and is not cached. Vendor totals skip unavailable packages, so a partial upstream outage can produce a partial total.

getVendorsTotalStars retains its original meaning: it sums favers, rather than github_stars. Field availability and freshness depend on the Packagist API.

Features

• Package details, download counts, repository details, and vendor totals.
• Optional Laravel caching with separate list and package lifetimes.
• Existing static service calls, class alias, and facade support.
• Configurable endpoints, request timeouts, and optional retries.
• Localized error messages.
• Install and update commands that preserve application files.

Configuration

All settings are in config/laravelpackagist.php. Existing configuration keys and environment variables are unchanged.

Retries are optional and capped at five. They apply to connection failures, HTTP 429, and HTTP 5xx responses, with delays starting at 100 milliseconds and doubling between attempts. The total timeout also limits connection time. A zero total timeout retains the existing unlimited response timeout; the default remains 30 seconds. Failed requests and invalid package responses are not cached.

PACKAGIST_DEFAULT_VENDOR=jeremykenedy
PACKAGIST_CACHE_ENABLED=true
PACKAGIST_VENDOR_LIST_CACHE_TIME_MINUTES=100
PACKAGIST_VENDOR_ITEM_CACHE_TIME_MINUTES=100
PACKAGIST_CURL_TIMEOUT=30
PACKAGIST_CURL_CONNECT_TIMEOUT=300
PACKAGIST_CURL_RETRIES=0

After changing environment settings in an application that caches configuration, rebuild that cache with php artisan config:cache.

Changing Frameworks

Laravel Packagist does not own your application's views or CSS. Blade, Livewire, Vue, React, Svelte, Bootstrap 5, and Tailwind can consume the same data without changing this package's configuration. There are no --css, --frontend, or packagist:switch options.

php artisan packagist:update publishes missing package files and preserves your configuration. Framework changes belong to your application. Run npm run build after changing frontend assets if your application uses that build script.

Artisan Commands

Install Options

Testing

composer install
composer test

The suite exercises all public API methods, service provider and facade bindings, legacy cache formats, cache lifetimes, upstream failures, real cURL requests against a local fixture server, and installation over customized files. Tests do not contact Packagist.

Pint runs separately so its PHP requirement does not raise the package's PHP minimum. Use PHP 8.3 or later for the current development tools:

composer --working-dir=tools install
composer lint
composer format

With Xdebug enabled:

XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-filter src --coverage-clover coverage/clover.xml --coverage-text

GitHub Actions runs the compatibility matrix, Pint, coverage, and an audit of the current dependency set. Legacy compatibility jobs allow older dependencies that are no longer supported upstream; they do not certify those frameworks as secure. Scrutinizer runs analysis and coverage, with an A rating required for analyzed code.

License

This package is open-sourced software licensed under the MIT license.