fast-npm-meta 0.3.1 → 0.4.0

package/dist/index.d.mts

@@ -25,6 +25,11 @@ interface PackageVersionsInfo extends Pick<PackageManifest, 'name' | 'distTags'
 interface PackageVersionsInfoWithMetadata extends PackageManifest {
     specifier: string;
 }
+interface PackageError {
+    name: string;
+    error: string;
+}
+type MaybeError<T> = T | PackageError;
 interface ResolvedPackageVersion extends Partial<PackageVersionMeta> {
     name: string;
     version: string | null;
@@ -39,6 +44,12 @@ interface FetchOptions {
      * Fetch function
      */
     fetch?: typeof fetch;
+    /**
+     * Should throw error or return error object
+     *
+     * @default false
+     */
+    throw?: boolean;
 }
 interface GetVersionsOptions<WithMetadata extends boolean> extends FetchOptions {
     /**
@@ -72,12 +83,12 @@ declare const defaultOptions: {
      */
     apiEndpoint: string;
 };
-declare function getLatestVersionBatch(packages: string[], options?: GetLatestVersionOptions): Promise<ResolvedPackageVersion[]>;
-declare function getLatestVersion(name: string, options?: GetLatestVersionOptions): Promise<ResolvedPackageVersion>;
-declare function getVersionsBatch(packages: string[], options?: GetVersionsOptions<false>): Promise<PackageVersionsInfo[]>;
-declare function getVersionsBatch(packages: string[], options: GetVersionsOptions<true>): Promise<PackageVersionsInfoWithMetadata[]>;
-declare function getVersions(name: string, options?: GetVersionsOptions<false>): Promise<PackageVersionsInfo>;
-declare function getVersions(name: string, options: GetVersionsOptions<true>): Promise<PackageVersionsInfoWithMetadata>;
+declare function getLatestVersionBatch(packages: string[], options?: GetLatestVersionOptions): Promise<MaybeError<ResolvedPackageVersion>[]>;
+declare function getLatestVersion(name: string, options?: GetLatestVersionOptions): Promise<MaybeError<ResolvedPackageVersion>>;
+declare function getVersionsBatch(packages: string[], options?: GetVersionsOptions<false>): Promise<MaybeError<PackageVersionsInfo>[]>;
+declare function getVersionsBatch(packages: string[], options: GetVersionsOptions<true>): Promise<MaybeError<PackageVersionsInfoWithMetadata>[]>;
+declare function getVersions(name: string, options?: GetVersionsOptions<false>): Promise<MaybeError<PackageVersionsInfo>>;
+declare function getVersions(name: string, options: GetVersionsOptions<true>): Promise<MaybeError<PackageVersionsInfoWithMetadata>>;
 
 declare const NPM_REGISTRY = "https://registry.npmjs.org/";
 /**

package/dist/index.mjs

@@ -9,18 +9,19 @@ const defaultOptions = {
 async function getLatestVersionBatch(packages, options = {}) {
   const {
     apiEndpoint = defaultOptions.apiEndpoint,
-    fetch: fetchApi = fetch
+    fetch: fetchApi = fetch,
+    throw: throwError = false
   } = options;
   let query = [
     options.force ? "force=true" : "",
-    options.metadata ? "metadata=true" : ""
+    options.metadata ? "metadata=true" : "",
+    throwError ? "" : "throw=false"
   ].filter(Boolean).join("&");
   if (query)
     query = `?${query}`;
   const data = await fetchApi(new URL(packages.join("+") + query, apiEndpoint)).then((r) => r.json());
-  if (!Array.isArray(data))
-    return [data];
-  return data;
+  const list = toArray(data);
+  return throwError ? throwErrorObject(list) : list;
 }
 async function getLatestVersion(name, options = {}) {
   const [data] = await getLatestVersionBatch([name], options);
@@ -29,24 +30,37 @@ async function getLatestVersion(name, options = {}) {
 async function getVersionsBatch(packages, options = {}) {
   const {
     apiEndpoint = defaultOptions.apiEndpoint,
-    fetch: fetchApi = fetch
+    fetch: fetchApi = fetch,
+    throw: throwError = false
   } = options;
   let query = [
     options.force ? "force=true" : "",
     options.loose ? "loose=true" : "",
-    options.metadata ? "metadata=true" : ""
+    options.metadata ? "metadata=true" : "",
+    throwError ? "" : "throw=false"
   ].filter(Boolean).join("&");
   if (query)
     query = `?${query}`;
   const data = await fetchApi(new URL(`/versions/${packages.join("+")}${query}`, apiEndpoint)).then((r) => r.json());
-  if (!Array.isArray(data))
-    return [data];
-  return data;
+  const list = toArray(data);
+  return throwError ? throwErrorObject(list) : list;
 }
 async function getVersions(name, options = {}) {
   const [data] = await getVersionsBatch([name], options);
   return data;
 }
+function throwErrorObject(data) {
+  for (const item of toArray(data)) {
+    if (item && "error" in item)
+      throw new Error(item.message || item.error);
+  }
+  return data;
+}
+function toArray(data) {
+  if (Array.isArray(data))
+    return data;
+  return [data];
+}
 
 const NPM_REGISTRY = "https://registry.npmjs.org/";
 function pickRegistry(scope, npmConfigs, defaultRegistry = NPM_REGISTRY) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fast-npm-meta",
   "type": "module",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Get npm package metadata",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -15,23 +15,11 @@
   "keywords": [],
   "sideEffects": false,
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    }
+    ".": "./dist/index.mjs"
   },
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/*",
-        "./dist/index.d.ts"
-      ]
-    }
-  },
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],

package/dist/index.cjs

@@ -1,71 +0,0 @@
-'use strict';
-
-const defaultOptions = {
-  /**
-   * API endpoint for fetching package versions
-   *
-   * @default 'https://npm.antfu.dev/'
-   */
-  apiEndpoint: "https://npm.antfu.dev/"
-};
-async function getLatestVersionBatch(packages, options = {}) {
-  const {
-    apiEndpoint = defaultOptions.apiEndpoint,
-    fetch: fetchApi = fetch
-  } = options;
-  let query = [
-    options.force ? "force=true" : "",
-    options.metadata ? "metadata=true" : ""
-  ].filter(Boolean).join("&");
-  if (query)
-    query = `?${query}`;
-  const data = await fetchApi(new URL(packages.join("+") + query, apiEndpoint)).then((r) => r.json());
-  if (!Array.isArray(data))
-    return [data];
-  return data;
-}
-async function getLatestVersion(name, options = {}) {
-  const [data] = await getLatestVersionBatch([name], options);
-  return data;
-}
-async function getVersionsBatch(packages, options = {}) {
-  const {
-    apiEndpoint = defaultOptions.apiEndpoint,
-    fetch: fetchApi = fetch
-  } = options;
-  let query = [
-    options.force ? "force=true" : "",
-    options.loose ? "loose=true" : "",
-    options.metadata ? "metadata=true" : ""
-  ].filter(Boolean).join("&");
-  if (query)
-    query = `?${query}`;
-  const data = await fetchApi(new URL(`/versions/${packages.join("+")}${query}`, apiEndpoint)).then((r) => r.json());
-  if (!Array.isArray(data))
-    return [data];
-  return data;
-}
-async function getVersions(name, options = {}) {
-  const [data] = await getVersionsBatch([name], options);
-  return data;
-}
-
-const NPM_REGISTRY = "https://registry.npmjs.org/";
-function pickRegistry(scope, npmConfigs, defaultRegistry = NPM_REGISTRY) {
-  let registry = scope ? npmConfigs[`${scope.replace(/^@?/, "@")}:registry`] : void 0;
-  if (!registry && typeof npmConfigs.scope === "string") {
-    registry = npmConfigs[`${npmConfigs.scope.replace(/^@?/, "@")}:registry`];
-  }
-  if (!registry) {
-    registry = npmConfigs.registry || defaultRegistry;
-  }
-  return registry;
-}
-
-exports.NPM_REGISTRY = NPM_REGISTRY;
-exports.defaultOptions = defaultOptions;
-exports.getLatestVersion = getLatestVersion;
-exports.getLatestVersionBatch = getLatestVersionBatch;
-exports.getVersions = getVersions;
-exports.getVersionsBatch = getVersionsBatch;
-exports.pickRegistry = pickRegistry;

