libraries.io 3.4.6 → 3.5.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/Endpoints.d.ts

@@ -0,0 +1,45 @@
+export declare const Endpoint: {
+    CONTRIBUTORS: string;
+    DEPENDENCIES: string;
+    DEPENDENT_REPOSITORIES: string;
+    DEPENDENTS: string;
+    GITHUB: string;
+    GitHub: {
+        Repository: {
+            dependencies(owner: string, name: string): string;
+            projects(owner: string, name: string): string;
+            repository(owner: string, name: string): string;
+        };
+        User: {
+            contributedProjects(login: string): string;
+            contributedRepositories(login: string): string;
+            dependencies(login: string): string;
+            packages(login: string): string;
+            projects(login: string): string;
+            repositories(login: string): string;
+            user(login: string): string;
+        };
+    };
+    PLATFORMS: string;
+    platforms(): string;
+    Project: {
+        contributors(platform: string, name: string): string;
+        dependencies(platform: string, name: string, version: string): string;
+        dependentRepositories(platform: string, name: string): string;
+        dependents(platform: string, name: string): string;
+        project(platform: string, name: string): string;
+        search(): string;
+        sourceRank(platform: string, name: string): string;
+        subscriptions(platform: string, name: string): string;
+        usage(platform: string, name: string): string;
+    };
+    PROJECT_CONTRIBUTIONS: string;
+    PROJECTS: string;
+    REPOSITORIES: string;
+    REPOSITORY_CONTRIBUTIONS: string;
+    SEARCH: string;
+    SOURCERANK: string;
+    SUBSCRIPTIONS: string;
+    subscriptions(platform?: string, name?: string): string;
+    USAGE: string;
+};

package/dist/Endpoints.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+const encode = encodeURIComponent;
+exports.Endpoint = {
+    CONTRIBUTORS: 'contributors',
+    DEPENDENCIES: 'dependencies',
+    DEPENDENT_REPOSITORIES: 'dependent_repositories',
+    DEPENDENTS: 'dependents',
+    GITHUB: 'github',
+    GitHub: {
+        Repository: {
+            dependencies(owner, name) {
+                return `/${exports.Endpoint.GITHUB}/${encode(owner)}/${encode(name)}/${exports.Endpoint.DEPENDENCIES}/`;
+            },
+            projects(owner, name) {
+                return `/${exports.Endpoint.GITHUB}/${encode(owner)}/${encode(name)}/${exports.Endpoint.PROJECTS}/`;
+            },
+            repository(owner, name) {
+                return `/${exports.Endpoint.GITHUB}/${encode(owner)}/${encode(name)}/`;
+            },
+        },
+        User: {
+            contributedProjects(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/${exports.Endpoint.PROJECT_CONTRIBUTIONS}/`;
+            },
+            contributedRepositories(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/${exports.Endpoint.REPOSITORY_CONTRIBUTIONS}/`;
+            },
+            dependencies(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/${exports.Endpoint.DEPENDENCIES}/`;
+            },
+            packages(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/${exports.Endpoint.PROJECTS}/`;
+            },
+            projects(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/${exports.Endpoint.PROJECTS}/`;
+            },
+            repositories(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/${exports.Endpoint.REPOSITORIES}/`;
+            },
+            user(login) {
+                return `/${exports.Endpoint.GITHUB}/${encode(login)}/`;
+            },
+        },
+    },
+    PLATFORMS: 'platforms',
+    platforms() {
+        return `/${exports.Endpoint.PLATFORMS}/`;
+    },
+    Project: {
+        contributors(platform, name) {
+            return `/${encode(platform)}/${encode(name)}/${exports.Endpoint.CONTRIBUTORS}/`;
+        },
+        dependencies(platform, name, version) {
+            return `/${encode(platform)}/${encode(name)}/${encode(version)}/${exports.Endpoint.DEPENDENCIES}/`;
+        },
+        dependentRepositories(platform, name) {
+            return `/${encode(platform)}/${encode(name)}/${exports.Endpoint.DEPENDENT_REPOSITORIES}/`;
+        },
+        dependents(platform, name) {
+            return `/${encode(platform)}/${encode(name)}/${exports.Endpoint.DEPENDENTS}/`;
+        },
+        project(platform, name) {
+            return `/${encode(platform)}/${encode(name)}/`;
+        },
+        search() {
+            return `/${exports.Endpoint.SEARCH}/`;
+        },
+        sourceRank(platform, name) {
+            return `/${encode(platform)}/${encode(name)}/${exports.Endpoint.SOURCERANK}/`;
+        },
+        subscriptions(platform, name) {
+            return `/${exports.Endpoint.SUBSCRIPTIONS}/${encode(platform)}/${encode(name)}/`;
+        },
+        usage(platform, name) {
+            return `/${encode(platform)}/${encode(name)}/${exports.Endpoint.USAGE}/`;
+        },
+    },
+    PROJECT_CONTRIBUTIONS: 'project-contributions',
+    PROJECTS: 'projects',
+    REPOSITORIES: 'repositories',
+    REPOSITORY_CONTRIBUTIONS: 'repository-contributions',
+    SEARCH: 'search',
+    SOURCERANK: 'sourcerank',
+    SUBSCRIPTIONS: 'subscriptions',
+    subscriptions(platform, name) {
+        let endpoint = `/${exports.Endpoint.SUBSCRIPTIONS}/`;
+        if (platform && name) {
+            endpoint += `${encode(platform)}/${encode(name)}/`;
+        }
+        return endpoint;
+    },
+    USAGE: 'usage',
+};

