@iconify/tools 4.2.0 → 5.0.0-beta.1

package/lib/icon-set/tags.mjs

@@ -1,91 +0,0 @@
-import { defaultIconDimensions } from '@iconify/utils/lib/icon/defaults';
-import { detectIconSetPalette } from '../colors/detect.mjs';
-import '../colors/parse.mjs';
-import '@iconify/utils/lib/colors';
-import '../svg/data/tags.mjs';
-import '../svg/parse-style.mjs';
-import '../css/parse.mjs';
-import '../css/parser/tokens.mjs';
-import '../css/parser/error.mjs';
-import '../css/parser/strings.mjs';
-import '../css/parser/text.mjs';
-import '../css/parser/export.mjs';
-import '../css/parser/tree.mjs';
-import '../svg/parse.mjs';
-import '../colors/attribs.mjs';
-import '../svg/data/attributes.mjs';
-import '../svg/analyse.mjs';
-import '../svg/analyse/error.mjs';
-
-const paletteTags = {
-  monotone: "Monotone",
-  palette: "Has Colors"
-};
-const sizeTags = {
-  square: "Square",
-  gridPrefix: "Grid: ",
-  heightPrefix: "Height: "
-};
-function addTagsToIconSet(iconSet, customTags) {
-  const info = iconSet.info;
-  const tags = [];
-  const iconNames = Object.keys(iconSet.entries).filter((key) => {
-    const item = iconSet.entries[key];
-    if (item.type !== "icon") {
-      return false;
-    }
-    if (item.props.hidden) {
-      return false;
-    }
-    return true;
-  });
-  if (iconNames.length) {
-    let hasPalette = info?.palette;
-    if (hasPalette === void 0) {
-      hasPalette = detectIconSetPalette(iconSet);
-    }
-    if (hasPalette === true) {
-      tags.push(paletteTags.palette);
-    }
-    if (hasPalette === false) {
-      tags.push(paletteTags.monotone);
-    }
-    let isSquare = true;
-    let height;
-    for (let i = 0; i < iconNames.length; i++) {
-      const icon = iconSet.entries[iconNames[i]];
-      if (icon.type !== "icon") {
-        continue;
-      }
-      const iconProps = icon.props;
-      const iconWidth = iconProps.width || defaultIconDimensions.width;
-      const iconHeight = iconProps.height || defaultIconDimensions.height;
-      if (isSquare && iconWidth !== iconHeight) {
-        isSquare = false;
-      }
-      if (height === void 0) {
-        height = iconHeight;
-      } else if (height && iconHeight !== height) {
-        height = null;
-      }
-      if (!height && !isSquare) {
-        break;
-      }
-    }
-    if (height && Math.round(height) === height) {
-      tags.push(
-        (isSquare ? sizeTags.gridPrefix : sizeTags.heightPrefix) + height.toString()
-      );
-    }
-    if (isSquare) {
-      tags.push(sizeTags.square);
-    }
-  }
-  const result = tags.concat(customTags || []);
-  if (info) {
-    info.tags = result;
-  }
-  return result;
-}
-
-export { addTagsToIconSet, paletteTags, sizeTags };

package/lib/icon-set/types.cjs

@@ -1,2 +0,0 @@
-'use strict';
-

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

@@ -1,75 +0,0 @@
-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

@@ -1,75 +0,0 @@
-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.mjs

@@ -1 +0,0 @@
-

package/lib/import/directory.cjs

