@sit-onyx/figma-utils 0.0.0

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,48 @@
+# @sit-onyx/figma-utils
+
+Utility functions and CLI for importing data from the Figma API into CSS/SCSS variables.
+
+## Use as CLI
+
+For a list of supported commands and options, run:
+
+```sh
+npx @sit-onyx/figma-utils@latest --help
+```
+
+## Use as npm package
+
+This package also provides utility functions for importing data from the Figma API.
+This is useful if you want customize the CLI commands to have full control over the output.
+
+```sh
+npm install @sit-onyx/figma-utils
+```
+
+### Examples
+
+```ts
+import fs from "node:fs";
+import path from "node:path";
+import { fetchFigmaVariables, generateAsCSS, parseFigmaVariables } from "@sit-onyx/figma-utils";
+
+const FILE_KEY = "your-figma-file-key";
+const FIGMA_TOKEN = "your-figma-access-token";
+
+// fetch variables from Figma API
+const data = await fetchFigmaVariables(FILE_KEY, FIGMA_TOKEN);
+
+// parse variables into a readable and normalized format
+const parsedVariables = parseFigmaVariables(data);
+
+// generate .css files for every Figma mode
+parsedVariables.forEach((mode) => {
+  // get .css file content
+  const fileContent = generateAsCSS(mode);
+
+  // write content as a file
+  const filename = mode.modeName ? `variables-${mode.modeName}.css` : "variables.css";
+  const fullPath = path.join(process.cwd(), filename);
+  fs.writeFileSync(fullPath, fileContent);
+});
+```

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import fs from "node:fs";
+import { fileURLToPath, URL } from "node:url";
+import { importCommand } 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 = [importCommand];
+availableCommands.forEach((command) => cli.addCommand(command));
+cli.parse();

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

@@ -0,0 +1,2 @@
+import { Command } from "commander";
+export declare const importCommand: Command;

package/dist/commands/import-variables.js

