@iconify/tools 4.0.0-beta.9 → 4.0.0

package/lib/icon-set/index.d.cts

@@ -0,0 +1,162 @@
+import { IconifyInfo, IconifyJSON } from '@iconify/types';
+import { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
+import { IconSetIconEntry, IconCategory, IconSetIconType, IconSetAsyncForEachCallback, IconSetSyncForEachCallback, ResolvedIconifyIcon, CommonIconProps, CheckThemeResult } from './types.cjs';
+import { SVG } from '../svg/index.cjs';
+import { ParentIconsTree } from '@iconify/utils/lib/icon-set/tree';
+import 'cheerio';
+
+/**
+ * Sort theme keys: long keys first
+ *
+ * Applies changes to parameter, but also returns it
+ */
+declare function sortThemeKeys(keys: string[]): string[];
+/**
+ * Export icon set
+ */
+declare class IconSet {
+    /**
+     * Properties. You can write directly to almost any property, but avoid writing to
+     * 'entries' and 'categories' properties, there are functions for that.
+     */
+    prefix: string;
+    lastModified: number;
+    entries: Record<string, IconSetIconEntry>;
+    info: IconifyInfo | undefined;
+    categories: Set<IconCategory>;
+    prefixes: Record<string, string>;
+    suffixes: Record<string, string>;
+    /**
+     * Load icon set
+     */
+    constructor(data: IconifyJSON);
+    /**
+     * Load icon set
+     */
+    load(data: IconifyJSON): void;
+    /**
+     * Update last modification time
+     */
+    updateLastModified(value?: number): void;
+    /**
+     * List icons
+     */
+    list(types?: IconSetIconType[]): string[];
+    /**
+     * forEach function to loop through all entries.
+     * Supports asynchronous callbacks.
+     *
+     * Callback should return false to stop loop.
+     */
+    forEach(callback: IconSetAsyncForEachCallback, types?: IconSetIconType[]): Promise<void>;
+    /**
+     * Synchronous version of forEach function to loop through all entries.
+     *
+     * Callback should return false to stop loop.
+     */
+    forEachSync(callback: IconSetSyncForEachCallback, types?: IconSetIconType[]): void;
+    /**
+     * Get parent icons tree
+     *
+     * Returns parent icons list for each icon, null if failed to resolve.
+     * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+     *
+     * Examples:
+     *   'alias3': ['alias2', 'alias1', 'icon']
+     * 	 'icon': []
+     * 	 'bad-icon': null
+     */
+    getTree(names?: string[]): ParentIconsTree;
+    /**
+     * Resolve icon
+     */
+    resolve(name: string, full: false): ResolvedIconifyIcon | null;
+    resolve(name: string): ResolvedIconifyIcon | null;
+    resolve(name: string, full: true): Required<ResolvedIconifyIcon> | null;
+    /**
+     * Generate HTML
+     */
+    toString(name: string, customisations?: IconifyIconCustomisations): string | null;
+    /**
+     * Get SVG instance for icon
+     */
+    toSVG(name: string): SVG | null;
+    /**
+     * Export icon set
+     */
+    export(validate?: boolean): IconifyJSON;
+    /**
+     * Get characters map
+     */
+    chars(names?: string[]): Record<string, string>;
+    /**
+     * Filter icons
+     */
+    _filter(callback: (name: string, item: IconSetIconEntry, icon?: ResolvedIconifyIcon) => boolean): string[];
+    /**
+     * Count icons
+     */
+    count(): number;
+    /**
+     * Find category by title
+     */
+    findCategory(title: string, add: boolean): IconCategory | null;
+    /**
+     * Count icons in category, remove category if empty
+     *
+     * Hidden icons and aliases do not count
+     */
+    listCategory(category: IconCategory | string): string[] | null;
+    /**
+     * Check if icon exists
+     */
+    exists(name: string): boolean;
+    /**
+     * Remove icons. Returns number of removed icons
+     *
+     * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+     */
+    remove(name: string, removeDependencies?: boolean | string): number;
+    /**
+     * Rename icon
+     */
+    rename(oldName: string, newName: string): boolean;
+    /**
+     * Add/update item
+     */
+    setItem(name: string, item: IconSetIconEntry): boolean;
+    /**
+     * Add/update icon
+     */
+    setIcon(name: string, icon: ResolvedIconifyIcon): boolean;
+    /**
+     * Add/update alias without props
+     */
+    setAlias(name: string, parent: string): boolean;
+    /**
+     * Add/update alias with props
+     */
+    setVariation(name: string, parent: string, props: CommonIconProps): boolean;
+    /**
+     * Icon from SVG. Updates old icon if it exists
+     */
+    fromSVG(name: string, svg: SVG): boolean;
+    /**
+     * Add or remove character for icon
+     */
+    toggleCharacter(iconName: string, char: string, add: boolean): boolean;
+    /**
+     * Add or remove category for icon
+     */
+    toggleCategory(iconName: string, category: string, add: boolean): boolean;
+    /**
+     * Find icons that belong to theme
+     */
+    checkTheme(prefix: boolean): CheckThemeResult;
+}
+/**
+ * Create blank icon set
+ */
+declare function blankIconSet(prefix: string): IconSet;
+
+export { IconSet, blankIconSet, sortThemeKeys };

package/lib/icon-set/index.d.mts

@@ -0,0 +1,162 @@
+import { IconifyInfo, IconifyJSON } from '@iconify/types';
+import { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
+import { IconSetIconEntry, IconCategory, IconSetIconType, IconSetAsyncForEachCallback, IconSetSyncForEachCallback, ResolvedIconifyIcon, CommonIconProps, CheckThemeResult } from './types.mjs';
+import { SVG } from '../svg/index.mjs';
+import { ParentIconsTree } from '@iconify/utils/lib/icon-set/tree';
+import 'cheerio';
+
+/**
+ * Sort theme keys: long keys first
+ *
+ * Applies changes to parameter, but also returns it
+ */
+declare function sortThemeKeys(keys: string[]): string[];
+/**
+ * Export icon set
+ */
+declare class IconSet {
+    /**
+     * Properties. You can write directly to almost any property, but avoid writing to
+     * 'entries' and 'categories' properties, there are functions for that.
+     */
+    prefix: string;
+    lastModified: number;
+    entries: Record<string, IconSetIconEntry>;
+    info: IconifyInfo | undefined;
+    categories: Set<IconCategory>;
+    prefixes: Record<string, string>;
+    suffixes: Record<string, string>;
+    /**
+     * Load icon set
+     */
+    constructor(data: IconifyJSON);
+    /**
+     * Load icon set
+     */
+    load(data: IconifyJSON): void;
+    /**
+     * Update last modification time
+     */
+    updateLastModified(value?: number): void;
+    /**
+     * List icons
+     */
+    list(types?: IconSetIconType[]): string[];
+    /**
+     * forEach function to loop through all entries.
+     * Supports asynchronous callbacks.
+     *
+     * Callback should return false to stop loop.
+     */
+    forEach(callback: IconSetAsyncForEachCallback, types?: IconSetIconType[]): Promise<void>;
+    /**
+     * Synchronous version of forEach function to loop through all entries.
+     *
+     * Callback should return false to stop loop.
+     */
+    forEachSync(callback: IconSetSyncForEachCallback, types?: IconSetIconType[]): void;
+    /**
+     * Get parent icons tree
+     *
+     * Returns parent icons list for each icon, null if failed to resolve.
+     * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+     *
+     * Examples:
+     *   'alias3': ['alias2', 'alias1', 'icon']
+     * 	 'icon': []
+     * 	 'bad-icon': null
+     */
+    getTree(names?: string[]): ParentIconsTree;
+    /**
+     * Resolve icon
+     */
+    resolve(name: string, full: false): ResolvedIconifyIcon | null;
+    resolve(name: string): ResolvedIconifyIcon | null;
+    resolve(name: string, full: true): Required<ResolvedIconifyIcon> | null;
+    /**
+     * Generate HTML
+     */
+    toString(name: string, customisations?: IconifyIconCustomisations): string | null;
+    /**
+     * Get SVG instance for icon
+     */
+    toSVG(name: string): SVG | null;
+    /**
+     * Export icon set
+     */
+    export(validate?: boolean): IconifyJSON;
+    /**
+     * Get characters map
+     */
+    chars(names?: string[]): Record<string, string>;
+    /**
+     * Filter icons
+     */
+    _filter(callback: (name: string, item: IconSetIconEntry, icon?: ResolvedIconifyIcon) => boolean): string[];
+    /**
+     * Count icons
+     */
+    count(): number;
+    /**
+     * Find category by title
+     */
+    findCategory(title: string, add: boolean): IconCategory | null;
+    /**
+     * Count icons in category, remove category if empty
+     *
+     * Hidden icons and aliases do not count
+     */
+    listCategory(category: IconCategory | string): string[] | null;
+    /**
+     * Check if icon exists
+     */
+    exists(name: string): boolean;
+    /**
+     * Remove icons. Returns number of removed icons
+     *
+     * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+     */
+    remove(name: string, removeDependencies?: boolean | string): number;
+    /**
+     * Rename icon
+     */
+    rename(oldName: string, newName: string): boolean;
+    /**
+     * Add/update item
+     */
+    setItem(name: string, item: IconSetIconEntry): boolean;
+    /**
+     * Add/update icon
+     */
+    setIcon(name: string, icon: ResolvedIconifyIcon): boolean;
+    /**
+     * Add/update alias without props
+     */
+    setAlias(name: string, parent: string): boolean;
+    /**
+     * Add/update alias with props
+     */
+    setVariation(name: string, parent: string, props: CommonIconProps): boolean;
+    /**
+     * Icon from SVG. Updates old icon if it exists
+     */
+    fromSVG(name: string, svg: SVG): boolean;
+    /**
+     * Add or remove character for icon
+     */
+    toggleCharacter(iconName: string, char: string, add: boolean): boolean;
+    /**
+     * Add or remove category for icon
+     */
+    toggleCategory(iconName: string, category: string, add: boolean): boolean;
+    /**
+     * Find icons that belong to theme
+     */
+    checkTheme(prefix: boolean): CheckThemeResult;
+}
+/**
+ * Create blank icon set
+ */
+declare function blankIconSet(prefix: string): IconSet;
+
+export { IconSet, blankIconSet, sortThemeKeys };

package/lib/icon-set/index.mjs

@@ -8,6 +8,12 @@ import { mergeIconData } from '@iconify/utils';
 import '@iconify/utils/lib/misc/objects';
 import '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;
+};
 const themeKeys = ["prefixes", "suffixes"];
 function sortThemeKeys(keys) {
   return keys.sort(
@@ -19,6 +25,22 @@ class IconSet {
    * Load icon set
    */
   constructor(data) {
+    /**
+     * Properties. You can write directly to almost any property, but avoid writing to
+     * 'entries' and 'categories' properties, there are functions for that.
+     */
+    // Icon set prefix
+    __publicField(this, "prefix");
+    // Last modification time
+    __publicField(this, "lastModified");
+    // All icons
+    __publicField(this, "entries");
+    // Information block
+    __publicField(this, "info");
+    // Categories, using custom type. Use functions to update data
+    __publicField(this, "categories");
+    __publicField(this, "prefixes");
+    __publicField(this, "suffixes");
     this.load(data);
   }
   /**

package/lib/icon-set/match.d.cts

@@ -0,0 +1,15 @@
+import { FullIconifyIcon } from '@iconify/utils/lib/icon/defaults';
+import { IconSet } from './index.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Find matching icon in icon set
+ */
+declare function findMatchingIcon(iconSet: IconSet, icon: FullIconifyIcon): string | null;
+
+export { findMatchingIcon };

package/lib/icon-set/match.d.mts

@@ -0,0 +1,15 @@
+import { FullIconifyIcon } from '@iconify/utils/lib/icon/defaults';
+import { IconSet } from './index.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Find matching icon in icon set
+ */
+declare function findMatchingIcon(iconSet: IconSet, icon: FullIconifyIcon): string | null;
+
+export { findMatchingIcon };

package/lib/icon-set/merge.d.cts

@@ -0,0 +1,14 @@
+import { IconSet } from './index.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Merge icon sets
+ */
+declare function mergeIconSets(oldIcons: IconSet, newIcons: IconSet): IconSet;
+
+export { mergeIconSets };

package/lib/icon-set/merge.d.mts

@@ -0,0 +1,14 @@
+import { IconSet } from './index.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Merge icon sets
+ */
+declare function mergeIconSets(oldIcons: IconSet, newIcons: IconSet): IconSet;
+
+export { mergeIconSets };

package/lib/icon-set/modified.d.cts

@@ -0,0 +1,16 @@
+import { IconSet } from './index.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Check if icons in an icon set were updated.
+ *
+ * This function checks only icons, not metadata. It also ignores icon visibility.
+ */
+declare function hasIconDataBeenModified(set1: IconSet, set2: IconSet): boolean;
+
+export { hasIconDataBeenModified };

package/lib/icon-set/modified.d.mts

@@ -0,0 +1,16 @@
+import { IconSet } from './index.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Check if icons in an icon set were updated.
+ *
+ * This function checks only icons, not metadata. It also ignores icon visibility.
+ */
+declare function hasIconDataBeenModified(set1: IconSet, set2: IconSet): boolean;
+
+export { hasIconDataBeenModified };

package/lib/icon-set/props.d.cts

@@ -0,0 +1,13 @@
+import { CommonIconProps } from './types.cjs';
+import '@iconify/types';
+
+/**
+ * Common properties for icon and alias
+ */
+declare const defaultCommonProps: Required<CommonIconProps>;
+/**
+ * Filter icon props: copies properties, removing undefined and default entries
+ */
+declare function filterProps(data: CommonIconProps, reference: CommonIconProps, compareDefaultValues: boolean): CommonIconProps;
+
+export { defaultCommonProps, filterProps };

package/lib/icon-set/props.d.mts

@@ -0,0 +1,13 @@
+import { CommonIconProps } from './types.mjs';
+import '@iconify/types';
+
+/**
+ * Common properties for icon and alias
+ */
+declare const defaultCommonProps: Required<CommonIconProps>;
+/**
+ * Filter icon props: copies properties, removing undefined and default entries
+ */
+declare function filterProps(data: CommonIconProps, reference: CommonIconProps, compareDefaultValues: boolean): CommonIconProps;
+
+export { defaultCommonProps, filterProps };

package/lib/icon-set/tags.d.cts

@@ -0,0 +1,23 @@
+import { IconSet } from './index.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+declare const paletteTags: {
+    monotone: string;
+    palette: string;
+};
+declare const sizeTags: {
+    square: string;
+    gridPrefix: string;
+    heightPrefix: string;
+};
+/**
+ * Add tags to icon set
+ */
+declare function addTagsToIconSet(iconSet: IconSet, customTags?: string[]): string[];
+
+export { addTagsToIconSet, paletteTags, sizeTags };

package/lib/icon-set/tags.d.mts

@@ -0,0 +1,23 @@
+import { IconSet } from './index.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import './types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+declare const paletteTags: {
+    monotone: string;
+    palette: string;
+};
+declare const sizeTags: {
+    square: string;
+    gridPrefix: string;
+    heightPrefix: string;
+};
+/**
+ * Add tags to icon set
+ */
+declare function addTagsToIconSet(iconSet: IconSet, customTags?: string[]): string[];
+
+export { addTagsToIconSet, paletteTags, sizeTags };

package/lib/icon-set/types.d.cts

@@ -0,0 +1,75 @@
+import { ExtendedIconifyIcon, ExtendedIconifyAlias, IconifyOptional, IconifyIcon } from '@iconify/types';
+
+/**
+ * Category item
+ */
+interface IconCategory {
+    title: string;
+    count: number;
+}
+/**
+ * Get common properties: IconifyOptional + APIIconAttributes
+ */
+type CommonProps<A, B> = {
+    [K in keyof A & keyof B]?: A[K] extends B[K] ? A[K] : never;
+};
+type CommonIconProps = CommonProps<ExtendedIconifyIcon, ExtendedIconifyAlias>;
+/**
+ * Exclude IconifyOptional from CommonIconProps
+ */
+type ExtraIconProps = Omit<CommonIconProps, keyof IconifyOptional>;
+/**
+ * Partials
+ */
+interface IconWithChars {
+    chars: Set<string>;
+}
+interface IconWithPropsData extends IconWithChars {
+    props: CommonIconProps;
+}
+interface IconWithCategories {
+    categories: Set<IconCategory>;
+}
+interface IconParentData {
+    parent: string;
+}
+/**
+ * Icon types
+ */
+interface IconSetIcon extends IconWithPropsData, IconWithCategories {
+    type: 'icon';
+    body: string;
+}
+interface IconSetIconAlias extends IconWithChars, IconParentData {
+    type: 'alias';
+}
+interface IconSetIconVariation extends IconWithPropsData, IconParentData {
+    type: 'variation';
+}
+/**
+ * All icon types
+ */
+type IconSetIconEntry = IconSetIcon | IconSetIconAlias | IconSetIconVariation;
+type IconSetIconType = IconSetIconEntry['type'];
+/**
+ * Full icon with extra stuff
+ */
+interface ResolvedIconifyIcon extends IconifyIcon, ExtraIconProps {
+}
+/**
+ * Result for checking theme: list of names for each theme
+ */
+interface CheckThemeResult {
+    valid: Record<string, string[]>;
+    invalid: string[];
+}
+/**
+ * Callback for forEach functions
+ *
+ * Return false to stop loop
+ */
+type IconSetForEachCallbackResult = void | false;
+type IconSetAsyncForEachCallback = (name: string, type: IconSetIconEntry['type']) => Promise<IconSetForEachCallbackResult> | IconSetForEachCallbackResult;
+type IconSetSyncForEachCallback = (name: string, type: IconSetIconEntry['type']) => IconSetForEachCallbackResult;
+
+export type { CheckThemeResult, CommonIconProps, ExtraIconProps, IconCategory, IconParentData, IconSetAsyncForEachCallback, IconSetIcon, IconSetIconAlias, IconSetIconEntry, IconSetIconType, IconSetIconVariation, IconSetSyncForEachCallback, IconWithCategories, IconWithChars, IconWithPropsData, ResolvedIconifyIcon };

package/lib/icon-set/types.d.mts

@@ -0,0 +1,75 @@
+import { ExtendedIconifyIcon, ExtendedIconifyAlias, IconifyOptional, IconifyIcon } from '@iconify/types';
+
+/**
+ * Category item
+ */
+interface IconCategory {
+    title: string;
+    count: number;
+}
+/**
+ * Get common properties: IconifyOptional + APIIconAttributes
+ */
+type CommonProps<A, B> = {
+    [K in keyof A & keyof B]?: A[K] extends B[K] ? A[K] : never;
+};
+type CommonIconProps = CommonProps<ExtendedIconifyIcon, ExtendedIconifyAlias>;
+/**
+ * Exclude IconifyOptional from CommonIconProps
+ */
+type ExtraIconProps = Omit<CommonIconProps, keyof IconifyOptional>;
+/**
+ * Partials
+ */
+interface IconWithChars {
+    chars: Set<string>;
+}
+interface IconWithPropsData extends IconWithChars {
+    props: CommonIconProps;
+}
+interface IconWithCategories {
+    categories: Set<IconCategory>;
+}
+interface IconParentData {
+    parent: string;
+}
+/**
+ * Icon types
+ */
+interface IconSetIcon extends IconWithPropsData, IconWithCategories {
+    type: 'icon';
+    body: string;
+}
+interface IconSetIconAlias extends IconWithChars, IconParentData {
+    type: 'alias';
+}
+interface IconSetIconVariation extends IconWithPropsData, IconParentData {
+    type: 'variation';
+}
+/**
+ * All icon types
+ */
+type IconSetIconEntry = IconSetIcon | IconSetIconAlias | IconSetIconVariation;
+type IconSetIconType = IconSetIconEntry['type'];
+/**
+ * Full icon with extra stuff
+ */
+interface ResolvedIconifyIcon extends IconifyIcon, ExtraIconProps {
+}
+/**
+ * Result for checking theme: list of names for each theme
+ */
+interface CheckThemeResult {
+    valid: Record<string, string[]>;
+    invalid: string[];
+}
+/**
+ * Callback for forEach functions
+ *
+ * Return false to stop loop
+ */
+type IconSetForEachCallbackResult = void | false;
+type IconSetAsyncForEachCallback = (name: string, type: IconSetIconEntry['type']) => Promise<IconSetForEachCallbackResult> | IconSetForEachCallbackResult;
+type IconSetSyncForEachCallback = (name: string, type: IconSetIconEntry['type']) => IconSetForEachCallbackResult;
+
+export type { CheckThemeResult, CommonIconProps, ExtraIconProps, IconCategory, IconParentData, IconSetAsyncForEachCallback, IconSetIcon, IconSetIconAlias, IconSetIconEntry, IconSetIconType, IconSetIconVariation, IconSetSyncForEachCallback, IconWithCategories, IconWithChars, IconWithPropsData, ResolvedIconifyIcon };