@iconify/tools 4.2.0 → 5.0.0-beta.1

package/lib/colors/attribs.cjs

@@ -1,33 +0,0 @@
-'use strict';
-
-const commonColorAttributes = ["color"];
-const shapeColorAttributes = ["fill", "stroke"];
-const specialColorAttributes = [
-  "stop-color",
-  "flood-color"
-];
-const defaultBlackColor = {
-  type: "rgb",
-  r: 0,
-  g: 0,
-  b: 0,
-  alpha: 1
-};
-const defaultColorValues = {
-  "color": { type: "current" },
-  "fill": defaultBlackColor,
-  "stroke": { type: "none" },
-  "stop-color": defaultBlackColor,
-  "flood-color": defaultBlackColor
-};
-const allowDefaultColorValue = {
-  "stop-color": true,
-  "flood-color": "flood-opacity"
-};
-
-exports.allowDefaultColorValue = allowDefaultColorValue;
-exports.commonColorAttributes = commonColorAttributes;
-exports.defaultBlackColor = defaultBlackColor;
-exports.defaultColorValues = defaultColorValues;
-exports.shapeColorAttributes = shapeColorAttributes;
-exports.specialColorAttributes = specialColorAttributes;

package/lib/colors/attribs.d.cts

@@ -1,27 +0,0 @@
-import { Color } from '@iconify/utils/lib/colors/types';
-
-/**
- * Color attributes
- */
-type CommonColorAttributes = 'color';
-declare const commonColorAttributes: CommonColorAttributes[];
-type ShapeColorAttributes = 'fill' | 'stroke';
-declare const shapeColorAttributes: ShapeColorAttributes[];
-type SpecialColorAttributes = 'stop-color' | 'flood-color';
-declare const specialColorAttributes: SpecialColorAttributes[];
-type ColorAttributes = CommonColorAttributes | ShapeColorAttributes | SpecialColorAttributes;
-/**
- * Default values
- */
-declare const defaultBlackColor: Color;
-declare const defaultColorValues: Record<ColorAttributes, Color>;
-/**
- * Ignore default color for some tags:
- * - If value is true, allow default color
- * - If value is attribute name, allow default color if attribute is set
- *
- * Parent elements are not checked for these tags!
- */
-declare const allowDefaultColorValue: Partial<Record<ColorAttributes, string | true>>;
-
-export { type ColorAttributes, type CommonColorAttributes, type ShapeColorAttributes, type SpecialColorAttributes, allowDefaultColorValue, commonColorAttributes, defaultBlackColor, defaultColorValues, shapeColorAttributes, specialColorAttributes };

package/lib/colors/attribs.d.mts

@@ -1,27 +0,0 @@
-import { Color } from '@iconify/utils/lib/colors/types';
-
-/**
- * Color attributes
- */
-type CommonColorAttributes = 'color';
-declare const commonColorAttributes: CommonColorAttributes[];
-type ShapeColorAttributes = 'fill' | 'stroke';
-declare const shapeColorAttributes: ShapeColorAttributes[];
-type SpecialColorAttributes = 'stop-color' | 'flood-color';
-declare const specialColorAttributes: SpecialColorAttributes[];
-type ColorAttributes = CommonColorAttributes | ShapeColorAttributes | SpecialColorAttributes;
-/**
- * Default values
- */
-declare const defaultBlackColor: Color;
-declare const defaultColorValues: Record<ColorAttributes, Color>;
-/**
- * Ignore default color for some tags:
- * - If value is true, allow default color
- * - If value is attribute name, allow default color if attribute is set
- *
- * Parent elements are not checked for these tags!
- */
-declare const allowDefaultColorValue: Partial<Record<ColorAttributes, string | true>>;
-
-export { type ColorAttributes, type CommonColorAttributes, type ShapeColorAttributes, type SpecialColorAttributes, allowDefaultColorValue, commonColorAttributes, defaultBlackColor, defaultColorValues, shapeColorAttributes, specialColorAttributes };

package/lib/colors/attribs.mjs

@@ -1,26 +0,0 @@
-const commonColorAttributes = ["color"];
-const shapeColorAttributes = ["fill", "stroke"];
-const specialColorAttributes = [
-  "stop-color",
-  "flood-color"
-];
-const defaultBlackColor = {
-  type: "rgb",
-  r: 0,
-  g: 0,
-  b: 0,
-  alpha: 1
-};
-const defaultColorValues = {
-  "color": { type: "current" },
-  "fill": defaultBlackColor,
-  "stroke": { type: "none" },
-  "stop-color": defaultBlackColor,
-  "flood-color": defaultBlackColor
-};
-const allowDefaultColorValue = {
-  "stop-color": true,
-  "flood-color": "flood-opacity"
-};
-
-export { allowDefaultColorValue, commonColorAttributes, defaultBlackColor, defaultColorValues, shapeColorAttributes, specialColorAttributes };

package/lib/colors/detect.cjs

@@ -1,66 +0,0 @@
-'use strict';
-
-const colors_parse = require('./parse.cjs');
-require('@iconify/utils/lib/colors');
-require('../svg/data/tags.cjs');
-require('../svg/parse-style.cjs');
-require('../css/parse.cjs');
-require('../css/parser/tokens.cjs');
-require('../css/parser/error.cjs');
-require('../css/parser/strings.cjs');
-require('../css/parser/text.cjs');
-require('../css/parser/export.cjs');
-require('../css/parser/tree.cjs');
-require('../svg/parse.cjs');
-require('./attribs.cjs');
-require('../svg/data/attributes.cjs');
-require('../svg/analyse.cjs');
-require('../svg/analyse/error.cjs');
-
-function detectIconSetPalette(iconSet) {
-  let palette;
-  iconSet.forEachSync(
-    (name) => {
-      if (palette === null) {
-        return;
-      }
-      const svg = iconSet.toSVG(name);
-      if (!svg) {
-        return;
-      }
-      let iconPalette;
-      colors_parse.parseColors(svg, {
-        callback: (attr, colorStr, color) => {
-          if (!color) {
-            iconPalette = null;
-            return colorStr;
-          }
-          if (iconPalette === null || colors_parse.isEmptyColor(color)) {
-            return color;
-          }
-          const isColor = color.type !== "current";
-          if (iconPalette === void 0) {
-            iconPalette = isColor;
-            return color;
-          }
-          if (iconPalette !== isColor) {
-            iconPalette = null;
-          }
-          return color;
-        }
-      });
-      if (iconPalette === void 0) {
-        iconPalette = null;
-      }
-      if (palette === void 0) {
-        palette = iconPalette;
-      } else if (palette !== iconPalette) {
-        palette = null;
-      }
-    },
-    ["icon"]
-  );
-  return palette ?? null;
-}
-
-exports.detectIconSetPalette = detectIconSetPalette;

package/lib/colors/detect.d.cts

@@ -1,16 +0,0 @@
-import { IconSet } from '../icon-set/index.cjs';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '../icon-set/types.cjs';
-import '../svg/index.cjs';
-import 'cheerio';
-import '@iconify/utils/lib/icon-set/tree';
-
-/**
- * Detect palette
- *
- * Returns null if icon set has mixed colors
- */
-declare function detectIconSetPalette(iconSet: IconSet): boolean | null;
-
-export { detectIconSetPalette };

package/lib/colors/detect.d.mts

@@ -1,16 +0,0 @@
-import { IconSet } from '../icon-set/index.mjs';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '../icon-set/types.mjs';
-import '../svg/index.mjs';
-import 'cheerio';
-import '@iconify/utils/lib/icon-set/tree';
-
-/**
- * Detect palette
- *
- * Returns null if icon set has mixed colors
- */
-declare function detectIconSetPalette(iconSet: IconSet): boolean | null;
-
-export { detectIconSetPalette };

package/lib/colors/detect.mjs

@@ -1,64 +0,0 @@
-import { parseColors, isEmptyColor } from './parse.mjs';
-import '@iconify/utils/lib/colors';
-import '../svg/data/tags.mjs';
-import '../svg/parse-style.mjs';
-import '../css/parse.mjs';
-import '../css/parser/tokens.mjs';
-import '../css/parser/error.mjs';
-import '../css/parser/strings.mjs';
-import '../css/parser/text.mjs';
-import '../css/parser/export.mjs';
-import '../css/parser/tree.mjs';
-import '../svg/parse.mjs';
-import './attribs.mjs';
-import '../svg/data/attributes.mjs';
-import '../svg/analyse.mjs';
-import '../svg/analyse/error.mjs';
-
-function detectIconSetPalette(iconSet) {
-  let palette;
-  iconSet.forEachSync(
-    (name) => {
-      if (palette === null) {
-        return;
-      }
-      const svg = iconSet.toSVG(name);
-      if (!svg) {
-        return;
-      }
-      let iconPalette;
-      parseColors(svg, {
-        callback: (attr, colorStr, color) => {
-          if (!color) {
-            iconPalette = null;
-            return colorStr;
-          }
-          if (iconPalette === null || isEmptyColor(color)) {
-            return color;
-          }
-          const isColor = color.type !== "current";
-          if (iconPalette === void 0) {
-            iconPalette = isColor;
-            return color;
-          }
-          if (iconPalette !== isColor) {
-            iconPalette = null;
-          }
-          return color;
-        }
-      });
-      if (iconPalette === void 0) {
-        iconPalette = null;
-      }
-      if (palette === void 0) {
-        palette = iconPalette;
-      } else if (palette !== iconPalette) {
-        palette = null;
-      }
-    },
-    ["icon"]
-  );
-  return palette ?? null;
-}
-
-export { detectIconSetPalette };

package/lib/colors/parse.cjs