@@ -1,169 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const iconSet_index = require('../icon-set/index.cjs');
-const misc_keyword = require('../misc/keyword.cjs');
-const misc_scan = require('../misc/scan.cjs');
-const svg_index = require('../svg/index.cjs');
-const svg_cleanup = require('../svg/cleanup.cjs');
-require('@iconify/utils/lib/icon/defaults');
-require('@iconify/utils/lib/svg/build');
-require('@iconify/utils/lib/icon-set/minify');
-require('@iconify/utils/lib/icon-set/convert-info');
-require('../icon-set/props.cjs');
-require('@iconify/utils/lib/misc/objects');
-require('@iconify/utils');
-require('cheerio');
-require('../svg/cleanup/attribs.cjs');
-require('../svg/data/attributes.cjs');
-require('../svg/data/tags.cjs');
-require('../svg/parse.cjs');
-require('../svg/cleanup/bad-tags.cjs');
-require('../svg/cleanup/inline-style.cjs');
-require('../css/parse.cjs');
-require('../css/parser/tokens.cjs');
-require('../css/parser/error.cjs');
-require('../css/parser/strings.cjs');
-require('../css/parser/text.cjs');
-require('../svg/cleanup/root-style.cjs');
-require('../svg/parse-style.cjs');
-require('../css/parser/export.cjs');
-require('../css/parser/tree.cjs');
-require('../svg/cleanup/root-svg.cjs');
-require('../svg/cleanup/svgo-style.cjs');
-require('../optimise/svgo.cjs');
-require('svgo');
-require('@iconify/utils/lib/svg/id');
-
-function importDir(iconSet, options, getKeyword, files, readFile, done) {
-  let i = 0;
-  const next = () => {
-    if (i >= files.length) {
-      return done(iconSet);
-    }
-    const file = files[i];
-    i++;
-    const defaultKeyword = misc_keyword.cleanupIconKeyword(file.file);
-    getKeyword([file, defaultKeyword, iconSet], (keyword) => {
-      if (typeof keyword !== "string" || !keyword.length) {
-        return next();
-      }
-      readFile(
-        file.path + file.subdir + file.file + file.ext,
-        (content) => {
-          try {
-            const svg = new svg_index.SVG(content);
-            svg_cleanup.cleanupSVG(svg, options);
-            iconSet.fromSVG(keyword, svg);
-          } catch (err) {
-            const ignore = options.ignoreImportErrors ?? false;
-            if (ignore === false || ignore === "warn") {
-              let msg = `Failed to import "${keyword}"`;
-              if (err instanceof Error) {
-                msg += `: ${err.message}`;
-              }
-              if (ignore === false) {
-                throw new Error(msg);
-              } else {
-                console.warn(msg);
-              }
-            }
-          }
-          next();
-        }
-      );
-    });
-  };
-  next();
-}
-function isValidFile(item) {
-  return item.ext.toLowerCase() === ".svg";
-}
-function importDirectory(path, options = {}) {
-  return new Promise((fulfill, reject) => {
-    misc_scan.scanDirectory(
-      path,
-      (ext, file, subdir, path2) => {
-        const result = {
-          file,
-          ext,
-          subdir,
-          path: path2
-        };
-        return isValidFile(result) ? result : false;
-      },
-      options.includeSubDirs !== false
-    ).then((files) => {
-      const iconSet = iconSet_index.blankIconSet(options.prefix || "");
-      try {
-        importDir(
-          iconSet,
-          options,
-          (params, done) => {
-            if (options.keyword) {
-              const result = options.keyword(...params);
-              if (result instanceof Promise) {
-                result.then(done).catch(reject);
-              } else {
-                done(result);
-              }
-            } else {
-              done(params[1]);
-            }
-          },
-          files,
-          (filename, done) => {
-            fs.promises.readFile(filename, "utf8").then(done).catch(reject);
-          },
-          fulfill
-        );
-      } catch (err) {
-        reject(err);
-      }
-    }).catch(reject);
-  });
-}
-function importDirectorySync(path, options = {}) {
-  const files = misc_scan.scanDirectorySync(
-    path,
-    (ext, file, subdir, path2) => {
-      const result = {
-        file,
-        ext,
-        subdir,
-        path: path2
-      };
-      return isValidFile(result) ? result : false;
-    },
-    options.includeSubDirs !== false
-  );
-  const iconSet = iconSet_index.blankIconSet(options.prefix || "");
-  let isSync = true;
-  importDir(
-    iconSet,
-    options,
-    (params, done) => {
-      if (options.keyword) {
-        done(options.keyword(...params));
-      } else {
-        done(params[1]);
-      }
-    },
-    files,
-    (filename, done) => {
-      done(fs.readFileSync(filename, "utf8"));
-    },
-    () => {
-      if (!isSync) {
-        throw new Error(
-          "importDirectorySync supposed to be synchronous"
-        );
-      }
-    }
-  );
-  isSync = false;
-  return iconSet;
-}
-
-exports.importDirectory = importDirectory;
-exports.importDirectorySync = importDirectorySync;

