@supernova-studio/client 0.40.0 → 0.44.0

package/package.json

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

package/src/api/conversion/design-systems/elements/properties/property-definition.ts

@@ -1,5 +1,5 @@
 import { ElementPropertyDefinition } from "@supernova-studio/model";
-import { DTOElementPropertyDefinition } from "packages/client/src/api/dto/elements/properties/property-definitions";
+import { DTOElementPropertyDefinition } from "packages/client/src/api/dto";
 
 export function elementPropertyDefinitionToDto(
   elementProperyDefinition: ElementPropertyDefinition

package/src/api/conversion/design-systems/elements/properties/property-value.ts

@@ -1,5 +1,5 @@
 import { ElementPropertyValue } from "@supernova-studio/model";
-import { DTOElementPropertyValue } from "packages/client/src/api/dto/elements/properties/property-values";
+import { DTOElementPropertyValue } from "packages/client/src/api/dto";
 
 export function elementPropertyValueToDto(elementPropertyValue: ElementPropertyValue): DTOElementPropertyValue {
   let value: string | number | boolean | undefined;

package/src/api/conversion/documentation/documentation-group-v2-to-dto.ts

@@ -1,11 +1,6 @@
-import {
-  defaultDocumentationItemHeaderV2,
-  DocumentationPageV1,
-  DocumentationPageV2,
-  ElementGroup,
-  groupBy,
-} from "@supernova-studio/model";
+import { DocumentationPageV1, DocumentationPageV2, ElementGroup, groupBy } from "@supernova-studio/model";
 import { DTODocumentationGroupStructureV2, DTODocumentationGroupV2 } from "../../dto";
+import { documentationItemConfigurationToDTOV2 } from "./documentation-item-configuration-v2-to-dto";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
 // that we store page and group data in YJS documents in the same way as they are stored in the database.
@@ -31,10 +26,7 @@ export function elementGroupsToDocumentationGroupDTOV2(
   return groups.map(group => {
     return {
       ...elementGroupToDocumentationGroupStructureDTOV2(group, childrenIdsMap),
-      configuration: group.data?.configuration ?? {
-        showSidebar: true,
-        header: defaultDocumentationItemHeaderV2,
-      },
+      configuration: documentationItemConfigurationToDTOV2(group.data?.configuration),
     };
   });
 }
@@ -58,6 +50,7 @@ function elementGroupToDocumentationGroupStructureDTOV2(
     createdAt: group.createdAt,
     updatedAt: group.updatedAt,
     title: group.meta.name,
+    configuration: documentationItemConfigurationToDTOV2(group?.data?.configuration),
     childrenIds: childrenIds,
     isRoot: !group.parentPersistentId,
     groupBehavior: group.data?.behavior ?? "Group",

package/src/api/conversion/documentation/documentation-item-configuration-v1-to-dto.ts

@@ -8,6 +8,8 @@ import { DTODocumentationItemConfigurationV1 } from "../../dto";
 
 export const dtoDefaultItemConfigurationV1: DTODocumentationItemConfigurationV1 = {
   showSidebar: true,
+  isHidden: false,
+  isPrivate: false,
   header: {
     alignment: DocumentationItemHeaderAlignment.Left,
     backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
@@ -26,6 +28,8 @@ export function documentationItemConfigurationToDTOV1(
 
   return {
     showSidebar,
+    isHidden: config.isHidden ?? dtoDefaultItemConfigurationV1.isHidden,
+    isPrivate: config.isPrivate ?? dtoDefaultItemConfigurationV1.isPrivate,
     header: {
       ...headerRest,
       backgroundColor: colorToDTOV1(backgroundColor ?? undefined),

package/src/api/conversion/documentation/documentation-item-configuration-v2-to-dto.ts

@@ -0,0 +1,32 @@
+import {
+  DocumentationItemConfigurationV2,
+  DocumentationItemHeaderAlignment,
+  DocumentationItemHeaderImageScaleType,
+} from "@supernova-studio/model";
+import { DTODocumentationItemConfigurationV2 } from "../../dto/elements/documentation/item-configuration-v2";
+
+const dtoDefaultItemConfigurationV2: DTODocumentationItemConfigurationV2 = {
+  showSidebar: true,
+  isHidden: false,
+  isPrivate: false,
+  header: {
+    alignment: DocumentationItemHeaderAlignment.Left,
+    backgroundImageScaleType: DocumentationItemHeaderImageScaleType.AspectFill,
+    description: "",
+    showBackgroundOverlay: false,
+    showCoverText: true,
+  },
+};
+
+export function documentationItemConfigurationToDTOV2(
+  config: DocumentationItemConfigurationV2 | undefined
+): DTODocumentationItemConfigurationV2 {
+  if (!config) return dtoDefaultItemConfigurationV2;
+
+  return {
+    header: config.header,
+    isHidden: config.isHidden ?? dtoDefaultItemConfigurationV2.isPrivate,
+    isPrivate: config.isPrivate ?? dtoDefaultItemConfigurationV2.isPrivate,
+    showSidebar: config.showSidebar,
+  };
+}

package/src/api/conversion/documentation/documentation-page-v2-to-dto.ts

@@ -1,5 +1,6 @@
-import { DocumentationPageV2, ElementGroup, defaultDocumentationItemHeaderV2 } from "@supernova-studio/model";
+import { DocumentationPageV2, ElementGroup } from "@supernova-studio/model";
 import { DTODocumentationPageStructureV2, DTODocumentationPageV2 } from "../../dto";
+import { documentationItemConfigurationToDTOV2 } from "./documentation-item-configuration-v2-to-dto";
 import { buildDocPagePublishPaths } from "./documentation-page-to-dto-utils";
 
 // The fact that DTO conversion is located here instead of main backend code is due to the fact
@@ -27,10 +28,7 @@ export function documentationPagesToDTOV2(
   return pages.map(page => {
     return {
       ...documentationPageToStructureDTOV2(page, pathsMap),
-      configuration: page.data.configuration ?? {
-        showSidebar: true,
-        header: defaultDocumentationItemHeaderV2,
-      },
+      configuration: documentationItemConfigurationToDTOV2(page.data.configuration),
     };
   });
 }
@@ -52,6 +50,7 @@ function documentationPageToStructureDTOV2(
     title: page.meta.name,
     slug: page.slug,
     userSlug: page.userSlug,
+    configuration: documentationItemConfigurationToDTOV2(page.data.configuration),
     createdAt: page.createdAt,
     updatedAt: page.updatedAt,
     path: path,

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

@@ -2,6 +2,7 @@ export * from "./documentation-elements-to-hierarchy-v2-dto";
 export * from "./documentation-group-v1-to-dto";
 export * from "./documentation-group-v2-to-dto";
 export * from "./documentation-item-configuration-v1-to-dto";
+export * from "./documentation-item-configuration-v2-to-dto";
 export * from "./documentation-page-to-dto-utils";
 export * from "./documentation-page-v1-to-dto";
 export * from "./documentation-page-v2-to-dto";

package/src/api/conversion/index.ts

@@ -1,3 +1,4 @@
 export * from "./design-system";
 export * from "./design-systems";
 export * from "./documentation";
+export * from "./integrations";

package/src/api/conversion/integrations/index.ts

@@ -0,0 +1 @@
+export * from "./integration";

package/src/api/conversion/integrations/integration.ts

@@ -0,0 +1,12 @@
+import { Integration } from "@supernova-studio/model";
+import { DTOIntegration } from "../../dto";
+
+export function integrationToDto(integration: Integration): DTOIntegration {
+  return {
+    id: integration.id,
+    workspaceId: integration.workspaceId,
+    type: integration.type,
+    createdAt: integration.createdAt,
+    integrationCredentials: integration.integrationCredentials ?? undefined,
+  };
+}

package/src/api/dto/design-systems/brand.ts

@@ -10,8 +10,13 @@ export const DTOBrand = z.object({
 
 export const DTOBrandGetResponse = z.object({ brand: DTOBrand });
 
+export const DTOBrandCreateResponse = z.object({
+  brand: DTOBrand,
+});
+
 export const DTOBrandsListResponse = z.object({ brands: z.array(DTOBrand) });
 
 export type DTOBrand = z.infer<typeof DTOBrand>;
 export type DTOBrandGetResponse = z.infer<typeof DTOBrandGetResponse>;
+export type DTOBrandCreateResponse = z.infer<typeof DTOBrandCreateResponse>;
 export type DTOBrandsListResponse = z.infer<typeof DTOBrandsListResponse>;

package/src/api/dto/design-systems/design-system.ts

@@ -8,8 +8,10 @@ import { z } from "zod";
 export const DTODesignSystem = DesignSystem.omit({
   name: true,
   description: true,
+  docExporterId: true,
 }).extend({
   meta: ObjectMeta,
+  docExporterId: z.string(),
 });
 
 export type DTODesignSystem = z.infer<typeof DTODesignSystem>;

package/src/api/dto/design-systems/exporter-property.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+
+export const DTOExporterProperty = z.any({});
+
+export const DTOExporterPropertyListResponse = z.object({ items: z.array(DTOExporterProperty) });
+
+export type DTOExporterProperty = z.infer<typeof DTOExporterProperty>;
+export type DTOExporterPropertyListResponse = z.infer<typeof DTOExporterPropertyListResponse>;

package/src/api/dto/design-systems/index.ts

@@ -1,4 +1,5 @@
 export * from "./brand";
 export * from "./design-system";
+export * from "./exporter-property";
 export * from "./version";
 export * from "./view";

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

@@ -0,0 +1,15 @@
+import { DocumentationPageAnchor } from "@supernova-studio/model";
+import { z } from "zod";
+
+//
+// Read
+//
+
+export const DTODocumentationPageAnchor = DocumentationPageAnchor;
+
+export const DTOGetDocumentationPageAnchorsResponse = z.object({
+  anchors: z.array(DTODocumentationPageAnchor),
+});
+
+export type DTODocumentationPageAnchor = z.infer<typeof DTODocumentationPageAnchor>;
+export type DTOGetDocumentationPageAnchorsResponse = z.infer<typeof DTOGetDocumentationPageAnchorsResponse>;

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

@@ -1 +1,2 @@
+export * from "./anchor";
 export * from "./link-preview";

package/src/api/dto/elements/documentation/group-v2.ts

@@ -1,5 +1,6 @@
+import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
 import { z } from "zod";
-import { DocumentationGroupBehavior, DocumentationItemConfigurationV2, ElementGroup } from "@supernova-studio/model";
+import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 
 //
 // Read
@@ -9,7 +10,7 @@ import { DocumentationGroupBehavior, DocumentationItemConfigurationV2, ElementGr
  * Structure DTO is element properties minus element data (in other words data required
  * to display the element in the left panel)
  */
-export const DTODocumentationGroupStructureV2 = ElementGroup.omit({
+export const DTODocumentationGroupV2 = ElementGroup.omit({
   sortOrder: true,
   parentPersistentId: true,
   brandPersistentId: true,
@@ -23,15 +24,13 @@ export const DTODocumentationGroupStructureV2 = ElementGroup.omit({
   childrenIds: z.array(z.string()),
   groupBehavior: DocumentationGroupBehavior,
   shortPersistentId: z.string(),
+  configuration: DTODocumentationItemConfigurationV2,
   type: z.literal("Group"),
 });
 
-export const DTODocumentationGroupV2 = DTODocumentationGroupStructureV2.extend({
-  configuration: DocumentationItemConfigurationV2,
-});
-
-export type DTODocumentationGroupStructureV2 = z.infer<typeof DTODocumentationGroupStructureV2>;
 export type DTODocumentationGroupV2 = z.infer<typeof DTODocumentationGroupV2>;
+export const DTODocumentationGroupStructureV2 = DTODocumentationGroupV2;
+export type DTODocumentationGroupStructureV2 = DTODocumentationGroupV2;
 
 //
 // Write
@@ -43,10 +42,10 @@ export const DTOCreateDocumentationGroupInput = z.object({
 
   // Group properties
   title: z.string(),
-  configuration: DocumentationItemConfigurationV2.optional(),
+  configuration: DTODocumentationItemConfigurationV2.optional(),
 
   // Group placement properties
-  afterPersistentId: z.string().uuid().optional(),
+  afterPersistentId: z.string().uuid().nullish(),
   parentPersistentId: z.string().uuid(),
 });
 
@@ -56,7 +55,7 @@ export const DTOUpdateDocumentationGroupInput = z.object({
 
   // Group properties
   title: z.string().optional(),
-  configuration: DocumentationItemConfigurationV2.optional(),
+  configuration: DTODocumentationItemConfigurationV2.partial().optional(),
 });
 
 export const DTOMoveDocumentationGroupInput = z.object({
@@ -65,7 +64,7 @@ export const DTOMoveDocumentationGroupInput = z.object({
 
   // Group placement properties
   parentPersistentId: z.string().uuid(),
-  afterPersistentId: z.string().uuid().optional(),
+  afterPersistentId: z.string().uuid().nullish(),
 });
 
 export const DTODuplicateDocumentationGroupInput = z.object({
@@ -76,7 +75,7 @@ export const DTODuplicateDocumentationGroupInput = z.object({
   persistentId: z.string().uuid(),
 
   // Group placement properties
-  afterPersistentId: z.string().uuid().optional(),
+  afterPersistentId: z.string().uuid().nullish(),
   parentPersistentId: z.string().uuid(),
 });
 

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

@@ -2,6 +2,8 @@ export * from "./group-action";
 export * from "./group-v1";
 export * from "./group-v2";
 export * from "./item-configuration-v1";
+export * from "./item-configuration-v2";
 export * from "./page-actions-v2";
+export * from "./page-content";
 export * from "./page-v1";
 export * from "./page-v2";

package/src/api/dto/elements/documentation/item-configuration-v1.ts

@@ -16,6 +16,8 @@ const DTODocumentationItemHeaderV1 = DocumentationItemHeaderV1.omit({
 
 export const DTODocumentationItemConfigurationV1 = z.object({
   showSidebar: z.boolean(),
+  isPrivate: z.boolean(),
+  isHidden: z.boolean(),
   header: DTODocumentationItemHeaderV1,
 });
 

package/src/api/dto/elements/documentation/item-configuration-v2.ts

@@ -0,0 +1,14 @@
+import { DocumentationItemHeaderV2 } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTODocumentationItemHeaderV2 = DocumentationItemHeaderV2;
+
+export const DTODocumentationItemConfigurationV2 = z.object({
+  showSidebar: z.boolean(),
+  isPrivate: z.boolean(),
+  isHidden: z.boolean(),
+  header: DTODocumentationItemHeaderV2,
+});
+
+export type DTODocumentationItemHeaderV2 = z.infer<typeof DTODocumentationItemHeaderV2>;
+export type DTODocumentationItemConfigurationV2 = z.infer<typeof DTODocumentationItemConfigurationV2>;

package/src/api/dto/elements/documentation/page-content.ts

@@ -0,0 +1,15 @@
+import { DocumentationPageContent } from "@supernova-studio/model";
+import { z } from "zod";
+
+//
+// Read
+//
+
+export const DTODocumentationPageContent = DocumentationPageContent;
+
+export const DTODocumentationPageContentGetResponse = z.object({
+  pageContent: DTODocumentationPageContent,
+});
+
+export type DTODocumentationPageContent = z.infer<typeof DTODocumentationPageContent>;
+export type DTODocumentationPageContentGetResponse = z.infer<typeof DTODocumentationPageContentGetResponse>;

package/src/api/dto/elements/documentation/page-v2.ts

@@ -1,7 +1,7 @@
-import { DocumentationItemConfigurationV2, DocumentationPageV2 } from "@supernova-studio/model";
+import { DocumentationPageV2 } from "@supernova-studio/model";
 import { z } from "zod";
+import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
 import { DTODocumentationGroupStructureV2 } from "./group-v2";
-
 //
 // Read
 //
@@ -10,7 +10,7 @@ import { DTODocumentationGroupStructureV2 } from "./group-v2";
  * Structure DTO is element properties minus element data (in other words data required
  * to display the element in the left panel)
  */
-export const DTODocumentationPageStructureV2 = DocumentationPageV2.omit({
+export const DTODocumentationPageV2 = DocumentationPageV2.omit({
   data: true,
   meta: true,
   parentPersistentId: true,
@@ -19,21 +19,21 @@ export const DTODocumentationPageStructureV2 = DocumentationPageV2.omit({
   title: z.string(),
   path: z.string(),
   type: z.literal("Page"),
+  configuration: DTODocumentationItemConfigurationV2,
 });
+export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
 
-export const DTODocumentationPageV2 = DTODocumentationPageStructureV2.extend({
-  configuration: DocumentationItemConfigurationV2,
-});
+export const DTODocumentationPageStructureV2 = DTODocumentationPageV2;
+export type DTODocumentationPageStructureV2 = DTODocumentationPageV2;
 
 export const DTODocumentationHierarchyV2 = z.object({
   pages: z.array(DTODocumentationPageStructureV2),
   groups: z.array(DTODocumentationGroupStructureV2),
 });
 
-export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
-export type DTODocumentationPageStructureV2 = z.infer<typeof DTODocumentationPageStructureV2>;
 export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
 
+
 //
 // Write
 //
@@ -44,11 +44,11 @@ export const DTOCreateDocumentationPageInputV2 = z.object({
 
   // Page properties
   title: z.string(),
-  configuration: DocumentationItemConfigurationV2.optional(),
+  configuration: DTODocumentationItemConfigurationV2.optional(),
 
   // Page placement properties
   parentPersistentId: z.string().uuid(),
-  afterPersistentId: z.string().uuid().optional(),
+  afterPersistentId: z.string().uuid().nullish(),
 });
 
 export const DTOUpdateDocumentationPageInputV2 = z.object({
@@ -57,7 +57,7 @@ export const DTOUpdateDocumentationPageInputV2 = z.object({
 
   // Page properties
   title: z.string().optional(),
-  configuration: DocumentationItemConfigurationV2.optional(),
+  configuration: DTODocumentationItemConfigurationV2.partial().optional(),
 });
 
 export const DTOMoveDocumentationPageInputV2 = z.object({
@@ -66,7 +66,7 @@ export const DTOMoveDocumentationPageInputV2 = z.object({
 
   // Page placement properties
   parentPersistentId: z.string().uuid(),
-  afterPersistentId: z.string().uuid().optional(),
+  afterPersistentId: z.string().uuid().nullish(),
 });
 
 export const DTODuplicateDocumentationPageInputV2 = z.object({
@@ -78,7 +78,7 @@ export const DTODuplicateDocumentationPageInputV2 = z.object({
 
   // Page placement properties
   parentPersistentId: z.string().uuid(),
-  afterPersistentId: z.string().uuid().optional(),
+  afterPersistentId: z.string().uuid().nullish(),
 });
 
 export const DTODeleteDocumentationPageInputV2 = z.object({

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

@@ -1,16 +1,4 @@
 import { z } from "zod";
-import {
-  DTODocumentationPageCreateActionInputV2,
-  DTODocumentationPageCreateActionOutputV2,
-  DTODocumentationPageDeleteActionInputV2,
-  DTODocumentationPageDeleteActionOutputV2,
-  DTODocumentationPageDuplicateActionInputV2,
-  DTODocumentationPageDuplicateActionOutputV2,
-  DTODocumentationPageMoveActionInputV2,
-  DTODocumentationPageMoveActionOutputV2,
-  DTODocumentationPageUpdateActionInputV2,
-  DTODocumentationPageUpdateActionOutputV2,
-} from "./documentation/page-actions-v2";
 import {
   DTODocumentationGroupCreateActionInputV2,
   DTODocumentationGroupCreateActionOutputV2,
@@ -27,7 +15,27 @@ import {
   DTODocumentationTabGroupDeleteActionInputV2,
   DTODocumentationTabGroupDeleteActionOutputV2,
 } from "./documentation/group-action";
+import {
+  DTODocumentationPageCreateActionInputV2,
+  DTODocumentationPageCreateActionOutputV2,
+  DTODocumentationPageDeleteActionInputV2,
+  DTODocumentationPageDeleteActionOutputV2,
+  DTODocumentationPageDuplicateActionInputV2,
+  DTODocumentationPageDuplicateActionOutputV2,
+  DTODocumentationPageMoveActionInputV2,
+  DTODocumentationPageMoveActionOutputV2,
+  DTODocumentationPageUpdateActionInputV2,
+  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
@@ -52,6 +60,11 @@ export const DTOElementActionOutput = z.discriminatedUnion("type", [
 
   // Figma frames
   DTOFigmaNodeRenderActionOutput,
+
+  // Properties Definitions
+  DTOPropertyDefinitionCreateActionOutputV2,
+  DTOPropertyDefinitionUpdateActionOutputV2,
+  DTOPropertyDefinitionDeleteActionOutputV2,
 ]);
 
 export type DTOElementActionOutput = z.infer<typeof DTOElementActionOutput>;
@@ -79,6 +92,11 @@ export const DTOElementActionInput = z.discriminatedUnion("type", [
 
   // Figma frames
   DTOFigmaNodeRenderActionInput,
+
+  // Properties Definitions
+  DTOPropertyDefinitionCreateActionInputV2,
+  DTOPropertyDefinitionUpdateActionInputV2,
+  DTOPropertyDefinitionDeleteActionInputV2,
 ]);
 
 export type DTOElementActionInput = z.infer<typeof DTOElementActionInput>;

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

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

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

@@ -0,0 +1,53 @@
+import { z } from "zod";
+import {
+  DTOCreateElementPropertyDefinitionInputV2,
+  DTODeleteElementPropertyDefinitionInputV2,
+  DTOElementPropertyDefinition,
+  DTOUpdateElementPropertyDefinitionInputV2,
+} 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: DTOCreateElementPropertyDefinitionInputV2,
+});
+
+export const DTOPropertyDefinitionUpdateActionInputV2 = z.object({
+  type: z.literal("PropertyDefinitionUpdate"),
+  input: DTOUpdateElementPropertyDefinitionInputV2,
+});
+
+export const DTOPropertyDefinitionDeleteActionInputV2 = z.object({
+  type: z.literal("PropertyDefinitionDelete"),
+  input: DTODeleteElementPropertyDefinitionInputV2,
+});
+
+export type DTOPropertyDefinitionCreateActionInputV2 = z.infer<typeof DTOPropertyDefinitionCreateActionInputV2>;
+export type DTOPropertyDefinitionUpdateActionInputV2 = z.infer<typeof DTOPropertyDefinitionUpdateActionInputV2>;
+export type DTOPropertyDefinitionDeleteActionInputV2 = z.infer<typeof DTOPropertyDefinitionDeleteActionInputV2>;

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

@@ -1,4 +1,3 @@
-import { z } from "zod";
 import {
   ElementPropertyDefinitionOption,
   ElementPropertyLinkType,
@@ -6,7 +5,11 @@ import {
   ElementPropertyTypeSchema,
   ObjectMeta,
 } from "@supernova-studio/model";
+import { z } from "zod";
+
+const CODE_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z_$0-9]{1,99}$/;
 
+// DTO Object
 export const DTOElementPropertyDefinition = z.object({
   id: z.string(),
   designSystemVersionId: z.string(),
@@ -14,14 +17,46 @@ export const DTOElementPropertyDefinition = z.object({
   persistentId: z.string(),
   type: ElementPropertyTypeSchema,
   targetElementType: ElementPropertyTargetType,
-  codeName: z.string(),
+  codeName: z.string().regex(CODE_NAME_REGEX),
   options: z.array(ElementPropertyDefinitionOption).optional(),
   linkElementType: ElementPropertyLinkType.optional(),
 });
 
+export type DTOElementPropertyDefinition = z.infer<typeof DTOElementPropertyDefinition>;
+
+//
+// Read
+//
+
 export const DTOElementPropertyDefinitionsGetResponse = z.object({
   definitions: z.array(DTOElementPropertyDefinition),
 });
 
-export type DTOElementPropertyDefinition = z.infer<typeof DTOElementPropertyDefinition>;
 export type DTOElementPropertyDefinitionsGetResponse = z.infer<typeof DTOElementPropertyDefinitionsGetResponse>;
+
+//
+// Write
+//
+
+export const DTOCreateElementPropertyDefinitionInputV2 = DTOElementPropertyDefinition.omit({
+  id: true,
+  designSystemVersionId: true,
+});
+
+export type DTOCreateElementPropertyDefinitionInputV2 = z.infer<typeof DTOCreateElementPropertyDefinitionInputV2>;
+
+export const DTOUpdateElementPropertyDefinitionInputV2 = z.object({
+  id: z.string(),
+  name: z.string().optional(),
+  description: z.string().optional(),
+  codeName: z.string().regex(CODE_NAME_REGEX).optional(),
+  options: z.array(ElementPropertyDefinitionOption).optional(),
+});
+
+export type DTOUpdateElementPropertyDefinitionInputV2 = z.infer<typeof DTOUpdateElementPropertyDefinitionInputV2>;
+
+export const DTODeleteElementPropertyDefinitionInputV2 = z.object({
+  id: z.string(),
+});
+
+export type DTODeleteElementPropertyDefinitionInputV2 = z.infer<typeof DTODeleteElementPropertyDefinitionInputV2>;

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

@@ -1,3 +1,4 @@
+export * from "./integrations";
 export * from "./membership";
 export * from "./npm-registry";
 export * from "./workspace";