@iconify/tools 4.0.0-beta.9 → 4.0.0

package/lib/download/index.d.mts

@@ -0,0 +1,48 @@
+import { DownloadGitHubRepoOptions, DownloadGitHubRepoResult } from './github/index.mjs';
+import { DownloadGitRepoOptions, DownloadGitRepoResult } from './git/index.mjs';
+import { DownloadNPMPackageOptions, DownloadNPMPackageResult } from './npm/index.mjs';
+import { DocumentNotModified } from './types/modified.mjs';
+import { DownloadSourceType, DownloadSourceMixin } from './types/sources.mjs';
+import { DownloadGitLabRepoOptions, DownloadGitLabRepoResult } from './gitlab/index.mjs';
+import '../export/helpers/prepare.mjs';
+import './github/types.mjs';
+import './gitlab/types.mjs';
+
+/**
+ * Options and result combinations
+ */
+interface DownloadGitRepo {
+    options: DownloadGitRepoOptions & DownloadSourceMixin<'git'>;
+    result: DownloadGitRepoResult;
+}
+interface DownloadGitHubRepo {
+    options: DownloadGitHubRepoOptions & DownloadSourceMixin<'github'>;
+    result: DownloadGitHubRepoResult;
+}
+interface DownloadGitLabRepo {
+    options: DownloadGitLabRepoOptions & DownloadSourceMixin<'gitlab'>;
+    result: DownloadGitLabRepoResult;
+}
+interface DownloadNPMPackage {
+    options: DownloadNPMPackageOptions & DownloadSourceMixin<'npm'>;
+    result: DownloadNPMPackageResult;
+}
+/**
+ * Combinations based on type
+ */
+type DownloadParamsMixin<T extends DownloadSourceType> = T extends 'git' ? DownloadGitRepo : T extends 'github' ? DownloadGitHubRepo : T extends 'gitlab' ? DownloadGitLabRepo : T extends 'npm' ? DownloadNPMPackage : never;
+/**
+ * Combinations
+ */
+type DownloadParams = DownloadGitRepo | DownloadGitHubRepo | DownloadGitLabRepo | DownloadNPMPackage;
+/**
+ * Pick options or result from combinations
+ */
+type DownloadOptions<T extends DownloadSourceType> = DownloadParamsMixin<T>['options'];
+type DownloadResult<T extends DownloadSourceType> = Promise<DocumentNotModified | DownloadParamsMixin<T>['result']>;
+declare function downloadPackage<T extends 'git'>(options: DownloadOptions<T>): DownloadResult<T>;
+declare function downloadPackage<T extends 'github'>(options: DownloadOptions<T>): DownloadResult<T>;
+declare function downloadPackage<T extends 'gitlab'>(options: DownloadOptions<T>): DownloadResult<T>;
+declare function downloadPackage<T extends 'npm'>(options: DownloadOptions<T>): DownloadResult<T>;
+
+export { type DownloadParams, type DownloadParamsMixin, downloadPackage };

package/lib/download/index.d.ts

