@supernova-studio/client 1.96.6 → 1.96.7

package/src/api/dto/documentation/analytics-v2.ts

@@ -0,0 +1,80 @@
+import { z } from "zod";
+
+export const DTODocumentationAnalyticsTimeFrame = z.object({
+  start: z.coerce.date(),
+  end: z.coerce.date().optional(),
+});
+
+export type DTODocumentationAnalyticsTimeFrame = z.infer<typeof DTODocumentationAnalyticsTimeFrame>;
+
+//
+// Read
+//
+
+export const DTOPublishedDocVisitData = z.object({
+  timestamp: z.coerce.date(),
+  versionId: z.string(),
+  locale: z.string().optional(),
+  visits: z.number(),
+  sessions: z.number(),
+});
+
+export const DTOPublishedDocPageVisitData = DTOPublishedDocVisitData.extend({
+  pagePersistentId: z.string(),
+});
+
+/**
+ * Array of values per 2 hours (0, 2, 4, 6, etc)
+ */
+const DTOPublishedDocVisitHeatMapDay = z.number().array().length(12);
+
+export const DTOPublishedDocVisitHeatMapWeek = z.object({
+  /**
+   * For which timeframe it was calculated
+   */
+  timeFrame: DTODocumentationAnalyticsTimeFrame,
+
+  mon: DTOPublishedDocVisitHeatMapDay,
+  tue: DTOPublishedDocVisitHeatMapDay,
+  wed: DTOPublishedDocVisitHeatMapDay,
+  thu: DTOPublishedDocVisitHeatMapDay,
+  fri: DTOPublishedDocVisitHeatMapDay,
+  sat: DTOPublishedDocVisitHeatMapDay,
+  sun: DTOPublishedDocVisitHeatMapDay,
+});
+
+export const DTOPublishedDocAnalyticsComparisonData = z.object({
+  /**
+   * For which timeframe it was calculated
+   */
+  timeFrame: DTODocumentationAnalyticsTimeFrame,
+
+  priorVisitCount: z.number(),
+  priorSessionCount: z.number(),
+  currentVisitCount: z.number(),
+  currentSessionCount: z.number(),
+});
+
+export const DTOPublishedDocPageAnalyticsComparisonData = DTOPublishedDocAnalyticsComparisonData.extend({
+  pagePersistentId: z.string(),
+});
+
+export const DTODocumentationPageAnalyticsResponse = z.object({
+  globalAnalytics: DTOPublishedDocVisitData.array(),
+  pageAnalytics: DTOPublishedDocPageVisitData.array(),
+  heatMapData: DTOPublishedDocVisitHeatMapWeek.array(),
+  comparisonData: DTOPublishedDocAnalyticsComparisonData.array(),
+  pageComparisonData: DTOPublishedDocPageAnalyticsComparisonData.array(),
+});
+
+export const DTODocumentationAnalyticsRequest = z.object({
+  timeFrames: z.array(DTODocumentationAnalyticsTimeFrame),
+});
+
+export type DTOPublishedDocVisitHeatMapWeek = z.infer<typeof DTOPublishedDocVisitHeatMapWeek>;
+export type DTOPublishedDocPageVisitData = z.infer<typeof DTOPublishedDocPageVisitData>;
+export type DTOPublishedDocVisitData = z.infer<typeof DTOPublishedDocVisitData>;
+export type DTOPublishedDocAnalyticsComparisonData = z.infer<typeof DTOPublishedDocAnalyticsComparisonData>;
+export type DTOPublishedDocPageAnalyticsComparisonData = z.infer<typeof DTOPublishedDocPageAnalyticsComparisonData>;
+export type DTODocumentationPageAnalyticsResponse = z.infer<typeof DTODocumentationPageAnalyticsResponse>;
+export type DTODocumentationAnalyticsRequest = z.infer<typeof DTODocumentationAnalyticsRequest>;

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

