@iconify/tools 4.2.0 → 5.0.0-beta.1

package/lib/optimise/svgo.d.cts

@@ -1,37 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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

@@ -1,104 +0,0 @@
-import { optimize } from 'svgo';
-import { replaceIDs } from '@iconify/utils/lib/svg/id';
-
-function getSVGOPlugins(options) {
-  return [
-    "cleanupAttrs",
-    "mergeStyles",
-    "inlineStyles",
-    "removeComments",
-    "removeUselessDefs",
-    "removeEditorsNSData",
-    "removeEmptyAttrs",
-    "removeEmptyContainers",
-    "convertStyleToAttrs",
-    "convertColors",
-    "convertTransform",
-    "removeUnknownsAndDefaults",
-    "removeNonInheritableGroupAttrs",
-    "removeUnusedNS",
-    "cleanupNumericValues",
-    "cleanupListOfValues",
-    "moveElemsAttrsToGroup",
-    "moveGroupAttrsToElems",
-    "collapseGroups",
-    "sortDefsChildren",
-    "sortAttrs",
-    // Plugins that are bugged when using animations
-    ...options.animated ? [] : ["removeUselessStrokeAndFill"],
-    // Plugins that modify shapes or are bugged when using animations
-    ...options.animated || options.keepShapes ? [] : [
-      "removeHiddenElems",
-      "convertShapeToPath",
-      "convertEllipseToCircle",
-      {
-        name: "convertPathData",
-        params: {
-          noSpaceAfterFlags: true
-        }
-      },
-      {
-        name: "mergePaths",
-        params: {
-          noSpaceAfterFlags: true
-        }
-      },
-      // 'removeOffCanvasPaths', // bugged for some icons
-      "reusePaths"
-    ],
-    // Clean up IDs, first run
-    // Sometimes bugs out on animated icons. Do not use with animations!
-    ...!options.animated && options.cleanupIDs !== false ? ["cleanupIds"] : []
-  ];
-}
-function runSVGO(svg, options = {}) {
-  const code = svg.toString();
-  const multipass = options.multipass !== false;
-  let plugins;
-  if (options.plugins) {
-    plugins = options.plugins;
-  } else {
-    const animated = code.includes("<animate") || code.includes("<set");
-    plugins = getSVGOPlugins({
-      ...options,
-      animated
-    });
-    if (code.includes("filter=") && code.includes("transform=")) {
-      plugins = plugins.filter(
-        (item) => item !== "moveElemsAttrsToGroup"
-      );
-    }
-  }
-  const pluginOptions = {
-    plugins,
-    multipass
-  };
-  const result = optimize(code, pluginOptions);
-  if (typeof result.error === "string") {
-    throw new Error(result.error);
-  }
-  let content = result.data.replace(/<defs\/>/g, "");
-  if (!options.plugins) {
-    const prefix = options.cleanupIDs !== void 0 ? options.cleanupIDs : "svgID";
-    if (prefix !== false) {
-      let counter = 0;
-      content = replaceIDs(
-        content,
-        typeof prefix === "string" ? () => {
-          return prefix + (counter++).toString(36);
-        } : prefix
-      );
-    }
-  }
-  if (!options.plugins || options.plugins.find((item) => {
-    if (typeof item === "string") {
-      return item === "reusePaths";
-    }
-    return item.name === "reusePaths";
-  })) {
-    content = content.replace(' xmlns:xlink="http://www.w3.org/1999/xlink"', "").replaceAll("xlink:href=", "href=");
-  }
-  svg.load(content);
-}
-
-export { getSVGOPlugins, runSVGO };

package/lib/optimise/unwrap.cjs

@@ -1,31 +0,0 @@
-'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

@@ -1,11 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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.mjs

@@ -1,29 +0,0 @@
-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.cjs

@@ -1,16 +0,0 @@
-'use strict';
-
-function analyseTagError(element) {
-  let result = "<" + element.tagName;
-  if (element._id) {
-    result += ' id="' + element._id + '"';
-  }
-  const attribs = element.attribs;
-  if (attribs["d"]) {
-    const value = attribs["d"];
-    result += ' d="' + (value.length > 16 ? value.slice(0, 12) + "..." : value) + '"';
-  }
-  return result + ">";
-}
-
-exports.analyseTagError = analyseTagError;

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

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

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

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

package/lib/svg/analyse/error.mjs

@@ -1,14 +0,0 @@
-function analyseTagError(element) {
-  let result = "<" + element.tagName;
-  if (element._id) {
-    result += ' id="' + element._id + '"';
-  }
-  const attribs = element.attribs;
-  if (attribs["d"]) {
-    const value = attribs["d"];
-    result += ' d="' + (value.length > 16 ? value.slice(0, 12) + "..." : value) + '"';
-  }
-  return result + ">";
-}
-
-export { analyseTagError };

package/lib/svg/analyse/types.cjs

@@ -1,2 +0,0 @@
-'use strict';
-

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

@@ -1,93 +0,0 @@
-import { CheerioElement } from '../../misc/cheerio.cjs';
-import 'domhandler';
-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

@@ -1,93 +0,0 @@
-import { CheerioElement } from '../../misc/cheerio.mjs';
-import 'domhandler';
-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.mjs

@@ -1 +0,0 @@
-