@figma/code-connect 0.1.2 → 0.2.1

package/dist/connect/parser_executable_types.d.ts

@@ -0,0 +1,297 @@
+import { z } from 'zod';
+export type ParseRequestPayload = {
+    mode: 'PARSE';
+    paths: string[];
+    config: Record<string, any>;
+};
+export declare const ParserExecutableMessages: z.ZodArray<z.ZodObject<{
+    level: z.ZodUnion<[z.ZodLiteral<"DEBUG">, z.ZodLiteral<"INFO">, z.ZodLiteral<"WARN">, z.ZodLiteral<"ERROR">]>;
+    type: z.ZodOptional<z.ZodString>;
+    message: z.ZodString;
+    sourceLocation: z.ZodOptional<z.ZodObject<{
+        file: z.ZodString;
+        line: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        file: string;
+        line?: number | undefined;
+    }, {
+        file: string;
+        line?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+    type?: string | undefined;
+    sourceLocation?: {
+        file: string;
+        line?: number | undefined;
+    } | undefined;
+}, {
+    message: string;
+    level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+    type?: string | undefined;
+    sourceLocation?: {
+        file: string;
+        line?: number | undefined;
+    } | undefined;
+}>, "many">;
+export declare const ParseResponsePayload: z.ZodObject<{
+    docs: z.ZodArray<z.ZodObject<{
+        figmaNode: z.ZodString;
+        component: z.ZodOptional<z.ZodString>;
+        variant: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        source: z.ZodOptional<z.ZodString>;
+        sourceLocation: z.ZodOptional<z.ZodObject<{
+            line: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            line: number;
+        }, {
+            line: number;
+        }>>;
+        template: z.ZodString;
+        templateData: z.ZodObject<{
+            props: z.ZodRecord<z.ZodString, any>;
+            imports: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            nestable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            props: Record<string, any>;
+            imports?: string[] | undefined;
+            nestable?: boolean | undefined;
+        }, {
+            props: Record<string, any>;
+            imports?: string[] | undefined;
+            nestable?: boolean | undefined;
+        }>;
+        language: z.ZodString;
+        label: z.ZodString;
+        links: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            url: string;
+        }, {
+            name: string;
+            url: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        figmaNode: string;
+        label: string;
+        language: string;
+        template: string;
+        templateData: {
+            props: Record<string, any>;
+            imports?: string[] | undefined;
+            nestable?: boolean | undefined;
+        };
+        variant?: Record<string, any> | undefined;
+        links?: {
+            name: string;
+            url: string;
+        }[] | undefined;
+        component?: string | undefined;
+        source?: string | undefined;
+        sourceLocation?: {
+            line: number;
+        } | undefined;
+    }, {
+        figmaNode: string;
+        label: string;
+        language: string;
+        template: string;
+        templateData: {
+            props: Record<string, any>;
+            imports?: string[] | undefined;
+            nestable?: boolean | undefined;
+        };
+        variant?: Record<string, any> | undefined;
+        links?: {
+            name: string;
+            url: string;
+        }[] | undefined;
+        component?: string | undefined;
+        source?: string | undefined;
+        sourceLocation?: {
+            line: number;
+        } | undefined;
+    }>, "many">;
+    messages: z.ZodArray<z.ZodObject<{
+        level: z.ZodUnion<[z.ZodLiteral<"DEBUG">, z.ZodLiteral<"INFO">, z.ZodLiteral<"WARN">, z.ZodLiteral<"ERROR">]>;
+        type: z.ZodOptional<z.ZodString>;
+        message: z.ZodString;
+        sourceLocation: z.ZodOptional<z.ZodObject<{
+            file: z.ZodString;
+            line: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            file: string;
+            line?: number | undefined;
+        }, {
+            file: string;
+            line?: number | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }, {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    docs: {
+        figmaNode: string;
+        label: string;
+        language: string;
+        template: string;
+        templateData: {
+            props: Record<string, any>;
+            imports?: string[] | undefined;
+            nestable?: boolean | undefined;
+        };
+        variant?: Record<string, any> | undefined;
+        links?: {
+            name: string;
+            url: string;
+        }[] | undefined;
+        component?: string | undefined;
+        source?: string | undefined;
+        sourceLocation?: {
+            line: number;
+        } | undefined;
+    }[];
+    messages: {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }[];
+}, {
+    docs: {
+        figmaNode: string;
+        label: string;
+        language: string;
+        template: string;
+        templateData: {
+            props: Record<string, any>;
+            imports?: string[] | undefined;
+            nestable?: boolean | undefined;
+        };
+        variant?: Record<string, any> | undefined;
+        links?: {
+            name: string;
+            url: string;
+        }[] | undefined;
+        component?: string | undefined;
+        source?: string | undefined;
+        sourceLocation?: {
+            line: number;
+        } | undefined;
+    }[];
+    messages: {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }[];
+}>;
+export type CreateRequestPayload = {
+    mode: 'CREATE';
+    destinationDir: string;
+    destinationFile?: string;
+    component: {
+        figmaNodeUrl: string;
+        id: string;
+        name: string;
+        normalizedName: string;
+        type: 'COMPONENT' | 'COMPONENT_SET';
+        componentPropertyDefinitions: Record<string, {
+            type: 'BOOLEAN' | 'INSTANCE_SWAP' | 'TEXT' | 'VARIANT';
+            defaultValue: boolean | string;
+            variantOptions?: string[];
+        }>;
+    };
+    config: Record<string, any>;
+};
+export declare const CreateResponsePayload: z.ZodObject<{
+    createdFiles: z.ZodArray<z.ZodObject<{
+        filePath: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        filePath: string;
+    }, {
+        filePath: string;
+    }>, "many">;
+    messages: z.ZodArray<z.ZodObject<{
+        level: z.ZodUnion<[z.ZodLiteral<"DEBUG">, z.ZodLiteral<"INFO">, z.ZodLiteral<"WARN">, z.ZodLiteral<"ERROR">]>;
+        type: z.ZodOptional<z.ZodString>;
+        message: z.ZodString;
+        sourceLocation: z.ZodOptional<z.ZodObject<{
+            file: z.ZodString;
+            line: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            file: string;
+            line?: number | undefined;
+        }, {
+            file: string;
+            line?: number | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }, {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    messages: {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }[];
+    createdFiles: {
+        filePath: string;
+    }[];
+}, {
+    messages: {
+        message: string;
+        level: "DEBUG" | "INFO" | "WARN" | "ERROR";
+        type?: string | undefined;
+        sourceLocation?: {
+            file: string;
+            line?: number | undefined;
+        } | undefined;
+    }[];
+    createdFiles: {
+        filePath: string;
+    }[];
+}>;
+export type ParserRequestPayload = ParseRequestPayload | CreateRequestPayload;
+//# sourceMappingURL=parser_executable_types.d.ts.map

package/dist/connect/parser_executable_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser_executable_types.d.ts","sourceRoot":"","sources":["../../src/connect/parser_executable_types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,CAAA;IAGb,KAAK,EAAE,MAAM,EAAE,CAAA;IAIf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,CAAA;AAOD,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAuBpC,CAAA;AASD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8D/B,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,QAAQ,CAAA;IAId,cAAc,EAAE,MAAM,CAAA;IAGtB,eAAe,CAAC,EAAE,MAAM,CAAA;IAIxB,SAAS,EAAE;QAGT,YAAY,EAAE,MAAM,CAAA;QAEpB,EAAE,EAAE,MAAM,CAAA;QAEV,IAAI,EAAE,MAAM,CAAA;QAGZ,cAAc,EAAE,MAAM,CAAA;QAEtB,IAAI,EAAE,WAAW,GAAG,eAAe,CAAA;QAEnC,4BAA4B,EAAE,MAAM,CAClC,MAAM,EACN;YAEE,IAAI,EAAE,SAAS,GAAG,eAAe,GAAG,MAAM,GAAG,SAAS,CAAA;YAEtD,YAAY,EAAE,OAAO,GAAG,MAAM,CAAA;YAE9B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;SAC1B,CACF,CAAA;KACF,CAAA;IAID,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUhC,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG,oBAAoB,CAAA"}

package/dist/connect/parser_executable_types.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateResponsePayload = exports.ParseResponsePayload = exports.ParserExecutableMessages = void 0;
+const zod_1 = require("zod");
+const FigmaConnectLink = zod_1.z.object({
+    name: zod_1.z.string(),
+    url: zod_1.z.string(),
+});
+exports.ParserExecutableMessages = zod_1.z.array(zod_1.z.object({
+    // DEBUG and INFO messages should be output to console by the CLI for the
+    // user to read, according to the current log level setting.
+    //
+    // If any WARNING or ERROR messages are returned, the CLI can determine
+    // whether it should proceed with publishing or not based on configuration
+    // and the return code should be zero or non-zero as appropriate.
+    //
+    // There's no need for a "result" field as we can infer this from the
+    // messages.
+    level: zod_1.z.union([zod_1.z.literal('DEBUG'), zod_1.z.literal('INFO'), zod_1.z.literal('WARN'), zod_1.z.literal('ERROR')]),
+    // Optional type of message which can be displayed highlighted in the output
+    type: zod_1.z.string().optional(),
+    message: zod_1.z.string(),
+    // Optional source location which can be displayed in a standardised form
+    sourceLocation: zod_1.z
+        .object({
+        file: zod_1.z.string(),
+        line: zod_1.z.number().optional(),
+    })
+        .optional(),
+}));
+// Zod type modelling the response from a Code Connect parser. Zod allows us to
+// easily validate the response.
+//
+// This type somewhat duplicates the `CodeConnectJSON` type from
+// `figma_connect.ts`, but as Zod doesn't allow us to fully express recursive
+// types such as Intrinsic, we keep this explicit type as well. The `satisfies`
+// should ensure the two types stay in sync.
+exports.ParseResponsePayload = zod_1.z.object({
+    // Array of Code Connect docs parsed from the input files
+    docs: zod_1.z.array(zod_1.z.object({
+        // The Figma node URL the doc links to
+        figmaNode: zod_1.z.string(),
+        // Optional component name. This is only used for display purposes
+        // so can be omitted if it's not relevant to the language/framework
+        component: zod_1.z.string().optional(),
+        // Variant restrictions keyed by Figma property name e.g. `{ 'With icon': true }`
+        variant: zod_1.z.record(zod_1.z.any()).optional(),
+        // Optional source path/URL, which can either be a path on disk, which
+        // we'll show as a SCM link, or a URL (e.g. for a Storybook parser which
+        // wants to link to the story in Storybook rather than the file in Github)
+        source: zod_1.z.string().optional(),
+        // Optional source location containing line number information.
+        sourceLocation: zod_1.z
+            .object({
+            // Optional line number to link to. This is only used if type === 'PATH',
+            // to generate a link to the correct line
+            line: zod_1.z.number(),
+        })
+            .optional(),
+        // The JS template function to use for this doc
+        template: zod_1.z.string(),
+        templateData: zod_1.z.object({
+            // Map of information describing the props used by the template. This is
+            // used by the CLI to validate props before publishing.
+            //
+            // TODO this Zod type is a bit loose - couldn't work out how to model it exactly
+            //
+            // TODO We could look to extract this from the template somehow instead,
+            // (e.g. run it with figma.properties.* stubbed to record accesses) to
+            // avoid needing this duplication.
+            props: zod_1.z.record(zod_1.z.object({ kind: zod_1.z.string(), args: zod_1.z.any() })),
+            // Optional array of imports for this component. These are prepended
+            // to the example code, but it's useful to keep them separate e.g. if
+            // we ever want to auto-insert imports in VS Code. If more control
+            // over imports is required, they can be output directly by the template
+            // function. Currently they'd have to be output in the code directly, but
+            // the original spec does propose templates being able to return import
+            // sections separately (not implemented as there's no UI for this)
+            //
+            // Right now, there's no way to handle gathering imports from children and
+            // post-processing them (e.g. combining multiple imports from the same file
+            // into a single import). We could consider some way for templates to do this
+            // in future.
+            imports: zod_1.z.array(zod_1.z.string()).optional(),
+            // Whether the example should be rendered inline if it's a nested instance
+            nestable: zod_1.z.boolean().optional(),
+        }),
+        // The language to use for syntax highlighting
+        language: zod_1.z.string(),
+        // Label to be used for the example in the UI
+        label: zod_1.z.string(),
+        // Optional array of links to be displayed in the UI.
+        // TODO Not implemented in UI yet
+        links: zod_1.z.array(FigmaConnectLink).optional(),
+    })),
+    // Any info, warning or error messages generated during parsing.
+    messages: exports.ParserExecutableMessages,
+});
+exports.CreateResponsePayload = zod_1.z.object({
+    // A list of files created, which can be output to the console
+    createdFiles: zod_1.z.array(zod_1.z.object({
+        // The absolute path of the created file
+        filePath: zod_1.z.string(),
+    })),
+    // Any info, warning or error messages generated during creation.
+    messages: exports.ParserExecutableMessages,
+});
+//# sourceMappingURL=parser_executable_types.js.map

package/dist/connect/parser_executable_types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser_executable_types.js","sourceRoot":"","sources":["../../src/connect/parser_executable_types.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAcvB,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;IAChC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAA;AAEW,QAAA,wBAAwB,GAAG,OAAC,CAAC,KAAK,CAC7C,OAAC,CAAC,MAAM,CAAC;IACP,yEAAyE;IACzE,4DAA4D;IAC5D,EAAE;IACF,uEAAuE;IACvE,0EAA0E;IAC1E,iEAAiE;IACjE,EAAE;IACF,qEAAqE;IACrE,YAAY;IACZ,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9F,4EAA4E;IAC5E,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,yEAAyE;IACzE,cAAc,EAAE,OAAC;SACd,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC5B,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CACH,CAAA;AAED,+EAA+E;AAC/E,gCAAgC;AAChC,EAAE;AACF,gEAAgE;AAChE,6EAA6E;AAC7E,+EAA+E;AAC/E,4CAA4C;AAC/B,QAAA,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3C,yDAAyD;IACzD,IAAI,EAAE,OAAC,CAAC,KAAK,CACX,OAAC,CAAC,MAAM,CAAC;QACP,sCAAsC;QACtC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,kEAAkE;QAClE,mEAAmE;QACnE,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,iFAAiF;QACjF,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;QACrC,sEAAsE;QACtE,wEAAwE;QACxE,0EAA0E;QAC1E,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,+DAA+D;QAC/D,cAAc,EAAE,OAAC;aACd,MAAM,CAAC;YACN,yEAAyE;YACzE,yCAAyC;YACzC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,EAAE;QACb,+CAA+C;QAC/C,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC;YACrB,wEAAwE;YACxE,uDAAuD;YACvD,EAAE;YACF,gFAAgF;YAChF,EAAE;YACF,wEAAwE;YACxE,sEAAsE;YACtE,kCAAkC;YAClC,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAC,CAAC,GAAG,EAAE,EAAE,CAAQ,CAAC;YACrE,oEAAoE;YACpE,qEAAqE;YACrE,kEAAkE;YAClE,wEAAwE;YACxE,yEAAyE;YACzE,uEAAuE;YACvE,kEAAkE;YAClE,EAAE;YACF,0EAA0E;YAC1E,2EAA2E;YAC3E,6EAA6E;YAC7E,aAAa;YACb,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;YACvC,0EAA0E;YAC1E,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;QACF,8CAA8C;QAC9C,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,6CAA6C;QAC7C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,qDAAqD;QACrD,iCAAiC;QACjC,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;KAC5C,CAA4C,CAC9C;IACD,gEAAgE;IAChE,QAAQ,EAAE,gCAAwB;CACnC,CAAC,CAAA;AA8CW,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,8DAA8D;IAC9D,YAAY,EAAE,OAAC,CAAC,KAAK,CACnB,OAAC,CAAC,MAAM,CAAC;QACP,wCAAwC;QACxC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;KACrB,CAAC,CACH;IACD,iEAAiE;IACjE,QAAQ,EAAE,gCAAwB;CACnC,CAAC,CAAA"}

package/dist/connect/parser_executables.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { CodeConnectExecutableParserConfig } from './project';
+import { ParserExecutableMessages, ParserRequestPayload } from './parser_executable_types';
+export declare function callParser(config: CodeConnectExecutableParserConfig, payload: ParserRequestPayload, cwd: string): Promise<object>;
+export declare function handleMessages(messages: z.infer<typeof ParserExecutableMessages>): {
+    hasErrors: boolean;
+};
+//# sourceMappingURL=parser_executables.d.ts.map

package/dist/connect/parser_executables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser_executables.d.ts","sourceRoot":"","sources":["../../src/connect/parser_executables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,iCAAiC,EAA8B,MAAM,WAAW,CAAA;AACzF,OAAO,EAEL,wBAAwB,EACxB,oBAAoB,EACrB,MAAM,2BAA2B,CAAA;AAwDlC,wBAAsB,UAAU,CAC9B,MAAM,EAAE,iCAAiC,EACzC,OAAO,EAAE,oBAAoB,EAC7B,GAAG,EAAE,MAAM,mBAqEZ;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC;;EAqBhF"}

package/dist/connect/parser_executables.js

@@ -0,0 +1,132 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleMessages = exports.callParser = void 0;
+const logging_1 = require("../common/logging");
+const cross_spawn_1 = require("cross-spawn");
+const get_swift_parser_dir_1 = require("../parser_scripts/get_swift_parser_dir");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const get_gradlew_path_1 = require("../parser_scripts/get_gradlew_path");
+const temporaryInputFilePath = 'tmp/figma-code-connect-parser-input.json.tmp';
+const FIRST_PARTY_PARSERS = {
+    swift: {
+        command: async (cwd, config, mode) => {
+            return `swift run --package-path ${await (0, get_swift_parser_dir_1.getSwiftParserDir)(cwd, config.xcodeprojPath)} figma-swift`;
+        },
+    },
+    compose: {
+        command: async (cwd, config, mode) => {
+            const gradlewPath = await (0, get_gradlew_path_1.getGradleWrapperPath)(cwd, config.gradleWrapperPath);
+            const gradleExecutableInvocation = (0, get_gradlew_path_1.getGradleWrapperExecutablePath)(gradlewPath);
+            if (mode === 'CREATE') {
+                return `${gradleExecutableInvocation} -p ${gradlewPath} createCodeConnect -PfilePath=${temporaryInputFilePath} -q`;
+            }
+            else {
+                return `${gradleExecutableInvocation} -p ${gradlewPath} parseCodeConnect -PfilePath=${temporaryInputFilePath} -q`;
+            }
+        },
+        temporaryInputFilePath: temporaryInputFilePath,
+    },
+    __unit_test__: {
+        command: async () => 'node parser/unit_test_parser.js',
+    },
+};
+function getParser(config) {
+    const parser = FIRST_PARTY_PARSERS[config.parser];
+    if (!parser) {
+        (0, logging_1.exitWithError)(`Invalid parser specified: "${config.parser}". Valid parsers are: ${Object.keys(FIRST_PARTY_PARSERS).join(', ')}.`);
+    }
+    return parser;
+}
+async function callParser(config, payload, cwd) {
+    return new Promise(async (resolve, reject) => {
+        try {
+            const parser = getParser(config);
+            const command = await parser.command(cwd, config, payload.mode);
+            if (parser.temporaryInputFilePath) {
+                fs_1.default.mkdirSync(path_1.default.dirname(parser.temporaryInputFilePath), { recursive: true });
+                fs_1.default.writeFileSync(temporaryInputFilePath, JSON.stringify(payload));
+            }
+            logging_1.logger.debug(`Running parser: ${command}`);
+            const commandSplit = command.split(' ');
+            const child = (0, cross_spawn_1.spawn)(commandSplit[0], commandSplit.slice(1), {
+                cwd,
+            });
+            let stdout = '';
+            child.stdout.on('data', (data) => {
+                stdout += data.toString();
+            });
+            // This handles any stderr output from the parser.
+            //
+            // Parsers should not generally write to stderr, and should instead return
+            // an array of messages at the end of execution, but there are cases where
+            // you might want to log output immediately rather than at the end of the
+            // run - e.g. if the parser can take a while to compile first time, you
+            // might want to inform the user immediately that it is compiling.
+            //
+            // To log output, the parser should write a JSON object to stderr with the
+            // same structure as the `messages` response object, e.g. `{ "level":
+            // "INFO", "message": "Compiling parser..." }`.
+            //
+            // Non-JSON output will be logged as debug messages, as this is likely to
+            // be e.g. compiler output which the user doesn't need to see ordinarily.
+            child.stderr.on('data', (data) => {
+                const message = data.toString().trim();
+                try {
+                    const parsed = JSON.parse(message);
+                    handleMessages([parsed]);
+                }
+                catch (e) {
+                    logging_1.logger.debug(message);
+                }
+            });
+            child.on('close', (code) => {
+                if (code !== 0) {
+                    reject(new Error(`Parser exited with code ${code}`));
+                }
+                else {
+                    resolve(JSON.parse(stdout));
+                }
+                if (parser.temporaryInputFilePath) {
+                    fs_1.default.unlinkSync(parser.temporaryInputFilePath);
+                }
+            });
+            child.on('error', (e) => {
+                reject(e);
+            });
+            if (!parser.temporaryInputFilePath) {
+                child.stdin.write(JSON.stringify(payload));
+                child.stdin.end();
+            }
+        }
+        catch (e) {
+            (0, logging_1.exitWithError)(`Error calling parser: ${e}`);
+        }
+    });
+}
+exports.callParser = callParser;
+function handleMessages(messages) {
+    let hasErrors = false;
+    messages.forEach((message) => {
+        switch (message.level) {
+            case 'DEBUG':
+                logging_1.logger.debug(message.message);
+                break;
+            case 'INFO':
+                logging_1.logger.info(message.message);
+                break;
+            case 'WARN':
+                logging_1.logger.warn(message.message);
+                break;
+            case 'ERROR':
+                logging_1.logger.error(message.message);
+                break;
+        }
+    });
+    return { hasErrors };
+}
+exports.handleMessages = handleMessages;
+//# sourceMappingURL=parser_executables.js.map

package/dist/connect/parser_executables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser_executables.js","sourceRoot":"","sources":["../../src/connect/parser_executables.ts"],"names":[],"mappings":";;;;;;AACA,+CAAyD;AAOzD,6CAAmC;AACnC,iFAA0E;AAC1E,4CAAmB;AACnB,gDAAuB;AACvB,yEAG2C;AAE3C,MAAM,sBAAsB,GAAG,8CAA8C,CAAA;AAW7E,MAAM,mBAAmB,GAAmD;IAC1E,KAAK,EAAE;QACL,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YACnC,OAAO,4BAA4B,MAAM,IAAA,wCAAiB,EAAC,GAAG,EAAG,MAAc,CAAC,aAAa,CAAC,cAAc,CAAA;QAC9G,CAAC;KACF;IACD,OAAO,EAAE;QACP,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YACnC,MAAM,WAAW,GAAG,MAAM,IAAA,uCAAoB,EAAC,GAAG,EAAG,MAAc,CAAC,iBAAiB,CAAC,CAAA;YACtF,MAAM,0BAA0B,GAAG,IAAA,iDAA8B,EAAC,WAAW,CAAC,CAAA;YAC9E,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,OAAO,GAAG,0BAA0B,OAAO,WAAW,iCAAiC,sBAAsB,KAAK,CAAA;YACpH,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,0BAA0B,OAAO,WAAW,gCAAgC,sBAAsB,KAAK,CAAA;YACnH,CAAC;QACH,CAAC;QACD,sBAAsB,EAAE,sBAAsB;KAC/C;IACD,aAAa,EAAE;QACb,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,iCAAiC;KACvD;CACF,CAAA;AAED,SAAS,SAAS,CAAC,MAAyC;IAC1D,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAEjD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,IAAA,uBAAa,EACX,8BAA8B,MAAM,CAAC,MAAM,yBAAyB,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACnH,CAAA;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,MAAyC,EACzC,OAA6B,EAC7B,GAAW;IAEX,OAAO,IAAI,OAAO,CAAS,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QACnD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;YAChC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;YAC/D,IAAI,MAAM,CAAC,sBAAsB,EAAE,CAAC;gBAClC,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;gBAC9E,YAAE,CAAC,aAAa,CAAC,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;YACnE,CAAC;YACD,gBAAM,CAAC,KAAK,CAAC,mBAAmB,OAAO,EAAE,CAAC,CAAA;YAC1C,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAEvC,MAAM,KAAK,GAAG,IAAA,mBAAK,EAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBAC1D,GAAG;aACJ,CAAC,CAAA;YAEF,IAAI,MAAM,GAAG,EAAE,CAAA;YAEf,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC/B,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAA;YAC3B,CAAC,CAAC,CAAA;YAEF,kDAAkD;YAClD,EAAE;YACF,0EAA0E;YAC1E,0EAA0E;YAC1E,yEAAyE;YACzE,uEAAuE;YACvE,kEAAkE;YAClE,EAAE;YACF,0EAA0E;YAC1E,qEAAqE;YACrE,+CAA+C;YAC/C,EAAE;YACF,yEAAyE;YACzE,yEAAyE;YACzE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAA;gBACtC,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;oBAClC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;gBAC1B,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBACvB,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC,CAAA;gBACtD,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;gBAC7B,CAAC;gBACD,IAAI,MAAM,CAAC,sBAAsB,EAAE,CAAC;oBAClC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAA;gBAC9C,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;gBACtB,MAAM,CAAC,CAAC,CAAC,CAAA;YACX,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;gBACnC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;gBAC1C,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;YACnB,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAA,uBAAa,EAAC,yBAAyB,CAAC,EAAE,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAxED,gCAwEC;AAED,SAAgB,cAAc,CAAC,QAAkD;IAC/E,IAAI,SAAS,GAAG,KAAK,CAAA;IAErB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,QAAQ,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,KAAK,OAAO;gBACV,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;gBAC7B,MAAK;YACP,KAAK,MAAM;gBACT,gBAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;gBAC5B,MAAK;YACP,KAAK,MAAM;gBACT,gBAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;gBAC5B,MAAK;YACP,KAAK,OAAO;gBACV,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;gBAC7B,MAAK;QACT,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,EAAE,SAAS,EAAE,CAAA;AACtB,CAAC;AArBD,wCAqBC"}