@iconify/tools 4.0.0-beta.9 → 4.0.0

package/lib/optimise/global-style.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Expand global style
+ */
+declare function cleanupGlobalStyle(svg: SVG): void;
+
+export { cleanupGlobalStyle };

package/lib/optimise/mask.d.cts

@@ -0,0 +1,24 @@
+import { Color } from '@iconify/utils/lib/colors/types';
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+type ColorCallback = (value: string, color: Color | null) => boolean;
+type ColorCheck = string | string[] | ColorCallback;
+interface SVGToMaskOptions {
+    color?: string;
+    solid?: ColorCheck;
+    transparent?: ColorCheck;
+    custom?: (value: string, color: Color | null) => string | number | undefined;
+    force?: boolean;
+    id?: string;
+}
+/**
+ * Converts SVG to mask
+ *
+ * Fixes badly designed icons, which use white shape where icon supposed to be transparent
+ */
+declare function convertSVGToMask(svg: SVG, options?: SVGToMaskOptions): boolean;
+
+export { convertSVGToMask };

package/lib/optimise/mask.d.mts

@@ -0,0 +1,24 @@
+import { Color } from '@iconify/utils/lib/colors/types';
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+type ColorCallback = (value: string, color: Color | null) => boolean;
+type ColorCheck = string | string[] | ColorCallback;
+interface SVGToMaskOptions {
+    color?: string;
+    solid?: ColorCheck;
+    transparent?: ColorCheck;
+    custom?: (value: string, color: Color | null) => string | number | undefined;
+    force?: boolean;
+    id?: string;
+}
+/**
+ * Converts SVG to mask
+ *
+ * Fixes badly designed icons, which use white shape where icon supposed to be transparent
+ */
+declare function convertSVGToMask(svg: SVG, options?: SVGToMaskOptions): boolean;
+
+export { convertSVGToMask };

package/lib/optimise/origin.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Reset origin to 0 0
+ */
+declare function resetSVGOrigin(svg: SVG): void;
+
+export { resetSVGOrigin };

package/lib/optimise/origin.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Reset origin to 0 0
+ */
+declare function resetSVGOrigin(svg: SVG): void;
+
+export { resetSVGOrigin };

package/lib/optimise/scale.d.cts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Scale icon
+ */
+declare function scaleSVG(svg: SVG, scale: number): void;
+
+export { scaleSVG };

package/lib/optimise/scale.d.mts

@@ -0,0 +1,11 @@
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+/**
+ * Scale icon
+ */
+declare function scaleSVG(svg: SVG, scale: number): void;
+
+export { scaleSVG };

package/lib/optimise/svgo.d.cts

@@ -0,0 +1,37 @@
+import { PluginConfig } from 'svgo';
+import { SVG } from '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+interface CleanupIDsOption {
+    cleanupIDs?: string | ((id: string) => string) | false;
+}
+interface GetSVGOPluginOptions extends CleanupIDsOption {
+    animated?: boolean;
+    keepShapes?: boolean;
+}
+/**
+ * Get list of plugins
+ */
+declare function getSVGOPlugins(options: GetSVGOPluginOptions): PluginConfig[];
+/**
+ * Options
+ */
+interface SVGOCommonOptions {
+    multipass?: boolean;
+}
+interface SVGOOptionsWithPlugin extends SVGOCommonOptions {
+    plugins: PluginConfig[];
+}
+interface SVGOptionsWithoutPlugin extends SVGOCommonOptions, CleanupIDsOption {
+    plugins?: undefined;
+    keepShapes?: boolean;
+}
+type SVGOOptions = SVGOOptionsWithPlugin | SVGOptionsWithoutPlugin;
+/**
+ * Run SVGO on icon
+ */
+declare function runSVGO(svg: SVG, options?: SVGOOptions): void;
+
+export { getSVGOPlugins, runSVGO };

package/lib/optimise/svgo.d.mts

@@ -0,0 +1,37 @@
+import { PluginConfig } from 'svgo';
+import { SVG } from '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+
+interface CleanupIDsOption {
+    cleanupIDs?: string | ((id: string) => string) | false;
+}
+interface GetSVGOPluginOptions extends CleanupIDsOption {
+    animated?: boolean;
+    keepShapes?: boolean;
+}
+/**
+ * Get list of plugins
+ */
+declare function getSVGOPlugins(options: GetSVGOPluginOptions): PluginConfig[];
+/**
+ * Options
+ */
+interface SVGOCommonOptions {
+    multipass?: boolean;
+}
+interface SVGOOptionsWithPlugin extends SVGOCommonOptions {
+    plugins: PluginConfig[];
+}
+interface SVGOptionsWithoutPlugin extends SVGOCommonOptions, CleanupIDsOption {
+    plugins?: undefined;
+    keepShapes?: boolean;
+}
+type SVGOOptions = SVGOOptionsWithPlugin | SVGOptionsWithoutPlugin;
+/**
+ * Run SVGO on icon
+ */
+declare function runSVGO(svg: SVG, options?: SVGOOptions): void;
+
+export { getSVGOPlugins, runSVGO };

