@iconify/tools 4.0.0-dev.1 → 4.0.0

package/lib/download/npm/types.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Package options
+ */
+interface NPMPackageOptions {
+    package: string;
+    tag?: string;
+}
+
+export type { NPMPackageOptions };

package/lib/download/npm/types.d.ts

@@ -6,4 +6,4 @@ interface NPMPackageOptions {
     tag?: string;
 }
 
-export { NPMPackageOptions };
+export type { NPMPackageOptions };

package/lib/download/npm/version.d.cts

@@ -0,0 +1,16 @@
+import { NPMPackageOptions } from './types.cjs';
+
+interface GetNPMVersionResult {
+    version: string;
+    file?: string;
+}
+/**
+ * Get version of package from NPM registry
+ */
+declare function getNPMVersion(options: NPMPackageOptions): Promise<GetNPMVersionResult>;
+/**
+ * Get version of package from filename
+ */
+declare function getPackageVersion(target: string): Promise<string>;
+
+export { type GetNPMVersionResult, getNPMVersion, getPackageVersion };

package/lib/download/npm/version.d.mts

@@ -0,0 +1,16 @@
+import { NPMPackageOptions } from './types.mjs';
+
+interface GetNPMVersionResult {
+    version: string;
+    file?: string;
+}
+/**
+ * Get version of package from NPM registry
+ */
+declare function getNPMVersion(options: NPMPackageOptions): Promise<GetNPMVersionResult>;
+/**
+ * Get version of package from filename
+ */
+declare function getPackageVersion(target: string): Promise<string>;
+
+export { type GetNPMVersionResult, getNPMVersion, getPackageVersion };

package/lib/download/npm/version.d.ts

@@ -13,4 +13,4 @@ declare function getNPMVersion(options: NPMPackageOptions): Promise<GetNPMVersio
  */
 declare function getPackageVersion(target: string): Promise<string>;
 
-export { GetNPMVersionResult, getNPMVersion, getPackageVersion };
+export { type GetNPMVersionResult, getNPMVersion, getPackageVersion };

package/lib/download/types/modified.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Document wasn't modified
+ */
+type DocumentNotModified = 'not_modified';
+
+export type { DocumentNotModified };

package/lib/download/types/modified.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Document wasn't modified
+ */
+type DocumentNotModified = 'not_modified';
+
+export type { DocumentNotModified };

package/lib/download/types/modified.d.ts

@@ -3,4 +3,4 @@
  */
 type DocumentNotModified = 'not_modified';
 
-export { DocumentNotModified };
+export type { DocumentNotModified };

package/lib/download/types/sources.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Download types
+ */
+type DownloadSourceType = 'git' | 'github' | 'gitlab' | 'npm';
+/**
+ * Type in other objects
+ */
+interface DownloadSourceMixin<T extends DownloadSourceType> {
+    downloadType: T;
+}
+
+export type { DownloadSourceMixin, DownloadSourceType };

package/lib/download/types/sources.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Download types
+ */
+type DownloadSourceType = 'git' | 'github' | 'gitlab' | 'npm';
+/**
+ * Type in other objects
+ */
+interface DownloadSourceMixin<T extends DownloadSourceType> {
+    downloadType: T;
+}
+
+export type { DownloadSourceMixin, DownloadSourceType };

package/lib/download/types/sources.d.ts

@@ -9,4 +9,4 @@ interface DownloadSourceMixin<T extends DownloadSourceType> {
     downloadType: T;
 }
 
-export { DownloadSourceMixin, DownloadSourceType };
+export type { DownloadSourceMixin, DownloadSourceType };

package/lib/export/directory.d.cts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { ExportTargetOptions } from './helpers/prepare.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportToDirectoryOptions extends ExportTargetOptions {
+    autoHeight?: boolean;
+    includeAliases?: boolean;
+    includeChars?: boolean;
+    log?: boolean;
+}
+/**
+ * Export icon set to directory
+ *
+ * Returns list of stored files
+ */
+declare function exportToDirectory(iconSet: IconSet, options: ExportToDirectoryOptions): Promise<string[]>;
+
+export { type ExportToDirectoryOptions, exportToDirectory };

