@iconify/tools 4.2.0 → 5.0.0-beta.2

package/lib/export/json-package.js

@@ -0,0 +1,129 @@
+import { prepareDirectoryForExport } from "./helpers/prepare.js";
+import { writeJSONFile } from "../misc/write-json.js";
+import { exportCustomFiles } from "./helpers/custom-files.js";
+import { getTypesVersion } from "./helpers/types-version.js";
+import { defaultIconDimensions } from "@iconify/utils/lib/icon/defaults";
+import { promises } from "fs";
+
+const exportTypes = {
+	icons: "IconifyJSON",
+	info: "IconifyInfo",
+	metadata: "IconifyMetaData",
+	chars: "IconifyChars"
+};
+const iconsKeys = ["aliases", "lastModified"].concat(Object.keys(defaultIconDimensions));
+const metadataKeys = [
+	"categories",
+	"themes",
+	"prefixes",
+	"suffixes"
+];
+/**
+* Export icon set as JSON package
+*
+* Used for exporting `@iconify-json/{prefix}` packages
+*/
+async function exportJSONPackage(iconSet, options) {
+	const files = /* @__PURE__ */ new Set();
+	const dir = await prepareDirectoryForExport(options);
+	const exportedJSON = iconSet.export(true);
+	const icons = {
+		prefix: exportedJSON.prefix,
+		icons: exportedJSON.icons
+	};
+	iconsKeys.forEach((attr) => {
+		if (exportedJSON[attr] !== void 0) icons[attr] = exportedJSON[attr];
+	});
+	const metadata = {};
+	let hasMetadata = false;
+	metadataKeys.forEach((attr) => {
+		if (exportedJSON[attr]) {
+			metadata[attr] = exportedJSON[attr];
+			hasMetadata = true;
+		}
+	});
+	const info = exportedJSON.info ? {
+		prefix: iconSet.prefix,
+		...exportedJSON.info
+	} : void 0;
+	const contents = {
+		icons,
+		info,
+		metadata: hasMetadata ? metadata : void 0,
+		chars: exportedJSON.chars
+	};
+	const typesVersion = options.wildcardTypesVersion === false ? "^" + await getTypesVersion() : "*";
+	const { name, description, version, dependencies, ...customPackageProps } = options.package || {};
+	const packageJSONIconSet = {};
+	const packageJSONExports = {
+		"./*": "./*",
+		".": {
+			types: "./index.d.ts",
+			require: "./index.js",
+			import: "./index.mjs"
+		}
+	};
+	const packageJSON = {
+		name: name || `@iconify-json/${iconSet.prefix}`,
+		description: description || `${info ? info.name : iconSet.prefix} icon set in Iconify JSON format`,
+		version,
+		iconSetVersion: info?.version,
+		main: "index.js",
+		module: "index.mjs",
+		types: "index.d.ts",
+		...customPackageProps,
+		exports: packageJSONExports,
+		iconSet: packageJSONIconSet,
+		dependencies: dependencies || { "@iconify/types": typesVersion }
+	};
+	const dtsContent = [];
+	const cjsImports = [];
+	const cjsExports = [];
+	const mjsImports = [];
+	const mjsConsts = [];
+	const mjsExports = [];
+	for (const key in contents) {
+		const attr = key;
+		const data = contents[attr];
+		const type = exportTypes[attr];
+		const jsonFilename = attr + ".json";
+		const relativeFile = `./${jsonFilename}`;
+		dtsContent.push(`export declare const ${attr}: ${type};`);
+		cjsExports.push(`exports.${attr} = ${attr};`);
+		mjsExports.push(attr);
+		if (data !== void 0) {
+			await writeJSONFile(`${dir}/${jsonFilename}`, data);
+			cjsImports.push(`const ${attr} = require('${relativeFile}');`);
+			mjsImports.push(`import ${attr} from '${relativeFile}' with { type: 'json' };`);
+			packageJSONIconSet[attr] = attr + ".json";
+			packageJSONExports[relativeFile] = relativeFile;
+		} else {
+			await writeJSONFile(`${dir}/${jsonFilename}`, {});
+			cjsImports.push(`const ${attr} = {};`);
+			mjsConsts.push(`const ${attr} = {};`);
+		}
+		files.add(jsonFilename);
+	}
+	const cjsContent = cjsImports.concat([""], cjsExports);
+	await promises.writeFile(dir + "/index.js", cjsContent.join("\n") + "\n", "utf8");
+	files.add("index.js");
+	const mjsContent = mjsImports.concat([""], mjsConsts, [`export { ${mjsExports.join(", ")} };`]);
+	await promises.writeFile(dir + "/index.mjs", mjsContent.join("\n") + "\n", "utf8");
+	files.add("index.mjs");
+	const usedTypes = Object.values(exportTypes);
+	const typesData = [
+		`import type { ${usedTypes.join(", ")} } from '@iconify/types';`,
+		"",
+		`export { ${usedTypes.join(", ")} };`,
+		""
+	].concat(dtsContent);
+	await promises.writeFile(dir + "/index.d.ts", typesData.join("\n") + "\n", "utf8");
+	files.add("index.d.ts");
+	await exportCustomFiles(dir, options, files);
+	options.customisePackage?.(packageJSON);
+	await writeJSONFile(dir + "/package.json", packageJSON);
+	files.add("package.json");
+	return Array.from(files);
+}
+
+export { exportJSONPackage };

