@iconify/tools 4.0.0-dev.1 → 4.0.0

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

@@ -0,0 +1,20 @@
+import { DocumentNotModified } from '../../download/types/modified.cjs';
+import { FigmaIfModifiedSinceOption, FigmaImportOptions } from './types/options.cjs';
+import { FigmaImportResult } from './types/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';
+import './types/nodes.cjs';
+import './types/api.cjs';
+
+/**
+ * Import icon set from Figma
+ */
+declare function importFromFigma<T extends FigmaIfModifiedSinceOption & FigmaImportOptions>(options: T): Promise<FigmaImportResult | DocumentNotModified>;
+declare function importFromFigma(options: FigmaImportOptions): Promise<FigmaImportResult>;
+
+export { importFromFigma };

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

@@ -0,0 +1,20 @@
+import { DocumentNotModified } from '../../download/types/modified.mjs';
+import { FigmaIfModifiedSinceOption, FigmaImportOptions } from './types/options.mjs';
+import { FigmaImportResult } from './types/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';
+import './types/nodes.mjs';
+import './types/api.mjs';
+
+/**
+ * Import icon set from Figma
+ */
+declare function importFromFigma<T extends FigmaIfModifiedSinceOption & FigmaImportOptions>(options: T): Promise<FigmaImportResult | DocumentNotModified>;
+declare function importFromFigma(options: FigmaImportOptions): Promise<FigmaImportResult>;
+
+export { importFromFigma };

package/lib/import/figma/index.mjs

@@ -32,10 +32,13 @@ import '../../optimise/svgo.mjs';
 import 'svgo';
 import '@iconify/utils/lib/svg/id';
 import '../../download/api/index.mjs';
+import 'axios';
 import '../../download/api/cache.mjs';
 import 'fs';
 import 'crypto';
 import '../../misc/scan.mjs';
