@iconify/tools 2.0.14 → 2.0.15

package/lib/icon-set/match.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findMatchingIcon = void 0;
-const icon_1 = require("@iconify/utils/lib/icon");
-// Maximum depth for looking for parent icons
-const maxIteration = 5;
-/**
- * Find matching icon in icon set
- */
-function findMatchingIcon(iconSet, icon) {
-    const body = icon.body;
-    let hiddenMatch = null;
-    function isMatching(data) {
-        for (const key in icon_1.iconDefaults) {
-            const attr = key;
-            if (data[attr] !== icon[attr]) {
-                return false;
-            }
-        }
-        return true;
-    }
-    /**
-     * Check if icon matches
-     */
-    function test(name, iteration) {
-        const data = iconSet.resolve(name, true);
-        if (!data) {
-            return null;
-        }
-        if (isMatching(data)) {
-            if (data.hidden) {
-                hiddenMatch = name;
-            }
-            else {
-                return name;
-            }
-        }
-        if (iteration > maxIteration) {
-            return null;
-        }
-        // Check aliases
-        for (const key in iconSet.entries) {
-            const item = iconSet.entries[key];
-            if (item.type === 'variation' && item.parent === name) {
-                const result = test(key, iteration + 1);
-                if (typeof result === 'string') {
-                    return result;
-                }
-            }
-        }
-        return null;
-    }
-    // Find icons that match
-    for (const key in iconSet.entries) {
-        const item = iconSet.entries[key];
-        if (item.type === 'icon' && item.body === body) {
-            // Possible match
-            const result = test(key, 0);
-            if (typeof result === 'string') {
-                return result;
-            }
-        }
-    }
-    return hiddenMatch;
-}
-exports.findMatchingIcon = findMatchingIcon;

package/lib/icon-set/merge.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeIconSets = void 0;
-const _1 = require(".");
-const match_1 = require("./match");
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function assertNever(v) {
-    //
-}
-/**
- * Merge icon sets
- */
-function mergeIconSets(oldIcons, newIcons) {
-    const mergedIcons = new _1.IconSet(newIcons.export());
-    const oldEntries = oldIcons.entries;
-    const entries = mergedIcons.entries;
-    function add(name) {
-        if (entries[name]) {
-            // Already exists
-            return true;
-        }
-        const item = oldEntries[name];
-        switch (item.type) {
-            case 'icon': {
-                // Attempt to find matching icon
-                const fullIcon = oldIcons.resolve(name, true);
-                const parent = fullIcon
-                    ? (0, match_1.findMatchingIcon)(mergedIcons, fullIcon)
-                    : null;
-                if (parent !== null) {
-                    // Add as alias
-                    mergedIcons.setAlias(name, parent);
-                    return true;
-                }
-                // Add as is, duplicating props
-                const props = item.props;
-                mergedIcons.setItem(name, {
-                    ...item,
-                    props: {
-                        ...props,
-                        hidden: true,
-                    },
-                    categories: new Set(),
-                });
-                return true;
-            }
-            case 'variation':
-            case 'alias': {
-                // Add parent
-                let parent = item.parent;
-                if (!add(parent)) {
-                    return false;
-                }
-                const parentItem = entries[parent];
-                if (parentItem.type === 'alias') {
-                    // Alias of alias - use parent
-                    parent = parentItem.parent;
-                }
-                if (item.type === 'variation') {
-                    // Hide variation and copy props
-                    const props = item.props;
-                    mergedIcons.setItem(name, {
-                        ...item,
-                        parent,
-                        props: {
-                            ...props,
-                            hidden: true,
-                        },
-                    });
-                }
-                else {
-                    mergedIcons.setItem(name, {
-                        ...item,
-                        parent,
-                    });
-                }
-                return true;
-            }
-            default:
-                assertNever(item);
-                return false;
-        }
-    }
-    // Add old icons
-    for (const name in oldEntries) {
-        add(name);
-    }
-    return mergedIcons;
-}
-exports.mergeIconSets = mergeIconSets;

package/lib/icon-set/props.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterProps = exports.defaultCommonProps = exports.extraDefaultProps = void 0;
-const icon_1 = require("@iconify/utils/lib/icon");
-/**
- * Default properties
- */
-exports.extraDefaultProps = {
-    hidden: false,
-};
-exports.defaultCommonProps = {
-    ...icon_1.iconDefaults,
-    ...exports.extraDefaultProps,
-};
-/**
- * Properties to filter
- */
-const props = Object.keys(exports.defaultCommonProps);
-/**
- * Filter icon props: copies properties, removing undefined and default entries
- */
-function filterProps(data, compareDefaultValues) {
-    const result = {};
-    props.forEach((attr) => {
-        const value = data[attr];
-        if (value !== void 0 &&
-            (!compareDefaultValues ||
-                value !== exports.defaultCommonProps[attr])) {
-            result[attr] = value;
-        }
-    });
-    return result;
-}
-exports.filterProps = filterProps;

