@iconify/tools 5.0.0-beta.4 → 5.0.0-beta.5

package/lib/download/api/index.d.ts

@@ -1,6 +1,6 @@
-import { APICacheOptions, APIQueryParams } from "./types.js";
+import { APICacheOptions, APIQueryParams, APIQueryResult } from "./types.js";
 /**
  * Send API query
  */
-declare function sendAPIQuery(query: APIQueryParams, cache?: APICacheOptions): Promise<number | string>;
+declare function sendAPIQuery(query: APIQueryParams, cache?: APICacheOptions): Promise<APIQueryResult>;
 export { sendAPIQuery };

package/lib/download/api/index.js

@@ -9,15 +9,18 @@ async function sendAPIQuery(query, cache) {
 	const cacheKey = cache ? apiCacheKey(query) : "";
 	if (cache) {
 		const cached = await getAPICache(cache.dir, cacheKey);
-		if (cached) return cached;
+		if (cached) return {
+			success: true,
+			content: cached
+		};
 	}
-	const result = await sendQuery(query);
-	if (cache && typeof result !== "number") try {
-		await storeAPICache(cache, cacheKey, result);
-	} catch (err) {
+	const response = await sendQuery(query);
+	if (cache && response.success) try {
+		await storeAPICache(cache, cacheKey, response.content);
+	} catch {
 		console.error("Error writing API cache");
 	}
-	return result;
+	return response;
 }
 /**
 * Send query
@@ -27,9 +30,13 @@ async function sendQuery(query) {
 	const url = query.uri + (params ? "?" + params : "");
 	const headers = query.headers;
 	fetchCallbacks.onStart?.(url, query);
-	function fail(value) {
-		fetchCallbacks.onError?.(url, query, value);
-		return value ?? 404;
+	function fail(response, status) {
+		fetchCallbacks.onError?.(url, query, status);
+		return {
+			success: false,
+			response,
+			error: status ?? 404
+		};
 	}
 	const fetch = getFetch();
 	try {
@@ -37,12 +44,15 @@ async function sendQuery(query) {
 			...axiosConfig,
 			headers
 		});
-		if (response.status !== 200) return fail(response.status);
+		if (response.status !== 200) return fail(response, response.status);
 		const data = await response.text();
-		if (typeof data !== "string") return fail();
+		if (typeof data !== "string") return fail(response);
 		fetchCallbacks.onSuccess?.(url, query);
-		return data;
-	} catch (err) {
+		return {
+			success: true,
+			content: data
+		};
+	} catch {
 		return fail();
 	}
 }

package/lib/download/api/types.d.ts

@@ -13,4 +13,17 @@ interface APIQueryParams {
   params?: URLSearchParams;
   headers?: Record<string, string>;
 }
-export { APICacheOptions, APIQueryParams };
+/**
+ * Query result
+ */
+interface APIQuerySuccess {
+  success: true;
+  content: string;
+}
+interface APIQueryFailure {
+  success: false;
+  response?: Response;
+  error: number;
+}
+type APIQueryResult = APIQuerySuccess | APIQueryFailure;
+export { APICacheOptions, APIQueryParams, APIQueryResult };

package/lib/download/github/hash.js

@@ -4,15 +4,15 @@ import { sendAPIQuery } from "../api/index.js";
 * Get latest hash from GitHub using API
 */
 async function getGitHubRepoHash(options) {
-	const data = await sendAPIQuery({
+	const response = await sendAPIQuery({
 		uri: `https://api.github.com/repos/${options.user}/${options.repo}/branches/${options.branch}`,
 		headers: {
 			Accept: "application/vnd.github.v3+json",
 			Authorization: "token " + options.token
 		}
 	});
-	if (typeof data !== "string") throw new Error(`Error downloading data from GitHub API: ${data}`);
-	const hash = JSON.parse(data)?.commit?.sha;
+	if (!response.success) throw new Error(`Error downloading data from GitHub API: ${response.error}`);
+	const hash = JSON.parse(response.content)?.commit?.sha;
 	if (typeof hash !== "string") throw new Error("Error parsing GitHub API response");
 	return hash;
 }

package/lib/download/gitlab/hash.js

@@ -5,12 +5,12 @@ import { defaultGitLabBaseURI } from "./types.js";
 * Get latest hash from GitHub using API
 */
 async function getGitLabRepoHash(options) {
-	const data = await sendAPIQuery({
+	const response = await sendAPIQuery({
 		uri: `${options.uri || defaultGitLabBaseURI}/${options.project}/repository/branches/${options.branch}/`,
 		headers: { Authorization: "token " + options.token }
 	});
-	if (typeof data !== "string") throw new Error(`Error downloading data from GitLab API: ${data}`);
-	const content = JSON.parse(data);
+	if (!response.success) throw new Error(`Error downloading data from GitLab API: ${response.error}`);
+	const content = JSON.parse(response.content);
 	const item = (content instanceof Array ? content : [content]).find((item$1) => item$1.name === options.branch && typeof item$1.commit.id === "string");
 	if (!item) throw new Error("Error parsing GitLab API response");
 	return item.commit.id;

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

@@ -0,0 +1,5 @@
+/**
+ * Get error message from Figma API response
+ */
+declare function getFigmaErrorMessage(status: number, response?: Response): string;
+export { getFigmaErrorMessage };

package/lib/import/figma/error.js

@@ -0,0 +1,14 @@
+/**
+* Get error message from Figma API response
+*/
+function getFigmaErrorMessage(status, response) {
+	if (response) switch (status) {
+		case 429: {
+			const retryAfter = response.headers.get("Retry-After");
+			return `Error retrieving document from API: rate limit exceeded.${retryAfter ? ` Try again after ${retryAfter} seconds.` : ""}`;
+		}
+	}
+	return `Error retrieving document from API: ${status}`;
+}
+
+export { getFigmaErrorMessage };

package/lib/import/figma/query.js

@@ -1,6 +1,7 @@
 import { apiCacheKey, clearAPICache, getAPICache } from "../../download/api/cache.js";
 import { sendAPIQuery } from "../../download/api/index.js";
 import { runConcurrentQueries } from "../../download/api/queue.js";
+import { getFigmaErrorMessage } from "./error.js";
 
 /**
 * Compare last modified dates
@@ -34,7 +35,7 @@ async function figmaFilesQuery(options, cache) {
 				return true;
 			}
 			ifModifiedSince = parsedData$1.lastModified;
-		} catch (err) {
+		} catch {
 			await clearAPICache(cache.dir);
 			return true;
 		}
@@ -44,22 +45,22 @@ async function figmaFilesQuery(options, cache) {
 			params: new URLSearchParams(params)
 		};
 		versionCheckParams.params.set("depth", "1");
-		const data$1 = await sendAPIQuery(versionCheckParams);
+		const response$1 = await sendAPIQuery(versionCheckParams);
 		try {
-			if (typeof data$1 === "string") {
-				if (identicalDates(JSON.parse(data$1).lastModified, ifModifiedSince)) return false;
+			if (response$1.success) {
+				if (identicalDates(JSON.parse(response$1.content).lastModified, ifModifiedSince)) return false;
 			}
-		} catch (err) {}
+		} catch {}
 		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}`);
+	const response = await sendAPIQuery(queryParams, cache);
+	if (!response.success) throw new Error(getFigmaErrorMessage(response.error, response.response));
 	let parsedData;
 	try {
-		parsedData = JSON.parse(data);
-	} catch (err) {
+		parsedData = JSON.parse(response.content);
+	} catch {
 		throw new Error(`Error retrieving document from API: invalid data`);
 	}
 	if (typeof parsedData.status === "number") {
@@ -92,14 +93,14 @@ async function figmaImagesQuery(options, nodes, cache) {
 				uri,
 				params,
 				headers: { "X-FIGMA-TOKEN": options.token }
-			}, cache).then((data) => {
-				if (typeof data === "number") {
-					reject(data);
+			}, cache).then((response) => {
+				if (!response.success) {
+					reject(getFigmaErrorMessage(response.error, response.response));
 					return;
 				}
 				let parsedData;
 				try {
-					parsedData = JSON.parse(data);
+					parsedData = JSON.parse(response.content);
 				} catch {
 					reject("Bad API response");
 					return;

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "description": "Collection of functions for cleaning up and parsing SVG for Iconify project",
   "author": "Vjacheslav Trushkin",
-  "version": "5.0.0-beta.4",
+  "version": "5.0.0-beta.5",
   "publishConfig": {
     "tag": "next"
   },
@@ -285,6 +285,10 @@
       "types": "./lib/import/figma/index.d.ts",
       "import": "./lib/import/figma/index.js"
     },
+    "./lib/import/figma/error": {
+      "types": "./lib/import/figma/error.d.ts",
+      "import": "./lib/import/figma/error.js"
+    },
     "./lib/import/figma/index": {
       "types": "./lib/import/figma/index.d.ts",
       "import": "./lib/import/figma/index.js"