+import '../../download/api/config.mjs';
+import '../../download/api/queue.mjs';
 
 async function importFromFigma(options) {
   const cacheOptions = options.cacheDir ? {

package/lib/import/figma/nodes.cjs

@@ -64,7 +64,7 @@ function getFigmaIconNodes(document, options) {
         const newParents = parents.concat([parentItem]);
         if (!parents.length && options.pages) {
           const allowedPages = options.pages;
-          if (allowedPages.indexOf(node.id) === -1 && allowedPages.indexOf(node.name.trim()) === -1) {
+          if (!allowedPages.includes(node.id) && !allowedPages.includes(node.name.trim())) {
             return;
           }
         } else {

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

@@ -0,0 +1,18 @@
+import { FigmaDocument } from './types/api.cjs';
+import { FigmaGetIconNodesOptions } from './types/options.cjs';
+import { FigmaNodesImportResult } from './types/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';
+import './types/nodes.cjs';
+
+/**
+ * Get node ids for icons
+ */
+declare function getFigmaIconNodes(document: FigmaDocument, options: FigmaGetIconNodesOptions): FigmaNodesImportResult;
+
+export { getFigmaIconNodes };

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

@@ -0,0 +1,18 @@
+import { FigmaDocument } from './types/api.mjs';
+import { FigmaGetIconNodesOptions } from './types/options.mjs';
+import { FigmaNodesImportResult } from './types/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';
+import './types/nodes.mjs';
+
+/**
+ * Get node ids for icons
+ */
+declare function getFigmaIconNodes(document: FigmaDocument, options: FigmaGetIconNodesOptions): FigmaNodesImportResult;
+
+export { getFigmaIconNodes };

package/lib/import/figma/nodes.mjs

@@ -62,7 +62,7 @@ function getFigmaIconNodes(document, options) {
         const newParents = parents.concat([parentItem]);
         if (!parents.length && options.pages) {
           const allowedPages = options.pages;
-          if (allowedPages.indexOf(node.id) === -1 && allowedPages.indexOf(node.name.trim()) === -1) {
+          if (!allowedPages.includes(node.id) && !allowedPages.includes(node.name.trim())) {
             return;
           }
         } else {

package/lib/import/figma/query.cjs

@@ -2,6 +2,9 @@
 
 const download_api_index = require('../../download/api/index.cjs');
 const download_api_cache = require('../../download/api/cache.cjs');
+const download_api_queue = require('../../download/api/queue.cjs');
+require('axios');
+require('../../download/api/config.cjs');
 require('fs');
 require('crypto');
 require('../../misc/scan.cjs');
@@ -113,78 +116,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 download_api_index.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");
+      }
+      download_api_index.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 download_api_queue.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;
@@ -193,32 +210,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 download_api_index.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];
+        download_api_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 download_api_queue.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/query.d.cts

@@ -0,0 +1,42 @@
+import { APICacheOptions } from '../../download/api/types.cjs';
+import { DocumentNotModified } from '../../download/types/modified.cjs';
+import { FigmaDocument } from './types/api.cjs';
+import { FigmaIfModifiedSinceOption, FigmaFilesQueryOptions, FigmaImagesQueryOptions } from './types/options.cjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './types/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';
+import './types/nodes.cjs';
+
+/**
+ * Extra parameters added to runConcurrentQueries()
+ *
+ * Can be used to identify failed items in onfail callback
+ */
+interface FigmaIconNodeWithURL extends FigmaIconNode {
+    url: string;
+}
+type FigmaConcurrentQueriesParamsFunction = 'figmaImagesQuery' | 'figmaDownloadImages';
+interface FigmaConcurrentQueriesParams<T extends FigmaConcurrentQueriesParamsFunction> {
+    function: T;
+    payload: T extends 'figmaImagesQuery' ? string[][] : FigmaIconNodeWithURL[];
+}
+/**
+ * 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 { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

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

@@ -0,0 +1,42 @@
+import { APICacheOptions } from '../../download/api/types.mjs';
+import { DocumentNotModified } from '../../download/types/modified.mjs';
+import { FigmaDocument } from './types/api.mjs';
+import { FigmaIfModifiedSinceOption, FigmaFilesQueryOptions, FigmaImagesQueryOptions } from './types/options.mjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './types/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';
+import './types/nodes.mjs';
+
+/**
+ * Extra parameters added to runConcurrentQueries()
+ *
+ * Can be used to identify failed items in onfail callback
+ */
+interface FigmaIconNodeWithURL extends FigmaIconNode {
+    url: string;
+}
+type FigmaConcurrentQueriesParamsFunction = 'figmaImagesQuery' | 'figmaDownloadImages';
+interface FigmaConcurrentQueriesParams<T extends FigmaConcurrentQueriesParamsFunction> {
+    function: T;
+    payload: T extends 'figmaImagesQuery' ? string[][] : FigmaIconNodeWithURL[];
+}
+/**
+ * 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 { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

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

@@ -2,7 +2,7 @@ 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 { FigmaNodesImportResult, FigmaIconNode } from './types/result.js';
 import '../../icon-set/index.js';
 import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';
@@ -12,6 +12,19 @@ import 'cheerio';
 import '@iconify/utils/lib/icon-set/tree';
 import './types/nodes.js';
 
+/**
+ * Extra parameters added to runConcurrentQueries()
+ *
+ * Can be used to identify failed items in onfail callback
+ */
+interface FigmaIconNodeWithURL extends FigmaIconNode {
+    url: string;
+}
+type FigmaConcurrentQueriesParamsFunction = 'figmaImagesQuery' | 'figmaDownloadImages';
+interface FigmaConcurrentQueriesParams<T extends FigmaConcurrentQueriesParamsFunction> {
+    function: T;
+    payload: T extends 'figmaImagesQuery' ? string[][] : FigmaIconNodeWithURL[];
+}
 /**
  * Get Figma files
  */
@@ -26,4 +39,4 @@ declare function figmaImagesQuery(options: FigmaImagesQueryOptions, nodes: Figma
  */
 declare function figmaDownloadImages(nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
 
-export { figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };
+export { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };