@iconify/tools 1.3.17 → 2.0.0-dev.2

package/lib/svg/data/attributes.mjs

@@ -0,0 +1,352 @@
+// src/svg/data/attributes.ts
+import { filterChildTags, shapeTags } from "./tags.mjs";
+var badAttributes = new Set([
+  "cursor",
+  "pointer-events",
+  "shape-rendering",
+  "tabindex",
+  "requiredExtensions",
+  "requiredFeatures",
+  "systemLanguage",
+  "role",
+  "title"
+]);
+var junkSVGAttributes = new Set([
+  "xmlns:xlink",
+  "baseProfile",
+  "contentScriptType",
+  "contentStyleType",
+  "version",
+  "x",
+  "y",
+  "zoomAndPan"
+]);
+var badSoftwareAttributes = new Set([
+  "color-interpolation-filters",
+  "isolation",
+  "enable-background",
+  "overflow",
+  "marker",
+  "white-space",
+  "direction"
+]);
+var badAttributePrefixes = new Set([
+  "image",
+  "mix",
+  "block",
+  "data",
+  "aria",
+  "text",
+  "font",
+  "letter",
+  "baseline",
+  "word",
+  "line",
+  "writing",
+  ""
+]);
+var commonAttributes = new Set(["id"]);
+var stylingAttributes = new Set(["class", "style"]);
+var insideClipPathAttributes = new Set(["clip-rule"]);
+var fillPresentationalAttributes = new Set([
+  "fill-opacity",
+  "fill-rule"
+]);
+var strokePresentationalAttributes = new Set([
+  "stroke-dasharray",
+  "stroke-dashoffset",
+  "stroke-linecap",
+  "stroke-linejoin",
+  "stroke-miterlimit",
+  "stroke-opacity",
+  "stroke-width"
+]);
+var urlPresentationalAttributes = new Set([
+  "clip-path",
+  "filter",
+  "mask"
+]);
+var visibilityPresentationalAttributes = new Set([
+  "display",
+  "opacity",
+  "visibility"
+]);
+var commonColorPresentationalAttributes = new Set([
+  "color",
+  "fill",
+  "stroke"
+]);
+var otherPresentationalAttributes = new Set([
+  "color-interpolation",
+  "color-rendering",
+  "transform",
+  "vector-effect"
+]);
+var presentationalAttributes = new Set([
+  ...fillPresentationalAttributes,
+  ...strokePresentationalAttributes,
+  ...urlPresentationalAttributes,
+  ...visibilityPresentationalAttributes,
+  ...commonColorPresentationalAttributes,
+  ...otherPresentationalAttributes
+]);
+var markerAttributes = new Set([
+  "marker-start",
+  "marker-mid",
+  "marker-end"
+]);
+var otherShapeAttributes = new Set(["pathLength"]);
+var animationTimingAttributes = new Set([
+  "begin",
+  "dur",
+  "end",
+  "min",
+  "max",
+  "restart",
+  "repeatCount",
+  "repeatDur",
+  "fill"
+]);
+var animationValueAttributes = new Set([
+  "calcMode",
+  "values",
+  "keyTimes",
+  "keySplines",
+  "from",
+  "to",
+  "by"
+]);
+var otherAnimationAttributes = new Set([
+  "attributeName",
+  "additive",
+  "accumulate"
+]);
+var commonGradientAttributes = new Set([
+  "gradientUnits",
+  "gradientTransform",
+  "href",
+  "spreadMethod"
+]);
+var commonFeAttributes = new Set([
+  "x",
+  "y",
+  "width",
+  "height",
+  "color-interpolation-filters"
+]);
+var feFuncAttributes = new Set([
+  "type",
+  "tableValues",
+  "slope",
+  "intercept",
+  "amplitude",
+  "exponent",
+  "offset",
+  ...commonFeAttributes
+]);
+var tagSpecificAnimatedAttributes = {
+  circle: new Set(["cx", "cy", "r"]),
+  ellipse: new Set(["cx", "cy", "rx", "ry"]),
+  line: new Set(["x1", "x2", "y1", "y2"]),
+  path: new Set(["d"]),
+  polygon: new Set(["points"]),
+  polyline: new Set(["points"]),
+  rect: new Set(["x", "y", "width", "height", "rx", "ry"])
+};
+var tagSpecificPresentationalAttributes = {
+  svg: new Set(["width", "height", ...presentationalAttributes]),
+  clipPath: new Set([...presentationalAttributes]),
+  defs: new Set([...presentationalAttributes]),
+  g: new Set([...presentationalAttributes]),
+  mask: new Set(["x", "y", "width", "height", ...presentationalAttributes]),
+  symbol: new Set(["x", "y", "width", "height", ...presentationalAttributes]),
+  use: new Set([
+    "x",
+    "y",
+    "width",
+    "height",
+    "refX",
+    "refY",
+    ...presentationalAttributes
+  ]),
+  marker: new Set([...presentationalAttributes]),
+  linearGradient: new Set([
+    "x1",
+    "x2",
+    "y1",
+    "y2",
+    ...presentationalAttributes
+  ]),
+  radialGradient: new Set([
+    "cx",
+    "cy",
+    "fr",
+    "fx",
+    "fy",
+    "r",
+    ...presentationalAttributes
+  ]),
+  stop: new Set(["offset", "stop-color", "stop-opacity"]),
+  feFlood: new Set(["flood-color", "flood-opacity"]),
+  feDropShadow: new Set(["flood-color", "flood-opacity"])
+};
+shapeTags.forEach((tag) => {
+  tagSpecificPresentationalAttributes[tag] = new Set([
+    ...presentationalAttributes,
+    ...markerAttributes,
+    ...tagSpecificPresentationalAttributes[tag] || []
+  ]);
+});
+filterChildTags.forEach((tag) => {
+  tagSpecificPresentationalAttributes[tag] = new Set([
+    ...commonFeAttributes,
+    ...tagSpecificPresentationalAttributes[tag] || []
+  ]);
+});
+var tagSpecificNonPresentationalAttributes = {
+  svg: new Set(["xmlns", "viewBox", "preserveAspectRatio"]),
+  clipPath: new Set(["clipPathUnits"]),
+  mask: new Set(["maskContentUnits", "maskUnits"]),
+  symbol: new Set(["viewBox", "preserveAspectRatio"]),
+  circle: new Set([...otherShapeAttributes]),
+  ellipse: new Set([...otherShapeAttributes]),
+  line: new Set([...otherShapeAttributes]),
+  path: new Set([...otherShapeAttributes]),
+  polygon: new Set([...otherShapeAttributes]),
+  polyline: new Set([...otherShapeAttributes]),
+  rect: new Set([...otherShapeAttributes]),
+  use: new Set(["href"]),
+  marker: new Set([
+    "markerHeight",
+    "markerUnits",
+    "markerWidth",
+    "orient",
+    "preserveAspectRatio",
+    "refX",
+    "refY",
+    "viewBox"
+  ]),
+  animate: new Set([
+    ...animationTimingAttributes,
+    ...animationValueAttributes,
+    ...otherAnimationAttributes
+  ]),
+  animateMotion: new Set([
+    "keyPoints",
+    "path",
+    "rotate",
+    ...animationTimingAttributes,
+    ...animationValueAttributes,
+    ...otherAnimationAttributes
+  ]),
+  animateTransform: new Set([
+    "by",
+    "from",
+    "to",
+    "type",
+    ...animationTimingAttributes,
+    ...animationValueAttributes,
+    ...otherAnimationAttributes
+  ]),
+  discard: new Set(["begin", "href"]),
+  set: new Set([
+    "to",
+    ...animationTimingAttributes,
+    ...otherAnimationAttributes
+  ]),
+  mpath: new Set(["href"]),
+  linearGradient: new Set([...commonGradientAttributes]),
+  radialGradient: new Set([...commonGradientAttributes]),
+  feSpotLight: new Set([
+    "x",
+    "y",
+    "z",
+    "pointsAtX",
+    "pointsAtY",
+    "pointsAtZ",
+    "specularExponent",
+    "limitingConeAngle"
+  ]),
+  feBlend: new Set(["in", "in2", "mode"]),
+  feColorMatrix: new Set(["in", "type", "values"]),
+  feComponentTransfer: new Set(["in"]),
+  feComposite: new Set(["in", "in2", "operator", "k1", "k2", "k3", "k4"]),
+  feConvolveMatrix: new Set([
+    "in",
+    "order",
+    "kernelMatrix",
+    "divisor",
+    "bias",
+    "targetX",
+    "targetY",
+    "edgeMode",
+    "kernelUnitLength",
+    "preserveAlpha"
+  ]),
+  feDiffuseLighting: new Set([
+    "in",
+    "surfaceScale",
+    "diffuseConstant",
+    "kernelUnitLength"
+  ]),
+  feDisplacementMap: new Set([
+    "in",
+    "in2",
+    "scale",
+    "xChannelSelector",
+    "yChannelSelector"
+  ]),
+  feDistantLight: new Set(["azimuth", "elevation"]),
+  feDropShadow: new Set(["dx", "dy", "stdDeviation"]),
+  feGaussianBlur: new Set(["in", "stdDeviation", "edgeMode"]),
+  feFuncA: feFuncAttributes,
+  feFuncR: feFuncAttributes,
+  feFuncG: feFuncAttributes,
+  feFuncB: feFuncAttributes,
+  feMergeNode: new Set(["in"]),
+  feMorphology: new Set(["in", "operator", "radius"]),
+  feOffset: new Set(["in", "dx", "dy"]),
+  fePointLight: new Set(["x", "y", "z"]),
+  feSpecularLighting: new Set([
+    "in",
+    "surfaceScale",
+    "specularConstant",
+    "specularExponent",
+    "kernelUnitLength"
+  ]),
+  feTile: new Set(["in"]),
+  feTurbulence: new Set([
+    "baseFrequency",
+    "numOctaves",
+    "seed",
+    "stitchTiles",
+    "type"
+  ])
+};
+export {
+  animationTimingAttributes,
+  animationValueAttributes,
+  badAttributePrefixes,
+  badAttributes,
+  badSoftwareAttributes,
+  commonAttributes,
+  commonColorPresentationalAttributes,
+  commonFeAttributes,
+  commonGradientAttributes,
+  feFuncAttributes,
+  fillPresentationalAttributes,
+  insideClipPathAttributes,
+  junkSVGAttributes,
+  markerAttributes,
+  otherAnimationAttributes,
+  otherPresentationalAttributes,
+  otherShapeAttributes,
+  presentationalAttributes,
+  strokePresentationalAttributes,
+  stylingAttributes,
+  tagSpecificAnimatedAttributes,
+  tagSpecificNonPresentationalAttributes,
+  tagSpecificPresentationalAttributes,
+  urlPresentationalAttributes,
+  visibilityPresentationalAttributes
+};

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