@@ -1,300 +0,0 @@
-'use strict';
-
-const colors = require('@iconify/utils/lib/colors');
-const svg_data_tags = require('../svg/data/tags.cjs');
-const svg_parseStyle = require('../svg/parse-style.cjs');
-const colors_attribs = require('./attribs.cjs');
-const svg_data_attributes = require('../svg/data/attributes.cjs');
-const svg_analyse = require('../svg/analyse.cjs');
-require('../css/parse.cjs');
-require('../css/parser/tokens.cjs');
-require('../css/parser/error.cjs');
-require('../css/parser/strings.cjs');
-require('../css/parser/text.cjs');
-require('../css/parser/export.cjs');
-require('../css/parser/tree.cjs');
-require('../svg/parse.cjs');
-require('../svg/analyse/error.cjs');
-
-const propsToCheck = Object.keys(colors_attribs.defaultColorValues);
-const animatePropsToCheck = ["from", "to", "values"];
-function parseColors(svg, options = {}) {
-  const result = {
-    colors: [],
-    hasUnsetColor: false,
-    hasGlobalStyle: false
-  };
-  const defaultColor = typeof options.defaultColor === "string" ? colors.stringToColor(options.defaultColor) : options.defaultColor;
-  function findColor(color, add = false) {
-    const isString = typeof color === "string";
-    for (let i = 0; i < result.colors.length; i++) {
-      const item = result.colors[i];
-      if (item === color) {
-        return item;
-      }
-      if (!isString && typeof item !== "string" && colors.compareColors(item, color)) {
-        return item;
-      }
-    }
-    if (add) {
-      result.colors.push(color);
-      return color;
-    }
-    return null;
-  }
-  function addColorToItem(prop, color, item, add = true) {
-    const addedColor = findColor(color, add !== false);
-    if (item) {
-      const itemColors = item._colors || (item._colors = {});
-      itemColors[prop] = addedColor === null ? color : addedColor;
-    }
-  }
-  function getElementColor(prop, item, elements2) {
-    function find(prop2) {
-      let currentItem = item;
-      const allowDefaultColor = colors_attribs.allowDefaultColorValue[prop2];
-      while (currentItem) {
-        const element = elements2.get(
-          currentItem.index
-        );
-        const color = element._colors?.[prop2];
-        if (color !== void 0) {
-          return color;
-        }
-        if (allowDefaultColor) {
-          if (allowDefaultColor === true || element.attribs[allowDefaultColor]) {
-            return null;
-          }
-        }
-        currentItem = currentItem.parent;
-        if (currentItem?.usedAsMask) {
-          return colors_attribs.defaultColorValues[prop2];
-        }
-      }
-      return colors_attribs.defaultColorValues[prop2];
-    }
-    let propColor = find(prop);
-    if (propColor !== null && typeof propColor === "object" && propColor.type === "current" && prop !== "color") {
-      propColor = find("color");
-    }
-    return propColor;
-  }
-  function checkColor(prop, value, item) {
-    switch (value.trim().toLowerCase()) {
-      case "":
-      case "inherit":
-        return;
-    }
-    const parsedColor = colors.stringToColor(value);
-    const defaultValue = parsedColor || value;
-    if (parsedColor?.type === "function" && parsedColor.func === "url") {
-      addColorToItem(prop, defaultValue, item, false);
-      return value;
-    }
-    if (!options.callback) {
-      addColorToItem(prop, defaultValue, item);
-      return value;
-    }
-    const callbackResult = options.callback(
-      prop,
-      value,
-      parsedColor,
-      item?.tagName,
-      item
-    );
-    if (callbackResult instanceof Promise) {
-      throw new Error("parseColors does not support async callbacks");
-    }
-    switch (callbackResult) {
-      case "remove": {
-        return item ? callbackResult : void 0;
-      }
-      case "unset":
-        return;
-    }
-    if (callbackResult === value || parsedColor && callbackResult === parsedColor) {
-      addColorToItem(prop, defaultValue, item);
-      return value;
-    }
-    if (typeof callbackResult === "string") {
-      const newColor = colors.stringToColor(callbackResult);
-      addColorToItem(prop, newColor || callbackResult, item);
-      return callbackResult;
-    }
-    const newValue = colors.colorToString(callbackResult);
-    addColorToItem(prop, callbackResult, item);
-    return newValue;
-  }
-  svg_parseStyle.parseSVGStyle(svg, (item) => {
-    const prop = item.prop;
-    const value = item.value;
-    if (!propsToCheck.includes(prop)) {
-      return value;
-    }
-    const attr = prop;
-    const newValue = checkColor(attr, value);
-    if (newValue === void 0) {
-      return newValue;
-    }
-    if (item.type === "global") {
-      result.hasGlobalStyle = true;
-    }
-    return newValue;
-  });
-  const iconData = svg_analyse.analyseSVGStructure(svg, options);
-  const { elements, tree } = iconData;
-  const cheerio = svg.$svg;
-  const removedElements = /* @__PURE__ */ new Set();
-  const parsedElements = /* @__PURE__ */ new Set();
-  function removeElement(index, element) {
-    function removeChildren(element2) {
-      element2.children.forEach((item) => {
-        if (item.type !== "tag") {
-          return;
-        }
-        const element3 = item;
-        const index2 = element3._index;
-        if (index2 && !removedElements.has(index2)) {
-          element3._removed = true;
-          removedElements.add(index2);
-          removeChildren(element3);
-        }
-      });
-    }
-    element._removed = true;
-    removedElements.add(index);
-    removeChildren(element);
-    cheerio(element).remove();
-  }
-  function parseTreeItem(item) {
-    const index = item.index;
-    if (removedElements.has(index) || parsedElements.has(index)) {
-      return;
-    }
-    parsedElements.add(index);
-    const element = elements.get(index);
-    if (element._removed) {
-      return;
-    }
-    const { tagName, attribs } = element;
-    if (item.parent) {
-      const parentIndex = item.parent.index;
-      const parentElement = elements.get(
-        parentIndex
-      );
-      if (parentElement._colors) {
-        element._colors = {
-          ...parentElement._colors
-        };
-      }
-    }
-    for (let i = 0; i < propsToCheck.length; i++) {
-      const prop = propsToCheck[i];
-      if (prop === "fill" && svg_data_tags.animateTags.has(tagName)) {
-        continue;
-      }
-      const value = attribs[prop];
-      if (value !== void 0) {
-        const newValue = checkColor(prop, value, element);
-        if (newValue !== value) {
-          if (newValue === void 0) {
-            cheerio(element).removeAttr(prop);
-            if (element._colors) {
-              delete element._colors[prop];
-            }
-          } else if (newValue === "remove") {
-            removeElement(index, element);
-            return;
-          } else {
-            cheerio(element).attr(prop, newValue);
-          }
-        }
-      }
-    }
-    if (svg_data_tags.animateTags.has(tagName)) {
-      const attr = attribs.attributeName;
-      if (propsToCheck.includes(attr)) {
-        for (let i = 0; i < animatePropsToCheck.length; i++) {
-          const elementProp = animatePropsToCheck[i];
-          const fullValue = attribs[elementProp];
-          if (typeof fullValue !== "string") {
-            continue;
-          }
-          const splitValues = fullValue.split(";");
-          let updatedValues = false;
-          for (let j = 0; j < splitValues.length; j++) {
-            const value = splitValues[j];
-            if (value !== void 0) {
-              const newValue = checkColor(
-                elementProp,
-                value
-                // Do not pass third parameter
-              );
-              if (newValue !== value) {
-                updatedValues = true;
-                splitValues[j] = typeof newValue === "string" ? newValue : "";
-              }
-            }
-          }
-          if (updatedValues) {
-            cheerio(element).attr(
-              elementProp,
-              splitValues.join(";")
-            );
-          }
-        }
-      }
-    }
-    if (!result.hasGlobalStyle) {
-      let requiredProps;
-      if (svg_data_tags.shapeTags.has(tagName)) {
-        requiredProps = colors_attribs.shapeColorAttributes;
-      }
-      colors_attribs.specialColorAttributes.forEach((attr) => {
-        if (svg_data_attributes.tagSpecificPresentationalAttributes[tagName]?.has(attr)) {
-          requiredProps = [attr];
-        }
-      });
-      if (requiredProps) {
-        const itemColors = element._colors || (element._colors = {});
-        for (let i = 0; i < requiredProps.length; i++) {
-          const prop = requiredProps[i];
-          const color = getElementColor(prop, item, elements);
-          if (color === colors_attribs.defaultBlackColor) {
-            if (defaultColor) {
-              const defaultColorValue = typeof defaultColor === "function" ? defaultColor(
-                prop,
-                element,
-                item,
-                iconData
-              ) : defaultColor;
-              findColor(defaultColorValue, true);
-              cheerio(element).attr(
-                prop,
-                colors.colorToString(defaultColorValue)
-              );
-              itemColors[prop] = defaultColorValue;
-            } else {
-              result.hasUnsetColor = true;
-            }
-          }
-        }
-      }
-    }
-    for (let i = 0; i < item.children.length; i++) {
-      const childItem = item.children[i];
-      if (!childItem.usedAsMask) {
-        parseTreeItem(childItem);
-      }
-    }
-  }
-  parseTreeItem(tree);
-  return result;
-}
-function isEmptyColor(color) {
-  const type = color.type;
-  return type === "none" || type === "transparent";
-}
-
-exports.isEmptyColor = isEmptyColor;
-exports.parseColors = parseColors;