@@ -0,0 +1,52 @@
+import { Command } from "commander";
+import fs from "node:fs";
+import path from "node:path";
+import { DEFAULT_MODE_NAME, fetchFigmaVariables, generateAsCSS, generateAsSCSS, parseFigmaVariables, } from "../index.js";
+export const importCommand = 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 <string>", "Output format. Supported are: CSS, SCSS", "CSS")
+    .option("-n, --filename <string>", "Base name of the generated variables file", "variables")
+    .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.")
+    .action(async (options) => {
+    const generators = {
+        CSS: generateAsCSS,
+        SCSS: generateAsSCSS,
+    };
+    if (!(options.format in generators)) {
+        throw new Error(`Unknown format: ${options.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
+        for (const mode of options.modes) {
+            if (parsedVariables.find((i) => i.modeName === mode))
+                continue;
+            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();
+    const filename = options.filename ?? "variables";
+    console.log(`Generating ${options.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 = data.modeName ? `${filename}-${data.modeName}` : filename;
+        const fullPath = path.join(outputDirectory, `${baseName}.${options.format.toLowerCase()}`);
+        fs.writeFileSync(fullPath, generators[options.format](data));
+    });
+    console.log("Done.");
+});

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./types/figma.js";
+export * from "./utils/fetch.js";
+export * from "./utils/generate.js";
+export * from "./utils/parse.js";

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./types/figma.js";
+export * from "./utils/fetch.js";
+export * from "./utils/generate.js";
+export * from "./utils/parse.js";

package/dist/types/figma.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Figma API response when fetching from https://api.figma.com/v1/files/${fileKey}/variables/local
+ */
+export type FigmaVariablesApiResponse = {
+    meta: {
+        variableCollections: Record<string, VariablesCollection>;
+        variables: Record<string, Variable>;
+    };
+};
+export type VariablesCollection = {
+    defaultModeId: string;
+    hiddenFromPublishing: boolean;
+    modes: Mode[];
+};
+export type Mode = {
+    modeId: string;
+    name: string;
+};
+export type Variable = {
+    name: string;
+    variableCollectionId: string;
+    hiddenFromPublishing: boolean;
+    valuesByMode: Record<string, VariableValue>;
+};
+export type VariableValue = RGBAValue | ColorsAlias | number;
+export type RGBAValue = {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+};
+export type ColorsAlias = {
+    type: "VARIABLE_ALIAS";
+    id: string;
+};
+export type ParsedVariable = {
+    /** Figma mode name or undefined if its the default mode. */
+    modeName?: string;
+    /**
+     * Mapping from variable name to its value.
+     * @example
+     * ```json
+     * {
+     *    "primary-100": "#ffffff",
+     *    "border-radius-s": "1rem",
+     * }
+     * ```
+     */
+    variables: Record<string, string>;
+};

package/dist/types/figma.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/fetch.d.ts

@@ -0,0 +1,8 @@
+import { FigmaVariablesApiResponse } from "../types/figma.js";
+/**
+ * Fetches the Figma Variables for the given file from the Figma API v1.
+ *
+ * @param fileKey File key. Example: https://www.figma.com/file/your-file-key-here
+ * @param accessToken Personal access token with scope/permission `file_variables:read`
+ */
+export declare const fetchFigmaVariables: (fileKey: string, accessToken: string) => Promise<FigmaVariablesApiResponse>;

package/dist/utils/fetch.js

@@ -0,0 +1,18 @@
+/**
+ * Fetches the Figma Variables for the given file from the Figma API v1.
+ *
+ * @param fileKey File key. Example: https://www.figma.com/file/your-file-key-here
+ * @param accessToken Personal access token with scope/permission `file_variables:read`
+ */
+export const fetchFigmaVariables = async (fileKey, accessToken) => {
+    const response = await fetch(`https://api.figma.com/v1/files/${fileKey}/variables/local`, {
+        headers: {
+            "X-FIGMA-TOKEN": accessToken,
+        },
+    });
+    const body = await response.json();
+    if (response.status !== 200) {
+        throw new Error(`Figma API request failed. Response body: ${JSON.stringify(body)}`);
+    }
+    return body;
+};

package/dist/utils/generate.d.ts

@@ -0,0 +1,24 @@
+import { ParsedVariable } from "../types/figma.js";
+/**
+ * Generates the given parsed Figma variables into CSS variables.
+ *
+ * @returns File content of the .css file
+ */
+export declare const generateAsCSS: (data: ParsedVariable) => string;
+/**
+ * Generates the given parsed Figma variables into SCSS variables.
+ *
+ * @returns File content of the .scss file
+ */
+export declare const generateAsSCSS: (data: ParsedVariable) => string;
+/**
+ * Checks whether the given variable value is an alias / variable reference to another variable.
+ * Alias values are enclosed by curly braces.
+ *
+ * @example "{your-variable-name}"
+ * @returns `isAlias` whether the variable is an alias and `variableName` the raw variable name without curly braces.
+ */
+export declare const isAliasVariable: (variableValue: string) => {
+    isAlias: RegExpExecArray | null;
+    variableName: string;
+};

package/dist/utils/generate.js

@@ -0,0 +1,54 @@
+/**
+ * Generates the given parsed Figma variables into CSS variables.
+ *
+ * @returns File content of the .css file
+ */
+export const generateAsCSS = (data) => {
+    return genericGenerator({
+        data,
+        nameTransformer: (name) => `--${name}`,
+        aliasTransformer: (name) => `var(--${name})`,
+    });
+};
+/**
+ * Generates the given parsed Figma variables into SCSS variables.
+ *
+ * @returns File content of the .scss file
+ */
+export const generateAsSCSS = (data) => {
+    return genericGenerator({
+        data,
+        nameTransformer: (name) => `$${name}`,
+        aliasTransformer: (name) => `$${name}`,
+    });
+};
+/**
+ * Generic base generator for CSS, SCSS etc. files.
+ * Will take care of defining selectors and formatting.
+ */
+const genericGenerator = (options) => {
+    const variableContent = Object.entries(options.data.variables).map(([name, value]) => {
+        const { isAlias, variableName } = isAliasVariable(value);
+        const variableValue = isAlias ? options.aliasTransformer(variableName) : value;
+        return `  ${options.nameTransformer(name)}: ${variableValue};`;
+    });
+    const timestamp = new Date().toUTCString();
+    const mode = options.data.modeName;
+    return `/**
+ * Do not edit directly.${mode ? `\n * This file contains the specific variables for the "${mode}" theme.` : ""}
+ * Imported from Figma API on ${timestamp}
+ */
+:root {\n${variableContent.join("\n")}\n}\n`;
+};
+/**
+ * Checks whether the given variable value is an alias / variable reference to another variable.
+ * Alias values are enclosed by curly braces.
+ *
+ * @example "{your-variable-name}"
+ * @returns `isAlias` whether the variable is an alias and `variableName` the raw variable name without curly braces.
+ */
+export const isAliasVariable = (variableValue) => {
+    const isAlias = /{.*}/.exec(variableValue);
+    const variableName = variableValue.replace("{", "").replace("}", "");
+    return { isAlias, variableName };
+};

package/dist/utils/parse.d.ts

@@ -0,0 +1,42 @@
+import { FigmaVariablesApiResponse, ParsedVariable, RGBAValue, Variable, VariableValue } from "../types/figma.js";
+export type ParseFigmaVariablesOptions = {
+    /**
+     * Base for converting pixel in rem. Set to `false` for disabling rem conversion and use pixel values.
+     * @default 16
+     */
+    remBase?: number | false;
+};
+/** Default Figma mode name if only one mode exists and no other name is specified by the designer. */
+export declare const DEFAULT_MODE_NAME: "Mode 1";
+/**
+ * Parses Figma variables received from the Figma API to a minimal JSON.
+ * Numeric / pixel values will be transformed to rem.
+ * Variables / collections that are hidden from publishing will not be parsed.
+ *
+ * @param apiResponse Variables response body received from the Figma API.
+ */
+export declare const parseFigmaVariables: (apiResponse: FigmaVariablesApiResponse, options?: ParseFigmaVariablesOptions) => ParsedVariable[];
+/**
+ * Resolves the given Figma variable value to a string value. Value types:
+ * - number: converted to rem, e.g. 16 => "1rem"
+ * - color: converted to HEX color, e.g. {r:1, g: 1, b: 1, a: 1} => "#ffffff"
+ * - alias: referenced with variable name, e.g. "--primary-100" => "{--primary-100}"
+ * (curly brackets will indicate that the value is an alias / reference)
+ *
+ * @param value Figma variable value
+ * @param allVariables Object of all variables. Needed for variables that use aliases.
+ */
+export declare const resolveFigmaVariableValue: (value: VariableValue, allVariables: Record<string, Variable>, remBase?: ParseFigmaVariablesOptions["remBase"]) => string;
+/**
+ * Converts a RGBA value to a hex color.
+ * Transparency will only be added if its not 1, e.g. "#000000" instead of "#000000ff"
+ */
+export declare const rgbaToHex: (value: RGBAValue) => string;
+/**
+ * Normalizes the given variable name by apply these transformations:
+ * - replace slashes with "-"
+ * - replace whitespace with "-"
+ * - replace "+" with "-"
+ * - replace "&" with "-"
+ */
+export declare const normalizeVariableName: (name: string) => string;

package/dist/utils/parse.js

@@ -0,0 +1,98 @@
+/** Default Figma mode name if only one mode exists and no other name is specified by the designer. */
+export const DEFAULT_MODE_NAME = "Mode 1";
+/**
+ * Parses Figma variables received from the Figma API to a minimal JSON.
+ * Numeric / pixel values will be transformed to rem.
+ * Variables / collections that are hidden from publishing will not be parsed.
+ *
+ * @param apiResponse Variables response body received from the Figma API.
+ */
+export const parseFigmaVariables = (apiResponse, options) => {
+    const parsedData = [];
+    /**
+     * Loop through each variable and mode and create a new object.
+     */
+    Object.values(apiResponse.meta.variables).forEach((variable) => {
+        const collection = apiResponse.meta.variableCollections[variable.variableCollectionId];
+        if (variable.hiddenFromPublishing || collection.hiddenFromPublishing)
+            return;
+        // parse variable value for every mode
+        Object.values(collection.modes).forEach((mode) => {
+            const variableName = normalizeVariableName(variable.name);
+            const variableValue = resolveFigmaVariableValue(variable.valuesByMode?.[mode.modeId], apiResponse.meta.variables, options?.remBase);
+            // add/update parsed variable value
+            const existingIndex = parsedData.findIndex((i) => i.modeName === mode.name);
+            if (existingIndex !== -1) {
+                parsedData[existingIndex].variables[variableName] = variableValue;
+            }
+            else {
+                parsedData.push({
+                    modeName: mode.name,
+                    variables: { [variableName]: variableValue },
+                });
+            }
+        });
+    });
+    parsedData.forEach((data) => {
+        if (data.modeName === "DEFAULT_MODE_NAME")
+            delete data.modeName;
+    });
+    return parsedData;
+};
+/**
+ * Resolves the given Figma variable value to a string value. Value types:
+ * - number: converted to rem, e.g. 16 => "1rem"
+ * - color: converted to HEX color, e.g. {r:1, g: 1, b: 1, a: 1} => "#ffffff"
+ * - alias: referenced with variable name, e.g. "--primary-100" => "{--primary-100}"
+ * (curly brackets will indicate that the value is an alias / reference)
+ *
+ * @param value Figma variable value
+ * @param allVariables Object of all variables. Needed for variables that use aliases.
+ */
+export const resolveFigmaVariableValue = (value, allVariables, remBase = 16) => {
+    if (typeof value === "number") {
+        // numeric value, parse as rem or pixel value
+        if (value === 0)
+            return "0";
+        if (remBase === false || remBase <= 0)
+            return `${value}px`;
+        return `${value / remBase}rem`;
+    }
+    if ("type" in value) {
+        // parse value as alias
+        if (value.type !== "VARIABLE_ALIAS") {
+            throw new Error(`Unknown variable value type: ${value.type}`);
+        }
+        const reference = allVariables[value.id];
+        if (!reference) {
+            throw new Error(`Could not find variables alias with ID "${value.id}"`);
+        }
+        return `{${normalizeVariableName(reference.name)}}`;
+    }
+    return rgbaToHex(value);
+};
+/**
+ * Converts a RGBA value to a hex color.
+ * Transparency will only be added if its not 1, e.g. "#000000" instead of "#000000ff"
+ */
+export const rgbaToHex = (value) => {
+    const hex = Object.values(value)
+        .map((color) => Math.floor(color * 255))
+        .map((color) => color.toString(16))
+        .map((color) => color.padStart(2, "0"))
+        .join("")
+        .replace(/^/, "#");
+    if (value.a === 1)
+        return hex.substring(0, hex.length - 2);
+    return hex;
+};
+/**
+ * Normalizes the given variable name by apply these transformations:
+ * - replace slashes with "-"
+ * - replace whitespace with "-"
+ * - replace "+" with "-"
+ * - replace "&" with "-"
+ */
+export const normalizeVariableName = (name) => {
+    return name.replaceAll("/", "-").replaceAll(" ", "-").replaceAll("+", "-").replaceAll("&", "-");
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@sit-onyx/figma-utils",
+  "description": "Utility functions and CLI for importing data from the Figma API into CSS/SCSS variables",
+  "version": "0.0.0",
+  "type": "module",
+  "bin": {
+    "@sit-onyx/figma-utils": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "commander": "^11.1.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "@sit-onyx/figma-utils": "node ./dist/cli.js"
+  }
+}