crates.io 2.4.6 → 2.5.0

package/README.md

@@ -2,6 +2,14 @@
 
 A [crates.io](https://crates.io) API client.
 
+API references:
+
+- [Data access policy](https://crates.io/data-access)
+- [OpenAPI specification](https://crates.io/api/openapi.json)
+- [Historical HTTP API reference](https://github.com/hcpl/crates.io-http-api-reference)
+
+Some endpoints in this client require an API token (for example `following`, `follow`, `unfollow`, `yank`, and `unyank`).
+
 ### Installation
 
 Run `yarn add crates.io` or `npm install crates.io`.

package/dist/CratesIO.d.ts

@@ -0,0 +1,22 @@
+import type { API, ClientOptions, Summary } from './interfaces';
+export declare class CratesIO {
+    readonly api: API;
+    private readonly apiClient;
+    private readonly options;
+    constructor(apiKey?: string);
+    constructor(options?: ClientOptions);
+    /**
+     * Set a new API key.
+     * @param apiKey The API key
+     */
+    setApiKey(apiKey: string): void;
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+    /**
+     * Retrieve a summary containing crates.io wide information.
+     */
+    summary(): Promise<Summary>;
+}

package/dist/CratesIO.js

@@ -0,0 +1,50 @@
+"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.CratesIO = void 0;
+const api_client_1 = require("@ffflorian/api-client");
+const api_1 = require("./api");
+const Endpoints_1 = require("./Endpoints");
+class CratesIO {
+    constructor(options) {
+        this.options = typeof options === 'string' ? { apiKey: options } : options || {};
+        this.apiClient = new api_client_1.APIClient(this.options.apiUrl || 'https://crates.io/api/v1');
+        this.api = {
+            crates: new api_1.CratesAPI(this.apiClient, this.options.apiKey),
+        };
+    }
+    /**
+     * Set a new API key.
+     * @param apiKey The API key
+     */
+    setApiKey(apiKey) {
+        this.options.apiKey = apiKey;
+        this.api.crates.setApiKey(apiKey);
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+    /**
+     * Retrieve a summary containing crates.io wide information.
+     */
+    summary() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.summary();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.CratesIO = CratesIO;

package/dist/Endpoints.d.ts

@@ -0,0 +1,48 @@
+export declare const Endpoint: {
+    AUTHORS: string;
+    CATEGORIES: string;
+    Categories: {
+        categories(): string;
+        category(category: string): string;
+    };
+    CRATES: string;
+    Crates: {
+        authors(packageName: string, version: string): string;
+        crate(packageName: string): string;
+        crates(): string;
+        dependencies(packageName: string): string;
+        dependenciesByVersion(packageName: string, version: string): string;
+        download(packageName: string, version: string): string;
+        downloads(packageName: string): string;
+        follow(packageName: string): string;
+        following(packageName: string): string;
+        owners(packageName: string): string;
+        ownerTeam(packageName: string): string;
+        ownerUser(packageName: string): string;
+        reverseDependencies(packageName: string): string;
+        unyank(packageName: string, version: string): string;
+        version(packageName: string, version: string): string;
+        versionDownloads(packageName: string, version: string): string;
+        versions(packageName: string): string;
+        yank(packageName: string, version: string): string;
+    };
+    DEPENDENCIES: string;
+    DOWNLOAD: string;
+    DOWNLOADS: string;
+    FOLLOW: string;
+    FOLLOWING: string;
+    KEYWORDS: string;
+    Keywords: {
+        keyword(keyword: string): string;
+        keywords(): string;
+    };
+    OWNER_TEAM: string;
+    OWNER_USER: string;
+    OWNERS: string;
+    REVERSE_DEPENDENCIES: string;
+    SUMMARY: string;
+    summary(): string;
+    UNYANK: string;
+    VERSIONS: string;
+    YANK: string;
+};

package/dist/Endpoints.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+const encode = encodeURIComponent;
+const apiPrefix = '/api/v1';
+exports.Endpoint = {
+    AUTHORS: 'authors',
+    CATEGORIES: 'categories',
+    Categories: {
+        categories() {
+            return `${apiPrefix}/${exports.Endpoint.CATEGORIES}`;
+        },
+        category(category) {
+            return `${apiPrefix}/${exports.Endpoint.CATEGORIES}/${encode(category)}`;
+        },
+    },
+    CRATES: 'crates',
+    Crates: {
+        authors(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}/${exports.Endpoint.AUTHORS}`;
+        },
+        crate(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}`;
+        },
+        crates() {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}`;
+        },
+        dependencies(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.DEPENDENCIES}`;
+        },
+        dependenciesByVersion(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}/${exports.Endpoint.DEPENDENCIES}`;
+        },
+        download(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}/${exports.Endpoint.DOWNLOAD}`;
+        },
+        downloads(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.DOWNLOADS}`;
+        },
+        follow(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.FOLLOW}`;
+        },
+        following(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.FOLLOWING}`;
+        },
+        owners(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.OWNERS}`;
+        },
+        ownerTeam(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.OWNER_TEAM}`;
+        },
+        ownerUser(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.OWNER_USER}`;
+        },
+        reverseDependencies(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.REVERSE_DEPENDENCIES}`;
+        },
+        unyank(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}/${exports.Endpoint.UNYANK}`;
+        },
+        version(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}`;
+        },
+        versionDownloads(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}/${exports.Endpoint.DOWNLOADS}`;
+        },
+        versions(packageName) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${exports.Endpoint.VERSIONS}`;
+        },
+        yank(packageName, version) {
+            return `${apiPrefix}/${exports.Endpoint.CRATES}/${encode(packageName)}/${encode(version)}/${exports.Endpoint.YANK}`;
+        },
+    },
+    DEPENDENCIES: 'dependencies',
+    DOWNLOAD: 'download',
+    DOWNLOADS: 'downloads',
+    FOLLOW: 'follow',
+    FOLLOWING: 'following',
+    KEYWORDS: 'keywords',
+    Keywords: {
+        keyword(keyword) {
+            return `${apiPrefix}/${exports.Endpoint.KEYWORDS}/${encode(keyword)}`;
+        },
+        keywords() {
+            return `${apiPrefix}/${exports.Endpoint.KEYWORDS}`;
+        },
+    },
+    OWNER_TEAM: 'owner_team',
+    OWNER_USER: 'owner_user',
+    OWNERS: 'owners',
+    REVERSE_DEPENDENCIES: 'reverse_dependencies',
+    SUMMARY: 'summary',
+    summary() {
+        return `${apiPrefix}/${exports.Endpoint.SUMMARY}`;
+    },
+    UNYANK: 'unyank',
+    VERSIONS: 'versions',
+    YANK: 'yank',
+};

package/dist/api/CratesAPI.d.ts

@@ -0,0 +1,132 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { AuthorsResult, CategoriesResult, CategoryResult, CrateResult, DependenciesResult, DownloadsResult, FollowingResult, KeywordResult, KeywordsResult, OkResult, PaginationOptions, ReverseDependenciesResult, SearchOptions, SearchResult, TeamsResult, UrlResult, UsersResult, Version, VersionsResult } from '../interfaces/';
+export declare class CratesAPI {
+    private readonly apiClient;
+    private apiKey?;
+    constructor(apiClient: APIClient, apiKey?: string);
+    /**
+     * Follow a crate.
+     * @param packageName The package name
+     */
+    follow(packageName: string): Promise<OkResult>;
+    /**
+     * Retrieve the owners of a crate.
+     * @param packageName The package name
+     */
+    following(packageName: string): Promise<FollowingResult>;
+    /**
+     * Retrieve the owners of a crate.
+     * @param packageName The package name
+     */
+    getAuthors(packageName: string, version: string): Promise<AuthorsResult>;
+    /**
+     * Retrieve categories.
+     * @param options Pagination options
+     */
+    getCategories(options?: PaginationOptions): Promise<CategoriesResult>;
+    /**
+     * Retrieve a category.
+     * @param category The category slug
+     */
+    getCategory(category: string): Promise<CategoryResult>;
+    /**
+     * Retrieve information of a crate.
+     * @param packageName The package name
+     */
+    getCrate(packageName: string): Promise<CrateResult>;
+    /**
+     * Retrieve a page of crates, optionally constrained by a query.
+     * @param query The search query
+     * @param options The search options
+     */
+    getCrates(query: string, options?: SearchOptions): Promise<SearchResult>;
+    /**
+     * Retrieve the dependencies of a crate version.
+     * @param packageName The package name
+     */
+    getDependencies(packageName: string): Promise<DependenciesResult>;
+    /**
+     * Retrieve download stats for a crate.
+     * @param packageName The package name
+     */
+    getDownloads(packageName: string): Promise<DownloadsResult>;
+    /**
+     * Retrieve a download link for a certain version of a crate.
+     * @param packageName The package name
+     */
+    getDownloadUrl(packageName: string, version: string): Promise<UrlResult>;
+    /**
+     * Retrieve a keyword.
+     * @param keyword The keyword
+     */
+    getKeyword(keyword: string): Promise<KeywordResult>;
+    /**
+     * Retrieve keywords.
+     * @param options Pagination options
+     */
+    getKeywords(options?: PaginationOptions): Promise<KeywordsResult>;
+    /**
+     * Retrieve the owners of a crate.
+     * @param packageName The package name
+     */
+    getOwners(packageName: string): Promise<UsersResult>;
+    /**
+     * Retrieve the reverse dependencies of a crate version.
+     * @param packageName The package name
+     */
+    getReverseDependencies(packageName: string): Promise<ReverseDependenciesResult>;
+    /**
+     * Retrieve the team owner of a crate.
+     * @param packageName The package name
+     */
+    getTeamOwner(packageName: string): Promise<TeamsResult>;
+    /**
+     * Retrieve the user owner of a crate.
+     * @param packageName The package name
+     */
+    getUserOwner(packageName: string): Promise<UsersResult>;
+    /**
+     * Retrieve a specific version of a crate.
+     * @param packageName The package name
+     */
+    getVersion(packageName: string, version: string): Promise<Version>;
+    /**
+     * Retrieve the dependencies of a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    getVersionDependencies(packageName: string, version: string): Promise<DependenciesResult>;
+    /**
+     * Retrieve download stats for a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    getVersionDownloads(packageName: string, version: string): Promise<DownloadsResult>;
+    /**
+     * Retrieve all versions of a crate.
+     * @param packageName The package name
+     */
+    getVersions(packageName: string): Promise<VersionsResult>;
+    /**
+     * Set a new API key.
+     * @param apiKey The API key
+     */
+    setApiKey(apiKey: string): void;
+    /**
+     * Unfollow a crate.
+     * @param packageName The package name
+     */
+    unfollow(packageName: string): Promise<OkResult>;
+    /**
+     * Unyank a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    unyank(packageName: string, version: string): Promise<OkResult>;
+    /**
+     * Yank a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    yank(packageName: string, version: string): Promise<OkResult>;
+}

package/dist/api/CratesAPI.js

@@ -0,0 +1,336 @@
+"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.CratesAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class CratesAPI {
+    constructor(apiClient, apiKey) {
+        this.apiClient = apiClient;
+        this.apiKey = apiKey;
+    }
+    /**
+     * Follow a crate.
+     * @param packageName The package name
+     */
+    follow(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.follow(packageName);
+            if (!this.apiKey) {
+                throw new Error('You need to set an API key to use this endpoint.');
+            }
+            const additionalConfig = {
+                headers: {
+                    Authorization: this.apiKey,
+                },
+            };
+            const { data } = yield this.apiClient.put(endpoint, undefined, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the owners of a crate.
+     * @param packageName The package name
+     */
+    following(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.following(packageName);
+            if (!this.apiKey) {
+                throw new Error('You need to set an API key to use this endpoint.');
+            }
+            const additionalConfig = {
+                headers: {
+                    Authorization: this.apiKey,
+                },
+            };
+            const { data } = yield this.apiClient.get(endpoint, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the owners of a crate.
+     * @param packageName The package name
+     */
+    getAuthors(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.authors(packageName, version);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve categories.
+     * @param options Pagination options
+     */
+    getCategories(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Categories.categories();
+            const additionalConfig = {
+                params: Object.assign({}, options),
+            };
+            const { data } = yield this.apiClient.get(endpoint, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Retrieve a category.
+     * @param category The category slug
+     */
+    getCategory(category) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Categories.category(category);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve information of a crate.
+     * @param packageName The package name
+     */
+    getCrate(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.crate(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve a page of crates, optionally constrained by a query.
+     * @param query The search query
+     * @param options The search options
+     */
+    getCrates(query, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.crates();
+            const additionalConfig = {
+                params: Object.assign(Object.assign({}, options), { 
+                    // eslint-disable-next-line id-length
+                    q: query }),
+            };
+            const { data } = yield this.apiClient.get(endpoint, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the dependencies of a crate version.
+     * @param packageName The package name
+     */
+    getDependencies(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.dependencies(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve download stats for a crate.
+     * @param packageName The package name
+     */
+    getDownloads(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.downloads(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve a download link for a certain version of a crate.
+     * @param packageName The package name
+     */
+    getDownloadUrl(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.download(packageName, version);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve a keyword.
+     * @param keyword The keyword
+     */
+    getKeyword(keyword) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Keywords.keyword(keyword);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve keywords.
+     * @param options Pagination options
+     */
+    getKeywords(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Keywords.keywords();
+            const additionalConfig = {
+                params: Object.assign({}, options),
+            };
+            const { data } = yield this.apiClient.get(endpoint, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the owners of a crate.
+     * @param packageName The package name
+     */
+    getOwners(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.owners(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the reverse dependencies of a crate version.
+     * @param packageName The package name
+     */
+    getReverseDependencies(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.reverseDependencies(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the team owner of a crate.
+     * @param packageName The package name
+     */
+    getTeamOwner(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.ownerTeam(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve the user owner of a crate.
+     * @param packageName The package name
+     */
+    getUserOwner(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.ownerUser(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve a specific version of a crate.
+     * @param packageName The package name
+     */
+    getVersion(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.version(packageName, version);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data.version;
+        });
+    }
+    /**
+     * Retrieve the dependencies of a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    getVersionDependencies(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.dependenciesByVersion(packageName, version);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve download stats for a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    getVersionDownloads(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.versionDownloads(packageName, version);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Retrieve all versions of a crate.
+     * @param packageName The package name
+     */
+    getVersions(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.versions(packageName);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Set a new API key.
+     * @param apiKey The API key
+     */
+    setApiKey(apiKey) {
+        this.apiKey = apiKey;
+    }
+    /**
+     * Unfollow a crate.
+     * @param packageName The package name
+     */
+    unfollow(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.follow(packageName);
+            if (!this.apiKey) {
+                throw new Error('You need to set an API key to use this endpoint.');
+            }
+            const additionalConfig = {
+                headers: {
+                    Authorization: this.apiKey,
+                },
+            };
+            const { data } = yield this.apiClient.delete(endpoint, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Unyank a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    unyank(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.unyank(packageName, version);
+            if (!this.apiKey) {
+                throw new Error('You need to set an API key to use this endpoint.');
+            }
+            const additionalConfig = {
+                headers: {
+                    Authorization: this.apiKey,
+                },
+            };
+            const { data } = yield this.apiClient.put(endpoint, undefined, additionalConfig);
+            return data;
+        });
+    }
+    /**
+     * Yank a specific crate version.
+     * @param packageName The package name
+     * @param version The version
+     */
+    yank(packageName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Crates.yank(packageName, version);
+            if (!this.apiKey) {
+                throw new Error('You need to set an API key to use this endpoint.');
+            }
+            const additionalConfig = {
+                headers: {
+                    Authorization: this.apiKey,
+                },
+            };
+            const { data } = yield this.apiClient.delete(endpoint, additionalConfig);
+            return data;
+        });
+    }
+}
+exports.CratesAPI = CratesAPI;

package/dist/api/index.d.ts

@@ -0,0 +1 @@
+export * from './CratesAPI';

package/dist/api/index.js

@@ -0,0 +1,17 @@
+"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("./CratesAPI"), exports);

package/dist/index.d.ts

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

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("./CratesIO"), exports);
+__exportStar(require("./interfaces/"), exports);

package/dist/interfaces/API.d.ts

@@ -0,0 +1,4 @@
+import { CratesAPI } from '../api/';
+export interface API {
+    crates: CratesAPI;
+}

package/dist/interfaces/API.js

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

package/dist/interfaces/Category.d.ts

@@ -0,0 +1,8 @@
+export interface Category {
+    category: string;
+    crates_cnt: number;
+    created_at: string;
+    description: string;
+    id: string;
+    slug: string;
+}

package/dist/interfaces/Category.js

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

package/dist/interfaces/Crate.d.ts

@@ -0,0 +1,28 @@
+export interface Crate {
+    badges: object[];
+    categories: null | string[];
+    created_at: string;
+    description: null | string;
+    documentation: null | string;
+    downloads: number;
+    exact_match: boolean;
+    homepage: null | string;
+    id: string;
+    keywords: null | string[];
+    links: {
+        owner_team: string;
+        owner_user: string;
+        owners: string;
+        reverse_dependencies: string;
+        version_downloads: string;
+        versions: string;
+    };
+    max_version: string;
+    name: string;
+    recent_downloads: null | number;
+    repository: null | string;
+    trustpub_only: boolean;
+    updated_at: string;
+    versions: null | number[];
+    yanked: boolean;
+}

package/dist/interfaces/Crate.js

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

package/dist/interfaces/Dependency.d.ts

@@ -0,0 +1,12 @@
+export interface Dependency {
+    crate_id: string;
+    default_features: boolean;
+    downloads: number;
+    features: string[];
+    id: number;
+    kind: 'build' | 'dev' | 'normal';
+    optional: boolean;
+    req: string;
+    target: null | string;
+    version_id: number;
+}

package/dist/interfaces/Dependency.js

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

package/dist/interfaces/Download.d.ts

@@ -0,0 +1,6 @@
+export interface Download {
+    date: string;
+    downloads: number;
+    id: number;
+    version: number;
+}

package/dist/interfaces/Download.js

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

package/dist/interfaces/Keyword.d.ts

@@ -0,0 +1,6 @@
+export interface Keyword {
+    crates_cnt: number;
+    created_at: string;
+    id: string;
+    keyword: string;
+}

package/dist/interfaces/Keyword.js

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

package/dist/interfaces/Options.d.ts

@@ -0,0 +1,19 @@
+export interface ClientOptions {
+    apiKey?: string;
+    apiUrl?: string;
+}
+export interface PaginationOptions {
+    page?: number;
+    per_page?: number;
+}
+export interface SearchOptions {
+    category?: string;
+    following?: string;
+    keyword?: string;
+    letter?: string;
+    page?: number;
+    per_page?: number;
+    sort?: string;
+    team_id?: number;
+    user_id?: number;
+}

package/dist/interfaces/Options.js

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

package/dist/interfaces/Result.d.ts

@@ -0,0 +1,72 @@
+import type { Category, Crate, Dependency, Download, Keyword, Team, User, Version } from '.';
+export interface AuthorsResult {
+    meta: {
+        names: string[];
+    };
+    users: User[];
+}
+export interface CategoriesResult {
+    categories: Category[];
+    meta: {
+        total: number;
+    };
+}
+export interface CategoryResult {
+    category: Category;
+}
+export interface CrateResult {
+    categories: Category[];
+    crate: Crate;
+    keywords: Keyword[];
+}
+export interface DependenciesResult {
+    dependencies: Dependency[];
+}
+export interface DownloadsResult {
+    meta?: {
+        extra_downloads?: Download[];
+    };
+    version_downloads: Download[];
+}
+export interface FollowingResult {
+    following: boolean;
+}
+export interface KeywordResult {
+    keyword: Keyword;
+}
+export interface KeywordsResult {
+    keywords: Keyword[];
+    meta: {
+        total: number;
+    };
+}
+export interface OkResult {
+    ok: boolean;
+}
+export interface ReverseDependenciesResult extends DependenciesResult {
+    meta: {
+        total: number;
+    };
+    versions: Version[];
+}
+export interface SearchResult {
+    crates: Crate[];
+    meta: {
+        total: number;
+    };
+}
+export interface TeamsResult {
+    teams: Team[];
+}
+export interface UrlResult {
+    url: string;
+}
+export interface UsersResult {
+    users: User[];
+}
+export interface VersionResult {
+    version: Version;
+}
+export interface VersionsResult {
+    versions: Version[];
+}

package/dist/interfaces/Result.js

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

package/dist/interfaces/Summary.d.ts

@@ -0,0 +1,13 @@
+import type { Category } from './Category';
+import type { Crate } from './Crate';
+import type { Keyword } from './Keyword';
+export interface Summary {
+    just_updated: Crate[];
+    most_downloaded: Crate[];
+    most_recently_downloaded: Crate[];
+    new_crates: Crate[];
+    num_crates: number;
+    num_downloads: number;
+    popular_categories: Category[];
+    popular_keywords: Keyword[];
+}

package/dist/interfaces/Summary.js

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

package/dist/interfaces/Team.d.ts

@@ -0,0 +1,8 @@
+export interface Team {
+    avatar: null | string;
+    id: number;
+    kind?: string;
+    login: string;
+    name: null | string;
+    url: null | string;
+}

package/dist/interfaces/Team.js

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

package/dist/interfaces/User.d.ts

@@ -0,0 +1,8 @@
+export interface User {
+    avatar: null | string;
+    id: number;
+    kind?: string;
+    login: string;
+    name: null | string;
+    url: null | string;
+}

package/dist/interfaces/User.js

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

package/dist/interfaces/Version.d.ts

@@ -0,0 +1,23 @@
+import type { User } from './User';
+export interface Version {
+    crate: string;
+    crate_size: number;
+    created_at: string;
+    dl_path: string;
+    downloads: number;
+    features: {
+        [key: string]: string[];
+    };
+    id: number;
+    license: string;
+    links: {
+        authors: string;
+        dependencies: string;
+        version_downloads: string;
+    };
+    num: string;
+    published_by: null | User;
+    readme_path: string;
+    updated_at: string;
+    yanked: boolean;
+}

package/dist/interfaces/Version.js

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

package/dist/interfaces/index.d.ts

@@ -0,0 +1,12 @@
+export * from './API';
+export * from './Category';
+export * from './Crate';
+export * from './Dependency';
+export * from './Download';
+export * from './Keyword';
+export * from './Options';
+export * from './Result';
+export * from './Summary';
+export * from './Team';
+export * from './User';
+export * from './Version';

package/dist/interfaces/index.js

@@ -0,0 +1,28 @@
+"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("./Category"), exports);
+__exportStar(require("./Crate"), exports);
+__exportStar(require("./Dependency"), exports);
+__exportStar(require("./Download"), exports);
+__exportStar(require("./Keyword"), exports);
+__exportStar(require("./Options"), exports);
+__exportStar(require("./Result"), exports);
+__exportStar(require("./Summary"), exports);
+__exportStar(require("./Team"), exports);
+__exportStar(require("./User"), exports);
+__exportStar(require("./Version"), exports);

package/package.json

@@ -1,14 +1,16 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.0"
+    "@ffflorian/api-client": "2.5.1"
   },
   "description": "A crates.io API client",
   "devDependencies": {
     "@types/node": "~24",
+    "nock": "14.0.12",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3",
+    "vitest": "4.1.4"
   },
   "engines": {
     "node": ">= 21"
@@ -29,11 +31,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/crates.io src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
-    "test": "exit 0"
+    "dist": "yarn clean && yarn build",
+    "test": "vitest"
   },
-  "version": "2.4.6"
+  "version": "2.5.0"
 }