@figma/code-connect 0.1.0

package/dist/commands/connect.js

@@ -0,0 +1,214 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addConnectCommandToProgram = void 0;
+const parser_1 = require("../common/parser");
+const fs_1 = __importDefault(require("fs"));
+const upload_1 = require("../connect/upload");
+const validation_1 = require("../connect/validation");
+const create_1 = require("../connect/create");
+const project_1 = require("../common/project");
+const logging_1 = require("../common/logging");
+const convert_1 = require("../storybook/convert");
+const delete_docs_1 = require("../connect/delete_docs");
+function addBaseCommand(command, name, description) {
+    return command
+        .command(name)
+        .description(description)
+        .usage('[options]')
+        .option('-r --dir <dir>', 'directory to parse')
+        .option('-t --token <token>', 'figma access token')
+        .option('-d --debug', 'output debug logs')
+        .option('-o --outfile <file>', 'output to JSON file')
+        .option('-c --config <path>', 'path to a figma config file')
+        .option('--dry-run', 'tests publishing without actually publishing');
+}
+function addConnectCommandToProgram(program) {
+    // Main command, invoked with `figma connect`
+    const connectCommand = addBaseCommand(program, 'connect', 'Start the Code Connect Wizard (not implemented yet)');
+    // Sub-commands, invoked with e.g. `figma connect publish`
+    addBaseCommand(connectCommand, 'publish', 'Run Code Connect locally to find any files that include calls to `figma.connect()` and publishes those to Figma. ' +
+        'By default this looks for a config file named "figma.config.json", and uses the `include` and `exclude` fields to determine which files to parse. ' +
+        'If no config file is found, this parses the current directory. An optional `--dir` flag can be used to specify a directory to parse.')
+        .option('--skip-validation', 'skip validation of Code Connect docs')
+        .action(handlePublish);
+    addBaseCommand(connectCommand, 'unpublish', 'Run to find any files that include calls to `figma.connect()` and unpublish them from Figma. ' +
+        'By default this looks for a config file named "figma.config.json", and uses the `include` and `exclude` fields to determine which files to parse. ' +
+        'If no config file is found, this parses the current directory. An optional `--dir` flag can be used to specify a directory to parse.')
+        .option('--node <link_to_node>', 'specify the node to unpublish. This will unpublish for both React and Storybook.')
+        .action(handleUnpublish);
+    addBaseCommand(connectCommand, 'parse', 'Run Code Connect locally to find any files that include calls to `figma.connect()`, then converts to JSON and outputs to stdout.').action(handleParse);
+    addBaseCommand(connectCommand, 'create', 'Generate a Code Connect file with boilerplate in the current directory for a Figma node URL')
+        .argument('<figma-node-url>', 'Figma node URL to create the Code Connect file from')
+        .action(handleCreate);
+}
+exports.addConnectCommandToProgram = addConnectCommandToProgram;
+function getAccessToken(cmd) {
+    return cmd.token ?? process.env.FIGMA_ACCESS_TOKEN;
+}
+function setupHandler(cmd) {
+    if (cmd.debug) {
+        logging_1.logger.setLogLevel(logging_1.LogLevel.Debug);
+    }
+}
+async function getFigmadocs(dir, cmd, projectInfo) {
+    const figmadocs = [];
+    const { files, remoteUrl, config, tsProgram } = projectInfo;
+    const figmaNodeToFile = new Map();
+    for (const file of files.filter((f) => (0, parser_1.isFigmaConnectFile)(tsProgram, f))) {
+        try {
+            const docs = await (0, parser_1.parse)(tsProgram, file, remoteUrl, config, cmd.debug);
+            for (const doc of docs) {
+                figmaNodeToFile.set(doc.figmaNode, file);
+            }
+            figmadocs.push(...docs);
+            logging_1.logger.info((0, logging_1.success)(file));
+        }
+        catch (e) {
+            logging_1.logger.error(`❌ ${file}`);
+            if (e instanceof parser_1.ParserError) {
+                if (cmd.debug) {
+                    console.trace(e);
+                }
+                else {
+                    logging_1.logger.error(e.toString());
+                }
+            }
+            else {
+                if (cmd.debug) {
+                    console.trace(e);
+                }
+                else {
+                    logging_1.logger.error(new parser_1.InternalError(String(e)).toString());
+                }
+            }
+        }
+    }
+    return figmadocs;
+}
+async function handlePublish(cmd) {
+    setupHandler(cmd);
+    let dir = cmd.dir ?? process.cwd();
+    const projectInfo = (0, project_1.getProjectInfo)(dir, cmd.config);
+    if (cmd.dryRun) {
+        logging_1.logger.info(`Files that would be published:`);
+    }
+    const figmadocs = await getFigmadocs(dir, cmd, projectInfo);
+    const storybookFigmadocs = await (0, convert_1.convertStorybookFiles)({
+        projectInfo,
+    });
+    const allCodeConnectFiles = figmadocs.concat(storybookFigmadocs);
+    if (allCodeConnectFiles.length === 0) {
+        logging_1.logger.warn(`No Code Connect files found in ${dir} - Make sure you have configured \`include\` and \`exclude\` in your figma.config.json file correctly, or that you are running in a directory that contains Code Connect files.`);
+        process.exit(0);
+    }
+    const accessToken = getAccessToken(cmd);
+    if (!accessToken) {
+        logging_1.logger.error(`Couldn't find a Figma access token. Please provide one with \`--token <access_token>\` or set the FIGMA_ACCESS_TOKEN environment variable`);
+        process.exit(1);
+    }
+    if (cmd.skipValidation) {
+        logging_1.logger.info('Validation skipped');
+    }
+    else {
+        logging_1.logger.info('Validating Code Connect files...');
+        var start = new Date().getTime();
+        const valid = await (0, validation_1.validateDocs)(accessToken, allCodeConnectFiles);
+        if (!valid) {
+            process.exit(1);
+        }
+        else {
+            var end = new Date().getTime();
+            var time = end - start;
+            logging_1.logger.info(`All Code Connect files are valid (${time}ms)`);
+        }
+    }
+    if (cmd.dryRun) {
+        logging_1.logger.info(`Dry run complete`);
+        process.exit(0);
+    }
+    (0, upload_1.upload)({ accessToken, docs: allCodeConnectFiles });
+}
+async function handleUnpublish(cmd) {
+    setupHandler(cmd);
+    let dir = cmd.dir ?? process.cwd();
+    if (cmd.dryRun) {
+        logging_1.logger.info(`Files that would be unpublished:`);
+    }
+    let nodesToDeleteRelevantInfo;
+    if (cmd.node) {
+        nodesToDeleteRelevantInfo = [
+            { figmaNode: cmd.node, label: 'React' },
+            { figmaNode: cmd.node, label: 'Storybook' },
+        ];
+    }
+    else {
+        const projectInfo = (0, project_1.getProjectInfo)(dir, cmd.config);
+        const figmadocs = await getFigmadocs(dir, cmd, projectInfo);
+        const storybookFigmadocs = await (0, convert_1.convertStorybookFiles)({
+            projectInfo,
+        });
+        const allCodeConnectFiles = figmadocs.concat(storybookFigmadocs);
+        nodesToDeleteRelevantInfo = allCodeConnectFiles.map((doc) => ({
+            figmaNode: doc.figmaNode,
+            label: doc.label,
+        }));
+        if (cmd.dryRun) {
+            logging_1.logger.info(`Dry run complete`);
+            process.exit(0);
+        }
+    }
+    const accessToken = getAccessToken(cmd);
+    (0, delete_docs_1.delete_docs)({
+        accessToken,
+        docs: nodesToDeleteRelevantInfo,
+    });
+}
+async function handleParse(cmd) {
+    setupHandler(cmd);
+    // if we're not doing a dry run, we don't want to output logs
+    if (!cmd.dryRun) {
+        logging_1.logger.setLogLevel(logging_1.LogLevel.Error);
+    }
+    let dir = cmd.dir ?? process.cwd();
+    const projectInfo = (0, project_1.getProjectInfo)(dir, cmd.config);
+    const figmadocs = await getFigmadocs(dir, cmd, projectInfo);
+    const storybookFigmadocs = await (0, convert_1.convertStorybookFiles)({
+        projectInfo,
+    });
+    const allCodeConnectFiles = figmadocs.concat(storybookFigmadocs);
+    if (cmd.dryRun) {
+        logging_1.logger.info(`Dry run complete`);
+        process.exit(0);
+    }
+    if (cmd.outfile) {
+        fs_1.default.writeFileSync(cmd.outfile, JSON.stringify(figmadocs, null, 2));
+        logging_1.logger.info(`Wrote Code Connect JSON to ${(0, logging_1.highlight)(cmd.outfile)}`);
+    }
+    else {
+        // don't format the output, so it can be piped to other commands
+        console.log(JSON.stringify(allCodeConnectFiles, undefined, 2));
+    }
+}
+function handleCreate(nodeUrl, cmd) {
+    setupHandler(cmd);
+    if (cmd.dryRun) {
+        process.exit(0);
+    }
+    const accessToken = getAccessToken(cmd);
+    if (!accessToken) {
+        logging_1.logger.error(`Couldn't find a Figma access token. Please provide one with \`--token <access_token>\` or set the FIGMA_ACCESS_TOKEN environment variable`);
+        process.exit(1);
+    }
+    return (0, create_1.createFigmadocFromUrl)({
+        accessToken,
+        // We remove \s to allow users to paste URLs inside quotes - the terminal
+        // paste will add backslashes, which the quotes preserve, but expected user
+        // behaviour would be to strip the quotes
+        figmaNodeUrl: nodeUrl.replace(/\\/g, ''),
+        outFile: cmd.outfile,
+    });
+}
+//# sourceMappingURL=connect.js.map

