@iconify/tools 4.2.0 → 5.0.0-beta.1

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

@@ -1,95 +0,0 @@
-/**
- * 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

@@ -1,95 +0,0 @@
-/**
- * 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.mjs

@@ -1,117 +0,0 @@
-const badTags = /* @__PURE__ */ new Set([
-  // Nasty stuff or external resource
-  "foreignObject",
-  "script",
-  "image",
-  "feImage",
-  // Deprecated
-  "animateColor",
-  "altGlyph",
-  // Text
-  "text",
-  "tspan",
-  "switch",
-  "textPath",
-  // Font
-  "font",
-  "font-face",
-  "glyph",
-  "missing-glyph",
-  "hkern",
-  "vhern",
-  // View
-  "view",
-  // Link
-  "a"
-]);
-const unsupportedTags = /* @__PURE__ */ new Set(["metadata", "desc", "title"]);
-const styleTag = /* @__PURE__ */ new Set(["style"]);
-const defsTag = /* @__PURE__ */ new Set(["defs"]);
-const maskTags = /* @__PURE__ */ new Set(["clipPath", "mask"]);
-const symbolTag = /* @__PURE__ */ new Set(["symbol"]);
-const shapeTags = /* @__PURE__ */ new Set([
-  "circle",
-  "ellipse",
-  "line",
-  "path",
-  "polygon",
-  "polyline",
-  "rect"
-]);
-const useTag = /* @__PURE__ */ new Set(["use"]);
-const groupTag = /* @__PURE__ */ new Set(["g"]);
-const markerTag = /* @__PURE__ */ new Set(["marker"]);
-const animateTags = /* @__PURE__ */ new Set([
-  "animate",
-  "animateMotion",
-  "animateTransform",
-  "discard",
-  "set"
-]);
-const animateMotionChildTags = /* @__PURE__ */ new Set(["mpath"]);
-const gradientTags = /* @__PURE__ */ new Set(["linearGradient", "radialGradient"]);
-const gradientChildTags = /* @__PURE__ */ new Set(["stop"]);
-const patternTag = /* @__PURE__ */ new Set(["pattern"]);
-const filterTag = /* @__PURE__ */ new Set(["filter"]);
-const feLightningTags = /* @__PURE__ */ new Set([
-  "feDiffuseLighting",
-  "feSpecularLighting"
-]);
-const filterChildTags = /* @__PURE__ */ new Set([
-  "feBlend",
-  "feColorMatrix",
-  "feComponentTransfer",
-  "feComposite",
-  "feConvolveMatrix",
-  "feDisplacementMap",
-  "feDropShadow",
-  "feFlood",
-  "feGaussianBlur",
-  "feMerge",
-  "feMorphology",
-  "feOffset",
-  "feTile",
-  "feTurbulence",
-  ...feLightningTags
-]);
-const feComponentTransferChildTag = /* @__PURE__ */ new Set([
-  "feFuncR",
-  "feFuncG",
-  "feFuncB",
-  "feFuncA"
-]);
-const feLightningChildTags = /* @__PURE__ */ new Set([
-  "feSpotLight",
-  "fePointLight",
-  "feDistantLight"
-]);
-const feMergeChildTags = /* @__PURE__ */ new Set(["feMergeNode"]);
-const reusableElementsWithPalette = /* @__PURE__ */ new Set([
-  ...gradientTags,
-  ...patternTag,
-  ...markerTag,
-  ...symbolTag,
-  ...filterTag
-]);
-const allValidTags = /* @__PURE__ */ new Set([
-  ...styleTag,
-  ...defsTag,
-  ...maskTags,
-  ...symbolTag,
-  ...shapeTags,
-  ...useTag,
-  ...groupTag,
-  ...markerTag,
-  ...animateTags,
-  ...animateMotionChildTags,
-  ...gradientTags,
-  ...gradientChildTags,
-  ...patternTag,
-  ...filterTag,
-  ...filterChildTags,
-  ...feComponentTransferChildTag,
-  ...feLightningChildTags,
-  ...feMergeChildTags
-]);
-
-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/index.cjs

