@iconify/tools 2.1.0 → 2.1.1

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

@@ -1,4 +1,4 @@
-import { a as IconifyInfo, b as IconifyJSON } from '../types-6360d61e.js';
+import { IconifyInfo, IconifyJSON } from '@iconify/types';
 import { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
 import { IconSetIconEntry, IconCategory, IconSetIconType, IconSetAsyncForEachCallback, ResolvedIconifyIcon, CommonIconProps, CheckThemeResult } from './types.js';
 import { SVG } from '../svg/index.js';

package/lib/icon-set/index.mjs

@@ -10,7 +10,9 @@ import 'cheerio';
 
 const themeKeys = ["prefixes", "suffixes"];
 function sortThemeKeys(keys) {
-  return keys.sort((a, b) => a.length === b.length ? a.localeCompare(b) : b.length - a.length);
+  return keys.sort(
+    (a, b) => a.length === b.length ? a.localeCompare(b) : b.length - a.length
+  );
 }
 class IconSet {
   constructor(data) {
@@ -26,10 +28,14 @@ class IconSet {
       const entry = {
         type: "icon",
         body: item.body,
-        props: filterProps({
-          ...defaultProps,
-          ...item
-        }, defaultCommonProps, true),
+        props: filterProps(
+          {
+            ...defaultProps,
+            ...item
+          },
+          defaultCommonProps,
+          true
+        ),
         chars: /* @__PURE__ */ new Set(),
         categories: /* @__PURE__ */ new Set()
       };
@@ -201,7 +207,9 @@ class IconSet {
       return null;
     }
     const result = iconToSVG(item, customisations);
-    const attributes = Object.keys(result.attributes).map((key) => ` ${key}="${result.attributes[key]}"`).join("");
+    const attributes = Object.keys(result.attributes).map(
+      (key) => ` ${key}="${result.attributes[key]}"`
+    ).join("");
     return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"${attributes}>${result.body}</svg>`;
   }
   toSVG(name) {
@@ -258,7 +266,9 @@ class IconSet {
     if (Object.keys(aliases).length) {
       result.aliases = aliases;
     }
-    const chars = this.chars(Object.keys(icons).concat(Object.keys(aliases)));
+    const chars = this.chars(
+      Object.keys(icons).concat(Object.keys(aliases))
+    );
     if (Object.keys(chars).length) {
       result.chars = chars;
     }
@@ -338,7 +348,9 @@ class IconSet {
     }).length;
   }
   findCategory(title, add) {
-    const categoryItem = Array.from(this.categories).find((item) => item.title === title);
+    const categoryItem = Array.from(this.categories).find(
+      (item) => item.title === title
+    );
     if (categoryItem) {
       return categoryItem;
     }

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

@@ -1,6 +1,6 @@
 import { FullIconifyIcon } from '@iconify/utils/lib/icon/defaults';
 import { IconSet } from './index.js';
-import '../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import './types.js';
 import '../svg/index.js';

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

@@ -1,5 +1,5 @@
 import { IconSet } from './index.js';
-import '../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import './types.js';
 import '../svg/index.js';

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

@@ -1,5 +1,5 @@
 import { IconSet } from './index.js';
-import '../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import './types.js';
 import '../svg/index.js';

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

@@ -1,5 +1,5 @@
 import { CommonIconProps } from './types.js';
-import '../types-6360d61e.js';
+import '@iconify/types';
 
 /**
  * Common properties for icon and alias

package/lib/icon-set/tags.cjs

@@ -0,0 +1,97 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const defaults = require('@iconify/utils/lib/icon/defaults');
+const colors_detect = require('../colors/detect.cjs');
+require('../colors/parse.cjs');
+require('@iconify/utils/lib/colors');
+require('../svg/data/tags.cjs');
+require('../svg/parse-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('../css/parser/export.cjs');
+require('../css/parser/tree.cjs');
+require('../svg/parse.cjs');
+require('../colors/attribs.cjs');
+require('../svg/data/attributes.cjs');
+require('../svg/analyse.cjs');
+require('../svg/analyse/error.cjs');
+
+const paletteTags = {
+  monotone: "Monotone",
+  palette: "Has Colors"
+};
+const sizeTags = {
+  square: "Square",
+  gridPrefix: "Grid: ",
+  heightPrefix: "Height: "
+};
+async 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 = await colors_detect.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 || defaults.defaultIconDimensions.width;
+      const iconHeight = iconProps.height || defaults.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;
+}
+
+exports.addTagsToIconSet = addTagsToIconSet;
+exports.paletteTags = paletteTags;
+exports.sizeTags = sizeTags;

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

@@ -0,0 +1,22 @@
+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[]): Promise<string[]>;
+
+export { addTagsToIconSet, paletteTags, sizeTags };

package/lib/icon-set/tags.mjs

@@ -0,0 +1,91 @@
+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: "
+};
+async 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 = await 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.d.ts

@@ -1,4 +1,4 @@
-import { E as ExtendedIconifyIcon, c as ExtendedIconifyAlias, d as IconifyOptional, I as IconifyIcon } from '../types-6360d61e.js';
+import { ExtendedIconifyIcon, ExtendedIconifyAlias, IconifyOptional, IconifyIcon } from '@iconify/types';
 
 /**
  * Category item

package/lib/import/directory.cjs

@@ -61,7 +61,10 @@ async function importDirectory(path, options = {}) {
       continue;
     }
     try {
-      const content = await fs.promises.readFile(file.path + file.subdir + file.file + file.ext, "utf8");
+      const content = await fs.promises.readFile(
+        file.path + file.subdir + file.file + file.ext,
+        "utf8"
+      );
       const svg = new svg_index.SVG(content);
       await svg_cleanup.cleanupSVG(svg);
       iconSet.fromSVG(keyword, svg);

package/lib/import/directory.d.ts

@@ -1,5 +1,5 @@
 import { IconSet } from '../icon-set/index.js';
-import '../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import '../icon-set/types.js';
 import '../svg/index.js';

package/lib/import/directory.mjs

@@ -57,7 +57,10 @@ async function importDirectory(path, options = {}) {
       continue;
     }
     try {
-      const content = await promises.readFile(file.path + file.subdir + file.file + file.ext, "utf8");
+      const content = await promises.readFile(
+        file.path + file.subdir + file.file + file.ext,
+        "utf8"
+      );
       const svg = new SVG(content);
       await cleanupSVG(svg);
       iconSet.fromSVG(keyword, svg);

package/lib/import/figma/index.cjs

@@ -50,12 +50,15 @@ async function importFromFigma(options) {
     ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
     dir: options.cacheDir
   } : void 0;
-  const document = await import_figma_query.figmaFilesQuery(options, cacheOptions);
+  const document = await import_figma_query.figmaFilesQuery(
+    options,
+    cacheOptions
+  );
   if (document === "not_modified") {
     return document;
   }
   options.version = document.version;
-  const nodes = await import_figma_nodes.getFigmaIconNodes(document, options);
+  const nodes = import_figma_nodes.getFigmaIconNodes(document, options);
   await import_figma_query.figmaImagesQuery(options, nodes, cacheOptions);
   await import_figma_query.figmaDownloadImages(nodes, cacheSVGOptions);
   const iconSet = iconSet_index.blankIconSet(options.prefix);

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

@@ -2,7 +2,7 @@ import { DocumentNotModified } from '../../download/types/modified.js';
 import { FigmaIfModifiedSinceOption, FigmaImportOptions } from './types/options.js';
 import { FigmaImportResult } from './types/result.js';
 import '../../icon-set/index.js';
-import '../../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import '../../icon-set/types.js';
 import '../../svg/index.js';

package/lib/import/figma/index.mjs

@@ -46,12 +46,15 @@ async function importFromFigma(options) {
     ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
     dir: options.cacheDir
   } : void 0;
-  const document = await figmaFilesQuery(options, cacheOptions);
+  const document = await figmaFilesQuery(
+    options,
+    cacheOptions
+  );
   if (document === "not_modified") {
     return document;
   }
   options.version = document.version;
-  const nodes = await getFigmaIconNodes(document, options);
+  const nodes = getFigmaIconNodes(document, options);
   await figmaImagesQuery(options, nodes, cacheOptions);
   await figmaDownloadImages(nodes, cacheSVGOptions);
   const iconSet = blankIconSet(options.prefix);

package/lib/import/figma/nodes.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-async function getFigmaIconNodes(document, options) {
+function getFigmaIconNodes(document, options) {
   const nodes = {
     icons: /* @__PURE__ */ Object.create(null)
   };
@@ -23,7 +23,11 @@ async function getFigmaIconNodes(document, options) {
             height: box.height,
             parents
           };
-          const keyword = options.iconNameForNode(item, nodes, document);
+          const keyword = options.iconNameForNode(
+            item,
+            nodes,
+            document
+          );
           if (typeof keyword === "string") {
             found++;
             nodes.icons[node.id] = {

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

@@ -2,7 +2,7 @@ import { FigmaDocument } from './types/api.js';
 import { FigmaGetIconNodesOptions } from './types/options.js';
 import { FigmaNodesImportResult } from './types/result.js';
 import '../../icon-set/index.js';
-import '../../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import '../../icon-set/types.js';
 import '../../svg/index.js';
@@ -12,6 +12,6 @@ import './types/nodes.js';
 /**
  * Get node ids for icons
  */
-declare function getFigmaIconNodes(document: FigmaDocument, options: FigmaGetIconNodesOptions): Promise<FigmaNodesImportResult>;
+declare function getFigmaIconNodes(document: FigmaDocument, options: FigmaGetIconNodesOptions): FigmaNodesImportResult;
 
 export { getFigmaIconNodes };

package/lib/import/figma/nodes.mjs

@@ -1,4 +1,4 @@
-async function getFigmaIconNodes(document, options) {
+function getFigmaIconNodes(document, options) {
   const nodes = {
     icons: /* @__PURE__ */ Object.create(null)
   };
@@ -19,7 +19,11 @@ async function getFigmaIconNodes(document, options) {
             height: box.height,
             parents
           };
-          const keyword = options.iconNameForNode(item, nodes, document);
+          const keyword = options.iconNameForNode(
+            item,
+            nodes,
+            document
+          );
           if (typeof keyword === "string") {
             found++;
             nodes.icons[node.id] = {

package/lib/import/figma/query.cjs

@@ -30,7 +30,7 @@ async function figmaFilesQuery(options, cache) {
     params.set("version", options.version);
   }
   if (options.depth) {
-    params.set("depth", options.depth + "");
+    params.set("depth", options.depth.toString());
   }
   const queryParams = {
     uri: "https://api.figma.com/v1/files/" + options.file,
@@ -97,11 +97,15 @@ async function figmaFilesQuery(options, cache) {
   }
   if (typeof parsedData.status === "number") {
     const figmaError = parsedData;
-    throw new Error(`Error retrieving document from API: ${figmaError.err}`);
+    throw new Error(
+      `Error retrieving document from API: ${figmaError.err}`
+    );
   }
   const document = parsedData;
   if (document.editorType !== "figma") {
-    throw new Error(`Error retrieving document from API: document is for ${document.editorType}`);
+    throw new Error(
+      `Error retrieving document from API: document is for ${document.editorType}`
+    );
   }
   if (identicalDates(options.ifModifiedSince, document.lastModified)) {
     return "not_modified";
@@ -133,13 +137,16 @@ async function figmaImagesQuery(options, nodes, cache) {
     if (svgOptions.useAbsoluteBounds) {
       params.set("use_absolute_bounds", "true");
     }
-    const data = await download_api_index.sendAPIQuery({
-      uri,
-      params,
-      headers: {
-        "X-FIGMA-TOKEN": options.token
-      }
-    }, cache);
+    const data = await download_api_index.sendAPIQuery(
+      {
+        uri,
+        params,
+        headers: {
+          "X-FIGMA-TOKEN": options.token
+        }
+      },
+      cache
+    );
     if (typeof data === "number") {
       lastError = data;
       return;
@@ -175,7 +182,9 @@ async function figmaImagesQuery(options, nodes, cache) {
   }
   if (!found) {
     if (lastError) {
-      throw new Error(`Error retrieving image data from API${lastError ? ": " + lastError : ""}`);
+      throw new Error(
+        `Error retrieving image data from API${lastError ? ": " + lastError.toString() : ""}`
+      );
     } else {
       throw new Error("No valid icon layers were found");
     }
@@ -194,9 +203,12 @@ async function figmaDownloadImages(nodes, cache) {
     if (!item.url) {
       continue;
     }
-    const result = await download_api_index.sendAPIQuery({
-      uri: item.url
-    }, cache);
+    const result = await download_api_index.sendAPIQuery(
+      {
+        uri: item.url
+      },
+      cache
+    );
     if (typeof result === "number") {
       lastError = result;
       continue;
@@ -207,7 +219,9 @@ async function figmaDownloadImages(nodes, cache) {
     }
   }
   if (!count) {
-    throw new Error(`Error retrieving images${lastError ? ": " + lastError : ""}`);
+    throw new Error(
+      `Error retrieving images${lastError ? ": " + lastError.toString() : ""}`
+    );
   }
   nodes.downloadedIconsCount = count;
   return nodes;

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

@@ -4,7 +4,7 @@ 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 '../../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import '../../icon-set/types.js';
 import '../../svg/index.js';

package/lib/import/figma/query.mjs

@@ -26,7 +26,7 @@ async function figmaFilesQuery(options, cache) {
     params.set("version", options.version);
   }
   if (options.depth) {
-    params.set("depth", options.depth + "");
+    params.set("depth", options.depth.toString());
   }
   const queryParams = {
     uri: "https://api.figma.com/v1/files/" + options.file,
@@ -93,11 +93,15 @@ async function figmaFilesQuery(options, cache) {
   }
   if (typeof parsedData.status === "number") {
     const figmaError = parsedData;
-    throw new Error(`Error retrieving document from API: ${figmaError.err}`);
+    throw new Error(
+      `Error retrieving document from API: ${figmaError.err}`
+    );
   }
   const document = parsedData;
   if (document.editorType !== "figma") {
-    throw new Error(`Error retrieving document from API: document is for ${document.editorType}`);
+    throw new Error(
+      `Error retrieving document from API: document is for ${document.editorType}`
+    );
   }
   if (identicalDates(options.ifModifiedSince, document.lastModified)) {
     return "not_modified";
@@ -129,13 +133,16 @@ async function figmaImagesQuery(options, nodes, cache) {
     if (svgOptions.useAbsoluteBounds) {
       params.set("use_absolute_bounds", "true");
     }
-    const data = await sendAPIQuery({
-      uri,
-      params,
-      headers: {
-        "X-FIGMA-TOKEN": options.token
-      }
-    }, cache);
+    const data = await sendAPIQuery(
+      {
+        uri,
+        params,
+        headers: {
+          "X-FIGMA-TOKEN": options.token
+        }
+      },
+      cache
+    );
     if (typeof data === "number") {
       lastError = data;
       return;
@@ -171,7 +178,9 @@ async function figmaImagesQuery(options, nodes, cache) {
   }
   if (!found) {
     if (lastError) {
-      throw new Error(`Error retrieving image data from API${lastError ? ": " + lastError : ""}`);
+      throw new Error(
+        `Error retrieving image data from API${lastError ? ": " + lastError.toString() : ""}`
+      );
     } else {
       throw new Error("No valid icon layers were found");
     }
@@ -190,9 +199,12 @@ async function figmaDownloadImages(nodes, cache) {
     if (!item.url) {
       continue;
     }
-    const result = await sendAPIQuery({
-      uri: item.url
-    }, cache);
+    const result = await sendAPIQuery(
+      {
+        uri: item.url
+      },
+      cache
+    );
     if (typeof result === "number") {
       lastError = result;
       continue;
@@ -203,7 +215,9 @@ async function figmaDownloadImages(nodes, cache) {
     }
   }
   if (!count) {
-    throw new Error(`Error retrieving images${lastError ? ": " + lastError : ""}`);
+    throw new Error(
+      `Error retrieving images${lastError ? ": " + lastError.toString() : ""}`
+    );
   }
   nodes.downloadedIconsCount = count;
   return nodes;

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

@@ -1,7 +1,7 @@
 import { IconFigmaNode, FigmaDocument } from './api.js';
 import { FigmaNodesImportResult, FigmaIconNode } from './result.js';
 import '../../../icon-set/index.js';
-import '../../../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import '../../../icon-set/types.js';
 import '../../../svg/index.js';

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

@@ -1,7 +1,7 @@
 import { IconSet } from '../../../icon-set/index.js';
 import { FigmaImportParentNodeFilter, FigmaImportNodeFilter } from './nodes.js';
 import { FigmaIconNode } from './result.js';
-import '../../../types-6360d61e.js';
+import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
 import '../../../icon-set/types.js';
 import '../../../svg/index.js';