package/lib/icon-set/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/import/directory.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importDirectory = void 0;
-const fs_1 = require("fs");
-const icon_set_1 = require("../icon-set");
-const keyword_1 = require("../misc/keyword");
-const scan_1 = require("../misc/scan");
-const svg_1 = require("../svg");
-const cleanup_1 = require("../svg/cleanup");
-/**
- * Import all icons from directory
- */
-async function importDirectory(path, options = {}) {
-    // Find all files
-    const files = await (0, scan_1.scanDirectory)(path, (ext, file, subdir, path) => {
-        if (ext.toLowerCase() === '.svg') {
-            const result = {
-                file,
-                ext,
-                subdir,
-                path,
-            };
-            return result;
-        }
-        return false;
-    });
-    // Create blank icon set
-    const iconSet = (0, icon_set_1.blankIconSet)(options.prefix || '');
-    // Import all files
-    for (let i = 0; i < files.length; i++) {
-        const file = files[i];
-        // Get keyword
-        const defaultKeyword = (0, keyword_1.cleanupIconKeyword)(file.file);
-        let keyword = options.keyword
-            ? options.keyword(file, defaultKeyword, iconSet)
-            : defaultKeyword;
-        if (keyword instanceof Promise) {
-            keyword = await keyword;
-        }
-        // Check it
-        if (typeof keyword !== 'string' || !keyword.length) {
-            continue;
-        }
-        // Import icon, clean it up
-        try {
-            const content = await fs_1.promises.readFile(file.path + file.subdir + file.file + file.ext, 'utf8');
-            const svg = new svg_1.SVG(content);
-            await (0, cleanup_1.cleanupSVG)(svg);
-            iconSet.fromSVG(keyword, svg);
-        }
-        catch (err) {
-            if (options.ignoreImportErrors !== false) {
-                throw err;
-            }
-        }
-    }
-    return iconSet;
-}
-exports.importDirectory = importDirectory;

package/lib/import/figma/index.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importFromFigma = void 0;
-const icon_set_1 = require("../../icon-set");
-const svg_1 = require("../../svg");
-const cleanup_1 = require("../../svg/cleanup");
-const nodes_1 = require("./nodes");
-const query_1 = require("./query");
-async function importFromFigma(options) {
-    const cacheOptions = options.cacheDir
-        ? {
-            // 24 hours
-            ttl: options.cacheAPITTL || 60 * 60 * 24,
-            dir: options.cacheDir,
-        }
-        : void 0;
-    const cacheSVGOptions = options.cacheDir
-        ? {
-            // 30 days
-            ttl: options.cacheSVGTTL || 60 * 60 * 24 * 30,
-            dir: options.cacheDir,
-        }
-        : void 0;
-    // Get document
-    const document = await (0, query_1.figmaFilesQuery)(options, cacheOptions);
-    if (document === 'not_modified') {
-        return document;
-    }
-    // Set version to make sure further queries get consistent data
-    options.version = document.version;
-    // Get nodes
-    const nodes = await (0, nodes_1.getFigmaIconNodes)(document, options);
-    // Get images
-    await (0, query_1.figmaImagesQuery)(options, nodes, cacheOptions);
-    // Download images
-    await (0, query_1.figmaDownloadImages)(nodes, cacheSVGOptions);
-    // Generate icon set
-    const iconSet = (0, icon_set_1.blankIconSet)(options.prefix);
-    const icons = nodes.icons;
-    const missing = [];
-    const iconIDs = Object.keys(icons);
-    for (let i = 0; i < iconIDs.length; i++) {
-        const id = iconIDs[i];
-        const item = icons[id];
-        if (typeof item.content !== 'string') {
-            missing.push(item);
-            continue;
-        }
-        // Callback before import (to change stuff, such as icon content)
-        if (options.beforeImportingIcon) {
-            const callbackResult = options.beforeImportingIcon(item, iconSet);
-            if (callbackResult instanceof Promise) {
-                await callbackResult;
-            }
-        }
-        // Import SVG
-        try {
-            const svg = new svg_1.SVG(item.content);
-            await (0, cleanup_1.cleanupSVG)(svg);
-            iconSet.fromSVG(item.keyword, svg);
-        }
-        catch (err) {
-            missing.push(item);
-            continue;
-        }
-        // Callback after import (to add stuff, such as categories)
-        if (options.afterImportingIcon) {
-            const callbackResult = options.afterImportingIcon(item, iconSet);
-            if (callbackResult instanceof Promise) {
-                await callbackResult;
-            }
-        }
-    }
-    // Generate result
-    const result = {
-        // Document
-        name: document.name,
-        version: document.version,
-        lastModified: document.lastModified,
-        // Counters
-        nodesCount: nodes.nodesCount,
-        generatedIconsCount: nodes.generatedIconsCount,
-        downloadedIconsCount: nodes.downloadedIconsCount,
-        // Icon set
-        iconSet,
-        missing,
-    };
-    return result;
-}
-exports.importFromFigma = importFromFigma;

