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

package/lib/download/api/config.cjs

@@ -3,5 +3,9 @@
 const axiosConfig = {
   // Empty by default. Add properties
 };
+const fetchCallbacks = {
+  onStart: (url) => console.log("Fetching:", url)
+};
 
 exports.axiosConfig = axiosConfig;
+exports.fetchCallbacks = fetchCallbacks;

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

@@ -1,8 +1,18 @@
 import { AxiosRequestConfig } from 'axios';
+import { APIQueryParams } from './types.js';
 
 /**
  * Axios config, customisable
  */
-declare const axiosConfig: AxiosRequestConfig;
+declare const axiosConfig: Omit<AxiosRequestConfig, 'headers' | 'responseType' | 'url' | 'method' | 'data'>;
+interface AxiosCallbacks {
+    onStart?: (url: string, params: APIQueryParams) => void;
+    onSuccess?: (url: string, params: APIQueryParams) => void;
+    onError?: (url: string, params: APIQueryParams, errorCode?: number) => void;
+}
+/**
+ * Customisable callbacks, used for logging
+ */
+declare const fetchCallbacks: AxiosCallbacks;
 
-export { axiosConfig };
+export { axiosConfig, fetchCallbacks };

package/lib/download/api/config.mjs

@@ -1,5 +1,8 @@
 const axiosConfig = {
   // Empty by default. Add properties
 };
+const fetchCallbacks = {
+  onStart: (url) => console.log("Fetching:", url)
+};
 
-export { axiosConfig };
+export { axiosConfig, fetchCallbacks };

package/lib/download/api/download.cjs

@@ -12,15 +12,18 @@ async function downloadFile(query, target) {
   const params = query.params ? query.params.toString() : "";
   const url = query.uri + (params ? "?" + params : "");
   const headers = query.headers;
+  download_api_config.fetchCallbacks.onStart?.(url, query);
   const response = await axios__default.get(url, {
     ...download_api_config.axiosConfig,
     headers,
     responseType: "arraybuffer"
   });
   if (response.status !== 200) {
+    download_api_config.fetchCallbacks.onError?.(url, query, response.status);
     throw new Error(`Error downloading ${url}: ${response.status}`);
   }
   const data = response.data;
+  download_api_config.fetchCallbacks.onSuccess?.(url, query);
   await promises.writeFile(target, Buffer.from(data));
 }
 

package/lib/download/api/download.mjs

@@ -1,20 +1,23 @@
 import axios from 'axios';
 import { writeFile } from 'fs/promises';
-import { axiosConfig } from './config.mjs';
+import { fetchCallbacks, axiosConfig } from './config.mjs';
 
 async function downloadFile(query, target) {
   const params = query.params ? query.params.toString() : "";
   const url = query.uri + (params ? "?" + params : "");
   const headers = query.headers;
+  fetchCallbacks.onStart?.(url, query);
   const response = await axios.get(url, {
     ...axiosConfig,
     headers,
     responseType: "arraybuffer"
   });
   if (response.status !== 200) {
+    fetchCallbacks.onError?.(url, query, response.status);
     throw new Error(`Error downloading ${url}: ${response.status}`);
   }
   const data = response.data;
+  fetchCallbacks.onSuccess?.(url, query);
   await writeFile(target, Buffer.from(data));
 }
 

package/lib/download/api/index.cjs

