php-packagist-api-client
v1.0.0
Published
TypeScript client for the Packagist REST API
Maintainers
Readme
php-packagist-api-client
TypeScript client for the Packagist REST API.
Install
npm install php-packagist-api-clientUsage
import { PackagistClient } from 'php-packagist-api-client';
const packagist = new PackagistClient({
userAgent: 'my-app (mailto:[email protected])',
});
const search = await packagist.search({ query: 'monolog', perPage: 5 });
const pkg = await packagist.package('monolog/monolog');
const metadata = await packagist.package('monolog/monolog').metadata();
const stats = await packagist.package('monolog/monolog').stats();
const advisories = await packagist.securityAdvisories({
packages: ['monolog/monolog'],
});Authenticated endpoints
const packagist = new PackagistClient({
username: 'packagist-user',
apiToken: process.env.PACKAGIST_TOKEN,
userAgent: 'release-bot (mailto:[email protected])',
});
await packagist.updatePackage('https://packagist.org/packages/vendor/package');API coverage
listPackages()->GET /packages/list.jsonpopular()->GET /explore/popular.jsonsearch()->GET /search.jsonpackage(name).get()->GET /packages/[vendor]/[package].jsonpackage(name).metadata()->GET https://repo.packagist.org/p2/[vendor]/[package].jsonpackage(name).stats()->GET /packages/[vendor]/[package]/stats.jsonmetadataChanges()->GET /metadata/changes.jsonstatistics()->GET /statistics.jsonsecurityAdvisories()->GET /api/security-advisories/createPackage(),editPackage(),updatePackage()-> authenticated package mutation endpoints
Development
npm test
npm run lint
npm run build