package/lib/import/figma/nodes.js

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFigmaIconNodes = void 0;
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function assertNever(v) {
-    //
-}
-/**
- * Get node ids for icons
- */
-async function getFigmaIconNodes(document, options) {
-    const nodes = {
-        icons: Object.create(null),
-    };
-    let found = 0;
-    const check = (node, parents) => {
-        // Check if node can be icon
-        const iconNodeType = node.type;
-        switch (iconNodeType) {
-            case 'COMPONENT':
-            case 'INSTANCE':
-            case 'FRAME': {
-                const iconNode = node;
-                if (iconNode.absoluteBoundingBox) {
-                    const box = iconNode.absoluteBoundingBox;
-                    const item = {
-                        ...node,
-                        type: iconNodeType,
-                        width: box.width,
-                        height: box.height,
-                        parents,
-                    };
-                    const keyword = options.iconNameForNode(item, nodes, document);
-                    if (typeof keyword === 'string') {
-                        // Keyword
-                        found++;
-                        nodes.icons[node.id] = {
-                            id: node.id,
-                            name: node.name,
-                            keyword,
-                        };
-                        return;
-                    }
-                    if (keyword &&
-                        typeof keyword === 'object' &&
-                        typeof keyword.keyword === 'string') {
-                        // Full item, possibly with custom properties
-                        found++;
-                        nodes.icons[node.id] = {
-                            ...keyword,
-                            id: node.id,
-                            name: node.name,
-                        };
-                        return;
-                    }
-                }
-                break;
-            }
-            default:
-                assertNever(iconNodeType);
-        }
-        // Check if node is a valid parent node
-        if (!node.children) {
-            return;
-        }
-        const parentNodeType = node.type;
-        switch (parentNodeType) {
-            case 'CANVAS':
-            case 'FRAME':
-            case 'GROUP': {
-                const parentItem = {
-                    ...node,
-                    type: parentNodeType,
-                };
-                const newParents = parents.concat([parentItem]);
-                if (!parents.length && options.pages) {
-                    // Check page against allowed pages list
-                    const allowedPages = options.pages;
-                    if (allowedPages.indexOf(node.id) === -1 &&
-                        allowedPages.indexOf(node.name.trim()) === -1) {
-                        return;
-                    }
-                }
-                else {
-                    // Use callback
-                    if (options.filterParentNode &&
-                        !options.filterParentNode(newParents, document)) {
-                        return;
-                    }
-                }
-                node.children.forEach((childNode) => {
-                    check(childNode, newParents);
-                });
-                break;
-            }
-            default:
-                assertNever(parentNodeType);
-        }
-    };
-    document.document.children.forEach((node) => {
-        check(node, []);
-    });
-    nodes.nodesCount = found;
-    return nodes;
-}
-exports.getFigmaIconNodes = getFigmaIconNodes;

package/lib/import/figma/query.js

