@supernova-studio/client 0.59.3 → 0.59.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/client",
-  "version": "0.59.3",
+  "version": "0.59.5",
   "description": "Supernova Data Models",
   "source": "src/index.ts",
   "main": "dist/index.js",

package/src/api/dto/elements/figma-nodes/figma-node.ts

@@ -43,7 +43,7 @@ const DTOFigmaNodeRenderInputBase = z.object({
  * Figma node render request that uses source ID + node ID to identify the requested
  * node to render. The node ID can be obtained from the source's Figma node structure.
  */
-const DTOFigmaNodeRenderIdInput = DTOFigmaNodeRenderInputBase.extend({
+export const DTOFigmaNodeRenderIdInput = DTOFigmaNodeRenderInputBase.extend({
   inputType: z
     .literal("NodeId")
     .optional()
@@ -64,7 +64,7 @@ const DTOFigmaNodeRenderIdInput = DTOFigmaNodeRenderInputBase.extend({
  * Figma node render request that uses Figma URL to identify the requested
  * node to render. The URL can be obtained by the user directly from the Figma app.
  */
-const DTOFigmaNodeRenderUrlInput = DTOFigmaNodeRenderInputBase.extend({
+export const DTOFigmaNodeRenderUrlInput = DTOFigmaNodeRenderInputBase.extend({
   inputType: z.literal("URL"),
 
   /**
@@ -78,11 +78,26 @@ const DTOFigmaNodeRenderUrlInput = DTOFigmaNodeRenderInputBase.extend({
   brandPersistentId: z.string(),
 });
 
+/**
+ * Figma node render request that uses Figma URL to identify the requested
+ * node to render. The URL can be obtained by the user directly from the Figma app.
+ */
+export const DTOFigmaNodeRerenderInput = z.object({
+  inputType: z.literal("Rerender"),
+
+  /**
+   * Persistent ID of an existing Figma node
+   */
+  figmaNodePersistentId: z.string(),
+});
+
 export const DTOFigmaNodeRenderInput = z.discriminatedUnion("inputType", [
   DTOFigmaNodeRenderIdInput,
   DTOFigmaNodeRenderUrlInput,
+  DTOFigmaNodeRerenderInput,
 ]);
 
 export type DTOFigmaNodeRenderIdInput = z.infer<typeof DTOFigmaNodeRenderIdInput>;
 export type DTOFigmaNodeRenderUrlInput = z.infer<typeof DTOFigmaNodeRenderUrlInput>;
+export type DTOFigmaNodeRerenderInput = z.infer<typeof DTOFigmaNodeRerenderInput>;
 export type DTOFigmaNodeRenderInput = z.infer<typeof DTOFigmaNodeRenderInput>;

package/src/api/dto/elements/figma-nodes/node-actions-v2.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { DTOFigmaNodeRenderInput } from "./figma-node";
+import { DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput } from "./figma-node";
 import { DTOFigmaNode } from "./figma-node-v1";
 import { DTOFigmaNodeV2 } from "./figma-node-v2";
 
@@ -32,7 +32,7 @@ export type DTOFigmaNodeRenderAsyncActionOutput = z.infer<typeof DTOFigmaNodeRen
  */
 export const DTOFigmaNodeRenderActionInput = z.object({
   type: z.literal("FigmaNodeRender"),
-  input: DTOFigmaNodeRenderInput.array(),
+  input: DTOFigmaNodeRenderIdInput.array(),
 });
 
 export const DTOFigmaNodeRenderAsyncActionInput = z.object({

package/src/api/endpoints/design-system/versions/elements-action.ts

@@ -4,6 +4,7 @@ import {
   DTOCreateDocumentationTabInput,
   DTOElementActionInput,
   DTOElementActionOutput,
+  DTOFigmaNodeRenderIdInput,
   DTOFigmaNodeRenderInput,
   DTOMoveDocumentationGroupInput,
   DTOUpdateDocumentationGroupInput,
@@ -38,7 +39,7 @@ export class ElementsActionEndpoint {
     return this.action(dsId, vId, { type: "DocumentationTabCreate", input });
   }
 
-  async renderNodes(dsId: string, vId: string, input: DTOFigmaNodeRenderInput[]) {
+  async renderNodes(dsId: string, vId: string, input: DTOFigmaNodeRenderIdInput[]) {
     return this.action(dsId, vId, { type: "FigmaNodeRender", input });
   }
 

package/src/utils/figma.ts

@@ -2,28 +2,47 @@ const figmaFileIdRegex = /^[0-9a-zA-Z]{22,128}$/;
 const nodeIdRegex = /^\d+-\d+$/;
 const nodeTypeRegex = /^[0-9a-zA-Z]^/;
 
-type ParsedFigmaFileURL = {
-  fileId: string;
-  fileName: string | null;
-  nodeId: string | null;
-  nodeType: string | null;
-};
+export enum ParsedFigmaFileURLError {
+  InvalidUrl = "InvalidUrl",
+  InvalidFigmaFileId = "InvalidFigmaFileId",
+}
+
+type ParsedFigmaFileURL =
+  | {
+      status: "Success";
+      fileId: string;
+      fileName: string | null;
+      nodeId: string | null;
+      nodeType: string | null;
+    }
+  | {
+      status: "Error";
+      error: ParsedFigmaFileURLError;
+    };
 
 export const FigmaUtils = {
-  tryParseFigmaFileURL(urlString: string): ParsedFigmaFileURL | null {
-    if (!URL.canParse(urlString)) return null;
+  tryParseFigmaFileURL(urlString: string): ParsedFigmaFileURL {
+    if (!URL.canParse(urlString)) {
+      return { status: "Error", error: ParsedFigmaFileURLError.InvalidUrl };
+    }
 
     // Validate that this is a Figma URL
     const url = new URL(urlString);
-    if (!url.hostname.endsWith("figma.com")) return null;
+    if (!url.hostname.endsWith("figma.com")) {
+      return { status: "Error", error: ParsedFigmaFileURLError.InvalidUrl };
+    }
 
     // Validate that the URL type is the correct one (pointing to a design file)
     const pathSegments = url.pathname.split("/");
-    if (pathSegments[1] !== "design" && pathSegments[1] !== "file") return null;
+    if (pathSegments[1] !== "design" && pathSegments[1] !== "file") {
+      return { status: "Error", error: ParsedFigmaFileURLError.InvalidUrl };
+    }
 
     // Validate Figma file ID
     const fileId = pathSegments[2];
-    if (!fileId || !fileId.match(figmaFileIdRegex)) return null;
+    if (!fileId || !fileId.match(figmaFileIdRegex)) {
+      return { status: "Error", error: ParsedFigmaFileURLError.InvalidFigmaFileId };
+    }
 
     // Parse Figma file name
     let fileName: string | null = null;
@@ -46,7 +65,7 @@ export const FigmaUtils = {
       nodeType = nodeTypeRaw;
     }
 
-    return { fileId, fileName, nodeId, nodeType };
+    return { status: "Success", fileId, fileName, nodeId, nodeType };
   },
 };