npms.io 2.4.5 → 2.4.6

package/package.json

@@ -1,14 +1,14 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0"
+    "@ffflorian/api-client": "2.5.0"
   },
   "description": "A npms.io API client",
   "devDependencies": {
     "@types/node": "~24",
-    "rimraf": "6.1.2",
-    "typedoc": "0.28.15",
-    "typescript": "5.9.3"
+    "rimraf": "6.1.3",
+    "typedoc": "0.28.18",
+    "typescript": "6.0.2"
   },
   "engines": {
     "node": ">= 21"
@@ -35,6 +35,5 @@
     "dist": "yarn clean && yarn build:ts",
     "test": "exit 0"
   },
-  "version": "2.4.5",
-  "gitHead": "8d7471cbe490305b3e441c27acbc81e36a4bd9df"
+  "version": "2.4.6"
 }

package/dist/Endpoints.d.ts

@@ -1,14 +0,0 @@
-export declare const Endpoint: {
-    PACKAGE: string;
-    SEARCH: string;
-    SUGGESTIONS: string;
-    MGET: string;
-    Search: {
-        search(): string;
-        suggestions(): string;
-    };
-    Package: {
-        packageInfo(packageName: string): string;
-        multiPackageInfo(): string;
-    };
-};

package/dist/Endpoints.js

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

package/dist/NpmsIO.d.ts

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

package/dist/NpmsIO.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NpmsIO = void 0;
-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.api = {
-            package: new api_1.PackageAPI(this.apiClient),
-            search: new api_1.SearchAPI(this.apiClient),
-        };
-    }
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL) {
-        this.apiClient.setBaseURL(newURL);
-        this.api.package = new api_1.PackageAPI(this.apiClient);
-        this.api.search = new api_1.SearchAPI(this.apiClient);
-    }
-}
-exports.NpmsIO = NpmsIO;

package/dist/api/PackageAPI.d.ts