@@ -32,8 +32,12 @@ async function sendAPIQuery(query, cache) {
 async function sendQuery(query) {
   const params = query.params ? query.params.toString() : "";
   const url = query.uri + (params ? "?" + params : "");
-  console.log("Fetch:", url);
   const headers = query.headers;
+  download_api_config.fetchCallbacks.onStart?.(url, query);
+  function fail(value) {
+    download_api_config.fetchCallbacks.onError?.(url, query, value);
+    return value ?? 404;
+  }
   try {
     const response = await axios__default.get(url, {
       ...download_api_config.axiosConfig,
@@ -41,14 +45,15 @@ async function sendQuery(query) {
       responseType: "text"
     });
     if (response.status !== 200) {
-      return response.status;
+      return fail(response.status);
     }
     if (typeof response.data !== "string") {
-      return 404;
+      return fail();
     }
+    download_api_config.fetchCallbacks.onSuccess?.(url, query);
     return response.data;
   } catch (err) {
-    return 404;
+    return fail();
   }
 }
 

package/lib/download/api/index.mjs

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { apiCacheKey, getAPICache, storeAPICache } from './cache.mjs';
-import { axiosConfig } from './config.mjs';
+import { fetchCallbacks, axiosConfig } from './config.mjs';
 import 'fs';
 import 'crypto';
 import '../../misc/scan.mjs';
@@ -26,8 +26,12 @@ async function sendAPIQuery(query, cache) {
 async function sendQuery(query) {
   const params = query.params ? query.params.toString() : "";
   const url = query.uri + (params ? "?" + params : "");
-  console.log("Fetch:", url);
   const headers = query.headers;
+  fetchCallbacks.onStart?.(url, query);
+  function fail(value) {
+    fetchCallbacks.onError?.(url, query, value);
+    return value ?? 404;
+  }
   try {
     const response = await axios.get(url, {
       ...axiosConfig,
@@ -35,14 +39,15 @@ async function sendQuery(query) {
       responseType: "text"
     });
     if (response.status !== 200) {
-      return response.status;
+      return fail(response.status);
     }
     if (typeof response.data !== "string") {
-      return 404;
+      return fail();
     }
+    fetchCallbacks.onSuccess?.(url, query);
     return response.data;
   } catch (err) {
-    return 404;
+    return fail();
   }
 }
 

package/lib/download/api/queue.cjs

@@ -44,10 +44,10 @@ function runConcurrentQueries(params) {
           resolvedItem();
         }
       }
-      if (allParams.onFail) {
+      if (allParams.onError) {
         let retry;
         try {
-          retry = allParams.onFail(index, err, params);
+          retry = allParams.onError(index, err, params);
         } catch (err2) {
           err = err2;
           done(true);
@@ -70,9 +70,11 @@ function runConcurrentQueries(params) {
     function run(index, retry) {
       resolving.add(index);
       const p = isCallback ? paramsWithCount.callback(index) : paramsWithPromises.promises[index];
+      allParams.onStart?.(index, params);
       p.then((value) => {
         resolving.delete(index);
         results[index] = value;
+        allParams.onSuccess?.(index, params, value);
         resolvedItem();
       }).catch((err) => {
         if (retry < retries) {

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

@@ -12,7 +12,9 @@ type GetConcurrentQueryCallback<T> = (index: number) => Promise<T>;
 interface ConcurrentQueriesCommonParams<T> {
     limit?: number;
     retries?: number;
-    onFail?: (index: number, error: unknown, params: ConcurrentQueriesParams<T>) => void | Promise<void>;
+    onError?: (index: number, error: unknown, params: ConcurrentQueriesParams<T>) => void | Promise<void>;
+    onSuccess?: (index: number, params: ConcurrentQueriesParams<T>, result: T) => void;
+    onStart?: (index: number, params: ConcurrentQueriesParams<T>) => void;
 }
 interface ConcurrentQueriesParamsWithCount<T> extends ConcurrentQueriesCommonParams<T> {
     total: number;

package/lib/download/api/queue.mjs

@@ -42,10 +42,10 @@ function runConcurrentQueries(params) {
           resolvedItem();
         }
       }
-      if (allParams.onFail) {
+      if (allParams.onError) {
         let retry;
         try {
-          retry = allParams.onFail(index, err, params);
+          retry = allParams.onError(index, err, params);
         } catch (err2) {
           err = err2;
           done(true);
@@ -68,9 +68,11 @@ function runConcurrentQueries(params) {
     function run(index, retry) {
       resolving.add(index);
       const p = isCallback ? paramsWithCount.callback(index) : paramsWithPromises.promises[index];
+      allParams.onStart?.(index, params);
       p.then((value) => {
         resolving.delete(index);
         results[index] = value;
+        allParams.onSuccess?.(index, params, value);
         resolvedItem();
       }).catch((err) => {
         if (retry < retries) {

package/lib/index.cjs

@@ -51,6 +51,7 @@ const misc_keyword = require('./misc/keyword.cjs');
 const misc_bumpVersion = require('./misc/bump-version.cjs');
 const download_api_config = require('./download/api/config.cjs');
 const download_api_index = require('./download/api/index.cjs');
+const download_api_queue = require('./download/api/queue.cjs');
 require('cheerio');
 require('@iconify/utils');
 require('./css/parse.cjs');
@@ -80,7 +81,6 @@ require('./import/figma/query.cjs');
 require('./download/api/cache.cjs');
 require('fs');
 require('crypto');
-require('./download/api/queue.cjs');
 require('axios');
 require('pathe');
 require('child_process');
@@ -147,4 +147,7 @@ exports.execAsync = misc_exec.execAsync;
 exports.cleanupIconKeyword = misc_keyword.cleanupIconKeyword;
 exports.bumpVersion = misc_bumpVersion.bumpVersion;
 exports.axiosConfig = download_api_config.axiosConfig;
+exports.fetchCallbacks = download_api_config.fetchCallbacks;
 exports.sendAPIQuery = download_api_index.sendAPIQuery;
+exports.defaultQueueParams = download_api_queue.defaultQueueParams;
+exports.runConcurrentQueries = download_api_queue.runConcurrentQueries;

package/lib/index.d.ts

@@ -47,8 +47,9 @@ export { untar } from './download/helpers/untar.js';
 export { execAsync } from './misc/exec.js';
 export { cleanupIconKeyword } from './misc/keyword.js';
 export { bumpVersion } from './misc/bump-version.js';
-export { axiosConfig } from './download/api/config.js';
+export { axiosConfig, fetchCallbacks } from './download/api/config.js';
 export { sendAPIQuery } from './download/api/index.js';
+export { defaultQueueParams, runConcurrentQueries } from './download/api/queue.js';
 import 'cheerio';
 import '@iconify/types';
 import '@iconify/utils/lib/customisations/defaults';

package/lib/index.mjs

@@ -47,8 +47,9 @@ export { untar } from './download/helpers/untar.mjs';
 export { execAsync } from './misc/exec.mjs';
 export { cleanupIconKeyword } from './misc/keyword.mjs';
 export { bumpVersion } from './misc/bump-version.mjs';
-export { axiosConfig } from './download/api/config.mjs';
+export { axiosConfig, fetchCallbacks } from './download/api/config.mjs';
 export { sendAPIQuery } from './download/api/index.mjs';
+export { defaultQueueParams, runConcurrentQueries } from './download/api/queue.mjs';
 import 'cheerio';
 import '@iconify/utils';
 import './css/parse.mjs';
@@ -78,7 +79,6 @@ import './import/figma/query.mjs';
 import './download/api/cache.mjs';
 import 'fs';
 import 'crypto';
-import './download/api/queue.mjs';
 import 'axios';
 import 'pathe';
 import 'child_process';

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": "4.0.0-beta.4",
+  "version": "4.0.0-beta.5",
   "publishConfig": {
     "tag": "next"
   },