@@ -0,0 +1,32 @@
+import { z } from "zod";
+
+//
+// Difference
+//
+
+/**
+ * @deprecated
+ */
+export const DTODocumentationPageAnalyticsDifference = z.object({
+  startDate: z.coerce.date(),
+  endDate: z.coerce.date().optional(),
+  currentVisitCount: z.number(),
+  currentSessionCount: z.number(),
+  priorVisitCount: z.number(),
+  priorSessionCount: z.number(),
+});
+
+/**
+ * @deprecated
+ */
+export const DTODocumentationPageIntervalDifferenceResponse = z.object({
+  differences: z.array(DTODocumentationPageAnalyticsDifference),
+});
+
+/**
+ * @deprecated
+ */
+export type DTODocumentationPageAnalyticsDifference = z.infer<typeof DTODocumentationPageAnalyticsDifference>;
+export type DTODocumentationPageIntervalDifferenceResponse = z.infer<
+  typeof DTODocumentationPageIntervalDifferenceResponse
+>;

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/approvals.ts

@@ -0,0 +1,21 @@
+import { DocumentationPageApprovalState } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTODocumentationPageApprovalState = z.object({
+  approvalState: DocumentationPageApprovalState,
+  pagePersistentId: z.string(),
+  updatedByUserId: z.string(),
+  designSystemVersionId: z.string(),
+  updatedAt: z.coerce.date(),
+  createdAt: z.coerce.date(),
+});
+
+export const DTODocumentationGroupApprovalState = z.object({
+  persistentId: z.string(),
+  groupPersistentId: z.string(),
+  designSystemVersionId: z.string(),
+  approvalState: DocumentationPageApprovalState,
+});
+
+export type DTODocumentationPageApprovalState = z.infer<typeof DTODocumentationPageApprovalState>;
+export type DTODocumentationGroupApprovalState = z.infer<typeof DTODocumentationGroupApprovalState>;

package/src/api/dto/documentation/block-definition.ts

@@ -0,0 +1,28 @@
+import {
+  PageBlockColorV2,
+  PageBlockDefinition,
+  PageBlockDefinitionBehavior,
+  PageBlockDefinitionItem,
+  PageBlockDefinitionLayout,
+  PageBlockDefinitionProperty,
+  PageBlockDefinitionVariant,
+} from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTOPageBlockDefinitionBehavior = PageBlockDefinitionBehavior;
+export const DTOPageBlockDefinitionItem = PageBlockDefinitionItem;
+export const DTOPageBlockDefinitionLayout = PageBlockDefinitionLayout;
+export const DTOPageBlockDefinitionVariant = PageBlockDefinitionVariant;
+export const DTOPageBlockDefinitionProperty = PageBlockDefinitionProperty;
+export const DTOPageBlockColorV2 = PageBlockColorV2;
+
+export const DTOPageBlockDefinition = PageBlockDefinition;
+
+export type DTOPageBlockDefinitionBehavior = z.infer<typeof DTOPageBlockDefinitionBehavior>;
+export type DTOPageBlockDefinitionItem = z.infer<typeof DTOPageBlockDefinitionItem>;
+export type DTOPageBlockDefinitionLayout = z.infer<typeof DTOPageBlockDefinitionLayout>;
+export type DTOPageBlockDefinitionVariant = z.infer<typeof DTOPageBlockDefinitionVariant>;
+export type DTOPageBlockDefinitionProperty = z.infer<typeof DTOPageBlockDefinitionProperty>;
+export type DTOPageBlockColorV2 = z.infer<typeof DTOPageBlockColorV2>;
+
+export type DTOPageBlockDefinition = z.infer<typeof DTOPageBlockDefinition>;

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

@@ -0,0 +1,6 @@
+import { PageBlockItemV2 } from "@supernova-studio/model";
+import { z } from "zod";
+
+export const DTOPageBlockItemV2 = PageBlockItemV2;
+
+export type DTOPageBlockItemV2 = z.infer<typeof DTOPageBlockItemV2>;

package/src/api/dto/documentation/documentation-page-snapshot.ts

@@ -0,0 +1,18 @@
+import { DesignElementSnapshotReason } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTODocumentationPageV2 } from "../elements/documentation/page-v2";
+
+export const DTODocumentationPageSnapshot = z.object({
+  id: z.string(),
+  designSystemVersionId: z.string(),
+
+  createdAt: z.string(),
+  updatedAt: z.string(),
+
+  documentationPage: DTODocumentationPageV2,
+  pageContentHash: z.string(),
+
+  reason: DesignElementSnapshotReason,
+});
+
+export type DTODocumentationPageSnapshot = z.infer<typeof DTODocumentationPageSnapshot>;

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