package/dist/LibrariesIO.d.ts

@@ -0,0 +1,18 @@
+import type { API, ClientOptions } from './interfaces/';
+export declare class LibrariesIO {
+    readonly api: API;
+    private readonly apiClient;
+    private readonly options;
+    constructor(apiKey: string);
+    constructor(options: ClientOptions);
+    /**
+     * Set a new API key.
+     * @param apiKey The new API key
+     */
+    setApiKey(apiKey: string): void;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+}

package/dist/LibrariesIO.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LibrariesIO = void 0;
+const api_client_1 = require("@ffflorian/api-client");
+const api_1 = require("./api");
+class LibrariesIO {
+    constructor(options) {
+        if (typeof options === 'string') {
+            options = { apiKey: options };
+        }
+        this.options = Object.assign({ apiUrl: 'https://libraries.io/api' }, options);
+        this.apiClient = new api_client_1.APIClient(this.options.apiUrl);
+        this.apiClient.interceptors.request.push(options => {
+            if (options.body) {
+                const body = JSON.parse(options.body.toString());
+                body.api_key = this.options.apiKey;
+                options.body = JSON.stringify(body);
+            }
+            else {
+                const body = { api_key: this.options.apiKey };
+                options.body = JSON.stringify(body);
+            }
+            return options;
+        });
+        this.apiClient.interceptors.response.push(response => {
+            const headers = response.headers;
+            if (headers.get('total')) {
+                return Object.assign(Object.assign({}, response), { totalResults: Number(headers.get('total')) });
+            }
+            return response;
+        });
+        this.api = {
+            github: {
+                repository: new api_1.GitHubRepositoryAPI(this.apiClient, this.options),
+                user: new api_1.GitHubUserAPI(this.apiClient, this.options),
+            },
+            platform: new api_1.PlatformAPI(this.apiClient, this.options),
+            project: new api_1.ProjectAPI(this.apiClient, this.options),
+            user: new api_1.UserAPI(this.apiClient, this.options),
+        };
+    }
+    /**
+     * Set a new API key.
+     * @param apiKey The new API key
+     */
+    setApiKey(apiKey) {
+        this.options.apiKey = apiKey;
+    }
+    /*
+  
+        const contentType = headers['content-type'] ? String(headers['content-type']) : undefined;
+        const rateLimit = Number(headers['x-ratelimit-limit']);
+        const rateLimitRemaining = Number(headers['x-ratelimit-remaining']);
+        const totalResults = headers['total'] ? Number(headers['total']) : undefined;
+    */
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+}
+exports.LibrariesIO = LibrariesIO;

package/dist/api/APIBase.d.ts

@@ -0,0 +1,18 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ClientOptions } from '../interfaces';
+export declare class APIBase {
+    protected readonly apiClient: APIClient;
+    protected readonly options: ClientOptions;
+    constructor(apiClient: APIClient, options: ClientOptions);
+    /**
+     * Set a new API key.
+     * @param apiKey The new API key
+     */
+    setApiKey(apiKey: string): void;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+    protected checkApiKey(apiName?: string): void;
+}

package/dist/api/APIBase.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIBase = void 0;
+class APIBase {
+    constructor(apiClient, options) {
+        this.apiClient = apiClient;
+        this.options = options;
+    }
+    /**
+     * Set a new API key.
+     * @param apiKey The new API key
+     */
+    setApiKey(apiKey) {
+        this.options.apiKey = apiKey;
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+    checkApiKey(apiName) {
+        const name = apiName ? `the "${apiName}"` : 'this';
+        if (!this.options.apiKey) {
+            throw new Error(`An API key needs to be set in order to use ${name} API`);
+        }
+    }
+}
+exports.APIBase = APIBase;

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

@@ -0,0 +1,28 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ClientOptions, LibrariesIOResult, PaginationOptions, Project, RepositoryWithDependencies } from '../../interfaces/';
+import { APIBase } from '../APIBase';
+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
+     */
+    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
+     */
+    getRepositoryWithDependencies(repositoryOwner: string, repositoryName: string): Promise<LibrariesIOResult<RepositoryWithDependencies>>;
+}

