chore: add filter option to unzip

Author: cyberalien

@iconify/tools/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.2",
+	"version": "5.0.0-beta.3",
 	"publishConfig": {
 		"tag": "next"
 	},

@iconify/tools/src/download/github/index.ts

@@ -7,12 +7,15 @@ import type { DocumentNotModified } from '../types/modified';
 import { getGitHubRepoHash } from './hash';
 import type { GitHubAPIOptions } from './types';
 import { downloadFile } from '../api/download';
-import { unzip } from '../helpers/unzip';
+import { unzip, type UnzipFilterCallback } from '../helpers/unzip';
 import type { DownloadSourceMixin } from '../types/sources';
 
 interface IfModifiedSinceOption {
 	// Download only if it was modified since hash
 	ifModifiedSince: string | DownloadGitHubRepoResult;
+
+	// Filter files
+	filter?: UnzipFilterCallback;
 }
 
 /**
@@ -72,7 +75,7 @@ async function findMatchingDirs(
  * Download GitHub repo using API
  */
 export async function downloadGitHubRepo<
-	T extends IfModifiedSinceOption & DownloadGitHubRepoOptions
+	T extends IfModifiedSinceOption & DownloadGitHubRepoOptions,
 >(options: T): Promise<DownloadGitHubRepoResult | DocumentNotModified>;
 export async function downloadGitHubRepo(
 	options: DownloadGitHubRepoOptions
@@ -89,8 +92,8 @@ export async function downloadGitHubRepo(
 			typeof ifModifiedSince === 'string'
 				? ifModifiedSince
 				: ifModifiedSince.downloadType === 'github'
-				? ifModifiedSince.hash
-				: null;
+					? ifModifiedSince.hash
+					: null;
 		if (hash === expectedHash) {
 			return 'not_modified';
 		}
@@ -110,7 +113,7 @@ export async function downloadGitHubRepo(
 	try {
 		const stat = await fs.stat(archiveTarget);
 		exists = stat.isFile();
-	} catch (err) {
+	} catch {
 		//
 	}
 
@@ -156,14 +159,14 @@ export async function downloadGitHubRepo(
 					force: true,
 					recursive: true,
 				});
-			} catch (err) {
+			} catch {
 				//
 			}
 		}
 	}
 
 	// Unpack it
-	await unzip(archiveTarget, rootDir);
+	await unzip(archiveTarget, rootDir, options.filter);
 
 	// Get actual dir
 	const matchingDirs = await findMatchingDirs(rootDir, hash);

@iconify/tools/src/download/gitlab/index.ts

@@ -7,12 +7,15 @@ import type { DocumentNotModified } from '../types/modified';
 import { getGitLabRepoHash } from './hash';
 import { defaultGitLabBaseURI, GitLabAPIOptions } from './types';
 import { downloadFile } from '../api/download';
-import { unzip } from '../helpers/unzip';
+import { unzip, type UnzipFilterCallback } from '../helpers/unzip';
 import type { DownloadSourceMixin } from '../types/sources';
 
 interface IfModifiedSinceOption {
 	// Download only if it was modified since hash
 	ifModifiedSince: string | DownloadGitLabRepoResult;
+
+	// Filter files
+	filter?: UnzipFilterCallback;
 }
 
 /**
@@ -72,7 +75,7 @@ async function findMatchingDirs(
  * Download GitLab repo using API
  */
 export async function downloadGitLabRepo<
-	T extends IfModifiedSinceOption & DownloadGitLabRepoOptions
+	T extends IfModifiedSinceOption & DownloadGitLabRepoOptions,
 >(options: T): Promise<DownloadGitLabRepoResult | DocumentNotModified>;
 export async function downloadGitLabRepo(
 	options: DownloadGitLabRepoOptions
@@ -89,8 +92,8 @@ export async function downloadGitLabRepo(
 			typeof ifModifiedSince === 'string'
 				? ifModifiedSince
 				: ifModifiedSince.downloadType === 'gitlab'
-				? ifModifiedSince.hash
-				: null;
+					? ifModifiedSince.hash
+					: null;
 		if (hash === expectedHash) {
 			return 'not_modified';
 		}
@@ -110,7 +113,7 @@ export async function downloadGitLabRepo(
 	try {
 		const stat = await fs.stat(archiveTarget);
 		exists = stat.isFile();
-	} catch (err) {
+	} catch {
 		//
 	}
 
@@ -156,14 +159,14 @@ export async function downloadGitLabRepo(
 					force: true,
 					recursive: true,
 				});
-			} catch (err) {
+			} catch {
 				//
 			}
 		}
 	}
 
 	// Unpack it
-	await unzip(archiveTarget, rootDir);
+	await unzip(archiveTarget, rootDir, options.filter);
 
 	// Get actual dir
 	const matchingDirs = await findMatchingDirs(rootDir, hash);

@iconify/tools/src/download/helpers/unzip.ts

@@ -2,10 +2,16 @@ import { unzip as unzipAsync } from 'fflate';
 import { readFile, mkdir, writeFile } from 'node:fs/promises';
 import { dirname, join, normalize } from 'pathe';
 
+export type UnzipFilterCallback = (file: string) => boolean;
+
 /**
  * Unzip archive
  */
-export async function unzip(source: string, path: string): Promise<void> {
+export async function unzip(
+	source: string,
+	path: string,
+	filter?: UnzipFilterCallback
+): Promise<void> {
 	const dir = normalize(path);
 	const data = await readFile(source);
 
@@ -15,8 +21,12 @@ export async function unzip(source: string, path: string): Promise<void> {
 	): Promise<void> {
 		const createdDirs = new Set<string>();
 		for (const name in data) {
-			// const content = data[name];
 			const filePath = normalize(join(dir, name));
+			if (filter && !filter(filePath)) {
+				continue;
+			}
+
+			// Check path
 			if (
 				filePath.startsWith('/') ||
 				filePath.includes('..') ||