package/lib/export/directory.d.mts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { ExportTargetOptions } from './helpers/prepare.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportToDirectoryOptions extends ExportTargetOptions {
+    autoHeight?: boolean;
+    includeAliases?: boolean;
+    includeChars?: boolean;
+    log?: boolean;
+}
+/**
+ * Export icon set to directory
+ *
+ * Returns list of stored files
+ */
+declare function exportToDirectory(iconSet: IconSet, options: ExportToDirectoryOptions): Promise<string[]>;
+
+export { type ExportToDirectoryOptions, exportToDirectory };

package/lib/export/directory.d.ts

@@ -23,4 +23,4 @@ interface ExportToDirectoryOptions extends ExportTargetOptions {
  */
 declare function exportToDirectory(iconSet: IconSet, options: ExportToDirectoryOptions): Promise<string[]>;
 
-export { ExportToDirectoryOptions, exportToDirectory };
+export { type ExportToDirectoryOptions, exportToDirectory };

package/lib/export/helpers/custom-files.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Options
+ */
+interface ExportOptionsWithCustomFiles {
+    customFiles?: Record<string, string | Record<string, unknown> | null>;
+}
+/**
+ * Write custom files
+ */
+declare function exportCustomFiles(dir: string, options: ExportOptionsWithCustomFiles, result?: Set<string>): Promise<void>;
+
+export { type ExportOptionsWithCustomFiles, exportCustomFiles };

package/lib/export/helpers/custom-files.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Options
+ */
+interface ExportOptionsWithCustomFiles {
+    customFiles?: Record<string, string | Record<string, unknown> | null>;
+}
+/**
+ * Write custom files
+ */
+declare function exportCustomFiles(dir: string, options: ExportOptionsWithCustomFiles, result?: Set<string>): Promise<void>;
+
+export { type ExportOptionsWithCustomFiles, exportCustomFiles };

package/lib/export/helpers/custom-files.d.ts

@@ -9,4 +9,4 @@ interface ExportOptionsWithCustomFiles {
  */
 declare function exportCustomFiles(dir: string, options: ExportOptionsWithCustomFiles, result?: Set<string>): Promise<void>;
 
-export { ExportOptionsWithCustomFiles, exportCustomFiles };
+export { type ExportOptionsWithCustomFiles, exportCustomFiles };

package/lib/export/helpers/prepare.d.cts

@@ -0,0 +1,19 @@
+/**
+ * Common options for all functions that export to directory
+ */
+interface ExportTargetOptions {
+    target: string;
+    cleanup?: boolean;
+}
+/**
+ * Normalize directory
+ */
+declare function normalizeDir(dir: string): string;
+/**
+ * Prepare directory for export
+ *
+ * Also normalizes directory and returns normalized value
+ */
+declare function prepareDirectoryForExport(options: ExportTargetOptions): Promise<string>;
+
+export { type ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

package/lib/export/helpers/prepare.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Common options for all functions that export to directory
+ */
+interface ExportTargetOptions {
+    target: string;
+    cleanup?: boolean;
+}
+/**
+ * Normalize directory
+ */
+declare function normalizeDir(dir: string): string;
+/**
+ * Prepare directory for export
+ *
+ * Also normalizes directory and returns normalized value
+ */
+declare function prepareDirectoryForExport(options: ExportTargetOptions): Promise<string>;
+
+export { type ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

package/lib/export/helpers/prepare.d.ts

@@ -16,4 +16,4 @@ declare function normalizeDir(dir: string): string;
  */
 declare function prepareDirectoryForExport(options: ExportTargetOptions): Promise<string>;
 
-export { ExportTargetOptions, normalizeDir, prepareDirectoryForExport };
+export { type ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

package/lib/export/helpers/types-version.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Get current version of Iconify Types package
+ */
+declare function getTypesVersion(): Promise<string>;
+
+export { getTypesVersion };

package/lib/export/helpers/types-version.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Get current version of Iconify Types package
+ */
+declare function getTypesVersion(): Promise<string>;
+
+export { getTypesVersion };

package/lib/export/icon-package.d.cts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { ExportTargetOptions } from './helpers/prepare.cjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportIconPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    module?: boolean;
+    typesContent?: string;
+}
+/**
+ * Export icon set as single icon packages
+ *
+ * Was used for exporting `@iconify-icons/{prefix}` packages
+ */
+declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
+
+export { type ExportIconPackageOptions, exportIconPackage };

package/lib/export/icon-package.d.mts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { ExportTargetOptions } from './helpers/prepare.mjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportIconPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    module?: boolean;
+    typesContent?: string;
+}
+/**
+ * Export icon set as single icon packages
+ *
+ * Was used for exporting `@iconify-icons/{prefix}` packages
+ */
+declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
+
+export { type ExportIconPackageOptions, exportIconPackage };

package/lib/export/icon-package.d.ts

@@ -19,8 +19,8 @@ interface ExportIconPackageOptions extends ExportTargetOptions, ExportOptionsWit
 /**
  * Export icon set as single icon packages
  *
- * Used for exporting `@iconify-icons/{prefix}` packages
+ * Was used for exporting `@iconify-icons/{prefix}` packages
  */
 declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
 
-export { ExportIconPackageOptions, exportIconPackage };
+export { type ExportIconPackageOptions, exportIconPackage };

package/lib/export/json-package.cjs

@@ -135,6 +135,7 @@ async function exportJSONPackage(iconSet, options) {
   );
   files.add("index.d.ts");
   await export_helpers_customFiles.exportCustomFiles(dir, options, files);
+  options.customisePackage?.(packageJSON);
   await misc_writeJson.writeJSONFile(dir + "/package.json", packageJSON);
   files.add("package.json");
   return Array.from(files);

package/lib/export/json-package.d.cts

@@ -0,0 +1,25 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { ExportTargetOptions } from './helpers/prepare.cjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    customisePackage?: (contents: Record<string, unknown>) => void;
+}
+/**
+ * Export icon set as JSON package
+ *
+ * Used for exporting `@iconify-json/{prefix}` packages
+ */
+declare function exportJSONPackage(iconSet: IconSet, options: ExportJSONPackageOptions): Promise<string[]>;
+
+export { type ExportJSONPackageOptions, exportJSONPackage };

package/lib/export/json-package.d.mts

@@ -0,0 +1,25 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { ExportTargetOptions } from './helpers/prepare.mjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    customisePackage?: (contents: Record<string, unknown>) => void;
+}
+/**
+ * Export icon set as JSON package
+ *
+ * Used for exporting `@iconify-json/{prefix}` packages
+ */
+declare function exportJSONPackage(iconSet: IconSet, options: ExportJSONPackageOptions): Promise<string[]>;
+
+export { type ExportJSONPackageOptions, exportJSONPackage };

package/lib/export/json-package.d.ts

@@ -13,6 +13,7 @@ import '@iconify/utils/lib/icon-set/tree';
  */
 interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
     package?: Record<string, unknown>;
+    customisePackage?: (contents: Record<string, unknown>) => void;
 }
 /**
  * Export icon set as JSON package
@@ -21,4 +22,4 @@ interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWit
  */
 declare function exportJSONPackage(iconSet: IconSet, options: ExportJSONPackageOptions): Promise<string[]>;
 
-export { ExportJSONPackageOptions, exportJSONPackage };
+export { type ExportJSONPackageOptions, exportJSONPackage };

package/lib/export/json-package.mjs

@@ -133,6 +133,7 @@ async function exportJSONPackage(iconSet, options) {
   );
   files.add("index.d.ts");
   await exportCustomFiles(dir, options, files);
+  options.customisePackage?.(packageJSON);
   await writeJSONFile(dir + "/package.json", packageJSON);
   files.add("package.json");
   return Array.from(files);

package/lib/icon-set/index.cjs

@@ -10,6 +10,12 @@ const utils = require('@iconify/utils');
 require('@iconify/utils/lib/misc/objects');
 require('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(
@@ -21,6 +27,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);
   }
   /**
@@ -145,10 +167,9 @@ class IconSet {
    * List icons
    */
   list(types = ["icon", "variation"]) {
-    return Object.keys(this.entries).filter((name) => {
-      const type = this.entries[name].type;
-      return types.indexOf(type) !== -1;
-    });
+    return Object.keys(this.entries).filter(
+      (name) => types.includes(this.entries[name].type)
+    );
   }
   /**
    * forEach function to loop through all entries.

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 };