@@ -45,4 +45,4 @@ declare function downloadPackage<T extends 'github'>(options: DownloadOptions<T>
 declare function downloadPackage<T extends 'gitlab'>(options: DownloadOptions<T>): DownloadResult<T>;
 declare function downloadPackage<T extends 'npm'>(options: DownloadOptions<T>): DownloadResult<T>;
 
-export { DownloadParams, DownloadParamsMixin, downloadPackage };
+export { type DownloadParams, type DownloadParamsMixin, downloadPackage };

package/lib/download/npm/index.d.cts

@@ -0,0 +1,30 @@
+import { ExportTargetOptions } from '../../export/helpers/prepare.cjs';
+import { DocumentNotModified } from '../types/modified.cjs';
+import { DownloadSourceMixin } from '../types/sources.cjs';
+
+interface IfModifiedSinceOption {
+    ifModifiedSince: string | true | DownloadNPMPackageResult;
+}
+/**
+ * Options for downloadNPMPackage()
+ */
+interface DownloadNPMPackageOptions extends ExportTargetOptions, Partial<IfModifiedSinceOption> {
+    package: string;
+    tag?: string;
+    log?: boolean;
+}
+/**
+ * Result
+ */
+interface DownloadNPMPackageResult extends DownloadSourceMixin<'npm'> {
+    rootDir: string;
+    contentsDir: string;
+    version: string;
+}
+/**
+ * Download NPM package
+ */
+declare function downloadNPMPackage<T extends IfModifiedSinceOption & DownloadNPMPackageOptions>(options: T): Promise<DownloadNPMPackageResult | DocumentNotModified>;
+declare function downloadNPMPackage(options: DownloadNPMPackageOptions): Promise<DownloadNPMPackageResult>;
+
+export { type DownloadNPMPackageOptions, type DownloadNPMPackageResult, downloadNPMPackage };

package/lib/download/npm/index.d.mts

@@ -0,0 +1,30 @@
+import { ExportTargetOptions } from '../../export/helpers/prepare.mjs';
+import { DocumentNotModified } from '../types/modified.mjs';
+import { DownloadSourceMixin } from '../types/sources.mjs';
+
+interface IfModifiedSinceOption {
+    ifModifiedSince: string | true | DownloadNPMPackageResult;
+}
+/**
+ * Options for downloadNPMPackage()
+ */
+interface DownloadNPMPackageOptions extends ExportTargetOptions, Partial<IfModifiedSinceOption> {
+    package: string;
+    tag?: string;
+    log?: boolean;
+}
+/**
+ * Result
+ */
+interface DownloadNPMPackageResult extends DownloadSourceMixin<'npm'> {
+    rootDir: string;
+    contentsDir: string;
+    version: string;
+}
+/**
+ * Download NPM package
+ */
+declare function downloadNPMPackage<T extends IfModifiedSinceOption & DownloadNPMPackageOptions>(options: T): Promise<DownloadNPMPackageResult | DocumentNotModified>;
+declare function downloadNPMPackage(options: DownloadNPMPackageOptions): Promise<DownloadNPMPackageResult>;
+
+export { type DownloadNPMPackageOptions, type DownloadNPMPackageResult, downloadNPMPackage };

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

@@ -27,4 +27,4 @@ interface DownloadNPMPackageResult extends DownloadSourceMixin<'npm'> {
 declare function downloadNPMPackage<T extends IfModifiedSinceOption & DownloadNPMPackageOptions>(options: T): Promise<DownloadNPMPackageResult | DocumentNotModified>;
 declare function downloadNPMPackage(options: DownloadNPMPackageOptions): Promise<DownloadNPMPackageResult>;
 
-export { DownloadNPMPackageOptions, DownloadNPMPackageResult, downloadNPMPackage };
+export { type DownloadNPMPackageOptions, type DownloadNPMPackageResult, downloadNPMPackage };

package/lib/download/npm/types.d.cts

@@ -0,0 +1,9 @@
+/**
+ * Package options
+ */
+interface NPMPackageOptions {
+    package: string;
+    tag?: string;
+}
+
+export type { NPMPackageOptions };

package/lib/download/npm/types.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Package options
+ */
+interface NPMPackageOptions {
+    package: string;
+    tag?: string;
+}
+
+export type { NPMPackageOptions };

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

@@ -6,4 +6,4 @@ interface NPMPackageOptions {
     tag?: string;
 }
 
-export { NPMPackageOptions };
+export type { NPMPackageOptions };

package/lib/download/npm/version.d.cts

@@ -0,0 +1,16 @@
+import { NPMPackageOptions } from './types.cjs';
+
+interface GetNPMVersionResult {
+    version: string;
+    file?: string;
+}
+/**
+ * Get version of package from NPM registry
+ */
+declare function getNPMVersion(options: NPMPackageOptions): Promise<GetNPMVersionResult>;
+/**
+ * Get version of package from filename
+ */
+declare function getPackageVersion(target: string): Promise<string>;
+
+export { type GetNPMVersionResult, getNPMVersion, getPackageVersion };

package/lib/download/npm/version.d.mts

@@ -0,0 +1,16 @@
+import { NPMPackageOptions } from './types.mjs';
+
+interface GetNPMVersionResult {
+    version: string;
+    file?: string;
+}
+/**
+ * Get version of package from NPM registry
+ */
+declare function getNPMVersion(options: NPMPackageOptions): Promise<GetNPMVersionResult>;
+/**
+ * Get version of package from filename
+ */
+declare function getPackageVersion(target: string): Promise<string>;
+
+export { type GetNPMVersionResult, getNPMVersion, getPackageVersion };

package/lib/download/npm/version.d.ts

@@ -13,4 +13,4 @@ declare function getNPMVersion(options: NPMPackageOptions): Promise<GetNPMVersio
  */
 declare function getPackageVersion(target: string): Promise<string>;
 
-export { GetNPMVersionResult, getNPMVersion, getPackageVersion };
+export { type GetNPMVersionResult, getNPMVersion, getPackageVersion };

package/lib/download/types/modified.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Document wasn't modified
+ */
+type DocumentNotModified = 'not_modified';
+
+export type { DocumentNotModified };

package/lib/download/types/modified.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Document wasn't modified
+ */
+type DocumentNotModified = 'not_modified';
+
+export type { DocumentNotModified };

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

@@ -3,4 +3,4 @@
  */
 type DocumentNotModified = 'not_modified';
 
-export { DocumentNotModified };
+export type { DocumentNotModified };

package/lib/download/types/sources.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Download types
+ */
+type DownloadSourceType = 'git' | 'github' | 'gitlab' | 'npm';
+/**
+ * Type in other objects
+ */
+interface DownloadSourceMixin<T extends DownloadSourceType> {
+    downloadType: T;
+}
+
+export type { DownloadSourceMixin, DownloadSourceType };

package/lib/download/types/sources.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Download types
+ */
+type DownloadSourceType = 'git' | 'github' | 'gitlab' | 'npm';
+/**
+ * Type in other objects
+ */
+interface DownloadSourceMixin<T extends DownloadSourceType> {
+    downloadType: T;
+}
+
+export type { DownloadSourceMixin, DownloadSourceType };

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

@@ -9,4 +9,4 @@ interface DownloadSourceMixin<T extends DownloadSourceType> {
     downloadType: T;
 }
 
-export { DownloadSourceMixin, DownloadSourceType };
+export type { DownloadSourceMixin, DownloadSourceType };

package/lib/export/directory.d.cts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { ExportTargetOptions } from './helpers/prepare.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportToDirectoryOptions extends ExportTargetOptions {
+    autoHeight?: boolean;
+    includeAliases?: boolean;
+    includeChars?: boolean;
+    log?: boolean;
+}
+/**
+ * Export icon set to directory
+ *
+ * Returns list of stored files
+ */
+declare function exportToDirectory(iconSet: IconSet, options: ExportToDirectoryOptions): Promise<string[]>;
+
+export { type ExportToDirectoryOptions, exportToDirectory };

package/lib/export/directory.d.mts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { ExportTargetOptions } from './helpers/prepare.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportToDirectoryOptions extends ExportTargetOptions {
+    autoHeight?: boolean;
+    includeAliases?: boolean;
+    includeChars?: boolean;
+    log?: boolean;
+}
+/**
+ * Export icon set to directory
+ *
+ * Returns list of stored files
+ */
+declare function exportToDirectory(iconSet: IconSet, options: ExportToDirectoryOptions): Promise<string[]>;
+
+export { type ExportToDirectoryOptions, exportToDirectory };

