@supernova-studio/client 0.58.0 → 0.58.1

package/package.json

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

package/src/api/dto/aux/color.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+
+export const DTOColorTokenInlineData = z.object({
+  value: z.string().regex(/^#[a-f0-9]{6,8}$/),
+});
+
+export type DTOColorTokenInlineData = z.infer<typeof DTOColorTokenInlineData>;

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

@@ -1 +1,3 @@
+export * from "./color";
+export * from "./meta";
 export * from "./pagination";

package/src/api/dto/aux/meta.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+
+export const DTOObjectMeta = z.object({
+  name: z.string().max(512),
+  description: z.string().max(2048).optional(),
+});
+
+export type DTOObjectMeta = z.infer<typeof DTOObjectMeta>;

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

@@ -34,14 +34,6 @@ import {
   DTODocumentationPageUpdateActionOutputV2,
 } from "./documentation/page-actions-v2";
 import { DTOFigmaNodeRenderActionInput, DTOFigmaNodeRenderActionOutput } from "./figma-nodes/node-actions-v2";
-import {
-  DTOPropertyDefinitionCreateActionInputV2,
-  DTOPropertyDefinitionCreateActionOutputV2,
-  DTOPropertyDefinitionDeleteActionInputV2,
-  DTOPropertyDefinitionDeleteActionOutputV2,
-  DTOPropertyDefinitionUpdateActionInputV2,
-  DTOPropertyDefinitionUpdateActionOutputV2,
-} from "./properties/property-definitions-actions-v2";
 
 //
 // Read
@@ -67,11 +59,6 @@ export const DTOElementActionOutput = z.discriminatedUnion("type", [
   // Figma frames
   DTOFigmaNodeRenderActionOutput,
 
-  // Properties Definitions
-  DTOPropertyDefinitionCreateActionOutputV2,
-  DTOPropertyDefinitionUpdateActionOutputV2,
-  DTOPropertyDefinitionDeleteActionOutputV2,
-
   // Restore
   DTODocumentationPageRestoreActionOutput,
   DTODocumentationGroupRestoreActionOutput,
@@ -106,11 +93,6 @@ export const DTOElementActionInput = z.discriminatedUnion("type", [
   // Figma frames
   DTOFigmaNodeRenderActionInput,
 
-  // Properties Definitions
-  DTOPropertyDefinitionCreateActionInputV2,
-  DTOPropertyDefinitionUpdateActionInputV2,
-  DTOPropertyDefinitionDeleteActionInputV2,
-
   // Restore
   DTODocumentationPageRestoreActionInput,
   DTODocumentationGroupRestoreActionInput,

package/src/api/dto/elements/properties/index.ts

@@ -1,3 +1,2 @@
-export * from "./property-definitions-actions-v2";
 export * from "./property-definitions";
 export * from "./property-values";

package/src/api/dto/elements/properties/property-definitions.ts

@@ -1,28 +1,35 @@
 import {
-  ElementPropertyDefinitionOption,
   ElementPropertyLinkType,
   ElementPropertyTargetType,
   ElementPropertyTypeSchema,
   nullishToOptional,
-  ObjectMeta,
 } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTOColorTokenInlineData } from "../../aux";
+import { DTOObjectMeta } from "../../aux/meta";
 
 const CODE_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z_$0-9]{1,99}$/;
 
+export const DTOElementPropertyDefinitionOption = z.object({
+  id: z.string(),
+  name: z.string(),
+  backgroundColor: DTOColorTokenInlineData.optional(),
+});
+
 // DTO Object
 export const DTOElementPropertyDefinition = z.object({
   id: z.string(),
   designSystemVersionId: z.string(),
-  meta: ObjectMeta,
+  meta: DTOObjectMeta,
   persistentId: z.string(),
   type: ElementPropertyTypeSchema,
   targetElementType: ElementPropertyTargetType,
   codeName: z.string().regex(CODE_NAME_REGEX),
-  options: nullishToOptional(z.array(ElementPropertyDefinitionOption)),
+  options: nullishToOptional(z.array(DTOElementPropertyDefinitionOption)),
   linkElementType: nullishToOptional(ElementPropertyLinkType),
 });
 
+export type DTOElementPropertyDefinitionOption = z.infer<typeof DTOElementPropertyDefinitionOption>;
 export type DTOElementPropertyDefinition = z.infer<typeof DTOElementPropertyDefinition>;
 
 //
@@ -44,23 +51,22 @@ export type DTOElementPropertyDefinitionResponse = z.infer<typeof DTOElementProp
 // Write
 //
 
-export const DTOElementPropertyDefinitionCreatePayload = DTOElementPropertyDefinition.omit({
-  id: true,
-  designSystemVersionId: true,
+export const DTOElementPropertyDefinitionCreatePayload = z.object({
+  meta: DTOObjectMeta,
+  persistentId: z.string(),
+  type: ElementPropertyTypeSchema,
+  targetElementType: ElementPropertyTargetType,
+  codeName: z.string().regex(CODE_NAME_REGEX),
+  options: nullishToOptional(z.array(DTOElementPropertyDefinitionOption)),
+  linkElementType: nullishToOptional(ElementPropertyLinkType),
+  columnWidth: z.number().max(1024).optional(),
 });
 
 export const DTOElementPropertyDefinitionUpdatePayload = z.object({
-  id: z.string(),
-  name: z.string().optional(),
-  description: z.string().optional(),
+  meta: DTOObjectMeta.optional(),
   codeName: z.string().regex(CODE_NAME_REGEX).optional(),
-  options: z.array(ElementPropertyDefinitionOption).optional(),
-});
-
-export const DTOElementPropertyDefinitionDeletePayload = z.object({
-  id: z.string(),
+  options: z.array(DTOElementPropertyDefinitionOption).optional(),
 });
 
 export type DTOElementPropertyDefinitionCreatePayload = z.infer<typeof DTOElementPropertyDefinitionCreatePayload>;
 export type DTOElementPropertyDefinitionUpdatePayload = z.infer<typeof DTOElementPropertyDefinitionUpdatePayload>;
-export type DTOElementPropertyDefinitionDeletePayload = z.infer<typeof DTOElementPropertyDefinitionDeletePayload>;

package/src/api/endpoints/design-system/versions/property-definitions.ts

@@ -1,7 +1,9 @@
+import { z } from "zod";
 import {
   DTOElementPropertyDefinitionCreatePayload,
   DTOElementPropertyDefinitionListResponse,
   DTOElementPropertyDefinitionResponse,
+  DTOElementPropertyDefinitionUpdatePayload,
 } from "../../../dto";
 import { RequestExecutor } from "../../../transport/request-executor";
 
@@ -22,4 +24,20 @@ export class ElementPropertyDefinitionsEndpoint {
       { method: "POST", body }
     );
   }
+
+  update(designSystemId: string, versionId: string, defId: string, body: DTOElementPropertyDefinitionUpdatePayload) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/element-properties/definitions/${defId}`,
+      DTOElementPropertyDefinitionResponse,
+      { method: "PUT", body }
+    );
+  }
+
+  delete(designSystemId: string, versionId: string, defId: string) {
+    return this.requestExecutor.json(
+      `/design-systems/${designSystemId}/versions/${versionId}/element-properties/definitions/${defId}`,
+      z.any(),
+      { method: "DELETE" }
+    );
+  }
 }

package/src/api/transport/request-executor.ts

@@ -58,8 +58,11 @@ export class RequestExecutor {
       throw RequestExecutorError.serverError(endpoint, response.status, bodyString);
     }
 
-    const wrapperParseResult = ResponseWrapper.safeParse(await response.json());
+    const json = await response.json();
+    const wrapperParseResult = ResponseWrapper.safeParse(json);
     if (!wrapperParseResult.success) {
+      console.error(`Response was:`);
+      console.error(json);
       throw RequestExecutorError.responseParsingError(endpoint, wrapperParseResult.error);
     }
 

package/src/api/dto/elements/properties/property-definitions-actions-v2.ts

@@ -1,53 +0,0 @@
-import { z } from "zod";
-import {
-  DTOElementPropertyDefinition,
-  DTOElementPropertyDefinitionCreatePayload,
-  DTOElementPropertyDefinitionDeletePayload,
-  DTOElementPropertyDefinitionUpdatePayload,
-} from "./property-definitions";
-
-// Outputs
-
-const SuccessPayload = z.object({
-  success: z.literal(true),
-});
-
-export const DTOPropertyDefinitionCreateActionOutputV2 = z.object({
-  type: z.literal("PropertyDefinitionCreate"),
-  definition: DTOElementPropertyDefinition,
-});
-
-export const DTOPropertyDefinitionUpdateActionOutputV2 = z.object({
-  type: z.literal("PropertyDefinitionUpdate"),
-  definition: DTOElementPropertyDefinition,
-});
-
-export const DTOPropertyDefinitionDeleteActionOutputV2 = z.object({
-  type: z.literal("PropertyDefinitionDelete"),
-  output: SuccessPayload,
-});
-
-export type DTOPropertyDefinitionCreateActionOutputV2 = z.infer<typeof DTOPropertyDefinitionCreateActionOutputV2>;
-export type DTOPropertyDefinitionUpdateActionOutputV2 = z.infer<typeof DTOPropertyDefinitionUpdateActionOutputV2>;
-export type DTOPropertyDefinitionDeleteActionOutputV2 = z.infer<typeof DTOPropertyDefinitionDeleteActionOutputV2>;
-
-// Inputs
-
-export const DTOPropertyDefinitionCreateActionInputV2 = z.object({
-  type: z.literal("PropertyDefinitionCreate"),
-  input: DTOElementPropertyDefinitionCreatePayload,
-});
-
-export const DTOPropertyDefinitionUpdateActionInputV2 = z.object({
-  type: z.literal("PropertyDefinitionUpdate"),
-  input: DTOElementPropertyDefinitionUpdatePayload,
-});
-
-export const DTOPropertyDefinitionDeleteActionInputV2 = z.object({
-  type: z.literal("PropertyDefinitionDelete"),
-  input: DTOElementPropertyDefinitionDeletePayload,
-});
-
-export type DTOPropertyDefinitionCreateActionInputV2 = z.infer<typeof DTOPropertyDefinitionCreateActionInputV2>;
-export type DTOPropertyDefinitionUpdateActionInputV2 = z.infer<typeof DTOPropertyDefinitionUpdateActionInputV2>;
-export type DTOPropertyDefinitionDeleteActionInputV2 = z.infer<typeof DTOPropertyDefinitionDeleteActionInputV2>;