libraries.io 3.4.6 → 3.5.0

package/dist/api/ProjectAPI.js

@@ -0,0 +1,127 @@
+"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.ProjectAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+const APIBase_1 = require("./APIBase");
+class ProjectAPI extends APIBase_1.APIBase {
+    constructor(apiClient, options) {
+        super(apiClient, options);
+    }
+    /**
+     * 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.contributors(platform, projectName);
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * 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, projectName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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
+     */
+    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 });
+            return data;
+        });
+    }
+    /**
+     * 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, projectName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Project.project(platform, projectName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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, projectName, projectVersion) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Project.dependencies(platform, projectName, projectVersion);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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, projectName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Project.sourceRank(platform, projectName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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, projectName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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
+     */
+    search(query, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Project.search();
+            // eslint-disable-next-line id-length
+            const { data } = yield this.apiClient.get(endpoint, { data: Object.assign(Object.assign({}, options), { q: query }) });
+            return data;
+        });
+    }
+}
+exports.ProjectAPI = ProjectAPI;

package/dist/api/UserAPI.d.ts

@@ -0,0 +1,42 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { ClientOptions, LibrariesIOHeaders, LibrariesIOResult, PaginationOptions, PlatformType, PreReleaseOptions, Subscription } from '../interfaces/';
+import { APIBase } from './APIBase';
+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
+     */
+    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
+     */
+    updateSubscription(platform: PlatformType, projectName: string, options?: PreReleaseOptions): Promise<LibrariesIOResult<Subscription>>;
+}

package/dist/api/UserAPI.js

@@ -0,0 +1,86 @@
+"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.UserAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+const APIBase_1 = require("./APIBase");
+class UserAPI extends APIBase_1.APIBase {
+    constructor(apiClient, options) {
+        super(apiClient, options);
+    }
+    /**
+     * 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) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscriptions();
+            const { data } = yield this.apiClient.get(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * 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, projectName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscriptions(platform, projectName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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
+     */
+    subscribe(platform, projectName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscriptions(platform, projectName);
+            const { data } = yield this.apiClient.post(endpoint, { data: options });
+            return data;
+        });
+    }
+    /**
+     * 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, projectName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscriptions(platform, projectName);
+            const { data } = yield this.apiClient.delete(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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
+     */
+    updateSubscription(platform, projectName, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.subscriptions(platform, projectName);
+            const { data } = yield this.apiClient.put(endpoint, { data: options });
+            return data;
+        });
+    }
+}
+exports.UserAPI = UserAPI;

package/dist/api/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GitHub/';
+export * from './PlatformAPI';
+export * from './ProjectAPI';
+export * from './UserAPI';

package/dist/api/index.js

@@ -0,0 +1,20 @@
+"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("./GitHub/"), exports);
+__exportStar(require("./PlatformAPI"), exports);
+__exportStar(require("./ProjectAPI"), exports);
+__exportStar(require("./UserAPI"), exports);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api/';
+export * from './interfaces/';
+export * from './LibrariesIO';

package/dist/index.js

@@ -0,0 +1,19 @@
+"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("./api/"), exports);
+__exportStar(require("./interfaces/"), exports);
+__exportStar(require("./LibrariesIO"), exports);

package/dist/interfaces/API.d.ts

@@ -0,0 +1,10 @@
+import { GitHubRepositoryAPI, GitHubUserAPI, PlatformAPI, ProjectAPI, UserAPI } from '../api/';
+export interface API {
+    github: {
+        repository: GitHubRepositoryAPI;
+        user: GitHubUserAPI;
+    };
+    platform: PlatformAPI;
+    project: ProjectAPI;
+    user: UserAPI;
+}

package/dist/interfaces/API.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Contributor.d.ts

@@ -0,0 +1,19 @@
+export interface Contributor {
+    bio: null | string;
+    blog: null | string;
+    company: null | string;
+    created_at: string;
+    email: null | string;
+    followers: null | number;
+    following: null | number;
+    github_id: string;
+    hidden: boolean;
+    host_type: string;
+    last_synced_at: string;
+    location: null | string;
+    login: string;
+    name: string;
+    updated_at: string;
+    user_type: string;
+    uuid: string;
+}

package/dist/interfaces/Contributor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/LibrariesIOHeaders.d.ts

@@ -0,0 +1,8 @@
+export interface LibrariesIOHeaders {
+    rateLimit: number;
+    rateLimitRemaining: number;
+    totalResults?: number;
+}
+export interface LibrariesIOResult<T> extends LibrariesIOHeaders {
+    data: T;
+}

package/dist/interfaces/LibrariesIOHeaders.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Options.d.ts

@@ -0,0 +1,31 @@
+export interface ClientOptions {
+    apiKey: string;
+    apiUrl?: string;
+}
+export interface FilterOptions {
+    keywords?: string[];
+    languages?: string[];
+    licenses?: string[];
+    platforms?: PlatformType[];
+}
+export type HttpMethod = 'delete' | 'get' | 'post' | 'put';
+export interface PaginationOptions {
+    page?: number;
+    per_page?: number;
+}
+export type PlatformType = 'alcatraz' | 'atom' | 'bower' | 'cargo' | 'carthage' | 'clojars' | 'cocoapods' | 'cpan' | 'cran' | 'dub' | 'elm' | 'emacs' | 'go' | 'hackage' | 'haxelib' | 'hex' | 'homebrew' | 'inqlude' | 'julia' | 'maven' | 'meteor' | 'nimble' | 'npm' | 'nuget' | 'packagist' | 'platformio' | 'pub' | 'puppet' | 'purescript' | 'pypi' | 'racket' | 'rubygems' | 'sublime' | 'swiftpm' | 'wordpress';
+export interface PreReleaseOptions {
+    includePreRelease?: boolean;
+}
+export interface RequestOptions extends PreReleaseOptions, SearchOptions {
+    api_key?: string;
+    platform?: PlatformType;
+    /** query */
+    q?: string;
+}
+export interface SearchOptions extends PaginationOptions {
+    filter?: FilterOptions;
+    /** sort by */
+    sort?: SortType;
+}
+export type SortType = 'contributions_count' | 'created_at' | 'dependent_repos_count' | 'dependents_count' | 'latest_release_published_at' | 'rank' | 'stars';