@@ -0,0 +1,34 @@
+import { z } from "zod";
+
+export const DTODocumentationMinimalPage = z.object({
+  id: z.string(),
+  title: z.string(),
+  fullPath: z.string(),
+  description: z.string().optional(),
+});
+
+export const DTODocumentationContent = z.object({
+  id: z.string(),
+  markdown: z.string(),
+});
+
+export const DTODocumentationMinimalPageListResponse = z.object({
+  pages: z.array(DTODocumentationMinimalPage),
+});
+
+export const DTODocumentationContentResponse = z.object({
+  pageContents: z.array(DTODocumentationContent),
+});
+
+export const DTODocumentationContentQuery = z.object({
+  pageIds: z
+    .string()
+    .transform(value => value.split(","))
+    .pipe(z.string().trim().array()),
+});
+
+export type DTODocumentationMinimalPage = z.infer<typeof DTODocumentationMinimalPage>;
+export type DTODocumentationMinimalPageListResponse = z.infer<typeof DTODocumentationMinimalPageListResponse>;
+export type DTODocumentationContent = z.infer<typeof DTODocumentationContent>;
+export type DTODocumentationContentResponse = z.infer<typeof DTODocumentationContentResponse>;
+export type DTODocumentationContentQuery = z.infer<typeof DTODocumentationContentQuery>;

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

@@ -0,0 +1,11 @@
+export * from "./analytics-v2";
+export * from "./analytics";
+export * from "./anchor";
+export * from "./approvals";
+export * from "./block-definition";
+export * from "./block";
+export * from "./documentation-page-snapshot";
+export * from "./documentation";
+export * from "./link-preview";
+export * from "./publish";
+export * from "./room";

package/src/api/dto/documentation/link-preview.ts

@@ -0,0 +1,23 @@
+import { DocumentationLinkPreview } from "@supernova-studio/model";
+import { z } from "zod";
+
+//
+// Read
+//
+
+export const DTODocumentationLinkPreviewResponse = z.object({
+  linkPreview: DocumentationLinkPreview,
+});
+
+export type DTODocumentationLinkPreviewResponse = z.infer<typeof DTODocumentationLinkPreviewResponse>;
+
+//
+// Write
+//
+
+export const DTODocumentationLinkPreviewRequest = z.object({
+  url: z.string().optional(),
+  documentationItemPersistentId: z.string().optional(),
+});
+
+export type DTODocumentationLinkPreviewRequest = z.infer<typeof DTODocumentationLinkPreviewRequest>;

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

@@ -0,0 +1,23 @@
+import { ExportJobDocumentationChanges, PublishedDocEnvironment } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTOExportJob } from "../export";
+
+export const DTOPublishDocumentationChanges = ExportJobDocumentationChanges;
+
+export const DTOPublishDocumentationRequest = z.object({
+  environment: PublishedDocEnvironment,
+
+  /**
+   * If defined, this allows narrowing down what is published to a set of specific pages and groups
+   * If undefined, everything will be published.
+   */
+  changes: DTOPublishDocumentationChanges.optional(),
+});
+
+export const DTOPublishDocumentationResponse = z.object({
+  job: DTOExportJob,
+});
+
+export type DTOPublishDocumentationChanges = z.infer<typeof DTOPublishDocumentationChanges>;
+export type DTOPublishDocumentationRequest = z.infer<typeof DTOPublishDocumentationRequest>;
+export type DTOPublishDocumentationResponse = z.infer<typeof DTOPublishDocumentationResponse>;

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/components/figma-component-group.ts

@@ -0,0 +1,19 @@
+import z from "zod";
+import { DTOObjectMeta } from "../../aux/meta";
+
+export const DTOFigmaComponentGroup = z.object({
+  id: z.string(),
+  designSystemVersionId: z.string(),
+  persistentId: z.string(),
+  isRoot: z.boolean(),
+  brandId: z.string(),
+  meta: DTOObjectMeta,
+  childrenIds: z.string().array(),
+});
+
+export const DTOFigmaComponentGroupListResponse = z.object({
+  groups: DTOFigmaComponentGroup.array(),
+});
+
+export type DTOFigmaComponentGroup = z.infer<typeof DTOFigmaComponentGroup>;
+export type DTOFigmaComponentGroupListResponse = z.infer<typeof DTOFigmaComponentGroupListResponse>;

