fix: existing image are overwritten in bulk download

Author: fityannugroho

src/downloader.ts

@@ -12,17 +12,13 @@ import ArgumentError from './errors/ArgumentError.js';
 import DirectoryError from './errors/DirectoryError.js';
 import { Image } from './index.js';
 
-export type DownloadOptions = {
+export type ImageOptions = {
   /**
    * The directory to save the image to.
    *
    * If not provided, the current working directory will be used.
    */
   directory?: string;
-  /**
-   * The headers to send with the request.
-   */
-  headers?: Record<string, string | string[] | undefined>;
   /**
    * The name of the image file.
    *
@@ -33,12 +29,6 @@ export type DownloadOptions = {
    * If a name with same extension already exists, ` (1)`, ` (2)`, etc. will be added to the end of the name.
    */
   name?: string;
-  /**
-   * Set the maximum number of times to retry the request if it fails.
-   *
-   * @default 2
-   */
-  maxRetry?: number;
   /**
    * The extension of the image.
    *
@@ -47,6 +37,19 @@ export type DownloadOptions = {
    * If the URL doesn't have an extension, `jpg` will be used.
    */
   extension?: string;
+};
+
+export type DownloadOptions = {
+  /**
+   * The headers to send with the request.
+   */
+  headers?: Record<string, string | string[] | undefined>;
+  /**
+   * Set the maximum number of times to retry the request if it fails.
+   *
+   * @default 2
+   */
+  maxRetry?: number;
   /**
    * Set timeout for each request in milliseconds.
    */
@@ -58,11 +61,15 @@ export type DownloadOptions = {
 };
 
 /**
- * Set the options with the default values if they are not provided.
+ * Parses and validates the image parameters.
+ *
+ * If image options are not provided, the default values will be used.
+ *
+ * See {@link ImageOptions} for more information.
  *
  * @throws {ArgumentError} If there is an invalid value.
  */
-export function parseImageParams(url: string, options?: DownloadOptions) {
+export function parseImageParams(url: string, options?: ImageOptions) {
   const lowerImgExts = [...imageExtensions].map((ext) => ext.toLowerCase());
   const originalExt = path.extname(url).replace('.', '');
   const img: Image = {
@@ -135,16 +142,14 @@ export function parseImageParams(url: string, options?: DownloadOptions) {
 }
 
 /**
- * Downloads an image from a URL.
- * @param url The URL of the image to download.
- * @param options The options to use.
+ * Downloads an image.
+ * @param img The validated image parameters. See {@link parseImageParams}.
+ * @param options The download options.
  * @returns The file path.
  * @throws {DirectoryError} If the directory cannot be created.
  * @throws {Error} If there are any other errors.
  */
-export async function download(url: string, options: DownloadOptions = {}) {
-  const img = parseImageParams(url, options);
-
+export async function download(img: Image, options: DownloadOptions = {}) {
   // Create the directory if it doesn't exist.
   if (!fs.existsSync(img.directory)) {
     try {

src/index.ts

@@ -2,7 +2,13 @@ import PQueue from 'p-queue';
 import { setMaxListeners } from 'node:events';
 import { CancelError } from 'got';
 import { DEFAULT_INTERVAL, DEFAULT_STEP } from './constanta.js';
-import { DownloadOptions, download } from './downloader.js';
+import {
+  DownloadOptions,
+  ImageOptions,
+  download,
+  parseImageParams,
+} from './downloader.js';
+import path from 'node:path';
 
 export type Image = {
   /**
@@ -35,7 +41,7 @@ export type Image = {
   path: string;
 };
 
-export type Options = DownloadOptions & {
+export type Options = (ImageOptions & DownloadOptions) & {
   /**
    * Do something when the image is successfully downloaded.
    * For example, counting the number of successful downloads.
@@ -97,13 +103,29 @@ async function imgdl(
 
     return new Promise<Image[]>((resolve, reject) => {
       const images: Image[] = [];
+      const countNames = new Map<string, number>();
 
       url.forEach((u) => {
+        const img = parseImageParams(u, options);
+
+        // Make sure the name is unique
+        const nameKey = `${img.name}.${img.extension}`;
+        const count = countNames.get(nameKey);
+        if (count) {
+          img.name = `${img.name} (${count})`;
+          img.path = path.resolve(
+            img.directory,
+            `${img.name}.${img.extension}`,
+          );
+        }
+        countNames.set(nameKey, (count || 0) + 1);
+
+        // Add the download task to queue
         queue
           .add(
             async ({ signal }) => {
               try {
-                return await download(u, {
+                return await download(img, {
                   ...options,
                   signal,
                 });
@@ -130,6 +152,7 @@ async function imgdl(
           });
       });
 
+      // Resolve/reject when all task is finished
       queue
         .onIdle()
         .then(() => {
@@ -141,7 +164,7 @@ async function imgdl(
     });
   }
 
-  return download(url, {
+  return download(parseImageParams(url, options), {
     ...options,
     signal: options?.signal,
   });