package/dist/interfaces/Options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Platform.d.ts

@@ -0,0 +1,7 @@
+export interface Platform {
+    color: string;
+    default_language: string;
+    homepage: null | string;
+    name: string;
+    project_count: number;
+}

package/dist/interfaces/Platform.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Project.d.ts

@@ -0,0 +1,57 @@
+import type { PlatformType } from './Options';
+export interface Project {
+    dependent_repos_count: number;
+    dependents_count: number;
+    description: null | string;
+    forks: number;
+    homepage: null | string;
+    keywords: string[];
+    language: string;
+    latest_download_url: string;
+    latest_release_number: string;
+    latest_release_published_at: string;
+    latest_stable_release: ProjectRelease;
+    name: string;
+    normalized_licenses: string[];
+    package_manager_url: string;
+    platform: string;
+    rank: number;
+    repository_url: null | string;
+    stars: number;
+    status: null | string;
+    versions: ProjectVersion[];
+}
+export interface ProjectDependency {
+    deprecated: boolean;
+    filepath: null | string;
+    kind: 'Development' | 'Optional' | 'runtime';
+    latest: string;
+    latest_stable: string;
+    name: string;
+    outdated: boolean;
+    platform: PlatformType;
+    project_name: string;
+    requirements: string;
+}
+export interface ProjectRelease {
+    created_at: string;
+    id: number;
+    number: string;
+    project_id: number;
+    published_at: string;
+    runtime_dependencies_count: null | number;
+    updated_at: string;
+}
+export interface ProjectUsage {
+    [version: string]: number;
+}
+export interface ProjectVersion {
+    number: string;
+    published_at: string;
+}
+export interface ProjectWithDependencies extends Project {
+    dependencies: ProjectDependency[];
+    dependencies_for_version: string;
+    dependent_repos_count: number;
+    dependents_count: number;
+}

package/dist/interfaces/Project.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Repository.d.ts

@@ -0,0 +1,49 @@
+import type { ProjectDependency } from '../interfaces/Project';
+export interface Repository {
+    contributions_count: null | number;
+    created_at: string;
+    default_branch: string;
+    description: string;
+    fork: false;
+    fork_policy: null | string;
+    forks_count: number;
+    full_name: string;
+    github_contributions_count: number;
+    github_id: string;
+    has_audit: null | string;
+    has_changelog: null | string;
+    has_coc: null | string;
+    has_contributing: null | string;
+    has_issues: boolean;
+    has_license: null | string;
+    has_pages: boolean;
+    has_readme: null | string;
+    has_threat_model: null | string;
+    has_wiki: boolean;
+    homepage: string;
+    host_domain: null | string;
+    host_type: string;
+    keywords: string[];
+    language: string;
+    last_synced_at: string;
+    license: string;
+    logo_url: null | string;
+    mirror_url: null | string;
+    name: null | string;
+    open_issues_count: number;
+    private: boolean;
+    pull_requests_enabled: null | string;
+    pushed_at: string;
+    rank: number;
+    scm: string;
+    size: number;
+    source_name: null | string;
+    stargazers_count: number;
+    status: null | string;
+    subscribers_count: number;
+    updated_at: string;
+    uuid: string;
+}
+export interface RepositoryWithDependencies extends Repository {
+    dependencies: ProjectDependency[];
+}

package/dist/interfaces/Repository.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Subscription.d.ts

@@ -0,0 +1,7 @@
+import type { Project } from './Project';
+export interface Subscription {
+    created_at: string;
+    include_prerelease: boolean;
+    project: Project;
+    updated_at: string;
+}

package/dist/interfaces/Subscription.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/index.d.ts

@@ -0,0 +1,8 @@
+export * from './API';
+export * from './Contributor';
+export * from './LibrariesIOHeaders';
+export * from './Options';
+export * from './Platform';
+export * from './Project';
+export * from './Repository';
+export * from './Subscription';

package/dist/interfaces/index.js

@@ -0,0 +1,24 @@
+"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("./API"), exports);
+__exportStar(require("./Contributor"), exports);
+__exportStar(require("./LibrariesIOHeaders"), exports);
+__exportStar(require("./Options"), exports);
+__exportStar(require("./Platform"), exports);
+__exportStar(require("./Project"), exports);
+__exportStar(require("./Repository"), exports);
+__exportStar(require("./Subscription"), exports);

package/package.json

@@ -1,15 +1,15 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.0"
+    "@ffflorian/api-client": "2.5.1"
   },
   "description": "A libraries.io API client",
   "devDependencies": {
     "@types/node": "~24",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2",
-    "vitest": "4.1.0"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3",
+    "vitest": "4.1.5"
   },
   "engines": {
     "node": ">= 21"
@@ -30,11 +30,12 @@
   "readme": "https://github.com/ffflorian/api-clients#readme",
   "repository": "https://github.com/ffflorian/api-clients.git",
   "scripts": {
+    "build": "yarn build:ts",
     "build:ts": "tsc -p tsconfig.build.json",
     "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/libraries.io src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
+    "dist": "yarn clean && yarn build",
     "test": "vitest"
   },
-  "version": "3.4.6"
+  "version": "3.5.0"
 }