@interactivethings/scripts 0.0.9 → 2.0.0

package/dist/figma/cli.test.js

@@ -0,0 +1,187 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const argparse_1 = require("argparse");
+const cli_1 = require("./cli");
+const fs = __importStar(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+// Mock the API and other dependencies
+vitest_1.vi.mock("../figma/api", () => ({
+    createAPI: vitest_1.vi.fn(),
+}));
+vitest_1.vi.mock("@interactivethings/scripts/figma/images", () => ({
+    optimizeImage: vitest_1.vi.fn(),
+}));
+vitest_1.vi.mock("../config", () => ({
+    loadConfig: vitest_1.vi.fn(),
+    mergeConfigWithArgs: vitest_1.vi.fn(),
+    validateRequiredConfig: vitest_1.vi.fn(),
+}));
+vitest_1.vi.mock("fs/promises");
+vitest_1.vi.mock("ora", () => ({
+    default: vitest_1.vi.fn(() => ({
+        start: vitest_1.vi.fn().mockReturnThis(),
+        stop: vitest_1.vi.fn().mockReturnThis(),
+        text: "",
+        render: vitest_1.vi.fn(),
+    })),
+}));
+const api_1 = require("./api");
+const images_1 = require("@interactivethings/scripts/figma/images");
+const config_1 = require("../config");
+(0, vitest_1.describe)("Figma CLI", () => {
+    const mockAPI = {
+        images: {
+            fetch: vitest_1.vi.fn(),
+        },
+        nodes: {
+            fetch: vitest_1.vi.fn(),
+        },
+    };
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.clearAllMocks();
+        vitest_1.vi.mocked(api_1.createAPI).mockReturnValue(mockAPI);
+        vitest_1.vi.mocked(config_1.loadConfig).mockResolvedValue({});
+        vitest_1.vi.mocked(config_1.mergeConfigWithArgs).mockReturnValue({
+            token: "test-token",
+            assets: [
+                {
+                    name: "test-assets",
+                    url: "https://www.figma.com/design/test-file-id/Test?node-id=123-456",
+                    output: "test-output",
+                },
+            ],
+        });
+        vitest_1.vi.mocked(config_1.validateRequiredConfig).mockImplementation(() => { });
+    });
+    (0, vitest_1.describe)("configParser", () => {
+        (0, vitest_1.it)("should configure the argument parser correctly", () => {
+            const parser = new argparse_1.ArgumentParser();
+            const addSubparsersSpy = vitest_1.vi.spyOn(parser, "add_subparsers");
+            (0, cli_1.configParser)(parser);
+            (0, vitest_1.expect)(addSubparsersSpy).toHaveBeenCalledWith({
+                title: "commands",
+                dest: "subcommand",
+            });
+        });
+    });
+    (0, vitest_1.describe)("run", () => {
+        (0, vitest_1.beforeEach)(() => {
+            vitest_1.vi.spyOn(console, "log").mockImplementation(() => { });
+        });
+        (0, vitest_1.afterEach)(() => {
+            vitest_1.vi.mocked(console.log).mockRestore();
+        });
+        (0, vitest_1.describe)("download subcommand", () => {
+            (0, vitest_1.it)("should successfully download assets", async () => {
+                const mockImages = [
+                    {
+                        name: "test-image",
+                        format: "png",
+                        data: Buffer.from("test-data"),
+                    },
+                ];
+                mockAPI.images.fetch.mockResolvedValue(mockImages);
+                vitest_1.vi.mocked(fs.mkdir).mockResolvedValue(undefined);
+                vitest_1.vi.mocked(fs.writeFile).mockResolvedValue(undefined);
+                vitest_1.vi.mocked(images_1.optimizeImage).mockResolvedValue(undefined);
+                const args = {
+                    subcommand: "download",
+                    name: "test-assets",
+                    config: undefined,
+                    token: undefined,
+                };
+                await (0, cli_1.run)(args);
+                (0, vitest_1.expect)(config_1.loadConfig).toHaveBeenCalledWith(undefined);
+                (0, vitest_1.expect)(api_1.createAPI).toHaveBeenCalledWith("test-token");
+                (0, vitest_1.expect)(mockAPI.images.fetch).toHaveBeenCalled();
+                (0, vitest_1.expect)(fs.mkdir).toHaveBeenCalledWith(path_1.default.dirname("test-output/test-image.png"), { recursive: true });
+                (0, vitest_1.expect)(fs.writeFile).toHaveBeenCalledWith("test-output/test-image.png", Buffer.from("test-data"));
+                (0, vitest_1.expect)(images_1.optimizeImage).toHaveBeenCalledWith("test-output/test-image.png");
+            });
+            (0, vitest_1.it)("should throw error when no assets are configured", async () => {
+                vitest_1.vi.mocked(config_1.mergeConfigWithArgs).mockReturnValue({
+                    token: "test-token",
+                    assets: [],
+                });
+                const args = {
+                    subcommand: "download",
+                    name: "test-assets",
+                    config: undefined,
+                    token: undefined,
+                };
+                await (0, vitest_1.expect)((0, cli_1.run)(args)).rejects.toThrow("No figma assets configured");
+            });
+            (0, vitest_1.it)("should throw error when asset is not found", async () => {
+                vitest_1.vi.mocked(config_1.mergeConfigWithArgs).mockReturnValue({
+                    token: "test-token",
+                    assets: [
+                        {
+                            name: "other-assets",
+                            url: "https://www.figma.com/design/test-file-id/Test?node-id=123-456",
+                            output: "./test-output",
+                        },
+                    ],
+                });
+                const args = {
+                    subcommand: "download",
+                    name: "test-assets",
+                    config: undefined,
+                    token: undefined,
+                };
+                await (0, vitest_1.expect)((0, cli_1.run)(args)).rejects.toThrow('No asset configuration found for name "test-assets"');
+            });
+        });
+        (0, vitest_1.describe)("get subcommand", () => {
+            (0, vitest_1.it)("should successfully get node data", async () => {
+                const mockNodeData = { nodes: { "test-node": { id: "test-node" } } };
+                mockAPI.nodes.fetch.mockResolvedValue(mockNodeData);
+                const args = {
+                    subcommand: "get",
+                    url: "https://www.figma.com/design/test-file-id/Test?node-id=123-456",
+                    config: undefined,
+                    token: undefined,
+                };
+                await (0, cli_1.run)(args);
+                (0, vitest_1.expect)(mockAPI.nodes.fetch).toHaveBeenCalled();
+                (0, vitest_1.expect)(vitest_1.vi.mocked(console.log)).toHaveBeenCalledWith(JSON.stringify(mockNodeData, null, 2));
+            });
+        });
+        (0, vitest_1.it)("should validate required configuration", async () => {
+            const args = {
+                subcommand: "download",
+                name: "test-assets",
+                config: undefined,
+                token: undefined,
+            };
+            await (0, cli_1.run)(args);
+            (0, vitest_1.expect)(config_1.validateRequiredConfig).toHaveBeenCalledWith(vitest_1.expect.objectContaining({ token: "test-token" }), ["token"]);
+        });
+    });
+});

