@iconify/tools 4.0.0-beta.9 → 4.0.0

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

@@ -72,4 +72,4 @@ type IconSetForEachCallbackResult = void | false;
 type IconSetAsyncForEachCallback = (name: string, type: IconSetIconEntry['type']) => Promise<IconSetForEachCallbackResult> | IconSetForEachCallbackResult;
 type IconSetSyncForEachCallback = (name: string, type: IconSetIconEntry['type']) => IconSetForEachCallbackResult;
 
-export { CheckThemeResult, CommonIconProps, ExtraIconProps, IconCategory, IconParentData, IconSetAsyncForEachCallback, IconSetIcon, IconSetIconAlias, IconSetIconEntry, IconSetIconType, IconSetIconVariation, IconSetSyncForEachCallback, IconWithCategories, IconWithChars, IconWithPropsData, ResolvedIconifyIcon };
+export type { CheckThemeResult, CommonIconProps, ExtraIconProps, IconCategory, IconParentData, IconSetAsyncForEachCallback, IconSetIcon, IconSetIconAlias, IconSetIconEntry, IconSetIconType, IconSetIconVariation, IconSetSyncForEachCallback, IconWithCategories, IconWithChars, IconWithPropsData, ResolvedIconifyIcon };

package/lib/import/directory.d.cts

@@ -0,0 +1,52 @@
+import { IconSet } from '../icon-set/index.cjs';
+import { CleanupSVGOptions } from '../svg/cleanup.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';
+import '../svg/cleanup/bad-tags.cjs';
+
+/**
+ * Entry for file
+ */
+interface ImportDirectoryFileEntry {
+    path: string;
+    subdir: string;
+    file: string;
+    ext: string;
+}
+/**
+ * Callback to get keyword for icon based on file name
+ *
+ * Returns:
+ * - string for new keyword
+ * - undefined to skip icon
+ *
+ * Callback can be asynchronous
+ */
+type ImportDirectoryKeywordCallbackResult = string | undefined;
+type Callback<T> = (file: ImportDirectoryFileEntry, defaultKeyword: string, iconSet: IconSet) => T;
+type AsyncCallback<T> = Callback<T | Promise<T>>;
+type ImportDirectoryKeywordCallback = AsyncCallback<ImportDirectoryKeywordCallbackResult>;
+type ImportDirectoryKeywordSyncCallback = Callback<ImportDirectoryKeywordCallbackResult>;
+/**
+ * Options
+ */
+interface ImportDirectoryOptions<K> extends CleanupSVGOptions {
+    prefix?: string;
+    includeSubDirs?: boolean;
+    keyword?: K;
+    ignoreImportErrors?: boolean | 'warn';
+}
+/**
+ * Import all icons from directory
+ */
+declare function importDirectory(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordCallback>): Promise<IconSet>;
+/**
+ * Import all icons from directory synchronously
+ */
+declare function importDirectorySync(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordSyncCallback>): IconSet;
+
+export { type ImportDirectoryFileEntry, type ImportDirectoryKeywordCallback, type ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };

package/lib/import/directory.d.mts

@@ -0,0 +1,52 @@
+import { IconSet } from '../icon-set/index.mjs';
+import { CleanupSVGOptions } from '../svg/cleanup.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';
+import '../svg/cleanup/bad-tags.mjs';
+
+/**
+ * Entry for file
+ */
+interface ImportDirectoryFileEntry {
+    path: string;
+    subdir: string;
+    file: string;
+    ext: string;
+}
+/**
+ * Callback to get keyword for icon based on file name
+ *
+ * Returns:
+ * - string for new keyword
+ * - undefined to skip icon
+ *
+ * Callback can be asynchronous
+ */
+type ImportDirectoryKeywordCallbackResult = string | undefined;
+type Callback<T> = (file: ImportDirectoryFileEntry, defaultKeyword: string, iconSet: IconSet) => T;
+type AsyncCallback<T> = Callback<T | Promise<T>>;
+type ImportDirectoryKeywordCallback = AsyncCallback<ImportDirectoryKeywordCallbackResult>;
+type ImportDirectoryKeywordSyncCallback = Callback<ImportDirectoryKeywordCallbackResult>;
+/**
+ * Options
+ */
+interface ImportDirectoryOptions<K> extends CleanupSVGOptions {
+    prefix?: string;
+    includeSubDirs?: boolean;
+    keyword?: K;
+    ignoreImportErrors?: boolean | 'warn';
+}
+/**
+ * Import all icons from directory
+ */
+declare function importDirectory(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordCallback>): Promise<IconSet>;
+/**
+ * Import all icons from directory synchronously
+ */
+declare function importDirectorySync(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordSyncCallback>): IconSet;
+
+export { type ImportDirectoryFileEntry, type ImportDirectoryKeywordCallback, type ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };

package/lib/import/directory.d.ts

@@ -49,4 +49,4 @@ declare function importDirectory(path: string, options?: ImportDirectoryOptions<
  */
 declare function importDirectorySync(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordSyncCallback>): IconSet;
 
-export { ImportDirectoryFileEntry, ImportDirectoryKeywordCallback, ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };
+export { type ImportDirectoryFileEntry, type ImportDirectoryKeywordCallback, type ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };

package/lib/import/figma/index.d.cts

@@ -0,0 +1,20 @@
+import { DocumentNotModified } from '../../download/types/modified.cjs';
+import { FigmaIfModifiedSinceOption, FigmaImportOptions } from './types/options.cjs';
+import { FigmaImportResult } from './types/result.cjs';
+import '../../icon-set/index.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';
+import './types/nodes.cjs';
+import './types/api.cjs';
+
+/**
+ * Import icon set from Figma
+ */
+declare function importFromFigma<T extends FigmaIfModifiedSinceOption & FigmaImportOptions>(options: T): Promise<FigmaImportResult | DocumentNotModified>;
+declare function importFromFigma(options: FigmaImportOptions): Promise<FigmaImportResult>;
+
+export { importFromFigma };

package/lib/import/figma/index.d.mts

@@ -0,0 +1,20 @@
+import { DocumentNotModified } from '../../download/types/modified.mjs';
+import { FigmaIfModifiedSinceOption, FigmaImportOptions } from './types/options.mjs';
+import { FigmaImportResult } from './types/result.mjs';
+import '../../icon-set/index.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';
+import './types/nodes.mjs';
+import './types/api.mjs';
+
+/**
+ * Import icon set from Figma
+ */
+declare function importFromFigma<T extends FigmaIfModifiedSinceOption & FigmaImportOptions>(options: T): Promise<FigmaImportResult | DocumentNotModified>;
+declare function importFromFigma(options: FigmaImportOptions): Promise<FigmaImportResult>;
+
+export { importFromFigma };

package/lib/import/figma/nodes.d.cts

@@ -0,0 +1,18 @@
+import { FigmaDocument } from './types/api.cjs';
+import { FigmaGetIconNodesOptions } from './types/options.cjs';
+import { FigmaNodesImportResult } from './types/result.cjs';
+import '../../icon-set/index.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';
+import './types/nodes.cjs';
+
+/**
+ * Get node ids for icons
+ */
+declare function getFigmaIconNodes(document: FigmaDocument, options: FigmaGetIconNodesOptions): FigmaNodesImportResult;
+
+export { getFigmaIconNodes };

package/lib/import/figma/nodes.d.mts

@@ -0,0 +1,18 @@
+import { FigmaDocument } from './types/api.mjs';
+import { FigmaGetIconNodesOptions } from './types/options.mjs';
+import { FigmaNodesImportResult } from './types/result.mjs';
+import '../../icon-set/index.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';
+import './types/nodes.mjs';
+
+/**
+ * Get node ids for icons
+ */
+declare function getFigmaIconNodes(document: FigmaDocument, options: FigmaGetIconNodesOptions): FigmaNodesImportResult;
+
+export { getFigmaIconNodes };

package/lib/import/figma/query.d.cts

@@ -0,0 +1,42 @@
+import { APICacheOptions } from '../../download/api/types.cjs';
+import { DocumentNotModified } from '../../download/types/modified.cjs';
+import { FigmaDocument } from './types/api.cjs';
+import { FigmaIfModifiedSinceOption, FigmaFilesQueryOptions, FigmaImagesQueryOptions } from './types/options.cjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './types/result.cjs';
+import '../../icon-set/index.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';
+import './types/nodes.cjs';
+
+/**
+ * Extra parameters added to runConcurrentQueries()
+ *
+ * Can be used to identify failed items in onfail callback
+ */
+interface FigmaIconNodeWithURL extends FigmaIconNode {
+    url: string;
+}
+type FigmaConcurrentQueriesParamsFunction = 'figmaImagesQuery' | 'figmaDownloadImages';
+interface FigmaConcurrentQueriesParams<T extends FigmaConcurrentQueriesParamsFunction> {
+    function: T;
+    payload: T extends 'figmaImagesQuery' ? string[][] : FigmaIconNodeWithURL[];
+}
+/**
+ * Get Figma files
+ */
+declare function figmaFilesQuery<T extends FigmaIfModifiedSinceOption & FigmaFilesQueryOptions>(options: T, cache?: APICacheOptions): Promise<FigmaDocument | DocumentNotModified>;
+declare function figmaFilesQuery(options: FigmaFilesQueryOptions, cache?: APICacheOptions): Promise<FigmaDocument>;
+/**
+ * Generate all images
+ */
+declare function figmaImagesQuery(options: FigmaImagesQueryOptions, nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
+/**
+ * Download all images
+ */
+declare function figmaDownloadImages(nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
+
+export { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

package/lib/import/figma/query.d.mts

@@ -0,0 +1,42 @@
+import { APICacheOptions } from '../../download/api/types.mjs';
+import { DocumentNotModified } from '../../download/types/modified.mjs';
+import { FigmaDocument } from './types/api.mjs';
+import { FigmaIfModifiedSinceOption, FigmaFilesQueryOptions, FigmaImagesQueryOptions } from './types/options.mjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './types/result.mjs';
+import '../../icon-set/index.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';
+import './types/nodes.mjs';
+
+/**
+ * Extra parameters added to runConcurrentQueries()
+ *
+ * Can be used to identify failed items in onfail callback
+ */
+interface FigmaIconNodeWithURL extends FigmaIconNode {
+    url: string;
+}
+type FigmaConcurrentQueriesParamsFunction = 'figmaImagesQuery' | 'figmaDownloadImages';
+interface FigmaConcurrentQueriesParams<T extends FigmaConcurrentQueriesParamsFunction> {
+    function: T;
+    payload: T extends 'figmaImagesQuery' ? string[][] : FigmaIconNodeWithURL[];
+}
+/**
+ * Get Figma files
+ */
+declare function figmaFilesQuery<T extends FigmaIfModifiedSinceOption & FigmaFilesQueryOptions>(options: T, cache?: APICacheOptions): Promise<FigmaDocument | DocumentNotModified>;
+declare function figmaFilesQuery(options: FigmaFilesQueryOptions, cache?: APICacheOptions): Promise<FigmaDocument>;
+/**
+ * Generate all images
+ */
+declare function figmaImagesQuery(options: FigmaImagesQueryOptions, nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
+/**
+ * Download all images
+ */
+declare function figmaDownloadImages(nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
+
+export { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

package/lib/import/figma/query.d.ts

@@ -39,4 +39,4 @@ declare function figmaImagesQuery(options: FigmaImagesQueryOptions, nodes: Figma
  */
 declare function figmaDownloadImages(nodes: FigmaNodesImportResult, cache?: APICacheOptions): Promise<FigmaNodesImportResult>;
 
-export { FigmaConcurrentQueriesParams, FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };
+export { type FigmaConcurrentQueriesParams, type FigmaConcurrentQueriesParamsFunction, figmaDownloadImages, figmaFilesQuery, figmaImagesQuery };

package/lib/import/figma/types/api.d.cts

@@ -0,0 +1,53 @@
+/**
+ * Basic document structure
+ */
+interface FigmaBoundingBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface BaseFigmaNode {
+    id: string;
+    name: string;
+}
+interface GenericFigmaNode extends BaseFigmaNode {
+    type: string;
+    children?: FigmaNode[];
+}
+interface IconFigmaNode extends BaseFigmaNode {
+    type: 'FRAME' | 'COMPONENT' | 'INSTANCE';
+    clipsContent?: boolean;
+    absoluteBoundingBox?: FigmaBoundingBox;
+    children: FigmaNode[];
+}
+interface FigmaDocumentNode extends BaseFigmaNode {
+    type: 'DOCUMENT';
+    children: FigmaNode[];
+}
+type FigmaNode = GenericFigmaNode | IconFigmaNode;
+/**
+ * Document response from API
+ */
+interface FigmaDocument {
+    document: FigmaDocumentNode;
+    name: string;
+    version: string;
+    lastModified: string;
+    thumbnailUrl: string;
+    role: string;
+    editorType: 'figma' | 'figjam';
+}
+interface FigmaAPIError {
+    status: number;
+    err: string;
+}
+/**
+ * Result for retrieved icons
+ */
+interface FigmaAPIImagesResponse {
+    err?: string | null;
+    images: Record<string, string | null>;
+}
+
+export type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

package/lib/import/figma/types/api.d.mts

@@ -0,0 +1,53 @@
+/**
+ * Basic document structure
+ */
+interface FigmaBoundingBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface BaseFigmaNode {
+    id: string;
+    name: string;
+}
+interface GenericFigmaNode extends BaseFigmaNode {
+    type: string;
+    children?: FigmaNode[];
+}
+interface IconFigmaNode extends BaseFigmaNode {
+    type: 'FRAME' | 'COMPONENT' | 'INSTANCE';
+    clipsContent?: boolean;
+    absoluteBoundingBox?: FigmaBoundingBox;
+    children: FigmaNode[];
+}
+interface FigmaDocumentNode extends BaseFigmaNode {
+    type: 'DOCUMENT';
+    children: FigmaNode[];
+}
+type FigmaNode = GenericFigmaNode | IconFigmaNode;
+/**
+ * Document response from API
+ */
+interface FigmaDocument {
+    document: FigmaDocumentNode;
+    name: string;
+    version: string;
+    lastModified: string;
+    thumbnailUrl: string;
+    role: string;
+    editorType: 'figma' | 'figjam';
+}
+interface FigmaAPIError {
+    status: number;
+    err: string;
+}
+/**
+ * Result for retrieved icons
+ */
+interface FigmaAPIImagesResponse {
+    err?: string | null;
+    images: Record<string, string | null>;
+}
+
+export type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

package/lib/import/figma/types/api.d.ts

@@ -50,4 +50,4 @@ interface FigmaAPIImagesResponse {
     images: Record<string, string | null>;
 }
 
-export { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };
+export type { FigmaAPIError, FigmaAPIImagesResponse, FigmaDocument, FigmaDocumentNode, FigmaNode, IconFigmaNode };

package/lib/import/figma/types/nodes.d.cts

@@ -0,0 +1,44 @@
+import { IconFigmaNode, FigmaDocument } from './api.cjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './result.cjs';
+import '../../../icon-set/index.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';
+
+type FigmaImportParentNodeType = 'CANVAS' | 'FRAME' | 'GROUP' | 'SECTION';
+type FigmaImportIconNodeType = IconFigmaNode['type'];
+/**
+ * Node information passed to callback
+ */
+interface FigmaParentNodeData {
+    id: string;
+    type: FigmaImportParentNodeType;
+    name: string;
+}
+interface FigmaImportNodeData {
+    id: string;
+    type: FigmaImportIconNodeType;
+    name: string;
+    width: number;
+    height: number;
+    parents: FigmaParentNodeData[];
+}
+/**
+ * Callback to check if node needs to be checked for icons
+ *
+ * Used to speed up processing by eleminating pages, frames and groups that do not need processing
+ */
+type FigmaImportParentNodeFilter = (node: FigmaParentNodeData[], document: FigmaDocument) => boolean;
+/**
+ * Check if node is an icon.
+ *
+ * Returns icon name on success, null or undefined if not should be ignored.
+ * Function can also return FigmaIconNode object, where it can put extra properties that can be used later
+ */
+type FigmaIconNodeWithKeyword = Partial<FigmaIconNode> & Pick<FigmaIconNode, 'keyword'>;
+type FigmaImportNodeFilter = (node: FigmaImportNodeData, nodes: FigmaNodesImportResult, document: FigmaDocument) => string | FigmaIconNodeWithKeyword | null | undefined;
+
+export type { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

package/lib/import/figma/types/nodes.d.mts

@@ -0,0 +1,44 @@
+import { IconFigmaNode, FigmaDocument } from './api.mjs';
+import { FigmaNodesImportResult, FigmaIconNode } from './result.mjs';
+import '../../../icon-set/index.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';
+
+type FigmaImportParentNodeType = 'CANVAS' | 'FRAME' | 'GROUP' | 'SECTION';
+type FigmaImportIconNodeType = IconFigmaNode['type'];
+/**
+ * Node information passed to callback
+ */
+interface FigmaParentNodeData {
+    id: string;
+    type: FigmaImportParentNodeType;
+    name: string;
+}
+interface FigmaImportNodeData {
+    id: string;
+    type: FigmaImportIconNodeType;
+    name: string;
+    width: number;
+    height: number;
+    parents: FigmaParentNodeData[];
+}
+/**
+ * Callback to check if node needs to be checked for icons
+ *
+ * Used to speed up processing by eleminating pages, frames and groups that do not need processing
+ */
+type FigmaImportParentNodeFilter = (node: FigmaParentNodeData[], document: FigmaDocument) => boolean;
+/**
+ * Check if node is an icon.
+ *
+ * Returns icon name on success, null or undefined if not should be ignored.
+ * Function can also return FigmaIconNode object, where it can put extra properties that can be used later
+ */
+type FigmaIconNodeWithKeyword = Partial<FigmaIconNode> & Pick<FigmaIconNode, 'keyword'>;
+type FigmaImportNodeFilter = (node: FigmaImportNodeData, nodes: FigmaNodesImportResult, document: FigmaDocument) => string | FigmaIconNodeWithKeyword | null | undefined;
+
+export type { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

package/lib/import/figma/types/nodes.d.ts

@@ -41,4 +41,4 @@ type FigmaImportParentNodeFilter = (node: FigmaParentNodeData[], document: Figma
 type FigmaIconNodeWithKeyword = Partial<FigmaIconNode> & Pick<FigmaIconNode, 'keyword'>;
 type FigmaImportNodeFilter = (node: FigmaImportNodeData, nodes: FigmaNodesImportResult, document: FigmaDocument) => string | FigmaIconNodeWithKeyword | null | undefined;
 
-export { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };
+export type { FigmaImportIconNodeType, FigmaImportNodeData, FigmaImportNodeFilter, FigmaImportParentNodeFilter, FigmaImportParentNodeType, FigmaParentNodeData };

package/lib/import/figma/types/options.d.cts

@@ -0,0 +1,59 @@
+import { IconSet } from '../../../icon-set/index.cjs';
+import { FigmaImportParentNodeFilter, FigmaImportNodeFilter } from './nodes.cjs';
+import { FigmaIconNode } from './result.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';
+import './api.cjs';
+
+/**
+ * Options for importing SVG
+ */
+interface FigmaImportSVGOptions {
+    includeID?: boolean;
+    simplifyStroke?: boolean;
+    useAbsoluteBounds?: boolean;
+}
+/**
+ * Options
+ */
+interface FigmaImportCommonOptions {
+    token: string;
+    file: string;
+    version?: string;
+}
+interface FigmaIfModifiedSinceOption {
+    ifModifiedSince: string | Date | true;
+}
+interface FigmaFilesQueryOptions extends FigmaImportCommonOptions, Partial<FigmaIfModifiedSinceOption> {
+    ids?: string[];
+    depth?: number;
+}
+interface FigmaImagesQueryOptions extends FigmaImportCommonOptions {
+    svgOptions?: FigmaImportSVGOptions;
+}
+interface FigmaGetIconNodesOptions {
+    pages?: string[];
+    filterParentNode?: FigmaImportParentNodeFilter;
+    iconNameForNode: FigmaImportNodeFilter;
+}
+/**
+ * Callback to call before or after importing icon
+ */
+type FigmaImportedIconCallback = (node: FigmaIconNode, iconSet: IconSet) => void | Promise<void>;
+/**
+ * Options for main import function
+ */
+interface FigmaImportOptions extends FigmaFilesQueryOptions, FigmaImagesQueryOptions, FigmaGetIconNodesOptions {
+    prefix: string;
+    cacheDir?: string;
+    cacheAPITTL?: number;
+    cacheSVGTTL?: number;
+    beforeImportingIcon?: FigmaImportedIconCallback;
+    afterImportingIcon?: FigmaImportedIconCallback;
+}
+
+export type { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };

package/lib/import/figma/types/options.d.mts

@@ -0,0 +1,59 @@
+import { IconSet } from '../../../icon-set/index.mjs';
+import { FigmaImportParentNodeFilter, FigmaImportNodeFilter } from './nodes.mjs';
+import { FigmaIconNode } from './result.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';
+import './api.mjs';
+
+/**
+ * Options for importing SVG
+ */
+interface FigmaImportSVGOptions {
+    includeID?: boolean;
+    simplifyStroke?: boolean;
+    useAbsoluteBounds?: boolean;
+}
+/**
+ * Options
+ */
+interface FigmaImportCommonOptions {
+    token: string;
+    file: string;
+    version?: string;
+}
+interface FigmaIfModifiedSinceOption {
+    ifModifiedSince: string | Date | true;
+}
+interface FigmaFilesQueryOptions extends FigmaImportCommonOptions, Partial<FigmaIfModifiedSinceOption> {
+    ids?: string[];
+    depth?: number;
+}
+interface FigmaImagesQueryOptions extends FigmaImportCommonOptions {
+    svgOptions?: FigmaImportSVGOptions;
+}
+interface FigmaGetIconNodesOptions {
+    pages?: string[];
+    filterParentNode?: FigmaImportParentNodeFilter;
+    iconNameForNode: FigmaImportNodeFilter;
+}
+/**
+ * Callback to call before or after importing icon
+ */
+type FigmaImportedIconCallback = (node: FigmaIconNode, iconSet: IconSet) => void | Promise<void>;
+/**
+ * Options for main import function
+ */
+interface FigmaImportOptions extends FigmaFilesQueryOptions, FigmaImagesQueryOptions, FigmaGetIconNodesOptions {
+    prefix: string;
+    cacheDir?: string;
+    cacheAPITTL?: number;
+    cacheSVGTTL?: number;
+    beforeImportingIcon?: FigmaImportedIconCallback;
+    afterImportingIcon?: FigmaImportedIconCallback;
+}
+
+export type { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };

package/lib/import/figma/types/options.d.ts

@@ -56,4 +56,4 @@ interface FigmaImportOptions extends FigmaFilesQueryOptions, FigmaImagesQueryOpt
     afterImportingIcon?: FigmaImportedIconCallback;
 }
 
-export { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };
+export type { FigmaFilesQueryOptions, FigmaGetIconNodesOptions, FigmaIfModifiedSinceOption, FigmaImagesQueryOptions, FigmaImportOptions, FigmaImportSVGOptions };