@iconify/tools 2.0.3 → 2.0.7

package/lib/download/git/branch.d.ts

@@ -0,0 +1,5 @@
+import type { ExportTargetOptions } from '../../export/helpers/prepare';
+/**
+ * Get current branch from cloned git repo
+ */
+export declare function getGitRepoBranch(options: ExportTargetOptions, checkout?: string): Promise<string>;

package/lib/download/git/branch.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGitRepoBranch = void 0;
+const exec_1 = require("../../misc/exec");
+/**
+ * Get current branch from cloned git repo
+ */
+async function getGitRepoBranch(options, checkout) {
+    const result = await (0, exec_1.execAsync)('git branch --show-current', {
+        cwd: options.target,
+    });
+    const branch = result.stdout.trim();
+    if (typeof checkout === 'string' && branch !== checkout) {
+        // Checkout correct branch
+        await (0, exec_1.execAsync)(`git checkout ${checkout}`, {
+            cwd: options.target,
+        });
+        return await getGitRepoBranch(options);
+    }
+    return branch;
+}
+exports.getGitRepoBranch = getGitRepoBranch;

package/lib/download/git/branch.mjs

@@ -0,0 +1,18 @@
+// src/download/git/branch.ts
+import { execAsync } from "../../misc/exec.mjs";
+async function getGitRepoBranch(options, checkout) {
+  const result = await execAsync("git branch --show-current", {
+    cwd: options.target
+  });
+  const branch = result.stdout.trim();
+  if (typeof checkout === "string" && branch !== checkout) {
+    await execAsync(`git checkout ${checkout}`, {
+      cwd: options.target
+    });
+    return await getGitRepoBranch(options);
+  }
+  return branch;
+}
+export {
+  getGitRepoBranch
+};

package/lib/download/git/index.d.ts

@@ -1,7 +1,8 @@
 import { ExportTargetOptions } from '../../export/helpers/prepare';
 import type { DocumentNotModified } from '../types/modified';
+import type { DownloadSourceMixin } from '../types/sources';
 interface IfModifiedSinceOption {
-    ifModifiedSince: string | true;
+    ifModifiedSince: string | true | DownloadGitRepoResult;
 }
 /**
  * Options for downloadGitRepo()
@@ -14,8 +15,8 @@ export interface DownloadGitRepoOptions extends ExportTargetOptions, Partial<IfM
 /**
  * Result
  */