package/dist/figma/images.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optimizeImage = void 0;
+const child_process_1 = require("child_process");
+const path = __importStar(require("path"));
+const optimizeImage = async (filepath) => {
+    try {
+        const extension = path.extname(filepath).toLowerCase();
+        const binaryForExtensions = new Map([
+            [".png", "optipng"],
+            [".jpg", "jpegoptim"],
+        ]);
+        const binaryName = binaryForExtensions.get(extension);
+        if (!binaryName) {
+            // console.log(`No optimizer found for ${extension}, skipping optimization`);
+            return;
+        }
+        const binaryPath = (0, child_process_1.execSync)(`which ${binaryName}`).toString().trim();
+        if (!binaryPath) {
+            throw new Error(`Cannot find ${binaryName} in PATH. Please install it.`);
+        }
+        console.log(`Optimizing with ${filepath} with ${binaryName}`);
+        await (0, child_process_1.execSync)(`${binaryPath} "${filepath}"`);
+        console.log(`Image optimized successfully: ${filepath}`);
+    }
+    catch (error) {
+        console.error(`Error optimizing image ${filepath}: ${error instanceof Error ? error.message : error}`);
+    }
+};
+exports.optimizeImage = optimizeImage;

package/dist/figma/optimizeImage.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optimizeImage = void 0;
+const child_process_1 = require("child_process");
+const path = __importStar(require("path"));
+const optimizeImage = async (filepath) => {
+    try {
+        const extension = path.extname(filepath).toLowerCase();
+        const binaryForExtensions = new Map([
+            [".png", "optipng"],
+            [".jpg", "jpegoptim"],
+        ]);
+        const binaryName = binaryForExtensions.get(extension);
+        if (!binaryName) {
+            // console.log(`No optimizer found for ${extension}, skipping optimization`);
+            return;
+        }
+        const binaryPath = (0, child_process_1.execSync)(`which ${binaryName}`).toString().trim();
+        if (!binaryPath) {
+            throw new Error(`Cannot find ${binaryName} in PATH. Please install it.`);
+        }
+        console.log(`Optimizing with ${filepath} with ${binaryName}`);
+        await (0, child_process_1.execSync)(`${binaryPath} "${filepath}"`);
+        console.log(`Image optimized successfully: ${filepath}`);
+    }
+    catch (error) {
+        console.error(`Error optimizing image ${filepath}: ${error instanceof Error ? error.message : error}`);
+    }
+};
+exports.optimizeImage = optimizeImage;

