@iconify/tools 4.0.0-dev.1 → 4.0.0

package/lib/optimise/figma.cjs

@@ -75,7 +75,7 @@ function checkClipPathNode(clipNode, expectedWidth, expectedHeight) {
 const urlStart = "url(#";
 const urlEnd = ")";
 function removeFigmaClipPathFromSVG(svg) {
-  const cheerio2 = svg.$svg;
+  const cheerio = svg.$svg;
   const $root = svg.$svg(":root");
   const children = $root.children();
   const backup = svg.toString();
@@ -112,7 +112,7 @@ function removeFigmaClipPathFromSVG(svg) {
       svg.viewBox.width,
       svg.viewBox.height
     );
-    cheerio2(node).remove();
+    cheerio(node).remove();
     return result;
   };
   const findClipPath = () => {
@@ -136,7 +136,7 @@ function removeFigmaClipPathFromSVG(svg) {
                   }
                 );
                 if (!validChildren.length) {
-                  cheerio2(node).remove();
+                  cheerio(node).remove();
                 }
                 return result;
               }
@@ -160,13 +160,13 @@ function removeFigmaClipPathFromSVG(svg) {
   const attribs = clipPath.attribs;
   for (let i = 0; i < shapesToClip.length; i++) {
     const node = shapesToClip[i];
-    cheerio2(node).removeAttr("clip-path");
+    cheerio(node).removeAttr("clip-path");
     for (const attr in attribs) {
       if (node.attribs[attr] !== void 0) {
         svg.load(backup);
         return false;
       }
-      cheerio2(node).attr(attr, attribs[attr]);
+      cheerio(node).attr(attr, attribs[attr]);
     }
   }
   return true;

package/lib/optimise/figma.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Removes clip path from SVG, which Figma adds to icons that might have overflowing elements
+ */
+declare function removeFigmaClipPathFromSVG(svg: SVG): boolean;
+
+export { removeFigmaClipPathFromSVG };

package/lib/optimise/figma.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Removes clip path from SVG, which Figma adds to icons that might have overflowing elements
+ */
+declare function removeFigmaClipPathFromSVG(svg: SVG): boolean;
+
+export { removeFigmaClipPathFromSVG };

package/lib/optimise/figma.mjs

@@ -73,7 +73,7 @@ function checkClipPathNode(clipNode, expectedWidth, expectedHeight) {
 const urlStart = "url(#";
 const urlEnd = ")";
 function removeFigmaClipPathFromSVG(svg) {
-  const cheerio2 = svg.$svg;
+  const cheerio = svg.$svg;
   const $root = svg.$svg(":root");
   const children = $root.children();
   const backup = svg.toString();
@@ -110,7 +110,7 @@ function removeFigmaClipPathFromSVG(svg) {
       svg.viewBox.width,
       svg.viewBox.height
     );
-    cheerio2(node).remove();
+    cheerio(node).remove();
     return result;
   };
   const findClipPath = () => {
@@ -134,7 +134,7 @@ function removeFigmaClipPathFromSVG(svg) {
                   }
                 );
                 if (!validChildren.length) {
-                  cheerio2(node).remove();
+                  cheerio(node).remove();
                 }
                 return result;
               }
@@ -158,13 +158,13 @@ function removeFigmaClipPathFromSVG(svg) {
   const attribs = clipPath.attribs;
   for (let i = 0; i < shapesToClip.length; i++) {
     const node = shapesToClip[i];
-    cheerio2(node).removeAttr("clip-path");
+    cheerio(node).removeAttr("clip-path");
     for (const attr in attribs) {
       if (node.attribs[attr] !== void 0) {
         svg.load(backup);
         return false;
       }
-      cheerio2(node).attr(attr, attribs[attr]);
+      cheerio(node).attr(attr, attribs[attr]);
     }
   }
   return true;

package/lib/optimise/flags.cjs

@@ -223,7 +223,7 @@ function cleanPath(path) {
             if (index < 1) {
               break;
             }
-            if (item.params[index - 1].indexOf(".") !== -1) {
+            if (item.params[index - 1].includes(".")) {
               break;
             }
           default:
@@ -235,8 +235,8 @@ function cleanPath(path) {
   });
   return output;
 }
-async function deOptimisePaths(svg) {
-  await svg_parse.parseSVG(svg, (item) => {
+function deOptimisePaths(svg) {
+  svg_parse.parseSVG(svg, (item) => {
     if (item.tagName !== "path") {
       return;
     }

package/lib/optimise/flags.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * De-optimise paths. Compressed paths are still not supported by some software.
+ */
+declare function deOptimisePaths(svg: SVG): void;
+
+export { deOptimisePaths };

package/lib/optimise/flags.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * De-optimise paths. Compressed paths are still not supported by some software.
+ */
+declare function deOptimisePaths(svg: SVG): void;
+
+export { deOptimisePaths };

package/lib/optimise/flags.d.ts

@@ -6,6 +6,6 @@ import '@iconify/utils/lib/customisations/defaults';
 /**
  * De-optimise paths. Compressed paths are still not supported by some software.
  */
-declare function deOptimisePaths(svg: SVG): Promise<void>;
+declare function deOptimisePaths(svg: SVG): void;
 
 export { deOptimisePaths };

package/lib/optimise/flags.mjs

@@ -221,7 +221,7 @@ function cleanPath(path) {
             if (index < 1) {
               break;
             }
-            if (item.params[index - 1].indexOf(".") !== -1) {
+            if (item.params[index - 1].includes(".")) {
               break;
             }
           default:
@@ -233,8 +233,8 @@ function cleanPath(path) {
   });
   return output;
 }
-async function deOptimisePaths(svg) {
-  await parseSVG(svg, (item) => {
+function deOptimisePaths(svg) {
+  parseSVG(svg, (item) => {
     if (item.tagName !== "path") {
       return;
     }

package/lib/optimise/global-style.cjs

@@ -15,11 +15,11 @@ function getClassList(value) {
   return value?.split(/\s+/);
 }
 const tempDataAttrbiute = "data-gstyle-temp";
-async function cleanupGlobalStyle(svg) {
+function cleanupGlobalStyle(svg) {
   const backup = svg.toString();
   let containsTempAttr = false;
   const animatedClasses = /* @__PURE__ */ new Set();
-  await svg_parse.parseSVG(svg, (item) => {
+  svg_parse.parseSVG(svg, (item) => {
     if (!svg_data_tags.animateTags.has(item.tagName)) {
       return;
     }
@@ -41,7 +41,7 @@ async function cleanupGlobalStyle(svg) {
   });
   const removeClasses = /* @__PURE__ */ new Set();
   try {
-    await svg_parseStyle.parseSVGStyle(svg, async (styleItem) => {
+    svg_parseStyle.parseSVGStyle(svg, (styleItem) => {
       const returnValue = styleItem.value;
       if (styleItem.type !== "global") {
         return returnValue;
@@ -93,7 +93,7 @@ async function cleanupGlobalStyle(svg) {
               break;
             case "class": {
               const className = $element.attr("class");
-              if (className && getClassList(className).indexOf(value) !== -1) {
+              if (className && getClassList(className).includes(value)) {
                 return true;
               }
             }
@@ -101,7 +101,7 @@ async function cleanupGlobalStyle(svg) {
         }
         return false;
       };
-      await svg_parse.parseSVG(svg, (svgItem) => {
+      svg_parse.parseSVG(svg, (svgItem) => {
         const tagName = svgItem.tagName;
         const $element = svgItem.$element;
         if (!isMatch(tagName, $element)) {
@@ -130,7 +130,7 @@ async function cleanupGlobalStyle(svg) {
         }
       });
     });
-    await svg_parse.parseSVG(svg, (svgItem) => {
+    svg_parse.parseSVG(svg, (svgItem) => {
       const $element = svgItem.$element;
       const classList = getClassList($element.attr("class"));
       if (!classList) {
@@ -146,7 +146,7 @@ async function cleanupGlobalStyle(svg) {
       }
     });
     if (containsTempAttr) {
-      await svg_parse.parseSVG(svg, (item) => {
+      svg_parse.parseSVG(svg, (item) => {
         item.$element.removeAttr(tempDataAttrbiute);
       });
     }

package/lib/optimise/global-style.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Expand global style
+ */
+declare function cleanupGlobalStyle(svg: SVG): void;
+
+export { cleanupGlobalStyle };

package/lib/optimise/global-style.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Expand global style
+ */
+declare function cleanupGlobalStyle(svg: SVG): void;
+
+export { cleanupGlobalStyle };

package/lib/optimise/global-style.d.ts

@@ -6,6 +6,6 @@ import '@iconify/utils/lib/customisations/defaults';
 /**
  * Expand global style
  */
-declare function cleanupGlobalStyle(svg: SVG): Promise<void>;
+declare function cleanupGlobalStyle(svg: SVG): void;
 
 export { cleanupGlobalStyle };

package/lib/optimise/global-style.mjs

@@ -13,11 +13,11 @@ function getClassList(value) {
   return value?.split(/\s+/);
 }
 const tempDataAttrbiute = "data-gstyle-temp";
-async function cleanupGlobalStyle(svg) {
+function cleanupGlobalStyle(svg) {
   const backup = svg.toString();
   let containsTempAttr = false;
   const animatedClasses = /* @__PURE__ */ new Set();
-  await parseSVG(svg, (item) => {
+  parseSVG(svg, (item) => {
     if (!animateTags.has(item.tagName)) {
       return;
     }
@@ -39,7 +39,7 @@ async function cleanupGlobalStyle(svg) {
   });
   const removeClasses = /* @__PURE__ */ new Set();
   try {
-    await parseSVGStyle(svg, async (styleItem) => {
+    parseSVGStyle(svg, (styleItem) => {
       const returnValue = styleItem.value;
       if (styleItem.type !== "global") {
         return returnValue;
@@ -91,7 +91,7 @@ async function cleanupGlobalStyle(svg) {
               break;
             case "class": {
               const className = $element.attr("class");
-              if (className && getClassList(className).indexOf(value) !== -1) {
+              if (className && getClassList(className).includes(value)) {
                 return true;
               }
             }
@@ -99,7 +99,7 @@ async function cleanupGlobalStyle(svg) {
         }
         return false;
       };
-      await parseSVG(svg, (svgItem) => {
+      parseSVG(svg, (svgItem) => {
         const tagName = svgItem.tagName;
         const $element = svgItem.$element;
         if (!isMatch(tagName, $element)) {
@@ -128,7 +128,7 @@ async function cleanupGlobalStyle(svg) {
         }
       });
     });
-    await parseSVG(svg, (svgItem) => {
+    parseSVG(svg, (svgItem) => {
       const $element = svgItem.$element;
       const classList = getClassList($element.attr("class"));
       if (!classList) {
@@ -144,7 +144,7 @@ async function cleanupGlobalStyle(svg) {
       }
     });
     if (containsTempAttr) {
-      await parseSVG(svg, (item) => {
+      parseSVG(svg, (item) => {
         item.$element.removeAttr(tempDataAttrbiute);
       });
     }

package/lib/optimise/mask.cjs

@@ -46,7 +46,7 @@ function convertSVGToMask(svg, options = {}) {
   let failed = false;
   let hasCustomValue = false;
   const backup = svg.toString();
-  colors_parse.parseColorsSync(svg, {
+  colors_parse.parseColors(svg, {
     callback: (attr, colorStr, color) => {
       if (!color || colors_parse.isEmptyColor(color)) {
         return colorStr;

package/lib/optimise/mask.d.cts

@@ -0,0 +1,24 @@
+import { Color } from '@iconify/utils/lib/colors/types';
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+type ColorCallback = (value: string, color: Color | null) => boolean;
+type ColorCheck = string | string[] | ColorCallback;
+interface SVGToMaskOptions {
+    color?: string;
+    solid?: ColorCheck;
+    transparent?: ColorCheck;
+    custom?: (value: string, color: Color | null) => string | number | undefined;
+    force?: boolean;
+    id?: string;
+}
+/**
+ * Converts SVG to mask
+ *
+ * Fixes badly designed icons, which use white shape where icon supposed to be transparent
+ */
+declare function convertSVGToMask(svg: SVG, options?: SVGToMaskOptions): boolean;
+
+export { convertSVGToMask };

package/lib/optimise/mask.d.mts

@@ -0,0 +1,24 @@
+import { Color } from '@iconify/utils/lib/colors/types';
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+type ColorCallback = (value: string, color: Color | null) => boolean;
+type ColorCheck = string | string[] | ColorCallback;
+interface SVGToMaskOptions {
+    color?: string;
+    solid?: ColorCheck;
+    transparent?: ColorCheck;
+    custom?: (value: string, color: Color | null) => string | number | undefined;
+    force?: boolean;
+    id?: string;
+}
+/**
+ * Converts SVG to mask
+ *
+ * Fixes badly designed icons, which use white shape where icon supposed to be transparent
+ */
+declare function convertSVGToMask(svg: SVG, options?: SVGToMaskOptions): boolean;
+
+export { convertSVGToMask };

package/lib/optimise/mask.mjs

@@ -1,4 +1,4 @@
-import { parseColorsSync, isEmptyColor } from '../colors/parse.mjs';
+import { parseColors, isEmptyColor } from '../colors/parse.mjs';
 import { parseSVGContent, splitSVGDefs, iconToHTML } from '@iconify/utils';
 import '@iconify/utils/lib/colors';
 import '../svg/data/tags.mjs';
@@ -44,7 +44,7 @@ function convertSVGToMask(svg, options = {}) {
   let failed = false;
   let hasCustomValue = false;
   const backup = svg.toString();
-  parseColorsSync(svg, {
+  parseColors(svg, {
     callback: (attr, colorStr, color) => {
       if (!color || isEmptyColor(color)) {
         return colorStr;

package/lib/optimise/origin.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Reset origin to 0 0
+ */
+declare function resetSVGOrigin(svg: SVG): void;
+
+export { resetSVGOrigin };

package/lib/optimise/origin.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Reset origin to 0 0
+ */
+declare function resetSVGOrigin(svg: SVG): void;
+
+export { resetSVGOrigin };

package/lib/optimise/scale.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Scale icon
+ */
+declare function scaleSVG(svg: SVG, scale: number): void;
+
+export { scaleSVG };

package/lib/optimise/scale.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Scale icon
+ */
+declare function scaleSVG(svg: SVG, scale: number): void;
+
+export { scaleSVG };

package/lib/optimise/svgo.cjs

@@ -60,7 +60,7 @@ function runSVGO(svg, options = {}) {
   if (options.plugins) {
     plugins = options.plugins;
   } else {
-    const animated = code.indexOf("<animate") !== -1 || code.indexOf("<set") !== -1;
+    const animated = code.includes("<animate") || code.includes("<set");
     plugins = getSVGOPlugins({
       ...options,
       animated

package/lib/optimise/svgo.d.cts

@@ -0,0 +1,37 @@
+import { PluginConfig } from 'svgo';
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+interface CleanupIDsOption {
+    cleanupIDs?: string | ((id: string) => string) | false;
+}
+interface GetSVGOPluginOptions extends CleanupIDsOption {
+    animated?: boolean;
+    keepShapes?: boolean;
+}
+/**
+ * Get list of plugins
+ */
+declare function getSVGOPlugins(options: GetSVGOPluginOptions): PluginConfig[];
+/**
+ * Options
+ */
+interface SVGOCommonOptions {
+    multipass?: boolean;
+}
+interface SVGOOptionsWithPlugin extends SVGOCommonOptions {
+    plugins: PluginConfig[];
+}
+interface SVGOptionsWithoutPlugin extends SVGOCommonOptions, CleanupIDsOption {
+    plugins?: undefined;
+    keepShapes?: boolean;
+}
+type SVGOOptions = SVGOOptionsWithPlugin | SVGOptionsWithoutPlugin;
+/**
+ * Run SVGO on icon
+ */
+declare function runSVGO(svg: SVG, options?: SVGOOptions): void;
+
+export { getSVGOPlugins, runSVGO };

package/lib/optimise/svgo.d.mts

@@ -0,0 +1,37 @@
+import { PluginConfig } from 'svgo';
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+interface CleanupIDsOption {
+    cleanupIDs?: string | ((id: string) => string) | false;
+}
+interface GetSVGOPluginOptions extends CleanupIDsOption {
+    animated?: boolean;
+    keepShapes?: boolean;
+}
+/**
+ * Get list of plugins
+ */
+declare function getSVGOPlugins(options: GetSVGOPluginOptions): PluginConfig[];
+/**
+ * Options
+ */
+interface SVGOCommonOptions {
+    multipass?: boolean;
+}
+interface SVGOOptionsWithPlugin extends SVGOCommonOptions {
+    plugins: PluginConfig[];
+}
+interface SVGOptionsWithoutPlugin extends SVGOCommonOptions, CleanupIDsOption {
+    plugins?: undefined;
+    keepShapes?: boolean;
+}
+type SVGOOptions = SVGOOptionsWithPlugin | SVGOptionsWithoutPlugin;
+/**
+ * Run SVGO on icon
+ */
+declare function runSVGO(svg: SVG, options?: SVGOOptions): void;
+
+export { getSVGOPlugins, runSVGO };

package/lib/optimise/svgo.mjs

@@ -58,7 +58,7 @@ function runSVGO(svg, options = {}) {
   if (options.plugins) {
     plugins = options.plugins;
   } else {
-    const animated = code.indexOf("<animate") !== -1 || code.indexOf("<set") !== -1;
+    const animated = code.includes("<animate") || code.includes("<set");
     plugins = getSVGOPlugins({
       ...options,
       animated

package/lib/svg/analyse/error.d.cts

@@ -0,0 +1,10 @@
+import { ExtendedTagElement } from './types.cjs';
+import '../../misc/cheerio.cjs';
+import 'cheerio';
+
+/**
+ * Get tag for error message
+ */
+declare function analyseTagError(element: ExtendedTagElement): string;
+
+export { analyseTagError };

package/lib/svg/analyse/error.d.mts

@@ -0,0 +1,10 @@
+import { ExtendedTagElement } from './types.mjs';
+import '../../misc/cheerio.mjs';
+import 'cheerio';
+
+/**
+ * Get tag for error message
+ */
+declare function analyseTagError(element: ExtendedTagElement): string;
+
+export { analyseTagError };

package/lib/svg/analyse/error.d.ts

@@ -1,4 +1,5 @@
 import { ExtendedTagElement } from './types.js';
+import '../../misc/cheerio.js';
 import 'cheerio';
 
 /**