@iconify/tools 4.0.0-dev.1 → 4.0.1

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/optimise/unwrap.cjs

@@ -0,0 +1,31 @@
+'use strict';
+
+function unwrapEmptyGroup(svg) {
+  const cheerio = svg.$svg;
+  const $root = svg.$svg(":root");
+  const children = $root.children();
+  if (children.length !== 1 || children[0].tagName !== "g") {
+    return;
+  }
+  const groupNode = children[0];
+  const html = cheerio(groupNode).html();
+  if (!html) {
+    return;
+  }
+  for (const attr in groupNode.attribs) {
+    const value = groupNode.attribs[attr];
+    switch (attr) {
+      case "id": {
+        if (html?.includes(value)) {
+          return;
+        }
+        break;
+      }
+      default:
+        return;
+    }
+  }
+  $root.html(html);
+}
+
+exports.unwrapEmptyGroup = unwrapEmptyGroup;

package/lib/optimise/unwrap.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Removes empty group from SVG root element
+ */
+declare function unwrapEmptyGroup(svg: SVG): void;
+
+export { unwrapEmptyGroup };

package/lib/optimise/unwrap.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Removes empty group from SVG root element
+ */
+declare function unwrapEmptyGroup(svg: SVG): void;
+
+export { unwrapEmptyGroup };

package/lib/optimise/unwrap.d.ts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.js';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Removes empty group from SVG root element
+ */
+declare function unwrapEmptyGroup(svg: SVG): void;
+
+export { unwrapEmptyGroup };

package/lib/optimise/unwrap.mjs

@@ -0,0 +1,29 @@
+function unwrapEmptyGroup(svg) {
+  const cheerio = svg.$svg;
+  const $root = svg.$svg(":root");
+  const children = $root.children();
+  if (children.length !== 1 || children[0].tagName !== "g") {
+    return;
+  }
+  const groupNode = children[0];
+  const html = cheerio(groupNode).html();
+  if (!html) {
+    return;
+  }
+  for (const attr in groupNode.attribs) {
+    const value = groupNode.attribs[attr];
+    switch (attr) {
+      case "id": {
+        if (html?.includes(value)) {
+          return;
+        }
+        break;
+      }
+      default:
+        return;
+    }
+  }
+  $root.html(html);
+}
+
+export { unwrapEmptyGroup };

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';
 
 /**

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;