package/dist/api/GitHub/GitHubRepositoryAPI.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubRepositoryAPI = void 0;
+const Endpoints_1 = require("../../Endpoints");
+const APIBase_1 = require("../APIBase");
+class GitHubRepositoryAPI extends APIBase_1.APIBase {
+    constructor(apiClient, options) {
+        super(apiClient, options);
+    }
+    /**
+     * 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
+     */
+    getProjects(repositoryOwner, repositoryName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.Repository.projects(repositoryOwner, repositoryName);
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * 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, repositoryName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.Repository.repository(repositoryOwner, repositoryName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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
+     */
+    getRepositoryWithDependencies(repositoryOwner, repositoryName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.Repository.dependencies(repositoryOwner, repositoryName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.GitHubRepositoryAPI = GitHubRepositoryAPI;

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

@@ -0,0 +1,42 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ClientOptions, Contributor, LibrariesIOResult, PaginationOptions, PlatformType, Project, Repository } from '../../interfaces/';
+import { APIBase } from '../APIBase';
+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
+     */
+    getContributedRepositories(userName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Repository[]>>;
+    getDependencies(userName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Project[]>>;
+    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

@@ -0,0 +1,107 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubUserAPI = void 0;
+const Endpoints_1 = require("../../Endpoints");
+const APIBase_1 = require("../APIBase");
+class GitHubUserAPI extends APIBase_1.APIBase {
+    constructor(apiClient, options) {
+        super(apiClient, options);
+    }
+    /**
+     * 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, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.User.contributedProjects(userName);
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * 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
+     */
+    getContributedRepositories(userName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.User.contributedRepositories(userName);
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * 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.dependencies(userName);
+            let parameters = {};
+            if (platformOrOptions) {
+                if (typeof platformOrOptions === 'string') {
+                    parameters = Object.assign({ platform: platformOrOptions }, options);
+                }
+                else {
+                    parameters = platformOrOptions;
+                }
+            }
+            const { data } = yield this.apiClient.get(endpoint, { data: parameters });
+            return data;
+        });
+    }
+    /**
+     * 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.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
+     */
+    getRepositories(userName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.User.repositories(userName);
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * Get information for a given user or organization.
+     * @see https://libraries.io/api#user
+     * @param userName The username
+     */
+    getUser(userName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.GitHub.User.user(userName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.GitHubUserAPI = GitHubUserAPI;

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

@@ -0,0 +1,2 @@
+export * from './GitHubRepositoryAPI';
+export * from './GitHubUserAPI';

package/dist/api/GitHub/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./GitHubRepositoryAPI"), exports);
+__exportStar(require("./GitHubUserAPI"), exports);

package/dist/api/PlatformAPI.d.ts

@@ -0,0 +1,12 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ClientOptions, LibrariesIOResult, PaginationOptions, Platform } from '../interfaces/';
+import { APIBase } from './APIBase';
+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

@@ -0,0 +1,32 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+const APIBase_1 = require("./APIBase");
+class PlatformAPI extends APIBase_1.APIBase {
+    constructor(apiClient, options) {
+        super(apiClient, options);
+    }
+    /**
+     * Get list of supported package managers.
+     * @see https://libraries.io/api#platforms
+     * @param options Pagination options
+     */
+    getPlatforms(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.platforms();
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+}
+exports.PlatformAPI = PlatformAPI;

package/dist/api/ProjectAPI.d.ts

@@ -0,0 +1,64 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ClientOptions, Contributor, LibrariesIOResult, PaginationOptions, PlatformType, Project, ProjectUsage, ProjectWithDependencies, Repository, SearchOptions } from '../interfaces/';
+import { APIBase } from './APIBase';
+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
+     */
+    getContributors(platform: PlatformType, projectName: string, options?: PaginationOptions): Promise<LibrariesIOResult<Contributor[]>>;
+    /**
+     * Get repositories that depend on a given project.
+     * @param platform The project platform (e.g. "npm", "cargo", ...)
+     * @param projectName The project name
+     * @param options Pagination options
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    getSourceRank(platform: PlatformType, projectName: string): Promise<LibrariesIOResult<number>>;
+    /**
+     * Get breakdown of version usage for a given project.
+     * @param platform The project platform (e.g. "npm", "cargo", ...)
+     * @param projectName The project name
+     */
+    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
+     */
+    search(query: string, options?: SearchOptions): Promise<LibrariesIOResult<Project[]>>;
+}