package/src/api/dto/elements/components/figma-component.ts

@@ -0,0 +1,56 @@
+import {
+  FigmaComponentBooleanProperty,
+  FigmaComponentInstanceSwapProperty,
+  FigmaComponentOrigin,
+  FigmaComponentProperty,
+  FigmaComponentTextProperty,
+  FigmaComponentVariantProperty,
+  ObjectMeta,
+} from "@supernova-studio/model";
+import { z } from "zod";
+
+const DTOFigmaComponentBooleanProperty = FigmaComponentBooleanProperty;
+const DTOFigmaComponentInstanceSwapProperty = FigmaComponentInstanceSwapProperty;
+const DTOFigmaComponentTextProperty = FigmaComponentTextProperty;
+const DTOFigmaComponentVariantProperty = FigmaComponentVariantProperty;
+const DTOFigmaComponentProperty = FigmaComponentProperty;
+const DTOFigmaComponentPropertyMap = z.record(DTOFigmaComponentProperty);
+
+export const DTOFigmaComponent = z.object({
+  id: z.string(),
+  persistentId: z.string(),
+  designSystemVersionId: z.string(),
+  brandId: z.string(),
+  thumbnailUrl: z.string().optional(),
+  svgUrl: z.string().optional(),
+
+  exportProperties: z.object({
+    isAsset: z.boolean(),
+  }),
+
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+
+  meta: ObjectMeta,
+  originComponent: FigmaComponentOrigin.optional(),
+
+  parentComponentPersistentId: z.string().optional(),
+  childrenPersistentIds: z.string().array().optional(),
+
+  componentPropertyDefinitions: DTOFigmaComponentPropertyMap.optional(),
+  variantPropertyValues: z.record(z.string()).optional(),
+});
+
+export const DTOFigmaComponentListResponse = z.object({
+  components: DTOFigmaComponent.array(),
+});
+
+export type DTOFigmaComponentBooleanProperty = z.infer<typeof DTOFigmaComponentBooleanProperty>;
+export type DTOFigmaComponentInstanceSwapProperty = z.infer<typeof DTOFigmaComponentInstanceSwapProperty>;
+export type DTOFigmaComponentTextProperty = z.infer<typeof DTOFigmaComponentTextProperty>;
+export type DTOFigmaComponentVariantProperty = z.infer<typeof DTOFigmaComponentVariantProperty>;
+export type DTOFigmaComponentProperty = z.infer<typeof DTOFigmaComponentProperty>;
+export type DTOFigmaComponentPropertyMap = z.infer<typeof DTOFigmaComponentPropertyMap>;
+
+export type DTOFigmaComponent = z.infer<typeof DTOFigmaComponent>;
+export type DTOFigmaComponentListResponse = z.infer<typeof DTOFigmaComponentListResponse>;

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

@@ -0,0 +1,2 @@
+export * from "./figma-component-group";
+export * from "./figma-component";

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

@@ -0,0 +1,20 @@
+import { z } from "zod";
+
+export const DTODocumentationConfiguration = z.object({
+  tabbed: z.boolean(),
+  isPublic: z.boolean(),
+  selectedBrandId: z.string().nullish(),
+  storybookEmbedErrorMessage: z.string().nullish(),
+  renderCodePackageJson: z.string().nullish(),
+});
+
+export const DTODocumentationConfigurationResponse = z.object({
+  documentation: z.object({
+    designSystemId: z.string(),
+    designSystemVersionId: z.string(),
+    settings: DTODocumentationConfiguration,
+  }),
+});
+
+export type DTODocumentationConfiguration = z.infer<typeof DTODocumentationConfiguration>;
+export type DTODocumentationConfigurationResponse = z.infer<typeof DTODocumentationConfigurationResponse>;

package/src/api/dto/elements/documentation/draft-state.ts

