@iconify/tools 3.0.1 → 3.0.3

package/README.md

@@ -93,4 +93,4 @@ If you need to import or parse icons synchronously, such as in config file of pa
 
 Library is released with MIT license.
 
-© 2021 Vjacheslav Trushkin
+© 2021-PRESENT Vjacheslav Trushkin

package/lib/export/json-package.cjs

@@ -58,6 +58,7 @@ async function exportJSONPackage(iconSet, options) {
   const packageJSONExports = {
     "./*": "./*",
     ".": {
+      types: "./index.d.ts",
       require: "./index.js",
       import: "./index.mjs"
     }

package/lib/export/json-package.mjs

@@ -56,6 +56,7 @@ async function exportJSONPackage(iconSet, options) {
   const packageJSONExports = {
     "./*": "./*",
     ".": {
+      types: "./index.d.ts",
       require: "./index.js",
       import: "./index.mjs"
     }

package/lib/import/directory.cjs

@@ -72,15 +72,19 @@ function isValidFile(item) {
 }
 function importDirectory(path, options = {}) {
   return new Promise((fulfill, reject) => {
-    misc_scan.scanDirectory(path, (ext, file, subdir, path2) => {
-      const result = {
-        file,
-        ext,
-        subdir,
-        path: path2
-      };
-      return isValidFile(result) ? result : false;
-    }).then((files) => {
+    misc_scan.scanDirectory(
+      path,
+      (ext, file, subdir, path2) => {
+        const result = {
+          file,
+          ext,
+          subdir,
+          path: path2
+        };
+        return isValidFile(result) ? result : false;
+      },
+      options.includeSubDirs !== false
+    ).then((files) => {
       const iconSet = iconSet_index.blankIconSet(options.prefix || "");
       try {
         importDir(
@@ -111,15 +115,19 @@ function importDirectory(path, options = {}) {
   });
 }
 function importDirectorySync(path, options = {}) {
-  const files = misc_scan.scanDirectorySync(path, (ext, file, subdir, path2) => {
-    const result = {
-      file,
-      ext,
-      subdir,
-      path: path2
-    };
-    return isValidFile(result) ? result : false;
-  });
+  const files = misc_scan.scanDirectorySync(
+    path,
+    (ext, file, subdir, path2) => {
+      const result = {
+        file,
+        ext,
+        subdir,
+        path: path2
+      };
+      return isValidFile(result) ? result : false;
+    },
+    options.includeSubDirs !== false
+  );
   const iconSet = iconSet_index.blankIconSet(options.prefix || "");
   let isSync = true;
   importDir(

package/lib/import/directory.mjs

@@ -70,15 +70,19 @@ function isValidFile(item) {
 }
 function importDirectory(path, options = {}) {
   return new Promise((fulfill, reject) => {
-    scanDirectory(path, (ext, file, subdir, path2) => {
-      const result = {
-        file,
-        ext,
-        subdir,
-        path: path2
-      };
-      return isValidFile(result) ? result : false;
-    }).then((files) => {
+    scanDirectory(
+      path,
+      (ext, file, subdir, path2) => {
+        const result = {
+          file,
+          ext,
+          subdir,
+          path: path2
+        };
+        return isValidFile(result) ? result : false;
+      },
+      options.includeSubDirs !== false
+    ).then((files) => {
       const iconSet = blankIconSet(options.prefix || "");
       try {
         importDir(
@@ -109,15 +113,19 @@ function importDirectory(path, options = {}) {
   });
 }
 function importDirectorySync(path, options = {}) {
-  const files = scanDirectorySync(path, (ext, file, subdir, path2) => {
-    const result = {
-      file,
-      ext,
-      subdir,
-      path: path2
-    };
-    return isValidFile(result) ? result : false;
-  });
+  const files = scanDirectorySync(
+    path,
+    (ext, file, subdir, path2) => {
+      const result = {
+        file,
+        ext,
+        subdir,
+        path: path2
+      };
+      return isValidFile(result) ? result : false;
+    },
+    options.includeSubDirs !== false
+  );
   const iconSet = blankIconSet(options.prefix || "");
   let isSync = true;
   importDir(

package/lib/misc/keyword.cjs

@@ -7,7 +7,7 @@ function cleanupIconKeyword(keyword, convertCamelCase = false) {
       (chars) => "_" + chars.toLowerCase()
     );
   }
-  keyword = keyword.toLowerCase().trim().replace(/[\s_.:]/g, "-").replace(/[^a-z0-9-]/g, "").replace(/[-]+/g, "-");
+  keyword = keyword.toLowerCase().trim().replace(/[\s_.:/\\]/g, "-").replace(/[^a-z0-9-]/g, "").replace(/[-]+/g, "-");
   if (keyword.slice(0, 1) === "-") {
     keyword = keyword.slice(1);
   }

package/lib/misc/keyword.mjs

@@ -5,7 +5,7 @@ function cleanupIconKeyword(keyword, convertCamelCase = false) {
       (chars) => "_" + chars.toLowerCase()
     );
   }
-  keyword = keyword.toLowerCase().trim().replace(/[\s_.:]/g, "-").replace(/[^a-z0-9-]/g, "").replace(/[-]+/g, "-");
+  keyword = keyword.toLowerCase().trim().replace(/[\s_.:/\\]/g, "-").replace(/[^a-z0-9-]/g, "").replace(/[-]+/g, "-");
   if (keyword.slice(0, 1) === "-") {
     keyword = keyword.slice(1);
   }

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Vjacheslav Trushkin
+Copyright (c) 2021-PRESENT Vjacheslav Trushkin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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": "3.0.1",
+  "version": "3.0.3",
   "license": "MIT",
   "bugs": "https://github.com/iconify/tools/issues",
   "homepage": "https://github.com/iconify/tools",
@@ -16,32 +16,32 @@
   "types": "./lib/index.d.ts",
   "dependencies": {
     "@iconify/types": "^2.0.0",
-    "@iconify/utils": "^2.1.5",
+    "@iconify/utils": "^2.1.7",
     "@types/cheerio": "^0.22.31",
-    "@types/tar": "^6.1.4",
+    "@types/tar": "^6.1.5",
     "cheerio": "^1.0.0-rc.12",
     "extract-zip": "^2.0.1",
     "local-pkg": "^0.4.3",
-    "pathe": "^1.1.0",
+    "pathe": "^1.1.1",
     "svgo": "^3.0.2",
-    "tar": "^6.1.13"
+    "tar": "^6.1.15"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
-    "@types/node": "^18.15.11",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
+    "@types/jest": "^29.5.3",
+    "@types/node": "^18.17.3",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.38.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-jasmine": "^4.1.3",
     "eslint-plugin-prettier": "^4.2.1",
-    "jasmine": "^4.6.0",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.7",
-    "rimraf": "^5.0.0",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.0.4",
+    "jasmine": "^5.1.0",
+    "jest": "^29.6.2",
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.1.6",
     "unbuild": "^1.2.1"
   },
   "exports": {

package/lib/colors/attribs.d.ts

@@ -1,27 +0,0 @@
-import { Color } from '@iconify/utils/lib/colors/types';
-
-/**
- * Color attributes
- */
-type CommonColorAttributes = 'color';
-declare const commonColorAttributes: CommonColorAttributes[];
-type ShapeColorAttributes = 'fill' | 'stroke';
-declare const shapeColorAttributes: ShapeColorAttributes[];
-type SpecialColorAttributes = 'stop-color' | 'flood-color';
-declare const specialColorAttributes: SpecialColorAttributes[];
-type ColorAttributes = CommonColorAttributes | ShapeColorAttributes | SpecialColorAttributes;
-/**
- * Default values
- */
-declare const defaultBlackColor: Color;
-declare const defaultColorValues: Record<ColorAttributes, Color>;
-/**
- * Ignore default color for some tags:
- * - If value is true, allow default color
- * - If value is attribute name, allow default color if attribute is set
- *
- * Parent elements are not checked for these tags!
- */
-declare const allowDefaultColorValue: Partial<Record<ColorAttributes, string | true>>;
-
-export { ColorAttributes, CommonColorAttributes, ShapeColorAttributes, SpecialColorAttributes, allowDefaultColorValue, commonColorAttributes, defaultBlackColor, defaultColorValues, shapeColorAttributes, specialColorAttributes };

package/lib/colors/detect.d.ts

@@ -1,15 +0,0 @@
-import { IconSet } from '../icon-set/index.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '../icon-set/types.js';
-import '../svg/index.js';
-import '@iconify/utils/lib/icon-set/tree';
-
-/**
- * Detect palette
- *
- * Returns null if icon set has mixed colors
- */
-declare function detectIconSetPalette(iconSet: IconSet): boolean | null;
-
-export { detectIconSetPalette };

package/lib/colors/parse.d.ts

@@ -1,67 +0,0 @@
-import { Color } from '@iconify/utils/lib/colors/types';
-import { SVG } from '../svg/index.js';
-import { ColorAttributes } from './attribs.js';
-import { ElementsTreeItem, AnalyseSVGStructureResult, ExtendedTagElement, AnalyseSVGStructureOptions } from '../svg/analyse/types.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-
-/**
- * Result
- */
-interface FindColorsResult {
-    colors: (Color | string)[];
-    hasUnsetColor: boolean;
-    hasGlobalStyle: boolean;
-}
-/**
- * Callback to call for each found color
- *
- * Callback should return:
- * - new color value to change color
- * - first parameter to keep old value
- * - 'unset' to delete old value
- * - 'remove' to remove shape or rule
- */
-type ParseColorsCallbackResult = Color | string | 'remove' | 'unset';
-type ParseColorsCallback<T> = (attr: ColorAttributes, colorString: string, parsedColor: Color | null, tagName?: string, item?: ExtendedTagElementWithColors) => T;
-/**
- * Callback for default color
- */
-type ParseColorOptionsDefaultColorCallback = (prop: string, item: ExtendedTagElementWithColors, treeItem: ElementsTreeItem, iconData: AnalyseSVGStructureResult) => Color;
-/**
- * Options
- */
-interface Options<T> extends AnalyseSVGStructureOptions {
-    callback?: T;
-    defaultColor?: Color | string | ParseColorOptionsDefaultColorCallback;
-}
-type ParseColorsOptions = Options<ParseColorsCallback<ParseColorsCallbackResult | Promise<ParseColorsCallbackResult>>>;
-type ParseColorsSyncOptions = Options<ParseColorsCallback<ParseColorsCallbackResult>>;
-/**
- * Extend properties for element
- */
-type ItemColors = Partial<Record<ColorAttributes, Color | string>>;
-interface ExtendedTagElementWithColors extends ExtendedTagElement {
-    _colors?: ItemColors;
-    _removed?: boolean;
-}
-/**
- * Find colors in icon
- *
- * Clean up icon before running this function to convert style to attributes using
- * cleanupInlineStyle() or cleanupSVG(), otherwise results might be inaccurate
- */
-declare function parseColors(svg: SVG, options?: ParseColorsOptions): Promise<FindColorsResult>;
-/**
- * Find colors in icon, synchronous version
- *
- * Clean up icon before running this function to convert style to attributes using
- * cleanupInlineStyle() or cleanupSVG(), otherwise results might be inaccurate
- */
-declare function parseColorsSync(svg: SVG, options?: ParseColorsSyncOptions): FindColorsResult;
-/**
- * Check if color is empty, such as 'none' or 'transparent'
- */
-declare function isEmptyColor(color: Color): boolean;
-
-export { ExtendedTagElementWithColors, FindColorsResult, ParseColorOptionsDefaultColorCallback, ParseColorsOptions, ParseColorsSyncOptions, isEmptyColor, parseColors, parseColorsSync };

package/lib/colors/validate.d.ts

@@ -1,26 +0,0 @@
-import { SVG } from '../svg/index.js';
-import { ParseColorsOptions, FindColorsResult, ParseColorsSyncOptions } from './parse.js';
-import '@iconify/types';
-import '@iconify/utils/lib/customisations/defaults';
-import '@iconify/utils/lib/colors/types';
-import './attribs.js';
-import '../svg/analyse/types.js';
-
-/**
- * Validate colors in icon
- *
- * If icon is monotone,
- *
- * Throws exception on error
- */
-declare function validateColors(svg: SVG, expectMonotone: boolean, options?: ParseColorsOptions): Promise<FindColorsResult>;
-/**
- * Validate colors in icon, synchronous version
- *
- * If icon is monotone,
- *
- * Throws exception on error
- */
-declare function validateColorsSync(svg: SVG, expectMonotone: boolean, options?: ParseColorsSyncOptions): FindColorsResult;
-
-export { validateColors, validateColorsSync };

package/lib/css/parse.d.ts

@@ -1,6 +0,0 @@
-/**
- * Parse inline style
- */
-declare function parseInlineStyle(style: string): Record<string, string> | null;
-
-export { parseInlineStyle };

package/lib/css/parser/error.d.ts

@@ -1,13 +0,0 @@
-interface StyleParseError {
-    type: 'style-parse-error';
-    message: string;
-    code: string;
-    index?: number;
-    fullMessage: string;
-}
-/**
- * Create error message
- */
-declare function styleParseError(message: string, code: string, index?: number): StyleParseError;
-
-export { StyleParseError, styleParseError };

package/lib/css/parser/export.d.ts

@@ -1,8 +0,0 @@
-import { CSSTreeToken } from './types.js';
-
-/**
- * Convert tokens tree to string
- */
-declare function tokensToString(tree: CSSTreeToken[]): string;
-
-export { tokensToString };

package/lib/css/parser/strings.d.ts

@@ -1,16 +0,0 @@
-import { StyleParseError } from './error.js';
-
-/**
- * Find end of quoted string
- *
- * Returns index of character after quote
- */
-declare function findEndOfQuotedString(code: string, quote: string, start: number): number | null;
-/**
- * Find end of url
- *
- * Returns index of character after end of URL
- */
-declare function findEndOfURL(code: string, start: number): number | StyleParseError;
-
-export { findEndOfQuotedString, findEndOfURL };

package/lib/css/parser/text.d.ts

@@ -1,20 +0,0 @@
-import { TextToken, CSSRuleToken, CSSTokenWithSelector } from './types.js';
-
-/**
- * Merge text tokens to string
- */
-declare function mergeTextTokens(tokens: TextToken[]): string;
-/**
- * Get list of selectors from list of words
- */
-declare function getSelectors(tokens: TextToken[]): string[];
-/**
- * Convert text token to rule
- */
-declare function textTokensToRule(tokens: TextToken[]): CSSRuleToken | null;
-/**
- * Create at-rule or selector token from text tokens
- */
-declare function textTokensToSelector(tokens: TextToken[]): CSSTokenWithSelector | null;
-
-export { getSelectors, mergeTextTokens, textTokensToRule, textTokensToSelector };

package/lib/css/parser/tokens.d.ts

@@ -1,9 +0,0 @@
-import { StyleParseError } from './error.js';
-import { CSSToken } from './types.js';
-
-/**
- * Get tokens
- */
-declare function getTokens(css: string): CSSToken[] | StyleParseError;
-
-export { getTokens };

package/lib/css/parser/tree.d.ts

@@ -1,8 +0,0 @@
-import { CSSToken, CSSTreeToken } from './types.js';
-
-/**
- * Convert tokens list to tree
- */
-declare function tokensTree(tokens: CSSToken[]): CSSTreeToken[];
-
-export { tokensTree };

package/lib/css/parser/types.d.ts

@@ -1,52 +0,0 @@
-/**
- * Text tokens, to be split combined into correct tokens later
- */
-interface TextToken {
-    type: 'chunk' | 'url' | 'quoted-string';
-    index: number;
-    text: string;
-}
-/**
- * Values
- */
-type CSSATValue = string | string[];
-/**
- * Tokens
- */
-interface CSSRuleToken {
-    type: 'rule';
-    index: number;
-    prop: string;
-    value: string;
-    important?: boolean;
-}
-interface CSSSelectorToken {
-    type: 'selector';
-    index: number;
-    code: string;
-    selectors: string[];
-}
-interface CSSAtRuleToken {
-    type: 'at-rule';
-    index: number;
-    rule: string;
-    value: string;
-}
-interface CSSCloseToken {
-    type: 'close';
-    index: number;
-}
-type CSSTokenWithSelector = CSSSelectorToken | CSSAtRuleToken;
-type CSSToken = CSSRuleToken | CSSSelectorToken | CSSAtRuleToken | CSSCloseToken;
-/**
- * Tree tokens
- */
-interface CSSSelectorTreeToken extends CSSSelectorToken {
-    children: CSSTreeToken[];
-}
-interface CSSAtRuleTreeToken extends CSSAtRuleToken {
-    children: CSSTreeToken[];
-}
-type CSSTreeToken = CSSRuleToken | CSSSelectorTreeToken | CSSAtRuleTreeToken;
-
-export { CSSATValue, CSSAtRuleToken, CSSAtRuleTreeToken, CSSCloseToken, CSSRuleToken, CSSSelectorToken, CSSSelectorTreeToken, CSSToken, CSSTokenWithSelector, CSSTreeToken, TextToken };

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

@@ -1,20 +0,0 @@
-import { APIQueryParams, APICacheOptions } from './types.js';
-
-/**
- * Unique key
- */
-declare function apiCacheKey(query: APIQueryParams): string;
-/**
- * Store cache
- */
-declare function storeAPICache(options: APICacheOptions, key: string, data: string): Promise<void>;
-/**
- * Get item from cache
- */
-declare function getAPICache(dir: string, key: string): Promise<string | null>;
-/**
- * Clear cache
- */
-declare function clearAPICache(dir: string): Promise<void>;
-
-export { apiCacheKey, clearAPICache, getAPICache, storeAPICache };

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

@@ -1,8 +0,0 @@
-import { APIQueryParams } from './types.js';
-
-/**
- * Download file
- */
-declare function downloadFile(query: APIQueryParams, target: string): Promise<void>;
-
-export { downloadFile };

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

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

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

@@ -1,17 +0,0 @@
-/**
- * API Cache
- */
-interface APICacheOptions {
-    dir: string;
-    ttl: number;
-}
-/**
- * Params
- */
-interface APIQueryParams {
-    uri: string;
-    params?: URLSearchParams;
-    headers?: Record<string, string>;
-}
-
-export { APICacheOptions, APIQueryParams };

package/lib/download/git/branch.d.ts

@@ -1,8 +0,0 @@
-import { ExportTargetOptions } from '../../export/helpers/prepare.js';
-
-/**
- * Get current branch from cloned git repo
- */
-declare function getGitRepoBranch(options: ExportTargetOptions, checkout?: string): Promise<string>;
-
-export { getGitRepoBranch };

package/lib/download/git/hash.d.ts

@@ -1,8 +0,0 @@
-import { ExportTargetOptions } from '../../export/helpers/prepare.js';
-
-/**
- * Get latest hash from cloned git repo
- */
-declare function getGitRepoHash(options: ExportTargetOptions): Promise<string>;
-
-export { getGitRepoHash };

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

@@ -1,29 +0,0 @@
-import { ExportTargetOptions } from '../../export/helpers/prepare.js';
-import { DocumentNotModified } from '../types/modified.js';
-import { DownloadSourceMixin } from '../types/sources.js';
-
-interface IfModifiedSinceOption {
-    ifModifiedSince: string | true | DownloadGitRepoResult;
-}
-/**
- * Options for downloadGitRepo()
- */
-interface DownloadGitRepoOptions extends ExportTargetOptions, Partial<IfModifiedSinceOption> {
-    remote: string;
-    branch: string;
-    log?: boolean;
-}
-/**
- * Result
- */
-interface DownloadGitRepoResult extends DownloadSourceMixin<'git'> {
-    contentsDir: string;
-    hash: string;
-}
-/**
- * Download Git repo
- */
-declare function downloadGitRepo<T extends IfModifiedSinceOption & DownloadGitRepoOptions>(options: T): Promise<DownloadGitRepoResult | DocumentNotModified>;
-declare function downloadGitRepo(options: DownloadGitRepoOptions): Promise<DownloadGitRepoResult>;
-
-export { DownloadGitRepoOptions, DownloadGitRepoResult, downloadGitRepo };

package/lib/download/git/reset.d.ts

@@ -1,6 +0,0 @@
-/**
- * Reset Git repo contents
- */
-declare function resetGitRepoContents(target: string): Promise<void>;
-
-export { resetGitRepoContents };

package/lib/download/github/hash.d.ts

@@ -1,8 +0,0 @@
-import { GitHubAPIOptions } from './types.js';
-
-/**
- * Get latest hash from GitHub using API
- */
-declare function getGitHubRepoHash(options: GitHubAPIOptions): Promise<string>;
-
-export { getGitHubRepoHash };