@iconify/tools 3.0.2 → 3.0.3

package/lib/import/figma/query.d.ts

@@ -1,28 +0,0 @@
-import { APICacheOptions } from '../../download/api/types.js';
-import { DocumentNotModified } from '../../download/types/modified.js';
-import { FigmaDocument } from './types/api.js';
-import { FigmaIfModifiedSinceOption, FigmaFilesQueryOptions, FigmaImagesQueryOptions } from './types/options.js';
-import { FigmaNodesImportResult } from './types/result.js';
-import '../../icon-set/index.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';
-import './types/nodes.js';
-
-/**
- * Get Figma files
- */
-declare function figmaFilesQuery<T extends FigmaIfModifiedSinceOption & FigmaFilesQueryOptions>(options: T, cache?: APICacheOptions): Promise<FigmaDocument | DocumentNotModified>;
-declare function figmaFilesQuery(options: FigmaFilesQueryOptions, cache?: APICacheOptions): Promise<FigmaDocument>;
-/**
- * Generate all images
- */
-declare function figmaImagesQuery(options: FigmaImagesQueryOptions, nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
-/**
- * Download all images
- */
-declare function figmaDownloadImages(nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
-
-export { figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

package/lib/import/figma/types/api.d.ts

@@ -1,53 +0,0 @@
-/**
- * Basic document structure
- */
-interface FigmaBoundingBox {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-interface BaseFigmaNode {
-    id: string;
-    name: string;
-}
-interface GenericFigmaNode extends BaseFigmaNode {
-    type: string;
-    children?: FigmaNode[];
-}
-interface IconFigmaNode extends BaseFigmaNode {
-    type: 'FRAME' | 'COMPONENT' | 'INSTANCE';
-    clipsContent?: boolean;
-    absoluteBoundingBox?: FigmaBoundingBox;
-    children: FigmaNode[];
-}
-interface FigmaDocumentNode extends BaseFigmaNode {
-    type: 'DOCUMENT';
-    children: FigmaNode[];
-}
-type FigmaNode = GenericFigmaNode | IconFigmaNode;
-/**
- * Document response from API
- */
-interface FigmaDocument {
-    document: FigmaDocumentNode;
-    name: string;
-    version: string;
-    lastModified: string;
-    thumbnailUrl: string;
-    role: string;
-    editorType: 'figma' | 'figjam';
-}
-interface FigmaAPIError {
-    status: number;
-    err: string;
-}
-/**
- * Result for retrieved icons
- */
-interface FigmaAPIImagesResponse {
-    err?: string | null;
-    images: Record<string, string | null>;
-}
-
-export { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

package/lib/import/figma/types/nodes.d.ts

@@ -1,43 +0,0 @@
-import { IconFigmaNode, FigmaDocument } from './api.js';
-import { FigmaNodesImportResult, FigmaIconNode } from './result.js';
-import '../../../icon-set/index.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';
-
-type FigmaImportParentNodeType = 'CANVAS' | 'FRAME' | 'GROUP' | 'SECTION';
-type FigmaImportIconNodeType = IconFigmaNode['type'];
-/**
- * Node information passed to callback
- */
-interface FigmaParentNodeData {
-    id: string;
-    type: FigmaImportParentNodeType;
-    name: string;
-}
-interface FigmaImportNodeData {
-    id: string;
-    type: FigmaImportIconNodeType;
-    name: string;
-    width: number;
-    height: number;
-    parents: FigmaParentNodeData[];
-}
-/**
- * Callback to check if node needs to be checked for icons
- *
- * Used to speed up processing by eleminating pages, frames and groups that do not need processing
- */
-type FigmaImportParentNodeFilter = (node: FigmaParentNodeData[], document: FigmaDocument) => boolean;
-/**
- * Check if node is an icon.
- *
- * Returns icon name on success, null or undefined if not should be ignored.
- * Function can also return FigmaIconNode object, where it can put extra properties that can be used later
- */
-type FigmaIconNodeWithKeyword = Partial<FigmaIconNode> & Pick<FigmaIconNode, 'keyword'>;
-type FigmaImportNodeFilter = (node: FigmaImportNodeData, nodes: FigmaNodesImportResult, document: FigmaDocument) => string | FigmaIconNodeWithKeyword | null | undefined;
-
-export { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

package/lib/import/figma/types/options.d.ts

@@ -1,58 +0,0 @@
-import { IconSet } from '../../../icon-set/index.js';
-import { FigmaImportParentNodeFilter, FigmaImportNodeFilter } from './nodes.js';
-import { FigmaIconNode } from './result.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';
-import './api.js';
-
-/**
- * Options for importing SVG
- */
-interface FigmaImportSVGOptions {
-    includeID?: boolean;
-    simplifyStroke?: boolean;
-    useAbsoluteBounds?: boolean;
-}
-/**
- * Options
- */
-interface FigmaImportCommonOptions {
-    token: string;
-    file: string;
-    version?: string;
-}
-interface FigmaIfModifiedSinceOption {
-    ifModifiedSince: string | Date | true;
-}
-interface FigmaFilesQueryOptions extends FigmaImportCommonOptions, Partial<FigmaIfModifiedSinceOption> {
-    ids?: string[];
-    depth?: number;
-}
-interface FigmaImagesQueryOptions extends FigmaImportCommonOptions {
-    svgOptions?: FigmaImportSVGOptions;
-}
-interface FigmaGetIconNodesOptions {
-    pages?: string[];
-    filterParentNode?: FigmaImportParentNodeFilter;
-    iconNameForNode: FigmaImportNodeFilter;
-}
-/**
- * Callback to call before or after importing icon
- */
-type FigmaImportedIconCallback = (node: FigmaIconNode, iconSet: IconSet) => void | Promise<void>;
-/**
- * Options for main import function
- */
-interface FigmaImportOptions extends FigmaFilesQueryOptions, FigmaImagesQueryOptions, FigmaGetIconNodesOptions {
-    prefix: string;
-    cacheDir?: string;
-    cacheAPITTL?: number;
-    cacheSVGTTL?: number;
-    beforeImportingIcon?: FigmaImportedIconCallback;
-    afterImportingIcon?: FigmaImportedIconCallback;
-}
-
-export { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };

package/lib/import/figma/types/result.d.ts

@@ -1,43 +0,0 @@
-import { IconSet } from '../../../icon-set/index.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';
-
-/**
- * Result for found icons
- */
-interface FigmaIconNode {
-    id: string;
-    name: string;
-    keyword: string;
-    url?: string;
-    content?: string;
-}
-/**
- * Nodes count
- */
-interface FigmaNodesCount {
-    nodesCount: number;
-    generatedIconsCount: number;
-    downloadedIconsCount: number;
-}
-/**
- * Import result for icons
- */
-interface FigmaNodesImportResult extends Partial<FigmaNodesCount> {
-    icons: Record<string, FigmaIconNode>;
-}
-/**
- * Import result
- */
-interface FigmaImportResult extends FigmaNodesCount {
-    name: string;
-    version: string;
-    lastModified: string;
-    iconSet: IconSet;
-    missing: FigmaIconNode[];
-}
-
-export { FigmaIconNode, FigmaImportResult, FigmaNodesCount, FigmaNodesImportResult };

package/lib/index.d.ts

@@ -1,72 +0,0 @@
-export { SVG } from './svg/index.js';
-export { parseSVG, parseSVGSync } from './svg/parse.js';
-export { parseSVGStyle, parseSVGStyleSync } from './svg/parse-style.js';
-export { analyseSVGStructure } from './svg/analyse.js';
-export { cleanupSVG } from './svg/cleanup.js';
-export { removeBadAttributes } from './svg/cleanup/attribs.js';
-export { checkBadTags } from './svg/cleanup/bad-tags.js';
-export { cleanupRootStyle } from './svg/cleanup/root-style.js';
-export { cleanupInlineStyle } from './svg/cleanup/inline-style.js';
-export { cleanupSVGRoot } from './svg/cleanup/root-svg.js';
-export { convertStyleToAttrs } from './svg/cleanup/svgo-style.js';
-export { IconSet, blankIconSet } from './icon-set/index.js';
-export { mergeIconSets } from './icon-set/merge.js';
-export { addTagsToIconSet } from './icon-set/tags.js';
-export { importFromFigma } from './import/figma/index.js';
-export { importDirectory, importDirectorySync } from './import/directory.js';
-export { downloadGitRepo } from './download/git/index.js';
-export { getGitRepoHash } from './download/git/hash.js';
-export { getGitRepoBranch } from './download/git/branch.js';
-export { resetGitRepoContents } from './download/git/reset.js';
-export { downloadGitHubRepo } from './download/github/index.js';
-export { getGitHubRepoHash } from './download/github/hash.js';
-export { downloadGitLabRepo } from './download/gitlab/index.js';
-export { getGitLabRepoHash } from './download/gitlab/hash.js';
-export { downloadNPMPackage } from './download/npm/index.js';
-export { getNPMVersion, getPackageVersion } from './download/npm/version.js';
-export { downloadPackage } from './download/index.js';
-export { downloadFile } from './download/api/download.js';
-export { isEmptyColor, parseColors, parseColorsSync } from './colors/parse.js';
-export { validateColors, validateColorsSync } from './colors/validate.js';
-export { detectIconSetPalette } from './colors/detect.js';
-export { runSVGO } from './optimise/svgo.js';
-export { deOptimisePaths } from './optimise/flags.js';
-export { resetSVGOrigin } from './optimise/origin.js';
-export { scaleSVG } from './optimise/scale.js';
-export { cleanupGlobalStyle } from './optimise/global-style.js';
-export { exportToDirectory } from './export/directory.js';
-export { exportIconPackage } from './export/icon-package.js';
-export { exportJSONPackage } from './export/json-package.js';
-export { writeJSONFile } from './misc/write-json.js';
-export { prepareDirectoryForExport } from './export/helpers/prepare.js';
-export { scanDirectory, scanDirectorySync } from './misc/scan.js';
-export { compareDirectories } from './misc/compare-dirs.js';
-export { unzip } from './download/helpers/unzip.js';
-export { untar } from './download/helpers/untar.js';
-export { execAsync } from './misc/exec.js';
-export { cleanupIconKeyword } from './misc/keyword.js';
-export { bumpVersion } from './misc/bump-version.js';
-export { sendAPIQuery } from './download/api/index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import './misc/cheerio.js';
-import './css/parser/types.js';
-import './svg/analyse/types.js';
-import './icon-set/types.js';
-import '@iconify/utils/lib/icon-set/tree';
-import './download/types/modified.js';
-import './import/figma/types/options.js';
-import './import/figma/types/nodes.js';
-import './import/figma/types/api.js';
-import './import/figma/types/result.js';
-import './download/types/sources.js';
-import './download/github/types.js';
-import './download/gitlab/types.js';
-import './download/npm/types.js';
-import './download/api/types.js';
-import '@iconify/utils/lib/colors/types';
-import './colors/attribs.js';
-import 'svgo';
-import './export/helpers/custom-files.js';
-import 'fs';
-import 'child_process';

package/lib/misc/bump-version.d.ts

@@ -1,6 +0,0 @@
-/**
- * Bump version number
- */
-declare function bumpVersion(version: string): string;
-
-export { bumpVersion };

package/lib/misc/cheerio.d.ts

@@ -1,7 +0,0 @@
-/**
- * Shortcuts for Cheerio elements
- */
-type CheerioElement = cheerio.TagElement;
-type WrappedCheerioElement = cheerio.Cheerio;
-
-export { CheerioElement, WrappedCheerioElement };

package/lib/misc/compare-dirs.d.ts

@@ -1,11 +0,0 @@
-interface CompareDirectoriesOptions {
-    ignoreNewLine?: boolean;
-    ignoreVersions?: boolean;
-    textExtensions?: string[];
-}
-/**
- * Compare directories. Returns true if files are identical, false if different
- */
-declare function compareDirectories(dir1: string, dir2: string, options?: CompareDirectoriesOptions): Promise<boolean>;
-
-export { CompareDirectoriesOptions, compareDirectories };

package/lib/misc/exec.d.ts

@@ -1,12 +0,0 @@
-import { ExecOptions } from 'child_process';
-
-interface ExecResult {
-    stdout: string;
-    stderr: string;
-}
-/**
- * Exec as Promise
- */
-declare function execAsync(cmd: string, options?: ExecOptions): Promise<ExecResult>;
-
-export { ExecResult, execAsync };

package/lib/misc/keyword.d.ts

@@ -1,6 +0,0 @@
-/**
- * Clean up keyword
- */
-declare function cleanupIconKeyword(keyword: string, convertCamelCase?: boolean): string;
-
-export { cleanupIconKeyword };

package/lib/misc/scan.d.ts

@@ -1,33 +0,0 @@
-import { Stats } from 'fs';
-
-/**
- * Callback
- *
- * Extension starts with '.' (can be empty)
- * File does not include extension
- * Subdir ends with '/' (can be empty)
- *
- * Should return:
- * - false, null or undefined to skip file
- * - true to include file (subdir + file + extension)
- * - string to include custom string (such as file without extension)
- * - custom object to return custom object
- */
-type ScanDirectoryCallbackFalseResult = boolean | null | undefined;
-type ScanDirectoryCallbackStringResult = ScanDirectoryCallbackFalseResult | string;
-type Callback<T> = (ext: string, file: string, subdir: string, path: string, stat: Stats) => T;
-type AsyncCallback<T> = Callback<T | Promise<T>>;
-type ScanDirectoryCallback = AsyncCallback<ScanDirectoryCallbackStringResult | unknown>;
-type ScanDirectorySyncCallback = Callback<ScanDirectoryCallbackStringResult | unknown>;
-/**
- * Find all files in directory
- */
-declare function scanDirectory(path: string, callback?: AsyncCallback<ScanDirectoryCallbackStringResult>, subdirs?: boolean): Promise<string[]>;
-declare function scanDirectory<T>(path: string, callback: AsyncCallback<T | ScanDirectoryCallbackFalseResult>, subdirs?: boolean): Promise<T[]>;
-/**
- * Find all files in directory, synchronously
- */
-declare function scanDirectorySync(path: string, callback?: Callback<ScanDirectoryCallbackStringResult>, subdirs?: boolean): string[];
-declare function scanDirectorySync<T>(path: string, callback: Callback<T | ScanDirectoryCallbackFalseResult>, subdirs?: boolean): T[];
-
-export { ScanDirectoryCallback, ScanDirectorySyncCallback, scanDirectory, scanDirectorySync };

package/lib/misc/write-json.d.ts

@@ -1,6 +0,0 @@
-/**
- * Write JSON file
- */
-declare function writeJSONFile(filename: string, data: unknown): Promise<void>;
-
-export { writeJSONFile };

package/lib/optimise/flags.d.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../svg/index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * De-optimise paths. Compressed paths are still not supported by some software.
- */
-declare function deOptimisePaths(svg: SVG): Promise<void>;
-
-export { deOptimisePaths };

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

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

package/lib/optimise/origin.d.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../svg/index.js';
-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.ts

@@ -1,10 +0,0 @@
-import { SVG } from '../svg/index.js';
-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.ts

@@ -1,36 +0,0 @@
-import { PluginConfig } from 'svgo';
-import { SVG } from '../svg/index.js';
-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.ts

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

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