@iconify/tools 3.0.3 → 3.0.4

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

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

@@ -0,0 +1,47 @@
+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.Root;
+    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 body
+     */
+    getBody(): string;
+    /**
+     * Get icon as IconifyIcon
+     */
+    getIcon(): IconifyIcon;
+    /**
+     * Load SVG
+     *
+     * @param {string} content
+     */
+    load(content: string): void;
+}
+
+export { SVG, ViewBox };

package/lib/svg/parse-style.d.ts

@@ -0,0 +1,63 @@
+import { SVG } from './index.js';
+import { CSSRuleToken, CSSToken, CSSAtRuleToken } from '../css/parser/types.js';
+import { ParseSVGCallbackItem } from './parse.js';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../misc/cheerio.js';
+
+/**
+ * Item in callback
+ */
+interface ParseSVGStyleCallbackItemCommon {
+    prop: string;
+    value: string;
+}
+interface ParseSVGStyleCallbackItemInline extends ParseSVGStyleCallbackItemCommon {
+    type: 'inline';
+    item: ParseSVGCallbackItem;
+}
+interface ParseSVGStyleCallbackItemGlobal extends ParseSVGStyleCallbackItemCommon {
+    type: 'global';
+    token: CSSRuleToken;
+    selectors: string[];
+    selectorTokens: CSSToken[];
+    prevTokens: (CSSToken | null)[];
+    nextTokens: CSSToken[];
+}
+interface ParseSVGStyleCallbackItemGlobalAtRule extends ParseSVGStyleCallbackItemCommon {
+    token: CSSAtRuleToken;
+    childTokens: CSSToken[];
+    prevTokens: (CSSToken | null)[];
+    nextTokens: CSSToken[];
+}
+interface ParseSVGStyleCallbackItemGlobalGenericAtRule extends ParseSVGStyleCallbackItemGlobalAtRule {
+    type: 'at-rule';
+}
+interface ParseSVGStyleCallbackItemGlobalKeyframesAtRule extends ParseSVGStyleCallbackItemGlobalAtRule {
+    type: 'keyframes';
+    from: Record<string, string>;
+}
+type ParseSVGStyleCallbackItem = ParseSVGStyleCallbackItemInline | ParseSVGStyleCallbackItemGlobal | ParseSVGStyleCallbackItemGlobalGenericAtRule | ParseSVGStyleCallbackItemGlobalKeyframesAtRule;
+/**
+ * Result: undefined to remove item, string to change/keep item
+ */
+type ParseSVGStyleCallbackResult = string | undefined;
+/**
+ * Callback function
+ */
+type ParseSVGStyleCallback = (item: ParseSVGStyleCallbackItem) => ParseSVGStyleCallbackResult | Promise<ParseSVGStyleCallbackResult>;
+type ParseSVGStyleCallbackSync = (item: ParseSVGStyleCallbackItem) => ParseSVGStyleCallbackResult;
+/**
+ * Parse styles in SVG
+ *
+ * This function finds CSS in SVG, parses it, calls callback for each rule.
+ * Callback should return new value (string) or undefined to remove rule.
+ * Callback can be asynchronous.
+ */
+declare function parseSVGStyle(svg: SVG, callback: ParseSVGStyleCallback): Promise<void>;
+/**
+ * Synchronous version
+ */
+declare function parseSVGStyleSync(svg: SVG, callback: ParseSVGStyleCallbackSync): void;
+
+export { ParseSVGStyleCallback, ParseSVGStyleCallbackItem, ParseSVGStyleCallbackResult, ParseSVGStyleCallbackSync, parseSVGStyle, parseSVGStyleSync };

package/lib/svg/parse.d.ts

@@ -0,0 +1,36 @@
+import { CheerioElement, WrappedCheerioElement } from '../misc/cheerio.js';
+import { SVG } from './index.js';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Item in callback
+ */
+interface ParseSVGCallbackItem {
+    tagName: string;
+    element: CheerioElement;
+    $element: WrappedCheerioElement;
+    svg: SVG;
+    parents: ParseSVGCallbackItem[];
+    testChildren: boolean;
+    removeNode: boolean;
+}
+/**
+ * Callback function
+ */
+type Callback<T> = (item: ParseSVGCallbackItem) => T;
+type ParseSVGCallback = Callback<void | Promise<void>>;
+type ParseSVGCallbackSync = Callback<void>;
+/**
+ * Parse SVG
+ *
+ * This function finds all elements in SVG and calls callback for each element.
+ * Callback can be asynchronous.
+ */
+declare function parseSVG(svg: SVG, callback: ParseSVGCallback): Promise<void>;
+/**
+ * Sync version
+ */
+declare function parseSVGSync(svg: SVG, callback: ParseSVGCallbackSync): void;
+
+export { ParseSVGCallback, ParseSVGCallbackItem, ParseSVGCallbackSync, parseSVG, parseSVGSync };