@@ -1,178 +0,0 @@
-'use strict';
-
-const cheerio = require('cheerio');
-const utils = require('@iconify/utils');
-
-function _interopNamespaceCompat(e) {
-	if (e && typeof e === 'object' && 'default' in e) return e;
-	const n = Object.create(null);
-	if (e) {
-		for (const k in e) {
-			n[k] = e[k];
-		}
-	}
-	n.default = e;
-	return n;
-}
-
-const cheerio__namespace = /*#__PURE__*/_interopNamespaceCompat(cheerio);
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class SVG {
-  /**
-   * Constructor
-   */
-  constructor(content) {
-    // Cheerio tree, initialized in load()
-    __publicField(this, "$svg");
-    // Dimensions, initialized in load()
-    __publicField(this, "viewBox");
-    this.load(content);
-  }
-  /**
-   * Get SVG as string
-   */
-  toString(customisations) {
-    if (customisations) {
-      const data = utils.iconToSVG(this.getIcon(), customisations);
-      let svgAttributes = ' xmlns="http://www.w3.org/2000/svg"';
-      if (data.body.includes("xlink:")) {
-        svgAttributes += ' xmlns:xlink="http://www.w3.org/1999/xlink"';
-      }
-      for (const key in data.attributes) {
-        const value = data.attributes[key];
-        svgAttributes += " " + key + '="' + value + '"';
-      }
-      return "<svg" + svgAttributes + ">" + data.body + "</svg>";
-    }
-    const $root = this.$svg(":root");
-    const box = this.viewBox;
-    if ($root.attr("viewBox") === void 0) {
-      $root.attr(
-        "viewBox",
-        `${box.left} ${box.top} ${box.width} ${box.height}`
-      );
-    }
-    if ($root.attr("width") === void 0) {
-      $root.attr("width", box.width.toString());
-    }
-    if ($root.attr("height") === void 0) {
-      $root.attr("height", box.height.toString());
-    }
-    return this.$svg.html();
-  }
-  /**
-   * Get SVG as string without whitespaces
-   */
-  toMinifiedString(customisations) {
-    return utils.trimSVG(this.toString(customisations));
-  }
-  /**
-   * Get SVG as string with whitespaces
-   */
-  toPrettyString(customisations) {
-    const str = this.toMinifiedString(customisations);
-    return utils.prettifySVG(str) ?? str;
-  }
-  /**
-   * Get body
-   */
-  getBody() {
-    const $root = this.$svg(":root");
-    const attribs = $root.get(0).attribs;
-    for (const key in attribs) {
-      switch (key.split("-").shift()) {
-        case "fill":
-        case "stroke":
-        case "opacity":
-          throw new Error(
-            `Cannot use getBody() on icon that was not cleaned up with cleanupSVGRoot(). Icon has attribute ${key}="${attribs[key]}"`
-          );
-      }
-    }
-    return utils.trimSVG(this.$svg("svg").html());
-  }
-  /**
-   * Get icon as IconifyIcon
-   */
-  getIcon() {
-    const props = this.viewBox;
-    const body = this.getBody();
-    return {
-      ...props,
-      body
-    };
-  }
-  /**
-   * Load SVG
-   *
-   * @param {string} content
-   */
-  load(content) {
-    function remove(str1, str2, append) {
-      let start = 0;
-      while ((start = content.indexOf(str1, start)) !== -1) {
-        const end = content.indexOf(str2, start + str1.length);
-        if (end === -1) {
-          return;
-        }
-        content = content.slice(0, start) + append + content.slice(end + str2.length);
-        start = start + append.length;
-      }
-    }
-    remove("<!--", "-->", "");
-    remove("<?xml", "?>", "");
-    remove("<!DOCTYPE svg", "<svg", "<svg");
-    remove(
-      'xmlns:x="&ns_extend;" xmlns:i="&ns_ai;" xmlns:graph="&ns_graphs;"',
-      "",
-      ""
-    );
-    remove('xml:space="preserve"', "", "");
-    content = content.replace(/<g>\s*<\/g>/g, "");
-    this.$svg = cheerio__namespace.load(content.trim(), {
-      // @ts-expect-error Legacy attribute, kept because Cheerio types are a unstable
-      lowerCaseAttributeNames: false,
-      xmlMode: true
-    });
-    const $root = this.$svg(":root");
-    if ($root.length > 1 || $root.get(0).tagName !== "svg") {
-      throw new Error("Invalid SVG file: bad root tag");
-    }
-    const viewBox = $root.attr("viewBox");
-    if (viewBox !== void 0) {
-      const list = viewBox.split(" ");
-      this.viewBox = {
-        left: parseFloat(list[0]),
-        top: parseFloat(list[1]),
-        width: parseFloat(list[2]),
-        height: parseFloat(list[3])
-      };
-    } else {
-      const width = $root.attr("width");
-      const height = $root.attr("height");
-      if (!width || !height) {
-        throw new Error("Invalid SVG file: missing dimensions");
-      }
-      this.viewBox = {
-        left: 0,
-        top: 0,
-        width: parseFloat(width),
-        height: parseFloat(height)
-      };
-    }
-    Object.keys(this.viewBox).forEach((key) => {
-      const attr = key;
-      if (isNaN(this.viewBox[attr])) {
-        throw new Error(`Invalid SVG file: invalid ${attr}`);
-      }
-    });
-  }
-}
-
-exports.SVG = SVG;