package/dist/figma/utils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Should parse a URL in the form https://www.figma.com/design/ElWWZIcOGFhiT06rzfIwRO/Design-System-%5BTPW-Mobile-App%5D?node-id=10404-19140&p=f&t=K5K37NzOSt1uwjsX-0
+ * and extracts the pageId and nodeId
+ * The page id is the part just after /design
+ */
+export declare const parseFigmaURL: (urlString: string) => {
+    figmaFileId: string;
+    figmaPageId: string;
+};
+export declare const formatFigmaURL: (figmaFileId: string, figmaPageId: string) => string;

package/dist/figma/utils.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatFigmaURL = exports.parseFigmaURL = void 0;
+/**
+ * Should parse a URL in the form https://www.figma.com/design/ElWWZIcOGFhiT06rzfIwRO/Design-System-%5BTPW-Mobile-App%5D?node-id=10404-19140&p=f&t=K5K37NzOSt1uwjsX-0
+ * and extracts the pageId and nodeId
+ * The page id is the part just after /design
+ */
+const parseFigmaURL = (urlString) => {
+    var _a;
+    const url = new URL(urlString);
+    const figmaFileId = url.pathname.split("/")[2];
+    const figmaPageId = (_a = url.searchParams.get("node-id")) !== null && _a !== void 0 ? _a : "";
+    if (!figmaFileId || !figmaPageId) {
+        throw new Error(`Invalid Figma URL: ${urlString}`);
+    }
+    return {
+        figmaFileId,
+        figmaPageId,
+    };
+};
+exports.parseFigmaURL = parseFigmaURL;
+const formatFigmaURL = (figmaFileId, figmaPageId) => {
+    return `https://www.figma.com/file/${figmaFileId}/?node-id=${figmaPageId}&mode=design`;
+};
+exports.formatFigmaURL = formatFigmaURL;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @interactivethings/scripts
+ *
+ * A collection of useful development tools by Interactive Things
+ */
+export * from "./types";
+export { defineConfig, type IxtConfig, type FigmaConfig, type TokensStudioConfig, } from "./config";
+export * as tokensStudio from "./tokens-studio";

package/dist/index.js

@@ -0,0 +1,43 @@
+"use strict";
+/**
+ * @interactivethings/scripts
+ *
+ * A collection of useful development tools by Interactive Things
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokensStudio = exports.defineConfig = void 0;
+// Export commonly used types
+__exportStar(require("./types"), exports);
+// Export configuration system
+var config_1 = require("./config");
+Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return config_1.defineConfig; } });
+// Export tokens-studio utilities (for programmatic usage)
+exports.tokensStudio = __importStar(require("./tokens-studio"));
+// Note: CLI functionality is available via the 'ixt' binary
+// Individual modules can be imported via subpaths like '@interactivethings/scripts/tokens-studio'

package/dist/init/cli.d.ts

@@ -0,0 +1,3 @@
+import { ArgumentParser } from "argparse";
+export declare function configParser(parser: ArgumentParser): void;
+export declare function run(mainParser: ArgumentParser): Promise<void>;