package/dist/commands/connect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/commands/connect.ts"],"names":[],"mappings":";;;;;;AACA,6CAAwF;AACxF,4CAAmB;AACnB,8CAA0C;AAC1C,sDAAoD;AACpD,8CAAyD;AACzD,+CAA+D;AAC/D,+CAA+E;AAE/E,kDAA4D;AAC5D,wDAAoD;AAWpD,SAAS,cAAc,CAAC,OAA0B,EAAE,IAAY,EAAE,WAAmB;IACnF,OAAO,OAAO;SACX,OAAO,CAAC,IAAI,CAAC;SACb,WAAW,CAAC,WAAW,CAAC;SACxB,KAAK,CAAC,WAAW,CAAC;SAClB,MAAM,CAAC,gBAAgB,EAAE,oBAAoB,CAAC;SAC9C,MAAM,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;SAClD,MAAM,CAAC,YAAY,EAAE,mBAAmB,CAAC;SACzC,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;SACpD,MAAM,CAAC,oBAAoB,EAAE,6BAA6B,CAAC;SAC3D,MAAM,CAAC,WAAW,EAAE,8CAA8C,CAAC,CAAA;AACxE,CAAC;AAED,SAAgB,0BAA0B,CAAC,OAA0B;IACnE,6CAA6C;IAC7C,MAAM,cAAc,GAAG,cAAc,CACnC,OAAO,EACP,SAAS,EACT,qDAAqD,CACtD,CAAA;IAED,0DAA0D;IAC1D,cAAc,CACZ,cAAc,EACd,SAAS,EACT,mHAAmH;QACjH,oJAAoJ;QACpJ,sIAAsI,CACzI;SACE,MAAM,CAAC,mBAAmB,EAAE,sCAAsC,CAAC;SACnE,MAAM,CAAC,aAAa,CAAC,CAAA;IAExB,cAAc,CACZ,cAAc,EACd,WAAW,EACX,+FAA+F;QAC7F,oJAAoJ;QACpJ,sIAAsI,CACzI;SACE,MAAM,CACL,uBAAuB,EACvB,kFAAkF,CACnF;SACA,MAAM,CAAC,eAAe,CAAC,CAAA;IAE1B,cAAc,CACZ,cAAc,EACd,OAAO,EACP,kIAAkI,CACnI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAErB,cAAc,CACZ,cAAc,EACd,QAAQ,EACR,6FAA6F,CAC9F;SACE,QAAQ,CAAC,kBAAkB,EAAE,qDAAqD,CAAC;SACnF,MAAM,CAAC,YAAY,CAAC,CAAA;AACzB,CAAC;AA7CD,gEA6CC;AAED,SAAS,cAAc,CAAC,GAAgB;IACtC,OAAO,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAA;AACpD,CAAC;AAED,SAAS,YAAY,CAAC,GAAgB;IACpC,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QACd,gBAAM,CAAC,WAAW,CAAC,kBAAQ,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,GAAgB,EAAE,WAAwB;IACjF,MAAM,SAAS,GAAuB,EAAE,CAAA;IACxC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,CAAA;IAE3D,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,CAAA;IACjC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAA,2BAAkB,EAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAA,cAAK,EAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;YACvE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;YAC1C,CAAC;YACD,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;YACvB,gBAAM,CAAC,IAAI,CAAC,IAAA,iBAAO,EAAC,IAAI,CAAC,CAAC,CAAA;QAC5B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,gBAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;YACzB,IAAI,CAAC,YAAY,oBAAW,EAAE,CAAC;gBAC7B,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;oBACd,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAClB,CAAC;qBAAM,CAAC;oBACN,gBAAM,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC5B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;oBACd,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAClB,CAAC;qBAAM,CAAC;oBACN,gBAAM,CAAC,KAAK,CAAC,IAAI,sBAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACvD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAA8C;IACzE,YAAY,CAAC,GAAG,CAAC,CAAA;IAEjB,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IAClC,MAAM,WAAW,GAAG,IAAA,wBAAc,EAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAEnD,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,gBAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAA;IAC3D,MAAM,kBAAkB,GAAG,MAAM,IAAA,+BAAqB,EAAC;QACrD,WAAW;KACZ,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAA;IAChE,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,gBAAM,CAAC,IAAI,CACT,kCAAkC,GAAG,iLAAiL,CACvN,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;IACvC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,gBAAM,CAAC,KAAK,CACV,2IAA2I,CAC5I,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;QACvB,gBAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IACnC,CAAC;SAAM,CAAC;QACN,gBAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAA;QAC/C,IAAI,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QAChC,MAAM,KAAK,GAAG,MAAM,IAAA,yBAAY,EAAC,WAAW,EAAE,mBAAmB,CAAC,CAAA;QAClE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;YAC9B,IAAI,IAAI,GAAG,GAAG,GAAG,KAAK,CAAA;YACtB,gBAAM,CAAC,IAAI,CAAC,qCAAqC,IAAI,KAAK,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,gBAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,IAAA,eAAM,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAA;AACpD,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAmC;IAChE,YAAY,CAAC,GAAG,CAAC,CAAA;IAEjB,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IAElC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,gBAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAA;IACjD,CAAC;IAED,IAAI,yBAAyB,CAAA;IAE7B,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACb,yBAAyB,GAAG;YAC1B,EAAE,SAAS,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE;YACvC,EAAE,SAAS,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE;SAC5C,CAAA;IACH,CAAC;SAAM,CAAC;QACN,MAAM,WAAW,GAAG,IAAA,wBAAc,EAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAEnD,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAA;QAC3D,MAAM,kBAAkB,GAAG,MAAM,IAAA,+BAAqB,EAAC;YACrD,WAAW;SACZ,CAAC,CAAA;QAEF,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAA;QAEhE,yBAAyB,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC5D,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,KAAK,EAAE,GAAG,CAAC,KAAK;SACjB,CAAC,CAAC,CAAA;QAEH,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,gBAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;YAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;IAEvC,IAAA,yBAAW,EAAC;QACV,WAAW;QACX,IAAI,EAAE,yBAAyB;KAChC,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAgB;IACzC,YAAY,CAAC,GAAG,CAAC,CAAA;IAEjB,6DAA6D;IAC7D,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QAChB,gBAAM,CAAC,WAAW,CAAC,kBAAQ,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAA;IAClC,MAAM,WAAW,GAAG,IAAA,wBAAc,EAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAEnD,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAA;IAC3D,MAAM,kBAAkB,GAAG,MAAM,IAAA,+BAAqB,EAAC;QACrD,WAAW;KACZ,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAA;IAEhE,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,gBAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,YAAE,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;QACjE,gBAAM,CAAC,IAAI,CAAC,8BAA8B,IAAA,mBAAS,EAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACrE,CAAC;SAAM,CAAC;QACN,gEAAgE;QAChE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAA;IAChE,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,OAAe,EAAE,GAAgB;IACrD,YAAY,CAAC,GAAG,CAAC,CAAA;IAEjB,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;IACvC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,gBAAM,CAAC,KAAK,CACV,2IAA2I,CAC5I,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,OAAO,IAAA,8BAAqB,EAAC;QAC3B,WAAW;QACX,yEAAyE;QACzE,2EAA2E;QAC3E,yCAAyC;QACzC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;QACxC,OAAO,EAAE,GAAG,CAAC,OAAO;KACrB,CAAC,CAAA;AACJ,CAAC"}