@@ -1,244 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.figmaDownloadImages = exports.figmaImagesQuery = exports.figmaFilesQuery = void 0;
-const api_1 = require("../../download/api");
-const cache_1 = require("../../download/api/cache");
-/**
- * Compare last modified dates
- */
-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) {
-    // Check token
-    if (!options.token) {
-        throw new Error('Missing Figma API token');
-    }
-    // Generate parameters
-    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 + '');
-    }
-    const queryParams = {
-        uri: 'https://api.figma.com/v1/files/' + options.file,
-        params,
-        headers: {
-            'X-FIGMA-TOKEN': options.token,
-        },
-    };
-    // Get latest version without cache if 'ifModifiedSince' is set
-    const isModified = async () => {
-        // Check cache
-        if (!cache || !options.ifModifiedSince) {
-            return true;
-        }
-        const cacheKey = (0, cache_1.apiCacheKey)(queryParams);
-        const cachedData = await (0, cache_1.getAPICache)(cache.dir, cacheKey);
-        if (!cachedData) {
-            return true;
-        }
-        // Get time stamp for comparison
-        let ifModifiedSince;
-        if (options.ifModifiedSince === true) {
-            try {
-                const parsedData = JSON.parse(cachedData);
-                if (typeof parsedData.lastModified !== 'string') {
-                    // Bad data
-                    await (0, cache_1.clearAPICache)(cache.dir);
-                    return true;
-                }
-                // Set ifModifiedSince to last cached time
-                ifModifiedSince = parsedData.lastModified;
-            }
-            catch (err) {
-                // Bad data
-                await (0, cache_1.clearAPICache)(cache.dir);
-                return true;
-            }
-        }
-        else {
-            ifModifiedSince = options.ifModifiedSince;
-        }
-        // Get shallow copy of tree to get last modification time
-        const versionCheckParams = {
-            ...queryParams,
-            params: new URLSearchParams(params),
-        };
-        versionCheckParams.params.set('depth', '1');
-        const data = await (0, api_1.sendAPIQuery)(versionCheckParams);
-        try {
-            if (typeof data === 'string') {
-                const parsedData = JSON.parse(data);
-                if (identicalDates(parsedData.lastModified, ifModifiedSince)) {
-                    return false;
-                }
-            }
-        }
-        catch (err) {
-            //
-        }
-        // Reset cache
-        await (0, cache_1.clearAPICache)(cache.dir);
-        return true;
-    };
-    if (!(await isModified())) {
-        return 'not_modified';
-    }
-    // Send query
-    const data = await (0, api_1.sendAPIQuery)(queryParams, cache);
-    if (typeof data === 'number') {
-        throw new Error(`Error retrieving document from API: ${data}`);
-    }
-    // Parse JSON
-    let parsedData;
-    try {
-        parsedData = JSON.parse(data);
-    }
-    catch (err) {
-        throw new Error(`Error retrieving document from API: invalid data`);
-    }
-    if (typeof parsedData.status === 'number') {
-        // Error
-        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}`);
-    }
-    // Check if document was modified
-    if (identicalDates(options.ifModifiedSince, document.lastModified)) {
-        return 'not_modified';
-    }
-    return document;
-}
-exports.figmaFilesQuery = figmaFilesQuery;
-/**
- * Generate all images
- */
-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 || {};
-    let ids = [];
-    let idsLength = 0;
-    let lastError;
-    let found = 0;
-    // Send query
-    const query = async () => {
-        const params = new URLSearchParams({
-            ids: ids.join(','),
-            format: 'svg',
-        });
-        if (options.version) {
-            params.set('version', options.version);
-        }
-        if (svgOptions.includeID) {
-            params.set('svg_include_id', 'true');
-        }
-        if (svgOptions.simplifyStroke) {
-            params.set('svg_simplify_stroke', 'true');
-        }
-        if (svgOptions.useAbsoluteBounds) {
-            params.set('use_absolute_bounds', 'true');
-        }
-        const data = await (0, api_1.sendAPIQuery)({
-            uri,
-            params,
-            headers: {
-                'X-FIGMA-TOKEN': options.token,
-            },
-        }, cache);
-        if (typeof data === 'number') {
-            lastError = data;
-            return;
-        }
-        try {
-            const parsedData = JSON.parse(data);
-            const images = parsedData.images;
-            for (const id in images) {
-                const node = nodes.icons[id];
-                const target = images[id];
-                if (node && target) {
-                    node.url = target;
-                    found++;
-                }
-            }
-        }
-        catch (err) {
-            return;
-        }
-    };
-    // Loop all ids
-    const allKeys = Object.keys(nodes.icons);
-    for (let i = 0; i < allKeys.length; i++) {
-        const id = allKeys[i];
-        ids.push(id);
-        idsLength += id.length + 1;
-        if (idsLength >= maxLength) {
-            await query();
-            ids = [];
-            idsLength = 0;
-        }
-    }
-    if (idsLength) {
-        await query();
-    }
-    // Check data
-    if (!found) {
-        if (lastError) {
-            throw new Error(`Error retrieving image data from API${lastError ? ': ' + lastError : ''}`);
-        }
-        else {
-            throw new Error('No valid icon layers were found');
-        }
-    }
-    nodes.generatedIconsCount = found;
-    return nodes;
-}
-exports.figmaImagesQuery = figmaImagesQuery;
-/**
- * Download all images
- */
-async function figmaDownloadImages(nodes, cache) {
-    const icons = nodes.icons;
-    const ids = Object.keys(icons);
-    let count = 0;
-    let lastError;
-    for (let i = 0; i < ids.length; i++) {
-        const id = ids[i];
-        const item = icons[id];
-        if (!item.url) {
-            continue;
-        }
-        const result = await (0, api_1.sendAPIQuery)({
-            uri: item.url,
-        }, cache);
-        if (typeof result === 'number') {
-            lastError = result;
-            continue;
-        }
-        if (typeof result === 'string') {
-            count++;
-            item.content = result;
-        }
-    }
-    if (!count) {
-        throw new Error(`Error retrieving images${lastError ? ': ' + lastError : ''}`);
-    }
-    nodes.downloadedIconsCount = count;
-    return nodes;
-}
-exports.figmaDownloadImages = figmaDownloadImages;