@iconify/tools 4.2.0 → 5.0.0-beta.1

package/lib/import/figma/query.cjs

@@ -1,260 +0,0 @@
-'use strict';
-
-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('../../download/api/config.cjs');
-require('../../download/api/fetch.cjs');
-require('fs');
-require('crypto');
-require('../../misc/scan.cjs');
-
-function identicalDates(actual, expected) {
-  if (typeof actual !== "string") {
-    return false;
-  }
-  if (actual === expected) {
-    return true;
-  }
-  return new Date(actual).toString() === new Date(expected).toString();
-}
-async function figmaFilesQuery(options, cache) {
-  if (!options.token) {
-    throw new Error("Missing Figma API token");
-  }
-  const params = new URLSearchParams();
-  if (options.ids) {
-    params.set("ids", options.ids.join(","));
-  }
-  if (options.version) {
-    params.set("version", options.version);
-  }
-  if (options.depth) {
-    params.set("depth", options.depth.toString());
-  }
-  const queryParams = {
-    uri: "https://api.figma.com/v1/files/" + options.file,
-    params,
-    headers: {
-      "X-FIGMA-TOKEN": options.token
-    }
-  };
-  const isModified = async () => {
-    if (!cache || !options.ifModifiedSince) {
-      return true;
-    }
-    const cacheKey = download_api_cache.apiCacheKey(queryParams);
-    const cachedData = await download_api_cache.getAPICache(cache.dir, cacheKey);
-    if (!cachedData) {
-      return true;
-    }
-    let ifModifiedSince;
-    if (options.ifModifiedSince === true) {
-      try {
-        const parsedData2 = JSON.parse(cachedData);
-        if (typeof parsedData2.lastModified !== "string") {
-          await download_api_cache.clearAPICache(cache.dir);
-          return true;
-        }
-        ifModifiedSince = parsedData2.lastModified;
-      } catch (err) {
-        await download_api_cache.clearAPICache(cache.dir);
-        return true;
-      }
-    } else {
-      ifModifiedSince = options.ifModifiedSince;
-    }
-    const versionCheckParams = {
-      ...queryParams,
-      params: new URLSearchParams(params)
-    };
-    versionCheckParams.params.set("depth", "1");
-    const data2 = await download_api_index.sendAPIQuery(versionCheckParams);
-    try {
-      if (typeof data2 === "string") {
-        const parsedData2 = JSON.parse(data2);
-        if (identicalDates(parsedData2.lastModified, ifModifiedSince)) {
-          return false;
-        }
-      }
-    } catch (err) {
-    }
-    await download_api_cache.clearAPICache(cache.dir);
-    return true;
-  };
-  if (!await isModified()) {
-    return "not_modified";
-  }
-  const data = await download_api_index.sendAPIQuery(queryParams, cache);
-  if (typeof data === "number") {
-    throw new Error(`Error retrieving document from API: ${data}`);
-  }
-  let parsedData;
-  try {
-    parsedData = JSON.parse(data);
-  } catch (err) {
-    throw new Error(`Error retrieving document from API: invalid data`);
-  }
-  if (typeof parsedData.status === "number") {
-    const figmaError = parsedData;
-    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}`
-    );
-  }
-  if (identicalDates(options.ifModifiedSince, document.lastModified)) {
-    return "not_modified";
-  }
-  return document;
-}
-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 || {};
-  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);
-      }
-      params.set(
-        "svg_include_id",
-        svgOptions.includeID ? "true" : "false"
-      );
-      params.set(
-        "svg_simplify_stroke",
-        svgOptions.simplifyStroke ? "true" : "false"
-      );
-      params.set(
-        "use_absolute_bounds",
-        svgOptions.useAbsoluteBounds ? "true" : "false"
-      );
-      download_api_index.sendAPIQuery(
-        {
-          uri,
-          params,
-          headers: {
-            "X-FIGMA-TOKEN": options.token
-          }
-        },
-        cache
-      ).then((data) => {
-        if (typeof data === "number") {
-          reject(data);
-          return;
-        }
-        let parsedData;
-        try {
-          parsedData = JSON.parse(data);
-        } catch {
-          reject("Bad API response");
-          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) {
-      queue.push(ids.slice(0));
-      ids = [];
-      idsLength = 0;
-    }
-  }
-  if (idsLength) {
-    queue.push(ids.slice(0));
-  }
-  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;
-}
-async function figmaDownloadImages(nodes, cache) {
-  const icons = nodes.icons;
-  const ids = Object.keys(icons);
-  let count = 0;
-  const filtered = [];
-  for (let i = 0; i < ids.length; i++) {
-    const id = ids[i];
-    const item = icons[id];
-    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");
-  }
-  nodes.downloadedIconsCount = count;
-  return nodes;
-}
-
-exports.figmaDownloadImages = figmaDownloadImages;
-exports.figmaFilesQuery = figmaFilesQuery;
-exports.figmaImagesQuery = figmaImagesQuery;

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

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

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

@@ -1,256 +0,0 @@
-import { sendAPIQuery } from '../../download/api/index.mjs';
-import { apiCacheKey, getAPICache, clearAPICache } from '../../download/api/cache.mjs';
-import { runConcurrentQueries } from '../../download/api/queue.mjs';
-import '../../download/api/config.mjs';
-import '../../download/api/fetch.mjs';
-import 'fs';
-import 'crypto';
-import '../../misc/scan.mjs';
-
-function identicalDates(actual, expected) {
-  if (typeof actual !== "string") {
-    return false;
-  }
-  if (actual === expected) {
-    return true;
-  }
-  return new Date(actual).toString() === new Date(expected).toString();
-}
-async function figmaFilesQuery(options, cache) {
-  if (!options.token) {
-    throw new Error("Missing Figma API token");
-  }
-  const params = new URLSearchParams();
-  if (options.ids) {
-    params.set("ids", options.ids.join(","));
-  }
-  if (options.version) {
-    params.set("version", options.version);
-  }
-  if (options.depth) {
-    params.set("depth", options.depth.toString());
-  }
-  const queryParams = {
-    uri: "https://api.figma.com/v1/files/" + options.file,
-    params,
-    headers: {
-      "X-FIGMA-TOKEN": options.token
-    }
-  };
-  const isModified = async () => {
-    if (!cache || !options.ifModifiedSince) {
-      return true;
-    }
-    const cacheKey = apiCacheKey(queryParams);
-    const cachedData = await getAPICache(cache.dir, cacheKey);
-    if (!cachedData) {
-      return true;
-    }
-    let ifModifiedSince;
-    if (options.ifModifiedSince === true) {
-      try {
-        const parsedData2 = JSON.parse(cachedData);
-        if (typeof parsedData2.lastModified !== "string") {
-          await clearAPICache(cache.dir);
-          return true;
-        }
-        ifModifiedSince = parsedData2.lastModified;
-      } catch (err) {
-        await clearAPICache(cache.dir);
-        return true;
-      }
-    } else {
-      ifModifiedSince = options.ifModifiedSince;
-    }
-    const versionCheckParams = {
-      ...queryParams,
-      params: new URLSearchParams(params)
-    };
-    versionCheckParams.params.set("depth", "1");
-    const data2 = await sendAPIQuery(versionCheckParams);
-    try {
-      if (typeof data2 === "string") {
-        const parsedData2 = JSON.parse(data2);
-        if (identicalDates(parsedData2.lastModified, ifModifiedSince)) {
-          return false;
-        }
-      }
-    } catch (err) {
-    }
-    await clearAPICache(cache.dir);
-    return true;
-  };
-  if (!await isModified()) {
-    return "not_modified";
-  }
-  const data = await sendAPIQuery(queryParams, cache);
-  if (typeof data === "number") {
-    throw new Error(`Error retrieving document from API: ${data}`);
-  }
-  let parsedData;
-  try {
-    parsedData = JSON.parse(data);
-  } catch (err) {
-    throw new Error(`Error retrieving document from API: invalid data`);
-  }
-  if (typeof parsedData.status === "number") {
-    const figmaError = parsedData;
-    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}`
-    );
-  }
-  if (identicalDates(options.ifModifiedSince, document.lastModified)) {
-    return "not_modified";
-  }
-  return document;
-}
-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 || {};
-  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);
-      }
-      params.set(
-        "svg_include_id",
-        svgOptions.includeID ? "true" : "false"
-      );
-      params.set(
-        "svg_simplify_stroke",
-        svgOptions.simplifyStroke ? "true" : "false"
-      );
-      params.set(
-        "use_absolute_bounds",
-        svgOptions.useAbsoluteBounds ? "true" : "false"
-      );
-      sendAPIQuery(
-        {
-          uri,
-          params,
-          headers: {
-            "X-FIGMA-TOKEN": options.token
-          }
-        },
-        cache
-      ).then((data) => {
-        if (typeof data === "number") {
-          reject(data);
-          return;
-        }
-        let parsedData;
-        try {
-          parsedData = JSON.parse(data);
-        } catch {
-          reject("Bad API response");
-          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) {
-      queue.push(ids.slice(0));
-      ids = [];
-      idsLength = 0;
-    }
-  }
-  if (idsLength) {
-    queue.push(ids.slice(0));
-  }
-  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;
-}
-async function figmaDownloadImages(nodes, cache) {
-  const icons = nodes.icons;
-  const ids = Object.keys(icons);
-  let count = 0;
-  const filtered = [];
-  for (let i = 0; i < ids.length; i++) {
-    const id = ids[i];
-    const item = icons[id];
-    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");
-  }
-  nodes.downloadedIconsCount = count;
-  return nodes;
-}
-
-export { figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

package/lib/import/figma/types/api.cjs

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

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

@@ -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 type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

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

@@ -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 type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };