@iconify/tools 3.0.1 → 3.0.3

package/lib/download/github/index.d.ts

@@ -1,31 +0,0 @@
-import { ExportTargetOptions } from '../../export/helpers/prepare.js';
-import { DocumentNotModified } from '../types/modified.js';
-import { GitHubAPIOptions } from './types.js';
-import { DownloadSourceMixin } from '../types/sources.js';
-
-interface IfModifiedSinceOption {
-    ifModifiedSince: string | DownloadGitHubRepoResult;
-}
-/**
- * Options for downloadGitHubRepo()
- */
-interface DownloadGitHubRepoOptions extends ExportTargetOptions, GitHubAPIOptions, Partial<IfModifiedSinceOption> {
-    cleanupOldFiles?: boolean;
-    cleanupOldDirectories?: boolean;
-    log?: boolean;
-}
-/**
- * Result
- */
-interface DownloadGitHubRepoResult extends DownloadSourceMixin<'github'> {
-    rootDir: string;
-    contentsDir: string;
-    hash: string;
-}
-/**
- * Download GitHub repo using API
- */
-declare function downloadGitHubRepo<T extends IfModifiedSinceOption & DownloadGitHubRepoOptions>(options: T): Promise<DownloadGitHubRepoResult | DocumentNotModified>;
-declare function downloadGitHubRepo(options: DownloadGitHubRepoOptions): Promise<DownloadGitHubRepoResult>;
-
-export { DownloadGitHubRepoOptions, DownloadGitHubRepoResult, downloadGitHubRepo };

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

@@ -1,11 +0,0 @@
-/**
- * API options
- */
-interface GitHubAPIOptions {
-    token: string;
-    user: string;
-    repo: string;
-    branch: string;
-}
-
-export { GitHubAPIOptions };

package/lib/download/gitlab/hash.d.ts

@@ -1,8 +0,0 @@
-import { GitLabAPIOptions } from './types.js';
-
-/**
- * Get latest hash from GitHub using API
- */
-declare function getGitLabRepoHash(options: GitLabAPIOptions): Promise<string>;
-
-export { getGitLabRepoHash };

package/lib/download/gitlab/index.d.ts

@@ -1,31 +0,0 @@
-import { ExportTargetOptions } from '../../export/helpers/prepare.js';
-import { DocumentNotModified } from '../types/modified.js';
-import { GitLabAPIOptions } from './types.js';
-import { DownloadSourceMixin } from '../types/sources.js';
-
-interface IfModifiedSinceOption {
-    ifModifiedSince: string | DownloadGitLabRepoResult;
-}
-/**
- * Options for downloadGitLabRepo()
- */
-interface DownloadGitLabRepoOptions extends ExportTargetOptions, GitLabAPIOptions, Partial<IfModifiedSinceOption> {
-    cleanupOldFiles?: boolean;
-    cleanupOldDirectories?: boolean;
-    log?: boolean;
-}
-/**
- * Result
- */
-interface DownloadGitLabRepoResult extends DownloadSourceMixin<'gitlab'> {
-    rootDir: string;
-    contentsDir: string;
-    hash: string;
-}
-/**
- * Download GitLab repo using API
- */
-declare function downloadGitLabRepo<T extends IfModifiedSinceOption & DownloadGitLabRepoOptions>(options: T): Promise<DownloadGitLabRepoResult | DocumentNotModified>;
-declare function downloadGitLabRepo(options: DownloadGitLabRepoOptions): Promise<DownloadGitLabRepoResult>;
-
-export { DownloadGitLabRepoOptions, DownloadGitLabRepoResult, downloadGitLabRepo };

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

@@ -1,15 +0,0 @@
-/**
- * API options
- */
-interface GitLabAPIOptions {
-    uri?: string;
-    token: string;
-    project: string;
-    branch: string;
-}
-/**
- * Default base URI for GitLab API
- */
-declare const defaultGitLabBaseURI = "https://gitlab.com/api/v4/projects";
-
-export { GitLabAPIOptions, defaultGitLabBaseURI };

package/lib/download/helpers/untar.d.ts

@@ -1,6 +0,0 @@
-/**
- * Unpack .tgz archive
- */
-declare function untar(file: string, path: string): Promise<void>;
-
-export { untar };

package/lib/download/helpers/unzip.d.ts

@@ -1,6 +0,0 @@
-/**
- * Unzip archive
- */
-declare function unzip(source: string, path: string): Promise<void>;
-
-export { unzip };

package/lib/download/index.d.ts

@@ -1,48 +0,0 @@
-import { DownloadGitHubRepoOptions, DownloadGitHubRepoResult } from './github/index.js';
-import { DownloadGitRepoOptions, DownloadGitRepoResult } from './git/index.js';
-import { DownloadNPMPackageOptions, DownloadNPMPackageResult } from './npm/index.js';
-import { DocumentNotModified } from './types/modified.js';
-import { DownloadSourceType, DownloadSourceMixin } from './types/sources.js';
-import { DownloadGitLabRepoOptions, DownloadGitLabRepoResult } from './gitlab/index.js';
-import '../export/helpers/prepare.js';
-import './github/types.js';
-import './gitlab/types.js';
-
-/**
- * Options and result combinations
- */
-interface DownloadGitRepo {
-    options: DownloadGitRepoOptions & DownloadSourceMixin<'git'>;
-    result: DownloadGitRepoResult;
-}
-interface DownloadGitHubRepo {
-    options: DownloadGitHubRepoOptions & DownloadSourceMixin<'github'>;
-    result: DownloadGitHubRepoResult;
-}
-interface DownloadGitLabRepo {
-    options: DownloadGitLabRepoOptions & DownloadSourceMixin<'gitlab'>;
-    result: DownloadGitLabRepoResult;
-}
-interface DownloadNPMPackage {
-    options: DownloadNPMPackageOptions & DownloadSourceMixin<'npm'>;
-    result: DownloadNPMPackageResult;
-}
-/**
- * Combinations based on type
- */
-type DownloadParamsMixin<T extends DownloadSourceType> = T extends 'git' ? DownloadGitRepo : T extends 'github' ? DownloadGitHubRepo : T extends 'gitlab' ? DownloadGitLabRepo : T extends 'npm' ? DownloadNPMPackage : never;
-/**
- * Combinations
- */
-type DownloadParams = DownloadGitRepo | DownloadGitHubRepo | DownloadGitLabRepo | DownloadNPMPackage;
-/**
- * Pick options or result from combinations
- */
-type DownloadOptions<T extends DownloadSourceType> = DownloadParamsMixin<T>['options'];
-type DownloadResult<T extends DownloadSourceType> = Promise<DocumentNotModified | DownloadParamsMixin<T>['result']>;
-declare function downloadPackage<T extends 'git'>(options: DownloadOptions<T>): DownloadResult<T>;
-declare function downloadPackage<T extends 'github'>(options: DownloadOptions<T>): DownloadResult<T>;
-declare function downloadPackage<T extends 'gitlab'>(options: DownloadOptions<T>): DownloadResult<T>;
-declare function downloadPackage<T extends 'npm'>(options: DownloadOptions<T>): DownloadResult<T>;
-
-export { DownloadParams, DownloadParamsMixin, downloadPackage };

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

@@ -1,30 +0,0 @@
-import { ExportTargetOptions } from '../../export/helpers/prepare.js';
-import { DocumentNotModified } from '../types/modified.js';
-import { DownloadSourceMixin } from '../types/sources.js';
-
-interface IfModifiedSinceOption {
-    ifModifiedSince: string | true | DownloadNPMPackageResult;
-}
-/**
- * Options for downloadNPMPackage()
- */
-interface DownloadNPMPackageOptions extends ExportTargetOptions, Partial<IfModifiedSinceOption> {
-    package: string;
-    tag?: string;
-    log?: boolean;
-}
-/**
- * Result
- */
-interface DownloadNPMPackageResult extends DownloadSourceMixin<'npm'> {
-    rootDir: string;
-    contentsDir: string;
-    version: string;
-}
-/**
- * Download NPM package
- */
-declare function downloadNPMPackage<T extends IfModifiedSinceOption & DownloadNPMPackageOptions>(options: T): Promise<DownloadNPMPackageResult | DocumentNotModified>;
-declare function downloadNPMPackage(options: DownloadNPMPackageOptions): Promise<DownloadNPMPackageResult>;
-
-export { DownloadNPMPackageOptions, DownloadNPMPackageResult, downloadNPMPackage };

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

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

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

@@ -1,16 +0,0 @@
-import { NPMPackageOptions } from './types.js';
-
-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 { GetNPMVersionResult, getNPMVersion, getPackageVersion };

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

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

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

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

package/lib/export/directory.d.ts

@@ -1,25 +0,0 @@
-import { IconSet } from '../icon-set/index.js';
-import { ExportTargetOptions } from './helpers/prepare.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '../icon-set/types.js';
-import '../svg/index.js';
-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 { ExportToDirectoryOptions, exportToDirectory };

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

@@ -1,12 +0,0 @@
-/**
- * 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 { ExportOptionsWithCustomFiles, exportCustomFiles };

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

@@ -1,19 +0,0 @@
-/**
- * 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 { ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

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

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

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

@@ -1,25 +0,0 @@
-import { IconSet } from '../icon-set/index.js';
-import { ExportTargetOptions } from './helpers/prepare.js';
-import { ExportOptionsWithCustomFiles } from './helpers/custom-files.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '../icon-set/types.js';
-import '../svg/index.js';
-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
- *
- * Used for exporting `@iconify-icons/{prefix}` packages
- */
-declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
-
-export { ExportIconPackageOptions, exportIconPackage };

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

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

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

@@ -1,161 +0,0 @@
-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.js';
-import { SVG } from '../svg/index.js';
-import { ParentIconsTree } from '@iconify/utils/lib/icon-set/tree';
-
-/**
- * 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;
-    /**
-     * Remove 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/match.d.ts

@@ -1,14 +0,0 @@
-import { FullIconifyIcon } from '@iconify/utils/lib/icon/defaults';
-import { IconSet } from './index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import './types.js';
-import '../svg/index.js';
-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.ts

@@ -1,13 +0,0 @@
-import { IconSet } from './index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import './types.js';
-import '../svg/index.js';
-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.ts

@@ -1,15 +0,0 @@
-import { IconSet } from './index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import './types.js';
-import '../svg/index.js';
-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.ts

@@ -1,13 +0,0 @@
-import { CommonIconProps } from './types.js';
-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.ts

@@ -1,22 +0,0 @@
-import { IconSet } from './index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import './types.js';
-import '../svg/index.js';
-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 };