package/lib/icon-set/index.d.ts

@@ -1,10 +1,8 @@
-import { IconifyInfo, IconifyJSON } from '@iconify/types';
-import { IconifyIconCustomisations } from '@iconify/utils/lib/customisations/defaults';
-import { IconSetIconEntry, IconCategory, IconSetIconType, IconSetAsyncForEachCallback, IconSetSyncForEachCallback, ResolvedIconifyIcon, CommonIconProps, CheckThemeResult } from './types.js';
-import { SVG } from '../svg/index.js';
-import { ParentIconsTree } from '@iconify/utils/lib/icon-set/tree';
-import 'cheerio';
-
+import { CheckThemeResult, CommonIconProps, IconCategory, IconSetAsyncForEachCallback, IconSetIconEntry, IconSetIconType, IconSetSyncForEachCallback, ResolvedIconifyIcon } from "./types.js";
+import { SVG } from "../svg/index.js";
+import { IconifyInfo, IconifyJSON } from "@iconify/types";
+import { IconifyIconCustomisations } from "@iconify/utils/lib/customisations/defaults";
+import { ParentIconsTree } from "@iconify/utils/lib/icon-set/tree";
 /**
  * Sort theme keys: long keys first
  *
@@ -15,148 +13,147 @@ declare function sortThemeKeys(keys: string[]): string[];
  * Export icon set
  */
 declare class IconSet {
-    /**
-     * Properties. You can write directly to almost any property, but avoid writing to
-     * 'entries' and 'categories' properties, there are functions for that.
-     */
-    prefix: string;
-    lastModified: number;
-    entries: Record<string, IconSetIconEntry>;
-    info: IconifyInfo | undefined;
-    categories: Set<IconCategory>;
-    prefixes: Record<string, string>;
-    suffixes: Record<string, string>;
-    /**
-     * Load icon set
-     */
-    constructor(data: IconifyJSON);
-    /**
-     * Load icon set
-     */
-    load(data: IconifyJSON): void;
-    /**
-     * Update last modification time
-     */
-    updateLastModified(value?: number): void;
-    /**
-     * List icons
-     */
-    list(types?: IconSetIconType[]): string[];
-    /**
-     * forEach function to loop through all entries.
-     * Supports asynchronous callbacks.
-     *
-     * Callback should return false to stop loop.
-     */
-    forEach(callback: IconSetAsyncForEachCallback, types?: IconSetIconType[]): Promise<void>;
-    /**
-     * Synchronous version of forEach function to loop through all entries.
-     *
-     * Callback should return false to stop loop.
-     */
-    forEachSync(callback: IconSetSyncForEachCallback, types?: IconSetIconType[]): void;
-    /**
-     * Get parent icons tree
-     *
-     * Returns parent icons list for each icon, null if failed to resolve.
-     * In parent icons list, first element is a direct parent, last is icon. Does not include item.
-     *
-     * Examples:
-     *   'alias3': ['alias2', 'alias1', 'icon']
-     * 	 'icon': []
-     * 	 'bad-icon': null
-     */
-    getTree(names?: string[]): ParentIconsTree;
-    /**
-     * Resolve icon
-     */
-    resolve(name: string, full: false): ResolvedIconifyIcon | null;
-    resolve(name: string): ResolvedIconifyIcon | null;
-    resolve(name: string, full: true): Required<ResolvedIconifyIcon> | null;
-    /**
-     * Generate HTML
-     */
-    toString(name: string, customisations?: IconifyIconCustomisations): string | null;
-    /**
-     * Get SVG instance for icon
-     */
-    toSVG(name: string): SVG | null;
-    /**
-     * Export icon set
-     */
-    export(validate?: boolean): IconifyJSON;
-    /**
-     * Get characters map
-     */
-    chars(names?: string[]): Record<string, string>;
-    /**
-     * Filter icons
-     */
-    _filter(callback: (name: string, item: IconSetIconEntry, icon?: ResolvedIconifyIcon) => boolean): string[];
-    /**
-     * Count icons
-     */
-    count(): number;
-    /**
-     * Find category by title
-     */
-    findCategory(title: string, add: boolean): IconCategory | null;
-    /**
-     * Count icons in category, remove category if empty
-     *
-     * Hidden icons and aliases do not count
-     */
-    listCategory(category: IconCategory | string): string[] | null;
-    /**
-     * Check if icon exists
-     */
-    exists(name: string): boolean;
-    /**
-     * Remove icons. Returns number of removed icons
-     *
-     * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
-     */
-    remove(name: string, removeDependencies?: boolean | string): number;
-    /**
-     * Rename icon
-     */
-    rename(oldName: string, newName: string): boolean;
-    /**
-     * Add/update item
-     */
-    setItem(name: string, item: IconSetIconEntry): boolean;
-    /**
-     * Add/update icon
-     */
-    setIcon(name: string, icon: ResolvedIconifyIcon): boolean;
-    /**
-     * Add/update alias without props
-     */
-    setAlias(name: string, parent: string): boolean;
-    /**
-     * Add/update alias with props
-     */
-    setVariation(name: string, parent: string, props: CommonIconProps): boolean;
-    /**
-     * Icon from SVG. Updates old icon if it exists
-     */
-    fromSVG(name: string, svg: SVG): boolean;
-    /**
-     * Add or remove character for icon
-     */
-    toggleCharacter(iconName: string, char: string, add: boolean): boolean;
-    /**
-     * Add or remove category for icon
-     */
-    toggleCategory(iconName: string, category: string, add: boolean): boolean;
-    /**
-     * Find icons that belong to theme
-     */
-    checkTheme(prefix: boolean): CheckThemeResult;
+  /**
+   * Properties. You can write directly to almost any property, but avoid writing to
+   * 'entries' and 'categories' properties, there are functions for that.
+   */
+  prefix: string;
+  lastModified: number;
+  entries: Record<string, IconSetIconEntry>;
+  info: IconifyInfo | undefined;
+  categories: Set<IconCategory>;
+  prefixes: Record<string, string>;
+  suffixes: Record<string, string>;
+  /**
+   * Load icon set
+   */
+  constructor(data: IconifyJSON);
+  /**
+   * Load icon set
+   */
+  load(data: IconifyJSON): void;
+  /**
+   * Update last modification time
+   */
+  updateLastModified(value?: number): void;
+  /**
+   * List icons
+   */
+  list(types?: IconSetIconType[]): string[];
+  /**
+   * forEach function to loop through all entries.
+   * Supports asynchronous callbacks.
+   *
+   * Callback should return false to stop loop.
+   */
+  forEach(callback: IconSetAsyncForEachCallback, types?: IconSetIconType[]): Promise<void>;
+  /**
+   * Synchronous version of forEach function to loop through all entries.
+   *
+   * Callback should return false to stop loop.
+   */
+  forEachSync(callback: IconSetSyncForEachCallback, types?: IconSetIconType[]): void;
+  /**
+   * Get parent icons tree
+   *
+   * Returns parent icons list for each icon, null if failed to resolve.
+   * In parent icons list, first element is a direct parent, last is icon. Does not include item.
+   *
+   * Examples:
+   *   'alias3': ['alias2', 'alias1', 'icon']
+   * 	 'icon': []
+   * 	 'bad-icon': null
+   */
+  getTree(names?: string[]): ParentIconsTree;
+  /**
+   * Resolve icon
+   */
+  resolve(name: string, full: false): ResolvedIconifyIcon | null;
+  resolve(name: string): ResolvedIconifyIcon | null;
+  resolve(name: string, full: true): Required<ResolvedIconifyIcon> | null;
+  /**
+   * Generate HTML
+   */
+  toString(name: string, customisations?: IconifyIconCustomisations): string | null;
+  /**
+   * Get SVG instance for icon
+   */
+  toSVG(name: string): SVG | null;
+  /**
+   * Export icon set
+   */
+  export(validate?: boolean): IconifyJSON;
+  /**
+   * Get characters map
+   */
+  chars(names?: string[]): Record<string, string>;
+  /**
+   * Filter icons
+   */
+  _filter(callback: (name: string, item: IconSetIconEntry, icon?: ResolvedIconifyIcon) => boolean): string[];
+  /**
+   * Count icons
+   */
+  count(): number;
+  /**
+   * Find category by title
+   */
+  findCategory(title: string, add: boolean): IconCategory | null;
+  /**
+   * Count icons in category, remove category if empty
+   *
+   * Hidden icons and aliases do not count
+   */
+  listCategory(category: IconCategory | string): string[] | null;
+  /**
+   * Check if icon exists
+   */
+  exists(name: string): boolean;
+  /**
+   * Remove icons. Returns number of removed icons
+   *
+   * If removeDependencies is a string, it represents new parent for all aliases of removed icon. New parent cannot be alias or variation.
+   */
+  remove(name: string, removeDependencies?: boolean | string): number;
+  /**
+   * Rename icon
+   */
+  rename(oldName: string, newName: string): boolean;
+  /**
+   * Add/update item
+   */
+  setItem(name: string, item: IconSetIconEntry): boolean;
+  /**
+   * Add/update icon
+   */
+  setIcon(name: string, icon: ResolvedIconifyIcon): boolean;
+  /**
+   * Add/update alias without props
+   */
+  setAlias(name: string, parent: string): boolean;
+  /**
+   * Add/update alias with props
+   */
+  setVariation(name: string, parent: string, props: CommonIconProps): boolean;
+  /**
+   * Icon from SVG. Updates old icon if it exists
+   */
+  fromSVG(name: string, svg: SVG): boolean;
+  /**
+   * Add or remove character for icon
+   */
+  toggleCharacter(iconName: string, char: string, add: boolean): boolean;
+  /**
+   * Add or remove category for icon
+   */
+  toggleCategory(iconName: string, category: string, add: boolean): boolean;
+  /**
+   * Find icons that belong to theme
+   */
+  checkTheme(prefix: boolean): CheckThemeResult;
 }
 /**
  * Create blank icon set
  */
 declare function blankIconSet(prefix: string): IconSet;
-
-export { IconSet, blankIconSet, sortThemeKeys };
+export { IconSet, blankIconSet, sortThemeKeys };