@@ -1,18 +0,0 @@
-import type { APIClient } from '@ffflorian/api-client';
-import type { PackageInfo } from '../interfaces/';
-export declare class PackageAPI {
-    private readonly apiClient;
-    constructor(apiClient: APIClient);
-    /**
-     * 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

@@ -1,43 +0,0 @@
-"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.PackageAPI = void 0;
-const Endpoints_1 = require("../Endpoints");
-class PackageAPI {
-    constructor(apiClient) {
-        this.apiClient = apiClient;
-    }
-    /**
-     * 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* () {
-            const endpoint = Endpoints_1.Endpoint.Package.multiPackageInfo();
-            const { data } = yield this.apiClient.post(endpoint, packageNames);
-            return data;
-        });
-    }
-    /**
-     * 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* () {
-            const endpoint = Endpoints_1.Endpoint.Package.packageInfo(packageName);
-            const { data } = yield this.apiClient.get(endpoint);
-            return data;
-        });
-    }
-}
-exports.PackageAPI = PackageAPI;

package/dist/api/SearchAPI.d.ts

@@ -1,34 +0,0 @@
-import type { APIClient } from '@ffflorian/api-client';
-import type { SearchOptions, SearchResult, SuggestionsOptions } 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>;
-    /**
-     * Perform a search query.
-     * @param query Besides normal text, `query` supports qualifiers to express filters and other modifiers:
-     * - `scope:types` Show/filter results that belong to the `@types` scope
-     * - `author:sindresorhus` Show/filter results in which `sindresorhus` is the author
-     * - `maintainer:sindresorhus` Show/filter results in which `sindresorhus` is qualifier as a maintainer
-     * - `keywords:gulpplugin` Show/filter results that have `gulpplugin` in the keywords (separate multiple keywords with commas, you may also exclude keywords e.g.: `-framework`)
-     * - `not:deprecated` Exclude deprecated packages from the results
-     * - `not:unstable` Exclude packages whose version is `< 1.0.0`
-     * - `not:insecure` Exclude packages that are insecure or have vulnerable dependencies (as per [nsp](https://nodesecurity.io/))
-     * - `is:deprecated` Show/filter is deprecated packages
-     * - `is:unstable` Show/filter packages whose version is `< 1.0.0`
-     * - `is:insecure` Show/filter packages that are insecure or have vulnerable dependencies (as per [nsp](https://nodesecurity.io/))
-     * - `boost-exact:false` Do not boost exact matches, defaults to `true`
-     * - `score-effect:14` Set the effect that package scores have for the final search score, defaults to `15.3`
-     * - `quality-weight:1` Set the weight that quality has for the each package score, defaults to `1.95`
-     * - `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

@@ -1,61 +0,0 @@
-"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.SearchAPI = void 0;
-const Endpoints_1 = require("../Endpoints");
-class SearchAPI {
-    constructor(apiClient) {
-        this.apiClient = apiClient;
-    }
-    /**
-     * 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 params = Object.assign({ q: query }, (options.size && { size: options.size }));
-            const { data } = yield this.apiClient.get(endpoint, { params });
-            return data;
-        });
-    }
-    /**
-     * Perform a search query.
-     * @param query Besides normal text, `query` supports qualifiers to express filters and other modifiers:
-     * - `scope:types` Show/filter results that belong to the `@types` scope
-     * - `author:sindresorhus` Show/filter results in which `sindresorhus` is the author
-     * - `maintainer:sindresorhus` Show/filter results in which `sindresorhus` is qualifier as a maintainer
-     * - `keywords:gulpplugin` Show/filter results that have `gulpplugin` in the keywords (separate multiple keywords with commas, you may also exclude keywords e.g.: `-framework`)
-     * - `not:deprecated` Exclude deprecated packages from the results
-     * - `not:unstable` Exclude packages whose version is `< 1.0.0`
-     * - `not:insecure` Exclude packages that are insecure or have vulnerable dependencies (as per [nsp](https://nodesecurity.io/))
-     * - `is:deprecated` Show/filter is deprecated packages
-     * - `is:unstable` Show/filter packages whose version is `< 1.0.0`
-     * - `is:insecure` Show/filter packages that are insecure or have vulnerable dependencies (as per [nsp](https://nodesecurity.io/))
-     * - `boost-exact:false` Do not boost exact matches, defaults to `true`
-     * - `score-effect:14` Set the effect that package scores have for the final search score, defaults to `15.3`
-     * - `quality-weight:1` Set the weight that quality has for the each package score, defaults to `1.95`
-     * - `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 = {}) {
-            const endpoint = Endpoints_1.Endpoint.Search.search();
-            const params = Object.assign(Object.assign({ q: query }, (options.from && { from: options.from })), (options.size && { size: options.size }));
-            const { data } = yield this.apiClient.get(endpoint, { params });
-            return data;
-        });
-    }
-}
-exports.SearchAPI = SearchAPI;

package/dist/api/index.d.ts

@@ -1,2 +0,0 @@
-export * from './PackageAPI';
-export * from './SearchAPI';

package/dist/api/index.js

@@ -1,18 +0,0 @@
-"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("./PackageAPI"), exports);
-__exportStar(require("./SearchAPI"), exports);

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from './NpmsIO';
-export * from './interfaces/';

package/dist/index.js

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

package/dist/interfaces/API.d.ts

@@ -1,5 +0,0 @@
-import { PackageAPI, SearchAPI } from '../api/';
-export interface API {
-    package: PackageAPI;
-    search: SearchAPI;
-}

package/dist/interfaces/API.js

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

package/dist/interfaces/ClientOptions.d.ts

@@ -1,3 +0,0 @@
-export interface ClientOptions {
-    apiUrl?: string;
-}

package/dist/interfaces/ClientOptions.js

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

package/dist/interfaces/PackageInfo.d.ts

@@ -1,151 +0,0 @@
-export interface PackageInfo {
-    /** The date in which the package was last analyzed */
-    analyzedAt: string;
-    /** The collected information from all sources */
-    collected: Collected;
-    /** The error associated with the last analyze attempt */
-    error?: Error;
-    /** The package evaluation */
-    evaluation: Evaluation;
-    /** The package score */
-    score: Score;
-}
-interface Badge {
-    info: Info;
-    urls: Urls;
-}
-interface Collected {
-    github?: GitHub;
-    metadata: Metadata;
-    npm: Npm;
-    source?: Source;
-}
-interface Contributor {
-    commitsCount: number;
-    username: string;
-}
-interface Detail {
-    maintenance: number;
-    popularity: number;
-    quality: number;
-}
-interface Error {
-    code: string;
-    message: string;
-}
-interface Evaluation {
-    maintenance: Maintenance;
-    popularity: Popularity;
-    quality: Quality;
-}
-interface Files {
-    hasChangelog: boolean;
-    readmeSize: number;
-    testsSize: number;
-}
-interface GitHub {
-    commits: Release[];
-    contributors: Contributor[];
-    forksCount: number;
-    homepage?: string;
-    issues: Issues;
-    starsCount: number;
-    statuses: Status[];
-    subscribersCount: number;
-}
-interface Issues {
-    count: number;
-    distribution: Record<string, number>;
-    isDisabled: boolean;
-    openCount: number;
-}
-interface Info {
-    modifiers?: Modifiers;
-    service: string;
-    type: string;
-}
-interface Links {
-    bugs?: string;
-    homepage?: string;
-    npm: string;
-    repository?: string;
-}
-interface Maintenance {
-    commitsFrequency: number;
-    issuesDistribution: number;
-    openIssues: number;
-    releasesFrequency: number;
-}
-interface Metadata {
-    date: string;
-    dependencies: Record<string, string>;
-    description: string;
-    hasSelectiveFiles?: boolean;
-    hasTestScript?: boolean;
-    keywords: string[];
-    license: string;
-    links: Links;
-    maintainers: Publisher[];
-    name: string;
-    publisher: Publisher;
-    readme?: string;
-    releases: Release[];
-    repository: Repository;
-    scope: string;
-    version: string;
-}
-interface Modifiers {
-    type: string;
-}
-interface Npm {
-    dependentsCount: number;
-    downloads: Release[];
-    starsCount: number;
-}
-interface Popularity {
-    communityInterest: number;
-    dependentsCount: number;
-    downloadsAcceleration: number;
-    downloadsCount: number;
-}
-interface Publisher {
-    email?: string;
-    username: string;
-}
-interface Quality {
-    branding: number;
-    carefulness: number;
-    health: number;
-    tests: number;
-}
-interface Release {
-    count: number;
-    from: string;
-    to: string;
-}
-interface Repository {
-    directory: string;
-    type?: string;
-    url: string;
-}
-interface Score {
-    detail: Detail;
-    final: number;
-}
-interface Source {
-    badges: Badge[];
-    coverage: number;
-    files: Files;
-    linters: string[];
-}
-interface Status {
-    context: string;
-    state: string;
-}
-interface Urls {
-    content: string;
-    original: string;
-    service?: string;
-    shields: string;
-}
-export {};

