@sit-onyx/figma-utils 0.0.0-20250804145452

package/LICENSE.txt

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023 Schwarz IT KG
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,22 @@
+<div align="center" style="text-align: center">
+  <img alt="onyx logo" src="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo.svg" height="96px">
+</div>
+
+<br>
+
+# @sit-onyx/figma-utils
+
+Utility functions and CLI for importing data from the Figma API into different formats (e.g. CSS, SCSS etc.).
+Created by [Schwarz IT](https://it.schwarz).
+
+## Use as CLI
+
+For a list of supported commands and options, run:
+
+```sh
+npx @sit-onyx/figma-utils@latest --help
+```
+
+## Documentation
+
+You can find our documentation [here](https://onyx.schwarz/development/packages/figma-utils.html).

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import fs from "node:fs";
+import { fileURLToPath, URL } from "node:url";
+import { importFlagsCommand } from "./commands/import-flags.js";
+import { importIconsCommand } from "./commands/import-icons.js";
+import { importVariablesCommand } from "./commands/import-variables.js";
+const packageJson = JSON.parse(fs.readFileSync(fileURLToPath(new URL("../package.json", import.meta.url)), "utf8"));
+const cli = new Command();
+cli.version(packageJson.version, "-v, --version").description(packageJson.description);
+const availableCommands = [importVariablesCommand, importIconsCommand, importFlagsCommand];
+availableCommands.forEach((command) => cli.addCommand(command));
+cli.parse();

package/dist/commands/import-flags.d.ts

@@ -0,0 +1,13 @@
+import { Command } from "commander";
+export type ImportFlagsCommandOptions = {
+    fileKey: string;
+    token: string;
+    pageId: string;
+    dir?: string;
+    metaFile?: string;
+};
+export declare const importFlagsCommand: Command;
+/**
+ * Action to run when executing the import action. Only intended to be called manually for testing.
+ */
+export declare function importFlagsCommandAction(options: ImportFlagsCommandOptions): Promise<void>;

package/dist/commands/import-flags.js

@@ -0,0 +1,42 @@
+import { Command } from "commander";
+import { mkdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { writeFlagMetadata } from "../flags/generate.js";
+import { parseComponentsToFlags } from "../flags/parse.js";
+import { fetchFigmaComponents, fetchFigmaSVGs } from "../index.js";
+import { optimizeSvg } from "../utils/optimize.js";
+export const importFlagsCommand = new Command("import-flags")
+    .description("CLI tool to import SVG flags from Figma.")
+    .requiredOption("-k, --file-key <string>", "Figma file key (required)")
+    .requiredOption("-t, --token <string>", "Figma access token with scope `file_read` or `files:read` (required)")
+    .requiredOption("-p, --page-id <string>", "Figma page ID that contains the flags (required)")
+    .option("-d, --dir <string>", "Directory to save the flags to. Defaults to current working directory of the script.")
+    .option("-m, --meta-file <string>", 'JSON filename/path to write flag metadata to (country name etc.). Must end with ".json". If unset, no metadata will be generated.')
+    .action(importFlagsCommandAction);
+/**
+ * Action to run when executing the import action. Only intended to be called manually for testing.
+ */
+export async function importFlagsCommandAction(options) {
+    console.log("Fetching components from Figma API...");
+    const data = await fetchFigmaComponents(options.fileKey, options.token);
+    console.log("Parsing Figma flags...");
+    const parsedFlags = parseComponentsToFlags({
+        components: data.meta.components,
+        pageId: options.pageId,
+    });
+    const outputDirectory = options.dir ?? process.cwd();
+    console.log(`Fetching SVG content for ${parsedFlags.length} flags...`);
+    const svgContents = await fetchFigmaSVGs(options.fileKey, parsedFlags.map(({ id }) => id), options.token);
+    console.log("Optimizing and writing flag files...");
+    await mkdir(outputDirectory, { recursive: true });
+    await Promise.all(parsedFlags.map((flag) => {
+        const content = optimizeSvg(svgContents[flag.id], "image");
+        const fullPath = path.join(outputDirectory, `${flag.code}.svg`);
+        return writeFile(fullPath, content, "utf-8");
+    }));
+    if (options.metaFile) {
+        console.log("Writing flag metadata...");
+        await writeFlagMetadata(options.metaFile, parsedFlags);
+    }
+    console.log("Done.");
+}

package/dist/commands/import-icons.d.ts

@@ -0,0 +1,14 @@
+import { Command } from "commander";
+export type ImportIconsCommandOptions = {
+    fileKey: string;
+    token: string;
+    pageId: string;
+    aliasSeparator: string;
+    dir?: string;
+    metaFile?: string;
+};
+export declare const importIconsCommand: Command;
+/**
+ * Action to run when executing the import action. Only intended to be called manually for testing.
+ */
+export declare function importIconsCommandAction(options: ImportIconsCommandOptions): Promise<void>;

package/dist/commands/import-icons.js

@@ -0,0 +1,44 @@
+import { Command } from "commander";
+import { mkdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { writeIconMetadata } from "../icons/generate.js";
+import { parseComponentsToIcons } from "../icons/parse.js";
+import { fetchFigmaComponents, fetchFigmaSVGs } from "../index.js";
+import { optimizeSvg } from "../utils/optimize.js";
+export const importIconsCommand = new Command("import-icons")
+    .description("CLI tool to import SVG icons from Figma.")
+    .requiredOption("-k, --file-key <string>", "Figma file key (required)")
+    .requiredOption("-t, --token <string>", "Figma access token with scope `file_read` or `files:read` (required)")
+    .requiredOption("-p, --page-id <string>", "Figma page ID that contains the icons (required)")
+    .option("-d, --dir <string>", "Directory to save the icons to. Defaults to current working directory of the script.")
+    .option("-m, --meta-file <string>", 'JSON filename/path to write icon metadata to (categories, alias names etc.). Must end with ".json". If unset, no metadata will be generated.')
+    .option("-s, --alias-separator <string>", "Separator for icon alias names (which can be set to the component description in Figma).", ",")
+    .action(importIconsCommandAction);
+/**
+ * Action to run when executing the import action. Only intended to be called manually for testing.
+ */
+export async function importIconsCommandAction(options) {
+    console.log("Fetching components from Figma API...");
+    const data = await fetchFigmaComponents(options.fileKey, options.token);
+    console.log("Parsing Figma icons...");
+    const parsedIcons = parseComponentsToIcons({
+        components: data.meta.components,
+        pageId: options.pageId,
+        aliasSeparator: options.aliasSeparator,
+    });
+    const outputDirectory = options.dir ?? process.cwd();
+    console.log(`Fetching SVG content for ${parsedIcons.length} icons...`);
+    const svgContents = await fetchFigmaSVGs(options.fileKey, parsedIcons.map(({ id }) => id), options.token);
+    console.log("Optimizing and writing icon files...");
+    await mkdir(outputDirectory, { recursive: true });
+    await Promise.all(parsedIcons.map((icon) => {
+        const content = optimizeSvg(svgContents[icon.id]);
+        const fullPath = path.join(outputDirectory, `${icon.name}.svg`);
+        return writeFile(fullPath, content, "utf-8");
+    }));
+    if (options.metaFile) {
+        console.log("Writing icon metadata...");
+        await writeIconMetadata(options.metaFile, parsedIcons);
+    }
+    console.log("Done.");
+}

package/dist/commands/import-variables.d.ts

@@ -0,0 +1,16 @@
+import { Command } from "commander";
+export type ImportVariablesCommandOptions = {
+    fileKey: string;
+    token: string;
+    format: string[];
+    filename?: string;
+    dir?: string;
+    modes?: string[];
+    combinesDarkLight?: boolean;
+    selector: string;
+};
+export declare const importVariablesCommand: Command;
+/**
+ * Action to run when executing the import action. Only intended to be called manually for testing.
+ */
+export declare function importVariablesCommandAction(options: ImportVariablesCommandOptions): Promise<void>;

package/dist/commands/import-variables.js

@@ -0,0 +1,77 @@
+import { Command } from "commander";
+import fs from "node:fs";
+import path from "node:path";
+import { DEFAULT_MODE_NAME, fetchFigmaVariables, generateAsCSS, generateAsJSON, generateAsSCSS, parseFigmaVariables, } from "../index.js";
+export const importVariablesCommand = new Command("import-variables")
+    .description("CLI tool to import Figma variables into CSS, SCSS etc. variables.")
+    .requiredOption("-k, --file-key <string>", "Figma file key (required)")
+    .requiredOption("-t, --token <string>", "Figma access token with scope `file_variables:read` (required)")
+    .option("-f, --format <strings...>", "Output formats. Supported are: CSS, SCSS, JSON", ["CSS"])
+    .option("-n, --filename <string>", "Base name / prefix of the generated variables file. Will append the mode name")
+    .option("-d, --dir <string>", "Working directory to use. Defaults to current working directory of the script.")
+    .option("-m, --modes <strings...>", "Can be used to only export specific Figma modes. If unset, all modes will be exported as a separate file.")
+    .option("-c, --combines-dark-light", "Combines the dark theme data with the light theme data by using the light-dark() CSS function. The Figma file must include two modes with -light and -dark prefix, e.g. example-light and example-dark.")
+    .option("-s, --selector <string>", 'CSS selector to use for the CSS format. You can use {mode} as placeholder for the mode name, so e.g. for the mode named "dark", passing the selector "html.{mode}" will result in "html.dark"', ":root")
+    .action(importVariablesCommandAction);
+/**
+ * Action to run when executing the import action. Only intended to be called manually for testing.
+ */
+export async function importVariablesCommandAction(options) {
+    const generators = {
+        CSS: (data, dataDark) => generateAsCSS(data, { selector: options.selector, dataDarkTheme: dataDark }),
+        SCSS: (data, dataDark) => generateAsSCSS(data, { dataDarkTheme: dataDark }),
+        JSON: (data) => generateAsJSON(data),
+    };
+    options.format.forEach((format) => {
+        if (!(format in generators)) {
+            throw new Error(`Unknown format "${format}". Supported: ${Object.keys(generators).join(", ")}`);
+        }
+    });
+    console.log("Fetching variables from Figma API...");
+    const data = await fetchFigmaVariables(options.fileKey, options.token);
+    console.log("Parsing Figma variables...");
+    const parsedVariables = parseFigmaVariables(data);
+    if (options.modes?.length) {
+        // verify that all modes are found
+        options.modes.forEach((mode) => {
+            if (parsedVariables.find((i) => i.modeName === mode))
+                return;
+            const availableModes = parsedVariables
+                .map((i) => i.modeName ?? DEFAULT_MODE_NAME)
+                .map((mode) => `"${mode}"`);
+            throw new Error(`Mode "${mode}" not found. Available modes: ${Object.values(availableModes).join(", ")}`);
+        });
+    }
+    const outputDirectory = options.dir ?? process.cwd();
+    console.log(`Generating ${options.format} variables...`);
+    const getBaseFileName = (modeName = "default") => {
+        if (options.filename)
+            return `${options.filename}${modeName}`;
+        return modeName;
+    };
+    options.format.forEach((format) => {
+        console.log(`Generating ${format} variables...`);
+        parsedVariables.forEach((data) => {
+            // if the user passed specific modes to be exported, we will only generate those
+            // otherwise all modes will be exported.
+            // the default mode (undefined data.modeName) is always generated because its mode name can
+            // not be specified by the designer in Figma
+            const isModeIncluded = !options.modes?.length || !data.modeName || options.modes.includes(data.modeName);
+            if (!isModeIncluded)
+                return;
+            const baseName = getBaseFileName(data.modeName);
+            if (options.combinesDarkLight) {
+                const themeName = baseName.replace("-light", "").replace("-dark", "");
+                const fullPath = path.join(outputDirectory, `${themeName}.${format.toLowerCase()}`);
+                // find the matching theme
+                const dataDark = parsedVariables.find((themeData) => themeData.modeName === themeName + "-dark");
+                fs.writeFileSync(fullPath, generators[format]({ ...data, modeName: themeName }, dataDark));
+            }
+            else {
+                const fullPath = path.join(outputDirectory, `${baseName}.${format.toLowerCase()}`);
+                fs.writeFileSync(fullPath, generators[format](data));
+            }
+        });
+    });
+    console.log("Done.");
+}

package/dist/flags/generate.d.ts

@@ -0,0 +1,8 @@
+import { ParsedFlag } from "../types/figma.js";
+/**
+ * Writes a JSON file with metadata of the given flags (code, name etc.).
+ *
+ * @param path File path of the .json file, e.g. "./metadata.json"
+ * @param flags Flags to write metadata for
+ */
+export declare const writeFlagMetadata: (path: string, flags: ParsedFlag[]) => Promise<void>;

package/dist/flags/generate.js

@@ -0,0 +1,18 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+/**
+ * Writes a JSON file with metadata of the given flags (code, name etc.).
+ *
+ * @param path File path of the .json file, e.g. "./metadata.json"
+ * @param flags Flags to write metadata for
+ */
+export const writeFlagMetadata = async (path, flags) => {
+    const metaDirname = dirname(path);
+    await mkdir(metaDirname, { recursive: true });
+    const flagMetadata = flags.reduce((meta, flag) => {
+        const { id: _id, code, ...rest } = flag;
+        meta[code] = rest;
+        return meta;
+    }, {});
+    await writeFile(path, JSON.stringify(flagMetadata, null, 2), "utf-8");
+};

package/dist/flags/parse.d.ts

@@ -0,0 +1,12 @@
+import { Component, ParsedFlag } from "../types/figma.js";
+export type ParseFlagComponentsOptions = {
+    /**
+     * Available Figma components.
+     */
+    components: Component[];
+    /**
+     * Page ID that contains all flags. Components will be filtered accordingly.
+     */
+    pageId: string;
+};
+export declare const parseComponentsToFlags: (options: ParseFlagComponentsOptions) => ParsedFlag[];

package/dist/flags/parse.js

@@ -0,0 +1,34 @@
+/**
+ * Map of country names for country codes that are not (yet) supported by `Intl.DisplayNames`.
+ */
+const UNKNOWN_COUNTRY_NAMES = {
+    "CA-BC": "British Columbia",
+    "GB-ENG": "England",
+    "GB-SCT": "Scotland",
+    "GB-WLS": "Wales",
+    "US-HI": "Hawaii",
+};
+export const parseComponentsToFlags = (options) => {
+    const pageComponents = options.components.filter(({ containing_frame }) => containing_frame.pageId === options.pageId);
+    const countryCodeFormatter = new Intl.DisplayNames("en", { type: "region" });
+    return (pageComponents
+        .map((component) => {
+        const code = component.description.trim();
+        let internationalName = UNKNOWN_COUNTRY_NAMES[code] ?? "";
+        try {
+            internationalName = countryCodeFormatter.of(code) || internationalName;
+        }
+        catch {
+            // noop
+        }
+        return {
+            id: component.node_id,
+            code,
+            continent: component.containing_frame.name.trim(),
+            internationalName,
+        };
+    })
+        // remove invalid flags without a country code
+        .filter(({ code }) => code)
+        .sort((a, b) => a.code.localeCompare(b.code)));
+};

package/dist/icons/generate.d.ts

@@ -0,0 +1,8 @@
+import { ParsedIcon } from "../types/figma.js";
+/**
+ * Writes a JSON file with metadata of the given icons (category, aliases etc.).
+ *
+ * @param path File path of the .json file, e.g. "./metadata.json"
+ * @param icons Icons to write metadata for
+ */
+export declare const writeIconMetadata: (path: string, icons: ParsedIcon[]) => Promise<void>;

package/dist/icons/generate.js

@@ -0,0 +1,18 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+/**
+ * Writes a JSON file with metadata of the given icons (category, aliases etc.).
+ *
+ * @param path File path of the .json file, e.g. "./metadata.json"
+ * @param icons Icons to write metadata for
+ */
+export const writeIconMetadata = async (path, icons) => {
+    const metaDirname = dirname(path);
+    await mkdir(metaDirname, { recursive: true });
+    const iconMetadata = icons.reduce((meta, icon) => {
+        const { id: _id, name, ...rest } = icon;
+        meta[name] = rest;
+        return meta;
+    }, {});
+    await writeFile(path, JSON.stringify(iconMetadata, null, 2), "utf-8");
+};

package/dist/icons/parse.d.ts

@@ -0,0 +1,18 @@
+import { Component, ParsedIcon } from "../types/figma.js";
+export type ParseIconComponentsOptions = {
+    /**
+     * Available Figma components.
+     */
+    components: Component[];
+    /**
+     * Page ID that contains all icons. Components will be filtered accordingly.
+     */
+    pageId: string;
+    /**
+     * Separator for icon alias names (which can be set to the component description in Figma).
+     *
+     * @default ","
+     */
+    aliasSeparator?: string;
+};
+export declare const parseComponentsToIcons: (options: ParseIconComponentsOptions) => ParsedIcon[];

package/dist/icons/parse.js

@@ -0,0 +1,16 @@
+export const parseComponentsToIcons = (options) => {
+    const pageComponents = options.components.filter(({ containing_frame }) => containing_frame.pageId === options.pageId);
+    return pageComponents
+        .map((component) => {
+        return {
+            id: component.node_id,
+            name: component.name,
+            category: component.containing_frame.name.trim(),
+            aliases: component.description
+                .split(options.aliasSeparator ?? ",")
+                .map((alias) => alias.trim())
+                .filter((i) => i !== ""),
+        };
+    })
+        .sort((a, b) => a.name.localeCompare(b.name));
+};

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./flags/generate.js";
+export * from "./flags/parse.js";
+export * from "./icons/generate.js";
+export * from "./icons/parse.js";
+export * from "./types/figma.js";
+export * from "./utils/fetch.js";
+export * from "./utils/optimize.js";
+export * from "./variables/generate.js";
+export * from "./variables/parse.js";

package/dist/index.js

@@ -0,0 +1,9 @@
+export * from "./flags/generate.js";
+export * from "./flags/parse.js";
+export * from "./icons/generate.js";
+export * from "./icons/parse.js";
+export * from "./types/figma.js";
+export * from "./utils/fetch.js";
+export * from "./utils/optimize.js";
+export * from "./variables/generate.js";
+export * from "./variables/parse.js";