package/lib/import/directory.d.cts

@@ -1,52 +0,0 @@
-import { IconSet } from '../icon-set/index.cjs';
-import { CleanupSVGOptions } from '../svg/cleanup.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';
-import '../svg/cleanup/bad-tags.cjs';
-
-/**
- * Entry for file
- */
-interface ImportDirectoryFileEntry {
-    path: string;
-    subdir: string;
-    file: string;
-    ext: string;
-}
-/**
- * Callback to get keyword for icon based on file name
- *
- * Returns:
- * - string for new keyword
- * - undefined to skip icon
- *
- * Callback can be asynchronous
- */
-type ImportDirectoryKeywordCallbackResult = string | undefined;
-type Callback<T> = (file: ImportDirectoryFileEntry, defaultKeyword: string, iconSet: IconSet) => T;
-type AsyncCallback<T> = Callback<T | Promise<T>>;
-type ImportDirectoryKeywordCallback = AsyncCallback<ImportDirectoryKeywordCallbackResult>;
-type ImportDirectoryKeywordSyncCallback = Callback<ImportDirectoryKeywordCallbackResult>;
-/**
- * Options
- */
-interface ImportDirectoryOptions<K> extends CleanupSVGOptions {
-    prefix?: string;
-    includeSubDirs?: boolean;
-    keyword?: K;
-    ignoreImportErrors?: boolean | 'warn';
-}
-/**
- * Import all icons from directory
- */
-declare function importDirectory(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordCallback>): Promise<IconSet>;
-/**
- * Import all icons from directory synchronously
- */
-declare function importDirectorySync(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordSyncCallback>): IconSet;
-
-export { type ImportDirectoryFileEntry, type ImportDirectoryKeywordCallback, type ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };

package/lib/import/directory.d.mts

@@ -1,52 +0,0 @@
-import { IconSet } from '../icon-set/index.mjs';
-import { CleanupSVGOptions } from '../svg/cleanup.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';
-import '../svg/cleanup/bad-tags.mjs';
-
-/**
- * Entry for file
- */
-interface ImportDirectoryFileEntry {
-    path: string;
-    subdir: string;
-    file: string;
-    ext: string;
-}
-/**
- * Callback to get keyword for icon based on file name
- *
- * Returns:
- * - string for new keyword
- * - undefined to skip icon
- *
- * Callback can be asynchronous
- */
-type ImportDirectoryKeywordCallbackResult = string | undefined;
-type Callback<T> = (file: ImportDirectoryFileEntry, defaultKeyword: string, iconSet: IconSet) => T;
-type AsyncCallback<T> = Callback<T | Promise<T>>;
-type ImportDirectoryKeywordCallback = AsyncCallback<ImportDirectoryKeywordCallbackResult>;
-type ImportDirectoryKeywordSyncCallback = Callback<ImportDirectoryKeywordCallbackResult>;
-/**
- * Options
- */
-interface ImportDirectoryOptions<K> extends CleanupSVGOptions {
-    prefix?: string;
-    includeSubDirs?: boolean;
-    keyword?: K;
-    ignoreImportErrors?: boolean | 'warn';
-}
-/**
- * Import all icons from directory
- */
-declare function importDirectory(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordCallback>): Promise<IconSet>;
-/**
- * Import all icons from directory synchronously
- */
-declare function importDirectorySync(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordSyncCallback>): IconSet;
-
-export { type ImportDirectoryFileEntry, type ImportDirectoryKeywordCallback, type ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };

package/lib/import/directory.mjs