-export interface DownloadGitRepoResult {
-    target: string;
+export interface DownloadGitRepoResult extends DownloadSourceMixin<'git'> {
+    contentsDir: string;
     hash: string;
 }
 /**

package/lib/download/git/index.js

@@ -4,12 +4,14 @@ exports.downloadGitRepo = void 0;
 const fs_1 = require("fs");
 const prepare_1 = require("../../export/helpers/prepare");
 const exec_1 = require("../../misc/exec");
+const branch_1 = require("./branch");
 const hash_1 = require("./hash");
 async function downloadGitRepo(options) {
     const { remote, branch } = options;
     // Check for last commit
     const hasHashInTarget = options.target.indexOf('{hash}') !== -1;
-    if (options.ifModifiedSince || hasHashInTarget) {
+    const ifModifiedSince = options.ifModifiedSince;
+    if (ifModifiedSince || hasHashInTarget) {
         // Get actual hash
         const result = await (0, exec_1.execAsync)(`git ls-remote ${remote} --branch ${branch}`);
         const parts = result.stdout.split(/\s/);
@@ -17,19 +19,26 @@ async function downloadGitRepo(options) {
         if (hasHashInTarget) {
             options.target = options.target.replace('{hash}', latestHash);
         }
-        if (options.ifModifiedSince) {
-            try {
+        try {
+            // Make sure correct branch is checked out. This will throw error if branch is not available
+            await (0, branch_1.getGitRepoBranch)(options, branch);
+            if (ifModifiedSince) {
                 // Get expected hash
-                const expectedHash = options.ifModifiedSince === true
+                const expectedHash = ifModifiedSince === true
                     ? await (0, hash_1.getGitRepoHash)(options)
-                    : options.ifModifiedSince;
+                    : typeof ifModifiedSince === 'string'
+                        ? ifModifiedSince
+                        : ifModifiedSince.downloadType === 'git'
+                            ? ifModifiedSince.hash
+                            : null;
                 if (latestHash === expectedHash) {
                     return 'not_modified';
                 }
             }
-            catch (err) {
-                //
-            }
+        }
+        catch (err) {
+            // Cleanup on error
+            options.cleanup = true;
         }
     }
     // Prepare target directory
@@ -42,10 +51,12 @@ async function downloadGitRepo(options) {
         }
         await (0, exec_1.execAsync)(`git clone --branch ${branch} --no-tags --depth 1 ${remote} "${target}"`);
     }
-    // Get latest hash
+    // Get latest hash and make sure correct branch is available
     const hash = await (0, hash_1.getGitRepoHash)(options);
+    await (0, branch_1.getGitRepoBranch)(options, branch);
     return {
-        target,
+        downloadType: 'git',
+        contentsDir: target,
         hash,
     };
 }

package/lib/download/git/index.mjs

@@ -4,25 +4,29 @@ import {
   prepareDirectoryForExport
 } from "../../export/helpers/prepare.mjs";
 import { execAsync } from "../../misc/exec.mjs";
+import { getGitRepoBranch } from "./branch.mjs";
 import { getGitRepoHash } from "./hash.mjs";
 async function downloadGitRepo(options) {
   const { remote, branch } = options;
   const hasHashInTarget = options.target.indexOf("{hash}") !== -1;
-  if (options.ifModifiedSince || hasHashInTarget) {
+  const ifModifiedSince = options.ifModifiedSince;
+  if (ifModifiedSince || hasHashInTarget) {
     const result = await execAsync(`git ls-remote ${remote} --branch ${branch}`);
     const parts = result.stdout.split(/\s/);
     const latestHash = parts.shift();
     if (hasHashInTarget) {
       options.target = options.target.replace("{hash}", latestHash);
     }
-    if (options.ifModifiedSince) {
-      try {
-        const expectedHash = options.ifModifiedSince === true ? await getGitRepoHash(options) : options.ifModifiedSince;
+    try {
+      await getGitRepoBranch(options, branch);
+      if (ifModifiedSince) {
+        const expectedHash = ifModifiedSince === true ? await getGitRepoHash(options) : typeof ifModifiedSince === "string" ? ifModifiedSince : ifModifiedSince.downloadType === "git" ? ifModifiedSince.hash : null;
         if (latestHash === expectedHash) {
           return "not_modified";
         }
-      } catch (err) {
       }
+    } catch (err) {
+      options.cleanup = true;
     }
   }
   const target = options.target = await prepareDirectoryForExport(options);
@@ -34,8 +38,10 @@ async function downloadGitRepo(options) {
     await execAsync(`git clone --branch ${branch} --no-tags --depth 1 ${remote} "${target}"`);
   }
   const hash = await getGitRepoHash(options);
+  await getGitRepoBranch(options, branch);
   return {
-    target,
+    downloadType: "git",
+    contentsDir: target,
     hash
   };
 }

package/lib/download/github/index.d.ts

@@ -1,8 +1,9 @@
 import { ExportTargetOptions } from '../../export/helpers/prepare';
 import type { DocumentNotModified } from '../types/modified';
 import type { GitHubAPIOptions } from './types';
+import type { DownloadSourceMixin } from '../types/sources';
 interface IfModifiedSinceOption {
-    ifModifiedSince: string;
+    ifModifiedSince: string | DownloadGitHubRepoResult;
 }
 /**
  * Options for downloadGitRepo()
@@ -15,9 +16,9 @@ export interface DownloadGitHubRepoOptions extends ExportTargetOptions, GitHubAP
 /**
  * Result
  */
-export interface DownloadGitHubRepoResult {
+export interface DownloadGitHubRepoResult extends DownloadSourceMixin<'github'> {
     rootDir: string;
-    actualDir: string;
+    contentsDir: string;
     hash: string;
 }
 /**

package/lib/download/github/index.js

@@ -19,7 +19,7 @@ async function findMatchingDirs(rootDir, hash) {
             lastChunk !== hash.slice(0, lastChunk.length)) {
             continue;
         }
-        const stat = await fs_1.promises.lstat(rootDir + '/' + file);
+        const stat = await fs_1.promises.stat(rootDir + '/' + file);
         if (stat.isDirectory()) {
             matches.push(file);
         }
@@ -29,8 +29,16 @@ async function findMatchingDirs(rootDir, hash) {
 async function downloadGitHubRepo(options) {
     // Check for last commit
     const hash = await (0, hash_1.getGitHubRepoHash)(options);
-    if (options.ifModifiedSince && hash === options.ifModifiedSince) {
-        return 'not_modified';
+    const ifModifiedSince = options.ifModifiedSince;
+    if (ifModifiedSince) {
+        const expectedHash = typeof ifModifiedSince === 'string'
+            ? ifModifiedSince
+            : ifModifiedSince.downloadType === 'github'
+                ? ifModifiedSince.hash
+                : null;
+        if (hash === expectedHash) {
+            return 'not_modified';
+        }
     }
     // Replace hash in target
     options.target = options.target.replace('{hash}', hash);
@@ -41,7 +49,7 @@ async function downloadGitHubRepo(options) {
     // Check if archive exists
     let exists = false;
     try {
-        const stat = await fs_1.promises.lstat(archiveTarget);
+        const stat = await fs_1.promises.stat(archiveTarget);
         exists = stat.isFile();
     }
     catch (err) {
@@ -71,8 +79,10 @@ async function downloadGitHubRepo(options) {
         const stat = await fs_1.promises.lstat(filename);
         const isDir = stat.isDirectory();
         if (
-        // Remove if directory matches hash to avoid errors extracting zip
-        (isDir && filename.slice(0 - hashSearch.length) === hashSearch) ||
+        // Remove symbolic links
+        stat.isSymbolicLink() ||
+            // Remove if directory matches hash to avoid errors extracting zip
+            (isDir && filename.slice(0 - hashSearch.length) === hashSearch) ||
             // Remove if directory and cleanupOldDirectories is not disabled
             (isDir && options.cleanupOldDirectories !== false) ||
             // Remove if file and cleanupOldFiles is enabled
@@ -95,10 +105,11 @@ async function downloadGitHubRepo(options) {
     if (matchingDirs.length !== 1) {
         throw new Error(`Error unpacking ${hash}.zip`);
     }
-    const actualDir = rootDir + '/' + matchingDirs[0];
+    const contentsDir = rootDir + '/' + matchingDirs[0];
     return {
+        downloadType: 'github',
         rootDir,
-        actualDir,
+        contentsDir,
         hash,
     };
 }

package/lib/download/github/index.mjs

@@ -15,7 +15,7 @@ async function findMatchingDirs(rootDir, hash) {
     if (lastChunk.length < 4 || lastChunk !== hash.slice(0, lastChunk.length)) {
       continue;
     }
-    const stat = await fs.lstat(rootDir + "/" + file);
+    const stat = await fs.stat(rootDir + "/" + file);
     if (stat.isDirectory()) {
       matches.push(file);
     }
@@ -24,15 +24,19 @@ async function findMatchingDirs(rootDir, hash) {
 }
 async function downloadGitHubRepo(options) {
   const hash = await getGitHubRepoHash(options);
-  if (options.ifModifiedSince && hash === options.ifModifiedSince) {
-    return "not_modified";
+  const ifModifiedSince = options.ifModifiedSince;
+  if (ifModifiedSince) {
+    const expectedHash = typeof ifModifiedSince === "string" ? ifModifiedSince : ifModifiedSince.downloadType === "github" ? ifModifiedSince.hash : null;
+    if (hash === expectedHash) {
+      return "not_modified";
+    }
   }
   options.target = options.target.replace("{hash}", hash);
   const rootDir = options.target = await prepareDirectoryForExport(options);
   const archiveTarget = rootDir + "/" + hash + ".zip";
   let exists = false;
   try {
-    const stat = await fs.lstat(archiveTarget);
+    const stat = await fs.stat(archiveTarget);
     exists = stat.isFile();
   } catch (err) {
   }
@@ -56,7 +60,7 @@ async function downloadGitHubRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await fs.lstat(filename);
     const isDir = stat.isDirectory();
-    if (isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
       try {
         await fs.rm(filename, {
           force: true,
@@ -71,10 +75,11 @@ async function downloadGitHubRepo(options) {
   if (matchingDirs.length !== 1) {
     throw new Error(`Error unpacking ${hash}.zip`);
   }
-  const actualDir = rootDir + "/" + matchingDirs[0];
+  const contentsDir = rootDir + "/" + matchingDirs[0];
   return {
+    downloadType: "github",
     rootDir,
-    actualDir,
+    contentsDir,
     hash
   };
 }

package/lib/download/index.d.ts

@@ -0,0 +1,20 @@
+import { DownloadGitHubRepoOptions, DownloadGitHubRepoResult } from './github';
+import { DownloadGitRepoOptions, DownloadGitRepoResult } from './git';
+import { DownloadNPMPackageOptions, DownloadNPMPackageResult } from './npm';
+import type { DocumentNotModified } from './types/modified';
+import type { DownloadSourceMixin, DownloadSourceType } from './types/sources';
+/**
+ * Add downloadType to options
+ */
+declare type ExtendedDownloadGitRepoOptions = DownloadGitRepoOptions & DownloadSourceMixin<'git'>;
+declare type ExtendedDownloadGitHubRepoOptions = DownloadGitHubRepoOptions & DownloadSourceMixin<'github'>;
+declare type ExtendedDownloadNPMPackageOptions = DownloadNPMPackageOptions & DownloadSourceMixin<'npm'>;
+export declare type DownloadOptions<T extends DownloadSourceType> = T extends 'git' ? ExtendedDownloadGitRepoOptions : T extends 'github' ? ExtendedDownloadGitHubRepoOptions : T extends 'npm' ? ExtendedDownloadNPMPackageOptions : never;
+/**
+ * Result type from downloadType
+ */
+export declare type DownloadResult<T extends DownloadSourceType> = T extends 'git' ? DownloadGitRepoResult : T extends 'github' ? DownloadGitHubRepoResult : T extends 'npm' ? DownloadNPMPackageResult : never;
+export declare function downloadPackage<T extends 'git'>(options: DownloadOptions<T>): Promise<DocumentNotModified | DownloadResult<T>>;
+export declare function downloadPackage<T extends 'github'>(options: DownloadOptions<T>): Promise<DocumentNotModified | DownloadResult<T>>;
+export declare function downloadPackage<T extends 'npm'>(options: DownloadOptions<T>): Promise<DocumentNotModified | DownloadResult<T>>;
+export {};

package/lib/download/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadPackage = void 0;
+const github_1 = require("./github");
+const git_1 = require("./git");
+const npm_1 = require("./npm");
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function assertNever(v) {
+    //
+}
+function downloadPackage(options) {
+    const type = options.downloadType;
+    switch (type) {
+        case 'git': {
+            return (0, git_1.downloadGitRepo)(options);
+        }
+        case 'github':
+            return (0, github_1.downloadGitHubRepo)(options);
+        case 'npm':
+            return (0, npm_1.downloadNPMPackage)(options);
+        default:
+            assertNever(type);
+            throw new Error(`Invalid download type: ${type}`);
+    }
+}
+exports.downloadPackage = downloadPackage;

package/lib/download/index.mjs

@@ -0,0 +1,30 @@
+// src/download/index.ts
+import {
+  downloadGitHubRepo
+} from "./github/index.mjs";
+import {
+  downloadGitRepo
+} from "./git/index.mjs";
+import {
+  downloadNPMPackage
+} from "./npm/index.mjs";
+function assertNever(v) {
+}
+function downloadPackage(options) {
+  const type = options.downloadType;
+  switch (type) {
+    case "git": {
+      return downloadGitRepo(options);
+    }
+    case "github":
+      return downloadGitHubRepo(options);
+    case "npm":
+      return downloadNPMPackage(options);
+    default:
+      assertNever(type);
+      throw new Error(`Invalid download type: ${type}`);
+  }
+}
+export {
+  downloadPackage
+};

package/lib/download/npm/index.d.ts

@@ -1,7 +1,8 @@
 import { ExportTargetOptions } from '../../export/helpers/prepare';
 import type { DocumentNotModified } from '../types/modified';
+import type { DownloadSourceMixin } from '../types/sources';
 interface IfModifiedSinceOption {
-    ifModifiedSince: string | true;
+    ifModifiedSince: string | true | DownloadNPMPackageResult;
 }
 /**
  * Options for downloadNPMPackage()
@@ -14,9 +15,9 @@ export interface DownloadNPMPackageOptions extends ExportTargetOptions, Partial<
 /**
  * Result
  */
-export interface DownloadNPMPackageResult {
+export interface DownloadNPMPackageResult extends DownloadSourceMixin<'npm'> {
     rootDir: string;
-    actualDir: string;
+    contentsDir: string;
     version: string;
 }
 /**

package/lib/download/npm/index.js

@@ -8,22 +8,39 @@ const untar_1 = require("../helpers/untar");
 const version_1 = require("./version");
 async function downloadNPMPackage(options) {
     const rootDir = (options.target = (0, prepare_1.normalizeDir)(options.target));
-    const actualDir = rootDir + '/package';
+    const contentsDir = rootDir + '/package';
     // Get latest location
     const versionInfo = await (0, version_1.getNPMVersion)(options);
     const version = versionInfo.version;
     // Check downloaded copy
-    if (options.ifModifiedSince) {
+    const ifModifiedSince = options.ifModifiedSince;
+    if (ifModifiedSince) {
         try {
-            const expectedVersion = options.ifModifiedSince === true
-                ? await (0, version_1.getPackageVersion)(actualDir)
-                : options.ifModifiedSince;
+            let expectedVersion;
+            if (typeof ifModifiedSince === 'object') {
+                // Make sure result object matches
+                if (ifModifiedSince.downloadType === 'npm' &&
+                    ifModifiedSince.rootDir === rootDir &&
+                    ifModifiedSince.contentsDir === contentsDir) {
+                    expectedVersion = ifModifiedSince.version;
+                }
+                else {
+                    expectedVersion = null;
+                }
+            }
+            else {
+                expectedVersion =
+                    ifModifiedSince === true
+                        ? await (0, version_1.getPackageVersion)(contentsDir)
+                        : ifModifiedSince;
+            }
             if (version === expectedVersion) {
                 return 'not_modified';
             }
         }
         catch (err) {
-            //
+            // Clean up on error
+            options.cleanup = true;
         }
     }
     const archiveURL = versionInfo.file;
@@ -36,7 +53,7 @@ async function downloadNPMPackage(options) {
     // Check if archive exists
     let archiveExists = false;
     try {
-        const stat = await fs_1.promises.lstat(archiveTarget);
+        const stat = await fs_1.promises.stat(archiveTarget);
         archiveExists = stat.isFile();
     }
     catch (err) {
@@ -56,7 +73,7 @@ async function downloadNPMPackage(options) {
     }
     // Remove old unpacked file
     await (0, prepare_1.prepareDirectoryForExport)({
-        target: actualDir,
+        target: contentsDir,
         cleanup: true,
     });
     // Unpack file
@@ -65,8 +82,9 @@ async function downloadNPMPackage(options) {
     }
     await (0, untar_1.untar)(archiveTarget, rootDir);
     return {
+        downloadType: 'npm',
         rootDir,
-        actualDir,
+        contentsDir,
         version,
     };
 }

package/lib/download/npm/index.mjs

@@ -9,16 +9,27 @@ import { untar } from "../helpers/untar.mjs";
 import { getNPMVersion, getPackageVersion } from "./version.mjs";
 async function downloadNPMPackage(options) {
   const rootDir = options.target = normalizeDir(options.target);
-  const actualDir = rootDir + "/package";
+  const contentsDir = rootDir + "/package";
   const versionInfo = await getNPMVersion(options);
   const version = versionInfo.version;
-  if (options.ifModifiedSince) {
+  const ifModifiedSince = options.ifModifiedSince;
+  if (ifModifiedSince) {
     try {
-      const expectedVersion = options.ifModifiedSince === true ? await getPackageVersion(actualDir) : options.ifModifiedSince;
+      let expectedVersion;
+      if (typeof ifModifiedSince === "object") {
+        if (ifModifiedSince.downloadType === "npm" && ifModifiedSince.rootDir === rootDir && ifModifiedSince.contentsDir === contentsDir) {
+          expectedVersion = ifModifiedSince.version;
+        } else {
+          expectedVersion = null;
+        }
+      } else {
+        expectedVersion = ifModifiedSince === true ? await getPackageVersion(contentsDir) : ifModifiedSince;
+      }
       if (version === expectedVersion) {
         return "not_modified";
       }
     } catch (err) {
+      options.cleanup = true;
     }
   }
   const archiveURL = versionInfo.file;
@@ -29,7 +40,7 @@ async function downloadNPMPackage(options) {
   await prepareDirectoryForExport(options);
   let archiveExists = false;
   try {
-    const stat = await fs.lstat(archiveTarget);
+    const stat = await fs.stat(archiveTarget);
     archiveExists = stat.isFile();
   } catch (err) {
   }
@@ -45,7 +56,7 @@ async function downloadNPMPackage(options) {
     }, archiveTarget);
   }
   await prepareDirectoryForExport({
-    target: actualDir,
+    target: contentsDir,
     cleanup: true
   });
   if (options.log) {
@@ -53,8 +64,9 @@ async function downloadNPMPackage(options) {
   }
   await untar(archiveTarget, rootDir);
   return {
+    downloadType: "npm",
     rootDir,
-    actualDir,
+    contentsDir,
     version
   };
 }

package/lib/download/types/sources.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Download types
+ */
+export declare type DownloadSourceType = 'git' | 'github' | 'npm';
+/**
+ * Type in other objects
+ */
+export interface DownloadSourceMixin<T extends DownloadSourceType> {
+    downloadType: T;
+}

package/lib/download/types/sources.js

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

package/lib/icon-set/index.js

@@ -8,7 +8,7 @@ const minify_1 = require("@iconify/utils/lib/icon-set/minify");
 const convert_info_1 = require("@iconify/utils/lib/icon-set/convert-info");
 const props_1 = require("./props");
 const svg_1 = require("../svg");
-// eslint-disable-next-line @typescript-eslint/no-unused-vars-experimental, @typescript-eslint/no-unused-vars
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 function assertNever(v) {
     //
 }

package/lib/icon-set/merge.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeIconSets = void 0;
 const _1 = require(".");
 const match_1 = require("./match");
-// eslint-disable-next-line @typescript-eslint/no-unused-vars-experimental, @typescript-eslint/no-unused-vars
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 function assertNever(v) {
     //
 }

package/lib/index.d.ts

@@ -13,10 +13,12 @@ export { importFromFigma } from './import/figma/index';
 export { importDirectory } from './import/directory';
 export { downloadGitRepo } from './download/git/index';
 export { getGitRepoHash } from './download/git/hash';
+export { getGitRepoBranch } from './download/git/branch';
 export { downloadGitHubRepo } from './download/github/index';
 export { getGitHubRepoHash } from './download/github/hash';
 export { downloadNPMPackage } from './download/npm/index';
 export { getNPMVersion, getPackageVersion } from './download/npm/version';
+export { downloadPackage } from './download/index';
 export { parseColors, isEmptyColor } from './colors/parse';
 export { validateColors } from './colors/validate';
 export { runSVGO } from './optimise/svgo';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendAPIQuery = exports.bumpVersion = exports.cleanupIconKeyword = exports.execAsync = exports.untar = exports.unzip = exports.compareDirectories = exports.scanDirectory = exports.prepareDirectoryForExport = exports.writeJSONFile = exports.exportJSONPackage = exports.exportIconPackage = exports.exportToDirectory = exports.scaleSVG = exports.deOptimisePaths = exports.runSVGO = exports.validateColors = exports.isEmptyColor = exports.parseColors = exports.getPackageVersion = exports.getNPMVersion = exports.downloadNPMPackage = exports.getGitHubRepoHash = exports.downloadGitHubRepo = exports.getGitRepoHash = exports.downloadGitRepo = exports.importDirectory = exports.importFromFigma = exports.mergeIconSets = exports.blankIconSet = exports.IconSet = exports.convertStyleToAttrs = exports.cleanupSVGRoot = exports.cleanupInlineStyle = exports.checkBadTags = exports.removeBadAttributes = exports.cleanupSVG = exports.parseSVGStyle = exports.parseSVG = exports.SVG = void 0;
+exports.sendAPIQuery = exports.bumpVersion = exports.cleanupIconKeyword = exports.execAsync = exports.untar = exports.unzip = exports.compareDirectories = exports.scanDirectory = exports.prepareDirectoryForExport = exports.writeJSONFile = exports.exportJSONPackage = exports.exportIconPackage = exports.exportToDirectory = exports.scaleSVG = exports.deOptimisePaths = exports.runSVGO = exports.validateColors = exports.isEmptyColor = exports.parseColors = exports.downloadPackage = exports.getPackageVersion = exports.getNPMVersion = exports.downloadNPMPackage = exports.getGitHubRepoHash = exports.downloadGitHubRepo = exports.getGitRepoBranch = exports.getGitRepoHash = exports.downloadGitRepo = exports.importDirectory = exports.importFromFigma = exports.mergeIconSets = exports.blankIconSet = exports.IconSet = exports.convertStyleToAttrs = exports.cleanupSVGRoot = exports.cleanupInlineStyle = exports.checkBadTags = exports.removeBadAttributes = exports.cleanupSVG = exports.parseSVGStyle = exports.parseSVG = exports.SVG = void 0;
 // SVG class and functions
 var index_1 = require("./svg/index");
 Object.defineProperty(exports, "SVG", { enumerable: true, get: function () { return index_1.SVG; } });
@@ -37,6 +37,8 @@ var index_4 = require("./download/git/index");
 Object.defineProperty(exports, "downloadGitRepo", { enumerable: true, get: function () { return index_4.downloadGitRepo; } });
 var hash_1 = require("./download/git/hash");
 Object.defineProperty(exports, "getGitRepoHash", { enumerable: true, get: function () { return hash_1.getGitRepoHash; } });
+var branch_1 = require("./download/git/branch");
+Object.defineProperty(exports, "getGitRepoBranch", { enumerable: true, get: function () { return branch_1.getGitRepoBranch; } });
 var index_5 = require("./download/github/index");
 Object.defineProperty(exports, "downloadGitHubRepo", { enumerable: true, get: function () { return index_5.downloadGitHubRepo; } });
 var hash_2 = require("./download/github/hash");
@@ -46,6 +48,8 @@ Object.defineProperty(exports, "downloadNPMPackage", { enumerable: true, get: fu
 var version_1 = require("./download/npm/version");
 Object.defineProperty(exports, "getNPMVersion", { enumerable: true, get: function () { return version_1.getNPMVersion; } });
 Object.defineProperty(exports, "getPackageVersion", { enumerable: true, get: function () { return version_1.getPackageVersion; } });
+var index_7 = require("./download/index");
+Object.defineProperty(exports, "downloadPackage", { enumerable: true, get: function () { return index_7.downloadPackage; } });
 // Manipulation
 var parse_2 = require("./colors/parse");
 Object.defineProperty(exports, "parseColors", { enumerable: true, get: function () { return parse_2.parseColors; } });
@@ -85,5 +89,5 @@ var keyword_1 = require("./misc/keyword");
 Object.defineProperty(exports, "cleanupIconKeyword", { enumerable: true, get: function () { return keyword_1.cleanupIconKeyword; } });
 var bump_version_1 = require("./misc/bump-version");
 Object.defineProperty(exports, "bumpVersion", { enumerable: true, get: function () { return bump_version_1.bumpVersion; } });
-var index_7 = require("./download/api/index");
-Object.defineProperty(exports, "sendAPIQuery", { enumerable: true, get: function () { return index_7.sendAPIQuery; } });
+var index_8 = require("./download/api/index");
+Object.defineProperty(exports, "sendAPIQuery", { enumerable: true, get: function () { return index_8.sendAPIQuery; } });

package/lib/index.mjs

@@ -14,10 +14,12 @@ import { importFromFigma } from "./import/figma/index.mjs";
 import { importDirectory } from "./import/directory.mjs";
 import { downloadGitRepo } from "./download/git/index.mjs";
 import { getGitRepoHash } from "./download/git/hash.mjs";
+import { getGitRepoBranch } from "./download/git/branch.mjs";
 import { downloadGitHubRepo } from "./download/github/index.mjs";
 import { getGitHubRepoHash } from "./download/github/hash.mjs";
 import { downloadNPMPackage } from "./download/npm/index.mjs";
 import { getNPMVersion, getPackageVersion } from "./download/npm/version.mjs";
+import { downloadPackage } from "./download/index.mjs";
 import { parseColors, isEmptyColor } from "./colors/parse.mjs";
 import { validateColors } from "./colors/validate.mjs";
 import { runSVGO } from "./optimise/svgo.mjs";
@@ -52,11 +54,13 @@ export {
   downloadGitHubRepo,
   downloadGitRepo,
   downloadNPMPackage,
+  downloadPackage,
   execAsync,
   exportIconPackage,
   exportJSONPackage,
   exportToDirectory,
   getGitHubRepoHash,
+  getGitRepoBranch,
   getGitRepoHash,
   getNPMVersion,
   getPackageVersion,

package/lib/misc/scan.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import type { Stats } from 'fs';
 /**
  * Callback
  *
@@ -13,8 +15,8 @@
  */
 declare type ScanDirectoryCallbackFalseResult = boolean | null | undefined;
 declare type ScanDirectoryCallbackStringResult = ScanDirectoryCallbackFalseResult | string;
-declare type ScanDirectoryCallbackAsString = (ext: string, file: string, subdir: string, path: string) => ScanDirectoryCallbackStringResult | Promise<ScanDirectoryCallbackStringResult>;
-declare type ScanDirectoryCallbackAsCustom<T> = (ext: string, file: string, subdir: string, path: string) => T | ScanDirectoryCallbackFalseResult | Promise<T | ScanDirectoryCallbackFalseResult>;
+declare type ScanDirectoryCallbackAsString = (ext: string, file: string, subdir: string, path: string, stat: Stats) => ScanDirectoryCallbackStringResult | Promise<ScanDirectoryCallbackStringResult>;
+declare type ScanDirectoryCallbackAsCustom<T> = (ext: string, file: string, subdir: string, path: string, stat: Stats) => T | ScanDirectoryCallbackFalseResult | Promise<T | ScanDirectoryCallbackFalseResult>;
 export declare type ScanDirectoryCallback = ScanDirectoryCallbackAsCustom<unknown> | ScanDirectoryCallbackAsString;
 /**
  * Find all files in directory

package/lib/misc/scan.js

@@ -15,7 +15,7 @@ async function scanDirectory(path, callback, subdirs = true) {
                 // Exclude hidden items
                 continue;
             }
-            const stat = await fs_1.promises.lstat(path + subdir + filename);
+            const stat = await fs_1.promises.stat(path + subdir + filename);
             if (stat.isDirectory()) {
                 if (subdirs) {
                     await scan(subdir + filename + '/');
@@ -31,7 +31,7 @@ async function scanDirectory(path, callback, subdirs = true) {
             // Callback
             let callbackResult;
             if (callback) {
-                callbackResult = callback(ext, file, subdir, path);
+                callbackResult = callback(ext, file, subdir, path, stat);
                 if (callbackResult instanceof Promise) {
                     callbackResult = await callbackResult;
                 }

package/lib/misc/scan.mjs

@@ -12,7 +12,7 @@ async function scanDirectory(path, callback, subdirs = true) {
       if (filename.slice(0, 1) === ".") {
         continue;
       }
-      const stat = await fs.lstat(path + subdir + filename);
+      const stat = await fs.stat(path + subdir + filename);
       if (stat.isDirectory()) {
         if (subdirs) {
           await scan(subdir + filename + "/");
@@ -27,7 +27,7 @@ async function scanDirectory(path, callback, subdirs = true) {
       const file = parts.join(".");
       let callbackResult;
       if (callback) {
-        callbackResult = callback(ext, file, subdir, path);
+        callbackResult = callback(ext, file, subdir, path, stat);
         if (callbackResult instanceof Promise) {
           callbackResult = await callbackResult;
         }

package/lib/optimise/svgo.js

@@ -76,7 +76,7 @@ async function runSVGO(svg, options = {}) {
                     params: {
                         prefix: typeof options.cleanupIDs === 'string'
                             ? options.cleanupIDs
-                            : 'svg-',
+                            : 'svgID',
                     },
                 },
             ]

package/lib/optimise/svgo.mjs

@@ -58,7 +58,7 @@ async function runSVGO(svg, options = {}) {
       {
         name: "cleanupIDs",
         params: {
-          prefix: typeof options.cleanupIDs === "string" ? options.cleanupIDs : "svg-"
+          prefix: typeof options.cleanupIDs === "string" ? options.cleanupIDs : "svgID"
         }
       }
     ] : []);

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@iconify/tools",
 	"description": "Collection of functions for cleaning up and parsing SVG for Iconify project",
 	"author": "Vjacheslav Trushkin",
-	"version": "2.0.3",
+	"version": "2.0.7",
 	"license": "MIT",
 	"bugs": "https://github.com/iconify/tools/issues",
 	"homepage": "https://github.com/iconify/tools",
@@ -22,14 +22,14 @@
 		"test": "npm run test:jest && npm run test:jasmine"
 	},
 	"dependencies": {
-		"@iconify/utils": "^1.0.20",
+		"@iconify/utils": "^1.0.21",
 		"@types/cheerio": "^0.22.30",
 		"@types/node-fetch": "^2.5.12",
 		"@types/svgo": "^2.6.0",
 		"@types/tar": "^6.1.0",
 		"cheerio": "^1.0.0-rc.10",
 		"extract-zip": "^2.0.1",
-		"node-fetch": "^2.6.6",
+		"node-fetch": "^2.6.7",
 		"pathe": "^0.2.0",
 		"svgo": "^2.8.0",
 		"tar": "^6.1.11"
@@ -104,6 +104,10 @@
 			"require": "./lib/download/api/types.js",
 			"import": "./lib/download/api/types.mjs"
 		},
+		"./lib/download/git/branch": {
+			"require": "./lib/download/git/branch.js",
+			"import": "./lib/download/git/branch.mjs"
+		},
 		"./lib/download/git/hash": {
 			"require": "./lib/download/git/hash.js",
 			"import": "./lib/download/git/hash.mjs"
@@ -140,6 +144,14 @@
 			"require": "./lib/download/helpers/unzip.js",
 			"import": "./lib/download/helpers/unzip.mjs"
 		},
+		"./lib/download": {
+			"require": "./lib/download/index.js",
+			"import": "./lib/download/index.mjs"
+		},
+		"./lib/download/index": {
+			"require": "./lib/download/index.js",
+			"import": "./lib/download/index.mjs"
+		},
 		"./lib/download/npm": {
 			"require": "./lib/download/npm/index.js",
 			"import": "./lib/download/npm/index.mjs"
@@ -160,6 +172,10 @@
 			"require": "./lib/download/types/modified.js",
 			"import": "./lib/download/types/modified.mjs"
 		},
+		"./lib/download/types/sources": {
+			"require": "./lib/download/types/sources.js",
+			"import": "./lib/download/types/sources.mjs"
+		},
 		"./lib/export/directory": {
 			"require": "./lib/export/directory.js",
 			"import": "./lib/export/directory.mjs"