Class PackagistClient

Main entry point for the Packagist API.

Example

import { PackagistClient } from 'php-packagist-api-client';

const packagist = new PackagistClient({
  userAgent: 'my-app (mailto:me@example.com)',
});

const pkg = await packagist.package('monolog/monolog');
const search = await packagist.search({ query: 'logger', perPage: 5 });

Index

Constructors

constructor

Methods

on package listPackages popular search metadataChanges statistics securityAdvisories createPackage editPackage updatePackage

Constructors

constructor

new PackagistClient(options?: PackagistClientOptions): PackagistClient
Parameters
- options: PackagistClientOptions = {}
Returns PackagistClient
- Defined in src/PackagistClient.ts:87

Methods

on

on<K extends "request">(event: K, callback: PackagistClientEvents[K]): this
Subscribes to client request events.
Type Parameters
- K extends "request"
Parameters
- event: K
  Event name to subscribe to.
- callback: PackagistClientEvents[K]
  Function invoked after each request succeeds or fails.
Returns this
The current client for chaining.
- Defined in src/PackagistClient.ts:102

package

package(name: `${string}/${string}`): PackageResource
Creates an awaitable resource for one Packagist package.

The returned resource can be awaited directly, or used to access package metadata, stats, and advisories.
Parameters
- name: `${string}/${string}`
  Composer package name in vendor/package form.
Returns PackageResource
Chainable package resource.
- Defined in src/PackagistClient.ts:118

listPackages

listPackages(
options?: PackageListOptions,
signal?: AbortSignal,
): Promise<PackageListResponse>
Lists package names from Packagist.

Wraps GET /packages/list.json. Supports filtering by vendor or package type, and can request extra fields such as repository URL, package type, and abandoned status.
Parameters
- options: PackageListOptions = {}
  Optional vendor/type filters and extra fields.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageListResponse>
Package names, or package metadata when fields are requested.
- Defined in src/PackagistClient.ts:141

popular(
options?: PopularPackagesOptions,
signal?: AbortSignal,
): Promise<PopularPackagesResponse>
Lists popular packages ranked by recent downloads.

Wraps GET /explore/popular.json.
Parameters
- options: PopularPackagesOptions = {}
  Pagination options.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PopularPackagesResponse>
Popular package summaries and pagination metadata.
- Defined in src/PackagistClient.ts:168

search

search(
options: SearchPackagesOptions,
signal?: AbortSignal,
): Promise<SearchPackagesResponse>
Searches packages by query, tag, type, or combined filters.

Wraps GET /search.json. At least one of query, tags, or type must be provided.
Parameters
- options: SearchPackagesOptions
  Search filters and pagination options.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<SearchPackagesResponse>
Search results from Packagist.
- Defined in src/PackagistClient.ts:192

metadataChanges

metadataChanges(
options?: MetadataChangesOptions,
signal?: AbortSignal,
): Promise<MetadataChangesResponse>
Polls Packagist metadata changes.

Wraps GET /metadata/changes.json. Pass a stored timestamp in since to fetch package updates/deletes since that point.
Parameters
- options: MetadataChangesOptions = {}
  Timestamp filter.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<MetadataChangesResponse>
Metadata change actions or initialization timestamp/error payload.
- Defined in src/PackagistClient.ts:230

statistics

statistics(signal?: AbortSignal): Promise<StatisticsResponse>
Gets global Packagist statistics.

Wraps GET /statistics.json.
Parameters
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<StatisticsResponse>
Total download statistics.
- Defined in src/PackagistClient.ts:252

securityAdvisories

securityAdvisories(
options: SecurityAdvisoriesOptions,
signal?: AbortSignal,
): Promise<SecurityAdvisoriesResponse>
Lists security advisories for packages or updates since a timestamp.

Wraps GET /api/security-advisories/.
Parameters
- options: SecurityAdvisoriesOptions
  Package names/PURLs or updatedSince timestamp.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<SecurityAdvisoriesResponse>
Advisories keyed by package name.
- Defined in src/PackagistClient.ts:272

createPackage

createPackage(
repository: string,
signal?: AbortSignal,
): Promise<PackageMutationResponse>
Creates a Packagist package from a repository URL.

Requires authentication with the MAIN token.
Parameters
- repository: string
  Source repository URL.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageMutationResponse>
Mutation status.
- Defined in src/PackagistClient.ts:302

editPackage

editPackage(
    name: `${string}/${string}`,
    repository: string,
    signal?: AbortSignal,
): Promise<PackageMutationResponse>
Edits the repository URL for an existing package.

Requires authentication with the MAIN token.
Parameters
- name: `${string}/${string}`
  Package name in vendor/package form.
- repository: string
  New source repository URL.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageMutationResponse>
Mutation status.
- Defined in src/PackagistClient.ts:323

updatePackage

updatePackage(
repository: string,
signal?: AbortSignal,
): Promise<PackageUpdateResponse>
Triggers Packagist update for a repository or package URL.

Requires authentication with a SAFE or MAIN token.
Parameters
- repository: string
  Repository URL or Packagist package URL.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageUpdateResponse>
Update status and queued job IDs when provided by Packagist.
- Defined in src/PackagistClient.ts:347

Class PackagistClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PackagistClient

Methods

on

Type Parameters

Parameters

Returns this

package

Parameters

Returns PackageResource

listPackages

Parameters

Returns Promise<PackageListResponse>

popular

Parameters

Returns Promise<PopularPackagesResponse>

search

Parameters

Returns Promise<SearchPackagesResponse>

metadataChanges

Parameters

Returns Promise<MetadataChangesResponse>

statistics

Parameters

Returns Promise<StatisticsResponse>

securityAdvisories

Parameters

Returns Promise<SecurityAdvisoriesResponse>

createPackage

Parameters

Returns Promise<PackageMutationResponse>

editPackage

Parameters

Returns Promise<PackageMutationResponse>

updatePackage

Parameters

Returns Promise<PackageUpdateResponse>

Settings

On This Page