@iconify/tools 3.0.1 → 3.0.3

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

@@ -1,89 +0,0 @@
-/**
- * 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 cheerio.TagElement, 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 { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

package/lib/svg/analyse.d.ts

@@ -1,13 +0,0 @@
-import { SVG } from './index.js';
-import { AnalyseSVGStructureOptions, AnalyseSVGStructureResult } from './analyse/types.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Find all IDs, links, which elements use palette, which items aren't used
- *
- * Before running this function run cleanup functions to change inline style to attributes and fix attributes
- */
-declare function analyseSVGStructure(svg: SVG, options?: AnalyseSVGStructureOptions): AnalyseSVGStructureResult;
-
-export { analyseSVGStructure };

package/lib/svg/cleanup/attribs.d.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Remove useless attributes
- */
-declare function removeBadAttributes(svg: SVG): void;
-
-export { removeBadAttributes };

package/lib/svg/cleanup/bad-tags.d.ts

@@ -1,16 +0,0 @@
-import { SVG } from '../index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Options
- */
-interface CheckBadTagsOptions {
-    keepTitles?: boolean;
-}
-/**
- * Test for bag tags
- */
-declare function checkBadTags(svg: SVG, options?: CheckBadTagsOptions): void;
-
-export { CheckBadTagsOptions, checkBadTags };

package/lib/svg/cleanup/inline-style.d.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Expand inline style
- */
-declare function cleanupInlineStyle(svg: SVG): void;
-
-export { cleanupInlineStyle };

package/lib/svg/cleanup/root-style.d.ts

@@ -1,16 +0,0 @@
-import { SVG } from '../index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-interface CleanupRootStyleResult {
-    animations?: Set<string>;
-    removedAtRules?: Set<string>;
-}
-/**
- * Clean up root style
- *
- * This function removes all at-rule tokens, such as `@font-face`, `@media`
- */
-declare function cleanupRootStyle(svg: SVG): CleanupRootStyleResult;
-
-export { cleanupRootStyle };

package/lib/svg/cleanup/root-svg.d.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Clean up SVG
- */
-declare function cleanupSVGRoot(svg: SVG): void;
-
-export { cleanupSVGRoot };

package/lib/svg/cleanup/svgo-style.d.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Expand inline style
- */
-declare function convertStyleToAttrs(svg: SVG): void;
-
-export { convertStyleToAttrs };

package/lib/svg/cleanup.d.ts

@@ -1,15 +0,0 @@
-import { SVG } from './index.js';
-import { CheckBadTagsOptions } from './cleanup/bad-tags.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Options
- */
-type CleanupSVGOptions = CheckBadTagsOptions;
-/**
- * Clean up SVG before parsing/optimising it
- */
-declare function cleanupSVG(svg: SVG, options?: CleanupSVGOptions): void;
-
-export { CleanupSVGOptions, cleanupSVG };

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

@@ -1,77 +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.
- */
-/***** Attributes that are not part of tag specific stuff *****/
-/**
- * Attributes that icons should not mess with or that are irrelevant. They should be removed
- */
-declare const badAttributes: Set<string>;
-/**
- * Attributes for SVG element that should be removed
- */
-declare const junkSVGAttributes: Set<string>;
-/**
- * Attributes and styles often added by bad software to wrong tags, such as Adobe Illustrator and Inkscape
- */
-declare const badSoftwareAttributes: Set<string>;
-declare const badAttributePrefixes: Set<string>;
-/**
- * Common attributes that can exist on any element
- */
-declare const commonAttributes: Set<string>;
-declare const stylingAttributes: Set<string>;
-/**
- * Attributes that exist only on child elements of <clipPath>
- */
-declare const insideClipPathAttributes: Set<string>;
-/***** Other attributes, added to tagSpecificAttributes variable below *****/
-/**
- * Presentational attributes
- */
-declare const fillPresentationalAttributes: Set<string>;
-declare const strokePresentationalAttributes: Set<string>;
-declare const urlPresentationalAttributes: Set<string>;
-declare const visibilityPresentationalAttributes: Set<string>;
-declare const commonColorPresentationalAttributes: Set<string>;
-declare const otherPresentationalAttributes: Set<string>;
-declare const presentationalAttributes: Set<string>;
-/**
- * Markers
- *
- * Presentational attributes
- */
-declare const markerAttributes: Set<string>;
-/**
- * Shapes
- *
- * Not presentational
- */
-declare const otherShapeAttributes: Set<string>;
-/**
- * Animations
- */
-declare const animationTimingAttributes: Set<string>;
-declare const animationValueAttributes: Set<string>;
-declare const otherAnimationAttributes: Set<string>;
-/**
- * Gradients
- */
-declare const commonGradientAttributes: Set<string>;
-/**
- * Filters
- */
-declare const commonFeAttributes: Set<string>;
-declare const feFuncAttributes: Set<string>;
-/**
- * Tag specific attributes
- */
-declare const tagSpecificAnimatedAttributes: Record<string, Set<string>>;
-declare const tagSpecificPresentationalAttributes: Record<string, Set<string>>;
-declare const tagSpecificNonPresentationalAttributes: Record<string, Set<string>>;
-/**
- * Styles to keep in tags
- */
-declare const tagSpecificInlineStyles: Record<string, Set<string>>;
-
-export { animationTimingAttributes, animationValueAttributes, badAttributePrefixes, badAttributes, badSoftwareAttributes, commonAttributes, commonColorPresentationalAttributes, commonFeAttributes, commonGradientAttributes, feFuncAttributes, fillPresentationalAttributes, insideClipPathAttributes, junkSVGAttributes, markerAttributes, otherAnimationAttributes, otherPresentationalAttributes, otherShapeAttributes, presentationalAttributes, strokePresentationalAttributes, stylingAttributes, tagSpecificAnimatedAttributes, tagSpecificInlineStyles, tagSpecificNonPresentationalAttributes, tagSpecificPresentationalAttributes, urlPresentationalAttributes, visibilityPresentationalAttributes };

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

@@ -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/index.d.ts

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

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

@@ -1,36 +0,0 @@
-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 };