@@ -0,0 +1,89 @@
+/**
+ * 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.
+ */
+export declare const badTags: Set<string>;
+/**
+ * Deprecated or irrelevant tags
+ *
+ * Tags that are quietly removed
+ */
+export declare const unsupportedTags: Set<string>;
+/**
+ * Style
+ */
+export declare const styleTag: Set<string>;
+/**
+ * Definitions: reusable elements inside
+ */
+export declare const defsTag: Set<string>;
+/**
+ * Masks: colors are ignored, child elements must have id
+ */
+export declare const maskAndSymbolTags: Set<string>;
+/**
+ * SVG shapes
+ */
+export declare const shapeTags: Set<string>;
+/**
+ * Use
+ */
+export declare const useTag: Set<string>;
+/**
+ * Groups
+ */
+export declare const groupTag: Set<string>;
+/**
+ * Marker, must be inside <defs>
+ */
+export declare const markerTag: Set<string>;
+/**
+ * SVG animations
+ */
+export declare const animateTags: Set<string>;
+export declare const animateMotionChildTags: Set<string>;
+/**
+ * Gradients, must be inside <defs>
+ */
+export declare const gradientTags: Set<string>;
+/**
+ * Gradient color, must be inside one of gradientTags
+ */
+export declare const gradientChildTags: Set<string>;
+/**
+ * Pattern, must be inside <defs>
+ */
+export declare const patternTag: Set<string>;
+/**
+ * Filters
+ */
+export declare const filterTag: Set<string>;
+export declare const feLightningTags: Set<string>;
+export declare const filterChildTags: Set<string>;
+export declare const feComponentTransferChildTag: Set<string>;
+export declare const feLightningChildTags: Set<string>;
+export declare const feMergeChildTags: Set<string>;
+/***** Combination of tags *****/
+/**
+ * Tags that can be used only inside <defs>
+ */
+export declare const tagsInsideDefs: Set<string>;
+/**
+ * Parent tags for animations
+ */
+export declare const tagsBeforeAnimation: Set<string>;
+/**
+ * All supported tags
+ */
+export declare const allValidTags: Set<string>;