@@ -1,166 +0,0 @@
-import { promises, readFileSync } from 'fs';
-import { blankIconSet } from '../icon-set/index.mjs';
-import { cleanupIconKeyword } from '../misc/keyword.mjs';
-import { scanDirectory, scanDirectorySync } from '../misc/scan.mjs';
-import { SVG } from '../svg/index.mjs';
-import { cleanupSVG } from '../svg/cleanup.mjs';
-import '@iconify/utils/lib/icon/defaults';
-import '@iconify/utils/lib/svg/build';
-import '@iconify/utils/lib/icon-set/minify';
-import '@iconify/utils/lib/icon-set/convert-info';
-import '../icon-set/props.mjs';
-import '@iconify/utils/lib/misc/objects';
-import '@iconify/utils';
-import 'cheerio';
-import '../svg/cleanup/attribs.mjs';
-import '../svg/data/attributes.mjs';
-import '../svg/data/tags.mjs';
-import '../svg/parse.mjs';
-import '../svg/cleanup/bad-tags.mjs';
-import '../svg/cleanup/inline-style.mjs';
-import '../css/parse.mjs';
-import '../css/parser/tokens.mjs';
-import '../css/parser/error.mjs';
-import '../css/parser/strings.mjs';
-import '../css/parser/text.mjs';
-import '../svg/cleanup/root-style.mjs';
-import '../svg/parse-style.mjs';
-import '../css/parser/export.mjs';
-import '../css/parser/tree.mjs';
-import '../svg/cleanup/root-svg.mjs';
-import '../svg/cleanup/svgo-style.mjs';
-import '../optimise/svgo.mjs';
-import 'svgo';
-import '@iconify/utils/lib/svg/id';
-
-function importDir(iconSet, options, getKeyword, files, readFile, done) {
-  let i = 0;
-  const next = () => {
-    if (i >= files.length) {
-      return done(iconSet);
-    }
-    const file = files[i];
-    i++;
-    const defaultKeyword = cleanupIconKeyword(file.file);
-    getKeyword([file, defaultKeyword, iconSet], (keyword) => {
-      if (typeof keyword !== "string" || !keyword.length) {
-        return next();
-      }
-      readFile(
-        file.path + file.subdir + file.file + file.ext,
-        (content) => {
-          try {
-            const svg = new SVG(content);
-            cleanupSVG(svg, options);
-            iconSet.fromSVG(keyword, svg);
-          } catch (err) {
-            const ignore = options.ignoreImportErrors ?? false;
-            if (ignore === false || ignore === "warn") {
-              let msg = `Failed to import "${keyword}"`;
-              if (err instanceof Error) {
-                msg += `: ${err.message}`;
-              }
-              if (ignore === false) {
-                throw new Error(msg);
-              } else {
-                console.warn(msg);
-              }
-            }
-          }
-          next();
-        }
-      );
-    });
-  };
-  next();
-}
-function isValidFile(item) {
-  return item.ext.toLowerCase() === ".svg";
-}
-function importDirectory(path, options = {}) {
-  return new Promise((fulfill, reject) => {
-    scanDirectory(
-      path,
-      (ext, file, subdir, path2) => {
-        const result = {
-          file,
-          ext,
-          subdir,
-          path: path2
-        };
-        return isValidFile(result) ? result : false;
-      },
-      options.includeSubDirs !== false
-    ).then((files) => {
-      const iconSet = blankIconSet(options.prefix || "");
-      try {
-        importDir(
-          iconSet,
-          options,
-          (params, done) => {
-            if (options.keyword) {
-              const result = options.keyword(...params);
-              if (result instanceof Promise) {
-                result.then(done).catch(reject);
-              } else {
-                done(result);
-              }
-            } else {
-              done(params[1]);
-            }
-          },
-          files,
-          (filename, done) => {
-            promises.readFile(filename, "utf8").then(done).catch(reject);
-          },
-          fulfill
-        );
-      } catch (err) {
-        reject(err);
-      }
-    }).catch(reject);
-  });
-}
-function importDirectorySync(path, options = {}) {
-  const files = scanDirectorySync(
-    path,
-    (ext, file, subdir, path2) => {
-      const result = {
-        file,
-        ext,
-        subdir,
-        path: path2
-      };
-      return isValidFile(result) ? result : false;
-    },
-    options.includeSubDirs !== false
-  );
-  const iconSet = blankIconSet(options.prefix || "");
-  let isSync = true;
-  importDir(
-    iconSet,
-    options,
-    (params, done) => {
-      if (options.keyword) {
-        done(options.keyword(...params));
-      } else {
-        done(params[1]);
-      }
-    },
-    files,
-    (filename, done) => {
-      done(readFileSync(filename, "utf8"));
-    },
-    () => {
-      if (!isSync) {
-        throw new Error(
-          "importDirectorySync supposed to be synchronous"
-        );
-      }
-    }
-  );
-  isSync = false;
-  return iconSet;
-}
-
-export { importDirectory, importDirectorySync };