package/dist/interfaces/PackageInfo.js

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

package/dist/interfaces/SearchOptions.d.ts

@@ -1,16 +0,0 @@
-export interface SearchOptions extends SuggestionsOptions {
-    /**
-     * The offset in which to start searching from (max of 5000)
-     *
-     * Default value: `0`
-     */
-    from?: string;
-}
-export interface SuggestionsOptions {
-    /**
-     * The total number of results to return (max of 250)
-     *
-     * Default value: `25`
-     */
-    size?: string;
-}

package/dist/interfaces/SearchOptions.js

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

package/dist/interfaces/SearchResult.d.ts

@@ -1,57 +0,0 @@
-export interface SearchResult {
-    results: Result[];
-    total: number;
-}
-interface Result {
-    /** The package flags (deprecated, unstable, insecure) */
-    flags?: Flags;
-    /** The package data which contains the name, version and other useful information */
-    package: Package;
-    /** The package score */
-    score: Score;
-    /** The computed search score (from Elasticsearch) */
-    searchScore: number;
-}
-interface Author {
-    email?: string;
-    name: string;
-    url?: string;
-    username?: string;
-}
-interface Detail {
-    maintenance: number;
-    popularity: number;
-    quality: number;
-}
-interface Flags {
-    deprecated?: boolean;
-    insecure?: boolean;
-    unstable?: boolean;
-}
-interface Links {
-    bugs?: string;
-    homepage?: string;
-    npm: string;
-    repository?: string;
-}
-interface Package {
-    author?: Author;
-    date: string;
-    description: string;
-    keywords?: string[];
-    links: Links;
-    maintainers: Publisher[];
-    name: string;
-    publisher: Publisher;
-    scope: string;
-    version: string;
-}
-interface Publisher {
-    email: string;
-    username: string;
-}
-interface Score {
-    detail: Detail;
-    final: number;
-}
-export {};

package/dist/interfaces/SearchResult.js

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

package/dist/interfaces/index.d.ts

@@ -1,5 +0,0 @@
-export * from './API';
-export * from './ClientOptions';
-export * from './PackageInfo';
-export * from './SearchOptions';
-export * from './SearchResult';

package/dist/interfaces/index.js

@@ -1,21 +0,0 @@
-"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("./ClientOptions"), exports);
-__exportStar(require("./PackageInfo"), exports);
-__exportStar(require("./SearchOptions"), exports);
-__exportStar(require("./SearchResult"), exports);