libraries.io 3.4.7 → 3.6.0

package/README.md

@@ -1,6 +1,6 @@
 # libraries.io [![npm version](https://img.shields.io/npm/v/libraries.io.svg)](https://www.npmjs.com/package/libraries.io)
 
-A [libraries.io](https://libraries.io) API client. For a documentation on the API see https://libraries.io/api/.
+A [libraries.io](https://libraries.io) API client. For a documentation on the API see [the libraries.io API reference](https://libraries.io/api/).
 
 ### Installation
 

package/dist/api/GitHub/GitHubRepositoryAPI.d.ts

@@ -5,7 +5,6 @@ export declare class GitHubRepositoryAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
     /**
      * Get a list of packages referencing the given repository.
-     * @see https://libraries.io/api#repository-projects
      * @param repositoryOwner The repository owner
      * @param repositoryName The repository name
      * @param options Pagination Options
@@ -13,14 +12,12 @@ export declare class GitHubRepositoryAPI extends APIBase {
     getProjects(repositoryOwner: string, repositoryName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
     /**
      * Get a info for a repository. Currently only works for open source repositories.
-     * @see https://libraries.io/api#repository
      * @param repositoryOwner The repository owner
      * @param repositoryName The repository name
      */
     getRepository(repositoryOwner: string, repositoryName: string): Promise<LibrariesIOResult<RepositoryWithDependencies>>;
     /**
      * Get a list of dependencies for a repositories. Currently only works for open source repositories.
-     * @see https://libraries.io/api#repository-dependencies
      * @param repositoryOwner The repository owner
      * @param repositoryName The repository name
      */

package/dist/api/GitHub/GitHubRepositoryAPI.js

@@ -18,7 +18,6 @@ class GitHubRepositoryAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of packages referencing the given repository.
-     * @see https://libraries.io/api#repository-projects
      * @param repositoryOwner The repository owner
      * @param repositoryName The repository name
      * @param options Pagination Options
@@ -32,7 +31,6 @@ class GitHubRepositoryAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a info for a repository. Currently only works for open source repositories.
-     * @see https://libraries.io/api#repository
      * @param repositoryOwner The repository owner
      * @param repositoryName The repository name
      */
@@ -45,7 +43,6 @@ class GitHubRepositoryAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of dependencies for a repositories. Currently only works for open source repositories.
-     * @see https://libraries.io/api#repository-dependencies
      * @param repositoryOwner The repository owner
      * @param repositoryName The repository name
      */

package/dist/api/GitHub/GitHubUserAPI.d.ts

@@ -5,14 +5,12 @@ export declare class GitHubUserAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
     /**
      * Get a list of packages that the given user has contributed to.
-     * @see https://libraries.io/api#user-project-contributions
      * @param userName The username
      * @param options Pagination options
      */
     getContributedProjects(userName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
     /**
      * Get a list of repositories that the given user has contributed to.
-     * @see https://libraries.io/api#user-repository-contributions
      * @param userName The username
      * @param options Pagination options
      */
@@ -21,21 +19,18 @@ export declare class GitHubUserAPI extends APIBase {
     getDependencies(userName: string, platform?: PlatformType, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
     /**
      * Get a list of packages referencing the given user's repositories.
-     * @see https://libraries.io/api#user-projects
      * @param userName The username
      * @param options Pagination options
      */
     getProjects(userName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
     /**
      * Get repositories owned by a user.
-     * @see https://libraries.io/api#user-repositories
      * @param userName The username
      * @param options Pagination options
      */
     getRepositories(userName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Repository[]>>;
     /**
      * Get information for a given user or organization.
-     * @see https://libraries.io/api#user
      * @param userName The username
      */
     getUser(userName: string): Promise<LibrariesIOResult<Contributor>>;

package/dist/api/GitHub/GitHubUserAPI.js

@@ -18,7 +18,6 @@ class GitHubUserAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of packages that the given user has contributed to.
-     * @see https://libraries.io/api#user-project-contributions
      * @param userName The username
      * @param options Pagination options
      */
@@ -31,7 +30,6 @@ class GitHubUserAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of repositories that the given user has contributed to.
-     * @see https://libraries.io/api#user-repository-contributions
      * @param userName The username
      * @param options Pagination options
      */
@@ -44,14 +42,13 @@ class GitHubUserAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of unique packages that the given user's repositories list as a dependency. Ordered by frequency of use in those repositories.
-     * @see https://libraries.io/api#user-dependencies
      * @param userName The username
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param options Pagination options
      */
     getDependencies(userName, platformOrOptions, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.GitHub.User.contributedRepositories(userName);
+            const endpoint = Endpoints_1.Endpoint.GitHub.User.dependencies(userName);
             let parameters = {};
             if (platformOrOptions) {
                 if (typeof platformOrOptions === 'string') {
@@ -67,20 +64,18 @@ class GitHubUserAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of packages referencing the given user's repositories.
-     * @see https://libraries.io/api#user-projects
      * @param userName The username
      * @param options Pagination options
      */
     getProjects(userName, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.GitHub.User.repositories(userName);
+            const endpoint = Endpoints_1.Endpoint.GitHub.User.projects(userName);
             const { data } = yield this.apiClient.get(endpoint, { data: options });
             return data;
         });
     }
     /**
      * Get repositories owned by a user.
-     * @see https://libraries.io/api#user-repositories
      * @param userName The username
      * @param options Pagination options
      */
@@ -93,7 +88,6 @@ class GitHubUserAPI extends APIBase_1.APIBase {
     }
     /**
      * Get information for a given user or organization.
-     * @see https://libraries.io/api#user
      * @param userName The username
      */
     getUser(userName) {

package/dist/api/PlatformAPI.d.ts

@@ -5,7 +5,6 @@ export declare class PlatformAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
     /**
      * Get list of supported package managers.
-     * @see https://libraries.io/api#platforms
      * @param options Pagination options
      */
     getPlatforms(options?: PaginationOptions): Promise<LibrariesIOResult<Platform[]>>;

package/dist/api/PlatformAPI.js

@@ -18,7 +18,6 @@ class PlatformAPI extends APIBase_1.APIBase {
     }
     /**
      * Get list of supported package managers.
-     * @see https://libraries.io/api#platforms
      * @param options Pagination options
      */
     getPlatforms(options) {

package/dist/api/ProjectAPI.d.ts

@@ -5,7 +5,6 @@ export declare class ProjectAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
     /**
      * Get users that have contributed to a given project.
-     * @see https://libraries.io/api#project-contributors
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Pagination options
@@ -17,25 +16,22 @@ export declare class ProjectAPI extends APIBase {
      * @param projectName The project name
      * @param options Pagination options
      */
-    getDependendentRepositories(platform: PlatformType, projectName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Repository[]>>;
+    getDependentRepositories(platform: PlatformType, projectName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Repository[]>>;
     /**
      * Get packages that have at least one version that depends on a given project.
-     * @see https://libraries.io/api#project-dependents
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Pagination options
      */
-    getDependendents(platform: PlatformType, projectName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
+    getDependents(platform: PlatformType, projectName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
     /**
      * Get information about a package and it's versions.
-     * @see https://libraries.io/api#project
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
     getProject(platform: PlatformType, projectName: string): Promise<LibrariesIOResult<Project>>;
     /**
      * Get a list of dependencies for a version of a project, pass `latest` as version to get dependency info for the latest available version
-     * @see https://libraries.io/api#project-dependencies
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param projectVersion
@@ -43,7 +39,6 @@ export declare class ProjectAPI extends APIBase {
     getProjectWithDependencies(platform: PlatformType, projectName: string, projectVersion: string): Promise<LibrariesIOResult<ProjectWithDependencies>>;
     /**
      * Get breakdown of SourceRank score for a given project.
-     * @see https://libraries.io/api#project-sourcerank
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
@@ -56,7 +51,6 @@ export declare class ProjectAPI extends APIBase {
     getUsage(platform: PlatformType, projectName: string): Promise<LibrariesIOResult<ProjectUsage>>;
     /**
      * Search for projects.
-     * @see https://libraries.io/api#project-search
      * @param query The search query
      * @param options Sorting, filter and pagination options
      */

package/dist/api/ProjectAPI.js

@@ -18,14 +18,13 @@ class ProjectAPI extends APIBase_1.APIBase {
     }
     /**
      * Get users that have contributed to a given project.
-     * @see https://libraries.io/api#project-contributors
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Pagination options
      */
     getContributors(platform, projectName, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Project.dependents(platform, projectName);
+            const endpoint = Endpoints_1.Endpoint.Project.contributors(platform, projectName);
             const { data } = yield this.apiClient.get(endpoint, { data: options });
             return data;
         });
@@ -36,21 +35,20 @@ class ProjectAPI extends APIBase_1.APIBase {
      * @param projectName The project name
      * @param options Pagination options
      */
-    getDependendentRepositories(platform, projectName, options) {
+    getDependentRepositories(platform, projectName, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Project.dependents(platform, projectName);
+            const endpoint = Endpoints_1.Endpoint.Project.dependentRepositories(platform, projectName);
             const { data } = yield this.apiClient.get(endpoint, { data: options });
             return data;
         });
     }
     /**
      * Get packages that have at least one version that depends on a given project.
-     * @see https://libraries.io/api#project-dependents
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Pagination options
      */
-    getDependendents(platform, projectName, options) {
+    getDependents(platform, projectName, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const endpoint = Endpoints_1.Endpoint.Project.dependents(platform, projectName);
             const { data } = yield this.apiClient.get(endpoint, { data: options });
@@ -59,7 +57,6 @@ class ProjectAPI extends APIBase_1.APIBase {
     }
     /**
      * Get information about a package and it's versions.
-     * @see https://libraries.io/api#project
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
@@ -72,7 +69,6 @@ class ProjectAPI extends APIBase_1.APIBase {
     }
     /**
      * Get a list of dependencies for a version of a project, pass `latest` as version to get dependency info for the latest available version
-     * @see https://libraries.io/api#project-dependencies
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param projectVersion
@@ -86,7 +82,6 @@ class ProjectAPI extends APIBase_1.APIBase {
     }
     /**
      * Get breakdown of SourceRank score for a given project.
-     * @see https://libraries.io/api#project-sourcerank
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
@@ -104,14 +99,13 @@ class ProjectAPI extends APIBase_1.APIBase {
      */
     getUsage(platform, projectName) {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Project.sourceRank(platform, projectName);
+            const endpoint = Endpoints_1.Endpoint.Project.usage(platform, projectName);
             const { data } = yield this.apiClient.get(endpoint);
             return data;
         });
     }
     /**
      * Search for projects.
-     * @see https://libraries.io/api#project-search
      * @param query The search query
      * @param options Sorting, filter and pagination options
      */

package/dist/api/UserAPI.d.ts

@@ -5,20 +5,17 @@ export declare class UserAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
     /**
      * List packages that a user is subscribed to recieved notifications about new releases.
-     * @see https://libraries.io/api#subscriptions-index
      * @param options Pagination options
      */
     getAllSubscriptions(options?: PaginationOptions): Promise<LibrariesIOResult<Subscription[]>>;
     /**
      * Check if a users is subscribed to receive notifications about new releases of a project.
-     * @see https://libraries.io/api#subscriptions-show
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
     getSubscription(platform: PlatformType, projectName: string): Promise<LibrariesIOResult<null | Subscription>>;
     /**
      * Subscribe to receive notifications about new releases of a project.
-     * @see https://libraries.io/api#subscriptions-create
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Subscription options
@@ -26,14 +23,12 @@ export declare class UserAPI extends APIBase {
     subscribe(platform: PlatformType, projectName: string, options?: PreReleaseOptions): Promise<LibrariesIOResult<Subscription>>;
     /**
      * Stop receiving release notifications from a project.
-     * @see https://libraries.io/api#subscriptions-destroy
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
     unsubscribe(platform: PlatformType, projectName: string): Promise<LibrariesIOHeaders>;
     /**
      * Update the options for a subscription.
-     * @see https://libraries.io/api#subscriptions-update
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Subscription options

package/dist/api/UserAPI.js

@@ -18,7 +18,6 @@ class UserAPI extends APIBase_1.APIBase {
     }
     /**
      * List packages that a user is subscribed to recieved notifications about new releases.
-     * @see https://libraries.io/api#subscriptions-index
      * @param options Pagination options
      */
     getAllSubscriptions(options) {
@@ -30,7 +29,6 @@ class UserAPI extends APIBase_1.APIBase {
     }
     /**
      * Check if a users is subscribed to receive notifications about new releases of a project.
-     * @see https://libraries.io/api#subscriptions-show
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
@@ -43,7 +41,6 @@ class UserAPI extends APIBase_1.APIBase {
     }
     /**
      * Subscribe to receive notifications about new releases of a project.
-     * @see https://libraries.io/api#subscriptions-create
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Subscription options
@@ -57,7 +54,6 @@ class UserAPI extends APIBase_1.APIBase {
     }
     /**
      * Stop receiving release notifications from a project.
-     * @see https://libraries.io/api#subscriptions-destroy
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      */
@@ -70,7 +66,6 @@ class UserAPI extends APIBase_1.APIBase {
     }
     /**
      * Update the options for a subscription.
-     * @see https://libraries.io/api#subscriptions-update
      * @param platform The project platform (e.g. "npm", "cargo", ...)
      * @param projectName The project name
      * @param options Subscription options

package/package.json

@@ -7,9 +7,9 @@
   "devDependencies": {
     "@types/node": "~24",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2",
-    "vitest": "4.1.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3",
+    "vitest": "4.1.5"
   },
   "engines": {
     "node": ">= 21"
@@ -37,5 +37,5 @@
     "dist": "yarn clean && yarn build",
     "test": "vitest"
   },
-  "version": "3.4.7"
+  "version": "3.6.0"
 }