@supernova-studio/client 0.59.0 → 0.59.2

package/package.json

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

package/src/api/conversion/export/pipeline.ts

@@ -19,6 +19,7 @@ export function pipelineToDto(pipeline: Pipeline): DTOPipeline {
     destinationGithub: pipeline.destinationGithub,
     destinationGitlab: pipeline.destinationGitlab,
     destinationS3: pipeline.destinationS3,
+    exporterConfigurationProperties: pipeline.exporterConfigurationProperties,
     webhookUrl: pipeline.webhookUrl,
     latestJobs: [],
   };

package/src/api/dto/elements/elements-action-v2.ts

@@ -33,7 +33,12 @@ import {
   DTODocumentationPageUpdateActionInputV2,
   DTODocumentationPageUpdateActionOutputV2,
 } from "./documentation/page-actions-v2";
-import { DTOFigmaNodeRenderActionInput, DTOFigmaNodeRenderActionOutput } from "./figma-nodes/node-actions-v2";
+import {
+  DTOFigmaNodeRenderActionInput,
+  DTOFigmaNodeRenderActionOutput,
+  DTOFigmaNodeRenderAsyncActionInput,
+  DTOFigmaNodeRenderAsyncActionOutput,
+} from "./figma-nodes/node-actions-v2";
 
 //
 // Read
