@supernova-studio/client 0.58.16 → 0.58.18

package/package.json

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

package/src/api/client.ts

@@ -1,5 +1,6 @@
 import { CodegenEndpoint, WorkspacesEndpoint } from "./endpoints";
 import { DesignSystemsEndpoint } from "./endpoints/design-system";
+import { LiveblocksEndpoint } from "./endpoints/liveblocks";
 import { UsersEndpoint } from "./endpoints/users";
 import { RequestExecutor } from "./transport/request-executor";
 
@@ -13,6 +14,7 @@ export class SupernovaApiClient {
   readonly workspaces: WorkspacesEndpoint;
   readonly designSystems: DesignSystemsEndpoint;
   readonly codegen: CodegenEndpoint;
+  readonly liveblocks: LiveblocksEndpoint;
 
   constructor(config: SupernovaApiClientConfig) {
     const requestExecutor = new RequestExecutor({
@@ -24,5 +26,6 @@ export class SupernovaApiClient {
     this.workspaces = new WorkspacesEndpoint(requestExecutor);
     this.designSystems = new DesignSystemsEndpoint(requestExecutor);
     this.codegen = new CodegenEndpoint(requestExecutor);
+    this.liveblocks = new LiveblocksEndpoint(requestExecutor);
   }
 }

package/src/api/dto/documentation/index.ts

@@ -5,3 +5,4 @@ export * from "./block";
 export * from "./documentation-page-snapshot";
 export * from "./link-preview";
 export * from "./publish";
+export * from "./room";

package/src/api/dto/documentation/room.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+
+export const DTODocumentationPageRoom = z.object({
+  id: z.string(),
+});
+
+export const DTODocumentationPageRoomResponse = z.object({
+  room: DTODocumentationPageRoom,
+});
+
+export type DTODocumentationPageRoom = z.infer<typeof DTODocumentationPageRoom>;
+export type DTODocumentationPageRoomResponse = z.infer<typeof DTODocumentationPageRoomResponse>;

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

@@ -52,7 +52,26 @@ export type DTOFigmaNode = z.infer<typeof DTOFigmaNode>;
 // Write
 //
 
-export const DTOFigmaNodeRenderInput = z.object({
+/**
+ * Properties that are available on all types of Figma node render requests
+ */
+const DTOFigmaNodeRenderInputBase = z.object({
+  /**
+   * Format in which the node must be rendered, png by default.
+   */
+  format: FigmaNodeRenderFormat.default("Png"),
+});
+
+/**
+ * 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({
+  inputType: z
+    .literal("NodeId")
+    .optional()
+    .transform(v => v ?? "NodeId"),
+
   /**
    * Id of a design system's data source representing a linked Figma file
    */
@@ -62,11 +81,26 @@ export const DTOFigmaNodeRenderInput = z.object({
    * Id of a node within the Figma file
    */
   figmaFileNodeId: 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.
+ */
+const DTOFigmaNodeRenderUrlInput = DTOFigmaNodeRenderInputBase.extend({
+  inputType: z.literal("URL"),
 
   /**
-   * Format in which the node must be rendered, png by default.
+   * Id of a design system's data source representing a linked Figma file
    */
-  format: FigmaNodeRenderFormat.default("Png"),
+  figmaNodeUrl: z.string(),
 });
 
+export const DTOFigmaNodeRenderInput = z.discriminatedUnion("inputType", [
+  DTOFigmaNodeRenderIdInput,
+  DTOFigmaNodeRenderUrlInput,
+]);
+
+export type DTOFigmaNodeRenderIdInput = z.infer<typeof DTOFigmaNodeRenderIdInput>;
+export type DTOFigmaNodeRenderUrlInput = z.infer<typeof DTOFigmaNodeRenderUrlInput>;
 export type DTOFigmaNodeRenderInput = z.infer<typeof DTOFigmaNodeRenderInput>;

package/src/api/endpoints/design-system/versions/documentation.ts

@@ -1,11 +1,11 @@
-import { DTODocumentationStructure, DTODocumentationStructureItem, DTOImportJobResponse } from "../../../dto";
+import { DTODocumentationPageRoomResponse, DTODocumentationStructure } from "../../../dto";
 import { RequestExecutor } from "../../../transport/request-executor";
 
 export class DocumentationEndpoint {
   constructor(private readonly requestExecutor: RequestExecutor) {}
 
-  getStructure(designSystemId: string, versionId: string) {
-    return this.requestExecutor.json(
+  async getStructure(designSystemId: string, versionId: string) {
+    return await this.requestExecutor.json(
       `/design-systems/${designSystemId}/versions/${versionId}/documentation/structure`,
       DTODocumentationStructure
     );
@@ -14,10 +14,14 @@ export class DocumentationEndpoint {
   async getDocStructure(dsId: string, vId: string) {
     return await this.requestExecutor.json(
       `/design-systems/${dsId}/versions/${vId}/documentation/structure`,
-      DTODocumentationStructure,
-      {
-        method: "GET",
-      }
+      DTODocumentationStructure
+    );
+  }
+
+  async getPageRoom(dsId: string, vId: string, pageId: string) {
+    return await this.requestExecutor.json(
+      `/design-systems/${dsId}/versions/${vId}/documentation/pages/${pageId}/room`,
+      DTODocumentationPageRoomResponse
     );
   }
 }

package/src/api/endpoints/index.ts

@@ -1,4 +1,5 @@
 export * from "./codegen";
 export * from "./design-system";
 export * from "./workspaces";
+export * from "./liveblocks";
 export * from "./users";

package/src/api/endpoints/liveblocks.ts

@@ -0,0 +1,14 @@
+import { DTOLiveblocksAuthResponse } from "../dto";
+import { DTOLiveblocksAuthRequest } from "../payloads";
+import { RequestExecutor } from "../transport/request-executor";
+
+export class LiveblocksEndpoint {
+  constructor(private readonly requestExecutor: RequestExecutor) {}
+
+  auth(body: DTOLiveblocksAuthRequest) {
+    return this.requestExecutor.json("/liveblocks/auth", DTOLiveblocksAuthResponse, {
+      method: "POST",
+      body,
+    });
+  }
+}

package/src/utils/figma.ts

@@ -0,0 +1,53 @@
+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 const FigmaUtils = {
+  tryParseFigmaFileURL(urlString: string): ParsedFigmaFileURL | null {
+    if (!URL.canParse(urlString)) return null;
+
+    // Validate that this is a Figma URL
+    const url = new URL(urlString);
+    if (!url.hostname.endsWith("figma.com")) return null;
+
+    // Validate that the URL type is the correct one (pointing to a design file)
+    const pathSegments = url.pathname.split("/");
+    if (pathSegments[0] !== "design" && pathSegments[0] !== "file") return null;
+
+    // Validate Figma file ID
+    const fileId = pathSegments[1];
+    if (!fileId || !fileId.match(figmaFileIdRegex)) return null;
+
+    // Parse Figma file name
+    let fileName: string | null = null;
+    const rawFileName = pathSegments[2];
+    if (rawFileName) {
+      fileName = rawFileName.replaceAll("-", " ");
+    }
+
+    // Parse node id
+    let nodeId: string | null = null;
+    const nodeIdRaw = url.searchParams.get("node-id");
+    if (nodeIdRaw && nodeIdRaw.match(nodeIdRegex)) {
+      nodeId = nodeIdRaw.replace("-", ":");
+    }
+
+    // Parse node type
+    let nodeType: string | null = null;
+    const nodeTypeRaw = url.searchParams.get("node-type");
+    if (nodeTypeRaw && nodeTypeRaw.match(nodeTypeRegex)) {
+      nodeType = nodeTypeRaw;
+    }
+
+    return { fileId, fileName, nodeId, nodeType };
+  },
+};
+
+// https://www.figma.com/design/U3Mg3I8WbvqF6CcZtRJM7w?node-id=2-3&t=9Qev2vhsldyFMhuE-1

package/src/utils/index.ts

@@ -1,2 +1,3 @@
+export * from "./figma";
 export * from "./hash";
 export * from "./query";