@iconify/tools 4.0.0-dev.1 → 4.0.0

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

@@ -0,0 +1,92 @@
+import { CheerioElement } from '../../misc/cheerio.cjs';
+import 'cheerio';
+
+/**
+ * Options
+ */
+interface AnalyseSVGStructureOptions {
+    fixErrors?: boolean;
+}
+/**
+ * Extended properties for element
+ */
+/**
+ * Link to element
+ */
+interface LinkToElementWithID {
+    id: string;
+    usedAsMask: boolean;
+    usedByIndex: number;
+}
+/**
+ * How element is used by parent elements
+ */
+interface ExtendedTagElementUses {
+    _usedAsMask: boolean;
+    _usedAsPaint: boolean;
+}
+/**
+ * Definition: mask, clip path, symbol, etc...
+ */
+interface ReusableElement {
+    id: string;
+    isMask: boolean;
+    index: number;
+}
+/**
+ * Element with id
+ *
+ * Similar to ReusableElement, but not necessary a definition - any element with id. Also contains list of child elements
+ */
+interface ElementWithID {
+    id: string;
+    isMask: boolean;
+    indexes: Set<number>;
+}
+/**
+ * Parent and child elements. Unlike standard tree, this tree is for elements that inherit attributes from parent element
+ */
+interface ExtendedTagElementRelations {
+    _parentElement?: number;
+    _childElements?: number[];
+}
+/**
+ * Extended tag
+ */
+interface ExtendedTagElement extends CheerioElement, ExtendedTagElementUses, ExtendedTagElementRelations {
+    _index: number;
+    _id?: string;
+    _belongsTo?: ElementWithID[];
+    _reusableElement?: ReusableElement;
+    _linksTo?: LinkToElementWithID[];
+}
+/**
+ * Additional stuff for <svg>
+ */
+interface ExtendedRootTagElement extends ExtendedTagElement {
+    _parsed?: boolean;
+}
+/**
+ * Tree
+ */
+interface ElementsTreeItem {
+    index: number;
+    usedAsMask: boolean;
+    parent?: ElementsTreeItem;
+    children: ElementsTreeItem[];
+}
+/**
+ * Elements map
+ */
+type ElementsMap = Map<number, ExtendedTagElement>;
+/**
+ * Result
+ */
+interface AnalyseSVGStructureResult {
+    elements: ElementsMap;
+    ids: Record<string, number>;
+    links: LinkToElementWithID[];
+    tree: ElementsTreeItem;
+}
+
+export type { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

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

@@ -0,0 +1,92 @@
+import { CheerioElement } from '../../misc/cheerio.mjs';
+import 'cheerio';
+
+/**
+ * Options
+ */
+interface AnalyseSVGStructureOptions {
+    fixErrors?: boolean;
+}
+/**
+ * Extended properties for element
+ */
+/**
+ * Link to element
+ */
+interface LinkToElementWithID {
+    id: string;
+    usedAsMask: boolean;
+    usedByIndex: number;
+}
+/**
+ * How element is used by parent elements
+ */
+interface ExtendedTagElementUses {
+    _usedAsMask: boolean;
+    _usedAsPaint: boolean;
+}
+/**
+ * Definition: mask, clip path, symbol, etc...
+ */
+interface ReusableElement {
+    id: string;
+    isMask: boolean;
+    index: number;
+}
+/**
+ * Element with id
+ *
+ * Similar to ReusableElement, but not necessary a definition - any element with id. Also contains list of child elements
+ */
+interface ElementWithID {
+    id: string;
+    isMask: boolean;
+    indexes: Set<number>;
+}
+/**
+ * Parent and child elements. Unlike standard tree, this tree is for elements that inherit attributes from parent element
+ */
+interface ExtendedTagElementRelations {
+    _parentElement?: number;
+    _childElements?: number[];
+}
+/**
+ * Extended tag
+ */
+interface ExtendedTagElement extends CheerioElement, ExtendedTagElementUses, ExtendedTagElementRelations {
+    _index: number;
+    _id?: string;
+    _belongsTo?: ElementWithID[];
+    _reusableElement?: ReusableElement;
+    _linksTo?: LinkToElementWithID[];
+}
+/**
+ * Additional stuff for <svg>
+ */
+interface ExtendedRootTagElement extends ExtendedTagElement {
+    _parsed?: boolean;
+}
+/**
+ * Tree
+ */
+interface ElementsTreeItem {
+    index: number;
+    usedAsMask: boolean;
+    parent?: ElementsTreeItem;
+    children: ElementsTreeItem[];
+}
+/**
+ * Elements map
+ */
+type ElementsMap = Map<number, ExtendedTagElement>;
+/**
+ * Result
+ */
+interface AnalyseSVGStructureResult {
+    elements: ElementsMap;
+    ids: Record<string, number>;
+    links: LinkToElementWithID[];
+    tree: ElementsTreeItem;
+}
+
+export type { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

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

@@ -1,4 +1,5 @@
-import * as cheerio from 'cheerio';
+import { CheerioElement } from '../../misc/cheerio.js';
+import 'cheerio';
 
 /**
  * Options
@@ -52,7 +53,7 @@ interface ExtendedTagElementRelations {
 /**
  * Extended tag
  */
-interface ExtendedTagElement extends cheerio.Element, ExtendedTagElementUses, ExtendedTagElementRelations {
+interface ExtendedTagElement extends CheerioElement, ExtendedTagElementUses, ExtendedTagElementRelations {
     _index: number;
     _id?: string;
     _belongsTo?: ElementWithID[];
@@ -88,4 +89,4 @@ interface AnalyseSVGStructureResult {
     tree: ElementsTreeItem;
 }
 
-export { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };
+export type { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

package/lib/svg/analyse.cjs

@@ -83,7 +83,7 @@ function analyseSVGStructure(svg, options = {}) {
     element._linksTo.push(link);
   }
   let index = 0;
-  svg_parse.parseSVGSync(svg, (item) => {
+  svg_parse.parseSVG(svg, (item) => {
     const { tagName, parents } = item;
     if (svg_data_tags.styleTag.has(tagName)) {
       item.testChildren = false;
@@ -263,7 +263,7 @@ function analyseSVGStructure(svg, options = {}) {
     usedItems = usedItems.slice(0);
     usedItems.push(element._index);
     element._childElements?.forEach((childIndex) => {
-      if (usedItems.indexOf(childIndex) !== -1) {
+      if (usedItems.includes(childIndex)) {
         throw new Error("Recursion");
       }
       const childItem = {

package/lib/svg/analyse.d.cts

@@ -0,0 +1,15 @@
+import { SVG } from './index.cjs';
+import { AnalyseSVGStructureOptions, AnalyseSVGStructureResult } from './analyse/types.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../misc/cheerio.cjs';
+
+/**
+ * Find all IDs, links, which elements use palette, which items aren't used
+ *
+ * Before running this function run cleanup functions to change inline style to attributes and fix attributes
+ */
+declare function analyseSVGStructure(svg: SVG, options?: AnalyseSVGStructureOptions): AnalyseSVGStructureResult;
+
+export { analyseSVGStructure };

package/lib/svg/analyse.d.mts

@@ -0,0 +1,15 @@
+import { SVG } from './index.mjs';
+import { AnalyseSVGStructureOptions, AnalyseSVGStructureResult } from './analyse/types.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../misc/cheerio.mjs';
+
+/**
+ * Find all IDs, links, which elements use palette, which items aren't used
+ *
+ * Before running this function run cleanup functions to change inline style to attributes and fix attributes
+ */
+declare function analyseSVGStructure(svg: SVG, options?: AnalyseSVGStructureOptions): AnalyseSVGStructureResult;
+
+export { analyseSVGStructure };

package/lib/svg/analyse.d.ts

@@ -3,6 +3,7 @@ import { AnalyseSVGStructureOptions, AnalyseSVGStructureResult } from './analyse
 import 'cheerio';
 import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
+import '../misc/cheerio.js';
 
 /**
  * Find all IDs, links, which elements use palette, which items aren't used

package/lib/svg/analyse.mjs

@@ -1,6 +1,6 @@
-import { parseSVGSync } from './parse.mjs';
+import { parseSVG } from './parse.mjs';
 import { tagSpecificNonPresentationalAttributes, urlPresentationalAttributes, commonColorPresentationalAttributes, markerAttributes } from './data/attributes.mjs';
-import { useTag, styleTag, maskTags, reusableElementsWithPalette, defsTag } from './data/tags.mjs';
+import { styleTag, maskTags, reusableElementsWithPalette, defsTag, useTag } from './data/tags.mjs';
 import { analyseTagError } from './analyse/error.mjs';
 
 function analyseSVGStructure(svg, options = {}) {
@@ -81,7 +81,7 @@ function analyseSVGStructure(svg, options = {}) {
     element._linksTo.push(link);
   }
   let index = 0;
-  parseSVGSync(svg, (item) => {
+  parseSVG(svg, (item) => {
     const { tagName, parents } = item;
     if (styleTag.has(tagName)) {
       item.testChildren = false;
@@ -261,7 +261,7 @@ function analyseSVGStructure(svg, options = {}) {
     usedItems = usedItems.slice(0);
     usedItems.push(element._index);
     element._childElements?.forEach((childIndex) => {
-      if (usedItems.indexOf(childIndex) !== -1) {
+      if (usedItems.includes(childIndex)) {
         throw new Error("Recursion");
       }
       const childItem = {

package/lib/svg/cleanup/attribs.cjs

@@ -5,7 +5,7 @@ const svg_data_tags = require('../data/tags.cjs');
 const svg_parse = require('../parse.cjs');
 
 function removeBadAttributes(svg) {
-  svg_parse.parseSVGSync(svg, (item) => {
+  svg_parse.parseSVG(svg, (item) => {
     const tagName = item.tagName;
     const attribs = item.element.attribs;
     const $element = item.$element;

package/lib/svg/cleanup/attribs.d.cts

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

package/lib/svg/cleanup/attribs.d.mts

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

package/lib/svg/cleanup/attribs.mjs

@@ -1,9 +1,9 @@
 import { badAttributes, badSoftwareAttributes, badAttributePrefixes, tagSpecificPresentationalAttributes } from '../data/attributes.mjs';
 import { defsTag } from '../data/tags.mjs';
-import { parseSVGSync } from '../parse.mjs';
+import { parseSVG } from '../parse.mjs';
 
 function removeBadAttributes(svg) {
-  parseSVGSync(svg, (item) => {
+  parseSVG(svg, (item) => {
     const tagName = item.tagName;
     const attribs = item.element.attribs;
     const $element = item.$element;

package/lib/svg/cleanup/bad-tags.cjs

@@ -21,7 +21,7 @@ function checkBadTags(svg, options) {
     ...defaultOptions,
     ...options
   };
-  svg_parse.parseSVGSync(svg, (item) => {
+  svg_parse.parseSVG(svg, (item) => {
     const tagName = item.tagName;
     const $element = item.$element;
     if (tagName === "svg") {

package/lib/svg/cleanup/bad-tags.d.cts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Options
+ */
+interface CheckBadTagsOptions {
+    keepTitles?: boolean;
+}
+/**
+ * Test for bag tags
+ */
+declare function checkBadTags(svg: SVG, options?: CheckBadTagsOptions): void;
+
+export { type CheckBadTagsOptions, checkBadTags };

package/lib/svg/cleanup/bad-tags.d.mts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Options
+ */
+interface CheckBadTagsOptions {
+    keepTitles?: boolean;
+}
+/**
+ * Test for bag tags
+ */
+declare function checkBadTags(svg: SVG, options?: CheckBadTagsOptions): void;
+
+export { type CheckBadTagsOptions, checkBadTags };

package/lib/svg/cleanup/bad-tags.d.ts

@@ -14,4 +14,4 @@ interface CheckBadTagsOptions {
  */
 declare function checkBadTags(svg: SVG, options?: CheckBadTagsOptions): void;
 
-export { CheckBadTagsOptions, checkBadTags };
+export { type CheckBadTagsOptions, checkBadTags };

package/lib/svg/cleanup/bad-tags.mjs

@@ -1,4 +1,4 @@
-import { parseSVGSync } from '../parse.mjs';
+import { parseSVG } from '../parse.mjs';
 import { feComponentTransferChildTag, feMergeChildTags, feLightningTags, feLightningChildTags, filterTag, filterChildTags, gradientTags, gradientChildTags, animateMotionChildTags, unsupportedTags, badTags, allValidTags } from '../data/tags.mjs';
 
 const requiredParentTags = /* @__PURE__ */ new Map();
@@ -19,7 +19,7 @@ function checkBadTags(svg, options) {
     ...defaultOptions,
     ...options
   };
-  parseSVGSync(svg, (item) => {
+  parseSVG(svg, (item) => {
     const tagName = item.tagName;
     const $element = item.$element;
     if (tagName === "svg") {

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

@@ -32,7 +32,7 @@ const knownIgnoredRules = /* @__PURE__ */ new Set([
   "stop-opacity"
 ]);
 function cleanupInlineStyle(svg) {
-  svg_parse.parseSVGSync(svg, (item) => {
+  svg_parse.parseSVG(svg, (item) => {
     const $element = item.$element;
     const attribs = item.element.attribs;
     const tagName = item.tagName;

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 };