@@ -58,6 +63,7 @@ export const DTOElementActionOutput = z.discriminatedUnion("type", [
 
   // Figma frames
   DTOFigmaNodeRenderActionOutput,
+  DTOFigmaNodeRenderAsyncActionOutput,
 
   // Restore
   DTODocumentationPageRestoreActionOutput,
@@ -92,6 +98,7 @@ export const DTOElementActionInput = z.discriminatedUnion("type", [
 
   // Figma frames
   DTOFigmaNodeRenderActionInput,
+  DTOFigmaNodeRenderAsyncActionInput,
 
   // Restore
   DTODocumentationPageRestoreActionInput,

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

@@ -0,0 +1,32 @@
+import { FigmaNodeReference } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTOFigmaNodeOrigin, DTOFigmaNodeRenderFormat } from "./figma-node";
+
+export const DTOFigmaNodeData = z.object({
+  // Id of the node in the Figma file
+  figmaNodeId: z.string(),
+
+  // Validity
+  isValid: z.boolean(),
+
+  // Asset data
+  assetId: z.string(),
+  assetUrl: z.string(),
+  assetFormat: DTOFigmaNodeRenderFormat,
+
+  // Asset metadata
+  assetScale: z.number(),
+  assetWidth: z.number().optional(),
+  assetHeight: z.number().optional(),
+});
+
+export const DTOFigmaNode = FigmaNodeReference.omit({
+  data: true,
+  origin: true,
+}).extend({
+  data: DTOFigmaNodeData,
+  origin: DTOFigmaNodeOrigin,
+});
+
+export type DTOFigmaNodeData = z.infer<typeof DTOFigmaNodeData>;
+export type DTOFigmaNode = z.infer<typeof DTOFigmaNode>;

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

@@ -0,0 +1,32 @@
+import {
+  FigmaNodeReference,
+  FigmaNodeRenderedImage,
+  FigmaNodeRenderError,
+  FigmaNodeRenderFormat,
+  FigmaNodeRenderState,
+} from "@supernova-studio/model";
+import { z } from "zod";
+import { DTOFigmaNodeOrigin } from "./figma-node";
+
+export const DTOFigmaNodeDataV2 = z.object({
+  sceneNodeId: z.string(),
+  format: FigmaNodeRenderFormat,
+  scale: z.number().optional(),
+
+  renderState: FigmaNodeRenderState,
+  renderedImage: FigmaNodeRenderedImage.optional(),
+  renderError: FigmaNodeRenderError.optional(),
+
+  hasSource: z.boolean(),
+});
+
+export const DTOFigmaNodeV2 = FigmaNodeReference.omit({
+  data: true,
+  origin: true,
+}).extend({
+  data: DTOFigmaNodeDataV2,
+  origin: DTOFigmaNodeOrigin,
+});
+
+export type DTOFigmaNodeDataV2 = z.infer<typeof DTOFigmaNodeDataV2>;
+export type DTOFigmaNodeV2 = z.infer<typeof DTOFigmaNodeV2>;

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

@@ -1,4 +1,4 @@
-import { FigmaNodeReference, FigmaNodeRenderFormat } from "@supernova-studio/model";
+import { FigmaNodeRenderFormat } from "@supernova-studio/model";
 import { z } from "zod";
 
 //
@@ -18,35 +18,7 @@ export const DTOFigmaNodeOrigin = z.object({
   parentName: z.string().optional(),
 });
 
-export const DTOFigmaNodeData = z.object({
-  // Id of the node in the Figma file
-  figmaNodeId: z.string(),
-
-  // Validity
-  isValid: z.boolean(),
-
-  // Asset data
-  assetId: z.string(),
-  assetUrl: z.string(),
-  assetFormat: DTOFigmaNodeRenderFormat,
-
-  // Asset metadata
-  assetScale: z.number(),
-  assetWidth: z.number().optional(),
-  assetHeight: z.number().optional(),
-});
-
-export const DTOFigmaNode = FigmaNodeReference.omit({
-  data: true,
-  origin: true,
-}).extend({
-  data: DTOFigmaNodeData,
-  origin: DTOFigmaNodeOrigin,
-});
-
 export type DTOFigmaNodeOrigin = z.infer<typeof DTOFigmaNodeOrigin>;
-export type DTOFigmaNodeData = z.infer<typeof DTOFigmaNodeData>;
-export type DTOFigmaNode = z.infer<typeof DTOFigmaNode>;
 
 //
 // Write
@@ -60,6 +32,11 @@ const DTOFigmaNodeRenderInputBase = z.object({
    * Format in which the node must be rendered, png by default.
    */
   format: FigmaNodeRenderFormat.default("Png"),
+
+  /**
+   * Scale to apply to PNG images, can be between 1 and 4. Scale is ignored for other image formats.
+   */
+  scale: z.number().optional(),
 });
 
 /**

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

@@ -1,2 +1,4 @@
+export * from "./figma-node-v1";
+export * from "./figma-node-v2";
 export * from "./figma-node";
 export * from "./node-actions-v2";

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

@@ -1,24 +1,44 @@
 import { z } from "zod";
-import { DTOFigmaNode, DTOFigmaNodeRenderInput } from "./figma-node";
+import { DTOFigmaNodeRenderInput } from "./figma-node";
+import { DTOFigmaNode } from "./figma-node-v1";
+import { DTOFigmaNodeV2 } from "./figma-node-v2";
 
 //
 // Read
 //
 
+/**
+ * @deprecated Please use FigmaNodeRenderAsync (DTOFigmaNodeRenderAsyncActionOutput)
+ */
 export const DTOFigmaNodeRenderActionOutput = z.object({
   type: z.literal("FigmaNodeRender"),
   figmaNodes: z.array(DTOFigmaNode),
 });
 
+export const DTOFigmaNodeRenderAsyncActionOutput = z.object({
+  type: z.literal("FigmaNodeRenderAsync"),
+  figmaNodes: z.array(DTOFigmaNodeV2),
+});
+
 export type DTOFigmaNodeRenderActionOutput = z.infer<typeof DTOFigmaNodeRenderActionOutput>;
+export type DTOFigmaNodeRenderAsyncActionOutput = z.infer<typeof DTOFigmaNodeRenderAsyncActionOutput>;
 
 //
 // Read
 //
 
+/**
+ * @deprecated Please use FigmaNodeRenderAsync (DTOFigmaNodeRenderAsyncActionInput)
+ */
 export const DTOFigmaNodeRenderActionInput = z.object({
   type: z.literal("FigmaNodeRender"),
   input: DTOFigmaNodeRenderInput.array(),
 });
 
+export const DTOFigmaNodeRenderAsyncActionInput = z.object({
+  type: z.literal("FigmaNodeRenderAsync"),
+  nodes: DTOFigmaNodeRenderInput.array(),
+});
+
 export type DTOFigmaNodeRenderActionInput = z.infer<typeof DTOFigmaNodeRenderActionInput>;
+export type DTOFigmaNodeRenderAsyncActionInput = z.infer<typeof DTOFigmaNodeRenderAsyncActionInput>;

package/src/api/dto/elements/get-elements-v2.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { DTOFigmaNode } from "./figma-nodes";
+import { DTOFigmaNode, DTOFigmaNodeV2 } from "./figma-nodes";
 
 //
 // Read
@@ -9,13 +9,19 @@ export const DTOElementsGetTypeFilter = z.enum(["FigmaNode"]);
 
 export const DTOElementsGetQuerySchema = z.object({
   types: z.string().transform(val => val.split(",").map(v => DTOElementsGetTypeFilter.parse(v))),
+  responseVersion: z.coerce.number().default(1),
 });
 
 export const DTOElementsGetOutput = z.object({
   figmaNodes: z.array(DTOFigmaNode).optional(),
 });
 
+export const DTOElementsGetOutputV2 = z.object({
+  figmaNodes: z.array(DTOFigmaNodeV2).optional(),
+});
+
 export type DTOElementsGetOutput = z.infer<typeof DTOElementsGetOutput>;
+export type DTOElementsGetOutputV2 = z.infer<typeof DTOElementsGetOutputV2>;
 export type DTOElementsGetQueryRaw = z.input<typeof DTOElementsGetQuerySchema>;
 export type DTOElementsGetQueryParsed = z.output<typeof DTOElementsGetQuerySchema>;
 export type DTOElementsGetTypeFilter = z.infer<typeof DTOElementsGetTypeFilter>;

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

@@ -42,6 +42,10 @@ export class ElementsActionEndpoint {
     return this.action(dsId, vId, { type: "FigmaNodeRender", input });
   }
 
+  async renderNodesAsync(dsId: string, vId: string, nodes: DTOFigmaNodeRenderInput[]) {
+    return this.action(dsId, vId, { type: "FigmaNodeRenderAsync", nodes });
+  }
+
   private async action(dsId: string, vId: string, input: DTOElementActionInput) {
     return this.requestExecutor.json(
       `/design-systems/${dsId}/versions/${vId}/elements-action`,

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

@@ -1,13 +1,27 @@
+import { OmitStrict } from "@supernova-studio/model";
 import { serializeQuery } from "../../../../utils";
-import { DTOElementsGetOutput, DTOElementsGetQueryParsed } from "../../../dto";
+import { DTOElementsGetOutput, DTOElementsGetOutputV2, DTOElementsGetQueryParsed } from "../../../dto";
 import { RequestExecutor } from "../../../transport/request-executor";
 
+type GetElementsQuery = OmitStrict<DTOElementsGetQueryParsed, "responseVersion">;
+
 export class ElementsEndpoint {
   constructor(private readonly requestExecutor: RequestExecutor) {}
 
-  getElements(dsId: string, vId: string, query: DTOElementsGetQueryParsed) {
+  getElementsV1(dsId: string, vId: string, query: GetElementsQuery) {
     return this.requestExecutor.json(`/design-systems/${dsId}/versions/${vId}/elements`, DTOElementsGetOutput, {
       query: serializeQuery(query),
     });
   }
+
+  getElementsV2(dsId: string, vId: string, query: GetElementsQuery) {
+    const fullQuery: DTOElementsGetQueryParsed = {
+      ...query,
+      responseVersion: 2,
+    };
+
+    return this.requestExecutor.json(`/design-systems/${dsId}/versions/${vId}/elements`, DTOElementsGetOutputV2, {
+      query: serializeQuery(fullQuery),
+    });
+  }
 }

package/src/events/design-system.ts

@@ -0,0 +1,21 @@
+import { DataSourceRemoteType } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTOEventFigmaNodesRendered = z.object({
+  type: z.literal("DesignSystem.FigmaNodesRendered"),
+  designSystemId: z.string(),
+  versionId: z.string(),
+  figmaNodePersistentIds: z.string().array(),
+});
+
+export const DTOEventDataSourcesImported = z.object({
+  type: z.literal("DesignSystem.ImportJobFinished"),
+  designSystemId: z.string(),
+  versionId: z.string(),
+  importJobId: z.string(),
+  dataSourceType: DataSourceRemoteType,
+  dataSourceIds: z.string().array(),
+});
+
+export type DTOEventFigmaNodesRendered = z.infer<typeof DTOEventFigmaNodesRendered>;
+export type DTOEventDataSourcesImported = z.infer<typeof DTOEventDataSourcesImported>;

package/src/events/event.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+import { DTOEventDataSourcesImported, DTOEventFigmaNodesRendered } from "./design-system";
+
+export const DTOEvent = z.discriminatedUnion("type", [DTOEventDataSourcesImported, DTOEventFigmaNodesRendered]);
+
+export type DTOEvent = z.infer<typeof DTOEvent>;

package/src/events/index.ts

@@ -0,0 +1,2 @@
+export * from "./design-system";
+export * from "./event";

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from "./api";
+export * from "./events";
 export * from "./utils";
 export * from "./yjs";