fast-npm-meta 0.4.0 → 0.4.1

package/dist/index.d.mts

@@ -30,51 +30,72 @@ interface PackageError {
     error: string;
 }
 type MaybeError<T> = T | PackageError;
-interface ResolvedPackageVersion extends Partial<PackageVersionMeta> {
+interface ResolvedPackageVersion {
     name: string;
     version: string | null;
     specifier: string;
     publishedAt: string | null;
     lastSynced: number;
 }
+interface ResolvedPackageVersionWithMetadata extends ResolvedPackageVersion, PackageVersionMeta {
+}
 
-interface FetchOptions {
+interface FetchOptions<Throw extends boolean = true> {
+    /**
+     * API endpoint for fetching package versions
+     *
+     * @default 'https://npm.antfu.dev/'
+     */
     apiEndpoint?: string;
     /**
      * Fetch function
+     *
+     * @default [globalThis.fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
      */
     fetch?: typeof fetch;
     /**
      * Should throw error or return error object
      *
-     * @default false
+     * @default true
      */
-    throw?: boolean;
+    throw?: Throw;
 }
-interface GetVersionsOptions<WithMetadata extends boolean> extends FetchOptions {
+interface GetVersionsOptions<Metadata extends boolean = false, Throw extends boolean = true> extends FetchOptions<Throw> {
     /**
      * By pass cache and get the latest data
+     *
+     * @default false
      */
     force?: boolean;
     /**
      * Include all versions that are newer than the specified version
+     *
+     * @default false
      */
     loose?: boolean;
     /**
      * Includes metadata, this will change the return type
+     *
+     * @default false
      */
-    metadata?: WithMetadata;
+    metadata?: Metadata;
 }
-interface GetLatestVersionOptions extends FetchOptions {
+interface GetLatestVersionOptions<Metadata extends boolean = false, Throw extends boolean = true> extends FetchOptions<Throw> {
     /**
      * By pass cache and get the latest data
+     *
+     * @default false
      */
     force?: boolean;
     /**
      * Includes metadata
+     *
+     * @default false
      */
-    metadata?: boolean;
+    metadata?: Metadata;
 }
+type InferGetVersionsResult<Metadata, Throw> = Metadata extends true ? Throw extends true ? PackageVersionsInfoWithMetadata : MaybeError<PackageVersionsInfoWithMetadata> : Throw extends true ? PackageVersionsInfo : MaybeError<PackageVersionsInfo>;
+type InferGetLatestVersionResult<Metadata, Throw> = Metadata extends true ? Throw extends true ? ResolvedPackageVersionWithMetadata : MaybeError<ResolvedPackageVersionWithMetadata> : Throw extends true ? ResolvedPackageVersion : MaybeError<ResolvedPackageVersion>;
 declare const defaultOptions: {
     /**
      * API endpoint for fetching package versions
@@ -83,12 +104,10 @@ declare const defaultOptions: {
      */
     apiEndpoint: string;
 };
-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 function getLatestVersionBatch<Metadata extends boolean = false, Throw extends boolean = true>(packages: string[], options?: GetLatestVersionOptions<Metadata, Throw>): Promise<InferGetLatestVersionResult<Metadata, Throw>[]>;
+declare function getLatestVersion<Metadata extends boolean = false, Throw extends boolean = true>(name: string, options?: GetLatestVersionOptions<Metadata, Throw>): Promise<InferGetLatestVersionResult<Metadata, Throw>>;
+declare function getVersionsBatch<Metadata extends boolean = false, Throw extends boolean = true>(packages: string[], options?: GetVersionsOptions<Metadata, Throw>): Promise<InferGetVersionsResult<Metadata, Throw>[]>;
+declare function getVersions<Metadata extends boolean = false, Throw extends boolean = true>(name: string, options?: GetVersionsOptions<Metadata, Throw>): Promise<InferGetVersionsResult<Metadata, Throw>>;
 
 declare const NPM_REGISTRY = "https://registry.npmjs.org/";
 /**
@@ -100,4 +119,4 @@ declare const NPM_REGISTRY = "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 };
+export { type FetchOptions, type GetLatestVersionOptions, type GetVersionsOptions, type InferGetLatestVersionResult, type InferGetVersionsResult, NPM_REGISTRY, type PackageManifest, type ResolvedPackageVersion, defaultOptions, getLatestVersion, getLatestVersionBatch, getVersions, getVersionsBatch, pickRegistry };

package/dist/index.mjs

@@ -10,7 +10,7 @@ async function getLatestVersionBatch(packages, options = {}) {
   const {
     apiEndpoint = defaultOptions.apiEndpoint,
     fetch: fetchApi = fetch,
-    throw: throwError = false
+    throw: throwError = true
   } = options;
   let query = [
     options.force ? "force=true" : "",
@@ -31,7 +31,7 @@ async function getVersionsBatch(packages, options = {}) {
   const {
     apiEndpoint = defaultOptions.apiEndpoint,
     fetch: fetchApi = fetch,
-    throw: throwError = false
+    throw: throwError = true
   } = options;
   let query = [
     options.force ? "force=true" : "",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fast-npm-meta",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Get npm package metadata",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",