@@ -0,0 +1,37 @@
+import { z } from "zod";
+import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
+
+export const DTODocumentationDraftChangeType = z.enum(["Created", "Updated", "Deleted"]);
+
+export const DTODocumentationDraftStateCreated = z.object({
+  changeType: z.literal(DTODocumentationDraftChangeType.enum.Created),
+});
+
+export const DTODocumentationDraftStateUpdated = z.object({
+  changeType: z.literal(DTODocumentationDraftChangeType.enum.Updated),
+  changes: z.object({
+    previousTitle: z.string().optional(),
+    previousConfiguration: DTODocumentationItemConfigurationV2.optional(),
+    previousContentHash: z.string().optional(),
+  }),
+});
+
+export const DTODocumentationDraftStateDeleted = z.object({
+  changeType: z.literal(DTODocumentationDraftChangeType.enum.Deleted),
+  deletedAt: z.coerce.date(),
+  deletedByUserId: z.string(),
+});
+
+export const DTODocumentationDraftState = z.discriminatedUnion("changeType", [
+  DTODocumentationDraftStateCreated,
+  DTODocumentationDraftStateUpdated,
+  DTODocumentationDraftStateDeleted,
+]);
+
+export type DTODocumentationDraftChangeType = z.infer<typeof DTODocumentationDraftChangeType>;
+
+export type DTODocumentationDraftStateCreated = z.infer<typeof DTODocumentationDraftStateCreated>;
+export type DTODocumentationDraftStateUpdated = z.infer<typeof DTODocumentationDraftStateUpdated>;
+export type DTODocumentationDraftStateDeleted = z.infer<typeof DTODocumentationDraftStateDeleted>;
+
+export type DTODocumentationDraftState = z.infer<typeof DTODocumentationDraftState>;

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

