@iconify/tools 4.0.0-dev.1 → 4.0.1

package/lib/svg/cleanup/inline-style.d.cts

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

package/lib/svg/cleanup/inline-style.d.mts

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

package/lib/svg/cleanup/inline-style.mjs

@@ -1,6 +1,6 @@
 import { parseInlineStyle } from '../../css/parse.mjs';
 import { badAttributes, tagSpecificNonPresentationalAttributes, tagSpecificAnimatedAttributes, tagSpecificPresentationalAttributes, tagSpecificInlineStyles, insideClipPathAttributes, badSoftwareAttributes, badAttributePrefixes } from '../data/attributes.mjs';
-import { parseSVGSync } from '../parse.mjs';
+import { parseSVG } from '../parse.mjs';
 import '../../css/parser/tokens.mjs';
 import '../../css/parser/error.mjs';
 import '../../css/parser/strings.mjs';
@@ -30,7 +30,7 @@ const knownIgnoredRules = /* @__PURE__ */ new Set([
   "stop-opacity"
 ]);
 function cleanupInlineStyle(svg) {
-  parseSVGSync(svg, (item) => {
+  parseSVG(svg, (item) => {
     const $element = item.$element;
     const attribs = item.element.attribs;
     const tagName = item.tagName;

package/lib/svg/cleanup/root-style.cjs

@@ -12,7 +12,7 @@ require('../parse.cjs');
 
 function cleanupRootStyle(svg) {
   const result = {};
-  svg_parseStyle.parseSVGStyleSync(svg, (item) => {
+  svg_parseStyle.parseSVGStyle(svg, (item) => {
     switch (item.type) {
       case "inline":
         return item.value;

package/lib/svg/cleanup/root-style.d.cts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+interface CleanupRootStyleResult {
+    animations?: Set<string>;
+    removedAtRules?: Set<string>;
+}
+/**
+ * Clean up root style
+ *
+ * This function removes all at-rule tokens, such as `@font-face`, `@media`
+ */
+declare function cleanupRootStyle(svg: SVG): CleanupRootStyleResult;
+
+export { cleanupRootStyle };

package/lib/svg/cleanup/root-style.d.mts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+interface CleanupRootStyleResult {
+    animations?: Set<string>;
+    removedAtRules?: Set<string>;
+}
+/**
+ * Clean up root style
+ *
+ * This function removes all at-rule tokens, such as `@font-face`, `@media`
+ */
+declare function cleanupRootStyle(svg: SVG): CleanupRootStyleResult;
+
+export { cleanupRootStyle };

package/lib/svg/cleanup/root-style.mjs

@@ -1,4 +1,4 @@
-import { parseSVGStyleSync } from '../parse-style.mjs';
+import { parseSVGStyle } from '../parse-style.mjs';
 import '../../css/parse.mjs';
 import '../../css/parser/tokens.mjs';
 import '../../css/parser/error.mjs';
@@ -10,7 +10,7 @@ import '../parse.mjs';
 
 function cleanupRootStyle(svg) {
   const result = {};
-  parseSVGStyleSync(svg, (item) => {
+  parseSVGStyle(svg, (item) => {
     switch (item.type) {
       case "inline":
         return item.value;

package/lib/svg/cleanup/root-svg.cjs

@@ -4,7 +4,7 @@ const svg_data_attributes = require('../data/attributes.cjs');
 const svg_data_tags = require('../data/tags.cjs');
 
 function cleanupSVGRoot(svg) {
-  const cheerio2 = svg.$svg;
+  const cheerio = svg.$svg;
   const $root = svg.$svg(":root");
   const root = $root.get(0);
   const tagName = "svg";
@@ -61,12 +61,12 @@ function cleanupSVGRoot(svg) {
     $root.removeAttr(attr);
   });
   if (Object.keys(moveToChildren).length) {
-    const $wrapper = cheerio2("<g />");
+    const $wrapper = cheerio("<g />");
     for (const key in moveToChildren) {
       $wrapper.attr(key, moveToChildren[key]);
     }
     $root.children().each((_index, child) => {
-      const $child = cheerio2(child);
+      const $child = cheerio(child);
       if (child.type !== "tag") {
         $child.appendTo($wrapper);
         return;

package/lib/svg/cleanup/root-svg.d.cts

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

package/lib/svg/cleanup/root-svg.d.mts

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

package/lib/svg/cleanup/root-svg.mjs

@@ -2,7 +2,7 @@ import { commonAttributes, badAttributes, junkSVGAttributes, badSoftwareAttribut
 import { reusableElementsWithPalette, maskTags } from '../data/tags.mjs';
 
 function cleanupSVGRoot(svg) {
-  const cheerio2 = svg.$svg;
+  const cheerio = svg.$svg;
   const $root = svg.$svg(":root");
   const root = $root.get(0);
   const tagName = "svg";
@@ -59,12 +59,12 @@ function cleanupSVGRoot(svg) {
     $root.removeAttr(attr);
   });
   if (Object.keys(moveToChildren).length) {
-    const $wrapper = cheerio2("<g />");
+    const $wrapper = cheerio("<g />");
     for (const key in moveToChildren) {
       $wrapper.attr(key, moveToChildren[key]);
     }
     $root.children().each((_index, child) => {
-      const $child = cheerio2(child);
+      const $child = cheerio(child);
       if (child.type !== "tag") {
         $child.appendTo($wrapper);
         return;

package/lib/svg/cleanup/svgo-style.cjs

@@ -17,7 +17,7 @@ require('@iconify/utils/lib/svg/id');
 
 function convertStyleToAttrs(svg) {
   let hasStyle = false;
-  svg_parseStyle.parseSVGStyleSync(svg, (item) => {
+  svg_parseStyle.parseSVGStyle(svg, (item) => {
     if (item.type !== "inline" && item.type !== "global") {
       return item.value;
     }
@@ -26,7 +26,7 @@ function convertStyleToAttrs(svg) {
       // Attributes / properties now allowed
       svg_data_attributes.badAttributes.has(prop) || svg_data_attributes.badSoftwareAttributes.has(prop) || svg_data_attributes.badAttributePrefixes.has(prop.split("-").shift())
     ) {
-      return void 0;
+      return;
     }
     hasStyle = true;
     return item.value;

package/lib/svg/cleanup/svgo-style.d.cts

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

package/lib/svg/cleanup/svgo-style.d.mts

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

package/lib/svg/cleanup/svgo-style.mjs

@@ -1,5 +1,5 @@
 import { badAttributes, badSoftwareAttributes, badAttributePrefixes } from '../data/attributes.mjs';
-import { parseSVGStyleSync } from '../parse-style.mjs';
+import { parseSVGStyle } from '../parse-style.mjs';
 import { runSVGO } from '../../optimise/svgo.mjs';
 import '../data/tags.mjs';
 import '../../css/parse.mjs';
@@ -15,7 +15,7 @@ import '@iconify/utils/lib/svg/id';
 
 function convertStyleToAttrs(svg) {
   let hasStyle = false;
-  parseSVGStyleSync(svg, (item) => {
+  parseSVGStyle(svg, (item) => {
     if (item.type !== "inline" && item.type !== "global") {
       return item.value;
     }
@@ -24,7 +24,7 @@ function convertStyleToAttrs(svg) {
       // Attributes / properties now allowed
       badAttributes.has(prop) || badSoftwareAttributes.has(prop) || badAttributePrefixes.has(prop.split("-").shift())
     ) {
-      return void 0;
+      return;
     }
     hasStyle = true;
     return item.value;

package/lib/svg/cleanup.d.cts

@@ -0,0 +1,16 @@
+import { SVG } from './index.cjs';
+import { CheckBadTagsOptions } from './cleanup/bad-tags.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Options
+ */
+type CleanupSVGOptions = CheckBadTagsOptions;
+/**
+ * Clean up SVG before parsing/optimising it
+ */
+declare function cleanupSVG(svg: SVG, options?: CleanupSVGOptions): void;
+
+export { type CleanupSVGOptions, cleanupSVG };

package/lib/svg/cleanup.d.mts

@@ -0,0 +1,16 @@
+import { SVG } from './index.mjs';
+import { CheckBadTagsOptions } from './cleanup/bad-tags.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Options
+ */
+type CleanupSVGOptions = CheckBadTagsOptions;
+/**
+ * Clean up SVG before parsing/optimising it
+ */
+declare function cleanupSVG(svg: SVG, options?: CleanupSVGOptions): void;
+
+export { type CleanupSVGOptions, cleanupSVG };

package/lib/svg/cleanup.d.ts

@@ -13,4 +13,4 @@ type CleanupSVGOptions = CheckBadTagsOptions;
  */
 declare function cleanupSVG(svg: SVG, options?: CleanupSVGOptions): void;
 
-export { CleanupSVGOptions, cleanupSVG };
+export { type CleanupSVGOptions, cleanupSVG };

package/lib/svg/data/attributes.d.cts

@@ -0,0 +1,77 @@
+/**
+ * This list is highly opinionated. It is designed to handle icons that can be safely embedded in HTML and linked as external source.
+ * Icons cannot have anything that requires external resources, anything that renders inconsistently.
+ */
+/***** Attributes that are not part of tag specific stuff *****/
+/**
+ * Attributes that icons should not mess with or that are irrelevant. They should be removed
+ */
+declare const badAttributes: Set<string>;
+/**
+ * Attributes for SVG element that should be removed
+ */
+declare const junkSVGAttributes: Set<string>;
+/**
+ * Attributes and styles often added by bad software to wrong tags, such as Adobe Illustrator and Inkscape
+ */
+declare const badSoftwareAttributes: Set<string>;
+declare const badAttributePrefixes: Set<string>;
+/**
+ * Common attributes that can exist on any element
+ */
+declare const commonAttributes: Set<string>;
+declare const stylingAttributes: Set<string>;
+/**
+ * Attributes that exist only on child elements of <clipPath>
+ */
+declare const insideClipPathAttributes: Set<string>;
+/***** Other attributes, added to tagSpecificAttributes variable below *****/
+/**
+ * Presentational attributes
+ */
+declare const fillPresentationalAttributes: Set<string>;
+declare const strokePresentationalAttributes: Set<string>;
+declare const urlPresentationalAttributes: Set<string>;
+declare const visibilityPresentationalAttributes: Set<string>;
+declare const commonColorPresentationalAttributes: Set<string>;
+declare const otherPresentationalAttributes: Set<string>;
+declare const presentationalAttributes: Set<string>;
+/**
+ * Markers
+ *
+ * Presentational attributes
+ */
+declare const markerAttributes: Set<string>;
+/**
+ * Shapes
+ *
+ * Not presentational
+ */
+declare const otherShapeAttributes: Set<string>;
+/**
+ * Animations
+ */
+declare const animationTimingAttributes: Set<string>;
+declare const animationValueAttributes: Set<string>;
+declare const otherAnimationAttributes: Set<string>;
+/**
+ * Gradients
+ */
+declare const commonGradientAttributes: Set<string>;
+/**
+ * Filters
+ */
+declare const commonFeAttributes: Set<string>;
+declare const feFuncAttributes: Set<string>;
+/**
+ * Tag specific attributes
+ */
+declare const tagSpecificAnimatedAttributes: Record<string, Set<string>>;
+declare const tagSpecificPresentationalAttributes: Record<string, Set<string>>;
+declare const tagSpecificNonPresentationalAttributes: Record<string, Set<string>>;
+/**
+ * Styles to keep in tags
+ */
+declare const tagSpecificInlineStyles: Record<string, Set<string>>;
+
+export { animationTimingAttributes, animationValueAttributes, badAttributePrefixes, badAttributes, badSoftwareAttributes, commonAttributes, commonColorPresentationalAttributes, commonFeAttributes, commonGradientAttributes, feFuncAttributes, fillPresentationalAttributes, insideClipPathAttributes, junkSVGAttributes, markerAttributes, otherAnimationAttributes, otherPresentationalAttributes, otherShapeAttributes, presentationalAttributes, strokePresentationalAttributes, stylingAttributes, tagSpecificAnimatedAttributes, tagSpecificInlineStyles, tagSpecificNonPresentationalAttributes, tagSpecificPresentationalAttributes, urlPresentationalAttributes, visibilityPresentationalAttributes };

package/lib/svg/data/attributes.d.mts

@@ -0,0 +1,77 @@
+/**
+ * This list is highly opinionated. It is designed to handle icons that can be safely embedded in HTML and linked as external source.
+ * Icons cannot have anything that requires external resources, anything that renders inconsistently.
+ */
+/***** Attributes that are not part of tag specific stuff *****/
+/**
+ * Attributes that icons should not mess with or that are irrelevant. They should be removed
+ */
+declare const badAttributes: Set<string>;
+/**
+ * Attributes for SVG element that should be removed
+ */
+declare const junkSVGAttributes: Set<string>;
+/**
+ * Attributes and styles often added by bad software to wrong tags, such as Adobe Illustrator and Inkscape
+ */
+declare const badSoftwareAttributes: Set<string>;
+declare const badAttributePrefixes: Set<string>;
+/**
+ * Common attributes that can exist on any element
+ */
+declare const commonAttributes: Set<string>;
+declare const stylingAttributes: Set<string>;
+/**
+ * Attributes that exist only on child elements of <clipPath>
+ */
+declare const insideClipPathAttributes: Set<string>;
+/***** Other attributes, added to tagSpecificAttributes variable below *****/
+/**
+ * Presentational attributes
+ */
+declare const fillPresentationalAttributes: Set<string>;
+declare const strokePresentationalAttributes: Set<string>;
+declare const urlPresentationalAttributes: Set<string>;
+declare const visibilityPresentationalAttributes: Set<string>;
+declare const commonColorPresentationalAttributes: Set<string>;
+declare const otherPresentationalAttributes: Set<string>;
+declare const presentationalAttributes: Set<string>;
+/**
+ * Markers
+ *
+ * Presentational attributes
+ */
+declare const markerAttributes: Set<string>;
+/**
+ * Shapes
+ *
+ * Not presentational
+ */
+declare const otherShapeAttributes: Set<string>;
+/**
+ * Animations
+ */
+declare const animationTimingAttributes: Set<string>;
+declare const animationValueAttributes: Set<string>;
+declare const otherAnimationAttributes: Set<string>;
+/**
+ * Gradients
+ */
+declare const commonGradientAttributes: Set<string>;
+/**
+ * Filters
+ */
+declare const commonFeAttributes: Set<string>;
+declare const feFuncAttributes: Set<string>;
+/**
+ * Tag specific attributes
+ */
+declare const tagSpecificAnimatedAttributes: Record<string, Set<string>>;
+declare const tagSpecificPresentationalAttributes: Record<string, Set<string>>;
+declare const tagSpecificNonPresentationalAttributes: Record<string, Set<string>>;
+/**
+ * Styles to keep in tags
+ */
+declare const tagSpecificInlineStyles: Record<string, Set<string>>;
+
+export { animationTimingAttributes, animationValueAttributes, badAttributePrefixes, badAttributes, badSoftwareAttributes, commonAttributes, commonColorPresentationalAttributes, commonFeAttributes, commonGradientAttributes, feFuncAttributes, fillPresentationalAttributes, insideClipPathAttributes, junkSVGAttributes, markerAttributes, otherAnimationAttributes, otherPresentationalAttributes, otherShapeAttributes, presentationalAttributes, strokePresentationalAttributes, stylingAttributes, tagSpecificAnimatedAttributes, tagSpecificInlineStyles, tagSpecificNonPresentationalAttributes, tagSpecificPresentationalAttributes, urlPresentationalAttributes, visibilityPresentationalAttributes };

package/lib/svg/data/tags.d.cts

@@ -0,0 +1,95 @@
+/**
+ * This list is highly opinionated. It is designed to handle icons that can be safely embedded in HTML and linked as external source.
+ * Icons cannot have anything that requires external resources, anything that renders inconsistently.
+ */
+/**
+ * Bad tags
+ *
+ * Parser should throw error if one of these tags is found
+ *
+ * List includes text tags because:
+ * - it usuaully uses custom font, which makes things much more complex
+ * - it renders differently on different operating systems and browsers
+ *
+ * View tag is not allowed because it requires targeting view by id from external source, making it unusable in embedded icons.
+ */
+declare const badTags: Set<string>;
+/**
+ * Deprecated or irrelevant tags
+ *
+ * Tags that are quietly removed
+ */
+declare const unsupportedTags: Set<string>;
+/**
+ * Style
+ */
+declare const styleTag: Set<string>;
+/**
+ * Definitions: reusable elements inside
+ */
+declare const defsTag: Set<string>;
+/**
+ * Masks: colors are ignored, elements must have id
+ */
+declare const maskTags: Set<string>;
+/**
+ * Symbol
+ */
+declare const symbolTag: Set<string>;
+/**
+ * SVG shapes
+ */
+declare const shapeTags: Set<string>;
+/**
+ * Use
+ */
+declare const useTag: Set<string>;
+/**
+ * Groups
+ */
+declare const groupTag: Set<string>;
+/**
+ * Marker, should be inside <defs>
+ */
+declare const markerTag: Set<string>;
+/**
+ * SVG animations
+ */
+declare const animateTags: Set<string>;
+declare const animateMotionChildTags: Set<string>;
+/**
+ * Gradients, should be inside <defs>
+ */
+declare const gradientTags: Set<string>;
+/**
+ * Gradient color, must be inside one of gradientTags
+ */
+declare const gradientChildTags: Set<string>;
+/**
+ * Pattern, should be inside <defs>
+ */
+declare const patternTag: Set<string>;
+/**
+ * Filters
+ */
+declare const filterTag: Set<string>;
+declare const feLightningTags: Set<string>;
+declare const filterChildTags: Set<string>;
+declare const feComponentTransferChildTag: Set<string>;
+declare const feLightningChildTags: Set<string>;
+declare const feMergeChildTags: Set<string>;
+/***** Combination of tags *****/
+/**
+ * Reusable elements that use colors
+ *
+ * Most are used via color attributes like `fill`
+ * Some are used via custom attributes like `marker-start`
+ * Filter is used via `filter`
+ */
+declare const reusableElementsWithPalette: Set<string>;
+/**
+ * All supported tags
+ */
+declare const allValidTags: Set<string>;
+
+export { allValidTags, animateMotionChildTags, animateTags, badTags, defsTag, feComponentTransferChildTag, feLightningChildTags, feLightningTags, feMergeChildTags, filterChildTags, filterTag, gradientChildTags, gradientTags, groupTag, markerTag, maskTags, patternTag, reusableElementsWithPalette, shapeTags, styleTag, symbolTag, unsupportedTags, useTag };

package/lib/svg/data/tags.d.mts

@@ -0,0 +1,95 @@
+/**
+ * This list is highly opinionated. It is designed to handle icons that can be safely embedded in HTML and linked as external source.
+ * Icons cannot have anything that requires external resources, anything that renders inconsistently.
+ */
+/**
+ * Bad tags
+ *
+ * Parser should throw error if one of these tags is found
+ *
+ * List includes text tags because:
+ * - it usuaully uses custom font, which makes things much more complex
+ * - it renders differently on different operating systems and browsers
+ *
+ * View tag is not allowed because it requires targeting view by id from external source, making it unusable in embedded icons.
+ */
+declare const badTags: Set<string>;
+/**
+ * Deprecated or irrelevant tags
+ *
+ * Tags that are quietly removed
+ */
+declare const unsupportedTags: Set<string>;
+/**
+ * Style
+ */
+declare const styleTag: Set<string>;
+/**
+ * Definitions: reusable elements inside
+ */
+declare const defsTag: Set<string>;
+/**
+ * Masks: colors are ignored, elements must have id
+ */
+declare const maskTags: Set<string>;
+/**
+ * Symbol
+ */
+declare const symbolTag: Set<string>;
+/**
+ * SVG shapes
+ */
+declare const shapeTags: Set<string>;
+/**
+ * Use
+ */
+declare const useTag: Set<string>;
+/**
+ * Groups
+ */
+declare const groupTag: Set<string>;
+/**
+ * Marker, should be inside <defs>
+ */
+declare const markerTag: Set<string>;
+/**
+ * SVG animations
+ */
+declare const animateTags: Set<string>;
+declare const animateMotionChildTags: Set<string>;
+/**
+ * Gradients, should be inside <defs>
+ */
+declare const gradientTags: Set<string>;
+/**
+ * Gradient color, must be inside one of gradientTags
+ */
+declare const gradientChildTags: Set<string>;
+/**
+ * Pattern, should be inside <defs>
+ */
+declare const patternTag: Set<string>;
+/**
+ * Filters
+ */
+declare const filterTag: Set<string>;
+declare const feLightningTags: Set<string>;
+declare const filterChildTags: Set<string>;
+declare const feComponentTransferChildTag: Set<string>;
+declare const feLightningChildTags: Set<string>;
+declare const feMergeChildTags: Set<string>;
+/***** Combination of tags *****/
+/**
+ * Reusable elements that use colors
+ *
+ * Most are used via color attributes like `fill`
+ * Some are used via custom attributes like `marker-start`
+ * Filter is used via `filter`
+ */
+declare const reusableElementsWithPalette: Set<string>;
+/**
+ * All supported tags
+ */
+declare const allValidTags: Set<string>;
+
+export { allValidTags, animateMotionChildTags, animateTags, badTags, defsTag, feComponentTransferChildTag, feLightningChildTags, feLightningTags, feMergeChildTags, filterChildTags, filterTag, gradientChildTags, gradientTags, groupTag, markerTag, maskTags, patternTag, reusableElementsWithPalette, shapeTags, styleTag, symbolTag, unsupportedTags, useTag };