@iconify/tools 4.0.0-dev.1 → 4.0.1

package/lib/import/figma/query.mjs

@@ -1,5 +1,8 @@
 import { sendAPIQuery } from '../../download/api/index.mjs';
 import { apiCacheKey, getAPICache, clearAPICache } from '../../download/api/cache.mjs';
+import { runConcurrentQueries } from '../../download/api/queue.mjs';
+import 'axios';
+import '../../download/api/config.mjs';
 import 'fs';
 import 'crypto';
 import '../../misc/scan.mjs';
@@ -111,78 +114,92 @@ async function figmaImagesQuery(options, nodes, cache) {
   const uri = "https://api.figma.com/v1/images/" + options.file;
   const maxLength = 2048 - uri.length;
   const svgOptions = options.svgOptions || {};
-  let ids = [];
-  let idsLength = 0;
-  let lastError;
-  let found = 0;
-  const query = async () => {
-    const params = new URLSearchParams({
-      ids: ids.join(","),
-      format: "svg"
-    });
-    if (options.version) {
-      params.set("version", options.version);
-    }
-    if (svgOptions.includeID) {
-      params.set("svg_include_id", "true");
-    }
-    if (svgOptions.simplifyStroke) {
-      params.set("svg_simplify_stroke", "true");
-    }
-    if (svgOptions.useAbsoluteBounds) {
-      params.set("use_absolute_bounds", "true");
-    }
-    const data = await sendAPIQuery(
-      {
-        uri,
-        params,
-        headers: {
-          "X-FIGMA-TOKEN": options.token
+  const query = (ids2) => {
+    return new Promise((resolve, reject) => {
+      const params = new URLSearchParams({
+        ids: ids2.join(","),
+        format: "svg"
+      });
+      if (options.version) {
+        params.set("version", options.version);
+      }
+      if (svgOptions.includeID) {
+        params.set("svg_include_id", "true");
+      }
+      if (svgOptions.simplifyStroke) {
+        params.set("svg_simplify_stroke", "true");
+      }
+      if (svgOptions.useAbsoluteBounds) {
+        params.set("use_absolute_bounds", "true");
+      }
+      sendAPIQuery(
+        {
+          uri,
+          params,
+          headers: {
+            "X-FIGMA-TOKEN": options.token
+          }
+        },
+        cache
+      ).then((data) => {
+        if (typeof data === "number") {
+          reject(data);
+          return;
         }
-      },
-      cache
-    );
-    if (typeof data === "number") {
-      lastError = data;
-      return;
-    }
-    try {
-      const parsedData = JSON.parse(data);
-      const images = parsedData.images;
-      for (const id in images) {
-        const node = nodes.icons[id];
-        const target = images[id];
-        if (node && target) {
-          node.url = target;
-          found++;
+        let parsedData;
+        try {
+          parsedData = JSON.parse(data);
+        } catch {
+          reject("Bad API response");
+          return;
         }
-      }
-    } catch (err) {
-      return;
-    }
+        resolve(parsedData);
+      }).catch(reject);
+    });
   };
+  let ids = [];
+  let idsLength = 0;
   const allKeys = Object.keys(nodes.icons);
+  const queue = [];
   for (let i = 0; i < allKeys.length; i++) {
     const id = allKeys[i];
     ids.push(id);
     idsLength += id.length + 1;
     if (idsLength >= maxLength) {
-      await query();
+      queue.push(ids.slice(0));
       ids = [];
       idsLength = 0;
     }
   }
   if (idsLength) {
-    await query();
+    queue.push(ids.slice(0));
   }
-  if (!found) {
-    if (lastError) {
-      throw new Error(
-        `Error retrieving image data from API${lastError ? ": " + lastError.toString() : ""}`
-      );
-    } else {
-      throw new Error("No valid icon layers were found");
+  const queryParams = {
+    // Params
+    total: queue.length,
+    callback: (index) => query(queue[index]),
+    // Payload to identify failed items in onfail callback
+    function: "figmaImagesQuery",
+    payload: queue
+  };
+  const results = await runConcurrentQueries(queryParams);
+  let found = 0;
+  results.forEach((data) => {
+    if (!data) {
+      return;
+    }
+    const images = data.images;
+    for (const id in images) {
+      const node = nodes.icons[id];
+      const target = images[id];
+      if (node && target) {
+        node.url = target;
+        found++;
+      }
     }
+  });
+  if (!found) {
+    throw new Error("No valid icon layers were found");
   }
   nodes.generatedIconsCount = found;
   return nodes;
@@ -191,32 +208,43 @@ async function figmaDownloadImages(nodes, cache) {
   const icons = nodes.icons;
   const ids = Object.keys(icons);
   let count = 0;
-  let lastError;
+  const filtered = [];
   for (let i = 0; i < ids.length; i++) {
     const id = ids[i];
     const item = icons[id];
-    if (!item.url) {
-      continue;
-    }
-    const result = await sendAPIQuery(
-      {
-        uri: item.url
-      },
-      cache
-    );
-    if (typeof result === "number") {
-      lastError = result;
-      continue;
-    }
-    if (typeof result === "string") {
-      count++;
-      item.content = result;
-    }
-  }
+    if (item.url) {
+      filtered.push(item);
+    }
+  }
+  const params = {
+    // Params
+    total: filtered.length,
+    callback: (index) => {
+      return new Promise((resolve, reject) => {
+        const item = filtered[index];
+        sendAPIQuery(
+          {
+            uri: item.url
+          },
+          cache
+        ).then((data) => {
+          if (typeof data === "string") {
+            count++;
+            item.content = data;
+            resolve(void 0);
+          } else {
+            reject(data);
+          }
+        }).catch(reject);
+      });
+    },
+    // Payload to identify failed items in onfail callback
+    function: "figmaDownloadImages",
+    payload: filtered
+  };
+  await runConcurrentQueries(params);
   if (!count) {
-    throw new Error(
-      `Error retrieving images${lastError ? ": " + lastError.toString() : ""}`
-    );
+    throw new Error("Error retrieving images");
   }
   nodes.downloadedIconsCount = count;
   return nodes;

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

@@ -0,0 +1,53 @@
+/**
+ * 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 type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

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

@@ -0,0 +1,53 @@
+/**
+ * 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 type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

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

@@ -50,4 +50,4 @@ interface FigmaAPIImagesResponse {
     images: Record<string, string | null>;
 }
 
-export { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };
+export type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

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

@@ -0,0 +1,44 @@
+import { IconFigmaNode, FigmaDocument } from './api.cjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './result.cjs';
+import '../../../icon-set/index.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';
+
+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 type { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

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

@@ -0,0 +1,44 @@
+import { IconFigmaNode, FigmaDocument } from './api.mjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './result.mjs';
+import '../../../icon-set/index.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';
+
+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 type { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

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

@@ -41,4 +41,4 @@ type FigmaImportParentNodeFilter = (node: FigmaParentNodeData[], document: Figma
 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 };
+export type { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

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

@@ -0,0 +1,59 @@
+import { IconSet } from '../../../icon-set/index.cjs';
+import { FigmaImportParentNodeFilter, FigmaImportNodeFilter } from './nodes.cjs';
+import { FigmaIconNode } from './result.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 './api.cjs';
+
+/**
+ * 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 type { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };

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

@@ -0,0 +1,59 @@
+import { IconSet } from '../../../icon-set/index.mjs';
+import { FigmaImportParentNodeFilter, FigmaImportNodeFilter } from './nodes.mjs';
+import { FigmaIconNode } from './result.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 './api.mjs';
+
+/**
+ * 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 type { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };

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

@@ -56,4 +56,4 @@ interface FigmaImportOptions extends FigmaFilesQueryOptions, FigmaImagesQueryOpt
     afterImportingIcon?: FigmaImportedIconCallback;
 }
 
-export { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };
+export type { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };

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

@@ -0,0 +1,44 @@
+import { IconSet } from '../../../icon-set/index.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';
+
+/**
+ * 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 type { FigmaIconNode, FigmaImportResult, FigmaNodesCount, FigmaNodesImportResult };

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

@@ -0,0 +1,44 @@
+import { IconSet } from '../../../icon-set/index.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';
+
+/**
+ * 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 type { FigmaIconNode, FigmaImportResult, FigmaNodesCount, FigmaNodesImportResult };

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

@@ -41,4 +41,4 @@ interface FigmaImportResult extends FigmaNodesCount {
     missing: FigmaIconNode[];
 }
 
-export { FigmaIconNode, FigmaImportResult, FigmaNodesCount, FigmaNodesImportResult };
+export type { FigmaIconNode, FigmaImportResult, FigmaNodesCount, FigmaNodesImportResult };