package/dist/index.d.cts

@@ -1,92 +0,0 @@
-interface PackageManifest {
-    name: string;
-    distTags: Record<string, string> & {
-        latest: string;
-    };
-    versionsMeta: Record<string, PackageVersionMeta>;
-    timeCreated: string;
-    timeModified: string;
-    lastSynced: number;
-}
-type Engines = Partial<Record<string, string>>;
-interface PackageVersionMeta {
-    time?: string;
-    engines?: Engines;
-    deprecated?: string;
-}
-interface PackageVersionsInfo extends Pick<PackageManifest, 'name' | 'distTags' | 'lastSynced'> {
-    versions: string[];
-    specifier: string;
-    time: {
-        created: string;
-        modified: string;
-    } & Record<string, string>;
-}
-interface PackageVersionsInfoWithMetadata extends PackageManifest {
-    specifier: string;
-}
-interface ResolvedPackageVersion extends Partial<PackageVersionMeta> {
-    name: string;
-    version: string | null;
-    specifier: string;
-    publishedAt: string | null;
-    lastSynced: number;
-}
-
-interface FetchOptions {
-    apiEndpoint?: string;
-    /**
-     * Fetch function
-     */
-    fetch?: typeof fetch;
-}
-interface GetVersionsOptions<WithMetadata extends boolean> extends FetchOptions {
-    /**
-     * By pass cache and get the latest data
-     */
-    force?: boolean;
-    /**
-     * Include all versions that are newer than the specified version
-     */
-    loose?: boolean;
-    /**
-     * Includes metadata, this will change the return type
-     */
-    metadata?: WithMetadata;
-}
-interface GetLatestVersionOptions extends FetchOptions {
-    /**
-     * By pass cache and get the latest data
-     */
-    force?: boolean;
-    /**
-     * Includes metadata
-     */
-    metadata?: boolean;
-}
-declare const defaultOptions: {
-    /**
-     * API endpoint for fetching package versions
-     *
-     * @default 'https://npm.antfu.dev/'
-     */
-    apiEndpoint: string;
-};
-declare function getLatestVersionBatch(packages: string[], options?: GetLatestVersionOptions): Promise<ResolvedPackageVersion[]>;
-declare function getLatestVersion(name: string, options?: GetLatestVersionOptions): Promise<ResolvedPackageVersion>;
-declare function getVersionsBatch(packages: string[], options?: GetVersionsOptions<false>): Promise<PackageVersionsInfo[]>;
-declare function getVersionsBatch(packages: string[], options: GetVersionsOptions<true>): Promise<PackageVersionsInfoWithMetadata[]>;
-declare function getVersions(name: string, options?: GetVersionsOptions<false>): Promise<PackageVersionsInfo>;
-declare function getVersions(name: string, options: GetVersionsOptions<true>): Promise<PackageVersionsInfoWithMetadata>;
-
-declare const NPM_REGISTRY = "https://registry.npmjs.org/";
-/**
- * Lightweight replacement of `npm-registry-fetch` function `pickRegistry`'
- *
- * @param scope - scope of package, get from 'npm-package-arg'
- * @param npmConfigs - npm configs, read from `.npmrc` file
- * @param defaultRegistry - default registry, default to 'https://registry.npmjs.org/'
- */
-declare function pickRegistry(scope: string | null | undefined, npmConfigs: Record<string, unknown>, defaultRegistry?: string): string;
-
-export { type FetchOptions, type GetLatestVersionOptions, type GetVersionsOptions, NPM_REGISTRY, type PackageManifest, type ResolvedPackageVersion, defaultOptions, getLatestVersion, getLatestVersionBatch, getVersions, getVersionsBatch, pickRegistry };