@@ -0,0 +1,108 @@
+import { z } from "zod";
+import {
+  DTOCreateDocumentationGroupInput,
+  DTOCreateDocumentationTabInput,
+  DTODeleteDocumentationGroupInput,
+  DTODeleteDocumentationTabGroupInput,
+  DTODuplicateDocumentationGroupInput,
+  DTOMoveDocumentationGroupInput,
+  DTOUpdateDocumentationGroupInput,
+} from "./group-v2";
+
+//
+// Read
+//
+
+const SuccessPayload = z.object({
+  success: z.literal(true),
+});
+
+export const DTODocumentationGroupCreateActionOutputV2 = z.object({
+  type: z.literal("DocumentationGroupCreate"),
+  output: SuccessPayload,
+});
+
+export const DTODocumentationTabCreateActionOutputV2 = z.object({
+  type: z.literal("DocumentationTabCreate"),
+  output: SuccessPayload,
+});
+
+export const DTODocumentationGroupUpdateActionOutputV2 = z.object({
+  type: z.literal("DocumentationGroupUpdate"),
+  output: SuccessPayload,
+});
+
+export const DTODocumentationGroupMoveActionOutputV2 = z.object({
+  type: z.literal("DocumentationGroupMove"),
+  output: SuccessPayload,
+});
+
+export const DTODocumentationGroupDuplicateActionOutputV2 = z.object({
+  type: z.literal("DocumentationGroupDuplicate"),
+  output: SuccessPayload,
+});
+
+export const DTODocumentationGroupDeleteActionOutputV2 = z.object({
+  type: z.literal("DocumentationGroupDelete"),
+  output: SuccessPayload,
+});
+
+export const DTODocumentationTabGroupDeleteActionOutputV2 = z.object({
+  type: z.literal("DocumentationTabGroupDelete"),
+  output: SuccessPayload,
+});
+
+export type DTODocumentationGroupCreateActionOutputV2 = z.infer<typeof DTODocumentationGroupCreateActionOutputV2>;
+export type DTODocumentationTabCreateActionOutputV2 = z.infer<typeof DTODocumentationTabCreateActionOutputV2>;
+export type DTODocumentationGroupUpdateActionOutputV2 = z.infer<typeof DTODocumentationGroupUpdateActionOutputV2>;
+export type DTODocumentationGroupMoveActionOutputV2 = z.infer<typeof DTODocumentationGroupMoveActionOutputV2>;
+export type DTODocumentationGroupDuplicateActionOutputV2 = z.infer<typeof DTODocumentationGroupDuplicateActionOutputV2>;
+export type DTODocumentationGroupDeleteActionOutputV2 = z.infer<typeof DTODocumentationGroupDeleteActionOutputV2>;
+export type DTODocumentationTabGroupDeleteActionOutputV2 = z.infer<typeof DTODocumentationTabGroupDeleteActionOutputV2>;
+
+//
+// Write
+//
+
+export const DTODocumentationGroupCreateActionInputV2 = z.object({
+  type: z.literal("DocumentationGroupCreate"),
+  input: DTOCreateDocumentationGroupInput,
+});
+
+export const DTODocumentationTabCreateActionInputV2 = z.object({
+  type: z.literal("DocumentationTabCreate"),
+  input: DTOCreateDocumentationTabInput,
+});
+
+export const DTODocumentationGroupUpdateActionInputV2 = z.object({
+  type: z.literal("DocumentationGroupUpdate"),
+  input: DTOUpdateDocumentationGroupInput,
+});
+
+export const DTODocumentationGroupMoveActionInputV2 = z.object({
+  type: z.literal("DocumentationGroupMove"),
+  input: DTOMoveDocumentationGroupInput,
+});
+
+export const DTODocumentationGroupDuplicateActionInputV2 = z.object({
+  type: z.literal("DocumentationGroupDuplicate"),
+  input: DTODuplicateDocumentationGroupInput,
+});
+
+export const DTODocumentationGroupDeleteActionInputV2 = z.object({
+  type: z.literal("DocumentationGroupDelete"),
+  input: DTODeleteDocumentationGroupInput,
+});
+
+export const DTODocumentationTabGroupDeleteActionInputV2 = z.object({
+  type: z.literal("DocumentationTabGroupDelete"),
+  input: DTODeleteDocumentationTabGroupInput,
+});
+
+export type DTODocumentationGroupCreateActionInputV2 = z.infer<typeof DTODocumentationGroupCreateActionInputV2>;
+export type DTODocumentationTabGroupCreateActionInputV2 = z.infer<typeof DTODocumentationTabCreateActionInputV2>;
+export type DTODocumentationGroupUpdateActionInputV2 = z.infer<typeof DTODocumentationGroupUpdateActionInputV2>;
+export type DTODocumentationGroupMoveActionInputV2 = z.infer<typeof DTODocumentationGroupMoveActionInputV2>;
+export type DTODocumentationGroupDuplicateActionInputV2 = z.infer<typeof DTODocumentationGroupDuplicateActionInputV2>;
+export type DTODocumentationGroupDeleteActionInputV2 = z.infer<typeof DTODocumentationGroupDeleteActionInputV2>;
+export type DTODocumentationTabGroupDeleteActionInputV2 = z.infer<typeof DTODocumentationTabGroupDeleteActionInputV2>;

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

@@ -0,0 +1,35 @@
+import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
+import { z } from "zod";
+import { DTODocumentationItemConfigurationV1 } from "./item-configuration-v1";
+
+//
+// Read
+//
+
+/**
+ * Structure DTO is element properties minus element data (in other words data required
+ * to display the element in the left panel)
+ */
+export const DTODocumentationGroupStructureV1 = ElementGroup.omit({
+  sortOrder: true,
+  parentPersistentId: true,
+  brandPersistentId: true,
+  meta: true,
+  childType: true,
+  data: true,
+  shortPersistentId: true,
+}).extend({
+  title: z.string(),
+  isRoot: z.boolean(),
+  childrenIds: z.array(z.string()),
+  groupBehavior: DocumentationGroupBehavior,
+  shortPersistentId: z.string(),
+  type: z.literal("Group"),
+});
+
+export const DTODocumentationGroupV1 = DTODocumentationGroupStructureV1.extend({
+  configuration: DTODocumentationItemConfigurationV1,
+});
+
+export type DTODocumentationGroupStructureV1 = z.infer<typeof DTODocumentationGroupStructureV1>;
+export type DTODocumentationGroupV1 = z.infer<typeof DTODocumentationGroupV1>;