package/lib/svg/index.d.cts

@@ -1,52 +0,0 @@
-import * as cheerio from 'cheerio';
-import { IconifyIcon } from '@iconify/types';
-export { IconifyIcon } from '@iconify/types';
-import { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
-export { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
-
-interface ViewBox {
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-}
-
-/**
- * SVG class, used to manipulate icon content.
- */
-declare class SVG {
-    $svg: cheerio.CheerioAPI;
-    viewBox: ViewBox;
-    /**
-     * Constructor
-     */
-    constructor(content: string);
-    /**
-     * Get SVG as string
-     */
-    toString(customisations?: IconifyIconCustomisations): string;
-    /**
-     * Get SVG as string without whitespaces
-     */
-    toMinifiedString(customisations?: IconifyIconCustomisations): string;
-    /**
-     * Get SVG as string with whitespaces
-     */
-    toPrettyString(customisations?: IconifyIconCustomisations): string;
-    /**
-     * Get body
-     */
-    getBody(): string;
-    /**
-     * Get icon as IconifyIcon
-     */
-    getIcon(): IconifyIcon;
-    /**
-     * Load SVG
-     *
-     * @param {string} content
-     */
-    load(content: string): void;
-}
-
-export { SVG, type ViewBox };

package/lib/svg/index.d.mts

@@ -1,52 +0,0 @@
-import * as cheerio from 'cheerio';
-import { IconifyIcon } from '@iconify/types';
-export { IconifyIcon } from '@iconify/types';
-import { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
-export { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
-
-interface ViewBox {
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-}
-
-/**
- * SVG class, used to manipulate icon content.
- */
-declare class SVG {
-    $svg: cheerio.CheerioAPI;
-    viewBox: ViewBox;
-    /**
-     * Constructor
-     */
-    constructor(content: string);
-    /**
-     * Get SVG as string
-     */
-    toString(customisations?: IconifyIconCustomisations): string;
-    /**
-     * Get SVG as string without whitespaces
-     */
-    toMinifiedString(customisations?: IconifyIconCustomisations): string;
-    /**
-     * Get SVG as string with whitespaces
-     */
-    toPrettyString(customisations?: IconifyIconCustomisations): string;
-    /**
-     * Get body
-     */
-    getBody(): string;
-    /**
-     * Get icon as IconifyIcon
-     */
-    getIcon(): IconifyIcon;
-    /**
-     * Load SVG
-     *
-     * @param {string} content
-     */
-    load(content: string): void;
-}
-
-export { SVG, type ViewBox };