package/dist/index.d.ts

@@ -1,92 +0,0 @@
-interface PackageManifest {
-    name: string;
-    distTags: Record<string, string> & {
-        latest: string;
-    };
-    versionsMeta: Record<string, PackageVersionMeta>;
-    timeCreated: string;
-    timeModified: string;
-    lastSynced: number;
-}
-type Engines = Partial<Record<string, string>>;
-interface PackageVersionMeta {
-    time?: string;
-    engines?: Engines;
-    deprecated?: string;
-}
-interface PackageVersionsInfo extends Pick<PackageManifest, 'name' | 'distTags' | 'lastSynced'> {
-    versions: string[];
-    specifier: string;
-    time: {
-        created: string;
-        modified: string;
-    } & Record<string, string>;
-}
-interface PackageVersionsInfoWithMetadata extends PackageManifest {
-    specifier: string;
-}
-interface ResolvedPackageVersion extends Partial<PackageVersionMeta> {
-    name: string;
-    version: string | null;
-    specifier: string;
-    publishedAt: string | null;
-    lastSynced: number;
-}
-
-interface FetchOptions {
-    apiEndpoint?: string;
-    /**
-     * Fetch function
-     */
-    fetch?: typeof fetch;
-}
-interface GetVersionsOptions<WithMetadata extends boolean> extends FetchOptions {
-    /**
-     * By pass cache and get the latest data
-     */
-    force?: boolean;
-    /**
-     * Include all versions that are newer than the specified version
-     */
-    loose?: boolean;
-    /**
-     * Includes metadata, this will change the return type
-     */
-    metadata?: WithMetadata;
-}
-interface GetLatestVersionOptions extends FetchOptions {
-    /**
-     * By pass cache and get the latest data
-     */
-    force?: boolean;
-    /**
-     * Includes metadata
-     */
-    metadata?: boolean;
-}
-declare const defaultOptions: {
-    /**
-     * API endpoint for fetching package versions
-     *
-     * @default 'https://npm.antfu.dev/'
-     */
-    apiEndpoint: string;
-};
-declare function getLatestVersionBatch(packages: string[], options?: GetLatestVersionOptions): Promise<ResolvedPackageVersion[]>;
-declare function getLatestVersion(name: string, options?: GetLatestVersionOptions): Promise<ResolvedPackageVersion>;
-declare function getVersionsBatch(packages: string[], options?: GetVersionsOptions<false>): Promise<PackageVersionsInfo[]>;
-declare function getVersionsBatch(packages: string[], options: GetVersionsOptions<true>): Promise<PackageVersionsInfoWithMetadata[]>;
-declare function getVersions(name: string, options?: GetVersionsOptions<false>): Promise<PackageVersionsInfo>;
-declare function getVersions(name: string, options: GetVersionsOptions<true>): Promise<PackageVersionsInfoWithMetadata>;
-
-declare const NPM_REGISTRY = "https://registry.npmjs.org/";
-/**
- * Lightweight replacement of `npm-registry-fetch` function `pickRegistry`'
- *
- * @param scope - scope of package, get from 'npm-package-arg'
- * @param npmConfigs - npm configs, read from `.npmrc` file
- * @param defaultRegistry - default registry, default to 'https://registry.npmjs.org/'
- */
-declare function pickRegistry(scope: string | null | undefined, npmConfigs: Record<string, unknown>, defaultRegistry?: string): string;
-
-export { type FetchOptions, type GetLatestVersionOptions, type GetVersionsOptions, NPM_REGISTRY, type PackageManifest, type ResolvedPackageVersion, defaultOptions, getLatestVersion, getLatestVersionBatch, getVersions, getVersionsBatch, pickRegistry };