package/lib/svg/analyse/error.d.cts

@@ -0,0 +1,10 @@
+import { ExtendedTagElement } from './types.cjs';
+import '../../misc/cheerio.cjs';
+import 'cheerio';
+
+/**
+ * Get tag for error message
+ */
+declare function analyseTagError(element: ExtendedTagElement): string;
+
+export { analyseTagError };

package/lib/svg/analyse/error.d.mts

@@ -0,0 +1,10 @@
+import { ExtendedTagElement } from './types.mjs';
+import '../../misc/cheerio.mjs';
+import 'cheerio';
+
+/**
+ * Get tag for error message
+ */
+declare function analyseTagError(element: ExtendedTagElement): string;
+
+export { analyseTagError };

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

@@ -0,0 +1,92 @@
+import { CheerioElement } from '../../misc/cheerio.cjs';
+import 'cheerio';
+
+/**
+ * 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 CheerioElement, 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 type { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

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

@@ -0,0 +1,92 @@
+import { CheerioElement } from '../../misc/cheerio.mjs';
+import 'cheerio';
+
+/**
+ * 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 CheerioElement, 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 type { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

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

@@ -89,4 +89,4 @@ interface AnalyseSVGStructureResult {
     tree: ElementsTreeItem;
 }
 
-export { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };
+export type { AnalyseSVGStructureOptions, AnalyseSVGStructureResult, ElementWithID, ElementsMap, ElementsTreeItem, ExtendedRootTagElement, ExtendedTagElement, ExtendedTagElementUses, LinkToElementWithID };

package/lib/svg/analyse.d.cts

@@ -0,0 +1,15 @@
+import { SVG } from './index.cjs';
+import { AnalyseSVGStructureOptions, AnalyseSVGStructureResult } from './analyse/types.cjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../misc/cheerio.cjs';
+
+/**
+ * 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/analyse.d.mts

@@ -0,0 +1,15 @@
+import { SVG } from './index.mjs';
+import { AnalyseSVGStructureOptions, AnalyseSVGStructureResult } from './analyse/types.mjs';
+import 'cheerio';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../misc/cheerio.mjs';
+
+/**
+ * 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.cts

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

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

@@ -0,0 +1,11 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+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.cts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.cjs';
+import 'cheerio';
+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 { type CheckBadTagsOptions, checkBadTags };

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

@@ -0,0 +1,17 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+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 { type CheckBadTagsOptions, checkBadTags };

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

@@ -14,4 +14,4 @@ interface CheckBadTagsOptions {
  */
 declare function checkBadTags(svg: SVG, options?: CheckBadTagsOptions): void;
 
-export { CheckBadTagsOptions, checkBadTags };
+export { type CheckBadTagsOptions, checkBadTags };

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

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

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

@@ -0,0 +1,11 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+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.cts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.cjs';
+import 'cheerio';
+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-style.d.mts

@@ -0,0 +1,17 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+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.cts

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

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

@@ -0,0 +1,11 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+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.cts

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

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

@@ -0,0 +1,11 @@
+import { SVG } from '../index.mjs';
+import 'cheerio';
+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.cts

@@ -0,0 +1,16 @@
+import { SVG } from './index.cjs';
+import { CheckBadTagsOptions } from './cleanup/bad-tags.cjs';
+import 'cheerio';
+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 { type CleanupSVGOptions, cleanupSVG };

package/lib/svg/cleanup.d.mts

@@ -0,0 +1,16 @@
+import { SVG } from './index.mjs';
+import { CheckBadTagsOptions } from './cleanup/bad-tags.mjs';
+import 'cheerio';
+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 { type CleanupSVGOptions, cleanupSVG };

package/lib/svg/cleanup.d.ts

@@ -13,4 +13,4 @@ type CleanupSVGOptions = CheckBadTagsOptions;
  */
 declare function cleanupSVG(svg: SVG, options?: CleanupSVGOptions): void;
 
-export { CleanupSVGOptions, cleanupSVG };
+export { type CleanupSVGOptions, cleanupSVG };