@iconify/tools 2.2.0-beta.4 → 2.2.1

package/lib/colors/parse.cjs

@@ -226,6 +226,7 @@ async function parseColors(svg, options = {}) {
               const newValue = await checkColor(
                 elementProp,
                 value
+                // Do not pass third parameter
               );
               if (newValue !== value) {
                 updatedValues = true;

package/lib/colors/parse.mjs

@@ -224,6 +224,7 @@ async function parseColors(svg, options = {}) {
               const newValue = await checkColor(
                 elementProp,
                 value
+                // Do not pass third parameter
               );
               if (newValue !== value) {
                 updatedValues = true;

package/lib/download/git/index.cjs

@@ -58,6 +58,7 @@ async function downloadGitRepo(options) {
   }
   const target = options.target = await export_helpers_prepare.prepareDirectoryForExport({
     ...options,
+    // Always cleanup
     cleanup: true
   });
   if (options.log) {

package/lib/download/git/index.mjs

@@ -56,6 +56,7 @@ async function downloadGitRepo(options) {
   }
   const target = options.target = await prepareDirectoryForExport({
     ...options,
+    // Always cleanup
     cleanup: true
   });
   if (options.log) {

package/lib/download/github/index.cjs

@@ -72,7 +72,13 @@ async function downloadGitHubRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await fs.promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // 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
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await fs.promises.rm(filename, {
           force: true,

package/lib/download/github/index.mjs

@@ -70,7 +70,13 @@ async function downloadGitHubRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // 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
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await promises.rm(filename, {
           force: true,

package/lib/download/gitlab/index.cjs

@@ -72,7 +72,13 @@ async function downloadGitLabRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await fs.promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // 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
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await fs.promises.rm(filename, {
           force: true,

package/lib/download/gitlab/index.mjs

@@ -70,7 +70,13 @@ async function downloadGitLabRepo(options) {
     const filename = rootDir + "/" + files[i];
     const stat = await promises.lstat(filename);
     const isDir = stat.isDirectory();
-    if (stat.isSymbolicLink() || isDir && filename.slice(0 - hashSearch.length) === hashSearch || isDir && options.cleanupOldDirectories !== false || !isDir && options.cleanupOldFiles) {
+    if (
+      // 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
+      !isDir && options.cleanupOldFiles
+    ) {
       try {
         await promises.rm(filename, {
           force: true,

package/lib/export/icon-package.cjs

@@ -45,6 +45,7 @@ async function exportIconPackage(iconSet, options) {
     ...customPackageProps,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   await misc_writeJson.writeJSONFile(dir + "/package.json", packageJSON);

package/lib/export/icon-package.mjs

@@ -43,6 +43,7 @@ async function exportIconPackage(iconSet, options) {
     ...customPackageProps,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   await writeJSONFile(dir + "/package.json", packageJSON);

package/lib/export/json-package.cjs

@@ -75,6 +75,7 @@ async function exportJSONPackage(iconSet, options) {
     iconSet: packageJSONIconSet,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   const dtsContent = [];

package/lib/export/json-package.mjs

@@ -73,6 +73,7 @@ async function exportJSONPackage(iconSet, options) {
     iconSet: packageJSONIconSet,
     dependencies: dependencies || {
       "@iconify/types": "*"
+      // '^' + (await getTypesVersion()),
     }
   };
   const dtsContent = [];

package/lib/icon-set/index.cjs

@@ -17,9 +17,15 @@ function sortThemeKeys(keys) {
   );
 }
 class IconSet {
+  /**
+   * Load icon set
+   */
   constructor(data) {
     this.load(data);
   }
+  /**
+   * Load icon set
+   */
   load(data) {
     this.prefix = data.prefix;
     const defaultProps = iconSet_props.filterProps(data, defaults.defaultIconDimensions, true);
@@ -129,15 +135,27 @@ class IconSet {
     });
     this.lastModified = data.lastModified || 0;
   }
+  /**
+   * Update last modification time
+   */
   updateLastModified(value) {
     this.lastModified = value || Math.floor(Date.now() / 1e3);
   }
+  /**
+   * List icons
+   */
   list(types = ["icon", "variation"]) {
     return Object.keys(this.entries).filter((name) => {
       const type = this.entries[name].type;
       return types.indexOf(type) !== -1;
     });
   }
+  /**
+   * forEach function to loop through all entries.
+   * Supports asynchronous callbacks.
+   *
+   * Callback should return false to stop loop.
+   */
   async forEach(callback, types = ["icon", "variation", "alias"]) {
     const names = this.list(types);
     for (let i = 0; i < names.length; i++) {
@@ -154,6 +172,17 @@ class IconSet {
       }
     }
   }
+  /**
+   * Get parent icons tree
+   *
+   * Returns parent icons list for each icon, null if failed to resolve.
+   * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+   *
+   * Examples:
+   *   'alias3': ['alias2', 'alias1', 'icon']
+   * 	 'icon': []
+   * 	 'bad-icon': null
+   */
   getTree(names) {
     const entries = this.entries;
     const resolved = /* @__PURE__ */ Object.create(null);
@@ -200,6 +229,9 @@ class IconSet {
     tree.forEach(parse);
     return result && full ? { ...defaults.defaultIconProps, ...result } : result;
   }
+  /**
+   * Generate HTML
+   */
   toString(name, customisations = {
     width: "auto",
     height: "auto"
@@ -214,10 +246,16 @@ class IconSet {
     ).join("");
     return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"${attributes}>${result.body}</svg>`;
   }
+  /**
+   * Get SVG instance for icon
+   */
   toSVG(name) {
     const html = this.toString(name);
     return html ? new svg_index.SVG(html) : null;
   }
+  /**
+   * Export icon set
+   */
   export(validate = true) {
     const icons = /* @__PURE__ */ Object.create(null);
     const aliases = /* @__PURE__ */ Object.create(null);
@@ -304,6 +342,9 @@ class IconSet {
     minify.minifyIconSet(result);
     return result;
   }
+  /**
+   * Get characters map
+   */
   chars(names) {
     const chars = /* @__PURE__ */ Object.create(null);
     if (!names) {
@@ -318,6 +359,9 @@ class IconSet {
     }
     return chars;
   }
+  /**
+   * Filter icons
+   */
   _filter(callback) {
     const names = [];
     for (const key in this.entries) {
@@ -341,6 +385,9 @@ class IconSet {
     }
     return names;
   }
+  /**
+   * Count icons
+   */
   count() {
     return this._filter((_key, item, icon) => {
       if (item.type === "alias" || item.props.hidden || icon?.hidden) {
@@ -349,6 +396,9 @@ class IconSet {
       return true;
     }).length;
   }
+  /**
+   * Find category by title
+   */
   findCategory(title, add) {
     const categoryItem = Array.from(this.categories).find(
       (item) => item.title === title
@@ -366,6 +416,11 @@ class IconSet {
     }
     return null;
   }
+  /**
+   * Count icons in category, remove category if empty
+   *
+   * Hidden icons and aliases do not count
+   */
   listCategory(category) {
     const categoryItem = typeof category === "string" ? this.findCategory(category, false) : category;
     if (!categoryItem) {
@@ -385,9 +440,17 @@ class IconSet {
     }
     return icons;
   }
+  /**
+   * Check if icon exists
+   */
   exists(name) {
     return !!this.entries[name];
   }
+  /**
+   * Remove icons. Returns number of removed icons
+   *
+   * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+   */
   remove(name, removeDependencies = true) {
     const entries = this.entries;
     if (typeof removeDependencies === "string") {
@@ -430,6 +493,9 @@ class IconSet {
     }
     return count;
   }
+  /**
+   * Remove icon
+   */
   rename(oldName, newName) {
     const entries = this.entries;
     if (entries[newName]) {
@@ -458,6 +524,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update item
+   */
   setItem(name, item) {
     switch (item.type) {
       case "alias":
@@ -471,6 +540,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update icon
+   */
   setIcon(name, icon) {
     return this.setItem(name, {
       type: "icon",
@@ -480,6 +552,9 @@ class IconSet {
       categories: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias without props
+   */
   setAlias(name, parent) {
     return this.setItem(name, {
       type: "alias",
@@ -487,6 +562,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias with props
+   */
   setVariation(name, parent, props) {
     return this.setItem(name, {
       type: "variation",
@@ -495,6 +573,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Icon from SVG. Updates old icon if it exists
+   */
   fromSVG(name, svg) {
     const props = { ...svg.viewBox };
     const body = svg.getBody();
@@ -516,6 +597,9 @@ class IconSet {
       ...props
     });
   }
+  /**
+   * Add or remove character for icon
+   */
   toggleCharacter(iconName, char, add) {
     const item = this.entries[iconName];
     if (!item) {
@@ -527,6 +611,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Add or remove category for icon
+   */
   toggleCategory(iconName, category, add) {
     const item = this.entries[iconName];
     const categoryItem = this.findCategory(category, add);
@@ -543,6 +630,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Find icons that belong to theme
+   */
   checkTheme(prefix) {
     const themes = prefix ? this.prefixes : this.suffixes;
     const keys = sortThemeKeys(Object.keys(themes));

package/lib/icon-set/index.mjs

@@ -15,9 +15,15 @@ function sortThemeKeys(keys) {
   );
 }
 class IconSet {
+  /**
+   * Load icon set
+   */
   constructor(data) {
     this.load(data);
   }
+  /**
+   * Load icon set
+   */
   load(data) {
     this.prefix = data.prefix;
     const defaultProps = filterProps(data, defaultIconDimensions, true);
@@ -127,15 +133,27 @@ class IconSet {
     });
     this.lastModified = data.lastModified || 0;
   }
+  /**
+   * Update last modification time
+   */
   updateLastModified(value) {
     this.lastModified = value || Math.floor(Date.now() / 1e3);
   }
+  /**
+   * List icons
+   */
   list(types = ["icon", "variation"]) {
     return Object.keys(this.entries).filter((name) => {
       const type = this.entries[name].type;
       return types.indexOf(type) !== -1;
     });
   }
+  /**
+   * forEach function to loop through all entries.
+   * Supports asynchronous callbacks.
+   *
+   * Callback should return false to stop loop.
+   */
   async forEach(callback, types = ["icon", "variation", "alias"]) {
     const names = this.list(types);
     for (let i = 0; i < names.length; i++) {
@@ -152,6 +170,17 @@ class IconSet {
       }
     }
   }
+  /**
+   * Get parent icons tree
+   *
+   * Returns parent icons list for each icon, null if failed to resolve.
+   * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+   *
+   * Examples:
+   *   'alias3': ['alias2', 'alias1', 'icon']
+   * 	 'icon': []
+   * 	 'bad-icon': null
+   */
   getTree(names) {
     const entries = this.entries;
     const resolved = /* @__PURE__ */ Object.create(null);
@@ -198,6 +227,9 @@ class IconSet {
     tree.forEach(parse);
     return result && full ? { ...defaultIconProps, ...result } : result;
   }
+  /**
+   * Generate HTML
+   */
   toString(name, customisations = {
     width: "auto",
     height: "auto"
@@ -212,10 +244,16 @@ class IconSet {
     ).join("");
     return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"${attributes}>${result.body}</svg>`;
   }
+  /**
+   * Get SVG instance for icon
+   */
   toSVG(name) {
     const html = this.toString(name);
     return html ? new SVG(html) : null;
   }
+  /**
+   * Export icon set
+   */
   export(validate = true) {
     const icons = /* @__PURE__ */ Object.create(null);
     const aliases = /* @__PURE__ */ Object.create(null);
@@ -302,6 +340,9 @@ class IconSet {
     minifyIconSet(result);
     return result;
   }
+  /**
+   * Get characters map
+   */
   chars(names) {
     const chars = /* @__PURE__ */ Object.create(null);
     if (!names) {
@@ -316,6 +357,9 @@ class IconSet {
     }
     return chars;
   }
+  /**
+   * Filter icons
+   */
   _filter(callback) {
     const names = [];
     for (const key in this.entries) {
@@ -339,6 +383,9 @@ class IconSet {
     }
     return names;
   }
+  /**
+   * Count icons
+   */
   count() {
     return this._filter((_key, item, icon) => {
       if (item.type === "alias" || item.props.hidden || icon?.hidden) {
@@ -347,6 +394,9 @@ class IconSet {
       return true;
     }).length;
   }
+  /**
+   * Find category by title
+   */
   findCategory(title, add) {
     const categoryItem = Array.from(this.categories).find(
       (item) => item.title === title
@@ -364,6 +414,11 @@ class IconSet {
     }
     return null;
   }
+  /**
+   * Count icons in category, remove category if empty
+   *
+   * Hidden icons and aliases do not count
+   */
   listCategory(category) {
     const categoryItem = typeof category === "string" ? this.findCategory(category, false) : category;
     if (!categoryItem) {
@@ -383,9 +438,17 @@ class IconSet {
     }
     return icons;
   }
+  /**
+   * Check if icon exists
+   */
   exists(name) {
     return !!this.entries[name];
   }
+  /**
+   * Remove icons. Returns number of removed icons
+   *
+   * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+   */
   remove(name, removeDependencies = true) {
     const entries = this.entries;
     if (typeof removeDependencies === "string") {
@@ -428,6 +491,9 @@ class IconSet {
     }
     return count;
   }
+  /**
+   * Remove icon
+   */
   rename(oldName, newName) {
     const entries = this.entries;
     if (entries[newName]) {
@@ -456,6 +522,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update item
+   */
   setItem(name, item) {
     switch (item.type) {
       case "alias":
@@ -469,6 +538,9 @@ class IconSet {
     this.updateLastModified();
     return true;
   }
+  /**
+   * Add/update icon
+   */
   setIcon(name, icon) {
     return this.setItem(name, {
       type: "icon",
@@ -478,6 +550,9 @@ class IconSet {
       categories: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias without props
+   */
   setAlias(name, parent) {
     return this.setItem(name, {
       type: "alias",
@@ -485,6 +560,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Add/update alias with props
+   */
   setVariation(name, parent, props) {
     return this.setItem(name, {
       type: "variation",
@@ -493,6 +571,9 @@ class IconSet {
       chars: /* @__PURE__ */ new Set()
     });
   }
+  /**
+   * Icon from SVG. Updates old icon if it exists
+   */
   fromSVG(name, svg) {
     const props = { ...svg.viewBox };
     const body = svg.getBody();
@@ -514,6 +595,9 @@ class IconSet {
       ...props
     });
   }
+  /**
+   * Add or remove character for icon
+   */
   toggleCharacter(iconName, char, add) {
     const item = this.entries[iconName];
     if (!item) {
@@ -525,6 +609,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Add or remove category for icon
+   */
   toggleCategory(iconName, category, add) {
     const item = this.entries[iconName];
     const categoryItem = this.findCategory(category, add);
@@ -541,6 +628,9 @@ class IconSet {
     }
     return false;
   }
+  /**
+   * Find icons that belong to theme
+   */
   checkTheme(prefix) {
     const themes = prefix ? this.prefixes : this.suffixes;
     const keys = sortThemeKeys(Object.keys(themes));

package/lib/import/figma/index.cjs

@@ -42,10 +42,12 @@ require('../../misc/scan.cjs');
 
 async function importFromFigma(options) {
   const cacheOptions = options.cacheDir ? {
+    // 24 hours
     ttl: options.cacheAPITTL || 60 * 60 * 24,
     dir: options.cacheDir
   } : void 0;
   const cacheSVGOptions = options.cacheDir ? {
+    // 30 days
     ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
     dir: options.cacheDir
   } : void 0;
@@ -93,12 +95,15 @@ async function importFromFigma(options) {
     }
   }
   const result = {
+    // Document
     name: document.name,
     version: document.version,
     lastModified: document.lastModified,
+    // Counters
     nodesCount: nodes.nodesCount,
     generatedIconsCount: nodes.generatedIconsCount,
     downloadedIconsCount: nodes.downloadedIconsCount,
+    // Icon set
     iconSet,
     missing
   };

package/lib/import/figma/index.mjs

@@ -40,10 +40,12 @@ import '../../misc/scan.mjs';
 
 async function importFromFigma(options) {
   const cacheOptions = options.cacheDir ? {
+    // 24 hours
     ttl: options.cacheAPITTL || 60 * 60 * 24,
     dir: options.cacheDir
   } : void 0;
   const cacheSVGOptions = options.cacheDir ? {
+    // 30 days
     ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
     dir: options.cacheDir
   } : void 0;
@@ -91,12 +93,15 @@ async function importFromFigma(options) {
     }
   }
   const result = {
+    // Document
     name: document.name,
     version: document.version,
     lastModified: document.lastModified,
+    // Counters
     nodesCount: nodes.nodesCount,
     generatedIconsCount: nodes.generatedIconsCount,
     downloadedIconsCount: nodes.downloadedIconsCount,
+    // Icon set
     iconSet,
     missing
   };