refactor: rename images to exports so we can export css

Author: braposo

src/types/__tests__/file.test.ts

@@ -33,7 +33,7 @@ describe("File", () => {
         const query = `
             query {
                 file(id: "${figmaFile}") {
-                    images {
+                    exports {
                         id
                     }
                 }
@@ -43,15 +43,15 @@ describe("File", () => {
         const response = await graphql(schema, query, null, { fileId: figmaFile });
 
         expect(response).toEqual({
-            data: { file: { images: [{ id: "0:1" }] } },
+            data: { file: { exports: [{ id: "0:1" }] } },
         });
     });
 
     test("can get specific file images", async () => {
         const query = `
             query {
                 file(id: "${figmaFile}") {
-                    images(params: { ids: ["1:6"]}) {
+                    exports(params: { ids: ["1:6"]}) {
                         id
                     }
                 }
@@ -61,7 +61,7 @@ describe("File", () => {
         const response = await graphql(schema, query, null, { fileId: figmaFile });
 
         expect(response).toEqual({
-            data: { file: { images: [{ id: "1:6" }] } },
+            data: { file: { exports: [{ id: "1:6" }] } },
         });
     });
 

src/types/image.ts src/types/export.ts

@@ -10,6 +10,13 @@ export const type = gql`
         svg
     }
 
+    enum ExportFormat {
+        jpg
+        png
+        svg
+        css
+    }
+
     input ImageParams {
         # A comma separated list of node IDs to render
         ids: [ID]
@@ -21,31 +28,31 @@ export const type = gql`
         format: ImageFormat
     }
 
-    input ImageNodeParams {
+    input ExportParams {
         # A number between 0.01 and 4, the image scaling factor
         scale: Int
 
         # A string enum for the image output format, can be "jpg", "png", or "svg"
-        format: ImageFormat
+        format: ExportFormat
     }
 
-    type Image {
+    type ExportResult {
         id: String
-        file: String
+        output: String
     }
 
     extend type Query {
         # Get just the image of a node id in a file
-        images(id: ID!, params: ImageParams): [Image]
+        exports(id: ID!, params: ImageParams): [ExportResult]
     }
 `;
 
 export const resolvers = {
     Query: {
-        images: async (root, { id, params }) => {
+        exports: async (root, { id, params }) => {
             const imageParams = { ...defaultImageParams, ...params };
             const { images } = await loadImages(id, imageParams).then(data => data);
-            return Object.entries(images).map(entry => ({ id: entry[0], file: entry[1] }));
+            return Object.entries(images).map(entry => ({ id: entry[0], output: entry[1] }));
         },
     },
 };

src/types/file.ts

@@ -1,7 +1,7 @@
 import { gql } from "apollo-server-express";
 import { loadFile, loadImages, loadComments } from "../utils/figma";
 import { generateResolversForShortcuts, generateQueriesForShortcuts } from "../utils/shortcuts";
-import { defaultImageParams } from "./image";
+import { defaultImageParams } from "./export";
 
 export const type = gql`
     # Information about a file
@@ -19,7 +19,7 @@ export const type = gql`
         version: String
 
         # Get images for the file
-        images(params: ImageParams): [Image]
+        exports(params: ImageParams): [ExportResult]
 
         # Get comments for the file
         comments: [Comment]
@@ -38,10 +38,10 @@ export const resolvers = {
         file: (_, { id }) => loadFile(id).then(data => data),
     },
     File: {
-        images: async ({ fileId }, { params }) => {
+        exports: async ({ fileId }, { params }) => {
             const imageParams = { ...defaultImageParams, ...params };
             const { images } = await loadImages(fileId, imageParams);
-            return Object.entries(images).map(entry => ({ id: entry[0], file: entry[1] }));
+            return Object.entries(images).map(entry => ({ id: entry[0], output: entry[1] }));
         },
         comments: ({ fileId }) => loadComments(fileId).then(({ comments }) => comments),
         ...generateResolversForShortcuts(),

src/types/index.ts

@@ -4,7 +4,7 @@ import * as page from "./page";
 import * as frame from "./frame";
 import * as node from "./node";
 import * as vector from "./vector";
-import * as image from "./image";
+import * as fileExport from "./export";
 import * as comments from "./comments";
 import * as projects from "./projects";
 import * as projectFiles from "./project-files";
@@ -21,7 +21,7 @@ const typePaths = [
     frame,
     node,
     vector,
-    image,
+    fileExport,
     comments,
     projects,
     projectFiles,