npms.io 2.4.7 → 2.6.0

package/README.md

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

package/dist/Endpoints.d.ts

@@ -1,4 +1,5 @@
 export declare const Endpoint: {
+    API_VERSION: string;
     MGET: string;
     PACKAGE: string;
     Package: {

package/dist/Endpoints.js

@@ -2,23 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Endpoint = void 0;
 exports.Endpoint = {
+    API_VERSION: 'v2',
     MGET: 'mget',
     PACKAGE: 'package',
     Package: {
         multiPackageInfo() {
-            return `/${exports.Endpoint.PACKAGE}/${exports.Endpoint.MGET}`;
+            return `${exports.Endpoint.API_VERSION}/${exports.Endpoint.PACKAGE}/${exports.Endpoint.MGET}`;
         },
         packageInfo(packageName) {
-            return `/${exports.Endpoint.PACKAGE}/${encodeURIComponent(packageName)}`;
+            return `${exports.Endpoint.API_VERSION}/${exports.Endpoint.PACKAGE}/${encodeURIComponent(packageName)}`;
         },
     },
     SEARCH: 'search',
     Search: {
         search() {
-            return `/${exports.Endpoint.SEARCH}`;
+            return `${exports.Endpoint.API_VERSION}/${exports.Endpoint.SEARCH}`;
         },
         suggestions() {
-            return `/${exports.Endpoint.SEARCH}/${exports.Endpoint.SUGGESTIONS}`;
+            return `${exports.Endpoint.API_VERSION}/${exports.Endpoint.SEARCH}/${exports.Endpoint.SUGGESTIONS}`;
         },
     },
     SUGGESTIONS: 'suggestions',

package/dist/NpmsIO.js

@@ -5,7 +5,7 @@ const api_client_1 = require("@ffflorian/api-client");
 const api_1 = require("./api");
 class NpmsIO {
     constructor(options = {}) {
-        this.apiClient = new api_client_1.APIClient(options.apiUrl || 'https://api.npms.io/v2');
+        this.apiClient = new api_client_1.APIClient(options.apiUrl || 'https://api.npms.io');
         this.api = {
             package: new api_1.PackageAPI(this.apiClient),
             search: new api_1.SearchAPI(this.apiClient),

package/dist/api/PackageAPI.d.ts

@@ -6,13 +6,11 @@ export declare class PackageAPI {
     /**
      * Get various packages info.
      * @param packageNames The package names
-     * @see https://api-docs.npms.io/#api-Package-GetMultiPackageInfo
      */
     multiPackageInfo(packageNames: string[]): Promise<Record<string, PackageInfo>>;
     /**
      * Get package info.
      * @param packageName The package name
-     * @see https://api-docs.npms.io/#api-Package-GetPackageInfo
      */
     packageInfo(packageName: string): Promise<PackageInfo>;
 }

package/dist/api/PackageAPI.js

@@ -18,7 +18,6 @@ class PackageAPI {
     /**
      * Get various packages info.
      * @param packageNames The package names
-     * @see https://api-docs.npms.io/#api-Package-GetMultiPackageInfo
      */
     multiPackageInfo(packageNames) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -30,7 +29,6 @@ class PackageAPI {
     /**
      * Get package info.
      * @param packageName The package name
-     * @see https://api-docs.npms.io/#api-Package-GetPackageInfo
      */
     packageInfo(packageName) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/api/SearchAPI.d.ts

@@ -1,14 +1,13 @@
 import type { APIClient } from '@ffflorian/api-client';
-import type { SearchOptions, SearchResult, SuggestionsOptions } from '../interfaces';
+import type { SearchOptions, SearchResult, SuggestionsOptions, SuggestionsResult } from '../interfaces';
 export declare class SearchAPI {
     private readonly apiClient;
     constructor(apiClient: APIClient);
     /**
      * Fetch suggestions.
      * @param query Perform a search query
-     * @see https://api-docs.npms.io/#api-Search-SearchSuggestions
      */
-    getSuggestions(query: string, options?: SuggestionsOptions): Promise<SearchResult>;
+    getSuggestions(query: string, options?: SuggestionsOptions): Promise<SuggestionsResult>;
     /**
      * Perform a search query.
      * @param query Besides normal text, `query` supports qualifiers to express filters and other modifiers:
@@ -28,7 +27,6 @@ export declare class SearchAPI {
      * - `popularity-weight:1` Set the weight that popularity has for the each package score, defaults to `3.3`
      * - `maintenance-weight:1` Set the weight that the quality has for the each package score, defaults to `2.05`
      * @param options Additional search options
-     * @see https://api-docs.npms.io/#api-Search-ExecuteSearchQuery
      */
     searchPackage(query: string, options?: SearchOptions): Promise<SearchResult>;
 }

package/dist/api/SearchAPI.js

@@ -18,11 +18,10 @@ class SearchAPI {
     /**
      * Fetch suggestions.
      * @param query Perform a search query
-     * @see https://api-docs.npms.io/#api-Search-SearchSuggestions
      */
     getSuggestions(query_1) {
         return __awaiter(this, arguments, void 0, function* (query, options = {}) {
-            const endpoint = Endpoints_1.Endpoint.Search.search();
+            const endpoint = Endpoints_1.Endpoint.Search.suggestions();
             const params = Object.assign({ 
                 // eslint-disable-next-line id-length
                 q: query }, (options.size && { size: options.size }));
@@ -49,7 +48,6 @@ class SearchAPI {
      * - `popularity-weight:1` Set the weight that popularity has for the each package score, defaults to `3.3`
      * - `maintenance-weight:1` Set the weight that the quality has for the each package score, defaults to `2.05`
      * @param options Additional search options
-     * @see https://api-docs.npms.io/#api-Search-ExecuteSearchQuery
      */
     searchPackage(query_1) {
         return __awaiter(this, arguments, void 0, function* (query, options = {}) {

package/dist/interfaces/SearchOptions.d.ts

@@ -5,10 +5,16 @@ export interface SearchOptions extends SuggestionsOptions {
      * Default value: `0`
      */
     from?: string;
+    /**
+     * The total number of results to return (max of 250)
+     *
+     * Default value: `25`
+     */
+    size?: string;
 }
 export interface SuggestionsOptions {
     /**
-     * The total number of results to return (max of 250)
+     * The total number of results to return (max of 100)
      *
      * Default value: `25`
      */

package/dist/interfaces/SearchResult.d.ts

@@ -39,6 +39,11 @@ export interface SearchResult {
     results: Result[];
     total: number;
 }
+export interface SuggestionResult extends Result {
+    /** A string containing highlighted matched text */
+    highlight?: string;
+}
+export type SuggestionsResult = SuggestionResult[];
 interface Detail {
     maintenance: number;
     popularity: number;

package/package.json

@@ -6,9 +6,11 @@
   "description": "A npms.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"
@@ -34,7 +36,7 @@
     "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/npms.io src/index.ts",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "test": "exit 0"
+    "test": "vitest run"
   },
-  "version": "2.4.7"
+  "version": "2.6.0"
 }