package/dist/common/api.d.ts

@@ -0,0 +1,146 @@
+/// <reference types="react" />
+export interface FigmaConnectAPI {
+    /**
+     * Creates Figma documentation for a React component and a Figma component. This function is used to
+     * define a code example that displays in Figma when that component is selected. The function must be
+     * called with a link to the figmaNode and a reference to the React component.
+     *
+     * @param component A reference to the React component
+     * @param figmaNodeUrl A link to the node in Figma, for example:`https://www.figma.com/file/123abc/My-Component?node-id=123:456`
+     * @param meta {@link FigmaConnectMeta}
+     */
+    connect<P = {}>(component: any, figmaNodeUrl: string, meta?: FigmaConnectMeta<P>): void;
+    /**
+     * Maps a Figma property to a boolean value for the connected component. This prop is replaced
+     * with values from the Figma instance when viewed in Dev Mode. For example:
+     * ```ts
+     * props: {
+     *  disabled: figma.boolean('Disabled'),
+     * }
+     * ```
+     * Would show the `disabled` property if the Figma property "Disabled" is true.
+     *
+     * @param figmaPropName The name of the property on the Figma component
+     */
+    boolean(figmaPropName: string): boolean;
+    /**
+     * Maps a Figma boolean property to a set of values for the connected component, providing
+     * a value mapping for `true` and `false`. This prop is replaced with values from the
+     * Figma instance when viewed in Dev Mode. Example:
+     * ```ts
+     * props: {
+     *  label: figma.boolean('Disabled', {
+     *    true: <Label />,
+     *    false: <HiddenLabel />
+     *  }),
+     * }
+     * ```
+     * Would replace `label` with `<Label />` if the Figma property "Disabled" is true.
+     *
+     * @param figmaPropName The name of the property on the Figma component
+     * @param valueMapping A mapping of values for `true` and `false`
+     */
+    boolean<V extends string | boolean | number | symbol | undefined | JSX.Element>(figmaPropName: string, valueMapping?: Record<'true' | 'false', V>): ValueOf<Record<'true' | 'false', V>>;
+    /**
+     * Maps a Figma Variant property to a set if values for the connected component. This prop is replaced
+     * with values from the Figma instance when viewed in Dev Mode. For example:
+     * ```ts
+     * props: {
+     *  type: figma.enum('Type', {
+     *    Primary: 'primary',
+     *     Secondary: 'secondary',
+     *  }),
+     * }
+     * ```
+     * Would output "primary" if the Type Variant in Figma is set to "Primary".
+     *
+     * @param figmaPropName The name of the property on the Figma component
+     * @param valueMapping A mapping of values for the Figma Variant
+     */
+    enum<V extends string | boolean | number | symbol | undefined | JSX.Element>(figmaPropName: string, valueMapping: PropMapping<Record<string, V>>): ValueOf<Record<string, V>>;
+    /**
+     * Maps a Figma property to a string value for the connected component. This prop is replaced
+     * with values from the Figma instance when viewed in Dev Mode. For example:
+     * ```ts
+     * props: {
+     *  text: figma.string('Text'),
+     * }
+     * ```
+     * Would replace `text` with the text content from the Figma property "Text".
+     *
+     * @param figmaPropName The name of the property on the Figma component
+     */
+    string(figmaPropName: string): string;
+    /**
+     * Maps a Figma instance property for the connected component. This prop is replaced
+     * with values from the Figma instance when viewed in Dev Mode. For example:
+     * ```ts
+     * props: {
+     *  icon: figma.instance('Icon'),
+     * }
+     * ```
+     * Would show the nested examples for the component passed to the "Icon" property in Figma.
+     *
+     * @param figmaPropName The name of the property on the Figma component
+     */
+    instance(figmaPropName: string): JSX.Element;
+    /**
+     * Maps a Figma instance layer to a nested code example. For example:
+     * ```ts
+     * props: {
+     *  icon: figma.children('Icon')
+     * }
+     * ```
+     * Would show the nested code example for the child instance named 'Icon'. This also supports
+     * an array: `tabs: figma.children(['Tab 1', 'Tab 2'])` to map multiple nested examples.
+     *
+     * @param figmaPropName The name of the property on the Figma component
+     */
+    children(layerNames: string | string[]): JSX.Element;
+}
+export type ValueOf<T> = T[keyof T];
+export type PropMapping<T> = {
+    [key in keyof T]: T[key];
+};
+export interface FigmaConnectLink {
+    name: string;
+    url: string;
+}
+export interface FigmaConnectMeta<T = {}, ExtraExampleT = never> {
+    /**
+     * Restricts this figma connect to any variants that fullfill the given filter.
+     * The filter is a map of Figma variant names to values. Example:
+     * ```ts
+     * {
+     *  variant: { "Has Icon": true }
+     * }
+     */
+    variant?: Record<string, string | boolean | number>;
+    /**
+     * Prop mappings for the connected component. This is used to map the values of the component's props
+     * to the values that are used in Figma, using helper functions like `Figma.boolean`. For example:
+     * ```ts
+     * props: {
+     *   disabled: figma.boolean('Disabled'),
+     *   text: figma.string('Text'),
+     *   size: figma.enum('Size', {
+     *     slim: 'slim',
+     *     medium: 'medium',
+     *     large: 'large',
+     *   }),
+     * }
+     */
+    props?: T;
+    /**
+     * The code example to display in Figma. Any mapped `props` is passed to the component,
+     * where those values will be replaced with the mapped value when inspecting that instance in Figma.
+     * @param props
+     * @returns
+     */
+    example?: ((props: T) => React.Component | JSX.Element) | ExtraExampleT;
+    /**
+     * A list of links that will display in Figma along with the examples
+     */
+    links?: FigmaConnectLink[];
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/common/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":";AAAA,MAAM,WAAW,eAAe;IAC9B;;;;;;;;OAQG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IAEvF;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAA;IAEvC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,GAAG,CAAC,OAAO,EAC5E,aAAa,EAAE,MAAM,EACrB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC,CAAC,GACzC,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAEvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,GAAG,CAAC,OAAO,EACzE,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAC3C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;IAE7B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAAA;IAErC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAC,OAAO,CAAA;IAE5C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAA;CACrD;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;AAEnC,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC1B,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;CACzB,CAAA;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ;AAID,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,EAAE,EAAE,aAAa,GAAG,KAAK;IAC7D;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,CAAA;IAEnD;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,CAAC,CAAA;IAET;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,aAAa,CAAA;IAEvE;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAC3B"}

package/dist/common/api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api.js.map

package/dist/common/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":""}

package/dist/common/compiler.d.ts

@@ -0,0 +1,96 @@
+import ts from 'typescript';
+import { ParserContext } from './parser';
+/**
+ * Get the default export from a TypeScript source file
+ *
+ * @param sourceFile TypeScript source file
+ * @returns The default export Expression, or undefined if there is no default export
+ */
+export declare function getDefaultExport(sourceFile: ts.SourceFile): ts.Expression | undefined;
+/**
+ * Perform a breadth-first search to find the first node matching a predicate
+ *
+ * @param node Node to start the search from
+ * @param tsSourceFile SourceFile associated with the node
+ * @param predicate Predicate to match
+ * @returns The first node matching the predicate, or undefined if no node is found
+ */
+export declare function bfsFindNode(node: ts.Node, tsSourceFile: ts.SourceFile, predicate: (node: ts.Node) => boolean): ts.Node | undefined;
+/**
+ * Gets a property with the specified name and type (via predicate) from an object literal node
+ *
+ * @param objectLiteralNode The object literal node potentially containing the property
+ * @param propertyName The name of the property to get
+ * @param predicate Optional predicate to match
+ * @param required Whether the property is required. Defaults to false.
+ * If true, an error will be thrown if the property is not found
+ * @param errorMessage Optional error message to throw if the property is not found
+ * @returns The property, or undefined if the property is not found
+ */
+export declare function parsePropertyOfType<T extends ts.Node>(params: {
+    objectLiteralNode: ts.ObjectLiteralExpression;
+    propertyName: string;
+    predicate: (node: ts.Node) => node is T;
+    parserContext: ParserContext;
+    required?: true;
+    errorMessage?: string;
+}): T;
+export declare function parsePropertyOfType<T extends ts.Node>(params: {
+    objectLiteralNode: ts.ObjectLiteralExpression;
+    propertyName: string;
+    predicate: (node: ts.Node) => node is T;
+    parserContext: ParserContext;
+    required?: false;
+    errorMessage?: string;
+}): T | undefined;
+export declare function parsePropertyOfType<T extends ts.Node>(params: {
+    objectLiteralNode: ts.ObjectLiteralExpression;
+    propertyName: string;
+    predicate: (node: ts.Node) => node is T;
+    parserContext: ParserContext;
+    required?: boolean;
+    errorMessage?: string;
+}): T | undefined;
+type TypeGuard<A, B extends A> = (a: A) => a is B;
+type GuardType<T> = T extends (o: any) => o is infer U ? U : never;
+/**
+ * Combines several type guards into one.
+ *
+ * The returned function checks if any of the type guards in the list matches the argument,
+ * and infers the type based on the matching type guard.
+ *
+ * @param guards A list of type guards
+ */
+export declare function isOneOf<T extends TypeGuard<any, any>>(guards: T[]): [T] extends [TypeGuard<infer A, any>] ? (a: A) => a is GuardType<T> : never;
+/**
+ * Gets a function argument with the specified index from a call expression node
+ *
+ * @param fn The call expression node potentially containing the argument
+ * @param parserContext The parser context
+ * @param index The index of the argument to get
+ * @param predicate Predicate to match
+ * @param required Whether the argument is required. Defaults to false.
+ * @param errorMessage Optional error message to throw if the argument is not found
+ * @returns
+ */
+export declare function parseFunctionArgument<T extends ts.Node>(fn: ts.CallExpression, parserContext: ParserContext, index: number, predicate: (node: ts.Node) => node is T, required?: boolean, errorMessage?: string): T | undefined;
+export declare function assertIsPropertyAssignment(node: ts.Node, sourceFile: ts.SourceFile): asserts node is ts.PropertyAssignment;
+export declare function assertIsStringLiteral(node: ts.Node, sourceFile: ts.SourceFile, msg?: string): asserts node is ts.StringLiteral;
+export declare function assertIsArrayLiteralExpression(node: ts.Node, sourceFile: ts.SourceFile, msg?: string): asserts node is ts.ArrayLiteralExpression;
+export declare function assertIsObjectLiteralExpression(node: ts.Node, sourceFile: ts.SourceFile, msg?: string): asserts node is ts.ObjectLiteralExpression;
+export declare function assertIsIdentifier(node: ts.Node, sourceFile: ts.SourceFile, msg?: string): asserts node is ts.Identifier;
+/**
+ * Convert an object literal node to a JavaScript object
+ *
+ * @param objectLiteral The object literal node to convert
+ * @param sourceFile The source file containing the object literal
+ * @param extraConversionFn Optional function to convert a node to a value. This
+ * runs before the default conversion. If this returns undefined, the default
+ * conversion will be used. (This does mean there's no way to return undefined)
+ * @returns The JavaScript object version of the object literal
+ */
+export declare function convertObjectLiteralToJs(objectLiteral: ts.ObjectLiteralExpression, sourceFile: ts.SourceFile, checker: ts.TypeChecker, extraConversionFn?: (node: ts.Expression) => any): Record<string, any>;
+export declare function getTagName(element: ts.JsxElement | ts.JsxSelfClosingElement): string;
+export declare function stripQuotes(node: ts.StringLiteral): string;
+export {};
+//# sourceMappingURL=compiler.d.ts.map

package/dist/common/compiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../../src/common/compiler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAA;AAC3B,OAAO,EAAE,aAAa,EAAe,MAAM,UAAU,CAAA;AAErD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC,UAAU,GAAG,SAAS,CAMrF;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,YAAY,EAAE,EAAE,CAAC,UAAU,EAC3B,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,GACpC,EAAE,CAAC,IAAI,GAAG,SAAS,CAYrB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE;IAC7D,iBAAiB,EAAE,EAAE,CAAC,uBAAuB,CAAA;IAC7C,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAA;IACvC,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,EAAE,IAAI,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CAAC,CAAA;AAEL,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE;IAC7D,iBAAiB,EAAE,EAAE,CAAC,uBAAuB,CAAA;IAC7C,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAA;IACvC,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CAAC,GAAG,SAAS,CAAA;AAEjB,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE;IAC7D,iBAAiB,EAAE,EAAE,CAAC,uBAAuB,CAAA;IAC7C,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAA;IACvC,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,CAAC,GAAG,SAAS,CAAA;AAsFjB,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AACjD,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAElE;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EACnD,MAAM,EAAE,CAAC,EAAE,GACV,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;AAS9E;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,EACrD,EAAE,EAAE,EAAE,CAAC,cAAc,EACrB,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,EACvC,QAAQ,UAAQ,EAChB,YAAY,CAAC,EAAE,MAAM,GACpB,CAAC,GAAG,SAAS,CA0Bf;AAED,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,EAAE,CAAC,UAAU,GACxB,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,kBAAkB,CAOvC;AAED,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,EAAE,CAAC,UAAU,EACzB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,aAAa,CAOlC;AAED,wBAAgB,8BAA8B,CAC5C,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,EAAE,CAAC,UAAU,EACzB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,sBAAsB,CAO3C;AAED,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,EAAE,CAAC,UAAU,EACzB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,uBAAuB,CAO5C;AAED,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,UAAU,EAAE,EAAE,CAAC,UAAU,EACzB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,UAAU,CAO/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,EAAE,CAAC,uBAAuB,EACzC,UAAU,EAAE,EAAE,CAAC,UAAU,EACzB,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,KAAK,GAAG,uBAkEjD;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC,qBAAqB,UAM3E;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,UAKjD"}