package/lib/export/directory.d.ts

@@ -23,4 +23,4 @@ interface ExportToDirectoryOptions extends ExportTargetOptions {
  */
 declare function exportToDirectory(iconSet: IconSet, options: ExportToDirectoryOptions): Promise<string[]>;
 
-export { ExportToDirectoryOptions, exportToDirectory };
+export { type ExportToDirectoryOptions, exportToDirectory };

package/lib/export/helpers/custom-files.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Options
+ */
+interface ExportOptionsWithCustomFiles {
+    customFiles?: Record<string, string | Record<string, unknown> | null>;
+}
+/**
+ * Write custom files
+ */
+declare function exportCustomFiles(dir: string, options: ExportOptionsWithCustomFiles, result?: Set<string>): Promise<void>;
+
+export { type ExportOptionsWithCustomFiles, exportCustomFiles };

package/lib/export/helpers/custom-files.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Options
+ */
+interface ExportOptionsWithCustomFiles {
+    customFiles?: Record<string, string | Record<string, unknown> | null>;
+}
+/**
+ * Write custom files
+ */
+declare function exportCustomFiles(dir: string, options: ExportOptionsWithCustomFiles, result?: Set<string>): Promise<void>;
+
+export { type ExportOptionsWithCustomFiles, exportCustomFiles };

package/lib/export/helpers/custom-files.d.ts

@@ -9,4 +9,4 @@ interface ExportOptionsWithCustomFiles {
  */
 declare function exportCustomFiles(dir: string, options: ExportOptionsWithCustomFiles, result?: Set<string>): Promise<void>;
 
-export { ExportOptionsWithCustomFiles, exportCustomFiles };
+export { type ExportOptionsWithCustomFiles, exportCustomFiles };

package/lib/export/helpers/prepare.d.cts

@@ -0,0 +1,19 @@
+/**
+ * Common options for all functions that export to directory
+ */
+interface ExportTargetOptions {
+    target: string;
+    cleanup?: boolean;
+}
+/**
+ * Normalize directory
+ */
+declare function normalizeDir(dir: string): string;
+/**
+ * Prepare directory for export
+ *
+ * Also normalizes directory and returns normalized value
+ */
+declare function prepareDirectoryForExport(options: ExportTargetOptions): Promise<string>;
+
+export { type ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

package/lib/export/helpers/prepare.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Common options for all functions that export to directory
+ */
+interface ExportTargetOptions {
+    target: string;
+    cleanup?: boolean;
+}
+/**
+ * Normalize directory
+ */
+declare function normalizeDir(dir: string): string;
+/**
+ * Prepare directory for export
+ *
+ * Also normalizes directory and returns normalized value
+ */
+declare function prepareDirectoryForExport(options: ExportTargetOptions): Promise<string>;
+
+export { type ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

package/lib/export/helpers/prepare.d.ts

@@ -16,4 +16,4 @@ declare function normalizeDir(dir: string): string;
  */
 declare function prepareDirectoryForExport(options: ExportTargetOptions): Promise<string>;
 
-export { ExportTargetOptions, normalizeDir, prepareDirectoryForExport };
+export { type ExportTargetOptions, normalizeDir, prepareDirectoryForExport };

package/lib/export/helpers/types-version.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Get current version of Iconify Types package
+ */
+declare function getTypesVersion(): Promise<string>;
+
+export { getTypesVersion };

package/lib/export/helpers/types-version.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Get current version of Iconify Types package
+ */
+declare function getTypesVersion(): Promise<string>;
+
+export { getTypesVersion };

package/lib/export/icon-package.d.cts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { ExportTargetOptions } from './helpers/prepare.cjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportIconPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    module?: boolean;
+    typesContent?: string;
+}
+/**
+ * Export icon set as single icon packages
+ *
+ * Was used for exporting `@iconify-icons/{prefix}` packages
+ */
+declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
+
+export { type ExportIconPackageOptions, exportIconPackage };

package/lib/export/icon-package.d.mts

@@ -0,0 +1,26 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { ExportTargetOptions } from './helpers/prepare.mjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportIconPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    module?: boolean;
+    typesContent?: string;
+}
+/**
+ * Export icon set as single icon packages
+ *
+ * Was used for exporting `@iconify-icons/{prefix}` packages
+ */
+declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
+
+export { type ExportIconPackageOptions, exportIconPackage };

package/lib/export/icon-package.d.ts

@@ -20,9 +20,7 @@ interface ExportIconPackageOptions extends ExportTargetOptions, ExportOptionsWit
  * Export icon set as single icon packages
  *
  * Was used for exporting `@iconify-icons/{prefix}` packages
- *
- * @deprecated Packages with single icons are no longer maintained.
  */
 declare function exportIconPackage(iconSet: IconSet, options: ExportIconPackageOptions): Promise<string[]>;
 
-export { ExportIconPackageOptions, exportIconPackage };
+export { type ExportIconPackageOptions, exportIconPackage };

package/lib/export/json-package.d.cts

@@ -0,0 +1,25 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { ExportTargetOptions } from './helpers/prepare.cjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.cjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.cjs';
+import '../svg/index.cjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    customisePackage?: (contents: Record<string, unknown>) => void;
+}
+/**
+ * Export icon set as JSON package
+ *
+ * Used for exporting `@iconify-json/{prefix}` packages
+ */
+declare function exportJSONPackage(iconSet: IconSet, options: ExportJSONPackageOptions): Promise<string[]>;
+
+export { type ExportJSONPackageOptions, exportJSONPackage };

package/lib/export/json-package.d.mts

@@ -0,0 +1,25 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { ExportTargetOptions } from './helpers/prepare.mjs';
+import { ExportOptionsWithCustomFiles } from './helpers/custom-files.mjs';
+import '@iconify/types';
+import '@iconify/utils/lib/customisations/defaults';
+import '../icon-set/types.mjs';
+import '../svg/index.mjs';
+import 'cheerio';
+import '@iconify/utils/lib/icon-set/tree';
+
+/**
+ * Options
+ */
+interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWithCustomFiles {
+    package?: Record<string, unknown>;
+    customisePackage?: (contents: Record<string, unknown>) => void;
+}
+/**
+ * Export icon set as JSON package
+ *
+ * Used for exporting `@iconify-json/{prefix}` packages
+ */
+declare function exportJSONPackage(iconSet: IconSet, options: ExportJSONPackageOptions): Promise<string[]>;
+
+export { type ExportJSONPackageOptions, exportJSONPackage };

package/lib/export/json-package.d.ts

@@ -22,4 +22,4 @@ interface ExportJSONPackageOptions extends ExportTargetOptions, ExportOptionsWit
  */
 declare function exportJSONPackage(iconSet: IconSet, options: ExportJSONPackageOptions): Promise<string[]>;
 
-export { ExportJSONPackageOptions, exportJSONPackage };
+export { type ExportJSONPackageOptions, exportJSONPackage };

package/lib/icon-set/index.cjs

@@ -10,6 +10,12 @@ const utils = require('@iconify/utils');
 require('@iconify/utils/lib/misc/objects');
 require('cheerio');
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 const themeKeys = ["prefixes", "suffixes"];
 function sortThemeKeys(keys) {
   return keys.sort(
@@ -21,6 +27,22 @@ class IconSet {
    * Load icon set
    */
   constructor(data) {
+    /**
+     * Properties. You can write directly to almost any property, but avoid writing to
+     * 'entries' and 'categories' properties, there are functions for that.
+     */
+    // Icon set prefix
+    __publicField(this, "prefix");
+    // Last modification time
+    __publicField(this, "lastModified");
+    // All icons
+    __publicField(this, "entries");
+    // Information block
+    __publicField(this, "info");
+    // Categories, using custom type. Use functions to update data
+    __publicField(this, "categories");
+    __publicField(this, "prefixes");
+    __publicField(this, "suffixes");
     this.load(data);
   }
   /**