package/lib/svg/data/tags.js

@@ -0,0 +1,185 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allValidTags = exports.tagsBeforeAnimation = exports.tagsInsideDefs = exports.feMergeChildTags = exports.feLightningChildTags = exports.feComponentTransferChildTag = exports.filterChildTags = exports.feLightningTags = exports.filterTag = exports.patternTag = exports.gradientChildTags = exports.gradientTags = exports.animateMotionChildTags = exports.animateTags = exports.markerTag = exports.groupTag = exports.useTag = exports.shapeTags = exports.maskAndSymbolTags = exports.defsTag = exports.styleTag = exports.unsupportedTags = exports.badTags = void 0;
+/**
+ * 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.
+ */
+exports.badTags = 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',
+]);
+/**
+ * Deprecated or irrelevant tags
+ *
+ * Tags that are quietly removed
+ */
+exports.unsupportedTags = new Set(['metadata', 'desc', 'title']);
+/**
+ * Style
+ */
+exports.styleTag = new Set(['style']);
+/**
+ * Definitions: reusable elements inside
+ */
+exports.defsTag = new Set(['defs']);
+/**
+ * Masks: colors are ignored, child elements must have id
+ */
+exports.maskAndSymbolTags = new Set(['clipPath', 'mask', 'symbol']);
+/**
+ * SVG shapes
+ */
+exports.shapeTags = new Set([
+    'circle',
+    'ellipse',
+    'line',
+    'path',
+    'polygon',
+    'polyline',
+    'rect',
+]);
+/**
+ * Use
+ */
+exports.useTag = new Set(['use']);
+/**
+ * Groups
+ */
+exports.groupTag = new Set(['g']);
+/**
+ * Marker, must be inside <defs>
+ */
+exports.markerTag = new Set(['marker']);
+/**
+ * SVG animations
+ */
+exports.animateTags = new Set([
+    'animate',
+    'animateMotion',
+    'animateTransform',
+    'discard',
+    'set',
+]);
+exports.animateMotionChildTags = new Set(['mpath']);
+/**
+ * Gradients, must be inside <defs>
+ */
+exports.gradientTags = new Set(['linearGradient', 'radialGradient']);
+/**
+ * Gradient color, must be inside one of gradientTags
+ */
+exports.gradientChildTags = new Set(['stop']);
+/**
+ * Pattern, must be inside <defs>
+ */
+exports.patternTag = new Set(['pattern']);
+/**
+ * Filters
+ */
+exports.filterTag = new Set(['filter']);
+exports.feLightningTags = new Set([
+    'feDiffuseLighting',
+    'feSpecularLighting',
+]);
+exports.filterChildTags = new Set([
+    'feBlend',
+    'feColorMatrix',
+    'feComponentTransfer',
+    'feComposite',
+    'feConvolveMatrix',
+    'feDisplacementMap',
+    'feDropShadow',
+    'feFlood',
+    'feGaussianBlur',
+    'feMerge',
+    'feMorphology',
+    'feOffset',
+    'feTile',
+    'feTurbulence',
+    ...exports.feLightningTags,
+]);
+exports.feComponentTransferChildTag = new Set([
+    'feFuncR',
+    'feFuncG',
+    'feFuncB',
+    'feFuncA',
+]);
+exports.feLightningChildTags = new Set([
+    'feSpotLight',
+    'fePointLight',
+    'feDistantLight',
+]);
+exports.feMergeChildTags = new Set(['feMergeNode']);
+/***** Combination of tags *****/
+/**
+ * Tags that can be used only inside <defs>
+ */
+exports.tagsInsideDefs = new Set([
+    ...exports.gradientTags,
+    ...exports.patternTag,
+    ...exports.markerTag,
+]);
+/**
+ * Parent tags for animations
+ */
+exports.tagsBeforeAnimation = new Set([
+    ...exports.shapeTags,
+    ...exports.filterChildTags,
+    ...exports.feComponentTransferChildTag,
+]);
+/**
+ * All supported tags
+ */
+exports.allValidTags = new Set([
+    ...exports.styleTag,
+    ...exports.defsTag,
+    ...exports.maskAndSymbolTags,
+    ...exports.shapeTags,
+    ...exports.useTag,
+    ...exports.groupTag,
+    ...exports.markerTag,
+    ...exports.animateTags,
+    ...exports.animateMotionChildTags,
+    ...exports.gradientTags,
+    ...exports.gradientChildTags,
+    ...exports.patternTag,
+    ...exports.filterTag,
+    ...exports.filterChildTags,
+    ...exports.feComponentTransferChildTag,
+    ...exports.feLightningChildTags,
+    ...exports.feMergeChildTags,
+]);