package/lib/colors/parse.d.cts

@@ -1,61 +0,0 @@
-import { Color } from '@iconify/utils/lib/colors/types';
-import { SVG } from '../svg/index.cjs';
-import { ColorAttributes } from './attribs.cjs';
-import { ElementsTreeItem, AnalyseSVGStructureResult, AnalyseSVGStructureOptions, ExtendedTagElement } from '../svg/analyse/types.cjs';
-import 'cheerio';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '../misc/cheerio.cjs';
-import 'domhandler';
-
-/**
- * Result
- */
-interface FindColorsResult {
-    colors: (Color | string)[];
-    hasUnsetColor: boolean;
-    hasGlobalStyle: boolean;
-}
-/**
- * Callback to call for each found color
- *
- * Callback should return:
- * - new color value to change color
- * - first parameter to keep old value
- * - 'unset' to delete old value
- * - 'remove' to remove shape or rule
- */
-type ParseColorsCallbackResult = Color | string | 'remove' | 'unset';
-type ParseColorsCallback = (attr: ColorAttributes, colorString: string, parsedColor: Color | null, tagName?: string, item?: ExtendedTagElementWithColors) => ParseColorsCallbackResult;
-/**
- * Callback for default color
- */
-type ParseColorOptionsDefaultColorCallback = (prop: string, item: ExtendedTagElementWithColors, treeItem: ElementsTreeItem, iconData: AnalyseSVGStructureResult) => Color;
-/**
- * Options
- */
-interface ParseColorsOptions extends AnalyseSVGStructureOptions {
-    callback?: ParseColorsCallback;
-    defaultColor?: Color | string | ParseColorOptionsDefaultColorCallback;
-}
-/**
- * Extend properties for element
- */
-type ItemColors = Partial<Record<ColorAttributes, Color | string>>;
-interface ExtendedTagElementWithColors extends ExtendedTagElement {
-    _colors?: ItemColors;
-    _removed?: boolean;
-}
-/**
- * Find colors in icon
- *
- * Clean up icon before running this function to convert style to attributes using
- * cleanupInlineStyle() or cleanupSVG(), otherwise results might be inaccurate
- */
-declare function parseColors(svg: SVG, options?: ParseColorsOptions): FindColorsResult;
-/**
- * Check if color is empty, such as 'none' or 'transparent'
- */
-declare function isEmptyColor(color: Color): boolean;
-
-export { type ExtendedTagElementWithColors, type FindColorsResult, type ParseColorOptionsDefaultColorCallback, type ParseColorsOptions, isEmptyColor, parseColors };